change to internal client

Author: silesky

.editorconfig

@@ -1,3 +1,4 @@
+# https://github.com/ruby/ruby/blob/master/.editorconfig
 root = true
 
 [*]

.gitignore

@@ -38,4 +38,8 @@
 .rvmrc
 
 # Used by RuboCop. Remote config files pulled in from inherit_from directive.
-# .rubocop-https?--*
+# .rubocop-https?--*
+
+# Editor-specific directories
+.vscode
+.idea

Guardfile

@@ -1,42 +1,6 @@
-# A sample Guardfile
 # More info at https://github.com/guard/guard#readme
-
-## Uncomment and set this to only include directories you want to watch
-# directories %w(app lib config test spec features) \
-#  .select{|d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist")}
-
-## Note: if you are using the `directories` clause above and you are not
-## watching the project directory ('.'), then you will want to move
-## the Guardfile to a watched dir and symlink it back, e.g.
-#
-#  $ mkdir config
-#  $ mv Guardfile config/
-#  $ ln -s config/Guardfile .
-#
-# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
-
 guard :minitest do
-  # with Minitest::Unit
-  watch(%r{^test/(.*)/?test_(.*)\.rb$})
-  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
-  watch(%r{^test/test_helper\.rb$})      { 'test' }
-
-  # with Minitest::Spec
-  # watch(%r{^spec/(.*)_spec\.rb$})
-  # watch(%r{^lib/(.+)\.rb$})         { |m| "spec/#{m[1]}_spec.rb" }
-  # watch(%r{^spec/spec_helper\.rb$}) { 'spec' }
-
-  # Rails 4
-  # watch(%r{^app/(.+)\.rb$})                               { |m| "test/#{m[1]}_test.rb" }
-  # watch(%r{^app/controllers/application_controller\.rb$}) { 'test/controllers' }
-  # watch(%r{^app/controllers/(.+)_controller\.rb$})        { |m| "test/integration/#{m[1]}_test.rb" }
-  # watch(%r{^app/views/(.+)_mailer/.+})                    { |m| "test/mailers/#{m[1]}_mailer_test.rb" }
-  # watch(%r{^lib/(.+)\.rb$})                               { |m| "test/lib/#{m[1]}_test.rb" }
-  # watch(%r{^test/.+_test\.rb$})
-  # watch(%r{^test/test_helper\.rb$}) { 'test' }
-
-  # Rails < 4
-  # watch(%r{^app/controllers/(.*)\.rb$}) { |m| "test/functional/#{m[1]}_test.rb" }
-  # watch(%r{^app/helpers/(.*)\.rb$})     { |m| "test/helpers/#{m[1]}_test.rb" }
-  # watch(%r{^app/models/(.*)\.rb$})      { |m| "test/unit/#{m[1]}_test.rb" }
+  watch(%r{^test/(.*)_test\.rb$})
+  watch(%r{^lib/(.+)\.rb$})         { |m| "test/#{m[1]}_test.rb" }
+  watch(%r{^test/test_helper\.rb$}) { 'test' }
 end

README.md

@@ -16,6 +16,7 @@ The Official Ruby SDK for ShipEngine
 
 ## Commands
 
-- Run tests: `rake test`
+- Run tests once: `rake test`
+- Run tests on change: `guard`
 - Lint: `rake lint`
 - Autoformat: `rake fix`

lib/shipengine.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 require 'shipengine/version'
-require 'shipengine/client/platform'
+require 'shipengine/client/internal'
 require 'shipengine/exceptions'

lib/shipengine/client/platform.rb lib/shipengine/client/internal.rb

@@ -3,7 +3,7 @@
 require 'faraday_middleware'
 
 module ShipEngine
-  class PlatformClient
+  class InternalClient
     attr_accessor :connection
 
     def initialize(api_key:, base_url: 'https://simengine.herokuapp.com/jsonrpc', adapter: Faraday.default_adapter)
@@ -15,18 +15,17 @@ def initialize(api_key:, base_url: 'https://simengine.herokuapp.com/jsonrpc', ad
       end
     end
 
-    def assert_no_platform_errors(response)
-      # puts response.inspect
-      body = response.body
-      error = body['error'] || {}
-      data = error['data']
-      return unless data
-        raise ShipEngine::Exceptions::ShipEngineErrorDetailed.new(body['id'], error['message'], data) unless data.nil?
+    def assert_shipengine_rpc_success(body)
+      error, request_id = body.values_at('error', 'request_id')
+      if error
+        message, data = error.values_at('message', 'data')
+        source, type, code = data.values_at('source', 'type', 'code')
+        raise ShipEngine::Exceptions::ShipEngineErrorDetailed.new(request_id, message, source, type, code)
       end
     end
 
     # create jsonrpc request has
-    def create_jsonrpc_request_body(method, params)
+    def build_jsonrpc_request_body(method, params)
       {
         jsonrpc: '2.0',
         id: '123',
@@ -36,11 +35,13 @@ def create_jsonrpc_request_body(method, params)
     end
 
     def make_request(method, params)
-      response = @connection.send(:post, nil, create_jsonrpc_request_body(method, params))
-      assert_no_platform_errors(response)
-      response.body
-    # throw an error if status code is 400 or above.
-    # Faraday does not throw errors for 400s -- only 500s!
+      response = @connection.send(:post, nil, build_jsonrpc_request_body(method, params))
+      body = response.body
+      assert_shipengine_rpc_success(body)
+
+      body
+      # throw an error if status code is 400 or above.
+      # Faraday does not throw errors for 400s -- only 500s!
     rescue Faraday::Error => e
       raise ShipEngine::Exceptions::ShipEngineError, e.message
     end

lib/shipengine/exceptions.rb

@@ -11,12 +11,15 @@ def initialize(message_or_messages)
 
     # 400 error, or other "user exceptions"
     class ShipEngineErrorDetailed < ShipEngineError
-      def initialize(request_id, message, data)
+      attr_reader :request_id, :message, :source, :type, :code
+
+      def initialize(request_id, message, source, type, code)
         super(message)
         @request_id = request_id
-        @source = data['source']
-        @type = data['type']
-        @code = data['code']
+        @message = message  # super with attribute reader seems odd
+        @source = source
+        @type = type
+        @code = code
       end
     end
   end

test/address/validate_address_test.rb

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-describe 'validate address' do
+describe 'Validate Address' do
   it 'Should successfully validate an address' do
     # client = ::ShipEngine::Client.new(api_key: 'abc123')
     # valid_address = {

test/client_test.rb test/internal_client_test.rb

@@ -1,8 +1,8 @@
 require 'test_helper'
 require 'pry'
-describe 'Client test' do
+describe 'Internal client test' do
   it 'Should make a request' do
-    client = ::ShipEngine::PlatformClient.new(api_key: 'abc123')
+    client = ::ShipEngine::InternalClient.new(api_key: 'abc123')
     params = { address: {
       street: ['501 Crawford St'],
       city_locality: 'Houston',
@@ -15,12 +15,15 @@
   end
 
   it 'Should throw Errors' do
-    client = ::ShipEngine::PlatformClient.new(api_key: 'abc123')
+    client = ::ShipEngine::InternalClient.new(api_key: 'abc123')
     client.make_request('address/validate', { foo: 'invalid request' })
-    raise 'should not happen'
-  rescue ShipEngine::Exceptions::ShipEngineError => e
+    raise 'force fail'
+  rescue ShipEngine::Exceptions::ShipEngineErrorDetailed => e
+    assert e.source.is_a?(String)
+    assert e.type.is_a?(String)
+    assert e.code.is_a?(String)
     assert e.message.is_a?(String)
   else
-    raise 'should not happen'
+    raise 'force fail'
   end
 end

test/smoke_test.rb

@@ -2,12 +2,8 @@
 
 require 'test_helper'
 
-class ShipEngineTest < Minitest::Test
-  def test_that_it_has_a_version_number
+describe 'Smoke tests' do
+  it 'Should test a version number' do
     refute_nil ::ShipEngine::VERSION
   end
-
-  def test_it_does_something_useful
-    assert true
-  end
 end