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, #declared_type, #default_guard_interpreter, #elapsed_time, #enclosing_provider, #ignore_failure, #not_if_args, #only_if_args, #params, #recipe_name, #resource_name, #retries, #retry_delay, #run_context, #sensitive, #source_line, #updated

Instance Method Summary collapse

Methods included from Mixin::Securable

#group, included, #mode, #owner

Methods included from Mixin::Securable::WindowsSecurableAttributes

#inherits

Methods inherited from File

#atomic_update, #backup, #content, #diff, #force_unlink, #manage_symlink_source, #path, #verify

Methods inherited from Chef::Resource

#action, #as_json, #cookbook_version, #custom_exception_message, #customize_exception, #declared_key, #defined_at, #delayed_notifications, dsl_name, #epic_fail, #events, #guard_interpreter, #identity, identity_attr, #immediate_notifications, #inspect, #is, json_create, #load_from, #method_missing, #name, #node, node_map, #noop, #not_if, #notifies, #notifies_delayed, #notifies_immediately, #only_if, #provider, #provider=, provider_base, #provider_for_action, provides, #resolve_notification_references, resource_for_node, resource_matching_short_name, #resources, #run_action, #should_skip?, #state, state_attrs, #subscribes, #supports, #supports=, #to_hash, #to_json, #to_s, #to_text, #updated?, #updated_by_last_action, #updated_by_last_action?, #validate_action, #validate_resource_spec!

Methods included from Mixin::ConvertToClassName

#constantize, #convert_to_class_name, #convert_to_snake_case, #filename_to_qualified_string, #snake_case_basename

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 Mixin::Deprecation

#deprecated_ivar

Methods included from Mixin::ParamsValidate

#lazy, #set_or_return, #validate

Methods included from DSL::RebootPending

#reboot_pending?

Methods included from DSL::PlatformIntrospection

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

Methods included from DSL::RegistryHelper

#registry_data_exists?, #registry_get_subkeys, #registry_get_values, #registry_has_subkeys?, #registry_key_exists?, #registry_value_exists?

Methods included from DSL::DataQuery

#data_bag, #data_bag_item, #search

Methods included from EncryptedDataBagItem::CheckEncrypted

#encrypted?

Constructor Details

#initialize(name, run_context = nil) ⇒ RemoteFile

Returns a new instance of RemoteFile.



32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/chef/resource/remote_file.rb', line 32

def initialize(name, run_context=nil)
  super
  @resource_name = :remote_file
  @action = "create"
  @source = []
  @use_etag = true
  @use_last_modified = true
  @ftp_active_mode = false
  @headers = {}
  @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

#after_created ⇒ Object 



128
129
130
 
# File 'lib/chef/resource/remote_file.rb', line 128

def after_created
  validate_source(@source)
end

#checksum(args = nil) ⇒ Object 



78
79
80
81
82
83
84
 
# File 'lib/chef/resource/remote_file.rb', line 78

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

#ftp_active_mode(args = nil) ⇒ Object 



112
113
114
115
116
117
118
 
# File 'lib/chef/resource/remote_file.rb', line 112

def ftp_active_mode(args=nil)
  set_or_return(
    :ftp_active_mode,
    args,
    :kind_of => [ TrueClass, FalseClass ]
  )
end

#headers(args = nil) ⇒ Object 



120
121
122
123
124
125
126
 
# File 'lib/chef/resource/remote_file.rb', line 120

def headers(args=nil)
  set_or_return(
    :headers,
    args,
    :kind_of => Hash
  )
end

#parse_source_args(args) ⇒ Object 



66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/chef/resource/remote_file.rb', line 66

def parse_source_args(args)
  if args.empty?
    nil
  elsif args[0].is_a?(Chef::DelayedEvaluator) && args.count == 1
    args[0]
  elsif args.any? {|a| a.is_a?(Chef::DelayedEvaluator)} && args.count > 1
    raise Exceptions::InvalidRemoteFileURI, "Only 1 source argument allowed when using a lazy evaluator"
  else
    Array(args).flatten
  end
end

#source(*args) ⇒ Object

source can take any of the following as arguments

  • A single string argument

  • Multiple string arguments

  • An array or strings

  • A delayed evaluator that evaluates to a string or array of strings

All strings must be parsable as URIs. source returns an array of strings.



52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/chef/resource/remote_file.rb', line 52

def source(*args)
  arg = parse_source_args(args)
  ret = set_or_return(:source,
                      arg,
                      { :callbacks => {
                          :validate_source => method(:validate_source)
                        }})
  if ret.is_a? String
    Array(ret)
  else
    ret
  end
end

#use_conditional_get(true_or_false) ⇒ Object

Disable or enable ETag and Last Modified conditional GET. Equivalent to

use_etag(true_or_false)
use_last_modified(true_or_false)



89
90
91
92
 
# File 'lib/chef/resource/remote_file.rb', line 89

def use_conditional_get(true_or_false)
  use_etag(true_or_false)
  use_last_modified(true_or_false)
end

#use_etag(args = nil) ⇒ Object Also known as: use_etags 



94
95
96
97
98
99
100
 
# File 'lib/chef/resource/remote_file.rb', line 94

def use_etag(args=nil)
  set_or_return(
    :use_etag,
    args,
    :kind_of => [ TrueClass, FalseClass ]
  )
end

#use_last_modified(args = nil) ⇒ Object 



104
105
106
107
108
109
110
 
# File 'lib/chef/resource/remote_file.rb', line 104

def use_last_modified(args=nil)
  set_or_return(
    :use_last_modified,
    args,
    :kind_of => [ TrueClass, FalseClass ]
  )
end