haveapi 0.19.3 → 0.21.0

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
 

data/lib/haveapi/validators/exclusion.rb

@@ -29,7 +29,7 @@ module HaveAPI
     def describe
       {
         values: @values,
-        message: @message,
+        message: @message
       }
     end
 

data/lib/haveapi/validators/format.rb

@@ -28,7 +28,7 @@ module HaveAPI
         rx: @rx.source,
         match: @match,
         description: @desc,
-        message: @message,
+        message: @message
       }
     end
 

data/lib/haveapi/validators/inclusion.rb

@@ -37,7 +37,7 @@ module HaveAPI
     def describe
       {
         values: @values,
-        message: @message,
+        message: @message
       }
     end
 

data/lib/haveapi/validators/length.rb

@@ -23,31 +23,31 @@ module HaveAPI
       @equals = take(:equals)
 
       if (@min || @max) && @equals
-        fail 'cannot mix min/max with equals'
+        raise 'cannot mix min/max with equals'
 
       elsif !@min && !@max && !@equals
-        fail 'must use either min, max or equals'
+        raise 'must use either min, max or equals'
       end
 
       msg = if @equals
-        "length has to be #{@equals}"
+              "length has to be #{@equals}"
 
-      elsif @min && !@max
-        "length has to be minimally #{@min}"
+            elsif @min && !@max
+              "length has to be minimally #{@min}"
 
-      elsif !@min && @max
-        "length has to be maximally #{@max}"
+            elsif !@min && @max
+              "length has to be maximally #{@max}"
 
-      else
-        "length has to be in range <#{@min}, #{@max}>"
-      end
+            else
+              "length has to be in range <#{@min}, #{@max}>"
+            end
 
       @message = take(:message, msg)
     end
 
     def describe
       ret = {
-        message: @message,
+        message: @message
       }
 
       if @equals
@@ -67,6 +67,7 @@ module HaveAPI
       return len == @equals if @equals
       return len >= @min if @min && !@max
       return len <= @max if !@min && @max
+
       len >= @min && len <= @max
     end
   end

data/lib/haveapi/validators/numericality.rb

@@ -33,17 +33,17 @@ module HaveAPI
       @odd = take(:odd)
 
       msg = if @min && !@max
-        "has to be minimally #{@min}"
+              "has to be minimally #{@min}"
 
-      elsif !@min && @max
-        "has to be maximally #{@max}"
+            elsif !@min && @max
+              "has to be maximally #{@max}"
 
-      elsif @min && @max
-        "has to be in range <#{@min}, #{@max}>"
+            elsif @min && @max
+              "has to be in range <#{@min}, #{@max}>"
 
-      else
-        'has to be a number'
-      end
+            else
+              'has to be a number'
+            end
 
       if @step
         msg += '; ' unless msg.empty?
@@ -57,16 +57,16 @@ module HaveAPI
 
       if @odd
         msg += '; ' unless msg.empty?
-        msg += "odd"
+        msg += 'odd'
       end
 
       if @even
         msg += '; ' unless msg.empty?
-        msg += "even"
+        msg += 'even'
       end
 
       if @odd && @even
-        fail 'cannot be both odd and even at the same time'
+        raise 'cannot be both odd and even at the same time'
       end
 
       @message = take(:message, msg)
@@ -74,7 +74,7 @@ module HaveAPI
 
     def describe
       ret = {
-        message: @message,
+        message: @message
       }
 
       ret[:min] = @min if @min
@@ -90,6 +90,7 @@ module HaveAPI
     def valid?(v)
       if v.is_a?(::String)
         return false if /\A\d+\z/ !~ v
+
         v = v.to_i
       end
 
@@ -98,7 +99,7 @@ module HaveAPI
       ret = false if @max && v > @max
       ret = false if @step && (v - (@min || 0)) % @step != 0
       ret = false if @mod && v % @mod != 0
-      ret = false if @odd && v % 2 == 0
+      ret = false if @odd && v.even?
       ret = false if @even && v % 2 > 0
       ret
     end

data/lib/haveapi/validators/presence.rb

@@ -20,21 +20,22 @@ module HaveAPI
 
       @empty = take(:empty, false)
       @message = take(
-          :message,
-          @empty ? 'must be present' : 'must be present and non-empty'
+        :message,
+        @empty ? 'must be present' : 'must be present and non-empty'
       )
     end
 
     def describe
       {
         empty: @empty,
-        message: @message,
+        message: @message
       }
     end
 
     def valid?(v)
       return false if v.nil?
       return !v.strip.empty? if !@empty && v.is_a?(::String)
+
       # FIXME: other data types?
       true
     end

data/lib/haveapi/version.rb

@@ -1,4 +1,4 @@
 module HaveAPI
-  PROTOCOL_VERSION = '2.0'
-  VERSION = '0.19.3'
+  PROTOCOL_VERSION = '2.0'.freeze
+  VERSION = '0.21.0'.freeze
 end

data/lib/haveapi.rb

@@ -6,13 +6,12 @@ require 'active_record' if ar
 require 'sinatra/base'
 require 'sinatra/cookies'
 require 'sinatra/activerecord' if ar
-require 'pp'
 require 'github/markdown'
 require 'json'
 
 module HaveAPI
-  module Resources ; end
-  module Actions ; end
+  module Resources; end
+  module Actions; end
 end
 
 require_relative 'haveapi/params'

data/spec/.rubocop.yml

@@ -0,0 +1,4 @@
+inherit_from: ../../../.rubocop.yml
+
+Lint/ConstantDefinitionInBlock:
+  Enabled: false

data/spec/action/dsl_spec.rb

@@ -8,7 +8,7 @@ describe HaveAPI::Action do
           end
         end
 
-        class SubInputAction < InputAction ; end
+        class SubInputAction < InputAction; end
       end
 
       # Invokes execution of input/output blocks
@@ -24,9 +24,9 @@ describe HaveAPI::Action do
           end
         end
 
-        class SubOutputAction < OutputAction ; end
+        class SubOutputAction < OutputAction; end
       end
-    
+
       # Invokes execution of input/output blocks
       Resource.routes
       expect(Resource::SubOutputAction.output.params.first.name).to eq(:param)
@@ -44,11 +44,11 @@ describe HaveAPI::Action do
           end
         end
       end
-   
+
       # Invokes execution of input/output blocks
       Resource.routes
 
-      params = Resource::InputChainAction.input.params.map { |p| p.name }
+      params = Resource::InputChainAction.input.params.map(&:name)
       expect(params).to contain_exactly(:param1, :param2)
     end
 
@@ -64,11 +64,11 @@ describe HaveAPI::Action do
           end
         end
       end
-   
+
       # Invokes execution of input/output blocks
       Resource.routes
 
-      params = Resource::OutputChainAction.output.params.map { |p| p.name }
+      params = Resource::OutputChainAction.output.params.map(&:name)
       expect(params).to contain_exactly(:param1, :param2)
     end
 
@@ -116,16 +116,16 @@ describe HaveAPI::Action do
       # Invokes execution of input/output blocks
       Resource.routes
 
-      input = Resource::SubAction.input.params.map { |p| p.name }
-      output = Resource::SubAction.output.params.map { |p| p.name }
+      input = Resource::SubAction.input.params.map(&:name)
+      output = Resource::SubAction.output.params.map(&:name)
 
-      expect(input).to contain_exactly(*%i(inbase1 inbase2 insub1 insub2 insub3))
-      expect(output).to contain_exactly(*%i(outbase1 outbase2 outsub1 outsub2 outsub3))
+      expect(input).to contain_exactly(*%i[inbase1 inbase2 insub1 insub2 insub3])
+      expect(output).to contain_exactly(*%i[outbase1 outbase2 outsub1 outsub2 outsub3])
     end
 
     it 'sets layout' do
       class Resource < HaveAPI::Resource
-        class DefaultLayoutAction < HaveAPI::Action ; end
+        class DefaultLayoutAction < HaveAPI::Action; end
 
         class ObjectLayoutAction < HaveAPI::Action
           input(:object) {}
@@ -136,17 +136,17 @@ describe HaveAPI::Action do
           input(:object_list) {}
           output(:object_list) {}
         end
-        
+
         class HashLayoutAction < HaveAPI::Action
           input(:hash) {}
           output(:hash) {}
         end
-        
+
         class HashListLayoutAction < HaveAPI::Action
           input(:hash_list) {}
           output(:hash_list) {}
         end
-        
+
         class CombinedLayoutAction < HaveAPI::Action
           input(:hash) {}
           output(:object_list) {}
@@ -176,19 +176,19 @@ describe HaveAPI::Action do
       class ExResourceIn < HaveAPI::Resource
         class ExInputAction < HaveAPI::Action
           input do
-            fail 'this is terrible!'
+            raise 'this is terrible!'
           end
         end
       end
 
       expect { ExResourceIn.routes }.to raise_error(HaveAPI::BuildError)
     end
-    
+
     it 'catches exceptions in output' do
       class ExResourceOut < HaveAPI::Resource
         class ExOutputAction < HaveAPI::Action
           output do
-            fail 'this is terrible!'
+            raise 'this is terrible!'
           end
         end
       end

data/spec/authorization_spec.rb

@@ -37,7 +37,7 @@ describe HaveAPI::Authorization do
 
   it 'whitelists input' do
     auth = HaveAPI::Authorization.new do
-      input whitelist: %i(param1)
+      input whitelist: %i[param1]
       allow
     end
 
@@ -49,14 +49,14 @@ describe HaveAPI::Authorization do
       action.input.params,
       action.model_adapter(action.input.layout).input({
         param1: '123',
-        param2: '456',
+        param2: '456'
       })
     ).keys).to contain_exactly(:param1)
   end
 
   it 'blacklists input' do
     auth = HaveAPI::Authorization.new do
-      input blacklist: %i(param1)
+      input blacklist: %i[param1]
       allow
     end
 
@@ -68,14 +68,14 @@ describe HaveAPI::Authorization do
       action.input.params,
       action.model_adapter(action.input.layout).input({
         param1: '123',
-        param2: '456',
+        param2: '456'
       })
     ).keys).to contain_exactly(:param2)
   end
 
   it 'whitelists output' do
     auth = HaveAPI::Authorization.new do
-      output whitelist: %i(param1)
+      output whitelist: %i[param1]
       allow
     end
 
@@ -87,14 +87,14 @@ describe HaveAPI::Authorization do
       action.output.params,
       action.model_adapter(action.output.layout).output(nil, {
         param1: '123',
-        param2: '456',
+        param2: '456'
       })
     ).keys).to contain_exactly(:param1)
   end
 
   it 'blacklists output' do
     auth = HaveAPI::Authorization.new do
-      output blacklist: %i(param1)
+      output blacklist: %i[param1]
       allow
     end
 
@@ -106,7 +106,7 @@ describe HaveAPI::Authorization do
       action.output.params,
       action.model_adapter(action.output.layout).output(nil, {
         param1: '123',
-        param2: '456',
+        param2: '456'
       })
     ).keys).to contain_exactly(:param2)
   end

data/spec/common_spec.rb

@@ -8,7 +8,7 @@ describe HaveAPI::Common do
     expect(Test1.attr1).to be_nil
     expect(Test1.attr2).to eq(42)
   end
-  
+
   class Test2 < HaveAPI::Common
     has_attr :attr1
     has_attr :attr2, 42
@@ -31,6 +31,7 @@ describe HaveAPI::Common do
     attr2 :bar
 
     def self.inherited(subclass)
+      super
       inherit_attrs(subclass)
     end
   end

data/spec/documentation_spec.rb

@@ -1,29 +1,22 @@
 describe 'Documentation' do
   it 'responds to OPTIONS /' do
-
   end
-  
-  it 'responds to OPTIONS /?describe=versions' do
 
+  it 'responds to OPTIONS /?describe=versions' do
   end
-  
-  it 'responds to OPTIONS /?describe=default' do
 
+  it 'responds to OPTIONS /?describe=default' do
   end
 
   it 'responds to OPTIONS /<version>' do
-
   end
 
   it 'responds to OPTIONS /<every action>?method=<method>' do
-
   end
 
   it 'has online doc' do
-  
   end
 
   it 'has online doc for every version' do
-
   end
 end

data/spec/envelope_spec.rb

@@ -5,7 +5,7 @@ describe 'Envelope' do
     it 'returns correct envelope' do
       call_api(:options, '/')
       expect(api_response.envelope.keys).to contain_exactly(
-        *%i(version status response message errors)
+        *%i[version status response message errors]
       )
     end
 
@@ -21,7 +21,7 @@ describe 'Envelope' do
     it 'returns correct envelope' do
       call_api(:get, '/unknown_resource')
       expect(api_response.envelope.keys).to contain_exactly(
-        *%i(status response message errors)
+        *%i[status response message errors]
       )
     end
 

data/spec/hooks_spec.rb

@@ -7,7 +7,7 @@ describe HaveAPI::Hooks do
     has_hook :ret_hook
     has_hook :context_hook
   end
-  
+
   class InstanceLevel
     include HaveAPI::Hookable
 
@@ -35,10 +35,10 @@ describe HaveAPI::Hooks do
       end
 
     else
-      fail "unknown level '#{@level}'"
+      raise "unknown level '#{@level}'"
     end
   end
-  
+
   shared_examples(:common) do
     it 'calls hooks' do
       called = false
@@ -51,10 +51,10 @@ describe HaveAPI::Hooks do
       call_hooks(:simple_hook)
       expect(called).to be true
     end
-    
+
     it 'passes arguments' do
       called = false
-      
+
       connect_hook(:arg_hook) do |ret, a, b, c|
         called = true
         expect([a, b, c]).to eq([1, 2, 3])
@@ -87,7 +87,7 @@ describe HaveAPI::Hooks do
         end
       end
 
-      sum = call_hooks(:ret_hook, initial: {counter: 0})
+      sum = call_hooks(:ret_hook, initial: { counter: 0 })
       expect(sum[:counter]).to eq(5)
     end
 
@@ -113,7 +113,7 @@ describe HaveAPI::Hooks do
       @obj = ClassLevel
       @level = :class
     end
-    
+
     include_examples :common
   end
 
@@ -123,23 +123,23 @@ describe HaveAPI::Hooks do
         @obj = InstanceLevel.new
         @level = :instance
       end
-      
+
       include_examples :common
     end
-    
+
     context 'only class hooks' do
       # FIXME: class hooks fail (that is correct, no class hooks are defined)
       #        must find a way to test failure
-      #include_examples :common
+      # include_examples :common
     end
-    
+
     context 'only instance hooks' do
       before(:each) do
         @obj = InstanceLevel.new
         @level = :instance
         @method = :call_instance_hooks_for
       end
-      
+
       include_examples :common
     end
   end

data/spec/parameters/typed_spec.rb

@@ -2,21 +2,21 @@ require 'time'
 
 describe 'Parameters::Typed' do
   def p_type(type)
-    HaveAPI::Parameters::Typed.new(:param1, type: type)
+    HaveAPI::Parameters::Typed.new(:param1, type:)
   end
 
   def p_arg(arg = {})
-    HaveAPI::Parameters::Typed.new(*[:param1, arg])
+    HaveAPI::Parameters::Typed.new(:param1, arg)
   end
 
   it 'does not change provided arguments' do
     kwargs = {
       label: 'Param 1',
       desc: 'Desc',
-      required: true,
+      required: true
     }
     p_arg(kwargs)
-    expect(kwargs.keys).to contain_exactly(*%i(label desc required))
+    expect(kwargs.keys).to contain_exactly(*%i[label desc required])
   end
 
   it 'automatically sets label' do
@@ -63,11 +63,11 @@ describe 'Parameters::Typed' do
     # Boolean
     p = p_type(Boolean)
 
-    %w(true t yes y 1).each do |v|
+    %w[true t yes y 1].each do |v|
       expect(p.clean(v)).to be true
     end
 
-    %w(false f no n 0).each do |v|
+    %w[false f no n 0].each do |v|
       expect(p.clean(v)).to be false
     end