apipie-bindings 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6e8560165daeb6cae4d2530f42a9adc58e1511e3
-  data.tar.gz: 9291144917dc1a6111ba60e01de1096338c47b3a
+SHA256:
+  metadata.gz: 5c27168a737308891f84a0437f14b21247d4054651f698f888ef3a5e80dced00
+  data.tar.gz: 6d68349f382e9282d5674db0e175280d05952ea35004a6dc525d896b93ae46c6
 SHA512:
-  metadata.gz: 59e41d190c6bf09379b1a2b9b7f6f56923a1f9e4adb3289e49a61c61fc23d6c6831c1e57e0273c4b6f1a5cb6f067db502016812e5c3d2c13c093f307060e7891
-  data.tar.gz: 360e2e4781f437a0627b015acfb59de2cd291e9c66941d21c548fab65dacf164f3a5fbb88f037125be78ff1f3d7bdee640ed31e5c8c34eba6a620b5ae5317b30
+  metadata.gz: eeb6522be945abe8c90588ac382751e4cf0ece7b898ae233def0a73d9d621264ee5bb4494e5da4921a75cde2af8fe078be3aa4875441e54390417b9948ff75b5
+  data.tar.gz: 1ac904b2c5e2ea670246619fe8d1e5b3450cc7567f716692506311e0ce5a0130191862e71e9ef253fcb87437a88fa9213ab3e93b57a902f7d0f6c056c2c18f04

data/doc/release_notes.md

@@ -1,5 +1,25 @@
 Release notes
 =============
+### 0.4.0 (2020-05-29)
+* support Ruby 2.7 ([PR #79](https://github.com/Apipie/apipie-bindings/pull/79))
+
+### 0.3.0 (2019-10-25)
+* Add token based auth mechanism ([PR #77](https://github.com/Apipie/apipie-bindings/pull/77))
+* Throw malformed examples ([PR #78](https://github.com/Apipie/apipie-bindings/pull/78))
+
+### 0.2.3 (2019-01-16)
+* Remove error log output from specs ([PR #76](https://github.com/Apipie/apipie-bindings/pull/76))
+* Update apidoc_cache_name apidoc ([PR #74](https://github.com/Apipie/apipie-bindings/pull/74))
+* Fix typo in api docs ([PR #75](https://github.com/Apipie/apipie-bindings/pull/75))
+* Fix typo in param test ([PR #73](https://github.com/Apipie/apipie-bindings/pull/73))
+
+### 0.2.2 (2018-01-09)
+* modernize ruby versions ([PR #71](https://github.com/Apipie/apipie-bindings/pull/71))
+
+### 0.2.1 (2018-01-06)
+* Do not allow NIL as a route parameter ([PR #70](https://github.com/Apipie/apipie-bindings/pull/70)) ([#22009](http://projects.theforeman.org/issues/22009))
+* update cache on error responses ([PR #67](https://github.com/Apipie/apipie-bindings/pull/67))
+* pin oauth to support ruby < 2.0.0 ([PR #69](https://github.com/Apipie/apipie-bindings/pull/69))
 
 ### 0.2.0 (2017-04-24)
 * Support for overriding exceptions from authorizers ([PR #64](https://github.com/Apipie/apipie-bindings/pull/64))

data/lib/apipie_bindings/action.rb

@@ -41,14 +41,14 @@ module ApipieBindings
     def examples
       apidoc[:examples].map do |example|
         ApipieBindings::Example.parse(example)
-      end
+      end.compact
     end
 
     def find_route(params={})
       sorted_routes = routes.sort_by { |r| [-1 * r.params_in_path.count, r.path] }
 
       suitable_route = sorted_routes.find do |route|
-        route.params_in_path.all? { |path_param| params.keys.map(&:to_s).include?(path_param) }
+        route.params_in_path.all? { |path_param| !params[path_param.to_sym].nil? || !params[path_param].nil? }
       end
 
       suitable_route ||= sorted_routes.last

data/lib/apipie_bindings/api.rb

@@ -29,7 +29,7 @@ module ApipieBindings
     #   directory for building apidoc_cache_dir
     # @option config [String] :apidoc_cache_dir (apidoc_cache_base_dir+'/<URI>') where
     #   to cache the JSON description of the API
-    # @option config [String] :apidoc_cache_name ('default.json') name of te cache file.
+    # @option config [String] :apidoc_cache_name ('default') name of the cache file.
     #   If there is cache in the :apidoc_cache_dir, it is used.
     # @option config [String] :apidoc_authenticated (true) whether or not does the call to
     #   obtain API description use authentication. It is useful to avoid unnecessary prompts
@@ -135,7 +135,7 @@ module ApipieBindings
     end
 
     def apidoc
-      @apidoc = @apidoc || load_apidoc || retrieve_apidoc
+      @apidoc ||= load_apidoc || retrieve_apidoc
       @apidoc
     end
 
@@ -160,7 +160,7 @@ module ApipieBindings
 
     # Call an action in the API.
     # It finds most fitting route based on given parameters
-    # with other attributes neccessary to do an API call.
+    # with other attributes necessary to do an API call.
     # If in dry_run mode {#initialize} it finds fake response data in examples
     # or user provided data. At the end when the response format is JSON it
     # is parsed and returned as ruby objects. If server supports checksum sending
@@ -242,6 +242,9 @@ module ApipieBindings
         rescue => e
           log.error e.message
           log.debug inspect_data(e)
+          if e.respond_to?(:response) && e.response.respond_to?(:headers)
+            update_cache(e.response.headers[:apipie_checksum])
+          end
           override_e = @authenticator.error(e) if authenticate && @authenticator
           raise override_e.is_a?(StandardError) ? override_e : e
         end
@@ -277,7 +280,7 @@ module ApipieBindings
     end
 
     def retrieve_apidoc
-      FileUtils.mkdir_p(@apidoc_cache_dir) unless File.exists?(@apidoc_cache_dir)
+      FileUtils.mkdir_p(@apidoc_cache_dir) unless File.exist?(@apidoc_cache_dir)
       if language
         response = retrieve_apidoc_call("/apidoc/v#{@api_version}.#{language}.json", :safe => true)
         language_family = language.split('_').first

data/lib/apipie_bindings/authenticators.rb

@@ -1,3 +1,4 @@
 require 'apipie_bindings/authenticators/basic_auth'
 require 'apipie_bindings/authenticators/credentials_legacy'
 require 'apipie_bindings/authenticators/oauth'
+require 'apipie_bindings/authenticators/token_auth'

data/lib/apipie_bindings/authenticators/token_auth.rb

@@ -0,0 +1,15 @@
+require 'apipie_bindings/authenticators/base'
+
+module ApipieBindings
+  module Authenticators
+    class TokenAuth < Base
+      def initialize(token)
+        @token = token
+      end
+
+      def authenticate(req, token)
+        req['Authorization'] = "Bearer #{@token}"
+      end
+    end
+  end
+end

data/lib/apipie_bindings/example.rb

@@ -14,7 +14,7 @@ module ApipieBindings
 
     def self.parse(example)
       prep = /(\w+)\ ([^\n]*)\n?(.*)?\n(\d+)\n(.*)/m.match(example)
-      new(*prep[1..5])
+      new(*prep[1..5]) if prep
     end
   end
 

data/lib/apipie_bindings/rest_client_extensions.rb

@@ -16,7 +16,7 @@ module ApipieBindings
     end
 
     unless RestClient.before_execution_procs.include? RestClient::AUTHENTICATOR_EXTENSION
-      RestClient.add_before_execution_proc &RestClient::AUTHENTICATOR_EXTENSION
+      RestClient.add_before_execution_proc(&RestClient::AUTHENTICATOR_EXTENSION)
     end
   end
 end

data/lib/apipie_bindings/route.rb

@@ -17,10 +17,10 @@ module ApipieBindings
     def path(params=nil)
       return @path if params.nil?
 
-      path = params_in_path.inject(@path) do |p, param_name|
+      params_in_path.inject(@path) do |p, param_name|
         param_value = (params[param_name.to_sym] or params[param_name.to_s]) or
           raise ArgumentError, "missing param '#{param_name}' in parameters"
-        p.sub(":#{param_name}", URI.escape(param_value.to_s))
+        p.sub(":#{param_name}", CGI.escape(param_value.to_s))
       end
     end
 

data/lib/apipie_bindings/version.rb

@@ -1,5 +1,5 @@
 module ApipieBindings
   def self.version
-    @version ||= Gem::Version.new '0.2.0'
+    @version ||= Gem::Version.new '0.4.0'
   end
 end

data/test/dummy/app/controllers/comments_controller.rb

@@ -1,6 +1,18 @@
 class CommentsController < ApplicationController
   include Concerns::DummyConcern
 
+  api!
+  api :GET, "archive/comments/:id/"
+  api :GET, "archive/users/:user_id/comments/:id/"
+  param :id, Integer, :required => true
+  param :user_id, Integer
+  param :post_id, Integer
+  def archive
+    params[:user_id] ||= 1
+    params[:post_id] ||= 1
+    render :json => Dummy::Store.show(base_path)
+  end
+
   protected
 
   def base_path

data/test/dummy/config/routes.rb

@@ -6,4 +6,6 @@ Rails.application.routes.draw do
       resources :comments
     end
   end
+  get 'archive/users/:user_id/comment/:id', :to => 'comments#show'
+  get 'archive/comment/:id', :to => 'comments#show'
 end

data/test/unit/action_test.rb

@@ -2,8 +2,9 @@ require File.join(File.dirname(__FILE__), 'test_helper')
 
 describe ApipieBindings::Action do
 
-  let(:resource) { ApipieBindings::API.new({:apidoc_cache_dir => 'test/unit/data',
-    :apidoc_cache_name => 'dummy'}).resource(:users) }
+  let(:dummy_api) { ApipieBindings::API.new({:apidoc_cache_dir => 'test/unit/data',
+    :apidoc_cache_name => 'dummy'}) }
+  let(:resource) { dummy_api.resource(:users)}
 
   it "should allow user to call the action" do
     params = { :a => 1 }
@@ -16,8 +17,21 @@ describe ApipieBindings::Action do
     resource.action(:index).routes.first.must_be_kind_of ApipieBindings::Route
   end
 
-  it "should find suitable route" do
-    resource.action(:index).find_route.path.must_equal "/users"
+  describe "#find_route" do
+    let(:archive_action) { dummy_api.resource(:comments).action(:archive) }
+
+    it "should find suitable route" do
+      resource.action(:index).find_route.path.must_equal "/users"
+    end
+
+    it "should find longest matching route" do
+      archive_action.find_route(:id => 1, :user_id => 1).path.must_equal "/archive/users/:user_id/comments/:id"
+    end
+
+    it "should find longest matching route ignoring nil params in the path" do
+      archive_action.find_route(:id => 1, :user_id => nil).path.must_equal "/archive/comments/:id"
+    end
+
   end
 
   it "should return params" do
@@ -46,7 +60,7 @@ describe ApipieBindings::Action do
       e = proc do
         resource.action(:create).validate!({ :user => { :vip => true } })
       end.must_raise(ApipieBindings::MissingArgumentsError)
-      e.message.must_match /: user\[name\]$/
+      e.message.must_match(/: user\[name\]$/)
     end
 
     it "should raise on missing nested required params (hash)" do
@@ -60,7 +74,7 @@ describe ApipieBindings::Action do
           }
         })
       end.must_raise(ApipieBindings::MissingArgumentsError)
-      e.message.must_match /: user\[address\]\[city\]$/
+      e.message.must_match(/: user\[address\]\[city\]$/)
     end
 
     it "should raise on missing nested required params (array)" do
@@ -74,7 +88,7 @@ describe ApipieBindings::Action do
           }
         })
       end.must_raise(ApipieBindings::MissingArgumentsError)
-      e.message.must_match /: user\[contacts\]\[0\]\[contact\]$/
+      e.message.must_match(/: user\[contacts\]\[0\]\[contact\]$/)
     end
 
     it "should raise on invalid param format" do
@@ -89,8 +103,8 @@ describe ApipieBindings::Action do
           }
         })
       end.must_raise(ApipieBindings::InvalidArgumentTypesError)
-      e.message.must_match /user\[contacts\]\[0\] - Hash was expected/
-      e.message.must_match /user\[contacts\]\[1\] - Hash was expected/
+      e.message.must_match(/user\[contacts\]\[0\] - Hash was expected/)
+      e.message.must_match(/user\[contacts\]\[1\] - Hash was expected/)
     end
 
     it "should accept minimal correct params" do
@@ -117,7 +131,7 @@ describe ApipieBindings::Action do
   end
 
   it "should have name visible in puts" do
-    out, err = capture_io { puts resource.action(:index) }
+    out, _err = capture_io { puts resource.action(:index) }
     out.must_equal "<Action users:index>\n"
   end
 

data/test/unit/api_test.rb

@@ -76,7 +76,7 @@ describe ApipieBindings::API do
       request_args = RestClient.version >= '1.8.0' ? args.last.args : args.last
       request_args[:method] == :post && request_args[:params] == {:file => s} && request_args[:headers] == headers
     end
-    result = api.http_call(:post, '/api/path', {:file => s}, headers, {:response => :raw})
+    api.http_call(:post, '/api/path', {:file => s}, headers, {:response => :raw})
   end
 
   it "should process nil response safely" do
@@ -229,7 +229,8 @@ describe ApipieBindings::API do
         :uri => 'http://example.com',
         :api_version => 2,
         :apidoc_cache_base_dir => cache_dir,
-        :authenticator => authenticator
+        :authenticator => authenticator,
+        :logger => Logger.new(File::NULL)
       }
       base_params.merge(params)
     end
@@ -371,7 +372,10 @@ describe ApipieBindings::API do
     it "should call clear_credentials when doing authenticated call and auth error is raised" do
       Dir.mktmpdir do |dir|
         credentials = ApipieBindings::AbstractCredentials.new
-        api = ApipieBindings::API.new({:uri => 'http://example.com', :apidoc_cache_base_dir => dir, :api_version => 2,
+        api = ApipieBindings::API.new({:uri => 'http://example.com',
+                                       :logger => Logger.new(File::NULL),
+                                       :apidoc_cache_base_dir => dir,
+                                       :api_version => 2,
                                        :credentials => credentials})
         credentials.expects(:clear)
         api.stubs(:call_client).raises(RestClient::Unauthorized)

data/test/unit/data/dummy.json

@@ -1 +1 @@
-{"docs":{"name":"Dummy","info":"Another API description","copyright":null,"doc_url":"./apipie/1.0","api_url":"/","resources":{"posts":{"doc_url":"./apipie/1.0/posts","api_url":"/","name":"Posts","short_description":null,"full_description":null,"version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"./apipie/1.0/posts/index","name":"index","apis":[{"api_url":"/users/:user_id/posts","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[]},{"doc_url":"./apipie/1.0/posts/show","name":"show","apis":[{"api_url":"/users/:user_id/posts/:id","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[]},{"doc_url":"./apipie/1.0/posts/create","name":"create","apis":[{"api_url":"/users/:user_id/posts","http_method":"POST","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[]},{"doc_url":"./apipie/1.0/posts/update","name":"update","apis":[{"api_url":"/users/:user_id/posts/:id","http_method":"PATCH","short_description":null,"deprecated":null},{"api_url":"/users/:user_id/posts/:id","http_method":"PUT","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[]},{"doc_url":"./apipie/1.0/posts/destroy","name":"destroy","apis":[{"api_url":"/users/:user_id/posts/:id","http_method":"DELETE","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[]}]},"users":{"doc_url":"./apipie/1.0/users","api_url":"/","name":"Users","short_description":null,"full_description":null,"version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"./apipie/1.0/users/index","name":"index","apis":[{"api_url":"/users","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":["GET /users\n200\n[ {\"user\":{\"name\":\"John Doe\" }} ]\n"],"metadata":null,"see":[]},{"doc_url":"./apipie/1.0/users/show","name":"show","apis":[{"api_url":"/users/:id","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[]},{"doc_url":"./apipie/1.0/users/create","name":"create","apis":[{"api_url":"/users","http_method":"POST","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"user","full_name":"user","description":"","required":false,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"name","full_name":"user[name]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"vip","full_name":"user[vip]","description":"","required":false,"allow_nil":false,"validator":"Must be 'true' or 'false'","expected_type":"boolean","metadata":null,"show":true},{"name":"address","full_name":"user[address]","description":"","required":false,"allow_nil":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"city","full_name":"user[address][city]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"street","full_name":"user[address][street]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}]},{"name":"contacts","full_name":"user[contacts]","description":"","required":false,"allow_nil":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"contact","full_name":"user[contacts][contact]","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"kind","full_name":"user[contacts][kind]","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}]}]}],"examples":[],"metadata":null,"see":[]},{"doc_url":"./apipie/1.0/users/update","name":"update","apis":[{"api_url":"/users/:id","http_method":"PATCH","short_description":null,"deprecated":null},{"api_url":"/users/:id","http_method":"PUT","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[]},{"doc_url":"./apipie/1.0/users/destroy","name":"destroy","apis":[{"api_url":"/users/:id","http_method":"DELETE","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[]},{"doc_url":"./apipie/1.0/users/create_unnested","name":"create_unnested","apis":[{"api_url":"/users/create_unnested","http_method":"POST","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[]}]},"comments":{"doc_url":"./apipie/1.0/comments","api_url":"/","name":"Comments","short_description":null,"full_description":null,"version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"./apipie/1.0/comments/index","name":"index","apis":[{"api_url":"/users/:user_id/posts/:post_id/comments","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[]},{"doc_url":"./apipie/1.0/comments/show","name":"show","apis":[{"api_url":"/users/:user_id/posts/:post_id/comments/:id","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[]},{"doc_url":"./apipie/1.0/comments/create","name":"create","apis":[{"api_url":"/users/:user_id/posts/:post_id/comments","http_method":"POST","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[]},{"doc_url":"./apipie/1.0/comments/update","name":"update","apis":[{"api_url":"/users/:user_id/posts/:post_id/comments/:id","http_method":"PATCH","short_description":null,"deprecated":null},{"api_url":"/users/:user_id/posts/:post_id/comments/:id","http_method":"PUT","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[]},{"doc_url":"./apipie/1.0/comments/destroy","name":"destroy","apis":[{"api_url":"/users/:user_id/posts/:post_id/comments/:id","http_method":"DELETE","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[]}]}},"link_extension":".html"}}
+{"docs":{"name":"Dummy","info":"\n\u003cp\u003eAnother API description\u003c/p\u003e\n","copyright":null,"doc_url":"./apipie/1.0","api_url":"/","resources":{"posts":{"doc_url":"./apipie/1.0/posts","api_url":"/","name":"Posts","short_description":null,"full_description":null,"version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"./apipie/1.0/posts/index","name":"index","apis":[{"api_url":"/users/:user_id/posts","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"./apipie/1.0/posts/show","name":"show","apis":[{"api_url":"/users/:user_id/posts/:id","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"./apipie/1.0/posts/create","name":"create","apis":[{"api_url":"/users/:user_id/posts","http_method":"POST","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"./apipie/1.0/posts/update","name":"update","apis":[{"api_url":"/users/:user_id/posts/:id","http_method":"PATCH","short_description":null,"deprecated":null},{"api_url":"/users/:user_id/posts/:id","http_method":"PUT","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"./apipie/1.0/posts/destroy","name":"destroy","apis":[{"api_url":"/users/:user_id/posts/:id","http_method":"DELETE","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"users":{"doc_url":"./apipie/1.0/users","api_url":"/","name":"Users","short_description":null,"full_description":null,"version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"./apipie/1.0/users/index","name":"index","apis":[{"api_url":"/users","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":["GET /users\n200\n[ {\"user\":{\"name\":\"John Doe\" }} ]\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"./apipie/1.0/users/show","name":"show","apis":[{"api_url":"/users/:id","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"./apipie/1.0/users/create","name":"create","apis":[{"api_url":"/users","http_method":"POST","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"user","full_name":"user","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"user[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vip","full_name":"user[vip]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"address","full_name":"user[address]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"city","full_name":"user[address][city]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"street","full_name":"user[address][street]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"contacts","full_name":"user[contacts]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"contact","full_name":"user[contacts][contact]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"kind","full_name":"user[contacts][kind]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"./apipie/1.0/users/update","name":"update","apis":[{"api_url":"/users/:id","http_method":"PATCH","short_description":null,"deprecated":null},{"api_url":"/users/:id","http_method":"PUT","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"./apipie/1.0/users/destroy","name":"destroy","apis":[{"api_url":"/users/:id","http_method":"DELETE","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"./apipie/1.0/users/create_unnested","name":"create_unnested","apis":[{"api_url":"/users/create_unnested","http_method":"POST","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"comments":{"doc_url":"./apipie/1.0/comments","api_url":"/","name":"Comments","short_description":null,"full_description":null,"version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"./apipie/1.0/comments/index","name":"index","apis":[{"api_url":"/users/:user_id/posts/:post_id/comments","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"./apipie/1.0/comments/show","name":"show","apis":[{"api_url":"/users/:user_id/posts/:post_id/comments/:id","http_method":"GET","short_description":null,"deprecated":null},{"api_url":"/archive/users/:user_id/comment/:id","http_method":"GET","short_description":null,"deprecated":null},{"api_url":"/archive/comment/:id","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"./apipie/1.0/comments/create","name":"create","apis":[{"api_url":"/users/:user_id/posts/:post_id/comments","http_method":"POST","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"./apipie/1.0/comments/update","name":"update","apis":[{"api_url":"/users/:user_id/posts/:post_id/comments/:id","http_method":"PATCH","short_description":null,"deprecated":null},{"api_url":"/users/:user_id/posts/:post_id/comments/:id","http_method":"PUT","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"./apipie/1.0/comments/destroy","name":"destroy","apis":[{"api_url":"/users/:user_id/posts/:post_id/comments/:id","http_method":"DELETE","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"./apipie/1.0/comments/archive","name":"archive","apis":[{"api_url":"/archive/comments/:id","http_method":"GET","short_description":null,"deprecated":null},{"api_url":"/archive/users/:user_id/comments/:id","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"post_id","full_name":"post_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null}},"link_extension":".html"}}

data/test/unit/param_test.rb

@@ -32,7 +32,7 @@ describe ApipieBindings::Param do
     param.expected_type.must_equal :hash
   end
 
-  it "should have description taht strip html tags" do
+  it "should have description that strip html tags" do
     param.description.must_equal "Architecture"
   end
 
@@ -46,7 +46,7 @@ describe ApipieBindings::Param do
   end
 
   it "should have full name, type and required visible in puts" do
-    out, err = capture_io { puts param }
+    out, _err = capture_io { puts param }
     out.must_equal "<Param *architecture (Hash)>\n"
   end
 

data/test/unit/resource_test.rb

@@ -34,7 +34,7 @@ describe ApipieBindings::Resource do
   end
 
   it "should have name visible in puts" do
-    out, err = capture_io { puts resource }
+    out, _err = capture_io { puts resource }
     out.must_equal "<Resource :users>\n"
   end
 

data/test/unit/route_test.rb

@@ -24,7 +24,7 @@ describe ApipieBindings::Route do
   end
 
   it "should have path visible in puts" do
-    out, err = capture_io { puts route }
+    out, _err = capture_io { puts route }
     out.must_equal "<Route /api/architectures/:id>\n"
   end
 

data/test/unit/test_helper.rb

@@ -12,6 +12,6 @@ SimpleCov.root Pathname.new(File.dirname(__FILE__) + "../../../")
 require 'minitest/autorun'
 require 'minitest/spec'
 require "minitest-spec-context"
-require "mocha/setup"
+require "mocha/minitest"
 
 require 'apipie_bindings'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apipie-bindings
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Martin Bačovský
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-24 00:00:00.000000000 Z
+date: 2020-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -62,16 +62,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 10.1.0
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 10.1.0
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -118,16 +118,16 @@ dependencies:
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -185,6 +185,7 @@ files:
 - lib/apipie_bindings/authenticators/basic_auth.rb
 - lib/apipie_bindings/authenticators/credentials_legacy.rb
 - lib/apipie_bindings/authenticators/oauth.rb
+- lib/apipie_bindings/authenticators/token_auth.rb
 - lib/apipie_bindings/credentials.rb
 - lib/apipie_bindings/example.rb
 - lib/apipie_bindings/exceptions.rb
@@ -248,7 +249,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.8.7
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -256,7 +257,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: The Ruby bindings for Apipie documented APIs