shipcloud 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: be261ed61c16ba184adf29c75d3c40721eefc397
-  data.tar.gz: 54e6e380adc84a996c581726a8e3c0a47e60a6bf
+  metadata.gz: e1af501886ebceb1740604bdc3216bac732bfd3a
+  data.tar.gz: b0eb7b46245cab6d030a7dc4ec268ad2198cc117
 SHA512:
-  metadata.gz: 64d988f7fdf9d858e240f132282da454c0bd814b30accc290d045ca17bcf73fce67c370293d1db75b53facff9d9918ace79fcaa4fd99e592fdad0398cfad3340
-  data.tar.gz: 19ca529bafdf0764d357e0652fe55019a7a84b0d1a5ce8d5c3d5514b571635af6eac92291b2381d084596dc14fbede14a3caf3119997a8518f9603b45645eb83
+  metadata.gz: f84e3710264fe699fde827fa9393bb54fa1d054385f8c966da2238898ec9ccfe9b424399e35630c98c89d9e7375fef97d1745d7178087a3030c3267d6e1051f7
+  data.tar.gz: 5efa177ecb0085b8dee951c02032b4b874f26c3a85df5ba07920d399c0bf048b2ab2434b75ec3429802a65469195ad03c7f533d4bf39d9c8b1445d45b64367f4

data/.ruby-style.yml

@@ -1,9 +1,10 @@
 AllCops:
-  RunRailsCops: true
   Exclude:
     - "vendor/**/*"
     - "db/schema.rb"
   UseCache: false
+Rails:
+  Enabled: true
 Rails/FindBy:
   Enabled: false
 Metrics/LineLength:
@@ -30,6 +31,21 @@ Style/FileName:
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#snake-case-files
   Enabled: false
   Exclude: []
+Style/FirstArrayElementLineBreak:
+  Description: >-
+                 Checks for a line break before the first element in a
+                 multi-line array.
+  Enabled: true
+Style/FirstHashElementLineBreak:
+  Description: >-
+                 Checks for a line break before the first element in a
+                 multi-line hash.
+  Enabled: true
+Style/FirstMethodArgumentLineBreak:
+  Description: >-
+                 Checks for a line break before the first argument in a
+                 multi-line method call.
+  Enabled: true
 Style/GuardClause:
   Description: Check for conditionals that can be replaced with guard clauses
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-nested-conditionals
@@ -118,13 +134,24 @@ Style/StringLiteralsInInterpolation:
   SupportedStyles:
   - single_quotes
   - double_quotes
-Style/TrailingComma:
-  Description: Checks for trailing comma in parameter lists and literals.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas
+Style/TrailingCommaInArguments:
+  Description: 'Checks for trailing comma in argument lists.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
+  Enabled: false
+  EnforcedStyleForMultiline: no_comma
+  SupportedStyles:
+  - comma
+  - consistent_comma
+  - no_comma
+Style/TrailingCommaInLiteral:
+  Description: 'Checks for trailing comma in array and hash literals.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
   Enabled: false
   EnforcedStyleForMultiline: no_comma
   SupportedStyles:
   - comma
+  - consistent_comma
+  - no_comma
 Metrics/AbcSize:
   Description: A calculated magnitude based on number of assignments, branches, and
     conditions.

data/.travis.yml

@@ -5,7 +5,6 @@ rvm:
   - 2.1.7
   - 2.2.4
   - 2.3.0
-  - jruby-9.0.0.0
   - rbx-2
 notifications:
   flowdock:

data/CHANGELOG.md

@@ -1,3 +1,28 @@
+## [Unreleased]
+### Added
+
+### Removed
+
+### Changed
+
+### Fixed
+
+## [0.7.0] - 2016-01-21
+### Added
+- Add the possibility to specify the api key on every request. (#8)
+- Add some more specific error classes ```Shipcloud::ClientError```,```Shipcloud::ServerError```,
+  ```Shipcloud::InvalidRequestError```, ```Shipcloud::TooManyRequests``` and ```Shipcloud::NotFoundError``` (#11).
+- Access to the entire response and error descriptions from the error object (#11).
+
+### Removed
+- Removed the following ruby versions from travis-ci test runs:
+  - jruby-9.0.0.0
+- Removed ```Shipcloud::APIError```  in preference to more granular error classes (#11).
+
+### Changed
+
+### Fixed
+
 ## [0.6.0] - 2016-01-21
 ### Added
 - This CHANGELOG file (Following "[Keep a CHANGELOG](http://keepachangelog.com/)")

data/README.md

@@ -4,6 +4,8 @@
 
 A Ruby wrapper for the shipcloud API
 
+We have dropped the support of jruby-9, because there is an issue with mixing hash and keyword arguments (https://github.com/jruby/jruby/issues/3138). When this issue is fixed, we will support jruby-9 again.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -20,27 +22,42 @@ Or install it yourself as:
 
 ## Usage
 
-Before using the shipcloud API, you need to set the API access key:
+Before using the shipcloud API, you may want to set the API access key.
 
-```
+```ruby
 Shipcloud.api_key = 'your-api-key-goes-here'
 ```
 
 Since Version 0.4.0, you can also do this via a configuration block, e.g. in an initializer:
 
-```
+```ruby
 Shipcloud.configure do |config|
   config.api_key = 'your-api-key-goes-here'
 end
 ```
 
+You can also pass the API key with each request:
+```ruby
+ Shipcloud::Shipment.create(
+   {
+     carrier: 'ups',
+     from: from-address-params,
+     to: to-address-params,
+     package: package-params,
+     create_shipping_label: true
+   },
+  api_key: "your-api-key"
+ )
+```
+If you pass in the ```api_key``` option, the value will be used as API key for the current request, even if you have set the ```Shipcloud.api_key``` before.
+
 You can sign up for a developer account at *[shipcloud.io](http://www.shipcloud.io)*
 
 ### Create a new shipment
 
 To create a new Shipment on the shipclod platform, you need to provide the name of the carrier, to- and from-address, and the package dimensions.
 For details, see *[shipcloud API documentation on Shipments](http://developers.shipcloud.io/reference/#shipments)*
-```
+```ruby
 Shipcloud::Shipment.create(
     carrier: 'ups',
     from: from-address-params,
@@ -52,7 +69,7 @@ Shipcloud::Shipment.create(
 
 `Shipment#create` will return shipping label and tracking information, encapsulated in a `Shipcloud::Shipment` object:
 
-```
+```ruby
 shipment = Shipcloud::Shipment.create(...) # parameters ommitted
 shipment.tracking_url # -> http://track.shipcloud.io/uzdgu22z3ed12
 ```

data/lib/shipcloud.rb

@@ -2,6 +2,7 @@ require "net/http"
 require "net/https"
 require "json"
 require "shipcloud/version"
+require "shipcloud/shipcloud_error"
 
 module Shipcloud
   API_VERSION = "v1"
@@ -12,8 +13,6 @@ module Shipcloud
     "User-Agent" => "shipcloud-ruby v#{Shipcloud::VERSION}, API #{Shipcloud::API_VERSION}, #{RUBY_VERSION}, #{RUBY_PLATFORM}, #{RUBY_PATCHLEVEL}"
   }
 
-  @@api_key = nil
-
   autoload :Base,           "shipcloud/base"
   autoload :Shipment,       "shipcloud/shipment"
   autoload :Carrier,        "shipcloud/carrier"
@@ -33,13 +32,8 @@ module Shipcloud
     autoload :Base,         "shipcloud/request/base"
     autoload :Connection,   "shipcloud/request/connection"
     autoload :Info,         "shipcloud/request/info"
-    autoload :Validator,    "shipcloud/request/validator"
   end
 
-  class ShipcloudError < StandardError; end
-  class AuthenticationError < ShipcloudError; end
-  class APIError            < ShipcloudError; end
-
   class << self
     attr_accessor :configuration
   end
@@ -75,7 +69,6 @@ module Shipcloud
   #
   # @param [String] api_key The api key
   def self.api_key=(api_key)
-    @@api_key = api_key
     configuration.api_key = api_key
   end
 
@@ -84,9 +77,12 @@ module Shipcloud
   # @param [Symbol] http_method The http method to use, must be one of :get, :post, :put and :delete
   # @param [String] api_url The API url to use
   # @param [Hash] data The data to send, e.g. used when creating new objects.
+  # @param [String] optional api_key The api key. If no api key is given, Shipcloud.api_key will
+  # be used for the request
   # @return [Array] The parsed JSON response.
-  def self.request(http_method, api_url, data)
-    info = Request::Info.new(http_method, api_url, data)
+  def self.request(http_method, api_url, data, api_key: nil)
+    api_key ||= Shipcloud.api_key
+    info = Request::Info.new(http_method, api_url, api_key, data)
     Request::Base.new(info).perform
   end
 end

data/lib/shipcloud/operations/all.rb

@@ -3,8 +3,12 @@ module Shipcloud
     module All
       module ClassMethods
         # Loads all Objects of the resource
-        def all(filter = {})
-          response = Shipcloud.request(:get, base_url, filter)
+        # @param [Hash] optional filter Filter the shipments list using one or more filter
+        # creteria
+        # @param [String] optional api_key The api key. If no api key is given, Shipcloud.api_key
+        # will be used for the request
+        def all(filter = {}, api_key: nil)
+          response = Shipcloud.request(:get, base_url, filter, api_key: api_key)
           if index_response_root
             response = response.fetch(index_response_root, [])
           end

data/lib/shipcloud/operations/create.rb

@@ -5,8 +5,10 @@ module Shipcloud
         # Creates a new object
         #
         # @param [Hash] attributes The attributes of the created object
-        def create(attributes)
-          response = Shipcloud.request(:post, base_url, attributes)
+        # @param \[String\] optional api_key The api key. If no api key is given, Shipcloud.api_key
+        # will be used for the request
+        def create(attributes, api_key: nil)
+          response = Shipcloud.request(:post, base_url, attributes, api_key: api_key)
           if create_response_root
             response = response.fetch(create_response_root, {})
           end

data/lib/shipcloud/operations/delete.rb

@@ -5,8 +5,10 @@ module Shipcloud
         # Deletes the given object
         #
         # @param [String] id The id of the object that gets deleted
-        def delete(id)
-          response = Shipcloud.request(:delete, "#{base_url}/#{id}", {})
+        # @param \[String\] optional api_key The api key. If no api key is given, Shipcloud.api_key
+        # will be used for the request
+        def delete(id, api_key: nil)
+          Shipcloud.request(:delete, "#{base_url}/#{id}", {}, api_key: api_key)
           true
         end
       end

data/lib/shipcloud/operations/find.rb

@@ -5,9 +5,11 @@ module Shipcloud
         # Finds a given object
         #
         # @param [String] id The id of the object that should be found
+        # @param \[String\] optional api_key The api key. If no api key is given, Shipcloud.api_key
+        # will be used for the request
         # @return [Shipcloud::Base] The found object
-        def find(id)
-          response = Shipcloud.request(:get, "#{base_url}/#{id}", {})
+        def find(id, api_key: nil)
+          response = Shipcloud.request(:get, "#{base_url}/#{id}", {}, api_key: api_key)
           self.new(response)
         end
       end

data/lib/shipcloud/operations/update.rb

@@ -6,8 +6,10 @@ module Shipcloud
         # Updates a object
         # @param [String] id The id of the object that should be updated
         # @param [Hash] attributes The attributes that should be updated
-        def update(id, attributes)
-          response = Shipcloud.request(:put, "#{base_url}/#{id}", attributes)
+        # @param \[String\] optional api_key The api key. If no api key is given, Shipcloud.api_key
+        # will be used for the request
+        def update(id, attributes, api_key: nil)
+          response = Shipcloud.request(:put, "#{base_url}/#{id}", attributes, api_key: api_key)
           self.new(response)
         end
       end
@@ -19,8 +21,10 @@ module Shipcloud
       # Updates a object
       #
       # @param [Hash] attributes The attributes that should be updated
-      def update(attributes)
-        response = Shipcloud.request(:put, "#{base_url}/#{id}", attributes)
+      # @param \[String\] optional api_key The api key. If no api key is given, Shipcloud.api_key
+      # will be used for the request
+      def update(attributes, api_key: nil)
+        response = Shipcloud.request(:put, "#{base_url}/#{id}", attributes, api_key: api_key)
         set_attributes(response)
       end
     end

data/lib/shipcloud/request/base.rb

@@ -2,32 +2,33 @@ module Shipcloud
   module Request
     class Base
       attr_reader :info
-      attr_accessor :response
 
       def initialize(info)
         @info = info
       end
 
       def perform
-        raise AuthenticationError if Shipcloud.api_key.nil?
+        raise AuthenticationError unless @info.api_key
         connection.setup_https
-        send_request
-        validator.validated_data_for(response)
+        response = connection.request
+        validate_response(response)
+        JSON.parse(response.body)
+      rescue JSON::ParserError
+        raise ShipcloudError.new(response)
       end
 
       protected
 
-      def send_request
-        self.response = connection.request
+      def validate_response(response)
+        error = ShipcloudError.from_response(response)
+        if error
+          raise error
+        end
       end
 
       def connection
         @connection ||= Connection.new(info)
       end
-
-      def validator
-        @validator ||= Validator.new(info)
-      end
     end
   end
 end

data/lib/shipcloud/request/connection.rb

@@ -38,7 +38,7 @@ module Shipcloud
                         else
                           Net::HTTP::Get.new(@info.path_with_params(@info.url, @info.data), API_HEADERS)
                         end
-        https_request.basic_auth(Shipcloud.api_key, "")
+        https_request.basic_auth(@info.api_key, "")
         https_request.body = @info.data.to_json if [:post, :put].include?(@info.http_method)
         https_request
       end

data/lib/shipcloud/request/info.rb

@@ -1,9 +1,10 @@
 module Shipcloud
   module Request
     class Info
-      attr_accessor :http_method, :api_url, :data
+      attr_accessor :http_method, :api_url, :api_key, :data
 
-      def initialize(http_method, api_url, data)
+      def initialize(http_method, api_url, api_key, data)
+        @api_key = api_key
         @http_method = http_method
         @api_url     = api_url
         @data        = data

data/lib/shipcloud/shipcloud_error.rb

@@ -0,0 +1,66 @@
+module Shipcloud
+  class ShipcloudError < StandardError
+    attr_reader :errors, :response
+
+    def initialize(response = nil)
+      @response = response
+      @errors = parse_errors
+      error_message = errors.empty? ? response_body : errors
+      super(error_message)
+    end
+
+    # Returns the appropriate Shipcloud::ShipcloudError subclass based
+    # on status code
+    #
+    # @param [HTTPResponse] response HTTP response
+    # @return [Shipcloud::ShipcloudError]
+    def self.from_response(response)
+      response_code = response.code.to_i
+      if error_class = error_class_for(response_code)
+        error_class.new(response)
+      end
+    end
+
+    def self.error_class_for(response_code)
+      case response_code
+      when 400, 422 then InvalidRequestError
+      when 401 then AuthenticationError
+      when 402 then TooManyRequests
+      when 404 then NotFoundError
+      when 400..499 then ClientError
+      when 500..599 then ServerError
+      end
+    end
+
+    private_class_method :error_class_for
+
+    private
+
+    def parse_errors
+      return [] unless response_body
+      data = JSON.parse(response_body)
+      if data.is_a?(Hash) && data["errors"]
+        data["errors"]
+      else
+        []
+      end
+    rescue JSON::ParserError
+      []
+    end
+
+    def response_body
+      return unless @response
+      @response.body
+    end
+  end
+
+  # Raised on errors in the 400-499 range
+  class ClientError < ShipcloudError; end
+  class AuthenticationError < ClientError; end
+  class InvalidRequestError < ClientError; end
+  class TooManyRequests < ClientError; end
+  class NotFoundError < ClientError; end
+
+  # Raised on errors in the 500-599 range
+  class ServerError < ShipcloudError; end
+end

data/lib/shipcloud/version.rb

@@ -1,3 +1,3 @@
 module Shipcloud
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

data/spec/shipcloud/address_spec.rb

@@ -35,31 +35,35 @@ describe Shipcloud::Address do
 
   describe '.create' do
     it 'makes a new POST request using the correct API endpoint' do
-      Shipcloud.should_receive(:request).with(:post, 'addresses', valid_attributes).and_return('data' => {})
+      expect(Shipcloud).to receive(:request).
+        with(:post, "addresses", valid_attributes, api_key: nil).and_return("data" => {})
+
       Shipcloud::Address.create(valid_attributes)
     end
   end
 
   describe '.find' do
     it 'makes a new GET request using the correct API endpoint to receive a specific address' do
-      Shipcloud.should_receive(:request).with(
-        :get, 'addresses/123', {}).and_return('id' => '123')
-      Shipcloud::Address.find('123')
+      expect(Shipcloud).to receive(:request).with(
+        :get, "addresses/123", {}, api_key: nil).and_return("id" => "123")
+
+      Shipcloud::Address.find("123")
     end
   end
 
   describe '.update' do
     it 'makes a new PUT request using the correct API endpoint' do
-      Shipcloud.should_receive(:request).with(
-        :put, 'addresses/123', {:street => 'Mittelweg' }).and_return('data' => {})
-      Shipcloud::Address.update('123', {:street => 'Mittelweg' })
+      expect(Shipcloud).to receive(:request).with(
+        :put, "addresses/123", { street: "Mittelweg" }, api_key: nil).and_return("data" => {})
+
+      Shipcloud::Address.update("123", street: "Mittelweg")
     end
   end
 
   describe '.all' do
     it 'makes a new Get request using the correct API endpoint' do
       expect(Shipcloud).to receive(:request).
-        with(:get, 'addresses', {}).and_return([])
+        with(:get, "addresses", {}, api_key: nil).and_return([])
 
       Shipcloud::Address.all
     end
@@ -77,38 +81,38 @@ describe Shipcloud::Address do
 
   def stub_addresses_request
     allow(Shipcloud).to receive(:request).
-      with(:get, 'addresses', {}).
-        and_return(
-          [
-            {
-              'id' => '1c81efb7-9b95-4dd8-92e3-cac1bca3df6f',
-              'company' => '',
-              'first_name' => 'Max',
-              'last_name' => 'Mustermann',
-              'care_of' => '',
-              'street' => 'Musterstraße',
-              'street_no' => '42',
-              'zip_code' => '12345',
-              'city' => 'Musterstadt',
-              'state' => '',
-              'country' => 'DE',
-              'phone' => ''
-            },
-            {
-              'id' => '7ea2a290-b456-4ecf-9010-e82b3da298f0',
-              'company' => 'Muster-Company',
-              'first_name' => 'Max',
-              'last_name' => 'Mustermann',
-              'care_of' => '',
-              'street' => 'Musterstraße',
-              'street_no' => '42',
-              'zip_code' => '54321',
-              'city' => 'Musterstadt',
-              'state' => '',
-              'country' => 'DE',
-              'phone' => ''
-            }
-          ]
-        )
+      with(:get, "addresses", {}, api_key: nil).
+      and_return(
+        [
+          {
+            "id" => "1c81efb7-9b95-4dd8-92e3-cac1bca3df6f",
+            "company" => "",
+            "first_name" => "Max",
+            "last_name" => "Mustermann",
+            "care_of" => "",
+            "street" => "Musterstraße",
+            "street_no" => "42",
+            "zip_code" => "12345",
+            "city" => "Musterstadt",
+            "state" => "",
+            "country" => "DE",
+            "phone" => ""
+          },
+          {
+            "id" => "7ea2a290-b456-4ecf-9010-e82b3da298f0",
+            "company" => "Muster-Company",
+            "first_name" => "Max",
+            "last_name" => "Mustermann",
+            "care_of" => "",
+            "street" => "Musterstraße",
+            "street_no" => "42",
+            "zip_code" => "54321",
+            "city" => "Musterstadt",
+            "state" => "",
+            "country" => "DE",
+            "phone" => ""
+          }
+        ]
+      )
   end
 end

data/spec/shipcloud/carrier_spec.rb

@@ -24,7 +24,7 @@ describe Shipcloud::Carrier do
   describe '.all' do
     it 'makes a new Get request using the correct API endpoint' do
       expect(Shipcloud).to receive(:request).
-        with(:get, 'carriers', {}).and_return([])
+        with(:get, "carriers", {}, api_key: nil).and_return([])
 
       Shipcloud::Carrier.all
     end
@@ -69,9 +69,9 @@ describe Shipcloud::Carrier do
   end
 
   def stub_carriers_request
-    allow(Shipcloud).to receive(:request)
-      .with(:get, 'carriers', {})
-      .and_return(
+    allow(Shipcloud).to receive(:request).
+      with(:get, "carriers", {}, api_key: nil).
+      and_return(
         [
           {
             'name' => 'carrier_1',

data/spec/shipcloud/request/base_spec.rb

@@ -3,25 +3,61 @@ require "spec_helper"
 describe Shipcloud::Request::Base do
   context "#perform" do
     it "checks for an api key" do
-      Shipcloud.stub(:api_key).and_return(nil)
+      info = Shipcloud::Request::Info.new(:get, "shipments", nil, {})
 
       expect{
-        Shipcloud::Request::Base.new(nil).perform
+        Shipcloud::Request::Base.new(info).perform
       }.to raise_error Shipcloud::AuthenticationError
     end
 
-    it "performs an https request" do
-      Shipcloud.stub(:api_key).and_return("some key")
-      connection = stub
-      validator = stub
-      Shipcloud::Request::Connection.stub(:new).and_return(connection)
-      Shipcloud::Request::Validator.stub(:new).and_return(validator)
+    it "performs an https request and returns a response hash" do
+      connection = double
+      expect(Shipcloud::Request::Connection).to receive(:new).and_return(connection)
+      expect(connection).to receive(:setup_https)
+      response = double(code: "200", body: { id: 1 }.to_json)
+      expect(connection).to receive(:request).and_return(response)
+      info = Shipcloud::Request::Info.new(:get, "shipments", "api_key", {})
 
-      connection.should_receive(:setup_https)
-      connection.should_receive(:request)
-      validator.should_receive(:validated_data_for)
+      data = Shipcloud::Request::Base.new(info).perform
 
-      Shipcloud::Request::Base.new(nil).perform
+      expect(data).to eq("id" => 1)
+    end
+
+    it "performs an https request and raises an Shipcloud::ClientError if the response "\
+       "has a 400 status code" do
+      connection = double
+      expect(Shipcloud::Request::Connection).to receive(:new).and_return(connection)
+      expect(connection).to receive(:setup_https)
+      response = double(code: "400", body: { id: 1 }.to_json)
+      expect(connection).to receive(:request).and_return(response)
+      info = Shipcloud::Request::Info.new(:get, "shipments", "api_key", {})
+
+      expect { Shipcloud::Request::Base.new(info).perform }.to raise_error(Shipcloud::ClientError)
+    end
+
+    it "performs an https request and raises an Shipcloud::ServerError if the response "\
+       "has a 500 status code" do
+      connection = double
+      expect(Shipcloud::Request::Connection).to receive(:new).and_return(connection)
+      expect(connection).to receive(:setup_https)
+      response = double(code: "500", body: { id: 1 }.to_json)
+      expect(connection).to receive(:request).and_return(response)
+      info = Shipcloud::Request::Info.new(:get, "shipments", "api_key", {})
+
+      expect { Shipcloud::Request::Base.new(info).perform }.to raise_error(Shipcloud::ServerError)
+    end
+
+    it "performs an https request and raises an Shipcloud::ShipcloudError if the body of the "\
+       "response is not in JSON" do
+      connection = double
+      expect(Shipcloud::Request::Connection).to receive(:new).and_return(connection)
+      expect(connection).to receive(:setup_https)
+      response = double(code: "200", body: "no json")
+      expect(connection).to receive(:request).and_return(response)
+      info = Shipcloud::Request::Info.new(:get, "shipments", "api_key", {})
+
+      expect { Shipcloud::Request::Base.new(info).perform }.
+        to raise_error(Shipcloud::ShipcloudError)
     end
   end
-end
+end

data/spec/shipcloud/shipcloud_error_spec.rb

@@ -0,0 +1,125 @@
+require "spec_helper"
+
+describe Shipcloud::ShipcloudError do
+  describe ".from_response" do
+    context "with a response with status code 400" do
+      it "returns a Shipcloud::InvalidRequestError" do
+        expect(Shipcloud::ShipcloudError.from_response(build_response(status_code: 400))).to be_a(
+          Shipcloud::InvalidRequestError
+        )
+      end
+    end
+
+    context "with a response with status code 422" do
+      it "returns a Shipcloud::InvalidRequestError" do
+        expect(Shipcloud::ShipcloudError.from_response(build_response(status_code: 422))).to be_a(
+          Shipcloud::InvalidRequestError
+        )
+      end
+    end
+
+    context "with a response with status code 401" do
+      it "returns a Shipcloud::AuthenticationError" do
+        expect(Shipcloud::ShipcloudError.from_response(build_response(status_code: 401))).to be_a(
+          Shipcloud::AuthenticationError
+        )
+      end
+    end
+
+    context "with a response with status code 402" do
+      it "returns a Shipcloud::TooManyRequests" do
+        expect(Shipcloud::ShipcloudError.from_response(build_response(status_code: 402))).to be_a(
+          Shipcloud::TooManyRequests
+        )
+      end
+    end
+
+    context "with a response with status code 404" do
+      it "returns a Shipcloud::NotFoundError" do
+        expect(Shipcloud::ShipcloudError.from_response(build_response(status_code: 404))).to be_a(
+          Shipcloud::NotFoundError
+        )
+      end
+    end
+
+    context "with a response with a 4xx status code" do
+      it "returns a Shipcloud::ClientError" do
+        expect(Shipcloud::ShipcloudError.from_response(build_response(status_code: 400))).to be_a(
+          Shipcloud::ClientError
+        )
+      end
+    end
+
+    context "with a response with a 5xx status code" do
+      it "returns a Shipcloud::ClientError" do
+        expect(Shipcloud::ShipcloudError.from_response(build_response(status_code: 500))).to be_a(
+          Shipcloud::ServerError
+        )
+      end
+    end
+
+    context "with a 200 response" do
+      it "returns nil" do
+        expect(Shipcloud::ShipcloudError.from_response(build_response(status_code: 200))).to be_nil
+      end
+    end
+  end
+
+  describe "#message" do
+    context "with an errors node in the response body" do
+      it "returns the errors formated as one string" do
+        errors = ["error 1", "error 2"]
+        response = build_response(body: { errors: errors }.to_json)
+        error = Shipcloud::ShipcloudError.new(response)
+
+        expect(error.message).to eq '["error 1", "error 2"]'
+      end
+    end
+    context "without an errors node in the response body" do
+      it "returns the body of the response" do
+        error = Shipcloud::ShipcloudError.new(build_response(body: "test"))
+
+        expect(error.message).to eq "test"
+      end
+    end
+  end
+
+  describe "#errors" do
+    it "returns the errors node of the response" do
+      errors = ["error 1", "error 2"]
+      response = build_response(body: { errors: errors }.to_json)
+      error = Shipcloud::ShipcloudError.new(response)
+
+      expect(error.errors).to eq errors
+    end
+    context "with a response that has no errors node" do
+      it "returns an empty list" do
+        response = build_response(body: {}.to_json)
+        error = Shipcloud::ShipcloudError.new(response)
+
+        expect(error.errors).to eq []
+      end
+    end
+    context "with a response that has no JSON formated body" do
+      it "returns an empty list" do
+        response = build_response(body: "error")
+        error = Shipcloud::ShipcloudError.new(response)
+
+        expect(error.errors).to eq []
+      end
+    end
+  end
+
+  describe "#response" do
+    it "returns the response" do
+      response = build_response
+      error = Shipcloud::ShipcloudError.new(response)
+
+      expect(error.response).to eq response
+    end
+  end
+
+  def build_response(status_code: 400, body: nil)
+    double(code: status_code.to_s, body: body)
+  end
+end

data/spec/shipcloud/shipment_quote_spec.rb

@@ -52,7 +52,7 @@ describe Shipcloud::ShipmentQuote do
   describe ".create" do
     it "makes a new POST request using the correct API endpoint" do
       expect(Shipcloud).to receive(:request).
-        with(:post, "shipment_quotes", valid_attributes).
+        with(:post, "shipment_quotes", valid_attributes, api_key: nil).
         and_return("data" => {})
 
       Shipcloud::ShipmentQuote.create(valid_attributes)

data/spec/shipcloud/shipment_spec.rb

@@ -47,28 +47,32 @@ describe Shipcloud::Shipment do
 
   describe ".create" do
     it "makes a new POST request using the correct API endpoint" do
-      Shipcloud.should_receive(:request).with(:post, "shipments", valid_attributes).and_return("data" => {})
+      expect(Shipcloud).to receive(:request).
+        with(:post, "shipments", valid_attributes, api_key: nil).and_return("data" => {})
       Shipcloud::Shipment.create(valid_attributes)
     end
   end
 
   describe ".find" do
     it "makes a new GET request using the correct API endpoint to receive a specific subscription" do
-      Shipcloud.should_receive(:request).with(:get, "shipments/123", {}).and_return("id" => "123")
+      expect(Shipcloud).to receive(:request).with(:get, "shipments/123", {}, api_key: nil).
+        and_return("id" => "123")
       Shipcloud::Shipment.find("123")
     end
   end
 
   describe ".update" do
     it "makes a new PUT request using the correct API endpoint" do
-      Shipcloud.should_receive(:request).with(:put, "shipments/123", {:carrier => 'ups' }).and_return("data" => {})
-      Shipcloud::Shipment.update("123", {:carrier => 'ups' })
+      expect(Shipcloud).to receive(:request).
+        with(:put, "shipments/123", { carrier: "ups" }, api_key: nil).and_return("data" => {})
+      Shipcloud::Shipment.update("123", carrier: "ups")
     end
   end
 
   describe ".delete" do
     it "makes a new DELETE request using the correct API endpoint" do
-      Shipcloud.should_receive(:request).with(:delete, "shipments/123", {}).and_return(true)
+      expect(Shipcloud).to receive(:request).with(:delete, "shipments/123", {}, api_key: nil).
+        and_return(true)
       Shipcloud::Shipment.delete("123")
     end
   end
@@ -76,7 +80,7 @@ describe Shipcloud::Shipment do
   describe ".all" do
     it "makes a new Get request using the correct API endpoint" do
       expect(Shipcloud).to receive(:request).
-        with(:get, "shipments", {}).
+        with(:get, "shipments", {}, api_key: nil).
         and_return("shipments" => [])
 
       Shipcloud::Shipment.all
@@ -104,7 +108,7 @@ describe Shipcloud::Shipment do
       }
 
       expect(Shipcloud).to receive(:request).
-        with(:get, "shipments", filter).
+        with(:get, "shipments", filter, api_key: nil).
         and_return("shipments" => shipments_array)
 
       Shipcloud::Shipment.all(filter)
@@ -113,7 +117,7 @@ describe Shipcloud::Shipment do
 
   def stub_shipments_requests
     allow(Shipcloud).to receive(:request).
-      with(:get, "shipments", {}).
+      with(:get, "shipments", {}, api_key: nil).
       and_return("shipments" => shipments_array)
   end
 

data/spec/shipcloud/webhooks_spec.rb

@@ -16,8 +16,8 @@ describe Shipcloud::Webhook do
 
   describe ".create" do
     it "makes a new POST request using the correct API endpoint" do
-      Shipcloud.should_receive(:request).
-        with(:post, "webhooks", valid_attributes).
+      expect(Shipcloud).to receive(:request).
+        with(:post, "webhooks", valid_attributes, api_key: nil).
         and_return("data" => {})
       Shipcloud::Webhook.create(valid_attributes)
     end
@@ -25,7 +25,9 @@ describe Shipcloud::Webhook do
 
   describe ".find" do
     it "makes a new GET request using the correct API endpoint to receive a specific webhook" do
-      Shipcloud.should_receive(:request).with(:get, "webhooks/123", {}).and_return("id" => "123")
+      expect(Shipcloud).to receive(:request).
+        with(:get, "webhooks/123", {}, api_key: nil).
+        and_return("id" => "123")
       Shipcloud::Webhook.find("123")
     end
   end
@@ -33,7 +35,7 @@ describe Shipcloud::Webhook do
   describe ".all" do
     it "makes a new Get request using the correct API endpoint" do
       expect(Shipcloud).to receive(:request).
-        with(:get, "webhooks", {}).
+        with(:get, "webhooks", {}, api_key: nil).
         and_return("webhooks" => [])
 
       Shipcloud::Webhook.all
@@ -52,7 +54,7 @@ describe Shipcloud::Webhook do
 
   def stub_webhooks_request
     allow(Shipcloud).to receive(:request).
-      with(:get, "webhooks", {}).
+      with(:get, "webhooks", {}, api_key: nil).
       and_return("webhooks" => webhooks_array)
   end
 

data/spec/shipcloud_spec.rb

@@ -29,6 +29,20 @@ describe Shipcloud do
         WebMock.should have_requested(:get, "https://#{Shipcloud::api_key}:@#{Shipcloud.configuration.api_base}/#{Shipcloud::API_VERSION}/transactions")
       end
     end
+
+    context "with an api key passed in as an argument" do
+      it "uses the given api key instead of the global one" do
+        WebMock.stub_request(:any, /#{Shipcloud.configuration.api_base}/).to_return(body: "{}")
+        Shipcloud.api_key = "global-api-key"
+
+        Shipcloud.request(:get, "transactions", {}, api_key: "123")
+
+        expect(WebMock).to have_requested(
+          :get,
+          "https://123:@#{Shipcloud.configuration.api_base}/#{Shipcloud::API_VERSION}/transactions"
+        )
+      end
+    end
   end
 
   describe '.configure' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shipcloud
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - sthollmann
@@ -151,7 +151,7 @@ files:
 - lib/shipcloud/request/base.rb
 - lib/shipcloud/request/connection.rb
 - lib/shipcloud/request/info.rb
-- lib/shipcloud/request/validator.rb
+- lib/shipcloud/shipcloud_error.rb
 - lib/shipcloud/shipment.rb
 - lib/shipcloud/shipment_quote.rb
 - lib/shipcloud/version.rb
@@ -161,7 +161,7 @@ files:
 - spec/shipcloud/carrier_spec.rb
 - spec/shipcloud/request/base_spec.rb
 - spec/shipcloud/request/connection_spec.rb
-- spec/shipcloud/request/validator_spec.rb
+- spec/shipcloud/shipcloud_error_spec.rb
 - spec/shipcloud/shipment_quote_spec.rb
 - spec/shipcloud/shipment_spec.rb
 - spec/shipcloud/webhooks_spec.rb
@@ -196,7 +196,7 @@ test_files:
 - spec/shipcloud/carrier_spec.rb
 - spec/shipcloud/request/base_spec.rb
 - spec/shipcloud/request/connection_spec.rb
-- spec/shipcloud/request/validator_spec.rb
+- spec/shipcloud/shipcloud_error_spec.rb
 - spec/shipcloud/shipment_quote_spec.rb
 - spec/shipcloud/shipment_spec.rb
 - spec/shipcloud/webhooks_spec.rb

data/lib/shipcloud/request/validator.rb

@@ -1,33 +0,0 @@
-module Shipcloud
-  module Request
-    class Validator
-      attr_reader :info
-      attr_accessor :response
-
-      def initialize(info)
-        @info = info
-      end
-
-      def validated_data_for(incoming_response)
-        self.response = incoming_response
-        verify_response_code
-        if response.body
-          info.data = JSON.parse(response.body)
-          validate_response_data
-        end
-        info.data
-      end
-
-      protected
-
-      def verify_response_code
-        raise AuthenticationError if response.code.to_i == 401
-        raise APIError if response.code.to_i >= 500
-      end
-
-      def validate_response_data
-        raise APIError.new(info.data["errors"]) if info.data.is_a?(Hash) && info.data["errors"]
-      end
-    end
-  end
-end

data/spec/shipcloud/request/validator_spec.rb

@@ -1,24 +0,0 @@
-require "spec_helper"
-
-describe Shipcloud::Request::Validator do
-  describe "#validated_data_for" do
-    it "validates the data" do
-      info = Shipcloud::Request::Info.new(:get, "random", OpenStruct.new(id: 1))
-      validator = Shipcloud::Request::Validator.new info
-      response = OpenStruct.new(body: '{"response":"ok"}', code: 200)
-
-      validator.validated_data_for(response).should eq "response" => "ok"
-    end
-
-    it 'raises an APIError if the response contains errors' do
-      info = Shipcloud::Request::Info.new(:get, 'random', {})
-      validator = Shipcloud::Request::Validator.new info
-      response = OpenStruct.new(body: '{"errors":["some error"]}', code: 200)
-
-      expect { validator.validated_data_for(response) }.to raise_error(
-        Shipcloud::APIError,
-        ['some error'].to_s
-      )
-    end
-  end
-end