shipcloud 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b38e4cfb0f461ac7d56789bd8da7509f34ccc79a4d676c953e75569a9c4806d2
-  data.tar.gz: defc12ded3f435dd7ac09ca390d480213fe11bdc17ac8b28861364afbd3cc1da
+  metadata.gz: 5f3bf2ce4eed19aeb58efbeb8f94eec7e530564c8a576ef027a7c6d86f6e0317
+  data.tar.gz: e8c7ee9e7f832462d45889310890b38919d0edbde40c06d6c6837aafe0fc4d56
 SHA512:
-  metadata.gz: 21265a7e3ee0ca03e467eb28034bb20092fc04ea24a29646717afaf1caef4a14b0a19460a60fe0197143c1b43f835e099e53d148bc41cf53685277c7007ad7ae
-  data.tar.gz: 676ae0f2669f1864cc0187800501805ac0494624a3d226822efb9fef27a3c64318b57a8a3aeca52dc7d05950c90a0366b7b5eaf2070336bb8c9ac66d45645386
+  metadata.gz: e488aa7992b5fd65a6b267d29e9b638d3256f453b16236e99195a85dd17fd5437ca5c03ec81a2ad0332ae593f8fb816da889d3dddcffbe7807fcdec2336c178c
+  data.tar.gz: 840df4369680ec64f38cbaeb5e5df4c223f641d7b1145a74fafba5f8ee40e6b6713d99599dd881781550690482a50debe1535c2edde3342d8ec9af3c8e7c35d0

data/.codeclimate.yml

@@ -12,6 +12,7 @@ engines:
     enabled: true
   rubocop:
     enabled: true
+    channel: rubocop-0-71
 ratings:
   paths:
   - "**.inc"

data/.rubocop.yml

@@ -1,7 +1,10 @@
+require: rubocop-performance
+
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 2.6
   Exclude:
     - vendor/**/*
+    - bin/*
 
 Naming/AccessorMethodName:
   Description: Check the naming of accessor methods for get_/set_.
@@ -39,6 +42,11 @@ Naming/PredicateName:
   Exclude:
     - spec/**/*
 
+Naming/RescuedExceptionsVariableName:
+  Description: 'Use consistent rescued exceptions variables naming.'
+  Enabled: true
+  PreferredName: error
+
 Style/Alias:
   Description: 'Use alias_method instead of alias.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#alias-method'
@@ -133,7 +141,7 @@ Style/EvenOdd:
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#predicate-methods'
   Enabled: false
 
-Style/FlipFlop:
+Lint/FlipFlop:
   Description: 'Checks for flip flops'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-flip-flops'
   Enabled: false
@@ -266,6 +274,13 @@ Style/RegexpLiteral:
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#percent-r'
   Enabled: false
 
+Style/Sample:
+  Description: >-
+                  Use `sample` instead of `shuffle.first`,
+                  `shuffle.last`, and `shuffle[Fixnum]`.
+  Reference: 'https://github.com/JuanitoFatas/fast-ruby#arrayshufflefirst-vs-arraysample-code'
+  Enabled: false
+
 Style/SelfAssignment:
   Description: >-
                  Checks for places where self-assignment shorthand should have
@@ -626,13 +641,6 @@ Performance/ReverseEach:
   Reference: 'https://github.com/JuanitoFatas/fast-ruby#enumerablereverseeach-vs-enumerablereverse_each-code'
   Enabled: false
 
-Performance/Sample:
-  Description: >-
-                  Use `sample` instead of `shuffle.first`,
-                  `shuffle.last`, and `shuffle[Fixnum]`.
-  Reference: 'https://github.com/JuanitoFatas/fast-ruby#arrayshufflefirst-vs-arraysample-code'
-  Enabled: false
-
 Performance/Size:
   Description: >-
                   Use `size` instead of `count` for counting

data/.ruby-version

@@ -1 +1 @@
-2.5.3
+2.6.3

data/.travis.yml

@@ -2,7 +2,6 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 2.2
   - 2.3
   - 2.4
   - 2.5

data/CHANGELOG.md

@@ -11,6 +11,13 @@
 
 ### Security
 
+## [0.10.0] - 2019-08-07
+### Added
+- Add the possibility to specify custom affiliate_id on every request
+
+### Removed
+- Removed support for ruby < 2.3. Target ruby version is 2.6
+
 ## [0.9.0] - 2019-01-09
 ### Added
 - Add attr_reader for `id` to class `Shipcloud::Address` to be able to get the id of a created address

data/bin/rubocop

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rubocop", "rubocop")

data/lib/shipcloud.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "net/http"
 require "net/https"
 require "json"
@@ -10,10 +11,11 @@ module Shipcloud
 
   API_HEADERS = {
     "Content-Type" => "application/json",
-    "User-Agent" => "shipcloud-ruby v#{Shipcloud::VERSION}, API #{Shipcloud::API_VERSION}, #{RUBY_VERSION}, #{RUBY_PLATFORM}, #{RUBY_PATCHLEVEL}"
-  }
+    "User-Agent" => "shipcloud-ruby v#{Shipcloud::VERSION}, API #{Shipcloud::API_VERSION}, " \
+      "#{RUBY_VERSION}, #{RUBY_PLATFORM}, #{RUBY_PATCHLEVEL}",
+  }.freeze
 
-  DEFAULT_AFFILIATE_ID = "integration.shipcloud-ruby-gem.v#{Shipcloud::VERSION}".freeze
+  DEFAULT_AFFILIATE_ID = "integration.shipcloud-ruby-gem.v#{Shipcloud::VERSION}"
 
   autoload :Base,           "shipcloud/base"
   autoload :Shipment,       "shipcloud/shipment"
@@ -39,12 +41,14 @@ module Shipcloud
   end
 
   class << self
-    attr_accessor :configuration
+    attr_writer :configuration
   end
 
+  # rubocop:disable Naming/MemoizedInstanceVariableName
   def self.configuration
     @configuration ||= Configuration.new
   end
+  # rubocop:enable Naming/MemoizedInstanceVariableName
 
   def self.configure
     yield(configuration)
@@ -52,7 +56,7 @@ module Shipcloud
 
   def self.api_headers
     API_HEADERS.merge(
-      "Affiliate-ID" => configuration.affiliate_id || DEFAULT_AFFILIATE_ID
+      "Affiliate-ID" => affiliate_id,
     )
   end
 
@@ -61,7 +65,7 @@ module Shipcloud
 
     def initialize
       @api_key = nil
-      @api_base = 'api.shipcloud.io'
+      @api_base = "api.shipcloud.io"
       @use_ssl = true
       @debug = false
     end
@@ -81,6 +85,10 @@ module Shipcloud
     configuration.api_key = api_key
   end
 
+  def self.affiliate_id
+    configuration.affiliate_id || DEFAULT_AFFILIATE_ID
+  end
+
   # Makes a request against the shipcloud API
   #
   # @param [Symbol] http_method The http method to use, must be one of :get, :post, :put and :delete
@@ -89,9 +97,10 @@ module Shipcloud
   # @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, api_key: nil)
+  def self.request(http_method, api_url, data, api_key: nil, affiliate_id: nil)
     api_key ||= Shipcloud.api_key
-    info = Request::Info.new(http_method, api_url, api_key, data)
+    affiliate_id ||= Shipcloud.affiliate_id
+    info = Request::Info.new(http_method, api_url, api_key, data, affiliate_id)
     Request::Base.new(info).perform
   end
 end

data/lib/shipcloud/operations/all.rb

@@ -7,8 +7,14 @@ module Shipcloud
         # 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)
+        def all(filter = {}, api_key: nil, affiliate_id: nil)
+          response = Shipcloud.request(
+            :get,
+            base_url,
+            filter,
+            api_key: api_key,
+            affiliate_id: affiliate_id,
+          )
           if index_response_root
             response = response.fetch(index_response_root, [])
           end

data/lib/shipcloud/operations/create.rb

@@ -7,8 +7,14 @@ module Shipcloud
         # @param [Hash] attributes The attributes of the created object
         # @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)
+        def create(attributes, api_key: nil, affiliate_id: nil)
+          response = Shipcloud.request(
+            :post,
+            base_url,
+            attributes,
+            api_key: api_key,
+            affiliate_id: affiliate_id,
+          )
           if create_response_root
             response = response.fetch(create_response_root, {})
           end

data/lib/shipcloud/operations/delete.rb

@@ -7,8 +7,14 @@ module Shipcloud
         # @param [String] id The id of the object that gets deleted
         # @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)
+        def delete(id, api_key: nil, affiliate_id: nil)
+          Shipcloud.request(
+            :delete,
+            "#{base_url}/#{id}",
+            {},
+            api_key: api_key,
+            affiliate_id: affiliate_id,
+          )
           true
         end
       end

data/lib/shipcloud/operations/find.rb

@@ -8,8 +8,14 @@ module Shipcloud
         # @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, api_key: nil)
-          response = Shipcloud.request(:get, "#{base_url}/#{id}", {}, api_key: api_key)
+        def find(id, api_key: nil, affiliate_id: nil)
+          response = Shipcloud.request(
+            :get,
+            "#{base_url}/#{id}",
+            {},
+            api_key: api_key,
+            affiliate_id: affiliate_id,
+          )
           self.new(response)
         end
       end

data/lib/shipcloud/operations/update.rb

@@ -8,8 +8,10 @@ module Shipcloud
         # @param [Hash] attributes The attributes that should be updated
         # @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)
+        def update(id, attributes, api_key: nil, affiliate_id: nil)
+          response = Shipcloud.request(
+            :put, "#{base_url}/#{id}", attributes, api_key: api_key, affiliate_id: affiliate_id
+          )
           self.new(response)
         end
       end
@@ -23,8 +25,10 @@ module Shipcloud
       # @param [Hash] attributes The attributes that should be updated
       # @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)
+      def update(attributes, api_key: nil, affiliate_id: nil)
+        response = Shipcloud.request(
+          :put, "#{base_url}/#{id}", attributes, api_key: api_key, affiliate_id: affiliate_id
+        )
         set_attributes(response)
       end
     end

data/lib/shipcloud/request/base.rb

@@ -9,6 +9,7 @@ module Shipcloud
 
       def perform
         raise AuthenticationError unless @info.api_key
+
         connection.setup_https
         response = connection.request
         validate_response(response)
@@ -26,9 +27,11 @@ module Shipcloud
         end
       end
 
+      # rubocop:disable Naming/MemoizedInstanceVariableName
       def connection
         @connection ||= Connection.new(info)
       end
+      # rubocop:enable Naming/MemoizedInstanceVariableName
     end
   end
 end

data/lib/shipcloud/request/connection.rb

@@ -20,7 +20,7 @@ module Shipcloud
       end
 
       def request
-        https.start do |connection|
+        https.start do
           https.request(https_request)
         end
       end
@@ -28,18 +28,19 @@ module Shipcloud
       protected
 
       def https_request
+        headers = Shipcloud.api_headers.merge("Affiliate-ID" => @info.affiliate_id)
         https_request =
           case @info.http_method
           when :post
-            Net::HTTP::Post.new(@info.url, Shipcloud.api_headers)
+            Net::HTTP::Post.new(@info.url, headers)
           when :put
-            Net::HTTP::Put.new(@info.url, Shipcloud.api_headers)
+            Net::HTTP::Put.new(@info.url, headers)
           when :delete
-            Net::HTTP::Delete.new(@info.url, Shipcloud.api_headers)
+            Net::HTTP::Delete.new(@info.url, headers)
           else
             Net::HTTP::Get.new(
               @info.path_with_params(@info.url, @info.data),
-              Shipcloud.api_headers,
+              headers,
             )
           end
 

data/lib/shipcloud/request/info.rb

@@ -1,13 +1,14 @@
 module Shipcloud
   module Request
     class Info
-      attr_accessor :http_method, :api_url, :api_key, :data
+      attr_accessor :http_method, :api_url, :api_key, :data, :affiliate_id
 
-      def initialize(http_method, api_url, api_key, data)
-        @api_key = api_key
-        @http_method = http_method
-        @api_url     = api_url
-        @data        = data
+      def initialize(http_method, api_url, api_key, data, affiliate_id)
+        @api_key      = api_key
+        @http_method  = http_method
+        @api_url      = api_url
+        @data         = data
+        @affiliate_id = affiliate_id
       end
 
       def url

data/lib/shipcloud/shipcloud_error.rb

@@ -39,6 +39,7 @@ module Shipcloud
 
     def parse_errors
       return [] unless response_body
+
       data = JSON.parse(response_body)
       if data.is_a?(Hash) && data["errors"]
         data["errors"]
@@ -51,6 +52,7 @@ module Shipcloud
 
     def response_body
       return unless @response
+
       @response.body
     end
   end

data/lib/shipcloud/version.rb

@@ -1,3 +1,3 @@
 module Shipcloud
-  VERSION = "0.9.0".freeze
+  VERSION = "0.10.0".freeze
 end

data/shipcloud.gemspec

@@ -1,5 +1,5 @@
 # coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "shipcloud/version"
 
@@ -19,12 +19,14 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = ">= 2.0"
+  spec.required_ruby_version = ">= 2.3"
 
   spec.add_runtime_dependency "json", ">= 1.8.0"
+  spec.add_development_dependency "pry", "~> 0.10"
   spec.add_development_dependency "rake", "~> 12.0"
   spec.add_development_dependency "rspec", "~> 3.6"
-  spec.add_development_dependency "webmock", "~> 3.0"
-  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "rubocop", "~> 0.71.0"
+  spec.add_development_dependency "rubocop-performance"
   spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "webmock", "~> 3.0"
 end

data/spec/shipcloud/address_spec.rb

@@ -36,44 +36,72 @@ describe Shipcloud::Address do
   describe '.create' do
     it 'makes a new POST request using the correct API endpoint' do
       expect(Shipcloud).to receive(:request).
-        with(:post, "addresses", valid_attributes, api_key: nil).and_return("data" => {})
+        with(:post, "addresses", valid_attributes, api_key: nil, affiliate_id: nil).
+        and_return("data" => {})
 
       Shipcloud::Address.create(valid_attributes)
     end
 
     it "returns an address containing an id" do
       expect(Shipcloud).to receive(:request).
-        with(:post, "addresses", valid_attributes, api_key: nil).
+        with(:post, "addresses", valid_attributes, api_key: nil, affiliate_id: nil).
         and_return(returned_address)
 
       address = Shipcloud::Address.create(valid_attributes)
 
       expect(address.id).to eq("1c81efb7-9b95-4dd8-92e3-cac1bca3df6f")
     end
+
+    it "use the affiliate ID provided for the request" do
+      expect(Shipcloud).to receive(:request).
+        with(:post, "addresses", valid_attributes, api_key: nil, affiliate_id: "affiliate_id").
+        and_return(returned_address)
+
+      address = Shipcloud::Address.create(valid_attributes, affiliate_id: "affiliate_id")
+
+      expect(address.id).to eq("1c81efb7-9b95-4dd8-92e3-cac1bca3df6f")
+    end
   end
 
   describe '.find' do
     it 'makes a new GET request using the correct API endpoint to receive a specific address' do
       expect(Shipcloud).to receive(:request).with(
-        :get, "addresses/123", {}, api_key: nil).and_return("id" => "123")
+        :get, "addresses/123", {}, api_key: nil, affiliate_id: nil).and_return("id" => "123")
 
       Shipcloud::Address.find("123")
     end
+
+    it "use the affiliate ID provided for the request" do
+      expect(Shipcloud).to receive(:request).with(
+        :get, "addresses/123", {}, api_key: nil, affiliate_id: "affiliate_id"
+      ).and_return("id" => "123")
+
+      Shipcloud::Address.find("123", affiliate_id: "affiliate_id")
+    end
   end
 
   describe '.update' do
     it 'makes a new PUT request using the correct API endpoint' do
       expect(Shipcloud).to receive(:request).with(
-        :put, "addresses/123", { street: "Mittelweg" }, api_key: nil).and_return("data" => {})
+        :put, "addresses/123", { street: "Mittelweg" }, api_key: nil, affiliate_id: nil
+      ).and_return("data" => {})
 
       Shipcloud::Address.update("123", street: "Mittelweg")
     end
+
+    it "use the affiliate ID provided for the request" do
+      expect(Shipcloud).to receive(:request).with(
+        :put, "addresses/123", { street: "Mittelweg" }, api_key: nil, affiliate_id: "affiliate_id"
+      ).and_return("data" => {})
+
+      Shipcloud::Address.update("123", { street: "Mittelweg" }, affiliate_id: "affiliate_id")
+    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", {}, api_key: nil).and_return([])
+        with(:get, "addresses", {}, api_key: nil, affiliate_id: nil).and_return([])
 
       Shipcloud::Address.all
     end
@@ -87,11 +115,21 @@ describe Shipcloud::Address do
         expect(address).to be_a Shipcloud::Address
       end
     end
+
+    it "use the affiliate ID provided for the request" do
+      stub_addresses_request(affiliate_id: "affiliate_id")
+
+      addresses = Shipcloud::Address.all(affiliate_id: "affiliate_id")
+
+      addresses.each do |address|
+        expect(address).to be_a Shipcloud::Address
+      end
+    end
   end
 
-  def stub_addresses_request
+  def stub_addresses_request(affiliate_id: nil)
     allow(Shipcloud).to receive(:request).
-      with(:get, "addresses", {}, api_key: nil).
+      with(:get, "addresses", {}, api_key: nil, affiliate_id: affiliate_id).
       and_return(
         [
           {

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", {}, api_key: nil).and_return([])
+        with(:get, "carriers", {}, api_key: nil, affiliate_id: nil).and_return([])
 
       Shipcloud::Carrier.all
     end
@@ -66,11 +66,18 @@ describe Shipcloud::Carrier do
           )
         )
     end
+
+    it "use the affiliate ID provided for the request" do
+      expect(Shipcloud).to receive(:request).
+        with(:get, "carriers", {}, api_key: nil, affiliate_id: "affiliate_id").and_return([])
+
+      Shipcloud::Carrier.all(affiliate_id: "affiliate_id")
+    end
   end
 
-  def stub_carriers_request
+  def stub_carriers_request(affiliate_id: nil)
     allow(Shipcloud).to receive(:request).
-      with(:get, "carriers", {}, api_key: nil).
+      with(:get, "carriers", {}, api_key: nil, affiliate_id: affiliate_id).
       and_return(
         [
           {

data/spec/shipcloud/pickup_request_spec.rb

@@ -56,7 +56,7 @@ describe Shipcloud::PickupRequest do
   describe ".create" do
     it "makes a new POST request using the correct API endpoint" do
       expect(Shipcloud).to receive(:request).
-        with(:post, "pickup_requests", valid_attributes, api_key: nil).
+        with(:post, "pickup_requests", valid_attributes, api_key: nil, affiliate_id: nil).
         and_return("data" => {})
 
       Shipcloud::PickupRequest.create(valid_attributes)
@@ -119,5 +119,18 @@ describe Shipcloud::PickupRequest do
         "phone" => "555-555"
       )
     end
+
+    it "use the affiliate ID provided for the request" do
+      expect(Shipcloud).to receive(:request).
+        with(
+          :post,
+          "pickup_requests",
+          valid_attributes,
+          api_key: nil,
+          affiliate_id: "affiliate_id",
+        ).and_return("data" => {})
+
+      Shipcloud::PickupRequest.create(valid_attributes, affiliate_id: "affiliate_id")
+    end
   end
 end

data/spec/shipcloud/request/base_spec.rb

@@ -3,7 +3,7 @@ require "spec_helper"
 describe Shipcloud::Request::Base do
   context "#perform" do
     it "checks for an api key" do
-      info = Shipcloud::Request::Info.new(:get, "shipments", nil, {})
+      info = Shipcloud::Request::Info.new(:get, "shipments", nil, {}, "affiliate_id")
 
       expect{
         Shipcloud::Request::Base.new(info).perform
@@ -16,7 +16,7 @@ describe Shipcloud::Request::Base do
       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", {})
+      info = Shipcloud::Request::Info.new(:get, "shipments", "api_key", {}, "affiliate_id")
 
       data = Shipcloud::Request::Base.new(info).perform
 
@@ -30,9 +30,10 @@ describe Shipcloud::Request::Base do
       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", {})
+      info = Shipcloud::Request::Info.new(:get, "shipments", "api_key", {}, "affiliate_id")
 
-      expect { Shipcloud::Request::Base.new(info).perform }.to raise_error(Shipcloud::ClientError)
+      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 "\
@@ -42,9 +43,10 @@ describe Shipcloud::Request::Base do
       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", {})
+      info = Shipcloud::Request::Info.new(:get, "shipments", "api_key", {}, "affiliate_id")
 
-      expect { Shipcloud::Request::Base.new(info).perform }.to raise_error(Shipcloud::ServerError)
+      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 "\
@@ -54,7 +56,7 @@ describe Shipcloud::Request::Base do
       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", {})
+      info = Shipcloud::Request::Info.new(:get, "shipments", "api_key", {}, "affiliate_id")
 
       expect { Shipcloud::Request::Base.new(info).perform }.
         to raise_error(Shipcloud::ShipcloudError)

data/spec/shipcloud/request/info_spec.rb

@@ -4,7 +4,7 @@ require "spec_helper"
 describe Shipcloud::Request::Info do
   describe "#url" do
     it "returns the correct url" do
-      info = Shipcloud::Request::Info.new(:get, "shipments", "api_key", {})
+      info = Shipcloud::Request::Info.new(:get, "shipments", "api_key", {}, "affiliate_id")
 
       expect(info.url).to eq "/v1/shipments"
     end
@@ -12,14 +12,20 @@ describe Shipcloud::Request::Info do
 
   describe "#path_with_params" do
     it "returns just the path if there aren't any params" do
-      info = Shipcloud::Request::Info.new(:get, "shipments", "api_key", {})
+      info = Shipcloud::Request::Info.new(:get, "shipments", "api_key", {}, "affiliate_id")
       path = info.path_with_params(info.url, info.data)
 
       expect(path).to eq "/v1/shipments"
     end
 
     it "returns the path and given params" do
-      info = Shipcloud::Request::Info.new(:get, "shipments", "api_key", foo: "bar")
+      info = Shipcloud::Request::Info.new(
+        :get,
+        "shipments",
+        "api_key",
+        { foo: "bar" },
+        "affiliate_id",
+      )
       path = info.path_with_params(info.url, info.data)
 
       expect(path).to eq "/v1/shipments?foo=bar"

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, api_key: nil).
+        with(:post, "shipment_quotes", valid_attributes, api_key: nil, affiliate_id: nil).
         and_return("data" => {})
 
       Shipcloud::ShipmentQuote.create(valid_attributes)
@@ -70,5 +70,18 @@ describe Shipcloud::ShipmentQuote do
 
       expect(shipment_quote.price).to eq 42.12
     end
+
+    it "use the affiliate ID provided for the request" do
+      expect(Shipcloud).to receive(:request).
+        with(
+          :post,
+          "shipment_quotes",
+          valid_attributes,
+          api_key: nil,
+          affiliate_id: "affiliate_id",
+        ).and_return("data" => {})
+
+      Shipcloud::ShipmentQuote.create(valid_attributes, affiliate_id: "affiliate_id")
+    end
   end
 end

data/spec/shipcloud/shipment_spec.rb

@@ -78,30 +78,61 @@ describe Shipcloud::Shipment do
   describe ".create" do
     it "makes a new POST request using the correct API endpoint" do
       expect(Shipcloud).to receive(:request).
-        with(:post, "shipments", valid_attributes, api_key: nil).and_return("data" => {})
+        with(:post, "shipments", valid_attributes, api_key: nil, affiliate_id: nil).
+        and_return("data" => {})
       Shipcloud::Shipment.create(valid_attributes)
     end
+
+    it "use the affiliate ID provided for the request" do
+      expect(Shipcloud).to receive(:request).
+        with(
+          :post,
+          "shipments",
+          valid_attributes,
+          api_key: nil,
+          affiliate_id: "affiliate_id",
+        ).and_return("data" => {})
+      Shipcloud::Shipment.create(valid_attributes, affiliate_id: "affiliate_id")
+    end
   end
 
   describe ".find" do
     it "makes a new GET request using the correct API endpoint to receive a specific subscription" do
-      expect(Shipcloud).to receive(:request).with(:get, "shipments/123", {}, api_key: nil).
+      expect(Shipcloud).to receive(:request).
+        with(:get, "shipments/123", {}, api_key: nil, affiliate_id: nil).
         and_return("id" => "123")
       Shipcloud::Shipment.find("123")
     end
+
+    it "use the affiliate ID provided for the request" do
+      expect(Shipcloud).to receive(:request).with(
+        :get, "shipments/123", {}, api_key: nil, affiliate_id: "affiliate_id"
+      ).and_return("id" => "123")
+      Shipcloud::Shipment.find("123", affiliate_id: "affiliate_id")
+    end
   end
 
   describe ".update" do
     it "makes a new PUT request using the correct API endpoint" do
       expect(Shipcloud).to receive(:request).
-        with(:put, "shipments/123", { carrier: "ups" }, api_key: nil).and_return("data" => {})
+        with(:put, "shipments/123", { carrier: "ups" }, api_key: nil, affiliate_id: nil).
+        and_return("data" => {})
       Shipcloud::Shipment.update("123", carrier: "ups")
     end
+
+    it "use the affiliate ID provided for the request" do
+      expect(Shipcloud).to receive(:request).
+        with(
+          :put, "shipments/123", { carrier: "ups" }, api_key: nil, affiliate_id: "affiliate_id"
+        ).and_return("data" => {})
+      Shipcloud::Shipment.update("123", { carrier: "ups" }, affiliate_id: "affiliate_id")
+    end
   end
 
   describe ".delete" do
     it "makes a new DELETE request using the correct API endpoint" do
-      expect(Shipcloud).to receive(:request).with(:delete, "shipments/123", {}, api_key: nil).
+      expect(Shipcloud).to receive(:request).
+        with(:delete, "shipments/123", {}, api_key: nil, affiliate_id: nil).
         and_return(true)
       Shipcloud::Shipment.delete("123")
     end
@@ -113,12 +144,19 @@ describe Shipcloud::Shipment do
       expect { Shipcloud::Shipment.delete("123", api_key: "your-api-key") }.
         to_not raise_error
     end
+
+    it "use the affiliate ID provided for the request" do
+      expect(Shipcloud).to receive(:request).with(
+        :delete, "shipments/123", {}, api_key: nil, affiliate_id: "affiliate_id"
+      ).and_return(true)
+      Shipcloud::Shipment.delete("123", affiliate_id: "affiliate_id")
+    end
   end
 
   describe ".all" do
     it "makes a new Get request using the correct API endpoint" do
       expect(Shipcloud).to receive(:request).
-        with(:get, "shipments", {}, api_key: nil).
+        with(:get, "shipments", {}, api_key: nil, affiliate_id: nil).
         and_return("shipments" => [])
 
       Shipcloud::Shipment.all
@@ -146,16 +184,24 @@ describe Shipcloud::Shipment do
       }
 
       expect(Shipcloud).to receive(:request).
-        with(:get, "shipments", filter, api_key: nil).
+        with(:get, "shipments", filter, api_key: nil, affiliate_id: nil).
         and_return("shipments" => shipments_array)
 
       Shipcloud::Shipment.all(filter, api_key: nil)
     end
+
+    it "use the affiliate ID provided for the request" do
+      expect(Shipcloud).to receive(:request).
+        with(:get, "shipments", {}, api_key: nil, affiliate_id: "affiliate_id").
+        and_return("shipments" => [])
+
+      Shipcloud::Shipment.all(affiliate_id: "affiliate_id")
+    end
   end
 
-  def stub_shipments_requests
+  def stub_shipments_requests(affiliate_id: nil)
     allow(Shipcloud).to receive(:request).
-      with(:get, "shipments", {}, api_key: nil).
+      with(:get, "shipments", {}, api_key: nil, affiliate_id: affiliate_id).
       and_return("shipments" => shipments_array)
   end
 

data/spec/shipcloud/tracker_spec.rb

@@ -19,7 +19,7 @@ describe Shipcloud::PickupRequest do
   describe ".all" do
     it "makes a new GET request using the correct API endpoint" do
       expect(Shipcloud).to receive(:request).
-        with(:get, "trackers", {}, api_key: nil).
+        with(:get, "trackers", {}, api_key: nil, affiliate_id: nil).
         and_return("trackers" => [])
 
       Shipcloud::Tracker.all
@@ -34,30 +34,55 @@ describe Shipcloud::PickupRequest do
         expect(tracker).to be_a Shipcloud::Tracker
       end
     end
+
+    it "use the affiliate ID provided for the request" do
+      expect(Shipcloud).to receive(:request).
+        with(:get, "trackers", {}, api_key: nil, affiliate_id: "affiliate_id").
+        and_return("trackers" => [])
+
+      Shipcloud::Tracker.all(affiliate_id: "affiliate_id")
+    end
   end
 
   describe ".create" do
     it "makes a new POST request using the correct API endpoint" do
       expect(Shipcloud).to receive(:request).
-        with(:post, "trackers", valid_attributes, api_key: nil).
+        with(:post, "trackers", valid_attributes, api_key: nil, affiliate_id: nil).
         and_return("data" => {})
 
       Shipcloud::Tracker.create(valid_attributes)
     end
+
+    it "use the affiliate ID provided for the request" do
+      expect(Shipcloud).to receive(:request).
+        with(:post, "trackers", valid_attributes, api_key: nil, affiliate_id: "affiliate_id").
+        and_return("data" => {})
+
+      Shipcloud::Tracker.create(valid_attributes, affiliate_id: "affiliate_id")
+    end
   end
 
   describe ".find" do
     it "makes a new GET request using the correct API endpoint to receive a specific tracker" do
-      expect(Shipcloud).to receive(:request).with(:get, "trackers/123", {}, api_key: nil).
+      expect(Shipcloud).to receive(:request).
+        with(:get, "trackers/123", {}, api_key: nil, affiliate_id: nil).
         and_return("id" => "123")
 
       Shipcloud::Tracker.find("123")
     end
+
+    it "use the affiliate ID provided for the request" do
+      expect(Shipcloud).to receive(:request).
+        with(:get, "trackers/123", {}, api_key: nil, affiliate_id: "affiliate_id").
+        and_return("id" => "123")
+
+      Shipcloud::Tracker.find("123", affiliate_id: "affiliate_id")
+    end
   end
 
-  def stub_trackers_requests
+  def stub_trackers_requests(affiliate_id: nil)
     allow(Shipcloud).to receive(:request).
-      with(:get, "trackers", {}, api_key: nil).
+      with(:get, "trackers", {}, api_key: nil, affiliate_id: affiliate_id).
       and_return("trackers" => trackers_array)
   end
 

data/spec/shipcloud/webhooks_spec.rb

@@ -19,25 +19,39 @@ describe Shipcloud::Webhook do
   describe ".create" do
     it "makes a new POST request using the correct API endpoint" do
       expect(Shipcloud).to receive(:request).
-        with(:post, "webhooks", valid_attributes, api_key: nil).
+        with(:post, "webhooks", valid_attributes, api_key: nil, affiliate_id: nil).
         and_return("data" => {})
       Shipcloud::Webhook.create(valid_attributes)
     end
+
+    it "use the affiliate ID provided for the request" do
+      expect(Shipcloud).to receive(:request).
+        with(:post, "webhooks", valid_attributes, api_key: nil, affiliate_id: "affiliate_id").
+        and_return("data" => {})
+      Shipcloud::Webhook.create(valid_attributes, affiliate_id: "affiliate_id")
+    end
   end
 
   describe ".find" do
     it "makes a new GET request using the correct API endpoint to receive a specific webhook" do
       expect(Shipcloud).to receive(:request).
-        with(:get, "webhooks/123", {}, api_key: nil).
+        with(:get, "webhooks/123", {}, api_key: nil, affiliate_id: nil).
         and_return("id" => "123")
       Shipcloud::Webhook.find("123")
     end
+
+    it "use the affiliate ID provided for the request" do
+      expect(Shipcloud).to receive(:request).
+        with(:get, "webhooks/123", {}, api_key: nil, affiliate_id: "affiliate_id").
+        and_return("id" => "123")
+      Shipcloud::Webhook.find("123", affiliate_id: "affiliate_id")
+    end
   end
 
   describe ".all" do
     it "makes a new Get request using the correct API endpoint" do
       expect(Shipcloud).to receive(:request).
-        with(:get, "webhooks", {}, api_key: nil).
+        with(:get, "webhooks", {}, api_key: nil, affiliate_id: nil).
         and_return("webhooks" => [])
 
       Shipcloud::Webhook.all
@@ -52,15 +66,30 @@ describe Shipcloud::Webhook do
         expect(webhook).to be_a Shipcloud::Webhook
       end
     end
+
+    it "use the affiliate ID provided for the request" do
+      expect(Shipcloud).to receive(:request).
+        with(:get, "webhooks", {}, api_key: nil, affiliate_id: "affiliate_id").
+        and_return("webhooks" => [])
+
+      Shipcloud::Webhook.all(affiliate_id: "affiliate_id")
+    end
   end
 
   describe ".delete" do
     it "makes a DELETE request using the correct API endpoint" do
       expect(Shipcloud).to receive(:request).
-        with(:delete, "webhooks/123", {}, api_key: nil).
+        with(:delete, "webhooks/123", {}, api_key: nil, affiliate_id: nil).
         and_return(true)
       Shipcloud::Webhook.delete("123")
     end
+
+    it "use the affiliate ID provided for the request" do
+      expect(Shipcloud).to receive(:request).
+        with(:delete, "webhooks/123", {}, api_key: nil, affiliate_id: "affiliate_id").
+        and_return(true)
+      Shipcloud::Webhook.delete("123", affiliate_id: "affiliate_id")
+    end
   end
 
   describe ".deactivated" do
@@ -70,7 +99,7 @@ describe Shipcloud::Webhook do
 
     before do
       expect(Shipcloud).to receive(:request).
-        with(:get, "webhooks/#{id}", {}, api_key: nil).
+        with(:get, "webhooks/#{id}", {}, api_key: nil, affiliate_id: nil).
         and_return("id" => id, "deactivated" => deactivated)
     end
 
@@ -85,9 +114,9 @@ describe Shipcloud::Webhook do
     end
   end
 
-  def stub_webhooks_request
+  def stub_webhooks_request(affiliate_id: nil)
     allow(Shipcloud).to receive(:request).
-      with(:get, "webhooks", {}, api_key: nil).
+      with(:get, "webhooks", {}, api_key: nil, affiliate_id: affiliate_id).
       and_return("webhooks" => webhooks_array)
   end
 

data/spec/shipcloud_spec.rb

@@ -52,55 +52,55 @@ describe Shipcloud do
     end
   end
 
-  describe '.configure' do
+  describe ".configure" do
     before :each do
       Shipcloud.configuration = nil
     end
 
-    it 'defaults api_key to nil' do
+    it "defaults api_key to nil" do
       expect(Shipcloud.configuration.api_key).to be_nil
     end
 
-    it 'sets the api_key' do
+    it "sets the api_key" do
       Shipcloud.configure do |config|
-        config.api_key = 'your-api-key'
+        config.api_key = "your-api-key"
       end
-      expect(Shipcloud.configuration.api_key).to eq 'your-api-key'
+      expect(Shipcloud.configuration.api_key).to eq "your-api-key"
     end
 
-    it 'gets the api key, set as a class variable (DEPRECATED)' do
-      Shipcloud.api_key = 'old-school-api-key'
-      expect(Shipcloud.api_key).to eq 'old-school-api-key'
-      expect(Shipcloud.configuration.api_key).to eq 'old-school-api-key'
+    it "gets the api key, set as a class variable (DEPRECATED)" do
+      Shipcloud.api_key = "old-school-api-key"
+      expect(Shipcloud.api_key).to eq "old-school-api-key"
+      expect(Shipcloud.configuration.api_key).to eq "old-school-api-key"
     end
 
     it "defaults api_base to 'api.shipcloud.io'" do
-      expect(Shipcloud.configuration.api_base).to eq 'api.shipcloud.io'
+      expect(Shipcloud.configuration.api_base).to eq "api.shipcloud.io"
     end
 
-    it 'overwrites the default api base' do
+    it "overwrites the default api base" do
       Shipcloud.configure do |config|
-        config.api_base = 'api.shipcloud.dev'
+        config.api_base = "api.shipcloud.dev"
       end
-      expect(Shipcloud.configuration.api_base).to eq 'api.shipcloud.dev'
+      expect(Shipcloud.configuration.api_base).to eq "api.shipcloud.dev"
     end
 
-    it 'defaults use_ssl to true' do
+    it "defaults use_ssl to true" do
       expect(Shipcloud.configuration.use_ssl).to be true
     end
 
-    it 'overwrites the default ssl mode' do
+    it "overwrites the default ssl mode" do
       Shipcloud.configure do |config|
         config.use_ssl = false
       end
       expect(Shipcloud.configuration.use_ssl).to be false
     end
 
-    it 'defaults debug to false' do
+    it "defaults debug to false" do
       expect(Shipcloud.configuration.debug).to be false
     end
 
-    it 'overwrites the default debug mode' do
+    it "overwrites the default debug mode" do
       Shipcloud.configure do |config|
         config.debug = true
       end
@@ -136,7 +136,6 @@ describe Shipcloud do
       Shipcloud.configure do |config|
         config.affiliate_id = "integration.my_rails_app.1234567"
       end
-
       expect(Shipcloud.api_headers).to eq(
         "Content-Type" => "application/json",
         "User-Agent" => "shipcloud-ruby v#{Shipcloud::VERSION}, API #{Shipcloud::API_VERSION}, " \

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shipcloud
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - sthollmann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-09 00:00:00.000000000 Z
+date: 2019-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -53,33 +67,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.6'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 0.71.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 0.71.0
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -94,10 +108,25 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: A wrapper for the shipcloud API. Fore more details visit https://developers.shipcloud.io/
 email:
 - stefan@shipcloud.io
-executables: []
+executables:
+- rubocop
 extensions: []
 extra_rdoc_files: []
 files:
@@ -113,6 +142,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/rubocop
 - install-cc-test-reporter.sh
 - lib/shipcloud.rb
 - lib/shipcloud/address.rb
@@ -159,15 +189,14 @@ 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.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A wrapper for the shipcloud API