apipie-bindings 0.0.17 → 0.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 13d22cd6355e9bf1c07c011efb312aa712d3581e
-  data.tar.gz: 76ac815e986f16a031dcb3248cc0653a440888b3
+  metadata.gz: 4734cdf3c653d0886c206128ad15894c3d279470
+  data.tar.gz: 747b17990ca0a2258eee7936b2040d98f7832c80
 SHA512:
-  metadata.gz: 5a1f387ce7e38ab4e0ac66c714c07366d5d49af2778d48ece0f4538af0bd77756135860f936e01a95a316560d248a76eddf8d20d1272d1b33f817197d092b877
-  data.tar.gz: c2aa3d6e688560a763a54112a615e3bacb2beb5f671c56e27f39ffd587756882966125f0a5f5f53c902630b4a94626c9eb70b70c46f92d492af0c1b772a03205
+  metadata.gz: 31986fa92e0941cfd0af5560d134b75b7166f11aaf1550d4b8385adc75c7c68759f93dbfbbb0657089d064d3dff762af5321459c6240babab6e7d5687fa72fb1
+  data.tar.gz: e7c6e55f3d160074635dc8861a93a6965d276425ef383c881ac298a3a936aaa0971b6029a10a10fe211ce7c7337347a90d10a6adee4ede59059de3cfa0c2bbed

data/doc/release_notes.md

@@ -1,6 +1,12 @@
 Release notes
 =============
 
+### 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))
+* Restrict json to < 2.0.0 ([#46](https://github.com/Apipie/apipie-bindings/issues/46))
+* Support rest-client 2.0.0 ([#45](https://github.com/Apipie/apipie-bindings/issues/45))
+
 ### 0.0.17 (2016-06-23)
 * Restrict rest-client version to < 2.0.0 ([#42](https://github.com/Apipie/apipie-bindings/issues/42))
 * Include request in response for rest-client < 1.8.0 ([#11147](http://projects.theforeman.org/issues/11147))

data/lib/apipie_bindings/api.rb

@@ -213,7 +213,7 @@ module ApipieBindings
       if dry_run?
         empty_response = ApipieBindings::Example.new('', '', '', 200, '')
         ex = options[:fake_response ] || empty_response
-        response = create_fake_response(ex.status, ex.response, http_method, path, args)
+        response = create_fake_response(ex.status, ex.response, http_method, URI.join(@uri || 'http://example.com', path).to_s, args)
       else
         begin
           apidoc_without_auth = (path =~ /\/apidoc\//) && !@apidoc_authenticated
@@ -223,8 +223,8 @@ module ApipieBindings
           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)
+          log.error e.message
+          log.debug inspect_data(e)
           raise
         end
       end
@@ -306,7 +306,11 @@ module ApipieBindings
             raise exception_with_response(response)
           end
         else
-          response.return!(request, result, &block)
+          if response.method(:return!).arity.zero?  # 2.0.0+
+            response.return!(&block)
+          else
+            response.return!(request, result, &block)
+          end
         end
       end
     end
@@ -381,20 +385,29 @@ module ApipieBindings
     end
 
     def inspect_data(obj)
-      ApipieBindings::Utils.inspect_data(obj)
+      ApipieBindings::Utils.inspect_data(obj.respond_to?(:response) ? process_data(obj.response) : obj)
+    rescue => e
+      log.debug "Error during inspecting response: #{e.message}"
+      ''
     end
 
-    def create_fake_response(status, body, method, path, args={})
+    def create_fake_response(status, body, method, path, args=[])
+      request_args = {:method => args.shift || method, :url => path}
+      request_args[:params] = args.shift if %w[post put].include?(method.to_s)
+      request_args[:headers] = args.shift
+
       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))
+      if RestClient.version >= '2.0.0'
+        RestClient::Response.create(body, net_http_resp, create_fake_request(request_args))
+      elsif RestClient.version >= '1.8.0'
+        RestClient::Response.create(body, net_http_resp, request_args, create_fake_request(request_args))
       else
-        RestClient::Response.create(body, net_http_resp, args)
+        RestClient::Response.create(body, net_http_resp, request_args)
       end
     end
 
-    def create_fake_request(method, path)
-      RestClient::Request.new(:method=>method, :url=>path)
+    def create_fake_request(args)
+      RestClient::Request.new(args)
     end
   end
 end

data/lib/apipie_bindings/resource.rb

@@ -10,34 +10,65 @@ module ApipieBindings
       @api = api
     end
 
+    # Execute an action on a resource
+    #
+    # @param action [Symbol]
+    # @param params [Hash]
+    # @param headers [Hash]
+    # @param options [Hash]
+    # @return [Hash]
     def call(action, params={}, headers={}, options={})
       @api.call(@name, action, params, headers, options)
     end
 
+    # Get API documentation for a resource
+    #
+    # @return [Hash]
     def apidoc
       @api.apidoc[:docs][:resources][@name]
     end
 
+    # Get list of all actions for a resource
+    #
+    # @return [Array<ApipieBindings::Action>]
     def actions
       apidoc[:methods].map { |a| action(a[:name].to_sym) }
     end
 
+    # Determine if resource has a particular action
+    #
+    # @param name [Symbol] name of action to check
+    # @return [Bool]
     def has_action?(name)
       apidoc[:methods].any? { |action| action[:name].to_sym == name }
     end
 
+    # Get ApipieBindings::Action
+    #
+    # @param name [Symbol] action name
+    # @return [ApipieBindings::Action]
     def action(name)
       ApipieBindings::Action.new(@name, name, @api)
     end
 
+    # Get simiple string representation
+    #
+    # @return [String] ApipieBindings::Resource as a string
     def singular_name
       ApipieBindings::Inflector.singularize(@name.to_s)
     end
 
+    # Get string representation
+    #
+    # @return [String] ApipieBindings::Resource as a string
     def to_s
       "<Resource :#{@name}>"
     end
 
+    # Get string representation
+    #
+    # @return [String] ApipieBindings::Resource as a string
+    # @note same as to_s method
     def inspect
       to_s
     end

data/lib/apipie_bindings/version.rb

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

data/test/unit/api_test.rb

@@ -71,9 +71,11 @@ describe ApipieBindings::API do
       :dry_run => true})
     s = StringIO.new; s << 'foo'
     headers = {:content_type => 'multipart/form-data', :multipart => true}
-    RestClient::Response.expects(:create).with() {
-      |body, head, args| args == [:post, {:file => s}, headers]
-    }
+    RestClient::Response.expects(:create).with do |*args|
+      # on 1.8, prefer the copy of args kept in the original request object
+      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})
   end
 
@@ -176,7 +178,7 @@ describe ApipieBindings::API do
     context "follow_redirects = :never" do
       let(:api) { configure_api_with(:follow_redirects => :never) }
       let(:block) { api.send(:rest_client_call_block) }
-      let(:response) { api.send(:create_fake_response, 301, "", "GET", "/", {}) }
+      let(:response) { api.send(:create_fake_response, 301, "", "GET", "http://example.com/", {}) }
 
       it "should rise error on redirect" do
         proc { block.call(response) }.must_raise RestClient::MovedPermanently
@@ -191,7 +193,7 @@ describe ApipieBindings::API do
     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 = api.send(:create_fake_response, 301, "", "POST", "http://example.com/", {})
       response.expects(:follow_redirection)
       block.call(response)
     end
@@ -199,7 +201,7 @@ describe ApipieBindings::API do
     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 = api.send(:create_fake_response, 301, "", "GET", "http://example.com/", {})
       response.expects(:return!)
       block.call(response)
     end
@@ -210,7 +212,10 @@ describe ApipieBindings::API do
     let(:fake_empty_response) {
       data = ApipieBindings::Example.new('', '', '', 200, '[]')
       net_http_resp = Net::HTTPResponse.new(1.0, data.status, "")
-      if RestClient::Response.method(:create).arity == 4 # RestClient >= 1.8.0
+      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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apipie-bindings
 version: !ruby/object:Gem::Version
-  version: 0.0.17
+  version: 0.0.18
 platform: ruby
 authors:
 - Martin Bačovský
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-23 00:00:00.000000000 Z
+date: 2016-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -33,7 +33,7 @@ dependencies:
         version: 1.6.5
     - - "<"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -43,7 +43,7 @@ dependencies:
         version: 1.6.5
     - - "<"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: oauth
   requirement: !ruby/object:Gem::Requirement