shipcloud 0.6.0 → 0.11.0

data/spec/shipcloud/shipment_spec.rb

@@ -18,7 +18,36 @@ describe Shipcloud::Shipment do
         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
 
@@ -42,41 +71,119 @@ describe Shipcloud::Shipment do
       expect(shipment.package[:length]).to eq 40
       expect(shipment.package[:width]).to eq 20
       expect(shipment.package[:height]).to eq 20
+
+      expect(shipment.pickup[:pickup_time][:earliest]).to eq "2015-09-15T09:00:00+02:00"
+      expect(shipment.pickup[:pickup_time][:latest]).to eq "2015-09-15T18:00:00+02:00"
+      expect(shipment.pickup[:pickup_address][:company]).to eq "Sender Ltd."
+      expect(shipment.pickup[:pickup_address][:first_name]).to eq "Jane"
+      expect(shipment.pickup[:pickup_address][:last_name]).to eq "Doe"
+      expect(shipment.pickup[:pickup_address][:street]).to eq "Musterstraße"
+      expect(shipment.pickup[:pickup_address][:street_no]).to eq "42"
+      expect(shipment.pickup[:pickup_address][:zip_code]).to eq "54321"
+      expect(shipment.pickup[:pickup_address][:city]).to eq "Musterstadt"
+      expect(shipment.pickup[:pickup_address][:country]).to eq "DE"
+
+      expect(shipment.customs_declaration[:id]).to eq "123456"
+      expect(shipment.customs_declaration[:contents_type]).to eq "commercial_goods"
+    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
     it "makes a new POST request using the correct API endpoint" do
-      Shipcloud.should_receive(:request).with(:post, "shipments", valid_attributes).and_return("data" => {})
+      expect(Shipcloud).to receive(:request).
+        with(:post, "shipments", valid_attributes, api_key: nil, affiliate_id: nil).
+        and_return("data" => {})
       Shipcloud::Shipment.create(valid_attributes)
     end
+
+    it "use the affiliate ID provided for the request" do
+      expect(Shipcloud).to receive(:request).
+        with(
+          :post,
+          "shipments",
+          valid_attributes,
+          api_key: nil,
+          affiliate_id: "affiliate_id",
+        ).and_return("data" => {})
+      Shipcloud::Shipment.create(valid_attributes, affiliate_id: "affiliate_id")
+    end
   end
 
   describe ".find" do
     it "makes a new GET request using the correct API endpoint to receive a specific subscription" do
-      Shipcloud.should_receive(:request).with(:get, "shipments/123", {}).and_return("id" => "123")
+      expect(Shipcloud).to receive(:request).
+        with(:get, "shipments/123", {}, api_key: nil, affiliate_id: nil).
+        and_return("id" => "123")
       Shipcloud::Shipment.find("123")
     end
+
+    it "use the affiliate ID provided for the request" do
+      expect(Shipcloud).to receive(:request).with(
+        :get, "shipments/123", {}, api_key: nil, affiliate_id: "affiliate_id"
+      ).and_return("id" => "123")
+      Shipcloud::Shipment.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, "shipments/123", {:carrier => 'ups' }).and_return("data" => {})
-      Shipcloud::Shipment.update("123", {:carrier => 'ups' })
+      expect(Shipcloud).to receive(:request).
+        with(:put, "shipments/123", { carrier: "ups" }, api_key: nil, affiliate_id: nil).
+        and_return("data" => {})
+      Shipcloud::Shipment.update("123", carrier: "ups")
+    end
+
+    it "use 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" => {})
+      Shipcloud::Shipment.update("123", { carrier: "ups" }, affiliate_id: "affiliate_id")
     end
   end
 
   describe ".delete" do
     it "makes a new DELETE request using the correct API endpoint" do
-      Shipcloud.should_receive(:request).with(:delete, "shipments/123", {}).and_return(true)
+      expect(Shipcloud).to receive(:request).
+        with(:delete, "shipments/123", {}, api_key: nil, affiliate_id: nil).
+        and_return(true)
       Shipcloud::Shipment.delete("123")
     end
+
+    it "doesn't raise an error" do
+      stub_request(:delete, "https://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
+
+    it "use the affiliate ID provided for the request" do
+      expect(Shipcloud).to receive(:request).with(
+        :delete, "shipments/123", {}, api_key: nil, affiliate_id: "affiliate_id"
+      ).and_return(true)
+      Shipcloud::Shipment.delete("123", 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, "shipments", {}).
+        with(:get, "shipments", {}, api_key: nil, affiliate_id: nil).
         and_return("shipments" => [])
 
       Shipcloud::Shipment.all
@@ -104,16 +211,24 @@ describe Shipcloud::Shipment do
       }
 
       expect(Shipcloud).to receive(:request).
-        with(:get, "shipments", filter).
+        with(:get, "shipments", filter, api_key: nil, affiliate_id: nil).
         and_return("shipments" => shipments_array)
 
-      Shipcloud::Shipment.all(filter)
+      Shipcloud::Shipment.all(filter, api_key: nil)
+    end
+
+    it "use the affiliate ID provided for the request" do
+      expect(Shipcloud).to receive(:request).
+        with(:get, "shipments", {}, api_key: nil, affiliate_id: "affiliate_id").
+        and_return("shipments" => [])
+
+      Shipcloud::Shipment.all(affiliate_id: "affiliate_id")
     end
   end
 
-  def stub_shipments_requests
+  def stub_shipments_requests(affiliate_id: nil)
     allow(Shipcloud).to receive(:request).
-      with(:get, "shipments", {}).
+      with(:get, "shipments", {}, api_key: nil, affiliate_id: affiliate_id).
       and_return("shipments" => shipments_array)
   end
 

data/spec/shipcloud/tracker_spec.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+require "spec_helper"
+
+describe Shipcloud::PickupRequest do
+  valid_attributes = {
+    carrier: "ups",
+    carrier_tracking_no: "723558934169",
+  }
+
+  describe "#initialize" do
+    it "initializes all attributes correctly" do
+      tracker = Shipcloud::Tracker.new(valid_attributes)
+
+      expect(tracker.carrier).to eq "ups"
+      expect(tracker.carrier_tracking_no).to eq "723558934169"
+    end
+  end
+
+  describe ".all" do
+    it "makes a new GET request using the correct API endpoint" do
+      expect(Shipcloud).to receive(:request).
+        with(:get, "trackers", {}, api_key: nil, affiliate_id: nil).
+        and_return("trackers" => [])
+
+      Shipcloud::Tracker.all
+    end
+
+    it "returns a list of Tracker objects" do
+      stub_trackers_requests
+
+      trackers = Shipcloud::Tracker.all
+
+      trackers.each do |tracker|
+        expect(tracker).to be_a Shipcloud::Tracker
+      end
+    end
+
+    it "use the affiliate ID provided for the request" do
+      expect(Shipcloud).to receive(:request).
+        with(:get, "trackers", {}, api_key: nil, affiliate_id: "affiliate_id").
+        and_return("trackers" => [])
+
+      Shipcloud::Tracker.all(affiliate_id: "affiliate_id")
+    end
+  end
+
+  describe ".create" do
+    it "makes a new POST request using the correct API endpoint" do
+      expect(Shipcloud).to receive(:request).
+        with(:post, "trackers", valid_attributes, api_key: nil, affiliate_id: nil).
+        and_return("data" => {})
+
+      Shipcloud::Tracker.create(valid_attributes)
+    end
+
+    it "use the affiliate ID provided for the request" do
+      expect(Shipcloud).to receive(:request).
+        with(:post, "trackers", valid_attributes, api_key: nil, affiliate_id: "affiliate_id").
+        and_return("data" => {})
+
+      Shipcloud::Tracker.create(valid_attributes, affiliate_id: "affiliate_id")
+    end
+  end
+
+  describe ".find" do
+    it "makes a new GET request using the correct API endpoint to receive a specific tracker" do
+      expect(Shipcloud).to receive(:request).
+        with(:get, "trackers/123", {}, api_key: nil, affiliate_id: nil).
+        and_return("id" => "123")
+
+      Shipcloud::Tracker.find("123")
+    end
+
+    it "use the affiliate ID provided for the request" do
+      expect(Shipcloud).to receive(:request).
+        with(:get, "trackers/123", {}, api_key: nil, affiliate_id: "affiliate_id").
+        and_return("id" => "123")
+
+      Shipcloud::Tracker.find("123", affiliate_id: "affiliate_id")
+    end
+  end
+
+  def stub_trackers_requests(affiliate_id: nil)
+    allow(Shipcloud).to receive(:request).
+      with(:get, "trackers", {}, api_key: nil, affiliate_id: affiliate_id).
+      and_return("trackers" => trackers_array)
+  end
+
+  def trackers_array
+    [
+      {
+        "id" => "4a6922e2-09ad-4724-807c-7b4e572d3c6b",
+        "carrier_tracking_no" => "723558934169",
+        "status" => "registered",
+        "created_at" => "2015-07-21T09:35:23+02:00",
+        "to" => {
+          "company" => nil,
+          "first_name" => "Hans",
+          "last_name" => "Meier",
+          "care_of" => nil,
+          "street" => "Semmelweg",
+          "street_no" => "1",
+          "zip_code" => "12345",
+          "city" => "Hamburg",
+          "state" => nil,
+          "country" => "DE",
+        },
+        "tracking_status_updated_at" => nil,
+        "last_polling_at" => nil,
+        "next_polling_at" => "2015-07-21T09:35:23+02:00",
+        "shipment_id" => "123456",
+        "carrier" => "ups",
+        "tracking_events" => [],
+      },
+      {
+        "id" => "7b4e572d3c6b-4a6922e2-09ad-4724-807c",
+        "carrier_tracking_no" => "723558934170",
+        "status" => "registered",
+        "created_at" => "2015-07-20T09:35:23+02:00",
+        "to" => {
+          "company" => nil,
+          "first_name" => "Rita",
+          "last_name" => "Rose",
+          "care_of" => nil,
+          "street" => "Geranienweg",
+          "street_no" => "2",
+          "zip_code" => "23456",
+          "city" => "Berlin",
+          "state" => nil,
+          "country" => "DE",
+        },
+        "tracking_status_updated_at" => nil,
+        "last_polling_at" => nil,
+        "next_polling_at" => "2015-07-21T09:35:23+02:00",
+        "shipment_id" => "654321",
+        "carrier" => "dpd",
+        "tracking_events" => [],
+      },
+    ]
+  end
+end

data/spec/shipcloud/webhooks_spec.rb

@@ -2,6 +2,7 @@ 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"]
   }
@@ -11,29 +12,46 @@ describe Shipcloud::Webhook do
       webhook = Shipcloud::Webhook.new(valid_attributes)
       expect(webhook.url).to eq "https://example.com/webhook"
       expect(webhook.event_types).to eq ["shipment.tracking.delayed", "shipment.tracking.delivered"]
+      expect(webhook.id).to eq "583cfd8b-77c7-4447-a3a0-1568bb9cc553"
     end
   end
 
   describe ".create" do
     it "makes a new POST request using the correct API endpoint" do
-      Shipcloud.should_receive(:request).
-        with(:post, "webhooks", valid_attributes).
+      expect(Shipcloud).to receive(:request).
+        with(:post, "webhooks", valid_attributes, api_key: nil, affiliate_id: nil).
         and_return("data" => {})
       Shipcloud::Webhook.create(valid_attributes)
     end
+
+    it "use the affiliate ID provided for the request" do
+      expect(Shipcloud).to receive(:request).
+        with(:post, "webhooks", valid_attributes, api_key: nil, affiliate_id: "affiliate_id").
+        and_return("data" => {})
+      Shipcloud::Webhook.create(valid_attributes, affiliate_id: "affiliate_id")
+    end
   end
 
   describe ".find" do
     it "makes a new GET request using the correct API endpoint to receive a specific webhook" do
-      Shipcloud.should_receive(:request).with(:get, "webhooks/123", {}).and_return("id" => "123")
+      expect(Shipcloud).to receive(:request).
+        with(:get, "webhooks/123", {}, api_key: nil, affiliate_id: nil).
+        and_return("id" => "123")
       Shipcloud::Webhook.find("123")
     end
+
+    it "use the affiliate ID provided for the request" do
+      expect(Shipcloud).to receive(:request).
+        with(:get, "webhooks/123", {}, api_key: nil, affiliate_id: "affiliate_id").
+        and_return("id" => "123")
+      Shipcloud::Webhook.find("123", 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, "webhooks", {}).
+        with(:get, "webhooks", {}, api_key: nil, affiliate_id: nil).
         and_return("webhooks" => [])
 
       Shipcloud::Webhook.all
@@ -48,11 +66,57 @@ describe Shipcloud::Webhook do
         expect(webhook).to be_a Shipcloud::Webhook
       end
     end
+
+    it "use the affiliate ID provided for the request" do
+      expect(Shipcloud).to receive(:request).
+        with(:get, "webhooks", {}, api_key: nil, affiliate_id: "affiliate_id").
+        and_return("webhooks" => [])
+
+      Shipcloud::Webhook.all(affiliate_id: "affiliate_id")
+    end
+  end
+
+  describe ".delete" do
+    it "makes a DELETE request using the correct API endpoint" do
+      expect(Shipcloud).to receive(:request).
+        with(:delete, "webhooks/123", {}, api_key: nil, affiliate_id: nil).
+        and_return(true)
+      Shipcloud::Webhook.delete("123")
+    end
+
+    it "use the affiliate ID provided for the request" do
+      expect(Shipcloud).to receive(:request).
+        with(:delete, "webhooks/123", {}, api_key: nil, affiliate_id: "affiliate_id").
+        and_return(true)
+      Shipcloud::Webhook.delete("123", affiliate_id: "affiliate_id")
+    end
+  end
+
+  describe ".deactivated" do
+    let(:id) { "123" }
+
+    subject { Shipcloud::Webhook.find(id).deactivated }
+
+    before do
+      expect(Shipcloud).to receive(:request).
+        with(:get, "webhooks/#{id}", {}, api_key: nil, affiliate_id: nil).
+        and_return("id" => id, "deactivated" => deactivated)
+    end
+
+    context "when the webhook is deactivated" do
+      let(:deactivated) { true }
+      it { is_expected.to be true }
+    end
+
+    context "when the webhook is not deactivated" do
+      let(:deactivated) { false }
+      it { is_expected.to be false }
+    end
   end
 
-  def stub_webhooks_request
+  def stub_webhooks_request(affiliate_id: nil)
     allow(Shipcloud).to receive(:request).
-      with(:get, "webhooks", {}).
+      with(:get, "webhooks", {}, api_key: nil, affiliate_id: affiliate_id).
       and_return("webhooks" => webhooks_array)
   end