haveapi 0.18.1 → 0.19.0

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
 

data/lib/haveapi/validators/exclusion.rb

@@ -12,8 +12,8 @@ module HaveAPI
   #     message: 'the error message'
   #   }
   #
-  # In this case, the value could be anything but +one+, +two+ or
-  # +three+.
+  # In this case, the value could be anything but `one`, `two` or
+  # `three`.
   class Validators::Exclusion < Validator
     name :exclude
     takes :exclude
@@ -28,8 +28,8 @@ module HaveAPI
 
     def describe
       {
-          values: @values,
-          message: @message,
+        values: @values,
+        message: @message,
       }
     end
 

data/lib/haveapi/validators/format.rb

@@ -25,10 +25,10 @@ module HaveAPI
 
     def describe
       {
-          rx: @rx.source,
-          match: @match,
-          description: @desc,
-          message: @message,
+        rx: @rx.source,
+        match: @match,
+        description: @desc,
+        message: @message,
       }
     end
 

data/lib/haveapi/validators/inclusion.rb

@@ -12,7 +12,7 @@ module HaveAPI
   #     message: 'the error message'
   #   }
   #
-  # Option +choices+ is an alias to +include+.
+  # Option `choices` is an alias to `include`.
   class Validators::Inclusion < Validator
     name :include
     takes :choices, :include
@@ -36,8 +36,8 @@ module HaveAPI
 
     def describe
       {
-          values: @values,
-          message: @message,
+        values: @values,
+        message: @message,
       }
     end
 

data/lib/haveapi/validators/length.rb

@@ -47,7 +47,7 @@ module HaveAPI
 
     def describe
       ret = {
-          message: @message,
+        message: @message,
       }
 
       if @equals

data/lib/haveapi/validators/numericality.rb

@@ -11,7 +11,7 @@ module HaveAPI
   #     message: 'the error message'
   #   }
   #
-  # Will allow values +3+, +5+, +7+ and +9+.
+  # Will allow values `3`, `5`, `7` and `9`.
   #
   #   string :param, number: {
   #     min: 3,
@@ -19,7 +19,7 @@ module HaveAPI
   #     mod: 2,
   #   }
   #
-  # Will allow values +4+, +6+, +8+ and +10+.
+  # Will allow values `4`, `6`, `8` and `10`.
   class Validators::Numericality < Validator
     name :number
     takes :number
@@ -74,7 +74,7 @@ module HaveAPI
 
     def describe
       ret = {
-          message: @message,
+        message: @message,
       }
 
       ret[:min] = @min if @min

data/lib/haveapi/validators/presence.rb

@@ -27,8 +27,8 @@ module HaveAPI
 
     def describe
       {
-          empty: @empty,
-          message: @message,
+        empty: @empty,
+        message: @message,
       }
     end
 

data/lib/haveapi/version.rb

@@ -1,4 +1,4 @@
 module HaveAPI
   PROTOCOL_VERSION = '2.0'
-  VERSION = '0.18.1'
+  VERSION = '0.19.0'
 end

data/lib/haveapi/views/version_page/auth_body.erb

@@ -12,10 +12,12 @@
   </dl>
 <% elsif name == :oauth2 %>
   <dl>
-    <dt>Authorize path:</dt>
-    <dd><%= info[:authorize_path] %></dd>
-    <dt>Token path:</dt>
-    <dd><%= info[:token_path] %></dd>
+    <dt>Authorize URL:</dt>
+    <dd><%= info[:authorize_url] %></dd>
+    <dt>Token URL:</dt>
+    <dd><%= info[:token_url] %></dd>
+    <dt>Revoke URL:</dt>
+    <dd><%= info[:revoke_url] %></dd>
   </dl>
 <% end %>
 

data/lib/haveapi/views/version_page/resource_body.erb

@@ -17,6 +17,8 @@
           <dd><%= info[:description] %></dd>
           <dt>Authentication required:</dt>
           <dd><%= info[:auth] ? 'yes' : 'no' %></dd>
+          <dt>Scope:</dt>
+          <dd><%= info[:scope] %></dd>
           <dt>Aliases:</dt>
           <dd><%= info[:aliases].join(', ') %></dd>
           <dt>Blocking:</dt>

data/lib/haveapi.rb

@@ -4,6 +4,7 @@ require 'require_all'
 require 'active_support/inflector'
 require 'active_record' if ar
 require 'sinatra/base'
+require 'sinatra/cookies'
 require 'sinatra/activerecord' if ar
 require 'pp'
 require 'github/markdown'

data/spec/authorization_spec.rb

@@ -40,17 +40,17 @@ describe HaveAPI::Authorization do
       input whitelist: %i(param1)
       allow
     end
-    
+
     expect(auth.authorized?(nil)).to be true
-  
+
     action = Resource::Index
 
     expect(auth.filter_input(
-        action.input.params,
-        action.model_adapter(action.input.layout).input({
-            param1: '123',
-            param2: '456',
-        })
+      action.input.params,
+      action.model_adapter(action.input.layout).input({
+        param1: '123',
+        param2: '456',
+      })
     ).keys).to contain_exactly(:param1)
   end
 
@@ -59,17 +59,17 @@ describe HaveAPI::Authorization do
       input blacklist: %i(param1)
       allow
     end
-    
+
     expect(auth.authorized?(nil)).to be true
-  
+
     action = Resource::Index
 
     expect(auth.filter_input(
-        action.input.params,
-        action.model_adapter(action.input.layout).input({
-            param1: '123',
-            param2: '456',
-        })
+      action.input.params,
+      action.model_adapter(action.input.layout).input({
+        param1: '123',
+        param2: '456',
+      })
     ).keys).to contain_exactly(:param2)
   end
 
@@ -78,17 +78,17 @@ describe HaveAPI::Authorization do
       output whitelist: %i(param1)
       allow
     end
-    
+
     expect(auth.authorized?(nil)).to be true
-  
+
     action = Resource::Index
 
     expect(auth.filter_output(
-        action.output.params,
-        action.model_adapter(action.output.layout).output(nil, {
-            param1: '123',
-            param2: '456',
-        })
+      action.output.params,
+      action.model_adapter(action.output.layout).output(nil, {
+        param1: '123',
+        param2: '456',
+      })
     ).keys).to contain_exactly(:param1)
   end
 
@@ -97,17 +97,17 @@ describe HaveAPI::Authorization do
       output blacklist: %i(param1)
       allow
     end
-    
+
     expect(auth.authorized?(nil)).to be true
-  
+
     action = Resource::Index
 
     expect(auth.filter_output(
-        action.output.params,
-        action.model_adapter(action.output.layout).output(nil, {
-            param1: '123',
-            param2: '456',
-        })
+      action.output.params,
+      action.model_adapter(action.output.layout).output(nil, {
+        param1: '123',
+        param2: '456',
+      })
     ).keys).to contain_exactly(:param2)
   end
 end

data/spec/envelope_spec.rb

@@ -5,10 +5,10 @@ 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
-    
+
     it 'succeeds' do
       call_api(:options, '/')
       expect(api_response).to be_ok
@@ -17,11 +17,11 @@ describe 'Envelope' do
 
   context 'data' do
     empty_api
-    
+
     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/parameters/typed_spec.rb

@@ -11,9 +11,9 @@ describe 'Parameters::Typed' do
 
   it 'does not change provided arguments' do
     kwargs = {
-        label: 'Param 1',
-        desc: 'Desc',
-        required: true,
+      label: 'Param 1',
+      desc: 'Desc',
+      required: true,
     }
     p_arg(kwargs)
     expect(kwargs.keys).to contain_exactly(*%i(label desc required))

data/spec/params_spec.rb

@@ -156,7 +156,7 @@ describe HaveAPI::Params do
 
     expect do
       p.check_layout({
-          my_resource: {}
+        my_resource: {}
       })
     end.not_to raise_error
   end
@@ -171,7 +171,7 @@ describe HaveAPI::Params do
 
     expect do
       p.check_layout({
-          something_bad: {}
+        something_bad: {}
       })
     end.to raise_error(HaveAPI::ValidationError)
   end

data/spec/validators/acceptance_spec.rb

@@ -7,7 +7,7 @@ describe HaveAPI::Validators::Acceptance do
     it "rejects incorrect value" do
       expect(@v.valid?('bar')).to be false
     end
-  end 
+  end
 
   context 'short form' do
     before(:each) do
@@ -20,7 +20,7 @@ describe HaveAPI::Validators::Acceptance do
   context 'full form' do
     before(:each) do
       @v = HaveAPI::Validators::Acceptance.new(:accept, {
-          value: 'foo'
+        value: 'foo'
       })
     end
 

data/spec/validators/confirmation_spec.rb

@@ -7,7 +7,7 @@ describe HaveAPI::Validators::Confirmation do
     it "rejects a different value" do
       expect(@v.validate('bar', {other_param: 'foo'})).to be false
     end
-  end 
+  end
 
   context 'short form' do
     before(:each) do
@@ -20,7 +20,7 @@ describe HaveAPI::Validators::Confirmation do
   context 'full form' do
     before(:each) do
       @v = HaveAPI::Validators::Confirmation.new(:confirm, {
-          param: :other_param
+        param: :other_param
       })
     end
 
@@ -30,8 +30,8 @@ describe HaveAPI::Validators::Confirmation do
   context 'with equal = false' do
     before(:each) do
       @v = HaveAPI::Validators::Confirmation.new(:confirm, {
-          param: :other_param,
-          equal: false
+        param: :other_param,
+        equal: false
       })
     end
 

data/spec/validators/exclusion_spec.rb

@@ -10,7 +10,7 @@ describe HaveAPI::Validators::Exclusion do
       expect(@v.valid?('zero')).to be true
       expect(@v.valid?('four')).to be true
     end
-  end 
+  end
 
   context 'short form' do
     before(:each) do
@@ -23,7 +23,7 @@ describe HaveAPI::Validators::Exclusion do
   context 'full form' do
     before(:each) do
       @v = HaveAPI::Validators::Exclusion.new(:exclude, {
-          values: %w(one two three)
+        values: %w(one two three)
       })
     end
 

data/spec/validators/format_spec.rb

@@ -10,7 +10,7 @@ describe HaveAPI::Validators::Format do
       expect(@v.valid?('bacacb')).to be false
       expect(@v.valid?('b')).to be false
     end
-  end 
+  end
 
   context 'with match = true' do
     context 'short form' do
@@ -24,7 +24,7 @@ describe HaveAPI::Validators::Format do
     context 'full form' do
       before(:each) do
         @v = HaveAPI::Validators::Format.new(:format, {
-            rx: /^a[^b]+b$/
+          rx: /^a[^b]+b$/
         })
       end
 
@@ -35,11 +35,11 @@ describe HaveAPI::Validators::Format do
   context 'with match = false' do
     before(:each) do
       @v = HaveAPI::Validators::Format.new(:format, {
-            rx: /^a[^b]+b$/,
-            match: false
+        rx: /^a[^b]+b$/,
+        match: false
       })
     end
-    
+
     it 'rejects a value that matches the regexp' do
       expect(@v.valid?('aab')).to be false
       expect(@v.valid?('aacacb')).to be false

data/spec/validators/inclusion_spec.rb

@@ -10,15 +10,15 @@ describe HaveAPI::Validators::Inclusion do
       expect(@v.valid?('zero')).to be false
       expect(@v.valid?('four')).to be false
     end
-  end 
+  end
 
   [
-      %w(one two three),
-      {
-          one: 'Fancy one',
-          two: 'Fancy two',
-          three: 'Fancy three'
-      }
+    %w(one two three),
+    {
+      one: 'Fancy one',
+      two: 'Fancy two',
+      three: 'Fancy three'
+    }
   ].each do |include|
     context "with include as a '#{include.class}'" do
       context 'short form' do
@@ -32,7 +32,7 @@ describe HaveAPI::Validators::Inclusion do
       context 'full form' do
         before(:each) do
           @v = HaveAPI::Validators::Inclusion.new(:include, {
-              values: %w(one two three)
+            values: %w(one two three)
           })
         end
 

data/spec/validators/presence_spec.rb

@@ -24,7 +24,7 @@ describe HaveAPI::Validators::Presence do
       before(:each) do
         @v = HaveAPI::Validators::Presence.new(:required, {})
       end
-      
+
       include_examples :all
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: haveapi
 version: !ruby/object:Gem::Version
-  version: 0.18.1
+  version: 0.19.0
 platform: ruby
 authors:
 - Jakub Skokan
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: sinatra-contrib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: tilt
   requirement: !ruby/object:Gem::Requirement
@@ -142,14 +156,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.1
+        version: 0.19.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.1
+        version: 0.19.0
 - !ruby/object:Gem::Dependency
   name: mail
   requirement: !ruby/object:Gem::Requirement
@@ -210,6 +224,7 @@ files:
 - lib/haveapi/authentication/oauth2.rb
 - lib/haveapi/authentication/oauth2/config.rb
 - lib/haveapi/authentication/oauth2/provider.rb
+- lib/haveapi/authentication/oauth2/revoke_endpoint.rb
 - lib/haveapi/authentication/token.rb
 - lib/haveapi/authentication/token/action_config.rb
 - lib/haveapi/authentication/token/action_request.rb
@@ -332,7 +347,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.13
+rubygems_version: 3.4.22
 signing_key:
 specification_version: 4
 summary: Framework for creating self-describing APIs