Module: RestCore::Client

Includes:
RestCore
Defined in:
lib/rest-core/client.rb

Constant Summary collapse

Unserializable = 
[Proc, Method, IO]

Constants included from RestCore

ASYNC, CLIENT, DRY, FAIL, HIJACK, LOG, PROMISE, REQUEST_HEADERS, REQUEST_METHOD, REQUEST_PATH, REQUEST_PAYLOAD, REQUEST_QUERY, REQUEST_URI, RESPONSE_BODY, RESPONSE_HEADERS, RESPONSE_KEY, RESPONSE_SOCKET, RESPONSE_STATUS, Simple, TIMER, Universal, VERSION

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from RestCore

eagerload, id

Instance Attribute Details

#app ⇒ Object (readonly)

Returns the value of attribute app.



45
46
47
 
# File 'lib/rest-core/client.rb', line 45

def app
  @app
end

#dry ⇒ Object (readonly)

Returns the value of attribute dry.



45
46
47
 
# File 'lib/rest-core/client.rb', line 45

def dry
  @dry
end

#promises ⇒ Object (readonly)

Returns the value of attribute promises.



45
46
47
 
# File 'lib/rest-core/client.rb', line 45

def promises
  @promises
end

Class Method Details

.included(mod) ⇒ Object 



10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/rest-core/client.rb', line 10

def self.included mod
  # honor default attributes
  src = mod.members.map{ |name|
    "      def \#{name}\n        if (r = super).nil?\n          self.\#{name} = default_\#{name}\n        else\n          r\n        end\n      end\n\n      def default_\#{name} app=app\n        if self.class.respond_to?(\"default_\#{name}\")\n          self.class.default_\#{name}      # old class default style\n        elsif app.respond_to?(:\#{name})\n          app.\#{name}({})                 # middleware instance value\n        elsif app.respond_to?(:wrapped)\n          default_\#{name}(app.wrapped) || # wrapper value\n          default_\#{name}(app.app)        # walk into it\n        elsif app.respond_to?(:app)\n          default_\#{name}(app.app)        # walk into next app\n        else\n          nil\n        end\n      end\n      private :default_\#{name}\n    RUBY\n  }\n  accessor = Module.new\n  accessor.module_eval(src.join(\"\\n\"), __FILE__, __LINE__)\n  mod.const_set('Accessor', accessor)\n  mod.send(:include, accessor)\nend\n"

Instance Method Details

#attributes ⇒ Object 



55
56
57
 
# File 'lib/rest-core/client.rb', line 55

def attributes
  Hash[each_pair.map{ |k, v| [k, send(k)] }]
end

#build_env(env = {}) ⇒ Object 



194
195
196
197
 
# File 'lib/rest-core/client.rb', line 194

def build_env env={}
  default_env.merge(
    Middleware.string_keys(attributes).merge(Middleware.string_keys(env)))
end

#default_env ⇒ Object 



199
200
201
202
203
204
205
206
207
208
 
# File 'lib/rest-core/client.rb', line 199

def default_env
  {REQUEST_METHOD  => :get,
   REQUEST_PATH    => '/' ,
   REQUEST_QUERY   => {}  ,
   REQUEST_PAYLOAD => {}  ,
   REQUEST_HEADERS => {}  ,
   FAIL            => []  ,
   LOG             => []  ,
   CLIENT          => self}
end

#delete(path, query = {}, opts = {}, &cb) ⇒ Object 



117
118
119
120
121
122
 
# File 'lib/rest-core/client.rb', line 117

def delete path, query={}, opts={}, &cb
  request(
    {REQUEST_METHOD  => :delete,
     REQUEST_PATH    => path   ,
     REQUEST_QUERY   => query  }.merge(opts), &cb)
end

#event_source(path, query = {}, opts = {}) ⇒ Object 



164
165
166
 
# File 'lib/rest-core/client.rb', line 164

def event_source path, query={}, opts={}
  self.class.event_source_class.new(self, path, query, opts)
end

#get(path, query = {}, opts = {}, &cb) ⇒ Object 



110
111
112
113
114
115
 
# File 'lib/rest-core/client.rb', line 110

def get    path, query={}, opts={}, &cb
  request(
    {REQUEST_METHOD  => :get   ,
     REQUEST_PATH    => path   ,
     REQUEST_QUERY   => query  }.merge(opts), &cb)
end

#head(path, query = {}, opts = {}, &cb) ⇒ Object 



124
125
126
127
128
129
130
 
# File 'lib/rest-core/client.rb', line 124

def head path, query={}, opts={}, &cb
  request(
    {REQUEST_METHOD  => :head  ,
     REQUEST_PATH    => path   ,
     REQUEST_QUERY   => query  ,
     RESPONSE_KEY    => RESPONSE_HEADERS}.merge(opts), &cb)
end

#initialize(o = {}) ⇒ Object 



46
47
48
49
50
51
52
53
 
# File 'lib/rest-core/client.rb', line 46

def initialize o={}
  @app ||= self.class.builder.to_app # lighten! would reinitialize anyway
  @dry ||= self.class.builder.to_app(Dry)
  @promises = []  # don't record any promises in lighten!
  @mutex    = nil # for locking promises, lazily initialized
                  # for serialization
  o.each{ |key, value| send("#{key}=", value) if respond_to?("#{key}=") }
end

#inspect ⇒ Object 



59
60
61
62
63
64
65
66
67
68
 
# File 'lib/rest-core/client.rb', line 59

def inspect
  fields = if size > 0
             ' ' + attributes.map{ |k, v|
               "#{k}=#{v.inspect.sub(/(?<=.{12}).{4,}/, '...')}"
             }.join(', ')
           else
             ''
           end
  "#<struct #{self.class.name}#{fields}>"
end

#lighten(o = {}) ⇒ Object 



83
84
85
 
# File 'lib/rest-core/client.rb', line 83

def lighten o={}
  dup.lighten!(o)
end

#lighten!(o = {}) ⇒ Object 



70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/rest-core/client.rb', line 70

def lighten! o={}
  attributes.each{ |k, v| vv = case v;
                                 when  Hash; lighten_hash(v)
                                 when Array; lighten_array(v)
                                 when *Unserializable; nil
                                 else v
                               end
                          send("#{k}=", vv)}
  initialize(o)
  @app, @dry = lighten_app(app), lighten_app(dry)
  self
end

#options(path, query = {}, opts = {}, &cb) ⇒ Object 



132
133
134
135
136
137
138
 
# File 'lib/rest-core/client.rb', line 132

def options path, query={}, opts={}, &cb
  request(
    {REQUEST_METHOD  => :options,
     REQUEST_PATH    => path   ,
     REQUEST_QUERY   => query  ,
     RESPONSE_KEY    => RESPONSE_HEADERS}.merge(opts), &cb)
end

#patch(path, payload = {}, query = {}, opts = {}, &cb) ⇒ Object 



156
157
158
159
160
161
162
 
# File 'lib/rest-core/client.rb', line 156

def patch  path, payload={}, query={}, opts={}, &cb
  request(
    {REQUEST_METHOD  => :patch ,
     REQUEST_PATH    => path   ,
     REQUEST_QUERY   => query  ,
     REQUEST_PAYLOAD => payload}.merge(opts), &cb)
end

#post(path, payload = {}, query = {}, opts = {}, &cb) ⇒ Object 



140
141
142
143
144
145
146
 
# File 'lib/rest-core/client.rb', line 140

def post   path, payload={}, query={}, opts={}, &cb
  request(
    {REQUEST_METHOD  => :post  ,
     REQUEST_PATH    => path   ,
     REQUEST_QUERY   => query  ,
     REQUEST_PAYLOAD => payload}.merge(opts), &cb)
end

#put(path, payload = {}, query = {}, opts = {}, &cb) ⇒ Object 



148
149
150
151
152
153
154
 
# File 'lib/rest-core/client.rb', line 148

def put    path, payload={}, query={}, opts={}, &cb
  request(
    {REQUEST_METHOD  => :put   ,
     REQUEST_PATH    => path   ,
     REQUEST_QUERY   => query  ,
     REQUEST_PAYLOAD => payload}.merge(opts), &cb)
end

#request(env, app = app) ⇒ Object 



168
169
170
171
172
173
174
 
# File 'lib/rest-core/client.rb', line 168

def request env, app=app
  if block_given?
    request_full(env, app){ |response| yield(response[response_key(env)]) }
  else
    request_full(env, app)[response_key(env)]
  end
end

#request_full(env, app = app, &k) ⇒ Object 



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/rest-core/client.rb', line 176

def request_full env, app=app, &k
  response = app.call(build_env({ASYNC => !!k}.merge(env)),
                      &(k || RC.id))

  # under ASYNC callback, response might not be a response hash
  # in that case (maybe in a user created engine), Client#wait
  # won't work because we have no way to track the promise.
  if response.kind_of?(Hash) && response[PROMISE].kind_of?(Promise)
    mutex.synchronize{ promises << WeakRef.new(response[PROMISE]) }
  end

  if block_given?
    self
  else
    response
  end
end

#url(path, query = {}, opts = {}) ⇒ Object 



103
104
105
106
107
108
 
# File 'lib/rest-core/client.rb', line 103

def url path, query={}, opts={}
  dry.call(build_env({
    REQUEST_PATH  => path,
    REQUEST_QUERY => query,
    DRY           => true}.merge(opts)), &Middleware.method(:request_uri))
end

#wait ⇒ Object 



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/rest-core/client.rb', line 87

def wait
  return self if promises.empty?
  current_promises = nil
  mutex.synchronize{
    current_promises = promises.dup
    promises.clear
  }
  current_promises.each{ |f|
    begin
      f.wait
    rescue WeakRef::RefError # it's gc'ed after we think it's alive
    end if f.weakref_alive?
  }
  wait
end