api_client_builder 1.0.0 → 1.4.0

data/spec/lib/api_client_builder/get_item_request_spec.rb

@@ -1,6 +1,5 @@
 require 'spec_helper'
-require 'api_client_builder/get_item_request'
-require 'lib/api_client_builder/test_client/client'
+require_relative 'test_client/client'
 
 module APIClientBuilder
   describe GetItemRequest do
@@ -21,9 +20,8 @@ module APIClientBuilder
           bad_response = APIClientBuilder::Response.new('bad request', 500, [200])
           allow_any_instance_of(TestClient::ResponseHandler).to receive(:get_first_page).and_return(bad_response)
           allow_any_instance_of(TestClient::ResponseHandler).to receive(:retry_request).and_return(bad_response)
-          expect{ client.get_some_object(some_id: '123').response }.to raise_error(
-            APIClientBuilder::DefaultPageError,
-            "Default error for bad response. If you want to handle this error use #on_error on the response in your api consumer. Error Code: 500"
+          expect { client.get_some_object(some_id: '123').response }.to raise_error(
+            APIClientBuilder::DefaultPageError, /Error Code: 500/
           )
         end
 
@@ -32,7 +30,7 @@ module APIClientBuilder
             client = TestClient::Client.new(domain: 'https://www.domain.com/api/endpoints/')
 
             bad_response = APIClientBuilder::Response.new('bad request', 500, [200])
-            good_response = APIClientBuilder::Response.new([1,2,3], 200, [200])
+            good_response = APIClientBuilder::Response.new([1, 2, 3], 200, [200])
             allow_any_instance_of(TestClient::ResponseHandler).to receive(:get_first_page).and_return(bad_response)
             allow_any_instance_of(TestClient::ResponseHandler).to receive(:more_pages?).and_return(false)
             allow_any_instance_of(TestClient::ResponseHandler).to receive(:retry_request).and_return(good_response)

data/spec/lib/api_client_builder/post_request_spec.rb

@@ -1,6 +1,5 @@
 require 'spec_helper'
-require 'api_client_builder/post_request'
-require 'lib/api_client_builder/test_client/client'
+require_relative 'test_client/client'
 
 module APIClientBuilder
   describe PostRequest do
@@ -20,9 +19,8 @@ module APIClientBuilder
 
           bad_response = APIClientBuilder::Response.new('bad request', 400, [200])
           allow_any_instance_of(TestClient::ResponseHandler).to receive(:post_request).and_return(bad_response)
-          expect{ client.post_some_object({}).response }.to raise_error(
-            APIClientBuilder::DefaultPageError,
-            "Default error for bad response. If you want to handle this error use #on_error on the response in your api consumer. Error Code: 400"
+          expect { client.post_some_object({}).response }.to raise_error(
+            APIClientBuilder::DefaultPageError, /Error Code: 400/
           )
         end
       end

data/spec/lib/api_client_builder/put_request_spec.rb

@@ -1,6 +1,5 @@
 require 'spec_helper'
-require 'api_client_builder/put_request'
-require 'lib/api_client_builder/test_client/client'
+require_relative 'test_client/client'
 
 module APIClientBuilder
   describe PutRequest do
@@ -20,9 +19,8 @@ module APIClientBuilder
 
           bad_response = APIClientBuilder::Response.new('bad request', 400, [200])
           allow_any_instance_of(TestClient::ResponseHandler).to receive(:put_request).and_return(bad_response)
-          expect{ client.put_some_object({}).response }.to raise_error(
-            APIClientBuilder::DefaultPageError,
-            "Default error for bad response. If you want to handle this error use #on_error on the response in your api consumer. Error Code: 400"
+          expect { client.put_some_object({}).response }.to raise_error(
+            APIClientBuilder::DefaultPageError, /Error Code: 400/
           )
         end
       end

data/spec/lib/api_client_builder/request_spec.rb

@@ -1,6 +1,5 @@
 require 'spec_helper'
-require 'lib/api_client_builder/test_client/client'
-require 'api_client_builder/request'
+require_relative 'test_client/client'
 
 module APIClientBuilder
   describe Request do
@@ -12,9 +11,8 @@ module APIClientBuilder
           bad_response = APIClientBuilder::Response.new('bad request', 400, [200])
           allow_any_instance_of(TestClient::ResponseHandler).to receive(:get_first_page).and_return(bad_response)
           allow_any_instance_of(TestClient::ResponseHandler).to receive(:retry_request).and_return(bad_response)
-          expect{ client.get_some_object(some_id: '123').response }.to raise_error(
-            APIClientBuilder::DefaultPageError,
-            "Default error for bad response. If you want to handle this error use #on_error on the response in your api consumer. Error Code: 400"
+          expect { client.get_some_object(some_id: '123').response }.to raise_error(
+            APIClientBuilder::DefaultPageError, /Error Code: 400/
           )
         end
       end
@@ -28,13 +26,13 @@ module APIClientBuilder
           allow_any_instance_of(TestClient::ResponseHandler).to receive(:retry_request).and_return(bad_response)
           object_response = client.get_some_object(some_id: '123')
 
-          object_response.on_error do |page, response|
-            raise StandardError, "Something Bad Happened"
+          object_response.on_error do |_page, _response|
+            raise StandardError, 'Something Bad Happened'
           end
 
-          expect{object_response.response}.to raise_error(
+          expect { object_response.response }.to raise_error(
             StandardError,
-            "Something Bad Happened"
+            'Something Bad Happened'
           )
         end
       end

data/spec/lib/api_client_builder/response_spec.rb

@@ -1,5 +1,4 @@
 require 'spec_helper'
-require 'api_client_builder/response'
 
 module APIClientBuilder
   describe Response do
@@ -18,7 +17,7 @@ module APIClientBuilder
 
       it 'returns false when the response is otherwise marked as failed' do
         page = Response.new([], 200, [200])
-        page.mark_failed "Something happened"
+        page.mark_failed 'Something happened'
 
         expect(page.success?).to eq(false)
       end

data/spec/lib/api_client_builder/test_client/client.rb

@@ -1,6 +1,5 @@
-require 'api_client_builder/api_client'
-require 'lib/api_client_builder/test_client/response_handler'
-require 'lib/api_client_builder/test_client/http_client_handler'
+require_relative 'response_handler'
+require_relative 'http_client_handler'
 
 module TestClient
   class Client < APIClientBuilder::APIClient
@@ -18,5 +17,6 @@ module TestClient
 
     post :some_object, 'some/post/url'
     put :some_object, 'som/put/url'
+    delete :some_object, 'som/delete/url'
   end
 end

data/spec/lib/api_client_builder/test_client/http_client_handler.rb

@@ -4,7 +4,6 @@ module TestClient
       @domain = domain
     end
 
-    def get(route, params = nil, headers = {})
-    end
+    def get(route, params = nil, headers = {}); end
   end
 end

data/spec/lib/api_client_builder/test_client/response_handler.rb

@@ -1,36 +1,37 @@
-require 'api_client_builder/response'
-
 module TestClient
   class ResponseHandler
     SUCCESS_STATUS = 200
-    SUCCESS_RANGE = [200]
+    SUCCESS_RANGE = [200].freeze
     MAX_RETRIES = 4
 
-    def initialize(client, start_url, type, **opts)
+    def initialize(_client, _start_url, _type, **_opts)
       @retries = 0
     end
 
     def get_first_page
       @current_page = 0
-      APIClientBuilder::Response.new([1,2,3], SUCCESS_STATUS, SUCCESS_RANGE)
+      APIClientBuilder::Response.new([1, 2, 3], SUCCESS_STATUS, SUCCESS_RANGE)
     end
 
     def get_next_page
       @current_page += 1
-      APIClientBuilder::Response.new([4,5,6], SUCCESS_STATUS, SUCCESS_RANGE)
+      APIClientBuilder::Response.new([4, 5, 6], SUCCESS_STATUS, SUCCESS_RANGE)
+    end
+
+    def delete_request
+      APIClientBuilder::Response.new('good delete request', SUCCESS_STATUS, SUCCESS_RANGE)
     end
 
-    def put_request(body)
+    def put_request(_body)
       APIClientBuilder::Response.new('good request', SUCCESS_STATUS, SUCCESS_RANGE)
     end
 
-    def post_request(body)
+    def post_request(_body)
       APIClientBuilder::Response.new('good request', SUCCESS_STATUS, SUCCESS_RANGE)
     end
 
     def more_pages?
-      return false if @current_page >= 2
-      return true
+      @current_page < 2
     end
 
     def retryable?(status_code)
@@ -38,10 +39,8 @@ module TestClient
       status_code != 400 && @retries < MAX_RETRIES
     end
 
-    def retry_request
-    end
+    def retry_request; end
 
-    def reset_retries
-    end
+    def reset_retries; end
   end
 end

data/spec/lib/api_client_builder/url_generator_spec.rb

@@ -1,12 +1,11 @@
 require 'spec_helper'
-require 'api_client_builder/url_generator'
 
 module APIClientBuilder
   describe URLGenerator do
     describe '#build_route' do
       context 'route with colon params and matching keys' do
         it 'replaces to route keys with their respective values' do
-          url_generator = URLGenerator.new("https://www.domain.com/api/endpoints/")
+          url_generator = URLGenerator.new('https://www.domain.com/api/endpoints/')
 
           route = url_generator.build_route(
             'object_one/:object_one_id/:object_one_id/route_to_object/:other_object_id/object',
@@ -16,16 +15,39 @@ module APIClientBuilder
 
           expect(route).to eq(URI.parse('https://www.domain.com/api/endpoints/object_one/4/4/route_to_object/10/object'))
         end
+
+        it 'replaces to route keys with their respective values in embedded params' do
+          url_generator = URLGenerator.new('https://www.domain.com/api/endpoints/')
+
+          route = url_generator.build_route(
+            'object_one/:object_one_id/:object_one_id/object&as_user_id=:user_object_id',
+            object_one_id: '4',
+            user_object_id: '1'
+          )
+          expect(route).to eq(URI.parse('https://www.domain.com/api/endpoints/object_one/4/4/object&as_user_id=1'))
+        end
+
+        it 'encodes the URI correctly' do
+          url_generator = URLGenerator.new('https://www.domain.com/api/endpoints/')
+
+          route = url_generator.build_route(
+            'route_to_object/:object_id/object',
+            object_id: "\u1F4a9"
+          )
+          expect(route).to eq(URI.parse('https://www.domain.com/api/endpoints/route_to_object/%E1%BD%8A9/object'))
+        end
       end
 
       context 'route with colon params and non matching keys' do
         it 'raises an argument error' do
-          url_generator = URLGenerator.new("https://www.domain.com/api/endpoints/")
+          url_generator = URLGenerator.new('https://www.domain.com/api/endpoints/')
 
-          expect{url_generator.build_route(
-            'object_one/:object_one_id/:object_one_id/route_to_object/:other_object_id/object',
-            other_object_id: '10'
-          )}.to raise_error(ArgumentError, "Param :object_one_id is required")
+          expect do
+            url_generator.build_route(
+              'object_one/:object_one_id/:object_one_id/route_to_object/:other_object_id/object',
+              other_object_id: '10'
+            )
+          end.to raise_error(ArgumentError, 'Param :object_one_id is required')
         end
       end
     end

data/spec/spec_helper.rb

@@ -1,4 +1,10 @@
+require 'simplecov'
+SimpleCov.start do
+  add_filter 'lib/api_client_builder/version.rb'
+  add_filter 'spec'
+  track_files 'lib/**/*.rb'
+end
+SimpleCov.minimum_coverage(97)
+
 require 'bundler/setup'
 require 'api_client_builder'
-
-SPEC_DIR = File.dirname(__FILE__)

metadata

@@ -1,55 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: api_client_builder
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Jayce Higgins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-01 00:00:00.000000000 Z
+date: 2021-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
   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: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.57.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.57.2
 - !ruby/object:Gem::Dependency
-  name: wwtd
+  name: simplecov
   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'
 description: API Client Builder provides an easy to use interface for creating HTTP
@@ -61,9 +75,28 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Jenkinsfile
+- LICENSE.txt
+- README.md
 - api_client_builder.gemspec
-- readme.md
+- build.sh
+- lib/api_client_builder.rb
+- lib/api_client_builder/api_client.rb
+- lib/api_client_builder/delete_request.rb
+- lib/api_client_builder/get_collection_request.rb
+- lib/api_client_builder/get_item_request.rb
+- lib/api_client_builder/post_request.rb
+- lib/api_client_builder/put_request.rb
+- lib/api_client_builder/request.rb
+- lib/api_client_builder/response.rb
+- lib/api_client_builder/url_generator.rb
+- lib/api_client_builder/version.rb
 - spec/lib/api_client_builder/api_client_spec.rb
+- spec/lib/api_client_builder/delete_request_spec.rb
 - spec/lib/api_client_builder/get_collection_request_spec.rb
 - spec/lib/api_client_builder/get_item_request_spec.rb
 - spec/lib/api_client_builder/post_request_spec.rb
@@ -75,7 +108,7 @@ files:
 - spec/lib/api_client_builder/test_client/response_handler.rb
 - spec/lib/api_client_builder/url_generator_spec.rb
 - spec/spec_helper.rb
-homepage: 
+homepage: https://github.com/instructure/api-client-builder
 licenses:
 - MIT
 metadata: {}
@@ -85,31 +118,18 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: API Client Builder provides an easy to use interface for creating HTTP api
   clients
-test_files:
-- spec/lib/api_client_builder/api_client_spec.rb
-- spec/lib/api_client_builder/get_collection_request_spec.rb
-- spec/lib/api_client_builder/get_item_request_spec.rb
-- spec/lib/api_client_builder/post_request_spec.rb
-- spec/lib/api_client_builder/put_request_spec.rb
-- spec/lib/api_client_builder/request_spec.rb
-- spec/lib/api_client_builder/response_spec.rb
-- spec/lib/api_client_builder/test_client/client.rb
-- spec/lib/api_client_builder/test_client/http_client_handler.rb
-- spec/lib/api_client_builder/test_client/response_handler.rb
-- spec/lib/api_client_builder/url_generator_spec.rb
-- spec/spec_helper.rb
+test_files: []