shipcloud 0.10.0 → 0.12.0

data/CHANGELOG.md

@@ -11,6 +11,38 @@
 
 ### Security
 
+## [0.12.0] - 2022-12-06
+### Added
+- Add order model
+- Add attr_accessor for `service` to class `Shipcloud::Shipment` to be able to access the service attribute at the shipment object.
+- Add attr_accessor for `additional_services` to class `Shipcloud::Shipment` to be able to access the additional_services attribute at the shipment object.
+- Add attr_reader for `label_voucher_url` to class `Shipcloud::Shipment` to be able to read the label_voucher_url (QR Code url) attribute at the shipment object.
+- Added missing `frozen_string_literal: true` magic comments to files
+
+### Changed
+- Ensure compatibility with ruby 2.x and 3.x
+- Set required ruby version to >= 2.6
+- Replace Travis CI with CircleCI
+- Specify simplecov to be ~> 0.21.0
+- Specify `rubocop` to be `~> 1.10.0`
+- Specify `rubocop-performance` to be `~> 1.7.0`
+
+### Deprecated
+
+### Removed
+- Drop support for Ruby <= 2.5
+- Drop support for RBX
+
+### Fixed
+- Fix rubocop styling issues
+
+### Security
+
+## [0.11.0] - 2020-07-28
+### Added
+- Support shipments with pickup requests as required for [TNT](https://developers.shipcloud.io/carriers/tnt.html).
+- Add attr_accessor for `email` to class `Shipcloud::Address` to be able to access the email attribute at the address object.
+
 ## [0.10.0] - 2019-08-07
 ### Added
 - Add the possibility to specify custom affiliate_id on every request

data/Gemfile

@@ -1,4 +1,5 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in shipcloud.gemspec
 gemspec

data/README.md

@@ -1,4 +1,6 @@
-[![Code Climate](https://codeclimate.com/github/shipcloud/shipcloud-ruby.png)](https://codeclimate.com/github/shipcloud/shipcloud-ruby) [![Build Status](https://travis-ci.org/shipcloud/shipcloud-ruby.png?branch=master)](https://travis-ci.org/shipcloud/shipcloud-ruby)
+[![CircleCI](https://circleci.com/gh/shipcloud/shipcloud-ruby/tree/master.svg?style=svg)](https://circleci.com/gh/shipcloud/shipcloud-ruby/tree/master)
+[![Maintainability](https://api.codeclimate.com/v1/badges/c8c3cba2068e5d649567/maintainability)](https://codeclimate.com/github/shipcloud/shipcloud-ruby/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/c8c3cba2068e5d649567/test_coverage)](https://codeclimate.com/github/shipcloud/shipcloud-ruby/test_coverage)
 
 # shipcloud
 

data/Rakefile

@@ -1,12 +1,13 @@
+# frozen_string_literal: true
 require "bundler/gem_tasks"
-require 'rspec/core/rake_task'
+require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
 task :console do
-  require 'irb'
-  require 'irb/completion'
-  require 'shipcloud'
+  require "irb"
+  require "irb/completion"
+  require "shipcloud"
   ARGV.clear
   IRB.start
 end

data/bin/setup

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+gem install bundler -v "~> 2.0"
+bundle install

data/lib/shipcloud/address.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module Shipcloud
   class Address < Base
     include Shipcloud::Operations::Update
     include Shipcloud::Operations::All
 
-    attr_accessor :company, :first_name, :last_name, :care_of, :street,
+    attr_accessor :company, :first_name, :last_name, :care_of, :street, :email,
                   :street_no, :zip_code, :city, :state, :country, :phone
     attr_reader :id
 

data/lib/shipcloud/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Shipcloud
   class Base
     include Shipcloud::Operations::Create
@@ -28,17 +30,15 @@ module Shipcloud
     end
 
     def self.class_name
-      self.name.split("::").last
+      name.split("::").last
     end
 
     def self.base_url
       "#{class_name.downcase}s"
     end
 
-    def self.create_response_root
-    end
+    def self.create_response_root; end
 
-    def self.index_response_root
-    end
+    def self.index_response_root; end
   end
 end

data/lib/shipcloud/carrier.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Shipcloud
   class Carrier < Base
     include Shipcloud::Operations::All

data/lib/shipcloud/operations/all.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Shipcloud
   module Operations
     module All

data/lib/shipcloud/operations/create.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Shipcloud
   module Operations
     module Create
@@ -18,7 +20,7 @@ module Shipcloud
           if create_response_root
             response = response.fetch(create_response_root, {})
           end
-          self.new(response)
+          new(response)
         end
       end
 

data/lib/shipcloud/operations/delete.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Shipcloud
   module Operations
     module Delete

data/lib/shipcloud/operations/find.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Shipcloud
   module Operations
     module Find
@@ -16,7 +18,7 @@ module Shipcloud
             api_key: api_key,
             affiliate_id: affiliate_id,
           )
-          self.new(response)
+          new(response)
         end
       end
 

data/lib/shipcloud/operations/update.rb

@@ -1,18 +1,25 @@
+# frozen_string_literal: true
+
 module Shipcloud
   module Operations
     module Update
-
       module ClassMethods
-        # Updates a object
+        # Updates an object
         # @param [String] id The id of the object that should be updated
         # @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
+        # @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)
+        # @param [String] optional affiliate_id Your affiliate ID. If no affiliate ID is given,
+        # Shipcloud.affiliate_id will be used for the request
+        def update(id, attributes = {}, **kwargs)
+          attributes.merge!(kwargs)
+          options = attributes.slice(:api_key, :affiliate_id) || {}
+          attributes.reject! { |key| [:api_key, :affiliate_id].include?(key) }
           response = Shipcloud.request(
-            :put, "#{base_url}/#{id}", attributes, api_key: api_key, affiliate_id: affiliate_id
+            :put, "#{base_url}/#{id}", attributes,
+            api_key: options[:api_key], affiliate_id: options[:affiliate_id]
           )
-          self.new(response)
+          new(response)
         end
       end
 
@@ -20,16 +27,15 @@ module Shipcloud
         base.extend(ClassMethods)
       end
 
-      # Updates a object
+      # Updates an object
       #
       # @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
+      # @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)
+      # @param [String] optional affiliate_id Your affiliate ID. If no affiliate ID is given,
+      # Shipcloud.affiliate_id will be used for the request
+      def update(attributes = {}, **kwargs)
+        self.class.update(id, attributes, **kwargs)
       end
     end
   end

data/lib/shipcloud/order.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Shipcloud
+  class Order < Base
+    include Shipcloud::Operations::All
+    include Shipcloud::Operations::Find
+    include Shipcloud::Operations::Create
+    include Shipcloud::Operations::Delete
+
+    attr_reader :id
+    attr_accessor :external_customer_id, :external_order_id, :placed_at, :total_price, :total_vat,
+                  :currency, :total_weight, :weight_unit, :refundable_until,
+                  :refund_deduction_amount, :delivery_address, :order_line_items, :metadata
+  end
+end

data/lib/shipcloud/pickup_request.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Shipcloud
   class PickupRequest < Base
     include Shipcloud::Operations::Create

data/lib/shipcloud/request/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Shipcloud
   module Request
     class Base

data/lib/shipcloud/request/connection.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Shipcloud
   module Request
     class Connection
@@ -9,12 +11,18 @@ module Shipcloud
 
       def setup_https
         if Shipcloud.configuration.use_ssl
-          @https             = Net::HTTP.new(Shipcloud.configuration.api_base, Net::HTTP.https_default_port)
+          @https = Net::HTTP.new(
+            Shipcloud.configuration.api_base,
+            Net::HTTP.https_default_port,
+          )
           @https.use_ssl     = true
           @https.verify_mode = OpenSSL::SSL::VERIFY_PEER
         else
-          @https             = Net::HTTP.new(Shipcloud.configuration.api_base, Net::HTTP.http_default_port)
-          @https.use_ssl     = false
+          @https = Net::HTTP.new(
+            Shipcloud.configuration.api_base,
+            Net::HTTP.http_default_port,
+          )
+          @https.use_ssl = false
         end
         @https.set_debug_output $stdout if Shipcloud.configuration.debug
       end

data/lib/shipcloud/request/info.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Shipcloud
   module Request
     class Info
@@ -12,16 +14,15 @@ module Shipcloud
       end
 
       def url
-        url = "/#{API_VERSION}/#{api_url}"
-        url
+        "/#{API_VERSION}/#{api_url}"
       end
 
       def path_with_params(path, params)
-        unless params.empty?
+        if params.empty?
+          path
+        else
           encoded_params = URI.encode_www_form(params)
           [path, encoded_params].join("?")
-        else
-          path
         end
       end
     end

data/lib/shipcloud/shipcloud_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Shipcloud
   class ShipcloudError < StandardError
     attr_reader :errors, :response
@@ -59,10 +61,15 @@ module Shipcloud
 
   # 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

data/lib/shipcloud/shipment.rb

@@ -1,12 +1,15 @@
+# frozen_string_literal: true
+
 module Shipcloud
   class Shipment < Base
     include Shipcloud::Operations::Delete
     include Shipcloud::Operations::Update
     include Shipcloud::Operations::All
 
-    attr_accessor :from, :to, :carrier, :package, :reference_number, :metadata
+    attr_accessor :from, :to, :carrier, :service, :package, :reference_number, :metadata,
+                  :additional_services
     attr_reader :id, :created_at, :carrier_tracking_no, :tracking_url, :label_url,
-                :packages, :price, :customs_declaration
+                :packages, :price, :customs_declaration, :pickup, :label_voucher_url
 
     def self.index_response_root
       "#{class_name.downcase}s"

data/lib/shipcloud/shipment_quote.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Shipcloud
   class ShipmentQuote < Base
     include Shipcloud::Operations::Create

data/lib/shipcloud/tracker.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipcloud
   class Tracker < Base
     include Shipcloud::Operations::All

data/lib/shipcloud/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Shipcloud
-  VERSION = "0.10.0".freeze
+  VERSION = "0.12.0"
 end

data/lib/shipcloud/webhook.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Shipcloud
   class Webhook < Base
     include Shipcloud::Operations::All

data/lib/shipcloud.rb

@@ -21,6 +21,7 @@ module Shipcloud
   autoload :Shipment,       "shipcloud/shipment"
   autoload :Carrier,        "shipcloud/carrier"
   autoload :Address,        "shipcloud/address"
+  autoload :Order,          "shipcloud/order"
   autoload :PickupRequest,  "shipcloud/pickup_request"
   autoload :ShipmentQuote,  "shipcloud/shipment_quote"
   autoload :Tracker,        "shipcloud/tracker"

data/shipcloud.gemspec

@@ -1,4 +1,6 @@
 # coding: utf-8
+# frozen_string_literal: true
+
 lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "shipcloud/version"
@@ -15,18 +17,17 @@ Gem::Specification.new do |spec|
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = ">= 2.3"
+  spec.required_ruby_version = ">= 2.6"
 
   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 "rake", "~> 13.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 "rubocop", "~> 1.10.0"
+  spec.add_development_dependency "rubocop-performance", "~> 1.7.0"
+  spec.add_development_dependency "simplecov", "~> 0.21.0"
   spec.add_development_dependency "webmock", "~> 3.0"
 end

data/spec/shipcloud/address_spec.rb

@@ -1,40 +1,43 @@
- # encoding: utf-8
-require 'spec_helper'
+# encoding: utf-8
+# frozen_string_literal: true
+require "spec_helper"
 
 describe Shipcloud::Address do
   valid_attributes = {
-    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'
+    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",
+    email: "max@mustermail.com",
   }
 
-  describe '#initialize' do
-    it 'initializes all attributes correctly' do
+  describe "#initialize" do
+    it "initializes all attributes correctly" do
       address = Shipcloud::Address.new(valid_attributes)
-      expect(address.company).to eq 'shipcloud GmbH'
-      expect(address.first_name).to eq 'Maxi'
-      expect(address.last_name).to eq 'Musterfrau'
-      expect(address.care_of).to eq 'Mustermann'
-      expect(address.street).to eq 'Musterstraße'
-      expect(address.street_no).to eq '123'
-      expect(address.zip_code).to eq '12345'
-      expect(address.city).to eq 'Hamburg'
-      expect(address.state).to eq 'Hamburg'
-      expect(address.country).to eq 'DE'
-      expect(address.phone).to eq '040/123456789'
+      expect(address.company).to eq "shipcloud GmbH"
+      expect(address.first_name).to eq "Maxi"
+      expect(address.last_name).to eq "Musterfrau"
+      expect(address.care_of).to eq "Mustermann"
+      expect(address.street).to eq "Musterstraße"
+      expect(address.street_no).to eq "123"
+      expect(address.zip_code).to eq "12345"
+      expect(address.city).to eq "Hamburg"
+      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
+  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, affiliate_id: nil).
         and_return("data" => {})
@@ -63,10 +66,11 @@ describe Shipcloud::Address do
     end
   end
 
-  describe '.find' do
-    it 'makes a new GET request using the correct API endpoint to receive a specific address' do
+  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, affiliate_id: nil).and_return("id" => "123")
+        :get, "addresses/123", {}, api_key: nil, affiliate_id: nil
+      ).and_return("id" => "123")
 
       Shipcloud::Address.find("123")
     end
@@ -80,8 +84,8 @@ describe Shipcloud::Address do
     end
   end
 
-  describe '.update' do
-    it 'makes a new PUT request using the correct API endpoint' do
+  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, affiliate_id: nil
       ).and_return("data" => {})
@@ -98,15 +102,15 @@ describe Shipcloud::Address do
     end
   end
 
-  describe '.all' do
-    it 'makes a new Get request using the correct API endpoint' do
+  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, affiliate_id: nil).and_return([])
 
       Shipcloud::Address.all
     end
 
-    it 'returns a list of Address objects' do
+    it "returns a list of Address objects" do
       stub_addresses_request
 
       addresses = Shipcloud::Address.all
@@ -127,6 +131,28 @@ describe Shipcloud::Address 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, "addresses/123", { street: "Mittelweg" }, api_key: nil, affiliate_id: nil
+      ).and_return("data" => {})
+
+      address = Shipcloud::Address.new(id: "123")
+
+      address.update(street: "Mittelweg")
+    end
+
+    it "uses 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" => {})
+
+      address = Shipcloud::Address.new(id: "123")
+
+      address.update({ street: "Mittelweg" }, affiliate_id: "affiliate_id")
+    end
+  end
+
   def stub_addresses_request(affiliate_id: nil)
     allow(Shipcloud).to receive(:request).
       with(:get, "addresses", {}, api_key: nil, affiliate_id: affiliate_id).
@@ -144,7 +170,7 @@ describe Shipcloud::Address do
             "city" => "Musterstadt",
             "state" => "",
             "country" => "DE",
-            "phone" => ""
+            "phone" => "",
           },
           {
             "id" => "7ea2a290-b456-4ecf-9010-e82b3da298f0",
@@ -158,9 +184,9 @@ describe Shipcloud::Address do
             "city" => "Musterstadt",
             "state" => "",
             "country" => "DE",
-            "phone" => ""
-          }
-        ]
+            "phone" => "",
+          },
+        ],
       )
   end