haveapi 0.18.2 → 0.19.1

data/lib/haveapi/resources/action_state.rb

@@ -26,12 +26,12 @@ module HaveAPI::Resources
     module Mixin
       def state_to_hash(state)
         hash = {
-            id: state.id,
-            label: state.label,
-            status: state.status,
-            created_at: state.created_at,
-            updated_at: state.updated_at,
-            can_cancel: state.can_cancel?,
+          id: state.id,
+          label: state.label,
+          status: state.status,
+          created_at: state.created_at,
+          updated_at: state.updated_at,
+          can_cancel: state.can_cancel?,
         }
 
         if state.finished?
@@ -68,10 +68,10 @@ module HaveAPI::Resources
       def exec
         ret = []
         actions = @context.server.action_state.list_pending(
-            current_user,
-            input[:offset],
-            input[:limit],
-            input[:order].to_sym
+          current_user,
+          input[:offset],
+          input[:limit],
+          input[:order].to_sym
         )
 
         actions.each do |state|
@@ -110,8 +110,8 @@ module HaveAPI::Resources
 
         loop do
           state = @context.server.action_state.new(
-              current_user,
-              id: params[:action_state_id]
+            current_user,
+            id: params[:action_state_id]
           )
 
           error('action state not found') unless state.valid?
@@ -147,8 +147,8 @@ module HaveAPI::Resources
 
       def exec
         state = @context.server.action_state.new(
-            current_user,
-            id: params[:action_state_id]
+          current_user,
+          id: params[:action_state_id]
         )
 
         return state_to_hash(state) if state.valid?
@@ -168,8 +168,8 @@ module HaveAPI::Resources
 
       def exec
         state = @context.server.action_state.new(
-            current_user,
-            id: params[:action_state_id]
+          current_user,
+          id: params[:action_state_id]
         )
 
         error('action state not found') unless state.valid?

data/lib/haveapi/route.rb

@@ -1,11 +1,12 @@
 module HaveAPI
   class Route
-    attr_reader :path, :sinatra_path, :action
+    attr_reader :path, :sinatra_path, :action, :resource_path
 
-    def initialize(path, action)
+    def initialize(path, action, resource_path)
       @path = path
       @sinatra_path = path.gsub(/:([a-zA-Z\-_]+)/, '{\1}')
       @action = action
+      @resource_path = resource_path
     end
 
     def http_method

data/lib/haveapi/server.rb

@@ -17,21 +17,33 @@ module HaveAPI
     has_hook :post_authenticated,
         desc: 'Called after the user was authenticated',
         args: {
-            current_user: 'object returned by the authentication backend',
+          current_user: 'object returned by the authentication backend',
         }
 
     has_hook :description_exception,
         desc: 'Called when an exception occurs when building self-description',
         args: {
-            context: 'HaveAPI::Context',
-            exception: 'exception instance',
+          context: 'HaveAPI::Context',
+          exception: 'exception instance',
         },
         ret: {
-            http_status: 'HTTP status code to send to client',
-            message: 'error message sent to the client',
+          http_status: 'HTTP status code to send to client',
+          message: 'error message sent to the client',
         }
 
     module ServerHelpers
+      def setup_formatter
+        return if @formatter
+        @formatter = OutputFormatter.new
+
+        unless @formatter.supports?(request.accept)
+          @halted = true
+          halt 406, "Not Acceptable\n"
+        end
+
+        content_type @formatter.content_type, charset: 'utf-8'
+      end
+
       def authenticate!(v)
         require_auth! unless authenticated?(v)
       end
@@ -47,11 +59,11 @@ module HaveAPI
       def access_control
         if request.env['HTTP_ORIGIN'] && request.env['HTTP_ACCESS_CONTROL_REQUEST_METHOD']
           halt 200, {
-                'Access-Control-Allow-Origin' => '*',
-                'Access-Control-Allow-Methods' => 'GET,POST,OPTIONS,PATCH,PUT,DELETE',
-                'Access-Control-Allow-Credentials' => 'false',
-                'Access-Control-Allow-Headers' => settings.api_server.allowed_headers,
-                'Access-Control-Max-Age' => (60*60).to_s
+            'Access-Control-Allow-Origin' => '*',
+            'Access-Control-Allow-Methods' => 'GET,POST,OPTIONS,PATCH,PUT,DELETE',
+            'Access-Control-Allow-Credentials' => 'false',
+            'Access-Control-Allow-Headers' => settings.api_server.allowed_headers,
+            'Access-Control-Max-Age' => (60*60).to_s
           }, ''
         end
       end
@@ -66,12 +78,16 @@ module HaveAPI
       end
 
       def require_auth!
-        report_error(401, {'WWW-Authenticate' => 'Basic realm="Restricted Area"'},
-                     'Action requires user to authenticate')
+        report_error(
+          401,
+          {'WWW-Authenticate' => 'Basic realm="Restricted Area"'},
+          'Action requires user to authenticate'
+        )
       end
 
       def report_error(code, headers, msg)
         @halted = true
+
         content_type @formatter.content_type, charset: 'utf-8'
         halt code, headers, @formatter.format(false, nil, msg, version: false)
       end
@@ -151,13 +167,12 @@ module HaveAPI
       @extensions = []
     end
 
-    # 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.
+    # Include specific version `v` of API.
+    #
+    # `default` is set only when including concrete version. Use {set_default_version}
+    # otherwise.
+    #
+    # @param v [:all, Array<String>, String]
     def use_version(v, default: false)
       @versions ||= []
 
@@ -178,7 +193,7 @@ module HaveAPI
     end
 
     # Load routes for all resource from included API versions.
-    # All routes are mounted under prefix +path+.
+    # All routes are mounted under prefix `path`.
     # If no default version is set, the last included version is used.
     def mount(prefix='/')
       @root = prefix
@@ -198,19 +213,11 @@ module HaveAPI
           set :show_exceptions, false
         end
 
+        helpers Sinatra::Cookies
         helpers ServerHelpers
         helpers DocHelpers
 
         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'
@@ -218,6 +225,7 @@ module HaveAPI
         end
 
         not_found do
+          setup_formatter
           report_error(404, {}, 'Action not found') unless @halted
         end
 
@@ -236,9 +244,9 @@ module HaveAPI
         authenticated?(settings.api_server.default_version)
 
         @api = settings.api_server.describe(Context.new(
-            settings.api_server,
-            user: current_user,
-            params: params
+          settings.api_server,
+          user: current_user,
+          params: params
         ))
 
         content_type 'text/html'
@@ -246,30 +254,31 @@ module HaveAPI
       end
 
       @sinatra.options @root do
+        setup_formatter
         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
-            ))
+        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
-            ))
+        else
+          ret = settings.api_server.describe(Context.new(
+            settings.api_server,
+            user: current_user,
+            params: params
+          ))
         end
 
         @formatter.format(true, ret)
@@ -348,10 +357,10 @@ module HaveAPI
 
         @v = v
         @help = settings.api_server.describe_version(Context.new(
-            settings.api_server,
-            version: v,
-            user: current_user,
-            params: params
+          settings.api_server,
+          version: v,
+          user: current_user,
+          params: params
         ))
 
         content_type 'text/html'
@@ -362,14 +371,15 @@ module HaveAPI
       end
 
       @sinatra.options prefix do
+        setup_formatter
         access_control
         authenticated?(v)
 
         @formatter.format(true, settings.api_server.describe_version(Context.new(
-            settings.api_server,
-            version: v,
-            user: current_user,
-            params: params
+          settings.api_server,
+          version: v,
+          user: current_user,
+          params: params
         )))
       end
 
@@ -380,10 +390,10 @@ module HaveAPI
 
       if action_state
         mount_resource(
-            prefix,
-            v,
-            HaveAPI::Resources::ActionState,
-            @routes[v][:resources]
+          prefix,
+          v,
+          HaveAPI::Resources::ActionState,
+          @routes[v][:resources]
         )
       end
 
@@ -406,8 +416,8 @@ module HaveAPI
       resource.routes(prefix).each do |route|
         if route.is_a?(Hash)
           hash[resource][:resources][route.keys.first] = mount_nested_resource(
-              v,
-              route.values.first
+            v,
+            route.values.first
           )
 
         else
@@ -435,6 +445,8 @@ module HaveAPI
 
     def mount_action(v, route)
       @sinatra.method(route.http_method).call(route.sinatra_path) do
+        setup_formatter
+
         if route.action.auth
           authenticate!(v)
         else
@@ -457,14 +469,15 @@ module HaveAPI
         end
 
         action = route.action.new(request, v, params, body, Context.new(
-            settings.api_server,
-            version: v,
-            request: self,
-            action: route.action,
-            path: route.path,
-            params: params,
-            user: current_user,
-            endpoint: true
+          settings.api_server,
+          version: v,
+          request: self,
+          action: route.action,
+          path: route.path,
+          params: params,
+          user: current_user,
+          endpoint: true,
+          resource_path: route.resource_path,
         ))
 
         unless action.authorized?(current_user)
@@ -475,18 +488,19 @@ module HaveAPI
         @halted = true
 
         [
-            http_status || 200,
-            @formatter.format(
-                status,
-                status  ? reply : nil,
-                !status ? reply : nil,
-                errors,
-                version: false
-            ),
+          http_status || 200,
+          @formatter.format(
+            status,
+            status  ? reply : nil,
+            !status ? reply : nil,
+            errors,
+            version: false
+          ),
         ]
       end
 
       @sinatra.options route.sinatra_path do |*args|
+        setup_formatter
         access_control
         route_method = route.http_method.to_s.upcase
 
@@ -499,15 +513,16 @@ module HaveAPI
         end
 
         ctx = Context.new(
-            settings.api_server,
-            version: v,
-            request: self,
-            action: route.action,
-            path: route.path,
-            args: args,
-            params: params,
-            user: current_user,
-            endpoint: true
+          settings.api_server,
+          version: v,
+          request: self,
+          action: route.action,
+          path: route.path,
+          args: args,
+          params: params,
+          user: current_user,
+          endpoint: true,
+          resource_path: route.resource_path,
         )
 
         begin
@@ -520,9 +535,9 @@ module HaveAPI
         rescue => e
           tmp = settings.api_server.call_hooks_for(:description_exception, args: [ctx, e])
           report_error(
-              tmp[:http_status] || 500,
-              {},
-              tmp[:message] || 'Server error occured'
+            tmp[:http_status] || 500,
+            {},
+            tmp[:message] || 'Server error occured'
           )
         end
 
@@ -534,8 +549,8 @@ module HaveAPI
       context.version = @default_version
 
       ret = {
-          default_version: @default_version,
-          versions: {default: describe_version(context)},
+        default_version: @default_version,
+        versions: {default: describe_version(context)},
       }
 
       @versions.each do |v|
@@ -548,10 +563,10 @@ module HaveAPI
 
     def describe_version(context)
       ret = {
-          authentication: @auth_chain.describe(context),
-          resources: {},
-          meta: Metadata.describe,
-          help: version_prefix(context.version)
+        authentication: @auth_chain.describe(context),
+        resources: {},
+        meta: Metadata.describe,
+        help: version_prefix(context.version)
       }
 
       #puts JSON.pretty_generate(@routes)

data/lib/haveapi/spec/mock_action.rb

@@ -10,13 +10,13 @@ module HaveAPI::Spec
 
     def call(input, user: nil, &block)
       action = @action.new(nil, @v, input, nil, HaveAPI::Context.new(
-          @server,
-          version: @v,
-          action: @action,
-          path: @path,
-          params: input,
-          user: user,
-          endpoint: true
+        @server,
+        version: @v,
+        action: @action,
+        path: @path,
+        params: input,
+        user: user,
+        endpoint: true
       ))
 
       unless action.authorized?(user)

data/lib/haveapi/spec/spec_methods.rb

@@ -35,23 +35,23 @@ module HaveAPI::Spec
         app
 
         action, path = find_action(
-            (params && params[:version]) || @api.default_version,
-            r_name, a_name
+          (params && params[:version]) || @api.default_version,
+          r_name, a_name
         )
 
         method(action.http_method).call(
-            path,
-            params && params.to_json,
-            {'Content-Type' => 'application/json'}
+          path,
+          params && params.to_json,
+          {'Content-Type' => 'application/json'}
         )
 
       else
         http_method, path, params = args
 
         method(http_method).call(
-            path,
-            params && params.to_json,
-            {'Content-Type' => 'application/json'}
+          path,
+          params && params.to_json,
+          {'Content-Type' => 'application/json'}
         )
       end
     end

data/lib/haveapi/tasks/yard.rb

@@ -5,8 +5,8 @@ def render_doc_file(src, dst)
 
   Proc.new do
     File.write(
-        dst,
-        ERB.new(File.read(src), 0).result(binding)
+      dst,
+      ERB.new(File.read(src), 0).result(binding)
     )
   end
 end

data/lib/haveapi/validator.rb

@@ -8,15 +8,15 @@ module HaveAPI
   # when default configuration is sufficient. Custom settings can be set using
   # the full form.
   #
-  # The short form means the validator is configured as +<option> => <single value>+.
-  # The full form is +<option> => { hash with configuration options }+.
+  # The short form means the validator is configured as `<option> => <single value>`.
+  # The full form is `<option> => { hash with configuration options }`.
   #
   # It is up to each validator what exactly the short form means and what options
   # can be set. Specify only those options that you wish to override. The only
-  # common option is +message+ - the error message sent to the client if the provided
+  # common option is `message` - the error message sent to the client if the provided
   # value did not pass the validator.
   #
-  # The +message+ can contain +%{value}+, which is replaced by the actual value
+  # The `message` can contain `%{value}`, which is replaced by the actual value
   # that did not pass the validator.
   class Validator
     class << self
@@ -35,13 +35,13 @@ module HaveAPI
         @takes = opts
       end
 
-      # True if this validator uses any of options in hash +opts+.
+      # True if this validator uses any of options in hash `opts`.
       def use?(opts)
         !(opts.keys & @takes).empty?
       end
 
-      # Use the validator on given set of options in hash +opts+. Used
-      # options are removed from +opts+.
+      # Use the validator on given set of options in hash `opts`. Used
+      # options are removed from `opts`.
       def use(opts)
         keys = opts.keys & @takes
 
@@ -84,7 +84,7 @@ module HaveAPI
     end
 
     # Calls method valid?, but before calling it sets instance variable
-    # +@params+. It contains of hash of all other parameters. The validator
+    # `@params`. It contains of hash of all other parameters. The validator
     # may use this information as it will.
     def validate(v, params)
       @params = params
@@ -96,12 +96,12 @@ module HaveAPI
     protected
     # This method has three modes of function.
     #
-    # 1. If +v+ is nil, it returns +@opts+. It is used if +@opts+ is not a hash
+    # 1. If `v` is nil, it returns `@opts`. It is used if `@opts` is not a hash
     #    but a single value - abbreviation if we're ok with default settings
     #    for given validator.
-    # 2. If +v+ is not nil and +@opts+ is not a hash, it returns +default+
-    # 3. If +v+ is not nil and +@opts+ is a hash and +@opts[v]+ is not nil, it is
-    #    returned. Otherwise the +default+ is returned.
+    # 2. If `v` is not nil and `@opts` is not a hash, it returns `default`
+    # 3. If `v` is not nil and `@opts` is a hash and `@opts[v]` is not nil, it is
+    #    returned. Otherwise the `default` is returned.
     def take(v = nil, default = nil)
       if v.nil?
         @opts
@@ -120,7 +120,7 @@ module HaveAPI
       @useful = false
     end
 
-    # Returns true if +@opts+ is not a hash.
+    # Returns true if `@opts` is not a hash.
     def simple?
       !@opts.is_a?(::Hash)
     end

data/lib/haveapi/validator_chain.rb

@@ -13,11 +13,11 @@ module HaveAPI
       end
     end
 
-    # Adds validator that takes option +name+ with configuration in +opt+.
+    # Adds validator that takes option `name` with configuration in `opt`.
     # If such validator already exists, it is reconfigured with newly provided
-    # +opt+.
+    # `opt`.
     #
-    # If +opt+ is +nil+, the validator is removed.
+    # If `opt` is `nil`, the validator is removed.
     def add_or_replace(name, opt)
       args = { name => opt }
 
@@ -61,8 +61,8 @@ module HaveAPI
       ret
     end
 
-    # Validate +value+ using all configured validators. It returns
-    # either +true+ if the value passed all validators or an array
+    # Validate `value` using all configured validators. It returns
+    # either `true` if the value passed all validators or an array
     # of errors.
     def validate(value, params)
       ret = []
@@ -70,7 +70,7 @@ module HaveAPI
       @validators.each do |validator|
         next if validator.validate(value, params)
         ret << validator.message % {
-            value: value
+          value: value
         }
       end
 

data/lib/haveapi/validators/acceptance.rb

@@ -28,8 +28,8 @@ module HaveAPI
 
     def describe
       {
-          value: @value,
-          message: @message,
+        value: @value,
+        message: @message,
       }
     end
 

data/lib/haveapi/validators/confirmation.rb

@@ -13,7 +13,7 @@ module HaveAPI
   #     message: 'the error message'
   #   }
   #
-  # +equal+ defaults to +true+.
+  # `equal` defaults to `true`.
   class Validators::Confirmation < Validator
     name :confirm
     takes :confirm
@@ -30,9 +30,9 @@ module HaveAPI
 
     def describe
       {
-          equal: @equal ? true : false,
-          parameter: @param,
-          message: @message,
+        equal: @equal ? true : false,
+        parameter: @param,
+        message: @message,
       }
     end