shipcloud 0.6.0 → 0.11.0

data/lib/shipcloud/operations/find.rb

@@ -5,9 +5,17 @@ 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, 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

@@ -6,8 +6,12 @@ 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, affiliate_id: nil)
+          response = Shipcloud.request(
+            :put, "#{base_url}/#{id}", attributes, api_key: api_key, affiliate_id: affiliate_id
+          )
           self.new(response)
         end
       end
@@ -19,8 +23,12 @@ 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, 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/pickup_request.rb

@@ -0,0 +1,12 @@
+module Shipcloud
+  class PickupRequest < Base
+    include Shipcloud::Operations::Create
+
+    attr_accessor :carrier, :pickup_time, :shipments, :pickup_address
+    attr_reader :id, :carrier_pickup_number
+
+    def self.base_url
+      "pickup_requests"
+    end
+  end
+end

data/lib/shipcloud/request/base.rb

@@ -2,32 +2,36 @@ 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) unless response.body.nil?
+      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
 
+      # rubocop:disable Naming/MemoizedInstanceVariableName
       def connection
         @connection ||= Connection.new(info)
       end
-
-      def validator
-        @validator ||= Validator.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,17 +28,23 @@ module Shipcloud
       protected
 
       def https_request
-        https_request = case @info.http_method
-                        when :post
-                          Net::HTTP::Post.new(@info.url, API_HEADERS)
-                        when :put
-                          Net::HTTP::Put.new(@info.url, API_HEADERS)
-                        when :delete
-                          Net::HTTP::Delete.new(@info.url, API_HEADERS)
-                        else
-                          Net::HTTP::Get.new(@info.path_with_params(@info.url, @info.data), API_HEADERS)
-                        end
-        https_request.basic_auth(Shipcloud.api_key, "")
+        headers = Shipcloud.api_headers.merge("Affiliate-ID" => @info.affiliate_id)
+        https_request =
+          case @info.http_method
+          when :post
+            Net::HTTP::Post.new(@info.url, headers)
+          when :put
+            Net::HTTP::Put.new(@info.url, headers)
+          when :delete
+            Net::HTTP::Delete.new(@info.url, headers)
+          else
+            Net::HTTP::Get.new(
+              @info.path_with_params(@info.url, @info.data),
+              headers,
+            )
+          end
+
+        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,12 +1,14 @@
 module Shipcloud
   module Request
     class Info
-      attr_accessor :http_method, :api_url, :data
+      attr_accessor :http_method, :api_url, :api_key, :data, :affiliate_id
 
-      def initialize(http_method, api_url, data)
-        @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

@@ -0,0 +1,70 @@
+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 403 then ForbiddenError
+      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 ForbiddenError < 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/shipment.rb

@@ -4,8 +4,9 @@ module Shipcloud
     include Shipcloud::Operations::Update
     include Shipcloud::Operations::All
 
-    attr_accessor :from, :to, :carrier, :package, :reference_number
-    attr_reader :id, :created_at, :carrier_tracking_no, :tracking_url, :label_url, :packages, :price
+    attr_accessor :from, :to, :carrier, :package, :reference_number, :metadata
+    attr_reader :id, :created_at, :carrier_tracking_no, :tracking_url, :label_url,
+                :packages, :price, :customs_declaration, :pickup
 
     def self.index_response_root
       "#{class_name.downcase}s"

data/lib/shipcloud/tracker.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+module Shipcloud
+  class Tracker < Base
+    include Shipcloud::Operations::All
+
+    attr_accessor :carrier, :carrier_tracking_no
+    attr_reader :id
+
+    def self.index_response_root
+      "#{class_name.downcase}s"
+    end
+  end
+end

data/lib/shipcloud/version.rb

@@ -1,3 +1,3 @@
 module Shipcloud
-  VERSION = "0.6.0"
+  VERSION = "0.11.0".freeze
 end

data/lib/shipcloud/webhook.rb

@@ -1,8 +1,9 @@
 module Shipcloud
   class Webhook < Base
     include Shipcloud::Operations::All
+    include Shipcloud::Operations::Delete
 
-    attr_reader :url, :event_types
+    attr_reader :id, :url, :event_types, :deactivated
 
     def self.index_response_root
       "webhooks"

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,13 +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", ">= 1.8.0"
-  spec.add_development_dependency "bundler", ">= 1.3.0", "< 2.0"
-  spec.add_development_dependency "rake", "~> 10.3"
-  spec.add_development_dependency "rspec", "~> 2.99"
-  spec.add_development_dependency "webmock", "~> 1.18"
+  spec.add_runtime_dependency "json", ">= 1.8.0"
   spec.add_development_dependency "pry", "~> 0.10"
-  spec.add_development_dependency "codeclimate-test-reporter"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rspec", "~> 3.6"
+  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

@@ -13,7 +13,8 @@ describe Shipcloud::Address do
     city:        'Hamburg',
     state:       'Hamburg',
     country:     'DE',
-    phone:       '040/123456789'
+    phone:       '040/123456789',
+    email:       'max@mustermail.com',
   }
 
   describe '#initialize' do
@@ -30,36 +31,79 @@ describe Shipcloud::Address do
       expect(address.state).to eq 'Hamburg'
       expect(address.country).to eq 'DE'
       expect(address.phone).to eq '040/123456789'
+      expect(address.email).to eq 'max@mustermail.com'
     end
   end
 
   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, 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, 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
-      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, 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
-      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, 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', {}).and_return([])
+        with(:get, "addresses", {}, api_key: nil, affiliate_id: nil).and_return([])
 
       Shipcloud::Address.all
     end
@@ -73,42 +117,69 @@ 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', {}).
-        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, affiliate_id: affiliate_id).
+      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
+
+  def returned_address
+    {
+      "id" => "1c81efb7-9b95-4dd8-92e3-cac1bca3df6f",
+      "company" => "shipcloud GmbH",
+      "first_name" => "Maxi",
+      "last_name" => "Musterfrau",
+      "care_of" => "Mustermann",
+      "street" => "Musterstraße",
+      "street_no" => "123",
+      "zip_code" => "12345",
+      "city" => "Hamburg",
+      "state" => "Hamburg",
+      "country" => "DE",
+      "phone" => "040/123456789",
+    }
   end
 end