Class: Chef::Provider::HttpRequest

Inherits:
Chef::Provider show all
Defined in:
lib/chef/provider/http_request.rb

Constant Summary

Constants included from Mixin::ShellOut

Mixin::ShellOut::DEPRECATED_OPTIONS

Instance Attribute Summary collapse

Attributes inherited from Chef::Provider

#action, #cookbook_name, #current_resource, #new_resource, #recipe_name, #run_context

Instance Method Summary collapse

Methods inherited from Chef::Provider

#action_nothing, #check_resource_semantics!, #cleanup_after_converge, #converge_by, #converge_if_changed, #define_resource_requirements, #events, include_resource_dsl, include_resource_dsl_module, #initialize, #node, #process_resource_requirements, provides, provides?, #requirements, #resource_collection, #resource_updated?, #run_action, #set_updated_status, supports?, use_inline_resources, #whyrun_mode?

Methods included from Mixin::Provides

#provided_as, #provides, #provides?

Methods included from Mixin::DescendantsTracker

#descendants, descendants, direct_descendants, #direct_descendants, find_descendants_by_name, #find_descendants_by_name, #inherited, store_inherited

Methods included from DeprecatedLWRPClass

#const_missing, #deprecated_constants, #register_deprecated_lwrp_class

Methods included from Mixin::LazyModuleInclude

#descendants, #include, #included

Methods included from Mixin::NotifyingBlock

#notifying_block, #subcontext_block

Methods included from DSL::DeclareResource

#build_resource, #declare_resource, #delete_resource, #delete_resource!, #edit_resource, #edit_resource!, #find_resource, #find_resource!, #with_run_context

Methods included from Mixin::ShellOut

#run_command_compatible_options, #shell_out, #shell_out!, #shell_out_with_systems_locale, #shell_out_with_systems_locale!

Methods included from Mixin::PowershellOut

#powershell_out, #powershell_out!

Methods included from Mixin::WindowsArchitectureHelper

#assert_valid_windows_architecture!, #disable_wow64_file_redirection, #forced_32bit_override_required?, #is_i386_process_on_x86_64_windows?, #node_supports_windows_architecture?, #node_windows_architecture, #restore_wow64_file_redirection, #valid_windows_architecture?, #with_os_architecture, #wow64_architecture_override_required?, #wow64_directory

Methods included from DSL::PlatformIntrospection

#docker?, #platform?, #platform_family?, #value_for_platform, #value_for_platform_family

Constructor Details

This class inherits a constructor from Chef::Provider

Instance Attribute Details

#httpObject

Returns the value of attribute http.



28
29
30
# File 'lib/chef/provider/http_request.rb', line 28

def http
  @http
end

Instance Method Details

#action_deleteObject

Send a DELETE request to @new_resource.url



98
99
100
101
102
103
104
105
106
107
108
# File 'lib/chef/provider/http_request.rb', line 98

def action_delete
  converge_by("#{@new_resource} DELETE to #{@new_resource.url}") do
    body = @http.delete(
      "#{@new_resource.url}",
      @new_resource.headers
    )
    @new_resource.updated_by_last_action(true)
    Chef::Log.info("#{@new_resource} DELETE to #{@new_resource.url} successful")
    Chef::Log.debug("#{@new_resource} DELETE request response: #{body}")
  end
end

#action_getObject

Send a GET request to @new_resource.url



56
57
58
59
60
61
62
63
64
65
66
67
# File 'lib/chef/provider/http_request.rb', line 56

def action_get
  converge_by("#{@new_resource} GET to #{@new_resource.url}") do

    message = check_message(@new_resource.message)
    body = @http.get(
      "#{@new_resource.url}",
      @new_resource.headers
    )
    Chef::Log.info("#{@new_resource} GET to #{@new_resource.url} successful")
    Chef::Log.debug("#{@new_resource} GET request response: #{body}")
  end
end

#action_headObject

Send a HEAD request to @new_resource.url



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
# File 'lib/chef/provider/http_request.rb', line 39

def action_head
  message = check_message(@new_resource.message)
  # CHEF-4762: we expect a nil return value from Chef::HTTP for a "200 Success" response
  # and false for a "304 Not Modified" response
  modified = @http.head(
    "#{@new_resource.url}",
    @new_resource.headers
  )
  Chef::Log.info("#{@new_resource} HEAD to #{@new_resource.url} successful")
  Chef::Log.debug("#{@new_resource} HEAD request response: #{modified}")
  # :head is usually used to trigger notifications, which converge_by now does
  if modified != false
    converge_by("#{@new_resource} HEAD to #{@new_resource.url} returned modified, trigger notifications") {}
  end
end

#action_postObject

Send a POST request to @new_resource.url, with the message as the payload



84
85
86
87
88
89
90
91
92
93
94
95
# File 'lib/chef/provider/http_request.rb', line 84

def action_post
  converge_by("#{@new_resource} POST to #{@new_resource.url}") do
    message = check_message(@new_resource.message)
    body = @http.post(
      "#{@new_resource.url}",
      message,
      @new_resource.headers
    )
    Chef::Log.info("#{@new_resource} POST to #{@new_resource.url} message: #{message.inspect} successful")
    Chef::Log.debug("#{@new_resource} POST request response: #{body}")
  end
end

#action_putObject

Send a PUT request to @new_resource.url, with the message as the payload



70
71
72
73
74
75
76
77
78
79
80
81
# File 'lib/chef/provider/http_request.rb', line 70

def action_put
  converge_by("#{@new_resource} PUT to #{@new_resource.url}") do
    message = check_message(@new_resource.message)
    body = @http.put(
      "#{@new_resource.url}",
      message,
      @new_resource.headers
    )
    Chef::Log.info("#{@new_resource} PUT to #{@new_resource.url} successful")
    Chef::Log.debug("#{@new_resource} PUT request response: #{body}")
  end
end

#load_current_resourceObject



34
35
36
# File 'lib/chef/provider/http_request.rb', line 34

def load_current_resource
  @http = Chef::HTTP::Simple.new(@new_resource.url)
end

#whyrun_supported?Boolean

Returns:

  • (Boolean)


30
31
32
# File 'lib/chef/provider/http_request.rb', line 30

def whyrun_supported?
  true
end