marble_api_client 1.0.0.pre.alpha → 1.0.0.pre.alpha.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07bb0106eb2b330cbedd19e5c4e3eb2ada24ee0730d1a1215f40f6747f8a28b9
-  data.tar.gz: e69d6c1eac333ad79019901d46eb4533c482124ea5fbb6c5f33e644db38d0c98
+  metadata.gz: af8b15a6c6b9c8f924514faec3239174d940a8f743f38f727d80256d5ecd5a29
+  data.tar.gz: 239322b12d457693d46e24c0a75f9b8940b726303732b8c033fba0cc41c98bae
 SHA512:
-  metadata.gz: 31aec67b60ec58add566da56550505c09c97116be608eb565bdeb6e72dd66b2c4fbfa5bd503ef4eb941cab583bc8d91a5f40c232b86bd7e7ec639d9e86fcfd3a
-  data.tar.gz: fff2dd756c5c60eadd571583493aa8a7c222879c0c066dd65d7208119b474a4626d2246af353d81236949f3aee90e58a8b1d0591a4a8d43db263fa9340e8bf49
+  metadata.gz: 65923ab69c544e910658e1aa6286f226f3e84ef21fa58be694991bc63cf3cca21d563bd88c27605449448e3e2e5edcd0b85913798583e6d116daac90ff9437db
+  data.tar.gz: d5e6ea846c798e7d6911906b1425b5c46ca2bb4c3328e33c93dcc72cbf97034bdd1592cf0078dc5662229ea863164f3468d7d7cdb04e4e88ac13e89a24bdb87d

data/.ruby-version

@@ -1 +1 @@
-2.6.3
+2.6.5

data/.travis.yml

@@ -4,10 +4,9 @@ env:
 language: ruby
 rvm:
   # Build on the latest stable of all supported Rubies (https://www.ruby-lang.org/en/downloads/):
-  - 2.3.8
-  - 2.4.6
-  - 2.5.5
-  - 2.6.3
+  - 2.4.9
+  - 2.5.7
+  - 2.6.5
 cache: bundler
 before_script:
   - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
@@ -15,7 +14,7 @@ before_script:
   - ./cc-test-reporter before-build
 script:
   - bundle exec rubocop
-  - bundle exec rspec spec --format documentation
+  - bundle exec rspec spec
 after_script:
   - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
 addons:

data/README.md

@@ -4,7 +4,7 @@
 [![Maintainability](https://api.codeclimate.com/v1/badges/fba9ec43303ca1595e5a/maintainability)](https://codeclimate.com/github/bluemarblepayroll/marble_api_client/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/fba9ec43303ca1595e5a/test_coverage)](https://codeclimate.com/github/bluemarblepayroll/marble_api_client/test_coverage)[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 
-This library is to simplify requests made to Marble Service Model (Still in procgress). This library offers simple objects to comply with the Marble Service Model request and response objects.
+This library exists to simplify requests made to Marble Service Model (Still in progress). It offers simple objects to comply with the Marble Service Model request and response objects.
 The library currently supports:
 
 * Create
@@ -28,14 +28,12 @@ bundle add marble_api_client
 
 ### Creating the client
 
-A client can be created with a url and any headers that should be included
-in all requests.
+A client can be created with a URL and any headers that should be included
+in all requests. By default, Content-Type of Application/JSON is added.
 ````ruby
-client = MarbleApiClient::Proxy.new(
-  'https://www.example.com:3000',
-  headers: { 'Content-Type': 'application/json' }
+client = MarbleApiClient.client(
+  'https://www.example.com:3000'
 )
-
 ````
 
 ### Making Request Objects

data/lib/marble_api_client/{proxy.rb → client.rb}

@@ -8,26 +8,26 @@
 #
 
 module MarbleApiClient
-  # Main class for sending http requests to url.
+  # Main class for sending HTTP requests to a URL.
   # Requests are sent using request and response objects crafted for each action.
   # Headers can be provided to the Proxy as default headers for all requests
-  class Proxy
+  class Client
     def initialize(base_url, headers: {})
       raise ArgumentError, 'Base URL is not valid' unless base_url_valid?(base_url)
 
       @base_url = base_url
-      @headers = headers
+      @headers = { 'Content-Type': 'application/json' }.merge(headers)
       freeze
     end
 
     def create(path, create_request: Requests::Create.new, headers: {})
-      response = send_request(path, create_request, headers, 'create')
-      Responses.get_response_object(response, Responses::CREATE_ACTION)
+      response = send_request(path, Requests::Create.make(create_request), headers, 'create')
+      Responses.parse_response(response, Responses::CREATE_ACTION)
     end
 
     def index(path, index_request: Requests::Index.new, headers: {})
-      response = send_request(path, index_request, headers, 'index')
-      Responses.get_response_object(response, Responses::INDEX_ACTION)
+      response = send_request(path, Requests::Index.make(index_request), headers, 'index')
+      Responses.parse_response(response, Responses::INDEX_ACTION)
     end
 
     private
@@ -38,7 +38,7 @@ module MarbleApiClient
 
       Net::HTTP.start(uri.host, uri.port, use_ssl: ssl?(uri)) do |http|
         request = Net::HTTP::Post.new(uri.request_uri)
-        merged_headers.each { |key, value| request.add_field(key, value) }
+        merged_headers.each { |key, value| request.add_field(key.to_s, value.to_s) }
         request.body = request_object.request_body
         http.request(request)
       end
@@ -57,12 +57,10 @@ module MarbleApiClient
     end
 
     def base_url_valid?(url)
-      uri = begin
-              URI.parse(url)
-            rescue URI::InvalidURIError
-              false
-            end
+      uri = URI.parse(url)
       uri.is_a?(URI::HTTP) || uri.is_a?(URI::HTTPS)
+    rescue URI::InvalidURIError
+      false
     end
   end
 end

data/lib/marble_api_client/requests/create.rb

@@ -9,11 +9,16 @@
 
 module MarbleApiClient
   module Requests
-    # Create Request Object
+    # Request object for sending create requests.
+    # Uses context and record to send data that
+    # the service model can use in controllers
     class Create
+      acts_as_hashable
+
       def initialize(context: {}, record: {})
         @context = context
         @record = record
+        freeze
       end
 
       def request_body

data/lib/marble_api_client/requests/index.rb

@@ -9,13 +9,18 @@
 
 module MarbleApiClient
   module Requests
-    # Index Request Object
+    # Request object for sending index requests.
+    # Uses context, record, page, and page_size to send
+    # data that the service model can use in controllers
     class Index
+      acts_as_hashable
+
       def initialize(context: {}, record: {}, page: 1, page_size: 25)
         @context = context
         @record = record
         @page = page
         @page_size = page_size
+        freeze
       end
 
       def request_body

data/lib/marble_api_client/responses/bad_request.rb

@@ -9,17 +9,10 @@
 
 module MarbleApiClient
   module Responses
-    # 400 Response Class
+    # Represents an HTTP 400 responses.
+    # Adds additional properties to the ClientError which encompasses the entire 400 level.
     class BadRequest < ClientError
-      ERRORS = 'errors'
-
-      def initialize(response)
-        super
-      end
-
-      def errors
-        parsed_body.dig(ERRORS)
-      end
+      body_attributes :message
     end
   end
 end

data/lib/marble_api_client/responses/body_attributes.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+module MarbleApiClient
+  module Responses
+    # Allows for declarative body attribute naming in response classes
+    module BodyAttributes
+      class << self
+        def included(klass)
+          klass.extend(ClassMethods)
+        end
+      end
+
+      # Extending ClassMethods to allow for module level class methods
+      module ClassMethods
+        def body_attributes(*keys)
+          keys.each do |k|
+            define_method(k) do
+              parsed_body.dig(json_key(k))
+            end
+          end
+        end
+      end
+
+      private
+
+      def json_key(key)
+        key.to_s.split('_').instance_eval do |k|
+          [k.first] + k.drop(1).map(&:capitalize)
+        end.join
+      end
+
+      def parsed_body
+        @parsed_body ||= JSON.parse(body)
+      end
+    end
+  end
+end

data/lib/marble_api_client/responses/client_error.rb

@@ -9,9 +9,10 @@
 
 module MarbleApiClient
   module Responses
-    # 400 Range Response Base Class
+    # Represents an HTTP 400 response. This will encompass all errors in the 400-499 range.
     class ClientError
       include HttpMethods
+      include BodyAttributes
 
       def initialize(response)
         @response = response

data/lib/marble_api_client/responses/forbidden.rb

@@ -9,21 +9,10 @@
 
 module MarbleApiClient
   module Responses
-    # 403 Response Class
+    # Represents an HTTP 403 responses.
+    # Adds additional properties to the ClientError which encompasses the entire 400 level.
     class Forbidden < ClientError
-      STATUS_CODE = 'statusCode'
-      REDIRECT_URL = 'redirectUrl'
-      def initialize(response)
-        super
-      end
-
-      def status_code
-        parsed_body.dig(STATUS_CODE)
-      end
-
-      def redirect_url
-        parsed_body.dig(REDIRECT_URL)
-      end
+      body_attributes :message, :redirect_url
     end
   end
 end

data/lib/marble_api_client/responses/http_methods.rb

@@ -9,7 +9,7 @@
 
 module MarbleApiClient
   module Responses
-    # Module assumes existance of @response Net::HTTPResponse object
+    # This module requires a "response" method which returns an instance of Net::HTTPResponse.
     module HttpMethods
       def code
         @response.code
@@ -18,12 +18,6 @@ module MarbleApiClient
       def body
         @response.body
       end
-
-      private
-
-      def parsed_body
-        @parsed_body ||= JSON.parse(body)
-      end
     end
   end
 end

data/lib/marble_api_client/responses/list.rb

@@ -9,52 +9,12 @@
 
 module MarbleApiClient
   module Responses
-    # 200 Response Index Class
+    # Represents an HTTP 200 responses.
+    # Adds additional properties to the Success class specific to Index requests.
     class List < Success
-      PAGE = 'page'
-      PAGE_SIZE = 'pageSize'
-      META = 'meta'
-      RECORDS = 'records'
-      SORT_DIRECTION = 'sortDirection'
-      SORT_COLUMN_INDEX = 'sortColumnIndex'
-      TOTAL = 'total'
-      TOTAL_PAGES = 'totalPages'
-
-      def initialize(response)
-        super
-      end
-
-      def page
-        parsed_body.dig(PAGE)
-      end
-
-      def page_size
-        parsed_body.dig(PAGE_SIZE)
-      end
-
-      def meta
-        parsed_body.dig(META)
-      end
-
-      def records
-        parsed_body.dig(RECORDS)
-      end
-
-      def sort_direction
-        parsed_body.dig(SORT_DIRECTION)
-      end
-
-      def sort_column_index
-        parsed_body.dig(SORT_COLUMN_INDEX)
-      end
-
-      def total
-        parsed_body.dig(TOTAL)
-      end
-
-      def total_pages
-        parsed_body.dig(TOTAL_PAGES)
-      end
+      body_attributes :page, :page_size, :meta, :records,
+                      :sort_direction, :sort_column_index,
+                      :total, :total_pages
     end
   end
 end

data/lib/marble_api_client/responses/not_found.rb

@@ -9,17 +9,10 @@
 
 module MarbleApiClient
   module Responses
-    # 404 Response Class
+    # Represents an HTTP 404 responses.
+    # Adds additional properties to the ClientError which encompasses the entire 400 level.
     class NotFound < ClientError
-      ERRORS = 'errors'
-
-      def initialize(response)
-        super
-      end
-
-      def errors
-        parsed_body.dig(ERRORS)
-      end
+      body_attributes :message
     end
   end
 end

data/lib/marble_api_client/responses/not_implemented.rb

@@ -8,17 +8,10 @@
 #
 module MarbleApiClient
   module Responses
-    # 501 Response Class
+    # Represents an HTTP 501 responses.
+    # Adds additional properties to the ServerError which encompasses the entire 500 level.
     class NotImplemented < ServerError
-      ERRORS = 'errors'
-
-      def initialize(response)
-        super
-      end
-
-      def errors
-        parsed_body.dig(ERRORS)
-      end
+      body_attributes :message
     end
   end
 end

data/lib/marble_api_client/responses/record.rb

@@ -9,17 +9,10 @@
 
 module MarbleApiClient
   module Responses
-    # 200 Response Create Class
+    # Represents an HTTP 200 responses.
+    # Adds additional properties to the Success class specific to Create requests.
     class Record < Success
-      RECORD = 'record'
-
-      def initialize(response)
-        super
-      end
-
-      def record
-        parsed_body.dig(RECORD)
-      end
+      body_attributes :record
     end
   end
 end

data/lib/marble_api_client/responses/server_error.rb

@@ -9,19 +9,16 @@
 
 module MarbleApiClient
   module Responses
-    # 500 Response Base Class
+    # Represents an HTTP 500 response. This will encompass all errors in the 500-599 range.
     class ServerError
       include HttpMethods
+      include BodyAttributes
 
-      ERRORS = 'errors'
+      body_attributes :errors
 
       def initialize(response)
         @response = response
       end
-
-      def errors
-        parsed_body.dig(ERRORS)
-      end
     end
   end
 end

data/lib/marble_api_client/responses/success.rb

@@ -9,9 +9,10 @@
 
 module MarbleApiClient
   module Responses
-    # 200 Response Base Class
+    # Represents an HTTP 200 response. This will encompass all errors in the 200-299 range.
     class Success
       include HttpMethods
+      include BodyAttributes
 
       def initialize(response)
         @response = response

data/lib/marble_api_client/responses/unauthorized.rb

@@ -9,11 +9,10 @@
 
 module MarbleApiClient
   module Responses
-    # 401 Response Class
+    # Represents an HTTP 401 responses.
+    # Adds additional properties to the ClientError which encompasses the entire 400 level.
     class Unauthorized < ClientError
-      def initialize(response)
-        super
-      end
+      body_attributes :message, :redirect_url
     end
   end
 end

data/lib/marble_api_client/responses/unprocessable_entity.rb

@@ -9,32 +9,10 @@
 
 module MarbleApiClient
   module Responses
-    # 422 Response Object
+    # Represents an HTTP 422 responses.
+    # Adds additional properties to the ClientError which encompasses the entire 400 level.
     class UnprocessableEntity < ClientError
-      ERRORS = 'errors'
-      ERROR_PROPERTIES = 'errorProperties'
-      WARNINGS = 'warnings'
-      WARNING_PROPERTIES = 'warningProperties'
-
-      def initialize(response)
-        super
-      end
-
-      def errors
-        parsed_body.dig(ERRORS)
-      end
-
-      def error_properties
-        parsed_body.dig(ERROR_PROPERTIES)
-      end
-
-      def warnings
-        parsed_body.dig(WARNINGS)
-      end
-
-      def warning_properties
-        parsed_body.dig(WARNING_PROPERTIES)
-      end
+      body_attributes :errors, :error_properties, :warnings, :warning_properties
     end
   end
 end

data/lib/marble_api_client/responses.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'responses/http_methods'
+require_relative 'responses/body_attributes'
 
 require_relative 'responses/success'
 require_relative 'responses/client_error'
@@ -16,7 +17,7 @@ require_relative 'responses/unauthorized'
 require_relative 'responses/unprocessable_entity'
 
 module MarbleApiClient
-  # Module for all response objects
+  # Module for getting response objects
   module Responses
     INDEX_ACTION = 'index'
     CREATE_ACTION = 'create'
@@ -31,6 +32,10 @@ module MarbleApiClient
     NOT_IMPLEMENTED_RESPONSE_CODE = '501'
 
     RESPONSES = [
+      {
+        code: SUCCESS_RESPONSE_CODE,
+        class_constant: Success
+      },
       {
         code: SUCCESS_RESPONSE_CODE,
         action: INDEX_ACTION,
@@ -72,20 +77,43 @@ module MarbleApiClient
     ].freeze
 
     class << self
-      def get_response_object(response, action)
+      def parse_response(response, action)
         raise ArgumentError, 'HTTPResponse required' unless response.is_a?(Net::HTTPResponse)
 
-        response_object = find_object(response, action)
+        find_object(response, action)[:class_constant].new(response)
+      end
 
-        raise ArgumentError, "Unexpecred HTTResponse: #{response.code}" unless response_object
+      private
 
-        response_object[:class_constant].new(response)
+      def find_object(response, action)
+        code_search = create_searches(response.code)
+        find_by_code_and_action(response.code, action, code_search)
       end
 
-      def find_object(response, action)
-        RESPONSES.find do |r|
-          r[:code] == response.code && (r[:action] ? r[:action] == action : true)
+      # Creates cascading searches using lambdas and the find ifnone argument.
+      # Shortcircuits at first found object and returns it.
+      def create_searches(code)
+        none_found = lambda do
+          raise ArgumentError, "Unexpecred HTTResponse: #{code}"
+        end
+
+        rounded_code_search = lambda do
+          RESPONSES.find(none_found) { |r| r[:action].nil? && r[:code] == rounded_code(code) }
         end
+
+        lambda do
+          RESPONSES.find(rounded_code_search) { |r| r[:action].nil? && r[:code] == code }
+        end
+      end
+
+      def find_by_code_and_action(code, action, ifnone)
+        RESPONSES.find(ifnone) do |r|
+          r[:code] == code && r[:action] == action
+        end
+      end
+
+      def rounded_code(code)
+        code.to_i.floor(-2).to_s
       end
     end
   end

data/lib/marble_api_client/version.rb

@@ -8,5 +8,5 @@
 #
 
 module MarbleApiClient
-  VERSION = '1.0.0-alpha'
+  VERSION = '1.0.0-alpha.1'
 end

data/lib/marble_api_client.rb

@@ -8,11 +8,17 @@
 #
 
 require 'net/http'
+require 'acts_as_hashable'
 
-require_relative 'marble_api_client/proxy'
+require_relative 'marble_api_client/client'
 require_relative 'marble_api_client/requests'
 require_relative 'marble_api_client/responses'
 
 # This class interacts with Blue Marble Payroll Webglobe API
 module MarbleApiClient
+  class << self
+    def client(base_url, headers: {})
+      Client.new(base_url, headers)
+    end
+  end
 end

data/marble_api_client.gemspec

@@ -19,14 +19,16 @@ Gem::Specification.new do |s|
   s.homepage    = 'https://github.com/bluemarblepayroll/marble_api_client'
   s.license     = 'MIT'
 
-  s.required_ruby_version = '>= 2.3.8'
+  s.required_ruby_version = '>= 2.3.8', '<2.7.0'
+
+  s.add_dependency 'acts_as_hashable', '~> 1'
 
   s.add_development_dependency('guard-rspec', '~>4.7')
   s.add_development_dependency('pry', '~>0')
   s.add_development_dependency('rake', '~> 12')
-  s.add_development_dependency('rspec')
-  s.add_development_dependency('rubocop', '~>0.74.0')
-  s.add_development_dependency('simplecov', '~>0.17.0')
-  s.add_development_dependency('simplecov-console', '~>0.5.0')
-  s.add_development_dependency('webmock')
+  s.add_development_dependency('rspec', '~>3.8')
+  s.add_development_dependency('rubocop', '~>0.74')
+  s.add_development_dependency('simplecov', '~>0.17')
+  s.add_development_dependency('simplecov-console', '~>0.5')
+  s.add_development_dependency('webmock', '~>3.7')
 end

data/spec/marble_api_client/{proxy_spec.rb → client_spec.rb}

@@ -9,21 +9,20 @@
 
 require 'spec_helper'
 
-RSpec.describe MarbleApiClient::Proxy do
-  let(:proxy) do
-    MarbleApiClient::Proxy.new(
-      'http://www.example.com:3000',
-      headers: { 'Content-Type': 'application/json' }
+RSpec.describe MarbleApiClient::Client do
+  let(:client) do
+    MarbleApiClient::Client.new(
+      'http://www.example.com:3000'
     )
   end
 
   it 'requires a base_url' do
-    expect { MarbleApiClient::Proxy.new(nil) }
+    expect { MarbleApiClient::Client.new(nil) }
       .to raise_error(ArgumentError, 'Base URL is not valid')
   end
 
   it 'uses SSL for HTTPS requests' do
-    p = MarbleApiClient::Proxy.new(
+    p = MarbleApiClient::Client.new(
       'https://www.example.com:3000',
       headers: { 'Content-Type': 'application/json' }
     )
@@ -36,19 +35,35 @@ RSpec.describe MarbleApiClient::Proxy do
   context 'create' do
     it 'sends requests to path' do
       stub_request(:post, 'http://www.example.com:3000/custom/path/create')
-      proxy.create('custom/path')
+      client.create('custom/path')
       expect(WebMock).to have_requested(:post, 'http://www.example.com:3000/custom/path/create')
     end
 
     it 'sends requests to path ending in "/"' do
       stub_request(:post, 'http://www.example.com:3000/custom/path/create')
-      proxy.create('custom/path/')
+      client.create('custom/path/')
       expect(WebMock).to have_requested(:post, 'http://www.example.com:3000/custom/path/create')
     end
 
     it 'sends correct headers' do
       stub_request(:post, 'http://www.example.com:3000/custom/path/create')
-      proxy.create('custom/path', headers: { option: 'val' })
+      client.create('custom/path', headers: { option: 'val' })
+      expect(WebMock).to have_requested(:post, 'http://www.example.com:3000/custom/path/create')
+        .with(headers: { 'Content-Type': 'application/json',
+                         option: 'val' })
+    end
+
+    it 'sends symbol headers' do
+      stub_request(:post, 'http://www.example.com:3000/custom/path/create')
+      client.create('custom/path', headers: { option: 'val' })
+      expect(WebMock).to have_requested(:post, 'http://www.example.com:3000/custom/path/create')
+        .with(headers: { 'Content-Type': 'application/json',
+                         option: 'val' })
+    end
+
+    it 'sends string headers' do
+      stub_request(:post, 'http://www.example.com:3000/custom/path/create')
+      client.create('custom/path', headers: { 'option' => 'val' })
       expect(WebMock).to have_requested(:post, 'http://www.example.com:3000/custom/path/create')
         .with(headers: { 'Content-Type': 'application/json',
                          option: 'val' })
@@ -56,8 +71,16 @@ RSpec.describe MarbleApiClient::Proxy do
 
     it 'sends the correct body' do
       stub_request(:post, 'http://www.example.com:3000/custom/path/create')
-      proxy.create('custom/path',
-                   create_request: MarbleApiClient::Requests::Create.new(record: { name: 'blue' }))
+      client.create('custom/path',
+                    create_request: MarbleApiClient::Requests::Create.new(record: { name: 'blue' }))
+      expect(WebMock).to have_requested(:post, 'http://www.example.com:3000/custom/path/create')
+        .with(body: { context: {}, record: { name: 'blue' } })
+    end
+
+    it 'allows hash instead of Request::Create object' do
+      stub_request(:post, 'http://www.example.com:3000/custom/path/create')
+      client.create('custom/path',
+                    create_request: { record: { name: 'blue' } })
       expect(WebMock).to have_requested(:post, 'http://www.example.com:3000/custom/path/create')
         .with(body: { context: {}, record: { name: 'blue' } })
     end
@@ -66,13 +89,13 @@ RSpec.describe MarbleApiClient::Proxy do
   context 'index' do
     it 'sends to requested path' do
       stub_request(:post, 'http://www.example.com:3000/custom/path/index')
-      proxy.index('custom/path')
+      client.index('custom/path')
       expect(WebMock).to have_requested(:post, 'http://www.example.com:3000/custom/path/index')
     end
 
     it 'sends the correct headers' do
       stub_request(:post, 'http://www.example.com:3000/custom/path/index')
-      proxy.index('custom/path', headers: { option: 'val' })
+      client.index('custom/path', headers: { option: 'val' })
       expect(WebMock).to have_requested(:post, 'http://www.example.com:3000/custom/path/index')
         .with(headers: { 'Content-Type': 'application/json',
                          option: 'val' })
@@ -80,8 +103,16 @@ RSpec.describe MarbleApiClient::Proxy do
 
     it 'sends the correct body' do
       stub_request(:post, 'http://www.example.com:3000/custom/path/index')
-      proxy.index('custom/path',
-                  index_request: MarbleApiClient::Requests::Index.new(record: { name: 'blue' }))
+      client.index('custom/path',
+                   index_request: MarbleApiClient::Requests::Index.new(record: { name: 'blue' }))
+      expect(WebMock).to have_requested(:post, 'http://www.example.com:3000/custom/path/index')
+        .with(body: { context: {}, record: { name: 'blue' }, page: 1, page_size: 25 })
+    end
+
+    it 'allows hash instead of Request::Index object' do
+      stub_request(:post, 'http://www.example.com:3000/custom/path/index')
+      client.index('custom/path',
+                   index_request: { record: { name: 'blue' } })
       expect(WebMock).to have_requested(:post, 'http://www.example.com:3000/custom/path/index')
         .with(body: { context: {}, record: { name: 'blue' }, page: 1, page_size: 25 })
     end

data/spec/marble_api_client/responses/bad_request_spec.rb

@@ -11,14 +11,14 @@ require 'spec_helper'
 
 RSpec.describe MarbleApiClient::Responses::BadRequest do
   context 'provides' do
-    let(:error_hash) { { name: 'invalid' }.to_json }
+    let(:message) { 'invalid' }
     let(:response) do
-      instance_double(Net::HTTPResponse, code: 400, body: { errors: error_hash }.to_json)
+      instance_double(Net::HTTPResponse, code: 400, body: { message: message }.to_json)
     end
 
-    it 'errors' do
-      expect(described_class.new(response).errors)
-        .to eq(error_hash)
+    specify 'message' do
+      expect(described_class.new(response).message)
+        .to eq(message)
     end
   end
 end

data/spec/marble_api_client/responses/forbidden_spec.rb

@@ -14,16 +14,16 @@ RSpec.describe MarbleApiClient::Responses::Forbidden do
     let(:response) do
       instance_double(Net::HTTPResponse,
                       code: 400,
-                      body: { statusCode: '403',
+                      body: { message: 'not allowed',
                               redirectUrl: 'www.example.com/hello' }.to_json)
     end
 
-    it 'Status Code' do
-      expect(described_class.new(response).status_code)
-        .to eq('403')
+    specify 'message' do
+      expect(described_class.new(response).message)
+        .to eq('not allowed')
     end
 
-    it 'Redirect URL' do
+    specify 'Redirect URL' do
       expect(described_class.new(response).redirect_url)
         .to eq('www.example.com/hello')
     end

data/spec/marble_api_client/responses/list_spec.rb

@@ -34,42 +34,42 @@ RSpec.describe MarbleApiClient::Responses::List do
                       }.to_json)
     end
 
-    it 'page' do
+    specify 'page' do
       expect(described_class.new(response).page)
         .to eq(page)
     end
 
-    it 'page_size' do
+    specify 'page_size' do
       expect(described_class.new(response).page_size)
         .to eq(page_size)
     end
 
-    it 'meta' do
+    specify 'meta' do
       expect(described_class.new(response).meta)
         .to eq(meta)
     end
 
-    it 'records' do
+    specify 'records' do
       expect(described_class.new(response).records)
         .to eq(records)
     end
 
-    it 'sort driection' do
+    specify 'sort driection' do
       expect(described_class.new(response).sort_direction)
         .to eq(sort_direction)
     end
 
-    it 'sort column index' do
+    specify 'sort column index' do
       expect(described_class.new(response).sort_column_index)
         .to eq(sort_column_index)
     end
 
-    it 'total' do
+    specify 'total' do
       expect(described_class.new(response).total)
         .to eq(total)
     end
 
-    it 'total pages' do
+    specify 'total pages' do
       expect(described_class.new(response).total_pages)
         .to eq(total_pages)
     end

data/spec/marble_api_client/responses/not_found_spec.rb

@@ -11,14 +11,14 @@ require 'spec_helper'
 
 RSpec.describe MarbleApiClient::Responses::NotFound do
   context 'provides' do
-    let(:error_hash) { { name: 'invalid' }.to_json }
+    let(:message) { 'invalid' }
     let(:response) do
-      instance_double(Net::HTTPResponse, code: 400, body: { errors: error_hash }.to_json)
+      instance_double(Net::HTTPResponse, code: 400, body: { message: message }.to_json)
     end
 
-    it 'errors' do
-      expect(described_class.new(response).errors)
-        .to eq(error_hash)
+    specify 'errors' do
+      expect(described_class.new(response).message)
+        .to eq(message)
     end
   end
 end

data/spec/marble_api_client/responses/not_implmented_spec.rb

@@ -16,7 +16,7 @@ RSpec.describe MarbleApiClient::Responses::NotImplemented do
       instance_double(Net::HTTPResponse, code: 400, body: { errors: error_hash }.to_json)
     end
 
-    it 'errors' do
+    specify 'errors' do
       expect(described_class.new(response).errors)
         .to eq(error_hash)
     end

data/spec/marble_api_client/responses/record_spec.rb

@@ -16,7 +16,7 @@ RSpec.describe MarbleApiClient::Responses::Record do
       instance_double(Net::HTTPResponse, code: 400, body: { record: record }.to_json)
     end
 
-    it 'errors' do
+    specify 'errors' do
       expect(described_class.new(response).record)
         .to eq(record)
     end

data/spec/marble_api_client/responses/responses_spec.rb

@@ -12,79 +12,93 @@ require 'spec_helper'
 RSpec.describe MarbleApiClient::Responses do
   it 'requires a HTTPResponse' do
     response = nil
-    expect { described_class.get_response_object(response, 'index') }
+    expect { described_class.parse_response(response, 'index') }
       .to raise_error(ArgumentError)
   end
 
-  context 'returns the right objects' do
-    it '200' do
+  describe 'objects returned for various HTTP status codes' do
+    specify '200' do
       response = Net::HTTPResponse.new(1.0, '200', 'OK')
-      response.uri = 'www.exampleuri.com/index'
-      expect(described_class.get_response_object(response, 'index'))
+      response.uri = 'www.exampleuri.com/notarealaction'
+      expect(described_class.parse_response(response, 'notarealaction'))
         .to be_a_kind_of(MarbleApiClient::Responses::Success)
     end
 
-    it '200 Index' do
+    specify '200 Index' do
       response = Net::HTTPResponse.new(1.0, '200', 'OK')
       response.uri = 'www.exampleuri.com/index'
-      expect(described_class.get_response_object(response, 'index'))
+      expect(described_class.parse_response(response, 'index'))
         .to be_a_kind_of(MarbleApiClient::Responses::List)
     end
 
-    it '200 Create' do
+    specify '200 Create' do
       response = Net::HTTPResponse.new(1.0, '200', 'OK')
       response.uri = 'www.exampleuri.com/create'
-      expect(described_class.get_response_object(response, 'create'))
+      expect(described_class.parse_response(response, 'create'))
         .to be_a_kind_of(MarbleApiClient::Responses::Record)
     end
 
-    it '400' do
+    specify '400' do
       response = Net::HTTPResponse.new(1.0, '400', 'Client Error')
       response.uri = 'www.exampleuri.com/index'
-      expect(described_class.get_response_object(response, 'index'))
+      expect(described_class.parse_response(response, 'index'))
         .to be_a_kind_of(MarbleApiClient::Responses::BadRequest)
     end
 
-    it '401' do
+    specify '401' do
       response = Net::HTTPResponse.new(1.0, '401', 'Client Error')
       response.uri = 'www.exampleuri.com/index'
-      expect(described_class.get_response_object(response, 'index'))
+      expect(described_class.parse_response(response, 'index'))
         .to be_a_kind_of(MarbleApiClient::Responses::Unauthorized)
     end
 
-    it '403' do
+    specify '403' do
       response = Net::HTTPResponse.new(1.0, '403', 'Client Error')
       response.uri = 'www.exampleuri.com/index'
-      expect(described_class.get_response_object(response, 'index'))
+      expect(described_class.parse_response(response, 'index'))
         .to be_a_kind_of(MarbleApiClient::Responses::Forbidden)
     end
 
-    it '404' do
+    specify '404' do
       response = Net::HTTPResponse.new(1.0, '404', 'Client Error')
       response.uri = 'www.exampleuri.com/index'
-      expect(described_class.get_response_object(response, 'index'))
+      expect(described_class.parse_response(response, 'index'))
         .to be_a_kind_of(MarbleApiClient::Responses::NotFound)
     end
 
-    it '422' do
+    specify '422' do
       response = Net::HTTPResponse.new(1.0, '422', 'Client Error')
       response.uri = 'www.exampleuri.com/index'
-      expect(described_class.get_response_object(response, 'index'))
+      expect(described_class.parse_response(response, 'index'))
         .to be_a_kind_of(MarbleApiClient::Responses::UnprocessableEntity)
     end
 
-    it '500' do
+    specify '500' do
       response = Net::HTTPResponse.new(1.0, '500', 'Server Error')
       response.uri = 'www.exampleuri.com/index'
-      expect(described_class.get_response_object(response, 'index'))
+      expect(described_class.parse_response(response, 'index'))
         .to be_a_kind_of(MarbleApiClient::Responses::ServerError)
     end
 
-    it '501' do
+    specify '501' do
       response = Net::HTTPResponse.new(1.0, '501', 'Server Error')
       response.uri = 'www.exampleuri.com/index'
-      expect(described_class.get_response_object(response, 'index'))
+      expect(described_class.parse_response(response, 'index'))
         .to be_a_kind_of(MarbleApiClient::Responses::NotImplemented)
     end
+
+    specify '503' do
+      response = Net::HTTPResponse.new(1.0, '503', 'Server Error')
+      response.uri = 'www.exampleuri.com/index'
+      expect(described_class.parse_response(response, 'index'))
+        .to be_a_kind_of(MarbleApiClient::Responses::ServerError)
+    end
+
+    specify '1000' do
+      response = Net::HTTPResponse.new(1.0, '1000', 'Not Real Error')
+      response.uri = 'www.exampleuri.com/index'
+      expect { described_class.parse_response(response, 'index') }
+        .to raise_error(ArgumentError)
+    end
   end
 end

data/spec/marble_api_client/responses/server_error_spec.rb

@@ -16,7 +16,7 @@ RSpec.describe MarbleApiClient::Responses::ServerError do
       instance_double(Net::HTTPResponse, code: 400, body: { errors: error_hash }.to_json)
     end
 
-    it 'errors' do
+    specify 'errors' do
       expect(described_class.new(response).errors)
         .to eq(error_hash)
     end

data/spec/marble_api_client/responses/unauthorized_spec.rb

@@ -10,4 +10,22 @@
 require 'spec_helper'
 
 RSpec.describe MarbleApiClient::Responses::Unauthorized do
+  context 'provides' do
+    let(:response) do
+      instance_double(Net::HTTPResponse,
+                      code: 400,
+                      body: { message: 'not authorized',
+                              redirectUrl: 'www.example.com/hello' }.to_json)
+    end
+
+    specify 'message' do
+      expect(described_class.new(response).message)
+        .to eq('not authorized')
+    end
+
+    specify 'Redirect URL' do
+      expect(described_class.new(response).redirect_url)
+        .to eq('www.example.com/hello')
+    end
+  end
 end

data/spec/marble_api_client/responses/unprocessable_entity_spec.rb

@@ -26,22 +26,22 @@ RSpec.describe MarbleApiClient::Responses::UnprocessableEntity do
                       }.to_json)
     end
 
-    it 'errors' do
+    specify 'errors' do
       expect(described_class.new(response).errors)
         .to eq(errors)
     end
 
-    it 'error properties' do
+    specify 'error properties' do
       expect(described_class.new(response).error_properties)
         .to eq(error_properties)
     end
 
-    it 'warnings' do
+    specify 'warnings' do
       expect(described_class.new(response).warnings)
         .to eq(warnings)
     end
 
-    it 'warning properties' do
+    specify 'warning properties' do
       expect(described_class.new(response).warning_properties)
         .to eq(warning_properties)
     end

data/spec/marble_api_client_spec.rb

@@ -13,4 +13,9 @@ RSpec.describe MarbleApiClient do
   it 'has a version number' do
     expect(MarbleApiClient::VERSION).not_to be nil
   end
+
+  specify 'client returns a MarbleApiClient::Client' do
+    expect(MarbleApiClient.client('http://www.example.com'))
+      .to be_a(MarbleApiClient::Client)
+  end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: marble_api_client
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.alpha
+  version: 1.0.0.pre.alpha.1
 platform: ruby
 authors:
 - Dan Dewar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-12 00:00:00.000000000 Z
+date: 2020-01-09 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: acts_as_hashable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -56,72 +70,72 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.8'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.74.0
+        version: '0.74'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.74.0
+        version: '0.74'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: '0.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: '0.17'
 - !ruby/object:Gem::Dependency
   name: simplecov-console
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: '0.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: webmock
   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'
 description: "    Write a description.\n"
 email:
 - ddewar@bluemarblepayroll.com
@@ -144,12 +158,13 @@ files:
 - Rakefile
 - bin/console
 - lib/marble_api_client.rb
-- lib/marble_api_client/proxy.rb
+- lib/marble_api_client/client.rb
 - lib/marble_api_client/requests.rb
 - lib/marble_api_client/requests/create.rb
 - lib/marble_api_client/requests/index.rb
 - lib/marble_api_client/responses.rb
 - lib/marble_api_client/responses/bad_request.rb
+- lib/marble_api_client/responses/body_attributes.rb
 - lib/marble_api_client/responses/client_error.rb
 - lib/marble_api_client/responses/forbidden.rb
 - lib/marble_api_client/responses/http_methods.rb
@@ -163,7 +178,7 @@ files:
 - lib/marble_api_client/responses/unprocessable_entity.rb
 - lib/marble_api_client/version.rb
 - marble_api_client.gemspec
-- spec/marble_api_client/proxy_spec.rb
+- spec/marble_api_client/client_spec.rb
 - spec/marble_api_client/requests/create_spec.rb
 - spec/marble_api_client/requests/index_spec.rb
 - spec/marble_api_client/responses/bad_request_spec.rb
@@ -193,6 +208,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ">="
     - !ruby/object:Gem::Version
       version: 2.3.8
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"
@@ -204,7 +222,7 @@ signing_key:
 specification_version: 4
 summary: Write a summary.
 test_files:
-- spec/marble_api_client/proxy_spec.rb
+- spec/marble_api_client/client_spec.rb
 - spec/marble_api_client/requests/create_spec.rb
 - spec/marble_api_client/requests/index_spec.rb
 - spec/marble_api_client/responses/bad_request_spec.rb