Class: HaveAPI::Server

Inherits:
Object
  • Object
show all
Includes:
Hookable
Defined in:
lib/haveapi/server.rb

Defined Under Namespace

Modules: ServerHelpers

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Hookable

included

Constructor Details

#initialize(module_name = HaveAPI.module_name) ⇒ Server

Returns a new instance of Server.



75
76
77
78
79
80
 
# File 'lib/haveapi/server.rb', line 75

def initialize(module_name = HaveAPI.module_name)
  @module_name = module_name
  @allowed_headers = ['Content-Type']
  @auth_chain = HaveAPI::Authentication::Chain.new(self)
  @extensions = []
end

Instance Attribute Details

#auth_chain ⇒ Object (readonly)

Returns the value of attribute auth_chain.



3
4
5
 
# File 'lib/haveapi/server.rb', line 3

def auth_chain
  @auth_chain
end

#default_version ⇒ Object (readonly)

Returns the value of attribute default_version.



3
4
5
 
# File 'lib/haveapi/server.rb', line 3

def default_version
  @default_version
end

#extensions ⇒ Object (readonly)

Returns the value of attribute extensions.



3
4
5
 
# File 'lib/haveapi/server.rb', line 3

def extensions
  @extensions
end

#module_name ⇒ Object (readonly)

Returns the value of attribute module_name.



3
4
5
 
# File 'lib/haveapi/server.rb', line 3

def module_name
  @module_name
end

#root ⇒ Object (readonly)

Returns the value of attribute root.



3
4
5
 
# File 'lib/haveapi/server.rb', line 3

def root
  @root
end

#routes ⇒ Object (readonly)

Returns the value of attribute routes.



3
4
5
 
# File 'lib/haveapi/server.rb', line 3

def routes
  @routes
end

#versions ⇒ Object (readonly)

Returns the value of attribute versions.



3
4
5
 
# File 'lib/haveapi/server.rb', line 3

def versions
  @versions
end

Instance Method Details

#add_auth_module(v, name, mod, prefix: '') ⇒ Object 



409
410
411
412
413
414
415
 
# File 'lib/haveapi/server.rb', line 409

def add_auth_module(v, name, mod, prefix: '')
  @routes[v] ||= {authentication: {name => {resources: {}}}}

  HaveAPI.get_version_resources(mod, v).each do |r|
    mount_resource("#{@root}_auth/#{prefix}/", v, r, @routes[v][:authentication][name][:resources])
  end
end

#allow_header(name) ⇒ Object 



417
418
419
420
 
# File 'lib/haveapi/server.rb', line 417

def allow_header(name)
  @allowed_headers << name unless @allowed_headers.include?(name)
  @allowed_headers_str = nil
end

#allowed_headers ⇒ Object 



422
423
424
425
 
# File 'lib/haveapi/server.rb', line 422

def allowed_headers
  return @allowed_headers_str if @allowed_headers_str
  @allowed_headers_str = @allowed_headers.join(',')
end

#app ⇒ Object 



427
428
429
 
# File 'lib/haveapi/server.rb', line 427

def app
  @sinatra
end

#describe(context) ⇒ Object 



363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/haveapi/server.rb', line 363

def describe(context)
  context.version = @default_version

  ret = {
      default_version: @default_version,
      versions: {default: describe_version(context)},
  }

  @versions.each do |v|
    context.version = v
    ret[:versions][v] = describe_version(context)
  end

  ret
end

#describe_resource(r, hash, context) ⇒ Object 



401
402
403
 
# File 'lib/haveapi/server.rb', line 401

def describe_resource(r, hash, context)
  r.describe(hash, context)
end

#describe_version(context) ⇒ Object 



379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/haveapi/server.rb', line 379

def describe_version(context)
  ret = {
      authentication: @auth_chain.describe(context),
      resources: {},
      meta: Metadata.describe,
      help: version_prefix(context.version)
  }

  #puts JSON.pretty_generate(@routes)

  @routes[context.version][:resources].each do |resource, children|
    r_name = resource.to_s.demodulize.underscore
    r_desc = describe_resource(resource, children, context)

    unless r_desc[:actions].empty? && r_desc[:resources].empty?
      ret[:resources][r_name] = r_desc
    end
  end

  ret
end

#mount(prefix = '/') ⇒ Object

Load routes for all resource from included API versions. All routes are mounted under prefix path. If no default version is set, the last included version is used.



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/haveapi/server.rb', line 111

def mount(prefix='/')
  @root = prefix

  @sinatra = Sinatra.new do
    set :views, settings.root + '/views'
    set :public_folder, settings.root + '/public'
    set :bind, '0.0.0.0'

    helpers ServerHelpers

    before do
      @formatter = OutputFormatter.new

      unless @formatter.supports?(request.accept)
        @halted = true
        halt 406, "Not Acceptable\n"
      end

      content_type @formatter.content_type, charset: 'utf-8'

      if request.env['HTTP_ORIGIN']
        headers 'Access-Control-Allow-Origin' => '*',
                'Access-Control-Allow-Credentials' => 'false'
      end
    end

    not_found do
      report_error(404, {}, 'Action not found') unless @halted
    end

    after do
      ActiveRecord::Base.clear_active_connections!
    end
  end

  @sinatra.set(:api_server, self)

  @routes = {}
  @default_version ||= @versions.last

  # Mount root
  @sinatra.get @root do
    authenticated?(settings.api_server.default_version)

    @api = settings.api_server.describe(Context.new(settings.api_server, user: current_user,
                                        params: params))

    content_type 'text/html'
    erb :index, layout: :main_layout
  end

  @sinatra.options @root do
    access_control
    authenticated?(settings.api_server.default_version)
    ret = nil

    case params[:describe]
      when 'versions'
        ret = {versions: settings.api_server.versions,
               default: settings.api_server.default_version}

      when 'default'
        ret = settings.api_server.describe_version(Context.new(settings.api_server, version: settings.api_server.default_version,
                                                              user: current_user, params: params))

      else
        ret = settings.api_server.describe(Context.new(settings.api_server, user: current_user,
                                                       params: params))
    end

    @formatter.format(true, ret)
  end

  # Doc
  @sinatra.get "#{@root}doc" do
    content_type 'text/html'
    erb :main_layout do
      doc(:index)
    end
  end

  @sinatra.get "#{@root}doc/readme" do
    content_type 'text/html'
    erb :main_layout do
      GitHub::Markdown.render(File.new(settings.views + '/../../../README.md').read)
    end
  end

  @sinatra.get %r{#{@root}doc/([^\.]+)[\.md]?} do |f|
    content_type 'text/html'
    erb :doc_layout, layout: :main_layout do
      begin
        @content = doc(f)

      rescue Errno::ENOENT
        halt 404
      end

      @sidebar = erb :"doc_sidebars/#{f}"
    end
  end

  # Login/logout links
  @sinatra.get "#{root}_login" do
    if current_user
      redirect back
    else
      authenticate!(settings.api_server.default_version) # FIXME
    end
  end

  @sinatra.get "#{root}_logout" do
    require_auth!
  end

  @auth_chain << HaveAPI.default_authenticate if @auth_chain.empty?
  @auth_chain.setup(@versions)

  @extensions.each { |e| e.enabled }

  # Mount default version first
  mount_version(@root, @default_version)

  @versions.each do |v|
    mount_version(version_prefix(v), v)
  end
end

#mount_action(v, route) ⇒ Object 



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/haveapi/server.rb', line 299

def mount_action(v, route)
  @sinatra.method(route.http_method).call(route.url) do
    authenticate!(v) if route.action.auth

    request.body.rewind

    begin
      body = request.body.read

      if body.empty?
        body = nil
      else
        body = JSON.parse(body, symbolize_names: true)
      end

    rescue => e
      report_error(400, {}, 'Bad JSON syntax')
    end

    action = route.action.new(request, v, params, body, Context.new(settings.api_server, version: v,
                                                                    action: route.action, url: route.url,
                                                                    params: params,
                                                                    user: current_user, endpoint: true))

    unless action.authorized?(current_user)
      report_error(403, {}, 'Access denied. Insufficient permissions.')
    end

    status, reply, errors = action.safe_exec

    @formatter.format(
        status,
        status  ? reply : nil,
        !status ? reply : nil,
        errors
    )
  end

  @sinatra.options route.url do |*args|
    access_control
    route_method = route.http_method.to_s.upcase

    pass if params[:method] && params[:method] != route_method

    authenticate!(v) if route.action.auth

    begin
      desc = route.action.describe(Context.new(settings.api_server, version: v,
                                               action: route.action, url: route.url,
                                               args: args, params: params,
                                               user: current_user, endpoint: true))

      unless desc
        report_error(403, {}, 'Access denied. Insufficient permissions.')
      end

    rescue ActiveRecord::RecordNotFound
      report_error(404, {}, 'Object not found')
    end

    @formatter.format(true, desc)
  end
end

#mount_nested_resource(v, routes) ⇒ Object 



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/haveapi/server.rb', line 283

def mount_nested_resource(v, routes)
  ret = {resources: {}, actions: {}}

  routes.each do |route|
    if route.is_a?(Hash)
      ret[:resources][route.keys.first] = mount_nested_resource(v, route.values.first)

    else
      ret[:actions][route.action] = route.url
      mount_action(v, route)
    end
  end

  ret
end

#mount_resource(prefix, v, resource, hash) ⇒ Object 



269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/haveapi/server.rb', line 269

def mount_resource(prefix, v, resource, hash)
  hash[resource] = {resources: {}, actions: {}}

  resource.routes(prefix).each do |route|
    if route.is_a?(Hash)
      hash[resource][:resources][route.keys.first] = mount_nested_resource(v, route.values.first)

    else
      hash[resource][:actions][route.action] = route.url
      mount_action(v, route)
    end
  end
end

#mount_version(prefix, v) ⇒ Object 



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/haveapi/server.rb', line 239

def mount_version(prefix, v)
  @routes[v] ||= {}
  @routes[v][:resources] = {}

  @sinatra.get prefix do
    authenticated?(v)

    @v = v
    @help = settings.api_server.describe_version(Context.new(settings.api_server, version: v,
                                                             user: current_user, params: params))
    content_type 'text/html'
    erb :doc_layout, layout: :main_layout do
      @content = erb :version_page
      @sidebar = erb :version_sidebar
    end
  end

  @sinatra.options prefix do
    access_control
    authenticated?(v)

    @formatter.format(true, settings.api_server.describe_version(Context.new(settings.api_server, version: v,
                                                                          user: current_user, params: params)))
  end

  HaveAPI.get_version_resources(@module_name, v).each do |resource|
    mount_resource(prefix, v, resource, @routes[v][:resources])
  end
end

#set_default_version(v) ⇒ Object

Set default version of API.



104
105
106
 
# File 'lib/haveapi/server.rb', line 104

def set_default_version(v)
  @default_version = v
end

#start! ⇒ Object 



431
432
433
 
# File 'lib/haveapi/server.rb', line 431

def start!
  @sinatra.run!
end

#use_version(v, default: false) ⇒ Object

Include specific version v of API. v can be one of:

:all

use all available versions

Array

use all versions in Array

version

include only concrete version

default is set only when including concrete version. Use set_default_version otherwise.



89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/haveapi/server.rb', line 89

def use_version(v, default: false)
  @versions ||= []

  if v == :all
    @versions = HaveAPI.get_versions(@module_name)
  elsif v.is_a?(Array)
    @versions += v
    @versions.uniq!
  else
    @versions << v
    @default_version = v if default
  end
end

#version_prefix(v) ⇒ Object 



405
406
407
 
# File 'lib/haveapi/server.rb', line 405

def version_prefix(v)
  "#{@root}v#{v}/"
end