shipcloud 0.11.0 → 0.12.0

data/spec/shipcloud/shipment_spec.rb

@@ -1,71 +1,21 @@
-require 'spec_helper'
+# frozen_string_literal: true
+require "spec_helper"
 
 describe Shipcloud::Shipment do
-  let(:valid_attributes) do
-    {
-      to: {
-        company: 'shipcloud GmbH',
-        first_name:   'Max',
-        last_name: 'Mustermann',
-        street: 'Musterallee',
-        street_no: '43',
-        city: 'Berlin',
-        zip_code: '10000',
-      },
-      carrier: 'dhl',
-      package: {
-        weight: 2.5,
-        length: 40,
-        width: 20,
-        height: 20
-      },
-      pickup: {
-        pickup_time: {
-          earliest: "2015-09-15T09:00:00+02:00",
-          latest: "2015-09-15T18:00:00+02:00"
-        },
-        pickup_address: {
-          company: "Sender Ltd.",
-          first_name: "Jane",
-          last_name: "Doe",
-          street: "Musterstraße",
-          street_no: "42",
-          zip_code: "54321",
-          city: "Musterstadt",
-          country: "DE"
-         },
-      },
-      metadata: {
-        product: {
-          name: "foo"
-        },
-        category: {
-          id: "123456",
-          name: "bar"
-        }
-      },
-      customs_declaration: {
-        id: "123456",
-        contents_type: "commercial_goods",
-      },
-    }
-  end
-
-  let(:shipment) {
-    Shipcloud::Shipment.new(valid_attributes)
-  }
-
   describe "#initialize" do
     it "initializes all attributes correctly" do
-      expect(shipment.to[:company]).to eq 'shipcloud GmbH'
-      expect(shipment.to[:first_name]).to eq 'Max'
-      expect(shipment.to[:last_name]).to eq 'Mustermann'
-      expect(shipment.to[:street]).to eq 'Musterallee'
-      expect(shipment.to[:street_no]).to eq '43'
-      expect(shipment.to[:city]).to eq 'Berlin'
-      expect(shipment.to[:zip_code]).to eq '10000'
+      shipment = Shipcloud::Shipment.new(valid_attributes)
+
+      expect(shipment.to[:company]).to eq "shipcloud GmbH"
+      expect(shipment.to[:first_name]).to eq "Max"
+      expect(shipment.to[:last_name]).to eq "Mustermann"
+      expect(shipment.to[:street]).to eq "Musterallee"
+      expect(shipment.to[:street_no]).to eq "43"
+      expect(shipment.to[:city]).to eq "Berlin"
+      expect(shipment.to[:zip_code]).to eq "10000"
 
-      expect(shipment.carrier).to eq 'dhl'
+      expect(shipment.carrier).to eq "dhl"
+      expect(shipment.service).to eq "standard"
 
       expect(shipment.package[:weight]).to eq 2.5
       expect(shipment.package[:length]).to eq 40
@@ -85,17 +35,33 @@ describe Shipcloud::Shipment do
 
       expect(shipment.customs_declaration[:id]).to eq "123456"
       expect(shipment.customs_declaration[:contents_type]).to eq "commercial_goods"
+      expect(shipment.additional_services.first[:name]).to eq "cash_on_delivery"
+      expect(shipment.additional_services.first[:properties][:amount]).to eq 123.45
+      expect(shipment.additional_services.first[:properties][:currency]).to eq "EUR"
+      expect(
+        shipment.additional_services.first[:properties][:bank_account_holder],
+      ).to eq "Max Mustermann"
+      expect(shipment.additional_services.first[:properties][:bank_name]).to eq "Musterbank"
+      expect(
+        shipment.additional_services.first[:properties][:bank_account_number],
+      ).to eq "DE12500105170648489890"
+      expect(shipment.additional_services.first[:properties][:bank_code]).to eq "BENEDEPPYYY"
+      expect(
+        shipment.additional_services.first[:properties][:reference1],
+      ).to eq "reason for transfer"
     end
 
     it "initializes the metadata correctly" do
+      shipment = Shipcloud::Shipment.new(valid_attributes)
+
       metadata = {
         category: {
           id: "123456",
-          name: "bar"
+          name: "bar",
         },
         product: {
-          name: "foo"
-        }
+          name: "foo",
+        },
       }
 
       expect(shipment.metadata).to eq metadata
@@ -124,7 +90,8 @@ describe Shipcloud::Shipment do
   end
 
   describe ".find" do
-    it "makes a new GET request using the correct API endpoint to receive a specific subscription" 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, affiliate_id: nil).
         and_return("id" => "123")
@@ -226,6 +193,29 @@ describe Shipcloud::Shipment do
     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, affiliate_id: nil).
+        and_return("data" => {})
+
+      shipment = Shipcloud::Shipment.new(id: "123")
+
+      shipment.update(carrier: "ups")
+    end
+
+    it "uses 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" => {})
+
+      shipment = Shipcloud::Shipment.new(id: "123")
+
+      shipment.update({ carrier: "ups" }, affiliate_id: "affiliate_id")
+    end
+  end
+
   def stub_shipments_requests(affiliate_id: nil)
     allow(Shipcloud).to receive(:request).
       with(:get, "shipments", {}, api_key: nil, affiliate_id: affiliate_id).
@@ -234,7 +224,8 @@ describe Shipcloud::Shipment do
 
   def shipments_array
     [
-      { "id" => "86afb143f9c9c0cfd4eb7a7c26a5c616585a6271",
+      {
+        "id" => "86afb143f9c9c0cfd4eb7a7c26a5c616585a6271",
         "carrier_tracking_no" => "43128000105",
         "carrier" => "hermes",
         "service" => "standard",
@@ -248,7 +239,7 @@ describe Shipcloud::Shipment do
           "street_no" => "1",
           "zip_code" => "12345",
           "city" => "Hamburg",
-          "country" => "DE"
+          "country" => "DE",
         },
         "from" => {
           "company" => "webionate GmbH",
@@ -257,17 +248,18 @@ describe Shipcloud::Shipment do
           "street_no" => "35a",
           "zip_code" => "22175",
           "city" => "Hamburg",
-          "country" => "DE"
+          "country" => "DE",
         },
         "packages" => {
           "id" => "be81573799958587ae891b983aabf9c4089fc462",
           "length" => 10.0,
           "width" => 10.0,
           "height" => 10.0,
-          "weight" => 1.5
-        }
+          "weight" => 1.5,
+        },
       },
-      { "id" => "be81573799958587ae891b983aabf9c4089fc462",
+      {
+        "id" => "be81573799958587ae891b983aabf9c4089fc462",
         "carrier_tracking_no" => "1Z12345E1305277940",
         "carrier" => "ups",
         "service" => "standard",
@@ -281,7 +273,7 @@ describe Shipcloud::Shipment do
           "street_no" => "57",
           "zip_code" => "22081",
           "city" => "Hamburg",
-          "country" => "DE"
+          "country" => "DE",
         },
         "from" => {
           "company" => "webionate GmbH",
@@ -290,16 +282,81 @@ describe Shipcloud::Shipment do
           "street_no" => "35a",
           "zip_code" => "22175",
           "city" => "Hamburg",
-          "country" => "DE"
+          "country" => "DE",
         },
         "packages" => {
           "id" => "74d4f1fc193d8a7ca542d1ee4e2021f3ddb82242",
           "length" => 15.0,
           "width" => 20.0,
           "height" => 10.0,
-          "weight" => 2.0
-        }
-      }
+          "weight" => 2.0,
+        },
+      },
     ]
   end
+
+  def valid_attributes
+    {
+      to: {
+        company: "shipcloud GmbH",
+        first_name: "Max",
+        last_name: "Mustermann",
+        street: "Musterallee",
+        street_no: "43",
+        city: "Berlin",
+        zip_code: "10000",
+      },
+      carrier: "dhl",
+      service: "standard",
+      package: {
+        weight: 2.5,
+        length: 40,
+        width: 20,
+        height: 20,
+      },
+      pickup: {
+        pickup_time: {
+          earliest: "2015-09-15T09:00:00+02:00",
+          latest: "2015-09-15T18:00:00+02:00",
+        },
+        pickup_address: {
+          company: "Sender Ltd.",
+          first_name: "Jane",
+          last_name: "Doe",
+          street: "Musterstraße",
+          street_no: "42",
+          zip_code: "54321",
+          city: "Musterstadt",
+          country: "DE",
+        },
+      },
+      metadata: {
+        product: {
+          name: "foo",
+        },
+        category: {
+          id: "123456",
+          name: "bar",
+        },
+      },
+      customs_declaration: {
+        id: "123456",
+        contents_type: "commercial_goods",
+      },
+      additional_services: [
+        {
+          name: "cash_on_delivery",
+          properties: {
+            amount: 123.45,
+            currency: "EUR",
+            bank_account_holder: "Max Mustermann",
+            bank_name: "Musterbank",
+            bank_account_number: "DE12500105170648489890",
+            bank_code: "BENEDEPPYYY",
+            reference1: "reason for transfer",
+          },
+        },
+      ],
+    }
+  end
 end

data/spec/shipcloud/webhooks_spec.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
 require "spec_helper"
 
 describe Shipcloud::Webhook do
   valid_attributes = {
     id: "583cfd8b-77c7-4447-a3a0-1568bb9cc553",
     url: "https://example.com/webhook",
-    event_types: ["shipment.tracking.delayed", "shipment.tracking.delivered"]
+    event_types: ["shipment.tracking.delayed", "shipment.tracking.delivered"],
   }
 
   describe "#initialize" do
@@ -126,14 +127,14 @@ describe Shipcloud::Webhook do
         "id" => "583cfd8b-77c7-4447-a3a0-1568bb9cc553",
         "url" => "https://example.com/webhook",
         "event_types" => ["shipment.tracking.delayed", "shipment.tracking.delivered"],
-        "deactivated" => false
+        "deactivated" => false,
       },
       {
         "id" => "e0ff4250-6c8e-494d-a069-afd9d566e372",
         "url" => "https://example.com/webhook",
         "event_types" => ["shipment.tracking.delayed", "shipment.tracking.delivered"],
-        "deactivated" => false
-      }
+        "deactivated" => false,
+      },
     ]
   end
 end

data/spec/shipcloud_spec.rb

@@ -1,16 +1,19 @@
+# frozen_string_literal: true
 require "spec_helper"
 
 describe Shipcloud do
   describe ".request" do
     context "given no api key exists" do
       it "raises an authentication error" do
-        expect { Shipcloud.request(:get, "clients", {}) }.to raise_error(Shipcloud::AuthenticationError)
+        expect do
+          Shipcloud.request(:get, "clients", {})
+        end.to raise_error(Shipcloud::AuthenticationError)
       end
     end
 
     context "with an invalid api key" do
       before(:each) do
-        WebMock.stub_request(:any, /#{Shipcloud.configuration.api_base}/).to_return(:body => "{}")
+        WebMock.stub_request(:any, /#{Shipcloud.configuration.api_base}/).to_return(body: "{}")
         Shipcloud.api_key = "your-api-key"
       end
 

data/spec/spec_helper.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
 require "simplecov"
 SimpleCov.start
 
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
-require 'shipcloud'
-require 'rspec'
+require "shipcloud"
+require "rspec"
 require "webmock/rspec"
 require "pry"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shipcloud
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - sthollmann
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-28 00:00:00.000000000 Z
+date: 2023-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -72,42 +72,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.71.0
+        version: 1.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.71.0
+        version: 1.10.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.7.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.21.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.21.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -125,25 +125,23 @@ dependencies:
 description: A wrapper for the shipcloud API. Fore more details visit https://developers.shipcloud.io/
 email:
 - stefan@shipcloud.io
-executables:
-- rubocop
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".codeclimate.yml"
 - ".gitignore"
-- ".hound.yml"
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/rubocop
-- install-cc-test-reporter.sh
+- bin/setup
 - lib/shipcloud.rb
 - lib/shipcloud/address.rb
 - lib/shipcloud/base.rb
@@ -153,6 +151,7 @@ files:
 - lib/shipcloud/operations/delete.rb
 - lib/shipcloud/operations/find.rb
 - lib/shipcloud/operations/update.rb
+- lib/shipcloud/order.rb
 - lib/shipcloud/pickup_request.rb
 - lib/shipcloud/request/base.rb
 - lib/shipcloud/request/connection.rb
@@ -166,6 +165,7 @@ files:
 - shipcloud.gemspec
 - spec/shipcloud/address_spec.rb
 - spec/shipcloud/carrier_spec.rb
+- spec/shipcloud/order_spec.rb
 - spec/shipcloud/pickup_request_spec.rb
 - spec/shipcloud/request/base_spec.rb
 - spec/shipcloud/request/connection_spec.rb
@@ -189,20 +189,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: A wrapper for the shipcloud API
 test_files:
 - spec/shipcloud/address_spec.rb
 - spec/shipcloud/carrier_spec.rb
+- spec/shipcloud/order_spec.rb
 - spec/shipcloud/pickup_request_spec.rb
 - spec/shipcloud/request/base_spec.rb
 - spec/shipcloud/request/connection_spec.rb

data/.hound.yml

@@ -1,12 +0,0 @@
-ruby:
-  config_file: .rubocop.yml
-scss:
-  enabled: false
-coffeescript:
-  enabled: false
-javascript:
-  enabled: false
-scss:
-  enabled: false
-haml:
-  enabled: false

data/.travis.yml

@@ -1,27 +0,0 @@
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.3
-  - 2.4
-  - 2.5
-  - 2.6
-  - ruby-head
-  - jruby
-  - rbx
-matrix:
-  allow_failures:
-    - rvm: ruby-head
-    - rvm: rbx
-    - rvm: jruby
-notifications:
-  flowdock:
-    secure: fSZxX5z3bHWT8aCFKBFrDDt5o3Jb6EFWcm+pAcMabpfDHc4iktWuCUlSM405798TRdKdws1A2RncQGYiQyLbqNvtLz48dvj4BxgYW7P/vg0koN+I/H2MjpZeuIQ7BRSEJIq2sAYNVya+hSil+SPEBMTngJiP6VYG0dm6fFnRkyk=
-addons:
-  code_climate:
-    repo_token: 704eb62133d951ce460a6047a15a58e0a521aa20ec6a533fa7a37585f8a75602
-before_script:
-  - ./install-cc-test-reporter.sh
-  - ./cc-test-reporter before-build
-after_script:
-  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/install-cc-test-reporter.sh

@@ -1,4 +0,0 @@
-#!/usr/bin/env sh
-
-curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-chmod +x ./cc-test-reporter