apipie-bindings 0.2.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: cba70830484b6ca1a333960396c8a1aedb62a80f
-  data.tar.gz: eec92707c91acd40998a7cec3c4457dc19d7695b
+SHA256:
+  metadata.gz: e93c13921f92db59b1bd280310cb4ace26fe6767f97671e4c895cbc7acc04c9e
+  data.tar.gz: fa4bcb25505765dcf6e8c8664465ba068f82fa3e3709466d25b8a359b66ca75d
 SHA512:
-  metadata.gz: 270a782b88c787f507f026fd46afa3948382dcc53fa8317cfa2d8aafce956d796732c5f85e32273bbd6c02bb79b4ba3caa76d6f02a18cdf0bf29d1f2cd2a0077
-  data.tar.gz: 7dd9be1af27f58078c8bb3710de370438c6c11003b2340845d597fcf7c7f04e5ae7e761ef07281b0ad230401469c4bbff9ba4e22cdc5d41389ce021d147a8448
+  metadata.gz: f0e5ad7af8416017fda3a1d6bca9e95ccfbfacc6a0322c66b640975dcaa2af20dba421ea0d09274b473d101c45bdebf88f02102c828a2db6a5a189800274f3ba
+  data.tar.gz: 1caa898dc4998246a0d0843423904f6bc4fb18a230918e841d5f84f560d3c4090ede054ad6c4de4cee4ca44ffdcff74370f95e9356460eaa1c2fb3772e45c666

data/doc/release_notes.md

@@ -1,5 +1,15 @@
 Release notes
 =============
+### 0.5.0 (2022-05-10)
+* Add support for kerberos negotiate auth ([PR #81](https://github.com/Apipie/apipie-bindings/pull/81))
+
+### 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))

data/lib/apipie_bindings/action.rb

@@ -41,7 +41,7 @@ module ApipieBindings
     def examples
       apidoc[:examples].map do |example|
         ApipieBindings::Example.parse(example)
-      end
+      end.compact
     end
 
     def find_route(params={})

data/lib/apipie_bindings/api.rb

@@ -135,7 +135,7 @@ module ApipieBindings
     end
 
     def apidoc
-      @apidoc = @apidoc || load_apidoc || retrieve_apidoc
+      @apidoc ||= load_apidoc || retrieve_apidoc
       @apidoc
     end
 
@@ -280,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/base.rb

@@ -1,6 +1,13 @@
 module ApipieBindings
   module Authenticators
     class Base
+      # In case an authenticator needs to make an authentication call
+      # before the original one you might want to set auth_cookie
+      # returned by the server to be available for futher processing
+      # (e.g. saving the session id) since it may contain session id
+      # to use with all the next calls
+      attr_reader :auth_cookie
+
       def authenticate(request, args)
       end
 

data/lib/apipie_bindings/authenticators/negotiate.rb

@@ -0,0 +1,65 @@
+require 'apipie_bindings/authenticators/base'
+require 'gssapi'
+
+module ApipieBindings
+  module Authenticators
+    # Negotiate authenticator
+    # Implements gssapi negotiation with preexisting kerberos ticket
+    # Requires a authentication url, the authentication request will be against.
+    # This url needs to support auth negotiation and after successful auth it should return 'set-cookie' header with session.
+    # This session will be initiated in the auth request and the original request will be made with this cookie.
+    # Next requests should be already skip the negotiation, please implement Session support in your client, for not using the negotiation on every request.
+    class Negotiate < Base
+
+      # Creates new authenticator for Negotiate auth
+      # @param [String] url to make authentication request to.
+      # @param [Hash] auth_request_options passed to RestClient::Request - especially for SSL options
+      #   see https://github.com/rest-client/rest-client/blob/master/lib/restclient/request.rb.
+      # @option service service principal used for gssapi tickets - defaults to HTTP.
+      # @option method http method used for the auth request - defaults to 'get'.
+      def initialize(authorization_url, auth_request_options = {})
+        @authorization_url = authorization_url
+        @service = auth_request_options.delete(:service) || 'HTTP'
+        auth_request_options[:method] ||= 'get'
+        @auth_request_options = auth_request_options
+      end
+
+      def error(ex)
+        if ex.is_a?(GSSAPI::GssApiError)
+          raise ApipieBindings::AuthenticatorError.new(:negotiate, :no_context, ex)
+        elsif ex.is_a?(ApipieBindings::ConfigurationError)
+          raise ApipieBindings::AuthenticatorError.new(:negotiate, :configuration, ex)
+        else
+          raise ex
+        end
+      end
+
+      def authenticate(original_request, args)
+        uri = URI.parse(@authorization_url)
+        @gsscli = GSSAPI::Simple.new(uri.host, @service)
+
+        token = @gsscli.init_context
+        headers = { 'Authorization' => "Negotiate #{Base64.strict_encode64(token)}" }
+
+        RestClient::Request.execute(@auth_request_options.merge(headers: headers, url: @authorization_url)) do |response, request, raw_response|
+          if response.code == 401
+            raise RestClient::Unauthorized.new(response), 'Negotiation authentication did not pass.'
+          end
+          if response.code == 302 && response.headers[:location].end_with?('/users/login')
+            raise ApipieBindings::ConfigurationError, 'Server misconfiguration detected'
+          end
+
+          # This part is only for next calls, that could be simplified if all resources are behind negotiate auth
+          itok = Array(raw_response['WWW-Authenticate']).pop.split(/\s+/).last
+          @gsscli.init_context(Base64.strict_decode64(itok)) # The context should now return true
+
+          cookie = raw_response['set-cookie'].split('; ')[0]
+          @auth_cookie = cookie
+          original_request['Cookie'] = cookie
+        end
+
+        original_request
+      end
+    end
+  end
+end

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/authenticators.rb

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

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/exceptions.rb

@@ -33,4 +33,13 @@ module ApipieBindings
     end
   end
 
+  class AuthenticatorError < StandardError
+    attr_reader :type, :cause, :original_error
+
+    def initialize(type, cause, original_error)
+      @type = type
+      @cause = cause
+      @original_error = original_error
+    end
+  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.3'
+    @version ||= Gem::Version.new '0.5.0'
   end
 end

data/test/unit/action_test.rb

@@ -60,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
@@ -74,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
@@ -88,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
@@ -103,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
@@ -131,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

data/test/unit/param_test.rb

@@ -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.3
+  version: 0.5.0
 platform: ruby
 authors:
 - Martin Bačovský
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-16 00:00:00.000000000 Z
+date: 2022-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -58,20 +58,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: gssapi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   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
@@ -184,7 +198,9 @@ files:
 - lib/apipie_bindings/authenticators/base.rb
 - lib/apipie_bindings/authenticators/basic_auth.rb
 - lib/apipie_bindings/authenticators/credentials_legacy.rb
+- lib/apipie_bindings/authenticators/negotiate.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
@@ -255,8 +271,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: The Ruby bindings for Apipie documented APIs