shipcloud 0.6.0 → 0.11.0

data/.ruby-version

@@ -0,0 +1 @@
+2.6.6

data/.travis.yml

@@ -1,15 +1,27 @@
 sudo: false
 language: ruby
+cache: bundler
 rvm:
-  - 2.0.0
-  - 2.1.7
-  - 2.2.4
-  - 2.3.0
-  - jruby-9.0.0.0
-  - rbx-2
+  - 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/CHANGELOG.md

@@ -1,3 +1,73 @@
+## [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.
+
+### Changed
+
+### Deprecated
+
+### Removed
+
+### Fixed
+
+### Security
+
+## [Unreleased]
+### Added
+
+### Changed
+
+### Deprecated
+
+### Removed
+
+### Fixed
+
+### 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
+- Add attr_reader for `id` to class `Shipcloud::Webhook` to be able to get the id of a created webhook
+- Add attr_reader for `customs_declaration` to class `Shipcloud::Shipment` to be able to get the `customs_declaration` of a created shipment
+
+## [0.8.0] - 2017-07-03
+### Added
+- Add attribute ```metadata``` to class ```Shipcloud::Shipment``` in order to transmit JSON data (#16).
+- Add resource pickup_request in order to submit pickup request to shipcloud
+- Add attribute ```pickup_address``` to class ```Shipcloud::PickupRequest``` to submit an alternative address for pickup request to shipcloud
+- Add ```delete``` operation for ```webhook``` resource
+- Add attribute ```deactivated``` to class ```Shipcloud::Webhook```
+- Add ```affiliate_id``` to ```Shipcloud::Configuration``` and submit it (or a default affiliate id) via API headers to shipcloud
+- Add class ```Shipcloud::Tracker``` with create, find, and index operations
+
+### Fixed
+- Parse response only when it is not empty
+
+## [0.7.0] - 2016-01-21
+### Added
+- Add the possibility to specify the api key on every request. (#8)
+- Add some more specific error classes ```Shipcloud::ClientError```,```Shipcloud::ServerError```,
+  ```Shipcloud::InvalidRequestError```, ```Shipcloud::TooManyRequests``` and ```Shipcloud::NotFoundError``` (#11).
+- Access to the entire response and error descriptions from the error object (#11).
+
+### Removed
+- Removed the following ruby versions from travis-ci test runs:
+  - jruby-9.0.0.0
+- Removed ```Shipcloud::APIError```  in preference to more granular error classes (#11).
+
+### Changed
+
+### Fixed
+
 ## [0.6.0] - 2016-01-21
 ### Added
 - This CHANGELOG file (Following "[Keep a CHANGELOG](http://keepachangelog.com/)")

data/README.md

@@ -1,9 +1,11 @@
-[![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) [![Dependency Status](https://gemnasium.com/shipcloud/shipcloud-ruby.svg)](https://gemnasium.com/shipcloud/shipcloud-ruby)
+[![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)
 
 # shipcloud
 
 A Ruby wrapper for the shipcloud API
 
+We have dropped the support of jruby-9, because there is an issue with mixing hash and keyword arguments (https://github.com/jruby/jruby/issues/3138). When this issue is fixed, we will support jruby-9 again.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -20,27 +22,42 @@ Or install it yourself as:
 
 ## Usage
 
-Before using the shipcloud API, you need to set the API access key:
+Before using the shipcloud API, you may want to set the API access key.
 
-```
+```ruby
 Shipcloud.api_key = 'your-api-key-goes-here'
 ```
 
 Since Version 0.4.0, you can also do this via a configuration block, e.g. in an initializer:
 
-```
+```ruby
 Shipcloud.configure do |config|
   config.api_key = 'your-api-key-goes-here'
 end
 ```
 
+You can also pass the API key with each request:
+```ruby
+ Shipcloud::Shipment.create(
+   {
+     carrier: 'ups',
+     from: from-address-params,
+     to: to-address-params,
+     package: package-params,
+     create_shipping_label: true
+   },
+  api_key: "your-api-key"
+ )
+```
+If you pass in the ```api_key``` option, the value will be used as API key for the current request, even if you have set the ```Shipcloud.api_key``` before.
+
 You can sign up for a developer account at *[shipcloud.io](http://www.shipcloud.io)*
 
 ### Create a new shipment
 
-To create a new Shipment on the shipclod platform, you need to provide the name of the carrier, to- and from-address, and the package dimensions.
+To create a new Shipment on the shipcloud platform, you need to provide the name of the carrier, to- and from-address, and the package dimensions.
 For details, see *[shipcloud API documentation on Shipments](http://developers.shipcloud.io/reference/#shipments)*
-```
+```ruby
 Shipcloud::Shipment.create(
     carrier: 'ups',
     from: from-address-params,
@@ -52,14 +69,28 @@ Shipcloud::Shipment.create(
 
 `Shipment#create` will return shipping label and tracking information, encapsulated in a `Shipcloud::Shipment` object:
 
-```
+```ruby
 shipment = Shipcloud::Shipment.create(...) # parameters ommitted
 shipment.tracking_url # -> http://track.shipcloud.io/uzdgu22z3ed12
 ```
 
+### Get a list of shipments
+
+You can get a list of all shipments from the shipcloud platform. Shipments can be filtered by providing optional parameters. For more information and a list of valid parameters see *[shipcloud API documentation on Shipments Index](https://developers.shipcloud.io/reference/#getting-a-list-of-shipments)*
+
+```ruby
+Shipcloud::Shipment.all(
+  carrier: 'ups',
+  per_page: 25,
+  page: 2
+)
+```
+
+`Shipment#all` will return an array of `Shipcloud::Shipment` objects, matching the given parameters.
+
 ### Get a shipment quote
 
-To get a shipment qoute from the shipclod platform, you need to provide the name of the carrier, the service, to- and from-address, and the package dimensions.
+To get a shipment qoute from the shipcloud platform, you need to provide the name of the carrier, the service, to- and from-address, and the package dimensions.
 For details, see *[shipcloud API documentation on shipment quotes](https://developers.shipcloud.io/reference/#shipment-quotes)*
 
 ```ruby
@@ -91,6 +122,43 @@ shipment_quote = Shipcloud::ShipmentQuote.create(
 shipment_quote.price # => 6.2
 ```
 
+### Create a pickup request
+
+To request parcels being picked up, you need to provide the carrier name and the time (earliest and latest) your shipments shall be fetched.
+
+```ruby
+pickup_request = Shipcloud::PickupRequest.create(
+  carrier: 'dpd',
+  pickup_time: {
+    earliest: "2016-04-04T09:00:00+02:00",
+    latest: "2016-04-04T18:00:00+02:00"
+  }
+)
+
+pickup_request.id # => "dje892dj20d2odj20"
+pickup_request.carrier_pickup_number # => "12345"
+```
+
+You may also provide a list of shipment ids to specify only certain shipments to be included in the pickup request.
+
+```ruby
+pickup_request = Shipcloud::PickupRequest.create(
+  carrier: 'dpd',
+  pickup_time: {
+    earliest: "2016-04-04T09:00:00+02:00",
+    latest: "2016-04-04T18:00:00+02:00"
+  },
+  shipments: [
+    { id: "abc_123"}
+  ]
+)
+
+pickup_request.id # => "dje892dj20d2odj20"
+pickup_request.carrier_pickup_number # => "12345"
+```
+
+
+
 ## Contributing
 
 1. Fork it

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/install-cc-test-reporter.sh

@@ -0,0 +1,4 @@
+#!/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

data/lib/shipcloud.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
 require "net/http"
 require "net/https"
 require "json"
 require "shipcloud/version"
+require "shipcloud/shipcloud_error"
 
 module Shipcloud
   API_VERSION = "v1"
@@ -9,16 +11,19 @@ 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
 
-  @@api_key = nil
+  DEFAULT_AFFILIATE_ID = "integration.shipcloud-ruby-gem.v#{Shipcloud::VERSION}"
 
   autoload :Base,           "shipcloud/base"
   autoload :Shipment,       "shipcloud/shipment"
   autoload :Carrier,        "shipcloud/carrier"
   autoload :Address,        "shipcloud/address"
+  autoload :PickupRequest,  "shipcloud/pickup_request"
   autoload :ShipmentQuote,  "shipcloud/shipment_quote"
+  autoload :Tracker,        "shipcloud/tracker"
   autoload :Webhook,        "shipcloud/webhook"
 
   module Operations
@@ -33,32 +38,34 @@ module Shipcloud
     autoload :Base,         "shipcloud/request/base"
     autoload :Connection,   "shipcloud/request/connection"
     autoload :Info,         "shipcloud/request/info"
-    autoload :Validator,    "shipcloud/request/validator"
   end
 
-  class ShipcloudError < StandardError; end
-  class AuthenticationError < ShipcloudError; end
-  class APIError            < ShipcloudError; end
-
   class << self
-    attr_accessor :configuration
+    attr_writer :configuration
   end
 
+  # rubocop:disable Naming/MemoizedInstanceVariableName
   def self.configuration
     @configuration ||= Configuration.new
   end
+  # rubocop:enable Naming/MemoizedInstanceVariableName
 
   def self.configure
     yield(configuration)
   end
 
+  def self.api_headers
+    API_HEADERS.merge(
+      "Affiliate-ID" => affiliate_id,
+    )
+  end
 
   class Configuration
-    attr_accessor :api_key, :api_base, :use_ssl, :debug
+    attr_accessor :affiliate_id, :api_key, :api_base, :use_ssl, :debug
 
     def initialize
       @api_key = nil
-      @api_base = 'api.shipcloud.io'
+      @api_base = "api.shipcloud.io"
       @use_ssl = true
       @debug = false
     end
@@ -75,18 +82,25 @@ module Shipcloud
   #
   # @param [String] api_key The api key
   def self.api_key=(api_key)
-    @@api_key = api_key
     configuration.api_key = api_key
   end
 
+  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
   # @param [String] api_url The API url to use
   # @param [Hash] data The data to send, e.g. used when creating new objects.
+  # @param [String] optional api_key The api key. If no api key is given, Shipcloud.api_key will
+  # be used for the request
   # @return [Array] The parsed JSON response.
-  def self.request(http_method, api_url, data)
-    info = Request::Info.new(http_method, api_url, data)
+  def self.request(http_method, api_url, data, api_key: nil, affiliate_id: nil)
+    api_key ||= Shipcloud.api_key
+    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/address.rb

@@ -3,8 +3,9 @@ module Shipcloud
     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
 
     def self.base_url
       "#{class_name.downcase}es"

data/lib/shipcloud/operations/all.rb

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

@@ -5,8 +5,16 @@ module Shipcloud
         # Creates a new object
         #
         # @param [Hash] attributes The attributes of the created object
-        def create(attributes)
-          response = Shipcloud.request(:post, base_url, attributes)
+        # @param \[String\] optional api_key The api key. If no api key is given, Shipcloud.api_key
+        # will be used for the request
+        def create(attributes, api_key: nil, 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

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