Class: MySpace::EndPoint

Inherits:
Object
  • Object
show all
Defined in:
lib/myspace/end_point.rb

Constant Summary collapse

@@registry = 
{}

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(path, method = :get, options = []) ⇒ EndPoint

Returns a new instance of EndPoint.



24
25
26
27
28
29
30
 
# File 'lib/myspace/end_point.rb', line 24

def initialize(path, method = :get, options = [])
  @components = EndPoint.parse_path(path)
  @method = method
  @options = options.dup
  @options.delete(:v1_json)
  @v1_json = options.include?(:v1_json)
end

Instance Attribute Details

#method ⇒ Object (readonly)

Returns the value of attribute method.



3
4
5
 
# File 'lib/myspace/end_point.rb', line 3

def method
  @method
end

Class Method Details

.define(name, path, method, *options) ⇒ Object

Registers a new EndPoint named name.

path is the path on server which may include variables in braces, e.g.

'/v1/users/{user_id}/profile'

In this case, when you call compute_path for this EndPoint, you must include user_id in params, which will be substituted into the url.



15
16
17
 
# File 'lib/myspace/end_point.rb', line 15

def self.define(name, path, method, *options)
  @@registry[name] = EndPoint.new(path, method, options)
end

.find(name) ⇒ Object

Returns the EndPoint named name.



20
21
22
 
# File 'lib/myspace/end_point.rb', line 20

def self.find(name)
  return @@registry[name]
end

.parse_path(path) ⇒ Object 



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/myspace/end_point.rb', line 32

def self.parse_path(path)
  # parse the path string looking for {var} to substitute
  fragments = []
  pos = 0
  while pos < path.length
    lbrace = path.index('{', pos)
    unless lbrace
      fragments.push(path[pos, path.length - pos])
      break
    end
    rbrace = path.index('}', lbrace)
    raise "unmatched left brace in '#{path}'" unless rbrace
    fragments.push(path[pos, lbrace - pos])
    var = path[lbrace + 1, rbrace - lbrace - 1].to_sym
    fragments.push(var)
    pos = rbrace + 1
  end

  fragments
end

Instance Method Details

#compute_path(params) ⇒ Object

Computes the path to the EndPoint by substituting parameters from params into the path.

WARNING: This function DESTRUCTIVELY modifies the params hash that you pass to it. This is normally what you want, since you don’t want to substitute a parameter into the path and also pass it in the query string, but make sure to make a copy first if you’re just passing in parameters from another caller.



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/myspace/end_point.rb', line 61

def compute_path(params)
  path = @components.inject("") do |result, cur|
    if cur.class == String
      result + cur
    elsif cur.class == Symbol
      val = params.delete(cur)
      raise "Required parameter '#{cur}' omitted" unless val
      result + val
    else
      raise "Bad path component: #{cur}"
    end
  end
  path << '.json' if @v1_json && params[:v1_json]
  path
end