shipcloud 0.11.0 → 0.12.0

data/spec/shipcloud/carrier_spec.rb

@@ -1,35 +1,36 @@
-require 'spec_helper'
+# frozen_string_literal: true
+require "spec_helper"
 
 describe Shipcloud::Carrier do
-  describe '#initialize' do
-    it 'initializes all attributes correctly' do
+  describe "#initialize" do
+    it "initializes all attributes correctly" do
       valid_attributes = {
-        name: 'bogus',
-        display_name: 'Bogus Carrier',
-        services: %w(
-          standard,
-          returns,
-          one_day,
-          one_day_early
-        )
+        name: "bogus",
+        display_name: "Bogus Carrier",
+        services: [
+          "standard",
+          "returns",
+          "one_day",
+          "one_day_early",
+        ],
       }
       carrier = Shipcloud::Carrier.new(valid_attributes)
 
-      expect(carrier.name).to eq 'bogus'
-      expect(carrier.display_name).to eq 'Bogus Carrier'
-      expect(carrier.services).to eq %w(standard, returns, one_day, one_day_early)
+      expect(carrier.name).to eq "bogus"
+      expect(carrier.display_name).to eq "Bogus Carrier"
+      expect(carrier.services).to eq ["standard", "returns", "one_day", "one_day_early"]
     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, "carriers", {}, api_key: nil, affiliate_id: nil).and_return([])
 
       Shipcloud::Carrier.all
     end
 
-    it 'returns a list of Carrier objects' do
+    it "returns a list of Carrier objects" do
       stub_carriers_request
 
       carriers = Shipcloud::Carrier.all
@@ -39,31 +40,31 @@ describe Shipcloud::Carrier do
       end
     end
 
-    it 'initializes the Carrier objects correctly' do
+    it "initializes the Carrier objects correctly" do
       stub_carriers_request
       allow(Shipcloud::Carrier).to receive(:new)
 
       Shipcloud::Carrier.all
 
-      expect(Shipcloud::Carrier).to have_received(:new)
-        .with(
-          'name' => 'carrier_1',
-          'display_name' => 'Carrier 1',
-          'services' => %w(
-            standard,
-            returns,
-            one_day,
-            one_day_early
-          )
+      expect(Shipcloud::Carrier).to have_received(:new).
+        with(
+          "name" => "carrier_1",
+          "display_name" => "Carrier 1",
+          "services" => [
+            "standard",
+            "returns",
+            "one_day",
+            "one_day_early",
+          ],
         )
-      expect(Shipcloud::Carrier).to have_received(:new)
-        .with(
-          'name' => 'carrier_2',
-          'display_name' => 'Carrier 2',
-          'services' => %w(
-            standard,
-            returns
-          )
+      expect(Shipcloud::Carrier).to have_received(:new).
+        with(
+          "name" => "carrier_2",
+          "display_name" => "Carrier 2",
+          "services" => [
+            "standard",
+            "returns",
+          ],
         )
     end
 
@@ -81,24 +82,24 @@ describe Shipcloud::Carrier do
       and_return(
         [
           {
-            'name' => 'carrier_1',
-            'display_name' => 'Carrier 1',
-            'services' => %w(
-              standard,
-              returns,
-              one_day,
-              one_day_early
-            )
+            "name" => "carrier_1",
+            "display_name" => "Carrier 1",
+            "services" => [
+              "standard",
+              "returns",
+              "one_day",
+              "one_day_early",
+            ],
           },
           {
-            'name' => 'carrier_2',
-            'display_name' => 'Carrier 2',
-            'services' => %w(
-              standard,
-              returns
-            )
-          }
-        ]
+            "name" => "carrier_2",
+            "display_name" => "Carrier 2",
+            "services" => [
+              "standard",
+              "returns",
+            ],
+          },
+        ],
       )
   end
 end

data/spec/shipcloud/order_spec.rb

@@ -0,0 +1,188 @@
+# frozen_string_literal: true
+require "spec_helper"
+
+describe Shipcloud::Order do
+  describe "#initialize" do
+    it "initializes all attributes correctly" do
+      valid_attributes = {
+        external_order_id: "external_order_id",
+        external_customer_id: "external_customer_id",
+        refundable_until: "refundable_until",
+        total_weight: 12.34,
+        refund_deduction_amount: 4.32,
+        delivery_address: {
+          id: "adress_id",
+        },
+        order_line_items: [
+          {
+            id: "order_line_item_id",
+          },
+        ],
+      }
+      order = Shipcloud::Order.new(valid_attributes)
+
+      expect(order.external_order_id).to eq "external_order_id"
+      expect(order.external_customer_id).to eq "external_customer_id"
+      expect(order.refundable_until).to eq "refundable_until"
+      expect(order.total_weight).to eq 12.34
+      expect(order.refund_deduction_amount).to eq 4.32
+      expect(order.delivery_address).to eq(id: "adress_id")
+      expect(order.order_line_items).to eq [
+        { id: "order_line_item_id" },
+      ]
+    end
+  end
+
+  describe ".all" do
+    it "executes a GET request to the 'orders' API endpoint" do
+      expect(Shipcloud).to receive(:request).
+        with(:get, "orders", {}, api_key: nil, affiliate_id: nil).
+        and_return([])
+
+      Shipcloud::Order.all
+    end
+
+    it "returns a list of Order objects" do
+      stub_orders_request
+
+      orders = Shipcloud::Order.all
+
+      orders.each do |order|
+        expect(order).to be_a Shipcloud::Order
+      end
+    end
+
+    it "returns a filtered list of order objects when using filter parameters" do
+      filter = {
+        "external_customer_id" => "external_customer_id",
+        "external_order_id" => "external_order_id",
+      }
+
+      expect(Shipcloud).to receive(:request).
+        with(:get, "orders", filter, api_key: nil, affiliate_id: nil).
+        and_return(orders_array)
+
+      Shipcloud::Order.all(filter, api_key: nil)
+    end
+
+    it "uses the affiliate ID provided for the request" do
+      expect(Shipcloud).to receive(:request).
+        with(:get, "orders", {}, api_key: nil, affiliate_id: "affiliate_id").
+        and_return([])
+
+      Shipcloud::Order.all(affiliate_id: "affiliate_id")
+    end
+  end
+
+  describe ".find" do
+    it "executes a GET request to the 'orders/:id' API endpoint" do
+      expect(Shipcloud).to receive(:request).
+        with(:get, "orders/order_id", {}, api_key: nil, affiliate_id: nil).
+        and_return("id" => "order_id")
+
+      Shipcloud::Order.find("order_id")
+    end
+  end
+
+  describe ".create" do
+    it "executes a POST request to the 'orders' API endpoint" do
+      expect(Shipcloud).to receive(:request).
+        with(:post, "orders", valid_attributes, api_key: nil, affiliate_id: nil).
+        and_return("data" => {})
+
+      Shipcloud::Order.create(valid_attributes)
+    end
+
+    it "uses the affiliate ID provided for the request" do
+      expect(Shipcloud).to receive(:request).
+        with(
+          :post,
+          "orders",
+          valid_attributes,
+          api_key: nil,
+          affiliate_id: "affiliate_id",
+        ).and_return("data" => {})
+
+      Shipcloud::Order.create(valid_attributes, affiliate_id: "affiliate_id")
+    end
+  end
+
+  describe ".delete" do
+    it "executes a DELETE request to the 'orders/:id' API endpoint" do
+      expect(Shipcloud).to receive(:request).
+        with(:delete, "orders/123", {}, api_key: nil, affiliate_id: nil).
+        and_return(true)
+
+      Shipcloud::Order.delete("123")
+    end
+
+    it "does not raise an error" do
+      stub_request(:delete, "https://api.shipcloud.io/v1/orders/123").
+        to_return(status: 204, body: "")
+
+      expect { Shipcloud::Order.delete("123", api_key: "your-api-key") }.
+        to_not raise_error
+    end
+
+    it "uses the affiliate ID provided for the request" do
+      expect(Shipcloud).to receive(:request).with(
+        :delete, "orders/123", {}, api_key: nil, affiliate_id: "affiliate_id"
+      ).and_return(true)
+
+      Shipcloud::Order.delete("123", affiliate_id: "affiliate_id")
+    end
+  end
+
+  def stub_orders_request(params: {}, affiliate_id: nil)
+    allow(Shipcloud).to receive(:request).
+      with(:get, "orders", params, api_key: nil, affiliate_id: affiliate_id).
+      and_return(orders_array)
+  end
+
+  def orders_array
+    [
+      {
+        id: "order_id",
+        external_order_id: "external_order_id",
+        external_customer_id: "external_customer_id",
+        delivery_address: {
+          id: "adress_id",
+        },
+        order_line_items: [
+          {
+            id: "order_line_item_id",
+          },
+        ],
+      },
+      {
+        id: "order_id1",
+        external_order_id: "external_order_id1",
+        external_customer_id: "external_customer_id1",
+        delivery_address: {
+          id: "adress_id1",
+        },
+        order_line_items: [
+          {
+            id: "order_line_item_id1",
+          },
+        ],
+      },
+    ]
+  end
+
+  def valid_attributes
+    {
+      id: "order_id",
+      external_order_id: "external_order_id",
+      external_customer_id: "external_customer_id",
+      delivery_address: {
+        id: "adress_id",
+      },
+      order_line_items: [
+        {
+          id: "order_line_item_id",
+        },
+      ],
+    }
+  end
+end

data/spec/shipcloud/pickup_request_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "spec_helper"
 
 describe Shipcloud::PickupRequest do
@@ -5,18 +6,18 @@ describe Shipcloud::PickupRequest do
     carrier: "dpd",
     pickup_time: {
       earliest: "2015-09-15T09:00:00+02:00",
-      latest: "2015-09-15T18:00:00+02:00"
+      latest: "2015-09-15T18:00:00+02:00",
     },
     shipments: [
-      { id: "abc_123" }
-    ]
+      { 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"
+      latest: "2015-09-15T18:00:00+02:00",
     },
     pickup_address: {
       company: "Muster-Company",
@@ -27,11 +28,11 @@ describe Shipcloud::PickupRequest do
       zip_code: "54321",
       city: "Musterstadt",
       country: "DE",
-      phone: "555-555"
+      phone: "555-555",
     },
     shipments: [
-      { id: "abc_123" }
-    ]
+      { id: "abc_123" },
+    ],
   }
 
   describe "#initialize" do
@@ -70,8 +71,8 @@ describe Shipcloud::PickupRequest do
           "carrier" => "dpd",
           "pickup_time" => {
             "earliest" => "2015-09-15T09:00:00+02:00",
-            "latest" => "2015-09-15T18:00:00+02:00"
-          }
+            "latest" => "2015-09-15T18:00:00+02:00",
+          },
         )
 
       pickup_request = Shipcloud::PickupRequest.create(valid_attributes)
@@ -88,7 +89,7 @@ describe Shipcloud::PickupRequest do
           "carrier" => "dpd",
           "pickup_time" => {
             "earliest" => "2015-09-15T09:00:00+02:00",
-            "latest" => "2015-09-15T18:00:00+02:00"
+            "latest" => "2015-09-15T18:00:00+02:00",
           },
           "pickup_address" => {
             "id" => "522a7cb1-d6c8-418c-ac26-011127ab5bbe",
@@ -100,8 +101,8 @@ describe Shipcloud::PickupRequest do
             "zip_code" => "54321",
             "city" => "Musterstadt",
             "country" => "DE",
-            "phone" => "555-555"
-          }
+            "phone" => "555-555",
+          },
         )
 
       pickup_request = Shipcloud::PickupRequest.create(valid_attributes_with_pickup_address)
@@ -116,7 +117,7 @@ describe Shipcloud::PickupRequest do
         "zip_code" => "54321",
         "city" => "Musterstadt",
         "country" => "DE",
-        "phone" => "555-555"
+        "phone" => "555-555",
       )
     end
 

data/spec/shipcloud/request/base_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "spec_helper"
 
 describe Shipcloud::Request::Base do
@@ -5,9 +6,9 @@ describe Shipcloud::Request::Base do
     it "checks for an api key" do
       info = Shipcloud::Request::Info.new(:get, "shipments", nil, {}, "affiliate_id")
 
-      expect{
+      expect do
         Shipcloud::Request::Base.new(info).perform
-      }.to raise_error Shipcloud::AuthenticationError
+      end.to raise_error Shipcloud::AuthenticationError
     end
 
     it "performs an https request and returns a response hash" do

data/spec/shipcloud/request/connection_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "spec_helper"
 
 describe Shipcloud::Request::Connection do

data/spec/shipcloud/shipcloud_error_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "spec_helper"
 
 describe Shipcloud::ShipcloudError do
@@ -5,7 +6,7 @@ describe Shipcloud::ShipcloudError do
     context "with a response with status code 400" do
       it "returns a Shipcloud::InvalidRequestError" do
         expect(Shipcloud::ShipcloudError.from_response(build_response(status_code: 400))).to be_a(
-          Shipcloud::InvalidRequestError
+          Shipcloud::InvalidRequestError,
         )
       end
     end
@@ -13,7 +14,7 @@ describe Shipcloud::ShipcloudError do
     context "with a response with status code 422" do
       it "returns a Shipcloud::InvalidRequestError" do
         expect(Shipcloud::ShipcloudError.from_response(build_response(status_code: 422))).to be_a(
-          Shipcloud::InvalidRequestError
+          Shipcloud::InvalidRequestError,
         )
       end
     end
@@ -21,7 +22,7 @@ describe Shipcloud::ShipcloudError do
     context "with a response with status code 401" do
       it "returns a Shipcloud::AuthenticationError" do
         expect(Shipcloud::ShipcloudError.from_response(build_response(status_code: 401))).to be_a(
-          Shipcloud::AuthenticationError
+          Shipcloud::AuthenticationError,
         )
       end
     end
@@ -29,7 +30,7 @@ describe Shipcloud::ShipcloudError do
     context "with a response with status code 402" do
       it "returns a Shipcloud::TooManyRequests" do
         expect(Shipcloud::ShipcloudError.from_response(build_response(status_code: 402))).to be_a(
-          Shipcloud::TooManyRequests
+          Shipcloud::TooManyRequests,
         )
       end
     end
@@ -37,7 +38,7 @@ describe Shipcloud::ShipcloudError do
     context "with a response with status code 404" do
       it "returns a Shipcloud::NotFoundError" do
         expect(Shipcloud::ShipcloudError.from_response(build_response(status_code: 404))).to be_a(
-          Shipcloud::NotFoundError
+          Shipcloud::NotFoundError,
         )
       end
     end
@@ -45,7 +46,7 @@ describe Shipcloud::ShipcloudError do
     context "with a response with a 4xx status code" do
       it "returns a Shipcloud::ClientError" do
         expect(Shipcloud::ShipcloudError.from_response(build_response(status_code: 400))).to be_a(
-          Shipcloud::ClientError
+          Shipcloud::ClientError,
         )
       end
     end
@@ -53,7 +54,7 @@ describe Shipcloud::ShipcloudError do
     context "with a response with a 5xx status code" do
       it "returns a Shipcloud::ClientError" do
         expect(Shipcloud::ShipcloudError.from_response(build_response(status_code: 500))).to be_a(
-          Shipcloud::ServerError
+          Shipcloud::ServerError,
         )
       end
     end

data/spec/shipcloud/shipment_quote_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "spec_helper"
 
 describe Shipcloud::ShipmentQuote do
@@ -22,8 +23,8 @@ describe Shipcloud::ShipmentQuote do
       weight: 2.5,
       length: 40,
       width: 20,
-      height: 20
-    }
+      height: 20,
+    },
   }
 
   describe "#initialize" do
@@ -62,8 +63,8 @@ describe Shipcloud::ShipmentQuote do
       allow(Shipcloud).to receive(:request).
         and_return(
           "shipment_quote" => {
-            "price" => 42.12
-          }
+            "price" => 42.12,
+          },
         )
 
       shipment_quote = Shipcloud::ShipmentQuote.create(valid_attributes)