apipie-bindings 0.0.18 → 0.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4734cdf3c653d0886c206128ad15894c3d279470
-  data.tar.gz: 747b17990ca0a2258eee7936b2040d98f7832c80
+  metadata.gz: 1d30b2c120a24152b99526e83b9b913b0e2cda4b
+  data.tar.gz: 918bb3e69af74ef55f9279dbb70f4ea1a5d33da4
 SHA512:
-  metadata.gz: 31986fa92e0941cfd0af5560d134b75b7166f11aaf1550d4b8385adc75c7c68759f93dbfbbb0657089d064d3dff762af5321459c6240babab6e7d5687fa72fb1
-  data.tar.gz: e7c6e55f3d160074635dc8861a93a6965d276425ef383c881ac298a3a936aaa0971b6029a10a10fe211ce7c7337347a90d10a6adee4ede59059de3cfa0c2bbed
+  metadata.gz: 0f64b123b50ae0183bce9d576d37263fff2fc8e0d23ab986befd8971dd0b47cb9ed341636da77dc2e9c56fda3f514744cd7acc1cc58d0f1f20917e32040ac254
+  data.tar.gz: b4a890d819bead44b94fb8dc916b183b480f6383171d7ba692f64667cbb112e5d081ccef7288048649df22130a75c0e634854f34af8a38d5df8de1076d8077ab

data/README.md

@@ -33,8 +33,8 @@ irb> api.resources
 ##### Listing actions
 
 ```
-irb> api.resource(:architectures).actions
-=> [<Action :index>, <Action :show>, <Action :create>, <Action :update>, <Action :destroy>]
+irb> api.resource(:roles).actions
+=> [<Action roles:index>, <Action roles:show>, <Action roles:create>, <Action roles:update>, <Action roles:destroy>]
 ```
 
 ##### Listing routes

data/doc/release_notes.md

@@ -1,6 +1,11 @@
 Release notes
 =============
 
+### 0.0.19 (2016-12-09)
+* Support for more advanced authentication algorithms ([PR #52](https://github.com/theforeman/apipie-bindings/pull/52))
+* Show resource when inspecting Action ([PR #50](https://github.com/theforeman/apipie-bindings/pull/50))
+* Prevent rest-client timeout deprecation warnings ([PR #53](https://github.com/theforeman/apipie-bindings/pull/53))
+
 ### 0.0.18 (2016-08-31)
 * Recover from exception while inspecting error response ([#48](https://github.com/Apipie/apipie-bindings/issues/48))
 * Add yard docs for ApipieBindings::Resource class ([#47](https://github.com/Apipie/apipie-bindings/issues/47))

data/lib/apipie_bindings/action.rb

@@ -108,7 +108,7 @@ module ApipieBindings
     end
 
     def to_s
-      "<Action :#{@name}>"
+      "<Action #{@resource}:#{@name}>"
     end
 
     def inspect

data/lib/apipie_bindings/api.rb

@@ -42,9 +42,10 @@ module ApipieBindings
     #   if the local cache of API description (JSON) is up to date. By default it is checked
     #   *after* each API request
     # @option config [Object] :logger (Logger.new(STDERR)) custom logger class
-    # @option config [Number] :timeout API request timeout in seconds
+    # @option config [Number] :timeout API request timeout in seconds, use -1 to disable timeout
     # @option config [Symbol] :follow_redirects (:default) Possible values are :always, :never and :default.
     #   The :default is to only redirect in GET and HEAD requests (RestClient default)
+    # @option config [AbstractAuthenticator] :authenticator API request authenticator
     # @param [Hash] options params that are passed to ResClient as-is
     # @raise [ApipieBindings::ConfigurationError] when no +:uri+ or +:apidoc_cache_dir+ is provided
     # @example connect to a server
@@ -88,8 +89,15 @@ module ApipieBindings
       log.debug "Global headers: #{inspect_data(headers)}"
       log.debug "Follow redirects: #{@follow_redirects.to_s}"
 
-      @credentials = config[:credentials] if config[:credentials] && config[:credentials].respond_to?(:to_params)
+      if config[:authenticator]
+        @authenticator = config[:authenticator]
+      else
+        @authenticator = legacy_authenticator(config)
+      end
 
+      if (config[:timeout] && config[:timeout].to_i < 0)
+        config[:timeout] = (RestClient.version < '1.7.0') ? -1 : nil
+      end
       @resource_config = {
         :timeout  => config[:timeout],
         :headers  => headers,
@@ -112,8 +120,7 @@ module ApipieBindings
     end
 
     def clear_credentials
-      @client_with_auth = nil
-      @credentials.clear if @credentials
+      @authenticator.clear if @authenticator && @authenticator.respond_to?(:clear)
     end
 
     def apidoc
@@ -215,14 +222,14 @@ module ApipieBindings
         ex = options[:fake_response ] || empty_response
         response = create_fake_response(ex.status, ex.response, http_method, URI.join(@uri || 'http://example.com', path).to_s, args)
       else
+        apidoc_without_auth = (path =~ /\/apidoc\//) && !@apidoc_authenticated
+        authenticate = options[:with_authentication].nil? ? !apidoc_without_auth : options[:with_authentication]
         begin
-          apidoc_without_auth = (path =~ /\/apidoc\//) && !@apidoc_authenticated
-          authenticate = options[:with_authentication].nil? ? !apidoc_without_auth : options[:with_authentication]
           client = authenticate ? authenticated_client : unauthenticated_client
           response = call_client(client, path, args)
           update_cache(response.headers[:apipie_checksum])
         rescue => e
-          clear_credentials if e.is_a? RestClient::Unauthorized
+          @authenticator.error(e) if authenticate && @authenticator
           log.error e.message
           log.debug inspect_data(e)
           raise
@@ -288,6 +295,19 @@ module ApipieBindings
 
     private
 
+    def legacy_authenticator(config)
+      if config[:user] || config[:password]
+        Authenticators::BasicAuth.new(config[:user], config[:password])
+      elsif config[:credentials] && config[:credentials].respond_to?(:to_params)
+        log.warn("Credentials are now deprecated, use custom authenticator instead.")
+        Authenticators::CredentialsLegacy.new(config[:credentials])
+      elsif config[:oauth]
+        log.warn("Passing oauth credentials in hash is now deprecated, use oauth authenticator instead.")
+        oauth = config[:oauth]
+        Authenticators::Oauth.new(oauth[:consumer_key], oauth[:consumer_secret], oauth[:options])
+      end
+    end
+
     def call_client(client, path, args)
       block = rest_client_call_block
       client[path].send(*args, &block)
@@ -298,6 +318,8 @@ module ApipieBindings
         # include request for rest_client < 1.8.0
         response.request ||= request
 
+        request.args[:authenticator].response(response) if request && request.args[:authenticator]
+
         if [301, 302, 307].include?(response.code) && [:always, :never].include?(@follow_redirects)
           if @follow_redirects == :always
             log.debug "Response redirected to #{response.headers[:location]}"
@@ -325,22 +347,23 @@ module ApipieBindings
     end
 
     def authenticated_client
-      unless @client_with_auth
-        resource_config = @resource_config.merge({
-          :user     => @config[:username],
-          :password => @config[:password],
-          :oauth    => @config[:oauth],
-        })
-        resource_config.merge!(@credentials.to_params) if @credentials
-        @client_with_auth = RestClient::Resource.new(@config[:uri], resource_config)
-      end
-      @client_with_auth
+      resource_config = @resource_config.dup
+      resource_config[:authenticator] = get_authenticator
+
+      log.debug "Using authenticator: #{resource_config[:authenticator].name}"
+
+      RestClient::Resource.new(@config[:uri], resource_config)
     end
 
     def unauthenticated_client
       @client_without_auth ||= RestClient::Resource.new(@config[:uri], @resource_config)
     end
 
+    def get_authenticator
+      raise ApipieBindings::AuthenticatorMissingError if @authenticator.nil?
+      @authenticator
+    end
+
     def retrieve_apidoc_call(path, options={})
       begin
         http_call('get', path, {},

data/lib/apipie_bindings/authenticators/base.rb

@@ -0,0 +1,18 @@
+module ApipieBindings
+  module Authenticators
+    class Base
+      def authenticate(request, args)
+      end
+
+      def error(ex)
+      end
+
+      def response(r)
+      end
+
+      def name
+        self.class.name
+      end
+    end
+  end
+end

data/lib/apipie_bindings/authenticators/basic_auth.rb

@@ -0,0 +1,16 @@
+require 'apipie_bindings/authenticators/base'
+
+module ApipieBindings
+  module Authenticators
+    class BasicAuth < Base
+      def initialize(user, password)
+        @user = user
+        @password = password
+      end
+
+      def authenticate(request, args)
+        request.basic_auth(@user, @password)
+      end
+    end
+  end
+end

data/lib/apipie_bindings/authenticators/credentials_legacy.rb

@@ -0,0 +1,24 @@
+require 'apipie_bindings/authenticators/base'
+
+module ApipieBindings
+  module Authenticators
+    class CredentialsLegacy < Base
+      def initialize(credentials)
+        @credentials = credentials
+      end
+
+      def authenticate(request, args)
+        params = @credentials.to_params
+        request.basic_auth(params[:user], params[:password])
+      end
+
+      def error(ex)
+        @credentials.clear if ex.is_a? RestClient::Unauthorized
+      end
+
+      def clear
+        @credentials.clear
+      end
+    end
+  end
+end

data/lib/apipie_bindings/authenticators/oauth.rb

@@ -0,0 +1,27 @@
+require 'apipie_bindings/authenticators/base'
+
+module ApipieBindings
+  module Authenticators
+    class Oauth < Base
+      def initialize(consumer_key, consumer_secret, options = {})
+        @consumer_key = consumer_key
+        @consumer_secret = consumer_secret
+        @options = options
+      end
+
+      def authenticate(request, args)
+        uri = URI.parse args[:url]
+        default_options = {
+          :site => "#{uri.scheme}://#{uri.host}:#{uri.port.to_s}",
+          :request_token_path => "",
+          :authorize_path => "",
+          :access_token_path  => ""
+        }
+        options = default_options.merge(@options)
+        consumer = OAuth::Consumer.new(@consumer_key, @consumer_secret, options)
+
+        consumer.sign!(request)
+      end
+    end
+  end
+end

data/lib/apipie_bindings/authenticators.rb

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

data/lib/apipie_bindings/exceptions.rb

@@ -2,6 +2,7 @@ module ApipieBindings
 
   class ConfigurationError < StandardError; end
   class DocLoadingError < StandardError; end
+  class AuthenticatorMissingError < StandardError; end
 
   ErrorData = Struct.new(:kind, :argument, :details)
 

data/lib/apipie_bindings/rest_client_extensions.rb

@@ -9,26 +9,14 @@ module ApipieBindings
     RestClient::AbstractResponse.send(:include, RequestAccessor) unless RestClient::AbstractResponse.method_defined?(:request)
     RestClient::Response.send(:include, RequestAccessor) unless RestClient::Response.method_defined?(:request)
 
-    unless RestClient.const_defined? :OAUTH_EXTENSION
-      RestClient::OAUTH_EXTENSION = lambda do |request, args|
-        if args[:oauth]
-          uri = URI.parse args[:url]
-          default_options = {
-            :site => "#{uri.scheme}://#{uri.host}:#{uri.port.to_s}",
-            :request_token_path => "",
-            :authorize_path => "",
-            :access_token_path  => "" 
-          }
-          options = default_options.merge args[:oauth][:options] || { }
-          consumer = OAuth::Consumer.new(args[:oauth][:consumer_key], args[:oauth][:consumer_secret], options)
-
-          consumer.sign!(request)
-        end
+    unless RestClient.const_defined? :AUTHENTICATOR_EXTENSION
+      RestClient::AUTHENTICATOR_EXTENSION = lambda do |request, args|
+        args[:authenticator].authenticate(request, args) if args[:authenticator]
       end
     end
 
-    unless RestClient.before_execution_procs.include? RestClient::OAUTH_EXTENSION
-      RestClient.add_before_execution_proc &RestClient::OAUTH_EXTENSION
+    unless RestClient.before_execution_procs.include? RestClient::AUTHENTICATOR_EXTENSION
+      RestClient.add_before_execution_proc &RestClient::AUTHENTICATOR_EXTENSION
     end
   end
 end

data/lib/apipie_bindings/version.rb

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

data/lib/apipie_bindings.rb

@@ -5,6 +5,7 @@ require 'apipie_bindings/credentials'
 require 'apipie_bindings/exceptions'
 require 'apipie_bindings/inflector'
 require 'apipie_bindings/indifferent_hash'
+require 'apipie_bindings/authenticators'
 require 'apipie_bindings/api'
 require 'apipie_bindings/resource'
 require 'apipie_bindings/action'

data/test/unit/action_test.rb

@@ -118,11 +118,11 @@ describe ApipieBindings::Action do
 
   it "should have name visible in puts" do
     out, err = capture_io { puts resource.action(:index) }
-    out.must_equal "<Action :index>\n"
+    out.must_equal "<Action users:index>\n"
   end
 
   it "should have name visible in inspect" do
-    resource.action(:index).inspect.must_equal "<Action :index>"
+    resource.action(:index).inspect.must_equal "<Action users:index>"
   end
 
   it "should have examples" do

data/test/unit/api_test.rb

@@ -207,7 +207,7 @@ describe ApipieBindings::API do
     end
   end
 
-  context "credentials" do
+  context "authenticators" do
 
     let(:fake_empty_response) {
       data = ApipieBindings::Example.new('', '', '', 200, '[]')
@@ -222,19 +222,104 @@ describe ApipieBindings::API do
         RestClient::Response.create(data.response, net_http_resp, {})
       end
     }
+    let(:authenticator) { stub(:name => :auth) }
+
+    def binding_params(cache_dir, params = {})
+      base_params = {
+        :uri => 'http://example.com',
+        :api_version => 2,
+        :apidoc_cache_base_dir => cache_dir,
+        :authenticator => authenticator
+      }
+      base_params.merge(params)
+    end
 
-    it "should call credentials to_param when :credentials are set and doing authenticated call" 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,
-          :credentials => credentials})
-        credentials.expects(:to_params).returns({:password => 'xxx'})
-        api.stubs(:call_client).returns(fake_empty_response)
+    context "when doing authenticated call" do
+      it "passes authenticator to the client" do
+        Dir.mktmpdir do |dir|
+          api = ApipieBindings::API.new(binding_params(dir))
+          api.expects(:call_client).with do |client, path, args|
+            client.options[:authenticator] == authenticator
+          end.returns(fake_empty_response)
+
+          api.http_call(:get, '/path')
+        end
+      end
+
+      it "passes error to authenticator" do
+        Dir.mktmpdir do |dir|
+          api = ApipieBindings::API.new(binding_params(dir))
+          api.stubs(:call_client).raises(RestClient::Unauthorized)
+          authenticator.expects(:error).with do |e|
+            e.is_a? RestClient::Unauthorized
+          end
+          assert_raises RestClient::Unauthorized do
+            api.http_call(:get, '/path')
+          end
+        end
+      end
+
+      it "raises exception when authenticator wasn't provided" do
+        Dir.mktmpdir do |dir|
+          api = ApipieBindings::API.new(binding_params(dir, :authenticator => nil))
+
+          assert_raises ApipieBindings::AuthenticatorMissingError do
+            api.http_call(:get, '/path')
+          end
+        end
+      end
+    end
+
+    context "when :apidoc_authenticated => false" do
+      it "doesn't pass request to authenticator" do
+        Dir.mktmpdir do |dir|
+          api = ApipieBindings::API.new(binding_params(dir, :apidoc_authenticated => false))
+          api.expects(:unauthenticated_client)
+          api.stubs(:call_client).returns(fake_empty_response)
+
+          api.check_cache
+        end
+      end
 
-        api.http_call(:get, '/path')
+      it "doesn't pass error to authenticator" do
+        Dir.mktmpdir do |dir|
+          api = ApipieBindings::API.new(binding_params(dir, :apidoc_authenticated => false))
+          api.expects(:unauthenticated_client)
+          api.stubs(:call_client).raises(RestClient::Unauthorized)
+
+          authenticator.expects(:error).never
+          api.check_cache
+        end
+      end
+
+      it "doesn't pass response to authenticator" do
+        Dir.mktmpdir do |dir|
+          api = ApipieBindings::API.new(binding_params(dir, :apidoc_authenticated => false))
+          api.expects(:unauthenticated_client)
+          api.stubs(:call_client).returns(fake_empty_response)
+
+          authenticator.expects(:response).never
+          api.check_cache
+        end
       end
     end
+  end
+
+  context "credentials" do
+
+    let(:fake_empty_response) {
+      data = ApipieBindings::Example.new('', '', '', 200, '[]')
+      net_http_resp = Net::HTTPResponse.new(1.0, data.status, "")
+      if RestClient.version >= '2.0.0'
+        RestClient::Response.create(data.response, net_http_resp,
+          RestClient::Request.new(:method=>'GET', :url=>'http://example.com'))
+      elsif RestClient.version >= '1.8.0'
+        RestClient::Response.create(data.response, net_http_resp, {},
+          RestClient::Request.new(:method=>'GET', :url=>'http://example.com'))
+      else
+        RestClient::Response.create(data.response, net_http_resp, {})
+      end
+    }
 
     it "should not require credentials for loading apidoc when :apidoc_authenticated => false" do
       Dir.mktmpdir do |dir|
@@ -276,7 +361,7 @@ describe ApipieBindings::API do
         credentials = ApipieBindings::AbstractCredentials.new
         api = ApipieBindings::API.new({:uri => 'http://example.com', :apidoc_cache_base_dir => dir, :api_version => 2,
                                        :credentials => credentials})
-        api.expects(:clear_credentials)
+        credentials.expects(:clear)
         api.stubs(:call_client).raises(RestClient::Unauthorized)
         assert_raises RestClient::Unauthorized do
           api.http_call(:get, '/path')

data/test/unit/authenticators/basic_auth_test.rb

@@ -0,0 +1,17 @@
+require File.join(File.dirname(__FILE__), '../test_helper')
+require 'apipie_bindings/authenticators/basic_auth'
+
+describe ApipieBindings::Authenticators::BasicAuth do
+  let(:authenticator) { ApipieBindings::Authenticators::BasicAuth.new(user, passwd) }
+  let(:user) { 'john_doe' }
+  let(:passwd) { 'secret_password' }
+  let(:request) { mock() }
+  let(:args) { {} }
+
+  describe '#authenticate' do
+    it 'adds base auth to the request' do
+      request.expects(:basic_auth).with(user, passwd)
+      authenticator.authenticate(request, args)
+    end
+  end
+end

data/test/unit/authenticators/credentials_legacy_test.rb

@@ -0,0 +1,34 @@
+require File.join(File.dirname(__FILE__), '../test_helper')
+require 'apipie_bindings/authenticators/credentials_legacy'
+
+describe ApipieBindings::Authenticators::CredentialsLegacy do
+  let(:authenticator) { ApipieBindings::Authenticators::CredentialsLegacy.new(@credentials) }
+  let(:user) { 'john_doe' }
+  let(:passwd) { 'secret_password' }
+  let(:request) { mock() }
+  let(:args) { {} }
+
+  before do
+    @credentials = mock()
+  end
+
+  describe '#authenticate' do
+    it 'uses result of to_params for base auth of the request' do
+      @credentials.expects(:to_params).returns({ :user => user, :password => passwd })
+      request.expects(:basic_auth).with(user, passwd)
+      authenticator.authenticate(request, args)
+    end
+  end
+
+  describe '#error' do
+    it 'clears credentials on RestClient::Unauthorized' do
+      @credentials.expects(:clear)
+      authenticator.error(RestClient::Unauthorized.new)
+    end
+
+    it 'lets other errors pass' do
+      authenticator.error(RuntimeError.new)
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apipie-bindings
 version: !ruby/object:Gem::Version
-  version: 0.0.18
+  version: 0.0.19
 platform: ruby
 authors:
 - Martin Bačovský
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-31 00:00:00.000000000 Z
+date: 2016-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -162,8 +162,10 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.0.0
-description: |
-  Bindings for API calls that are documented with Apipie. Bindings are generated on the fly.
+description: 'Bindings for API calls that are documented with Apipie. Bindings are
+  generated on the fly.
+
+'
 email: mbacovsk@redhat.com
 executables: []
 extensions: []
@@ -178,6 +180,11 @@ files:
 - lib/apipie_bindings.rb
 - lib/apipie_bindings/action.rb
 - lib/apipie_bindings/api.rb
+- lib/apipie_bindings/authenticators.rb
+- lib/apipie_bindings/authenticators/base.rb
+- lib/apipie_bindings/authenticators/basic_auth.rb
+- lib/apipie_bindings/authenticators/credentials_legacy.rb
+- lib/apipie_bindings/authenticators/oauth.rb
 - lib/apipie_bindings/credentials.rb
 - lib/apipie_bindings/example.rb
 - lib/apipie_bindings/exceptions.rb
@@ -218,6 +225,8 @@ files:
 - test/dummy/public/index.html
 - test/unit/action_test.rb
 - test/unit/api_test.rb
+- test/unit/authenticators/basic_auth_test.rb
+- test/unit/authenticators/credentials_legacy_test.rb
 - test/unit/data/dummy.json
 - test/unit/example_test.rb
 - test/unit/indifferent_hash_test.rb
@@ -247,7 +256,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: The Ruby bindings for Apipie documented APIs
@@ -281,6 +290,8 @@ test_files:
 - test/dummy/public/index.html
 - test/unit/action_test.rb
 - test/unit/api_test.rb
+- test/unit/authenticators/basic_auth_test.rb
+- test/unit/authenticators/credentials_legacy_test.rb
 - test/unit/data/dummy.json
 - test/unit/example_test.rb
 - test/unit/indifferent_hash_test.rb
@@ -290,4 +301,3 @@ test_files:
 - test/unit/resource_test.rb
 - test/unit/route_test.rb
 - test/unit/test_helper.rb
-has_rdoc: yard