apipie-bindings 0.0.15 → 0.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c2de238c0346625717ad8c455ad933a8f58915fe
-  data.tar.gz: 480e111759cf1d88b9b002f447f68b4fcefce7e7
+  metadata.gz: aff06fcd62b11a1cd42115eed2dc44642d5f312f
+  data.tar.gz: 1752856687b077fb3f35af546d687364b94bc732
 SHA512:
-  metadata.gz: e439a3315f55647319631390fe43411664fce48963c90baa44003302d656576553e773e634946e05c51e557aaa7705fce897ca7e0bb4d29e75fe33e9149f159c
-  data.tar.gz: e172fec2517f748068ece02e9c41ee3b8efab1d1d6745349c5e8cc733553abc5d62795826d75af20910c298121c8975cbf89a31da98bb4c126a7d3226326b9c0
+  metadata.gz: b0201bb9a4bca428e4a49d8b706daa2873e8e0d3252189b40ceaee3254e42c963b2ea52770c88dfe1b08c82eb454d9cd5713be3a052f9e4b206a979a3e799490
+  data.tar.gz: 2d43831dea22be3f35fcb6d298fabe2c05699ccb6e5300c158926dd4cd42e17e4dcd5498da470462cf22bffaf79b3f43a5b151a9a6eacd298e89b50819edf3cb

data/doc/release_notes.md

@@ -1,6 +1,14 @@
 Release notes
 =============
 
+### 0.0.16 (2016-03-08)
+* Controll following redirection ([#37](https://github.com/Apipie/apipie-bindings/issues/37))
+* Enable for mocking api calls with validations
+* Log the server uri ([#36](https://github.com/Apipie/apipie-bindings/issues/36))
+* build without sudo ([#40](https://github.com/Apipie/apipie-bindings/issues/40))
+* Added clear credentials on error ([#12112](http://projects.theforeman.org/issues/12112))
+* Added a function that enables removing credentials on need ([#12112](http://projects.theforeman.org/issues/12112))
+
 ### 0.0.15 (2015-09-21)
 * Make awesome_print optional ([#29](https://github.com/Apipie/apipie-bindings/issues/29))
 

data/lib/apipie_bindings/action.rb

@@ -2,7 +2,7 @@ module ApipieBindings
 
   class Action
 
-    attr_reader :name
+    attr_reader :name, :resource
 
     def initialize(resource, name, api)
       @resource = resource
@@ -57,7 +57,7 @@ module ApipieBindings
 
     def validate!(parameters)
       errors = validate(params, parameters)
-      
+
       missing_arguments, errors = errors.partition { |e| e.kind == :missing_argument }
       missing_arguments.map! { |e| e.argument }
       raise ApipieBindings::MissingArgumentsError.new(missing_arguments) unless missing_arguments.empty?
@@ -65,7 +65,7 @@ module ApipieBindings
       invalid_types, errors = errors.partition { |e| e.kind == :invalid_type }
       invalid_types.map! { |e| [e.argument, e.details] }
       raise ApipieBindings::InvalidArgumentTypesError.new(invalid_types) unless invalid_types.empty?
-      
+
       errors.map! { |e| e.argument }
       raise ApipieBindings::ValidationError.new(errors) unless errors.empty?
     end
@@ -82,7 +82,7 @@ module ApipieBindings
       values.each do |param, value|
         param_description = params.find { |p| p.name == param.to_s }
         if param_description
-        
+
           # nested?
           if !param_description.params.empty? && !value.nil?
             # array

data/lib/apipie_bindings/api.rb

@@ -8,7 +8,7 @@ module ApipieBindings
 
   class API
 
-    attr_reader :apidoc_cache_name, :fake_responses, :language
+    attr_reader :apidoc_cache_name, :fake_responses, :language, :uri, :follow_redirects
     attr_writer :dry_run
 
     # Creates new API bindings instance
@@ -45,6 +45,8 @@ module ApipieBindings
     #   *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 [Symbol] :follow_redirects (:default) Possible values are :always, :never and :default.
+    #   The :default is to only redirect in GET and HEAD requests (RestClient default)
     # @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
@@ -65,6 +67,7 @@ module ApipieBindings
       @apidoc_cache_dir = config[:apidoc_cache_dir] || File.join(apidoc_cache_base_dir, @uri.tr(':/', '_'), "v#{@api_version}")
       @apidoc_cache_name = config[:apidoc_cache_name] || set_default_name
       @apidoc_authenticated = (config[:apidoc_authenticated].nil? ? true : config[:apidoc_authenticated])
+      @follow_redirects = config.fetch(:follow_redirects, :default)
       @dry_run = config[:dry_run] || false
       @aggressive_cache_checking = config[:aggressive_cache_checking] || false
       @fake_responses = config[:fake_responses] || {}
@@ -85,6 +88,7 @@ module ApipieBindings
       headers.merge!(options.delete(:headers)) unless options[:headers].nil?
 
       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)
 
@@ -109,6 +113,10 @@ module ApipieBindings
       end
     end
 
+    def clear_credentials
+      @client_with_auth = nil
+      @credentials.clear
+    end
 
     def apidoc
       @apidoc = @apidoc || load_apidoc || retrieve_apidoc
@@ -155,9 +163,14 @@ module ApipieBindings
       check_cache if @aggressive_cache_checking
       resource = resource(resource_name)
       action = resource.action(action_name)
-      route = action.find_route(params)
       action.validate!(params) unless options[:skip_validation]
       options[:fake_response] = find_match(fake_responses, resource_name, action_name, params) || action.examples.first if dry_run?
+
+      call_action(action, params, headers, options)
+    end
+
+    def call_action(action, params={}, headers={}, options={})
+      route = action.find_route(params)
       return http_call(
         route.method,
         route.path(params),
@@ -192,6 +205,7 @@ module ApipieBindings
         headers[:params] = params if params
       end
 
+      log.info "Server: #{@uri}"
       log.info "#{http_method.to_s.upcase} #{path}"
       log.debug "Params: #{inspect_data(params)}"
       log.debug "Headers: #{inspect_data(headers)}"
@@ -201,13 +215,7 @@ module ApipieBindings
       if dry_run?
         empty_response = ApipieBindings::Example.new('', '', '', 200, '')
         ex = options[:fake_response ] || empty_response
-        net_http_resp = Net::HTTPResponse.new(1.0, ex.status, "")
-        if RestClient::Response.method(:create).arity == 4 # RestClient > 1.8.0
-          response = RestClient::Response.create(ex.response, net_http_resp, args,
-            RestClient::Request.new(:method=>http_method, :url=>path))
-        else
-          response = RestClient::Response.create(ex.response, net_http_resp, args)
-        end
+        response = create_fake_response(ex.status, ex.response, http_method, path, args)
       else
         begin
           apidoc_without_auth = (path =~ /\/apidoc\//) && !@apidoc_authenticated
@@ -216,6 +224,7 @@ module ApipieBindings
           response = call_client(client, path, args)
           update_cache(response.headers[:apipie_checksum])
         rescue => e
+          clear_credentials if e.is_a? RestClient::Unauthorized
           log.debug e.message + "\n" +
             inspect_data(e.respond_to?(:response) ? process_data(e.response) : e)
           raise
@@ -282,7 +291,32 @@ module ApipieBindings
     private
 
     def call_client(client, path, args)
-      client[path].send(*args)
+      block = rest_client_call_block
+      client[path].send(*args, &block)
+    end
+
+    def rest_client_call_block
+      Proc.new do |response, request, result, &block|
+        if [301, 302, 307].include?(response.code) && [:always, :never].include?(@follow_redirects)
+          if @follow_redirects == :always
+            log.debug "Response redirected to #{response.headers[:location]}"
+            response.follow_redirection(request, result, &block)
+          else
+            raise exception_with_response(response)
+          end
+        else
+          response.return!(request, result, &block)
+        end
+      end
+    end
+
+    def exception_with_response(response)
+      begin
+        klass = RestClient::Exceptions::EXCEPTIONS_MAP.fetch(response.code)
+      rescue KeyError
+        raise RestClient.RequestFailed.new(response, response.code)
+      end
+      raise klass.new(response, response.code)
     end
 
     def authenticated_client
@@ -348,5 +382,18 @@ module ApipieBindings
     def inspect_data(obj)
       ApipieBindings::Utils.inspect_data(obj)
     end
+
+    def create_fake_response(status, body, method, path, args={})
+      net_http_resp = Net::HTTPResponse.new(1.0, status, "")
+      if RestClient::Response.method(:create).arity == 4 # RestClient > 1.8.0
+        RestClient::Response.create(body, net_http_resp, args, create_fake_request(method, path))
+      else
+        RestClient::Response.create(body, net_http_resp, args)
+      end
+    end
+
+    def create_fake_request(method, path)
+      RestClient::Request.new(:method=>method, :url=>path)
+    end
   end
 end

data/lib/apipie_bindings/version.rb

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

data/test/unit/api_test.rb

@@ -154,6 +154,49 @@ describe ApipieBindings::API do
     end
   end
 
+  context "redirects" do
+    def configure_api_with(options={})
+      default_options = {
+        :apidoc_cache_dir => 'test/unit/data',
+        :apidoc_cache_name => 'dummy'
+      }
+      ApipieBindings::API.new(default_options.merge(options))
+    end
+
+    it "should follow RestClient default behaviour by default" do
+      api = configure_api_with()
+      api.follow_redirects.must_equal :default
+    end
+
+    it "should be possible to change redirects handling" do
+      api = configure_api_with(:follow_redirects => :never)
+      api.follow_redirects.must_equal :never
+    end
+
+    it "should rise error on redirect when follow_redirects = :never" do
+      api = configure_api_with(:follow_redirects => :never)
+      block = api.send(:rest_client_call_block)
+      response = api.send(:create_fake_response, 301, "", "GET", "/", {})
+      proc { block.call(response) }.must_raise RestClient::MovedPermanently
+    end
+
+    it "should follow redirect when follow_redirects = :always" do
+      api = configure_api_with(:follow_redirects => :always)
+      block = api.send(:rest_client_call_block)
+      response = api.send(:create_fake_response, 301, "", "POST", "/", {})
+      response.expects(:follow_redirection)
+      block.call(response)
+    end
+
+    it "should use original handling when follow_redirects = :default" do
+      api = configure_api_with(:follow_redirects => :default)
+      block = api.send(:rest_client_call_block)
+      response = api.send(:create_fake_response, 301, "", "GET", "/", {})
+      response.expects(:return!)
+      block.call(response)
+    end
+  end
+
   context "credentials" do
 
     let(:fake_empty_response) {
@@ -203,6 +246,30 @@ describe ApipieBindings::API do
         api.check_cache
       end
     end
+
+    it "should clear credentials" 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(:clear)
+        api.clear_credentials
+      end
+    end
+
+    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,
+                                       :credentials => credentials})
+        api.expects(:clear_credentials)
+        api.stubs(:call_client).raises(RestClient::Unauthorized)
+        assert_raises RestClient::Unauthorized do
+          api.http_call(:get, '/path')
+        end
+      end
+    end
   end
 
 end

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: apipie-bindings
 version: !ruby/object:Gem::Version
-  version: 0.0.15
+  version: 0.0.16
 platform: ruby
 authors:
 - Martin Bačovský
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-21 00:00:00.000000000 Z
+date: 2016-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.1
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.6.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.6.5
 - !ruby/object:Gem::Dependency
   name: oauth
   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
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 10.1.0
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -98,62 +98,62 @@ dependencies:
   name: minitest-spec-context
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: 0.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: ci_reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.6.3
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: 2.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.6.3
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: 2.0.0
 description: |
@@ -231,17 +231,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.4
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: The Ruby bindings for Apipie documented APIs
@@ -284,3 +284,4 @@ test_files:
 - test/unit/resource_test.rb
 - test/unit/route_test.rb
 - test/unit/test_helper.rb
+has_rdoc: yard