haveapi 0.20.0 → 0.21.0

data/lib/haveapi/server.rb

@@ -6,34 +6,34 @@ require 'haveapi/hooks'
 
 module HaveAPI
   class Server
-    attr_reader :root, :routes, :module_name, :auth_chain, :versions, :default_version,
-                :extensions
-    attr_accessor :action_state
+    attr_accessor :default_version, :action_state
+    attr_reader :root, :routes, :module_name, :auth_chain, :versions, :extensions
 
     include Hookable
 
     # Called after the user was authenticated (or not). The block is passed
     # current user object or nil as an argument.
     has_hook :post_authenticated,
-        desc: 'Called after the user was authenticated',
-        args: {
-          current_user: 'object returned by the authentication backend',
-        }
+             desc: 'Called after the user was authenticated',
+             args: {
+               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',
-        },
-        ret: {
-          http_status: 'HTTP status code to send to client',
-          message: 'error message sent to the client',
-        }
+             desc: 'Called when an exception occurs when building self-description',
+             args: {
+               context: 'HaveAPI::Context',
+               exception: 'exception instance'
+             },
+             ret: {
+               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)
@@ -57,15 +57,15 @@ module HaveAPI
       end
 
       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
-          }, ''
-        end
+        return unless 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
+        }, ''
       end
 
       def current_user
@@ -80,7 +80,7 @@ module HaveAPI
       def require_auth!
         report_error(
           401,
-          {'WWW-Authenticate' => 'Basic realm="Restricted Area"'},
+          { 'WWW-Authenticate' => 'Basic realm="Restricted Area"' },
           'Action requires user to authenticate'
         )
       end
@@ -106,12 +106,12 @@ module HaveAPI
       end
 
       def base_url
-        if request.env['HTTP_X_FORWARDED_SSL'] == 'on'
-          scheme = 'https'
+        scheme = if request.env['HTTP_X_FORWARDED_SSL'] == 'on'
+                   'https'
 
-        else
-          scheme = request.env['rack.url_scheme']
-        end
+                 else
+                   request.env['rack.url_scheme']
+                 end
 
         "#{scheme}://#{request.env['HTTP_HOST']}"
       end
@@ -140,6 +140,7 @@ module HaveAPI
     module DocHelpers
       def format_param_type(param)
         return param[:type] if param[:type] != 'Resource'
+
         "<a href=\"#root-#{param[:resource].join('-')}-show\">#{param[:type]}</a>"
       end
 
@@ -188,14 +189,11 @@ module HaveAPI
     end
 
     # Set default version of API.
-    def default_version=(v)
-      @default_version = v
-    end
 
     # 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.
-    def mount(prefix='/')
+    def mount(prefix = '/')
       @root = prefix
 
       @sinatra = Sinatra.new do
@@ -203,8 +201,8 @@ module HaveAPI
         # for markdown files with extension .md, only .markdown
         Tilt[:md]
 
-        set :views, settings.root + '/views'
-        set :public_folder, settings.root + '/public'
+        set :views, "#{settings.root}/views"
+        set :public_folder, "#{settings.root}/public"
         set :bind, '0.0.0.0'
 
         if settings.development?
@@ -246,10 +244,10 @@ 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:
+                                            ))
 
         content_type 'text/html'
         erb :index, layout: :main_layout
@@ -261,27 +259,27 @@ module HaveAPI
         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
+        ret = case params[:describe]
+              when 'versions'
+                {
+                  versions: settings.api_server.versions,
+                  default: settings.api_server.default_version
+                }
+
+              when 'default'
+                settings.api_server.describe_version(Context.new(
+                                                       settings.api_server,
+                                                       version: settings.api_server.default_version,
+                                                       user: current_user, params:
+                                                     ))
+
+              else
+                settings.api_server.describe(Context.new(
+                                               settings.api_server,
+                                               user: current_user,
+                                               params:
+                                             ))
+              end
 
         @formatter.format(true, ret)
       end
@@ -298,7 +296,7 @@ module HaveAPI
         content_type 'text/html'
 
         erb :main_layout do
-          GitHub::Markdown.render(File.new(settings.views + '/../../../README.md').read)
+          GitHub::Markdown.render(File.new("#{settings.views}/../../../README.md").read)
         end
       end
 
@@ -315,7 +313,6 @@ module HaveAPI
         erb :doc_layout, layout: :main_layout do
           begin
             @content = doc(f)
-
           rescue Errno::ENOENT
             halt 404
           end
@@ -359,11 +356,11 @@ 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:
+                                                     ))
 
         content_type 'text/html'
         erb :doc_layout, layout: :main_layout do
@@ -378,11 +375,11 @@ module HaveAPI
         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:
+                                                                     )))
       end
 
       # Register blocking resource
@@ -404,16 +401,14 @@ module HaveAPI
 
     def validate_resources(resources)
       resources.each_value do |r|
-        r[:actions].each_key do |a|
-          a.validate_build
-        end
+        r[:actions].each_key(&:validate_build)
 
         validate_resources(r[:resources])
       end
     end
 
     def mount_resource(prefix, v, resource, hash)
-      hash[resource] = {resources: {}, actions: {}}
+      hash[resource] = { resources: {}, actions: {} }
 
       resource.routes(prefix).each do |route|
         if route.is_a?(Hash)
@@ -430,7 +425,7 @@ module HaveAPI
     end
 
     def mount_nested_resource(v, routes)
-      ret = {resources: {}, actions: {}}
+      ret = { resources: {}, actions: {} }
 
       routes.each do |route|
         if route.is_a?(Hash)
@@ -460,27 +455,26 @@ module HaveAPI
         begin
           body = request.body.read
 
-          if body.empty?
-            body = nil
-          else
-            body = JSON.parse(body, symbolize_names: true)
-          end
-
-        rescue => e
+          body = if body.empty?
+                   nil
+                 else
+                   JSON.parse(body, symbolize_names: true)
+                 end
+        rescue StandardError => e
           report_error(400, {}, 'Bad JSON syntax')
         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,
-          resource_path: route.resource_path,
-        ))
+                                                              settings.api_server,
+                                                              version: v,
+                                                              request: self,
+                                                              action: route.action,
+                                                              path: route.path,
+                                                              params:,
+                                                              user: current_user,
+                                                              endpoint: true,
+                                                              resource_path: route.resource_path
+                                                            ))
 
         unless action.authorized?(current_user)
           report_error(403, {}, 'Access denied. Insufficient permissions.')
@@ -493,11 +487,11 @@ module HaveAPI
           http_status || 200,
           @formatter.format(
             status,
-            status  ? reply : nil,
-            !status ? reply : nil,
+            status ? reply : nil,
+            status ? nil : reply,
             errors,
             version: false
-          ),
+          )
         ]
       end
 
@@ -520,11 +514,11 @@ module HaveAPI
           request: self,
           action: route.action,
           path: route.path,
-          args: args,
-          params: params,
+          args:,
+          params:,
           user: current_user,
           endpoint: true,
-          resource_path: route.resource_path,
+          resource_path: route.resource_path
         )
 
         begin
@@ -533,8 +527,7 @@ module HaveAPI
           unless desc
             report_error(403, {}, 'Access denied. Insufficient permissions.')
           end
-
-        rescue => e
+        rescue StandardError => e
           tmp = settings.api_server.call_hooks_for(:description_exception, args: [ctx, e])
           report_error(
             tmp[:http_status] || 500,
@@ -552,7 +545,7 @@ module HaveAPI
 
       ret = {
         default_version: @default_version,
-        versions: {default: describe_version(context)},
+        versions: { default: describe_version(context) }
       }
 
       @versions.each do |v|
@@ -571,7 +564,7 @@ module HaveAPI
         help: version_prefix(context.version)
       }
 
-      #puts JSON.pretty_generate(@routes)
+      # puts JSON.pretty_generate(@routes)
 
       @routes[context.version][:resources].each do |resource, children|
         r_name = resource.resource_name.underscore
@@ -601,7 +594,7 @@ module HaveAPI
     end
 
     def add_auth_module(v, name, mod, prefix: '')
-      @routes[v] ||= {authentication: {name => {resources: {}}}}
+      @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])
@@ -615,6 +608,7 @@ module HaveAPI
 
     def allowed_headers
       return @allowed_headers_str if @allowed_headers_str
+
       @allowed_headers_str = @allowed_headers.join(',')
     end
 
@@ -627,6 +621,7 @@ module HaveAPI
     end
 
     private
+
     def do_authenticate(v, request)
       @auth_chain.authenticate(v, request)
     end

data/lib/haveapi/spec/api_response.rb

@@ -1,4 +1,4 @@
-module HaveAPI::Spec    
+module HaveAPI::Spec
   # This class wraps raw reply from the API and provides a more friendly
   # interface.
   class ApiResponse

data/lib/haveapi/spec/helpers.rb

@@ -1,7 +1,7 @@
 require 'rack/test'
 
 module HaveAPI
-  module Spec ; end
+  module Spec; end
 end
 
 require_relative 'api_builder'

data/lib/haveapi/spec/mock_action.rb

@@ -10,21 +10,22 @@ 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:,
+                                                  endpoint: true
+                                                ))
 
       unless action.authorized?(user)
-        fail 'Access denied. Insufficient permissions.'
+        raise 'Access denied. Insufficient permissions.'
       end
 
       status, data, errors = action.safe_exec
-      fail (data || 'action failed') unless status
+      raise(data || 'action failed') unless status
+
       action.instance_exec(@test, &block)
       data
     end

data/lib/haveapi/spec/spec_methods.rb

@@ -28,7 +28,7 @@ module HaveAPI::Spec
     # Two modes:
     #   http_method, path, params = {}
     #   [resource], action, params, &block
-    def call_api(*args, &block)
+    def call_api(*args, &)
       if args[0].is_a?(::Array) || args[1].is_a?(::Symbol)
         r_name, a_name, params = args
 
@@ -42,7 +42,7 @@ module HaveAPI::Spec
         method(action.http_method).call(
           path,
           params && params.to_json,
-          {'Content-Type' => 'application/json'}
+          { 'Content-Type' => 'application/json' }
         )
 
       else
@@ -51,7 +51,7 @@ module HaveAPI::Spec
         method(http_method).call(
           path,
           params && params.to_json,
-          {'Content-Type' => 'application/json'}
+          { 'Content-Type' => 'application/json' }
         )
       end
     end
@@ -79,22 +79,23 @@ module HaveAPI::Spec
       v = version || @api.default_version
       action, path = find_action(v, r_name, a_name)
       m = MockAction.new(self, @api, action, path, v)
-      m.call(params, user: user, &block)
+      m.call(params, user:, &block)
     end
 
     # Return parsed API response.
     # @return [HaveAPI::Spec::ApiResponse]
     def api_response
-      if last_response != @last_response
+      if last_response == @last_response
+        @api_response ||= ApiResponse.new(last_response.body)
+      else
         @last_response = last_response
         @api_response = ApiResponse.new(last_response.body)
 
-      else
-        @api_response ||= ApiResponse.new(last_response.body)
       end
     end
 
     protected
+
     def get_opt(name)
       self.class.opts && self.class.opts[name]
     end
@@ -113,7 +114,7 @@ module HaveAPI::Spec
         end.second
       end
 
-      top[:actions].detect do |k, v|
+      top[:actions].detect do |k, _v|
         k.to_s.demodulize.underscore.to_sym == a_name
       end
     end

data/lib/haveapi/tasks/yard.rb

@@ -3,10 +3,10 @@ require 'haveapi/tasks/hooks'
 def render_doc_file(src, dst)
   src = File.join(File.dirname(__FILE__), '..', '..', '..', src)
 
-  Proc.new do
+  proc do
     File.write(
       dst,
-      ERB.new(File.read(src), 0).result(binding)
+      ERB.new(File.read(src)).result(binding)
     )
   end
 end

data/lib/haveapi/types.rb

@@ -14,13 +14,10 @@ module Boolean
 end
 
 module Datetime
-
 end
 
 module Custom
-
 end
 
 class Text < String
-
 end

data/lib/haveapi/validator.rb

@@ -1,6 +1,6 @@
 module HaveAPI
   # Validators are stored in this module.
-  module Validators ; end
+  module Validators; end
 
   # Base class for all validators.
   #
@@ -37,7 +37,7 @@ module HaveAPI
 
       # True if this validator uses any of options in hash `opts`.
       def use?(opts)
-        !(opts.keys & @takes).empty?
+        opts.keys.intersect?(@takes)
       end
 
       # Use the validator on given set of options in hash `opts`. Used
@@ -45,7 +45,8 @@ module HaveAPI
       def use(opts)
         keys = opts.keys & @takes
 
-        fail 'too many keys' if keys.size > 1
+        raise 'too many keys' if keys.size > 1
+
         new(keys.first, opts.delete(keys.first))
       end
     end
@@ -94,6 +95,7 @@ module HaveAPI
     end
 
     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
@@ -109,6 +111,7 @@ module HaveAPI
       else
         return default unless @opts.is_a?(::Hash)
         return @opts[v] unless @opts[v].nil?
+
         default
       end
     end

data/lib/haveapi/validator_chain.rb

@@ -8,6 +8,7 @@ module HaveAPI
       find_validators(args) do |validator|
         obj = validator.use(args)
         next unless obj.useful?
+
         @required = true if obj.is_a?(Validators::Presence)
         @validators << obj
       end
@@ -21,8 +22,8 @@ module HaveAPI
     def add_or_replace(name, opt)
       args = { name => opt }
 
-      unless v_class = find_validator(args)
-        fail "validator for '#{name}' not found"
+      unless (v_class = find_validator(args))
+        raise "validator for '#{name}' not found"
       end
 
       exists = @validators.detect { |v| v.is_a?(v_class) }
@@ -42,9 +43,9 @@ module HaveAPI
         @validators << obj if obj.useful?
       end
 
-      if v_class == Validators::Presence
-        @required = !opt.nil? && obj.useful? ? true : false
-      end
+      return unless v_class == Validators::Presence
+
+      @required = !opt.nil? && obj.useful?
     end
 
     # Returns true if validator Validators::Presence is used.
@@ -69,15 +70,15 @@ module HaveAPI
 
       @validators.each do |validator|
         next if validator.validate(value, params)
-        ret << validator.message % {
-          value: value
-        }
+
+        ret << (format(validator.message, value:))
       end
 
       ret.empty? ? true : ret
     end
 
     protected
+
     def find_validator(args)
       HaveAPI::Validators.constants.select do |v|
         validator = HaveAPI::Validators.const_get(v)

data/lib/haveapi/validators/acceptance.rb

@@ -16,12 +16,12 @@ module HaveAPI
     takes :accept
 
     def setup
-      if simple?
-        @value = take
+      @value = if simple?
+                 take
 
-      else
-        @value = take(:value)
-      end
+               else
+                 take(:value)
+               end
 
       @message = take(:message, "has to be #{@value}")
     end
@@ -29,7 +29,7 @@ module HaveAPI
     def describe
       {
         value: @value,
-        message: @message,
+        message: @message
       }
     end
 

data/lib/haveapi/validators/confirmation.rb

@@ -23,8 +23,7 @@ module HaveAPI
       @equal = take(:equal, true)
       @message = take(
         :message,
-        @equal ? "must be the same as #{@param}"
-               : "must be different from #{@param}"
+        @equal ? "must be the same as #{@param}" : "must be different from #{@param}"
       )
     end
 
@@ -32,7 +31,7 @@ module HaveAPI
       {
         equal: @equal ? true : false,
         parameter: @param,
-        message: @message,
+        message: @message
       }
     end