Class: Chef::Resource::RemoteFile

Inherits:
File show all
Includes:
Mixin::Securable
Defined in:
lib/chef/resource/remote_file.rb

Constant Summary

Constants inherited from Chef::Resource

FORBIDDEN_IVARS, HIDDEN_IVARS

Instance Attribute Summary

Attributes inherited from Chef::Resource

#allowed_actions, #cookbook_name, #elapsed_time, #enclosing_provider, #not_if_args, #only_if_args, #params, #recipe_name, #resource_name, #retries, #retry_delay, #run_context, #source_line, #updated

Instance Method Summary collapse

Methods included from Mixin::Securable

#group, #inherits, #mode, #owner, rights_attribute

Methods inherited from File

#backup, #content, #diff, #path

Methods inherited from Chef::Resource

#action, #add_notification, #after_created, #as_json, attribute, build_from_file, #cookbook_version, #customize_exception, #defined_at, #delayed_notifications, dsl_name, #epic_fail, #events, #identity, identity_attr, #ignore_failure, #immediate_notifications, #inspect, #is, json_create, #load_prior_resource, #method_missing, #name, #node, #noop, #not_if, #notifies, #notifies_delayed, #notifies_immediately, #only_if, platform_map, provider_base, #provider_for_action, provides, #resolve_notification_references, resource_for_node, resource_for_platform, #resources, #run_action, #should_skip?, #state, state_attrs, #subscribes, #supports, #to_hash, #to_json, #to_s, #to_text, #updated?, #updated_by_last_action, #updated_by_last_action?, #validate_action

Methods included from Mixin::ConvertToClassName

#convert_to_class_name, #convert_to_snake_case, #filename_to_qualified_string, #snake_case_basename

Methods included from Mixin::Deprecation

#deprecated_ivar

Methods included from Mixin::Language

#data_bag, #data_bag_item, #platform?, #platform_family?, #search, #value_for_platform, #value_for_platform_family

Methods included from Mixin::ParamsValidate

#set_or_return, #validate

Methods included from Mixin::CheckHelper

#set_if_args

Constructor Details

#initialize(name, run_context = nil) ⇒ RemoteFile

Returns a new instance of RemoteFile.



31
32
33
34
35
36
37
38
 
# File 'lib/chef/resource/remote_file.rb', line 31

def initialize(name, run_context=nil)
  super
  @resource_name = :remote_file
  @action = "create"
  @source = ::File.basename(name)
  @cookbook = nil
  @provider = Chef::Provider::RemoteFile
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Chef::Resource

Instance Method Details

#checksum(args = nil) ⇒ Object 



56
57
58
59
60
61
62
 
# File 'lib/chef/resource/remote_file.rb', line 56

def checksum(args=nil)
  set_or_return(
    :checksum,
    args,
    :kind_of => String
  )
end

#cookbook(args = nil) ⇒ Object 



48
49
50
51
52
53
54
 
# File 'lib/chef/resource/remote_file.rb', line 48

def cookbook(args=nil)
  set_or_return(
    :cookbook,
    args,
    :kind_of => String
  )
end

#provider ⇒ Object

The provider that should be used for this resource.

Returns:

Chef::Provider::RemoteFile when the source is an absolute URI, like

http://www.google.com/robots.txt

Chef::Provider::CookbookFile when the source is a relative URI, like

'myscript.pl', 'dir/config.conf'



70
71
72
73
74
75
76
77
78
 
# File 'lib/chef/resource/remote_file.rb', line 70

def provider
  if absolute_uri?(source)
    Chef::Provider::RemoteFile
  else
    Chef::Log.warn("remote_file is deprecated for fetching files from cookbooks. Use cookbook_file instead")
    Chef::Log.warn("From #{self.to_s} on #{source_line}")
    Chef::Provider::CookbookFile
  end
end

#source(args = nil) ⇒ Object 



40
41
42
43
44
45
46
 
# File 'lib/chef/resource/remote_file.rb', line 40

def source(args=nil)
  set_or_return(
    :source,
    args,
    :kind_of => String
  )
end