Class: Wrest::UriTemplate

Inherits:
Object
  • Object
show all
Defined in:
lib/wrest/uri_template.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(uri_pattern, options = {}) ⇒ UriTemplate

Returns a new instance of UriTemplate.



16
17
18
19
 
# File 'lib/wrest/uri_template.rb', line 16

def initialize(uri_pattern, options = {})
  @uri_pattern = uri_pattern.clone
  @options = options.clone
end

Instance Attribute Details

#uri_pattern ⇒ Object (readonly)

Returns the value of attribute uri_pattern.



14
15
16
 
# File 'lib/wrest/uri_template.rb', line 14

def uri_pattern
  @uri_pattern
end

Instance Method Details

#==(other) ⇒ Object 



57
58
59
60
61
 
# File 'lib/wrest/uri_template.rb', line 57

def ==(other)
  return false if other.class != self.class

  other.uri_pattern == uri_pattern
end

#[](path) ⇒ Object 



53
54
55
 
# File 'lib/wrest/uri_template.rb', line 53

def [](path)
  UriTemplate.new(File.join(uri_pattern, path))
end

#to_uri(options = {}) ⇒ Object

Builds a new Wrest::Uri from this uri template by replacing the keys in the options that match with the corressponding values.

Example: template = UriTemplate.new(“coathangers.com/:resource/:id.:format”) template.to_uri(:resource => ‘shen_coins’, :id => 5, :format => :json)

> #<Wrest::Uri:0x1225514 @uri=#<URI::HTTP:0x9127d8 URL:localhost:3000/shen_coins/5.json>>

This feature can also be used to handle HTTP authentication where the username and password needs changing at runtime. However, this approach will fail if the password contains characters like ^ and @.

Note that beacuse because both HTTP Auth and UriTemplate use ‘:’ as a delimiter, the pattern does look slightly weird, but it still works. Example: template = UriTemplate.new(“:username::[email protected]/:resource/:id.:format”) template.to_uri(

:user => 'kaiwren',
:password => 'fupuppies',
:resource => 'portal',
:id => '1'

)

=> #<Wrest::Uri:0x18e0bec @uri=#<URI::HTTP:0x18e09a8 URL:http://kaiwren:[email protected]/portal/1>>



45
46
47
48
49
50
51
 
# File 'lib/wrest/uri_template.rb', line 45

def to_uri(options = {})
  merged_options = @options.merge(options)
  Wrest::Uri.new(merged_options.inject(uri_pattern.clone) do |uri_string, tuple|
    key, value = tuple
    uri_string.gsub(":#{key}", value.to_s)
  end, @options)
end