shipcloud 0.7.0 → 0.8.0

data/.travis.yml

@@ -5,10 +5,18 @@ rvm:
   - 2.1.7
   - 2.2.4
   - 2.3.0
-  - rbx-2
+matrix:
+  allow_failures:
+    - rvm: rbx-2
+  include:
+    - rvm: rbx-2
+      script: bundle exec rake spec
 notifications:
   flowdock:
     secure: fSZxX5z3bHWT8aCFKBFrDDt5o3Jb6EFWcm+pAcMabpfDHc4iktWuCUlSM405798TRdKdws1A2RncQGYiQyLbqNvtLz48dvj4BxgYW7P/vg0koN+I/H2MjpZeuIQ7BRSEJIq2sAYNVya+hSil+SPEBMTngJiP6VYG0dm6fFnRkyk=
 addons:
   code_climate:
     repo_token: 704eb62133d951ce460a6047a15a58e0a521aa20ec6a533fa7a37585f8a75602
+after_success:
+    - bundle exec codeclimate-test-reporter
+

data/CHANGELOG.md

@@ -1,11 +1,28 @@
 ## [Unreleased]
 ### Added
 
+### Changed
+
+### Deprecated
+
 ### Removed
 
-### Changed
+### Fixed
+
+### Security
+
+## [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

data/README.md

@@ -55,7 +55,7 @@ You can sign up for a developer account at *[shipcloud.io](http://www.shipcloud.
 
 ### 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(
@@ -74,9 +74,23 @@ 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
@@ -108,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/lib/shipcloud.rb

@@ -13,11 +13,15 @@ module Shipcloud
     "User-Agent" => "shipcloud-ruby v#{Shipcloud::VERSION}, API #{Shipcloud::API_VERSION}, #{RUBY_VERSION}, #{RUBY_PLATFORM}, #{RUBY_PATCHLEVEL}"
   }
 
+  DEFAULT_AFFILIATE_ID = "integration.shipcloud-ruby-gem.v#{Shipcloud::VERSION}".freeze
+
   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
@@ -46,9 +50,14 @@ module Shipcloud
     yield(configuration)
   end
 
+  def self.api_headers
+    API_HEADERS.merge(
+      "Affiliate-ID" => configuration.affiliate_id || DEFAULT_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

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

@@ -12,7 +12,7 @@ module Shipcloud
         connection.setup_https
         response = connection.request
         validate_response(response)
-        JSON.parse(response.body)
+        JSON.parse(response.body) unless response.body.nil?
       rescue JSON::ParserError
         raise ShipcloudError.new(response)
       end

data/lib/shipcloud/request/connection.rb

@@ -28,16 +28,21 @@ 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 =
+          case @info.http_method
+          when :post
+            Net::HTTP::Post.new(@info.url, Shipcloud.api_headers)
+          when :put
+            Net::HTTP::Put.new(@info.url, Shipcloud.api_headers)
+          when :delete
+            Net::HTTP::Delete.new(@info.url, Shipcloud.api_headers)
+          else
+            Net::HTTP::Get.new(
+              @info.path_with_params(@info.url, @info.data),
+              Shipcloud.api_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

data/lib/shipcloud/shipcloud_error.rb

@@ -26,6 +26,7 @@ module Shipcloud
       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
@@ -57,6 +58,7 @@ 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

data/lib/shipcloud/shipment.rb

@@ -4,7 +4,7 @@ module Shipcloud
     include Shipcloud::Operations::Update
     include Shipcloud::Operations::All
 
-    attr_accessor :from, :to, :carrier, :package, :reference_number
+    attr_accessor :from, :to, :carrier, :package, :reference_number, :metadata
     attr_reader :id, :created_at, :carrier_tracking_no, :tracking_url, :label_url, :packages, :price
 
     def self.index_response_root

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.7.0"
+  VERSION = "0.8.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 :url, :event_types, :deactivated
 
     def self.index_response_root
       "webhooks"

data/spec/shipcloud/pickup_request_spec.rb

@@ -0,0 +1,123 @@
+require "spec_helper"
+
+describe Shipcloud::PickupRequest do
+  valid_attributes = {
+    carrier: "dpd",
+    pickup_time: {
+      earliest: "2015-09-15T09:00:00+02:00",
+      latest: "2015-09-15T18:00:00+02:00"
+    },
+    shipments: [
+      { id: "abc_123" }
+    ]
+  }
+
+  valid_attributes_with_pickup_address = {
+    carrier: "dpd",
+    pickup_time: {
+      earliest: "2015-09-15T09:00:00+02:00",
+      latest: "2015-09-15T18:00:00+02:00"
+    },
+    pickup_address: {
+      company: "Muster-Company",
+      first_name: "Max",
+      last_name: "Mustermann",
+      street: "Musterstraße",
+      street_no: "42",
+      zip_code: "54321",
+      city: "Musterstadt",
+      country: "DE",
+      phone: "555-555"
+    },
+    shipments: [
+      { id: "abc_123" }
+    ]
+  }
+
+  describe "#initialize" do
+    it "initializes all attributes correctly" do
+      pickup_request = Shipcloud::PickupRequest.new(valid_attributes_with_pickup_address)
+
+      expect(pickup_request.carrier).to eq "dpd"
+      expect(pickup_request.pickup_time[:earliest]).to eq "2015-09-15T09:00:00+02:00"
+      expect(pickup_request.pickup_time[:latest]).to eq "2015-09-15T18:00:00+02:00"
+      expect(pickup_request.pickup_address[:company]).to eq "Muster-Company"
+      expect(pickup_request.pickup_address[:first_name]).to eq "Max"
+      expect(pickup_request.pickup_address[:last_name]).to eq "Mustermann"
+      expect(pickup_request.pickup_address[:street]).to eq "Musterstraße"
+      expect(pickup_request.pickup_address[:street_no]).to eq "42"
+      expect(pickup_request.pickup_address[:zip_code]).to eq "54321"
+      expect(pickup_request.pickup_address[:country]).to eq "DE"
+      expect(pickup_request.pickup_address[:phone]).to eq "555-555"
+      expect(pickup_request.shipments).to eq [{ id: "abc_123" }]
+    end
+  end
+
+  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).
+        and_return("data" => {})
+
+      Shipcloud::PickupRequest.create(valid_attributes)
+    end
+
+    it "returns pickup request id" do
+      allow(Shipcloud).to receive(:request).
+        and_return(
+          "id" => "123456",
+          "carrier_pickup_number" => "abcdef",
+          "carrier" => "dpd",
+          "pickup_time" => {
+            "earliest" => "2015-09-15T09:00:00+02:00",
+            "latest" => "2015-09-15T18:00:00+02:00"
+          }
+        )
+
+      pickup_request = Shipcloud::PickupRequest.create(valid_attributes)
+
+      expect(pickup_request.id).to eq "123456"
+      expect(pickup_request.carrier_pickup_number).to eq "abcdef"
+    end
+
+    it "returns a pickup_address" do
+      allow(Shipcloud).to receive(:request).
+        and_return(
+          "id" => "123456",
+          "carrier_pickup_number" => "abcdef",
+          "carrier" => "dpd",
+          "pickup_time" => {
+            "earliest" => "2015-09-15T09:00:00+02:00",
+            "latest" => "2015-09-15T18:00:00+02:00"
+          },
+          "pickup_address" => {
+            "id" => "522a7cb1-d6c8-418c-ac26-011127ab5bbe",
+            "company" => "Muster-Company",
+            "first_name" => "Max",
+            "last_name" => "Mustermann",
+            "street" => "Musterstraße",
+            "street_no" => "42",
+            "zip_code" => "54321",
+            "city" => "Musterstadt",
+            "country" => "DE",
+            "phone" => "555-555"
+          }
+        )
+
+      pickup_request = Shipcloud::PickupRequest.create(valid_attributes_with_pickup_address)
+
+      expect(pickup_request.pickup_address).to eq(
+        "id" => "522a7cb1-d6c8-418c-ac26-011127ab5bbe",
+        "company" => "Muster-Company",
+        "first_name" => "Max",
+        "last_name" => "Mustermann",
+        "street" => "Musterstraße",
+        "street_no" => "42",
+        "zip_code" => "54321",
+        "city" => "Musterstadt",
+        "country" => "DE",
+        "phone" => "555-555"
+      )
+    end
+  end
+end

data/spec/shipcloud/request/info_spec.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+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", {})
+
+      expect(info.url).to eq "/v1/shipments"
+    end
+  end
+
+  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", {})
+      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")
+      path = info.path_with_params(info.url, info.data)
+
+      expect(path).to eq "/v1/shipments?foo=bar"
+    end
+  end
+end

data/spec/shipcloud/shipment_spec.rb

@@ -18,6 +18,15 @@ describe Shipcloud::Shipment do
         length: 40,
         width: 20,
         height: 20
+      },
+      metadata: {
+        product: {
+          name: "foo"
+        },
+        category: {
+          id: "123456",
+          name: "bar"
+        }
       }
     }
   end
@@ -43,6 +52,20 @@ describe Shipcloud::Shipment do
       expect(shipment.package[:width]).to eq 20
       expect(shipment.package[:height]).to eq 20
     end
+
+    it "initializes the metadata correctly" do
+      metadata = {
+        category: {
+          id: "123456",
+          name: "bar"
+        },
+        product: {
+          name: "foo"
+        }
+      }
+
+      expect(shipment.metadata).to eq metadata
+    end
   end
 
   describe ".create" do
@@ -75,6 +98,13 @@ describe Shipcloud::Shipment do
         and_return(true)
       Shipcloud::Shipment.delete("123")
     end
+
+    it "doesn't raise an error" do
+      stub_request(:delete, "https://your-api-key:@api.shipcloud.io/v1/shipments/123").
+        to_return(status: 204, body: "")
+      expect { Shipcloud::Shipment.delete("123", api_key: "your-api-key") }.
+        to_not raise_error
+    end
   end
 
   describe ".all" do