api_client 0.5.24-java → 0.6.0-java

data/spec/api_client/scope_spec.rb

@@ -0,0 +1,204 @@
+require "spec_helper"
+
+describe ApiClient::Scope do
+
+  describe 'default_scopes' do
+
+    it "runs the default scopes defined in the scopeable" do
+      class DefaultScopeTest < ApiClient::Base
+        always do
+          params :foo => 1
+        end
+      end
+      instance = ApiClient::Scope.new(DefaultScopeTest)
+      instance.params.should == { :foo => 1 }
+    end
+  end
+
+  describe "#params" do
+
+    it "reads/writes the params and chains nicely" do
+      instance = ApiClient::Scope.new(ApiClient::Base)
+      instance.params(:foo => 1).params(:moo => 10).should == instance
+      instance.params.should == { :foo => 1, :moo => 10 }
+    end
+
+  end
+
+  describe "#headers" do
+
+    it "reads/writes the headers and chains nicely" do
+      instance = ApiClient::Scope.new(ApiClient::Base)
+      instance.headers(:foo => 1).headers(:moo => 10).should == instance
+      instance.headers.should == { :foo => 1, :moo => 10 }
+    end
+
+  end
+
+  describe "#options" do
+
+    it "reads/writes the headers and chains nicely" do
+      instance = ApiClient::Scope.new(ApiClient::Base)
+      instance.options(:foo => 1).options(:moo => 10).should == instance
+      instance.options.should == { :foo => 1, :moo => 10 }
+    end
+
+  end
+
+  describe "#raw_body" do
+
+    it "reads/writes non-hash body" do
+      instance = ApiClient::Scope.new(ApiClient::Base)
+      instance.raw_body('raw body string').should == instance
+      instance.raw_body.should == 'raw body string'
+    end
+
+    it "overwrites previous raw_body" do
+      instance = ApiClient::Scope.new(ApiClient::Base)
+      instance.raw_body('previous').raw_body('current')
+      instance.raw_body.should == 'current'
+    end
+
+    it "does request with raw body only if set, skips other params" do
+      connection = double
+      instance = ApiClient::Scope.new(ApiClient::Base)
+      instance.stub(:connection).and_return(connection)
+      response = Faraday::Response.new(:body => '{"a": "1"}')
+      connection.should_receive(:get).with(@path, 'raw body string', {}).and_return(response)
+
+      result = instance.params({:skipped => 'params'}).raw_body('raw body string').request(:get, @path)
+      result.should == {"a"=> "1"}
+    end
+
+  end
+
+  describe "connection" do
+
+    it "retuns the connection based on the adapter" do
+      instance = ApiClient::Scope.new(ApiClient::Base)
+      instance.connection.should be_an_instance_of ApiClient::Connection::Basic
+    end
+
+    it "raises an error if adapter was not found" do
+      instance = ApiClient::Scope.new(ApiClient::Base)
+      lambda {
+        instance.adapter("foo").connection
+      }.should raise_error
+    end
+
+    it "executes connection hooks" do
+      AConnectionHook = double
+      class ScopeConnectionHooksTest < ApiClient::Base
+      end
+      ScopeConnectionHooksTest.connection_hooks = [AConnectionHook]
+      instance = ApiClient::Scope.new(ScopeConnectionHooksTest)
+      AConnectionHook.should_receive(:call)
+      instance.connection
+    end
+
+  end
+
+  describe "requests" do
+
+    before do
+      @path    = "somepath"
+      @params  = { :foo => 1 }
+      @headers = { 'token' => 'A' }
+    end
+
+    def test_request(method)
+      connection = double
+      instance = ApiClient::Scope.new(ApiClient::Base)
+      instance.stub(:connection).and_return(connection)
+      response = Faraday::Response.new(:body => '{"a": "1"}')
+      connection.should_receive(method).with(@path, @params, @headers).and_return(response)
+      instance.params(@params).headers(@headers).send(method, @path)
+    end
+
+    it "can make any request" do
+      connection = double
+      instance = ApiClient::Scope.new(ApiClient::Base)
+      instance.stub(:connection).and_return(connection)
+      response = Faraday::Response.new(:body => '{"a": "1"}')
+      connection.should_receive(:get).with(@path, @params, @headers).and_return(response)
+      result = instance.params(@params).headers(@headers).request(:get, @path)
+      result.should == {"a"=> "1"}
+    end
+
+    it "can make any request and get a raw response" do
+      connection = double
+      instance = ApiClient::Scope.new(ApiClient::Base)
+      instance.stub(:connection).and_return(connection)
+      response = Faraday::Response.new(:body => '{"a": "1"}')
+      connection.should_receive(:get).twice.with(@path, @params, @headers).and_return(response)
+      result = instance.params(@params).headers(@headers).request(:get, @path, :raw => true)
+      result.should == response
+      result = instance.raw.params(@params).headers(@headers).request(:get, @path)
+      result.should == response
+    end
+
+    it "makes a GET request" do
+      result = test_request :get
+      result.should == {"a"=> "1"}
+    end
+
+    it "makes a POST request" do
+      result = test_request :post
+      result.should == {"a"=> "1"}
+    end
+
+    it "makes a PATCH request" do
+      result = test_request :patch
+      result.should == {"a"=> "1"}
+    end
+
+    it "makes a PUT request" do
+      result = test_request :put
+      result.should == {"a"=> "1"}
+    end
+
+    it "makes a PUT request" do
+      result = test_request :delete
+      result.should == {"a"=> "1"}
+    end
+
+    describe "fetch" do
+
+      it "performs a get and builds an object" do
+        connection = double
+        instance = ApiClient::Scope.new(ApiClient::Base)
+        instance.stub(:connection).and_return(connection)
+        response = Faraday::Response.new(:body => '{"id": 42}')
+        connection.should_receive(:get).with(@path, @params, @headers).and_return(response)
+        result = instance.params(@params).headers(@headers).fetch(@path)
+        result.should be_an_instance_of(ApiClient::Base)
+        result.id.should == 42
+      end
+
+    end
+
+  end
+
+  describe "dynamic delegation of scopeable singleton methods" do
+
+    it "dynamically delegates and properly scopes" do
+      class DynamicDelegationTest < ApiClient::Base
+        def self.some_method
+          self.scope.params
+        end
+      end
+      scope = ApiClient::Scope.new(DynamicDelegationTest)
+      scope.params(:param => "aaa").some_method.should == { :param => "aaa" }
+    end
+
+    it "raises an error if scopeable does not implement the method" do
+      scope = ApiClient::Scope.new(ApiClient::Base)
+      lambda {
+        scope.some_method_the_class_does_not_have
+      }.should raise_error(NoMethodError)
+    end
+
+  end
+
+
+end

data/spec/api_client/utils_spec.rb

@@ -0,0 +1,32 @@
+require "spec_helper"
+
+describe ApiClient::Utils do
+
+  describe '.deep_merge' do
+
+    it "merges two hashes updating the first one" do
+      hash_a = { :a => 1, :b => 2  }
+      hash_b = { :b => 3, :c => 45 }
+      ApiClient::Utils.deep_merge hash_a, hash_b
+      hash_a.should == { :a => 1, :b => 3, :c=>45 }
+      hash_b.should == { :b => 3, :c => 45 }
+    end
+
+    it "deeply merges two hashes recursively" do
+      hash_a = { :a => { :foo => 2, :boo => { :wat => 'wat' } }, :b => 2  }
+      hash_b = { :b => 3, :c => 45, :a => { :boo => { :wat => "WAT????" } } }
+      ApiClient::Utils.deep_merge hash_a, hash_b
+      hash_a.should == { :a => { :foo => 2, :boo => { :wat => 'WAT????' } }, :b => 3, :c => 45  }
+    end
+
+    it "require correct key type" do
+      hash_a = { :a  => 1 }
+      hash_b = { 'a' => 2 }
+      ApiClient::Utils.deep_merge hash_a, hash_b
+      hash_a.should == { :a => 1, 'a' => 2 }
+
+    end
+
+  end
+
+end

data/spec/support/matchers.rb

@@ -0,0 +1,5 @@
+RSpec::Matchers.define :inherit_from do |parent|
+  match do |klass|
+    klass.ancestors.include?(parent)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_client
 version: !ruby/object:Gem::Version
-  version: 0.5.24
+  version: 0.6.0
 platform: java
 authors:
 - Zendesk
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-15 00:00:00.000000000 Z
+date: 2022-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -17,8 +17,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.14.1
   name: rspec
-  type: :development
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
@@ -31,8 +31,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
   name: jrjackson
-  type: :runtime
   prerelease: false
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -45,8 +45,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.0.5
   name: hashie
-  type: :runtime
   prerelease: false
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -60,10 +60,10 @@ dependencies:
         version: 0.8.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 2.0.0
   name: faraday
-  type: :runtime
   prerelease: false
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -71,7 +71,7 @@ dependencies:
         version: 0.8.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -79,8 +79,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.6.1
   name: multi_json
-  type: :runtime
   prerelease: false
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -100,7 +100,48 @@ files:
 - README.md
 - Rakefile
 - lib/api_client.rb
+- lib/api_client/base.rb
+- lib/api_client/connection/abstract.rb
+- lib/api_client/connection/basic.rb
+- lib/api_client/connection/json.rb
+- lib/api_client/connection/middlewares/request/json.rb
+- lib/api_client/connection/middlewares/request/logger.rb
+- lib/api_client/connection/middlewares/request/oauth.rb
+- lib/api_client/connection/oauth.rb
+- lib/api_client/errors.rb
+- lib/api_client/mixins/configuration.rb
+- lib/api_client/mixins/connection_hooks.rb
+- lib/api_client/mixins/delegation.rb
+- lib/api_client/mixins/inheritance.rb
+- lib/api_client/mixins/instantiation.rb
+- lib/api_client/mixins/scoping.rb
+- lib/api_client/resource/base.rb
+- lib/api_client/resource/name_resolver.rb
+- lib/api_client/resource/scope.rb
+- lib/api_client/scope.rb
+- lib/api_client/utils.rb
+- lib/api_client/version.rb
+- spec/api_client/base/connection_hook_spec.rb
+- spec/api_client/base/delegation_spec.rb
+- spec/api_client/base/inheritance_spec.rb
+- spec/api_client/base/instantiation_spec.rb
+- spec/api_client/base/marshalling_spec.rb
+- spec/api_client/base/parsing_spec.rb
+- spec/api_client/base/scoping_spec.rb
+- spec/api_client/base_spec.rb
+- spec/api_client/connection/abstract_spec.rb
+- spec/api_client/connection/basic_spec.rb
+- spec/api_client/connection/oauth_spec.rb
+- spec/api_client/connection/request/json_spec.rb
+- spec/api_client/connection/request/logger_spec.rb
+- spec/api_client/connection/request/oauth_spec.rb
+- spec/api_client/resource/base_spec.rb
+- spec/api_client/resource/name_spec.rb
+- spec/api_client/resource/scope_spec.rb
+- spec/api_client/scope_spec.rb
+- spec/api_client/utils_spec.rb
 - spec/spec_helper.rb
+- spec/support/matchers.rb
 homepage: https://github.com/futuresimple/api_client
 licenses:
 - Apache License Version 2.0
@@ -113,16 +154,36 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.0
+      version: 2.3.8
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.2.29
 signing_key:
 specification_version: 3
 summary: API client builder
 test_files:
 - spec/spec_helper.rb
+- spec/api_client/utils_spec.rb
+- spec/api_client/scope_spec.rb
+- spec/api_client/base_spec.rb
+- spec/api_client/connection/oauth_spec.rb
+- spec/api_client/connection/basic_spec.rb
+- spec/api_client/connection/abstract_spec.rb
+- spec/api_client/connection/request/oauth_spec.rb
+- spec/api_client/connection/request/json_spec.rb
+- spec/api_client/connection/request/logger_spec.rb
+- spec/api_client/resource/name_spec.rb
+- spec/api_client/resource/scope_spec.rb
+- spec/api_client/resource/base_spec.rb
+- spec/api_client/base/delegation_spec.rb
+- spec/api_client/base/connection_hook_spec.rb
+- spec/api_client/base/marshalling_spec.rb
+- spec/api_client/base/inheritance_spec.rb
+- spec/api_client/base/instantiation_spec.rb
+- spec/api_client/base/parsing_spec.rb
+- spec/api_client/base/scoping_spec.rb
+- spec/support/matchers.rb