Class: Puppet::Indirector::Request

Inherits:
Object
  • Object
show all
Includes:
Util::PsychSupport, Util::Warnings
Defined in:
lib/puppet/indirector/request.rb

Overview

This class encapsulates all of the information you need to make an Indirection call, and as a result also handles REST calls. It's somewhat analogous to an HTTP Request object, except tuned for our Indirector.

Constant Summary collapse

OPTION_ATTRIBUTES =

trusted_information is specifically left out because we can't serialize it and keep it “trusted”

[:ip, :node, :authenticated, :ignore_terminus, :ignore_cache, :ignore_cache_save, :instance, :environment]

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Util::Warnings

clear_warnings, debug_once, maybe_log, notice_once, warnonce

Methods included from Util::PsychSupport

#encode_with, #init_with

Constructor Details

#initialize(indirection_name, method, key, instance, options = {}) ⇒ Request

Returns a new instance of Request.


62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/puppet/indirector/request.rb', line 62

def initialize(indirection_name, method, key, instance, options = {})
  @instance = instance
  options ||= {}

  self.indirection_name = indirection_name
  self.method = method

  options = options.inject({}) { |hash, ary| hash[ary[0].to_sym] = ary[1]; hash }

  set_attributes(options)

  @options = options

  if key
    # If the request key is a URI, then we need to treat it specially,
    # because it rewrites the key.  We could otherwise strip server/port/etc
    # info out in the REST class, but it seemed bad design for the REST
    # class to rewrite the key.

    if key.to_s =~ /^\w+:\// and not Puppet::Util.absolute_path?(key.to_s) # it's a URI
      set_uri_key(key)
    else
      @key = key
    end
  end

  @key = @instance.name if ! @key and @instance
end

Instance Attribute Details

#authenticated ⇒ Object

Returns the value of attribute authenticated.


14
15
16
 
# File 'lib/puppet/indirector/request.rb', line 14

def authenticated
  @authenticated
end

#ignore_cache ⇒ Object

Returns the value of attribute ignore_cache.


14
15
16
 
# File 'lib/puppet/indirector/request.rb', line 14

def ignore_cache
  @ignore_cache
end

#ignore_cache_save ⇒ Object

Returns the value of attribute ignore_cache_save.


14
15
16
 
# File 'lib/puppet/indirector/request.rb', line 14

def ignore_cache_save
  @ignore_cache_save
end

#ignore_terminus ⇒ Object

Returns the value of attribute ignore_terminus.


14
15
16
 
# File 'lib/puppet/indirector/request.rb', line 14

def ignore_terminus
  @ignore_terminus
end

#indirection_name ⇒ Object

Returns the value of attribute indirection_name.


18
19
20
 
# File 'lib/puppet/indirector/request.rb', line 18

def indirection_name
  @indirection_name
end

#instance ⇒ Object

Returns the value of attribute instance.


14
15
16
 
# File 'lib/puppet/indirector/request.rb', line 14

def instance
  @instance
end

#ip ⇒ Object

Returns the value of attribute ip.


14
15
16
 
# File 'lib/puppet/indirector/request.rb', line 14

def ip
  @ip
end

#key ⇒ Object

Returns the value of attribute key.


14
15
16
 
# File 'lib/puppet/indirector/request.rb', line 14

def key
  @key
end

#method ⇒ Object

Returns the value of attribute method.


14
15
16
 
# File 'lib/puppet/indirector/request.rb', line 14

def method
  @method
end

#node ⇒ Object

Returns the value of attribute node.


14
15
16
 
# File 'lib/puppet/indirector/request.rb', line 14

def node
  @node
end

#options ⇒ Object

Returns the value of attribute options.


14
15
16
 
# File 'lib/puppet/indirector/request.rb', line 14

def options
  @options
end

#port ⇒ Object

Returns the value of attribute port.


16
17
18
 
# File 'lib/puppet/indirector/request.rb', line 16

def port
  @port
end

#protocol ⇒ Object

Returns the value of attribute protocol.


16
17
18
 
# File 'lib/puppet/indirector/request.rb', line 16

def protocol
  @protocol
end

#server ⇒ Object

Returns the value of attribute server.


16
17
18
 
# File 'lib/puppet/indirector/request.rb', line 16

def server
  @server
end

#uri ⇒ Object

Returns the value of attribute uri.


16
17
18
 
# File 'lib/puppet/indirector/request.rb', line 16

def uri
  @uri
end

Instance Method Details

#authenticated? ⇒ Boolean

Is this an authenticated request?

Returns:

  • (Boolean) 

25
26
27
28
 
# File 'lib/puppet/indirector/request.rb', line 25

def authenticated?
  # Double negative, so we just get true or false
  ! ! authenticated
end

#description ⇒ Object 


139
140
141
 
# File 'lib/puppet/indirector/request.rb', line 139

def description
  return(uri ? uri : "/#{indirection_name}/#{key}")
end

#environment ⇒ Object 


30
31
32
33
34
 
# File 'lib/puppet/indirector/request.rb', line 30

def environment
  # If environment has not been set directly, we should use the application's
  # current environment
  @environment ||= Puppet.lookup(:current_environment)
end

#environment=(env) ⇒ Object 


36
37
38
39
40
41
42
43
 
# File 'lib/puppet/indirector/request.rb', line 36

def environment=(env)
  @environment =
  if env.is_a?(Puppet::Node::Environment)
    env
  else
    Puppet.lookup(:environments).get!(env)
  end
end

#ignore_cache? ⇒ Boolean

LAK:NOTE This is a messy interface to the cache, and it's only used by the Configurer class. I decided it was better to implement it now and refactor later, when we have a better design, than to spend another month coming up with a design now that might not be any better.

Returns:

  • (Boolean) 

50
51
52
 
# File 'lib/puppet/indirector/request.rb', line 50

def ignore_cache?
  ignore_cache
end

#ignore_cache_save? ⇒ Boolean

Returns:

  • (Boolean) 

54
55
56
 
# File 'lib/puppet/indirector/request.rb', line 54

def ignore_cache_save?
  ignore_cache_save
end

#ignore_terminus? ⇒ Boolean

Returns:

  • (Boolean) 

58
59
60
 
# File 'lib/puppet/indirector/request.rb', line 58

def ignore_terminus?
  ignore_terminus
end

#indirection ⇒ Object

Look up the indirection based on the name provided.


92
93
94
 
# File 'lib/puppet/indirector/request.rb', line 92

def indirection
  Puppet::Indirector::Indirection.instance(indirection_name)
end

#initialize_from_hash(hash) ⇒ Object 


111
112
113
114
115
116
117
 
# File 'lib/puppet/indirector/request.rb', line 111

def initialize_from_hash(hash)
  @indirection_name = hash['indirection_name'].to_sym
  @method = hash['method'].to_sym
  @key = hash['key']
  @instance = hash['instance']
  @options = hash['options']
end

#model ⇒ Object

Raises:

  • (ArgumentError) 

100
101
102
103
104
 
# File 'lib/puppet/indirector/request.rb', line 100

def model
  ind = indirection
  raise ArgumentError, _("Could not find indirection '%{indirection}'") % { indirection: indirection_name } unless ind
  ind.model
end

#plural? ⇒ Boolean

Are we trying to interact with multiple resources, or just one?

Returns:

  • (Boolean) 

107
108
109
 
# File 'lib/puppet/indirector/request.rb', line 107

def plural?
  method == :search
end

#remote? ⇒ Boolean

Returns:

  • (Boolean) 

143
144
145
 
# File 'lib/puppet/indirector/request.rb', line 143

def remote?
  self.node or self.ip
end

#to_data_hash ⇒ Object 


119
120
121
122
123
124
125
 
# File 'lib/puppet/indirector/request.rb', line 119

def to_data_hash
  { 'indirection_name' => @indirection_name.to_s,
    'method' => @method.to_s,
    'key' => @key,
    'instance' => @instance,
    'options' => @options }
end

#to_hash ⇒ Object 


127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/puppet/indirector/request.rb', line 127

def to_hash
  result = options.dup

  OPTION_ATTRIBUTES.each do |attribute|
    value = send(attribute)
    if value
      result[attribute] = value
    end
  end
  result
end