api_client_builder 1.0.1 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 325e44729f05185e293461182fd2f405824ef233
-  data.tar.gz: 44970894a7563a62609223a3efd9b7d38a0ce557
+SHA256:
+  metadata.gz: 6fe7e4e6055363b600d2544fab5f2585f30b73da723f2ee928762b0913251190
+  data.tar.gz: d6a81b59ceacb77cd86d5f4df6badeb21ed15d2f90889cd048a0ffcf8dab0f3e
 SHA512:
-  metadata.gz: edcc960fa01482a12446b8be86a847df5d93a500559901758c410e5cf44d6773e251306b4783821b6b9e9741e10429333a9daaae49da285f937a759b9237e18e
-  data.tar.gz: a9e4eec3e7d812ca887b39324c9fd4ee0d21737d31d8c177df431c40393aea6861aea2936b27a3d0e90a89c0f08849f7e2045b9be56beb1b6a52703294fb310c
+  metadata.gz: 0775c90d669b8fe323902689e9d5c8c12fc7d62039f32704a5a3b2f4158c68aa77a9aa5e7ea4d5fff458435beacd564f5f12ba3145967ee37368c66fd6cb3981
+  data.tar.gz: 804e72d9df7452aac1756568c9663d61fe6d5c8bf34e9952340a9445cd616a55d5fa041312c3793f2b56e9f1561b7fe55051c47531716ab2a30783cca62ce621

data/.gitignore

@@ -1 +1,3 @@
-Gemfile.lock
+/coverage
+/Gemfile.lock
+/*.gem

data/.rubocop.yml

@@ -0,0 +1,34 @@
+AllCops:
+  TargetRubyVersion: 2.3
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*.rb
+
+Metrics/LineLength:
+  Max: 120 # Default: 80
+
+Metrics/MethodLength:
+  Max: 20 # Default: 10
+
+Naming/AccessorMethodName: # TODO: Enable and fix API at some point.
+  Enabled: false
+
+Style/Documentation:
+  # This cop checks for missing top-level documentation of classes and modules.
+  # Classes with no body and namespace modules are exempt from the check.
+  # Namespace modules are modules that have nothing in their bodies except
+  # classes or other modules.
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  # `when_needed` will add the frozen string literal comment to files
+  # only when the `TargetRubyVersion` is set to 2.3+.
+  # `always` will always add the frozen string literal comment to a file
+  # regardless of the Ruby version or if `freeze` or `<<` are called on a
+  # string literal. If you run code against multiple versions of Ruby, it is
+  # possible that this will create errors in Ruby 2.3.0+.
+  #
+  # See: https://wyeworks.com/blog/2015/12/1/immutable-strings-in-ruby-2-dot-3
+  EnforcedStyle: when_needed
+  Enabled: false

data/.travis.yml

@@ -1,18 +1,20 @@
-language: ruby
+dist: trusty
 sudo: false
+language: ruby
 cache: bundler
+
 rvm:
-  # - ruby-head
-  - 2.1
-  - 2.2
   - 2.3
+  - 2.4
+  - 2.5
+
 matrix:
   fast_finish: true
-  # WWTD doesn't support allow_failures... yet
-  # allow_failures:
-  #   - rvm: ruby-head
-script: bundle exec rspec
-notifications:
-  email:
-    on_success: never
-    on_failure: never
+
+before_install: gem update bundler
+bundler_args: --jobs 3
+install: bundle install --jobs 3
+
+script:
+  - bundle exec rubocop --fail-level autocorrect
+  - bundle exec rspec

data/Jenkinsfile

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

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2016 Instructure Inc.
+Copyright (c) 2016-2018 Instructure Inc.
 
 MIT License
 

data/README.md

@@ -3,7 +3,9 @@
 API Client Builder was created to reduce the overhead of creating API clients.
 
 It provides a DSL for defining endpoints and only requires you to define handlers
-for http requests and responses.
+for HTTP requests and responses.
+
+[![Build Status](https://travis-ci.org/instructure/api-client-builder.svg?branch=master)](https://travis-ci.org/instructure/api-client-builder)
 
 ---
 
@@ -28,10 +30,6 @@ Or install it yourself as:
 The basic client structure looks like this.
 
 ```ruby
-require 'api_client_builder/api_client'
-require 'path/to/your/http_client_handler'
-require 'path/to/your/response_handler'
-
 class Client < APIClientBulder::APIClient
   def initialize(**opts)
     super(domain: opts[:domain],
@@ -55,8 +53,8 @@ def response_handler_build(http_client, start_url, type)
 end
 ```
 
-
 ### Defining routes on the client
+
 To define routes on the api client, use the DSL provided by the
 builder's APIClient class. Four parts have been defined to help:
 
@@ -81,7 +79,6 @@ builder's APIClient class. Four parts have been defined to help:
   - Note that any symbols in the route will be interpolated as required
    params when calling the method on the client.
 
-
 ---
 
 ## Route Examples
@@ -91,7 +88,7 @@ builder's APIClient class. Four parts have been defined to help:
 Define the route on the client
 
 ```ruby
-  get :some_object, :singular, 'some_objects/:id'
+get :some_object, :singular, 'some_objects/:id'
 ```
 
 Use the defined route
@@ -107,7 +104,7 @@ response_body = single_request.response
 Define the route on the client
 
 ```ruby
-  get :some_objects, :collection, 'some_objects'
+get :some_objects, :collection, 'some_objects'
 ```
 
 Use the defined route
@@ -116,7 +113,7 @@ Use the defined route
 collection_request = client.get_some_objects
 
 collection_request.each do |item|
-  #Item will be a Hash if you use the default response in the response handler
+  # Item will be a Hash if you use the default response in the response handler
 end
 ```
 
@@ -166,16 +163,16 @@ get :some_objects_for_course, :collection, 'course/:course_id/some_objects'
 
 ## Defining an HTTP Client Handler
 
-The HTTP Client Handler is designed to manage the http requests themselves. Since
+The HTTP Client Handler is designed to manage the HTTP requests themselves. Since
 actually making an HTTP request typically requires some amount of authentication,
 it is suggested that authentication and headers are managed here as well.
 
-The http client handler requires '#get', '#post', and '#put' to be defined here
+The HTTP client handler requires '#get', '#post', and '#put' to be defined here
 with the shown method signature.
 
 ```ruby
 class HTTPClientHandler
-  #Do initialization here, generally authentication creds and a domain is sent in
+  # Do initialization here, generally authentication creds and a domain is sent in
 
   def get(route, params = nil, headers = {})
     client.get(route, params, headers)
@@ -189,9 +186,13 @@ class HTTPClientHandler
     client.post(route, params, headers)
   end
 
-  #Define a client to use here. The HTTPClient gem is a good option
+  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
+  # Build up headers and authentication handling here as well
 end
 ```
 
@@ -219,11 +220,11 @@ these actions simpler.
 
 ```ruby
 class ResponseHandler
-    def initialize(http_client_handler, start_url, type)
-      @http_client = http_client_handler
-      @start_url = start_url
-      @type = type
-    end
+  def initialize(http_client_handler, start_url, type)
+    @http_client = http_client_handler
+    @start_url = start_url
+    @type = type
+  end
 end
 ```
 
@@ -239,13 +240,13 @@ of pages and also start the page counter.
 
 ```ruby
 def get_first_page
-  #Build the URL -- this could be to add pagination params to the route, or add
-  #  whatever else is necessary to the route
+  # Build the URL -- this could be to add pagination params to the route, or
+  # add whatever else is necessary to the route.
   http_response = @http_client.get("a URL")
 
-  #Generally the first page will contain information about how many pages a paginated
-  #  response will have. Set that here. `@max_pages`
-  #Be sure to set the current page count as well -- @current_page
+  # Generally the first page will contain information about how many pages a
+  # paginated response will have. Set that here: `@max_pages`
+  # Be sure to set the current page count as well: `@current_page`
   build_response(http_response)
 end
 ```
@@ -258,17 +259,16 @@ return a boolean denoting the presence of more pages.
 
 ```ruby
 def get_next_page
-  #Build the URL -- this could be to add pagination params to the route, or add
-  #  whatever else is necessary to the route
+  # Build the URL -- this could be to add pagination params to the route, or
+  # add whatever else is necessary to the route:
   http_response = @http_client.get("a URL")
 
-  #If the http_response is valid then increment the page counter here
+  # If the http_response is valid then increment the page counter here.
   build_response(http_response)
 end
 
 def more_pages?
-  return false if @current_page > @max_pages
-  return true
+  @current_page < @max_pages
 end
 ```
 
@@ -278,9 +278,9 @@ The builder will call `#put_request` when handling put routes.
 
 ```ruby
 def put_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 thats how the client handler is configured
+  # 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 thats how the client handler is configured.
   http_response = @http_client.put("a URL", {})
   build_response(http_response)
 end
@@ -292,14 +292,28 @@ The builder will call `#post_request` when handling post routes.
 
 ```ruby
 def post_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 thats how the client handler is configured
+  # 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.post("a URL", {})
   build_response(http_response)
 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
@@ -308,34 +322,35 @@ the following methods.
 ```ruby
 def retryable?(status_code)
   if @opts[:exponential_backoff]
-    #Define the conditions of whether or not the provided status code is retry-able
+    # Define the conditions of whether or not the provided status code is retry-able
+    true 
   else
-    return false
+    false
   end
 end
 
 def reset_retries
-  #Track the number of retries so the request is not retried indefinitely.
-  #  The builder will reset them when it no longer is retrying by calling this
-  #  method
+  # Track the number of retries so the request is not retried indefinitely.
+  # The builder will reset them when it no longer is retrying by calling this
+  # method.
   @retries = 0
 end
 
 def retry_request
-  #Increment the retries here so the request is not retried indefinitely.
+  # Increment the retries here so the request is not retried indefinitely.
   @retries += 1
 
-  #Build the URL -- this could be to add pagination params to the route, or add
-  #  whatever else is necessary to the route
+  # Build the URL -- this could be to add pagination params to the route, or
+  # add whatever else is necessary to the route.
   response = @http_client.the_action_to_retry("a URL")
   build_response(response)
 end
 ```
 
-#### Managing the http response
+#### Managing the HTTP response
 
 The builder defines a default `Response` object that will provide the minimally
-required interface for managing an http response.
+required interface for managing an HTTP response.
 
 ```ruby
 def build_response(http_response)
@@ -373,10 +388,10 @@ is not a "success."
 single_request = client.get_some_object(id: 123)
 
 single_request.on_error do |page, handler|
-  #The page will have all of the status information
-  #The handler is the defined response_handler
-  #Use either to glean more information about why the request was an error and
-  # handle the error here
+  # The page will have all of the status information.
+  # The handler is the defined response_handler.
+  # Use either to glean more information about why the request was an error and
+  # handle the error here.
 end
 
 response_body = single_request.response

data/api_client_builder.gemspec

@@ -1,24 +1,25 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/api_client_builder/version', __FILE__)
+require File.expand_path('lib/api_client_builder/version', __dir__)
 
 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.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']
   gem.email         = ['jhiggins@instructure.com', 'eng@instructure.com']
+  gem.homepage      = 'https://github.com/instructure/api-client-builder'
 
   gem.version       = APIClientBuilder::VERSION
-  gem.required_ruby_version = '>= 2.0'
+  gem.required_ruby_version = '>= 2.3'
 
-  gem.license       = 'MIT'
+  gem.license = 'MIT'
 
   gem.add_development_dependency 'pry'
-  gem.add_development_dependency 'rspec'
-  gem.add_development_dependency 'wwtd'
+  gem.add_development_dependency 'rspec', '~> 3.7'
+  gem.add_development_dependency 'rubocop', '~> 0.57.2'
+  gem.add_development_dependency 'simplecov', '~> 0'
 
   gem.files         = `git ls-files`.split("\n")
   gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   gem.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
-  gem.require_paths = ["lib"]
+  gem.require_paths = ['lib']
 end

data/build.sh

@@ -1,4 +1,16 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
-docker-compose build --pull
-docker-compose run test
+set -e
+
+docker pull ruby:2.5
+docker pull ruby:2.6
+
+docker run --rm -v "`pwd`:/app" -w /app --user `id -u`:`id -g` -e HOME="/tmp" "ruby:2.3" \
+  /bin/sh -c "echo \"gem: --no-document\" >> ~/.gemrc && bundle install --jobs 5 --quiet && bundle exec rubocop --cache false --fail-level autocorrect"
+
+for version in '2.5' '2.6'; do
+  echo "Testing Ruby $version..."
+  docker run --rm -v "`pwd`:/app" -w /app --user `id -u`:`id -g` \
+    -e HOME="/tmp" "ruby:$version" /bin/sh -c \
+    "echo \"gem: --no-document\" >> ~/.gemrc && bundle install --jobs 5 --quiet && bundle exec rspec"
+done

data/lib/api_client_builder.rb

@@ -1,9 +1,14 @@
-require 'api_client_builder/version'
-require 'api_client_builder/api_client'
-require 'api_client_builder/get_collection_request'
-require 'api_client_builder/get_item_request'
-require 'api_client_builder/post_request'
-require 'api_client_builder/put_request'
-require 'api_client_builder/request'
-require 'api_client_builder/response'
-require 'api_client_builder/url_generator'
+require 'uri'
+
+require_relative 'api_client_builder/version'
+require_relative 'api_client_builder/request'
+require_relative 'api_client_builder/response'
+
+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

@@ -1,9 +1,3 @@
-require 'api_client_builder/get_collection_request'
-require 'api_client_builder/get_item_request'
-require 'api_client_builder/post_request'
-require 'api_client_builder/put_request'
-require 'api_client_builder/url_generator'
-
 module APIClientBuilder
   # The base APIClient that defines the interface for defining an API Client.
   # Should be sub-classed and then provided an HTTPClient handler and a
@@ -28,7 +22,7 @@ module APIClientBuilder
     # @param route [String] defines the routes endpoint
     #
     # @return [Request] either a GetCollection or GetItem request
-    def self.get(type, plurality, route, **opts)
+    def self.get(type, plurality, route, **_opts)
       if plurality == :collection
         define_method("get_#{type}") do |**params|
           GetCollectionRequest.new(
@@ -81,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/get_collection_request.rb

@@ -1,5 +1,3 @@
-require 'api_client_builder/request'
-
 module APIClientBuilder
   # The multi item response object to be used as the container for
   # collection responses from the defined API
@@ -11,6 +9,7 @@ module APIClientBuilder
     # strategy is defined concretely on the response handler.
     #
     # @return [JSON] the http response body
+    # rubocop:disable Metrics/AbcSize
     def each
       if block_given?
         each_page do |page|
@@ -32,6 +31,7 @@ module APIClientBuilder
         Enumerator.new(self, :each)
       end
     end
+    # rubocop:enable Metrics/AbcSize
 
     private
 

data/lib/api_client_builder/get_item_request.rb

@@ -1,5 +1,3 @@
-require 'api_client_builder/request'
-
 module APIClientBuilder
   # The single item response object to be used as the container for
   # singular responses from the defined API

data/lib/api_client_builder/post_request.rb

@@ -1,5 +1,3 @@
-require 'api_client_builder/request'
-
 module APIClientBuilder
   class PostRequest < Request
     # Yields the response body if the response was successful. Will call

data/lib/api_client_builder/put_request.rb

@@ -1,5 +1,3 @@
-require 'api_client_builder/request'
-
 module APIClientBuilder
   class PutRequest < Request
     # Yields the response body if the response was successful. Will call

data/lib/api_client_builder/request.rb

@@ -1,5 +1,5 @@
 module APIClientBuilder
-  class DefaultPageError < StandardError;end
+  class DefaultPageError < StandardError; end
 
   class Request
     attr_reader :type, :response_handler, :body, :error_handlers_collection
@@ -23,11 +23,11 @@ module APIClientBuilder
     # @return [Array<Block>] the error handlers collection
     def error_handlers
       if error_handlers_collection.empty?
-        self.on_error do |page, handler|
-          raise 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: #{page.status_code}"
+        on_error do |page, _handler|
+          raise DefaultPageError, <<~MESSAGE
+            Default error for bad response. If you want to handle this error use #on_error
+            on the response in your api consumer. Error Code: #{page.status_code}.
+          MESSAGE
         end
       end
       error_handlers_collection

data/lib/api_client_builder/url_generator.rb

@@ -1,7 +1,5 @@
-require 'uri'
-
 module APIClientBuilder
-  class NoURLError < StandardError;end
+  class NoURLError < StandardError; end
   class URLGenerator
     # Receives a domain and parses it into a URI
     #
@@ -23,17 +21,26 @@ module APIClientBuilder
     #
     # @return [URI] the fully built route
     def build_route(route, **params)
-      string_params = route.split('/').select{|param| param.start_with?(':')}
-      symboled_params = string_params.map{|param| param.tr(':', '').to_sym}
+      string_params = route.split(%r{[\/=]}).select { |param| param.start_with?(':') }
+      symboled_params = string_params.map { |param| param.tr(':', '').to_sym }
 
       new_route = route.clone
       symboled_params.each do |param|
         value = params[param]
         raise ArgumentError, "Param :#{param} is required" unless value
-        new_route.gsub!(":#{param}", value.to_s)
+        new_route.gsub!(":#{param}", encode_ascii(value.to_s))
       end
 
       @base_uri.merge(new_route)
     end
+
+    private
+
+    def encode_ascii(str)
+      str.each_char.map do |c|
+        next c if c.force_encoding('ascii').valid_encoding?
+        CGI.escape c
+      end.join
+    end
   end
 end

data/lib/api_client_builder/version.rb

@@ -1,3 +1,3 @@
 module APIClientBuilder
-  VERSION = '1.0.1' unless defined?(APIClientBuilder::VERSION)
+  VERSION = '1.4.1'.freeze
 end

data/spec/lib/api_client_builder/api_client_spec.rb

@@ -1,11 +1,10 @@
 require 'spec_helper'
-require 'lib/api_client_builder/test_client/client'
-require 'api_client_builder/api_client'
+require_relative 'test_client/client'
 
 module APIClientBuilder
   describe APIClient do
-    let(:domain) {'https://www.domain.com/api/endpoints/'}
-    let(:client) {TestClient::Client.new(domain: domain)}
+    let(:domain) { 'https://www.domain.com/api/endpoints/' }
+    let(:client) { TestClient::Client.new(domain: domain) }
 
     describe '.get' do
       context 'plurality is :collection' do
@@ -42,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/get_collection_request_spec.rb

@@ -1,6 +1,5 @@
 require 'spec_helper'
-require 'api_client_builder/get_collection_request'
-require 'lib/api_client_builder/test_client/client'
+require_relative 'test_client/client'
 
 module APIClientBuilder
   describe GetCollectionRequest 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_objects.each{} }.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_objects.each {} }.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)
@@ -47,13 +45,12 @@ module APIClientBuilder
             client = TestClient::Client.new(domain: 'https://www.domain.com/api/endpoints/')
 
             bad_response = APIClientBuilder::Response.new('bad request', 400, [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)
-            expect{ client.get_some_objects.each{} }.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_objects.each {} }.to raise_error(
+              APIClientBuilder::DefaultPageError, /Error Code: 400/
             )
           end
         end

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,41 @@ 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/:query_string',
+            object_id: "\u1F4a9",
+            query_string: "?sample[]=\u1F648\u1F649\u1F64A&success=party\u1F64C"
+          )
+          expect(route).to eq(URI.parse('https://www.domain.com/api/endpoints/route_to_object/%E1%BD%8A9/object/' \
+                                        '?sample[]=%E1%BD%A48%E1%BD%A49%E1%BD%A4A&success=party%E1%BD%A4C'))
+        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.1
+  version: 1.4.1
 platform: ruby
 authors:
 - Jayce Higgins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-01 00:00:00.000000000 Z
+date: 2021-05-24 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,19 +75,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .dockerignore
-- .gitignore
-- .travis.yml
-- Dockerfile
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
 - Gemfile
+- Jenkinsfile
 - LICENSE.txt
 - README.md
-- api_client_builder-1.0.0.gem
 - api_client_builder.gemspec
 - build.sh
-- docker-compose.yml
 - 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
@@ -83,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
@@ -94,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: {}
@@ -104,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: []

data/.dockerignore

@@ -1 +0,0 @@
-Gemfile.lock

data/Dockerfile

@@ -1,16 +0,0 @@
-FROM instructure/rvm
-MAINTAINER Instructure
-
-COPY Gemfile* *.gemspec /usr/src/app/
-COPY lib/api_client_builder/version.rb /usr/src/app/lib/api_client_builder/
-
-USER root
-RUN chown -R docker:docker /usr/src/app
-USER docker
-RUN /bin/bash -l -c "cd /usr/src/app && bundle install"
-
-COPY . /usr/src/app
-USER root
-RUN chown -R docker:docker /usr/src/app/*
-USER docker
-CMD /bin/bash -l -c "cd /usr/src/app && pwd && bundle exec wwtd --parallel"

data/docker-compose.yml

@@ -1,4 +0,0 @@
-test:
-  build: .
-  volumes:
-    - "coverage:/app/coverage"