api_client_builder 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 88e1b96d923ba97a2adcc4a9016c2e63fd9bdc3c
-  data.tar.gz: 8abe62264ede2bcf80ada8ae2a24cac37dd3b7d2
+SHA256:
+  metadata.gz: 2accab064d29f0ff8f30fe57c72e1d6d4e8443e638fc118c0c3491072f4f9893
+  data.tar.gz: 36eca023a1104ab85da81b13422b2ab0125601c0d008a398e91310697cd1b99c
 SHA512:
-  metadata.gz: 19b3e2ee30df3ce75e7616a3146d392312d5540a58ae3b75d05ee41db21d344f86c9c0ae5cabaf96b0411d4331d16fd12d18013b3d749c9a037745d2053958cf
-  data.tar.gz: af3aaf9e2f75477a988d623a721d0818b87a0bb782e4fbaefe9515e2690f8c8fd08e72d43c6481130f25167fde7cac25459c8db92fd528f1f626d9ea2e187e03
+  metadata.gz: 811764f10bf9810621e0148944e040123433690f7fce45e7512c9e5537e894b62b5dfb2fa96f2c45df7221c5942121879728cc488181495223bb9bb6d57162bb
+  data.tar.gz: 39a5f07153ddaef6f2e5dbb2acb971c8f033f3d97421b915fb9b0b43a5fcc02159321c1d807c930ff934115c21ecedca74ed97c18734371694eefa71739bd1c1

data/Jenkinsfile

@@ -0,0 +1,13 @@
+pipeline {
+  agent {
+    label 'docker'
+  }
+
+  stages {
+    stage('Lint & Test') {
+      steps {
+        sh './build.sh'
+      }
+    }
+  }
+}

data/README.md

@@ -186,6 +186,10 @@ class HTTPClientHandler
     client.post(route, params, headers)
   end
 
+  def delete(route, params = nil, headers = {})
+    client.delete(route, params, headers)
+  end
+
   # Define a client to use here. The HTTPClient gem is a good option
 
   # Build up headers and authentication handling here as well
@@ -296,6 +300,20 @@ def post_request
 end
 ```
 
+#### For deletes
+
+The builder will call `#delete_request` when handling delete routes.
+
+```ruby
+def delete_request
+  # Build the URL -- this could be to add pagination params to the route, or
+  # add whatever else is necessary to the route.
+  # Also send the body if that's how the client handler is configured.
+  http_response = @http_client.delete("a URL")
+  build_response(http_response)
+end
+```
+
 #### Handling retry-able requests
 
 If requests defined need to be retry-able, extend the response handler by providing

data/api_client_builder.gemspec

@@ -4,8 +4,8 @@ Gem::Specification.new do |gem|
   gem.name          = 'api_client_builder'
   gem.summary       = 'API Client Builder provides an easy to use interface for creating HTTP api clients'
   gem.description   = 'API Client Builder provides an easy to use interface for creating HTTP api clients'
-  gem.authors       = ['Jayce Higgins', 'Bryan Petty']
-  gem.email         = ['jhiggins@instructure.com', 'bpetty@instructure.com', 'eng@instructure.com']
+  gem.authors       = ['Jayce Higgins']
+  gem.email         = ['jhiggins@instructure.com', 'eng@instructure.com']
   gem.homepage      = 'https://github.com/instructure/api-client-builder'
 
   gem.version       = APIClientBuilder::VERSION

data/lib/api_client_builder.rb

@@ -8,6 +8,7 @@ require_relative 'api_client_builder/get_collection_request'
 require_relative 'api_client_builder/get_item_request'
 require_relative 'api_client_builder/post_request'
 require_relative 'api_client_builder/put_request'
+require_relative 'api_client_builder/delete_request'
 require_relative 'api_client_builder/url_generator'
 
 require_relative 'api_client_builder/api_client'

data/lib/api_client_builder/api_client.rb

@@ -75,5 +75,22 @@ module APIClientBuilder
         )
       end
     end
+
+    # Used to define a DELETE api route on the base class. Will
+    # yield a method that takes the shape of 'delete_type' that will
+    # return a DeleteRequest.
+    #
+    # @param type [Symbol] defines the route model
+    # @param route [String] defines the routes endpoint
+    #
+    # @return [DeleteRequest] the request object that handles puts
+    def self.delete(type, route)
+      define_method("delete_#{type}") do |**params|
+        DeleteRequest.new(
+          type,
+          response_handler_build(http_client, @url_generator.build_route(route, **params), type)
+        )
+      end
+    end
   end
 end

data/lib/api_client_builder/delete_request.rb

@@ -0,0 +1,19 @@
+module APIClientBuilder
+  class DeleteRequest < Request
+    # Yields the response body if the response was successful. Will call
+    # the response handlers if there was not a successful response.
+    #
+    # @return [JSON] the http response body
+    def response
+      response = response_handler.delete_request
+
+      if response.success?
+        response
+      else
+        error_handlers.each do |handler|
+          handler.call(response, self)
+        end
+      end
+    end
+  end
+end

data/lib/api_client_builder/version.rb

@@ -1,3 +1,3 @@
 module APIClientBuilder
-  VERSION = '1.2.0'.freeze
+  VERSION = '1.3.0'.freeze
 end

data/spec/lib/api_client_builder/api_client_spec.rb

@@ -41,5 +41,15 @@ module APIClientBuilder
         expect(client.put_some_object({})).to be_a(APIClientBuilder::PutRequest)
       end
     end
+
+    describe '.delete' do
+      it 'defines a delete method on the client' do
+        expect(client).to respond_to(:delete_some_object)
+      end
+
+      it 'returns a DeleteRequest object' do
+        expect(client.delete_some_object({})).to be_a(APIClientBuilder::DeleteRequest)
+      end
+    end
   end
 end

data/spec/lib/api_client_builder/delete_request_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+require_relative 'test_client/client'
+
+module APIClientBuilder
+  describe DeleteRequest do
+    describe '#response' do
+      context 'request was successful' do
+        it 'returns a response object' do
+          client = TestClient::Client.new(domain: 'https://www.domain.com/api/endpoints/')
+
+          some_object = client.delete_some_object({}).response
+          expect(some_object.body).to eq('good delete request')
+        end
+      end
+
+      context 'request was unsuccessful' do
+        it 'calls the error handlers' do
+          client = TestClient::Client.new(domain: 'https://www.domain.com/api/endpoints/')
+
+          bad_response = APIClientBuilder::Response.new('bad request', 400, [200])
+          allow_any_instance_of(TestClient::ResponseHandler).to receive(:delete_request).and_return(bad_response)
+          expect { client.delete_some_object({}).response }.to raise_error(
+            APIClientBuilder::DefaultPageError, /Error Code: 400/
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -17,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/response_handler.rb

@@ -18,6 +18,10 @@ module TestClient
       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)
       APIClientBuilder::Response.new('good request', SUCCESS_STATUS, SUCCESS_RANGE)
     end

metadata

@@ -1,92 +1,92 @@
 --- !ruby/object:Gem::Specification
 name: api_client_builder
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Jayce Higgins
-- Bryan Petty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-03 00:00:00.000000000 Z
+date: 2020-03-27 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: '3.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         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: 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
   api clients
 email:
 - jhiggins@instructure.com
-- bpetty@instructure.com
 - eng@instructure.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rubocop.yml
-- .travis.yml
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
 - Gemfile
+- Jenkinsfile
 - LICENSE.txt
 - README.md
 - api_client_builder.gemspec
 - 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
@@ -96,6 +96,7 @@ files:
 - 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
@@ -117,23 +118,23 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       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.6
 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/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