sendle-api 0.0.2 → 0.0.11

data/spec/sendle/api/ping_spec.rb

@@ -33,13 +33,21 @@ describe Sendle::Api::Ping do
       expect(pong).to be_a Sendle::Api::Responses::Pong
     end
 
-    it "handles unauthorized" do
+    it "handles unauthorized error" do
       expect(RestClient::Request).to receive(:execute).and_raise(UNAUTHORIZED_ERROR)
 
       expect {
         Sendle::Api::Ping.execute
       }.to raise_error(Sendle::Api::Errors::Unauthorized)
     end
+
+    it "handles payment required error" do
+      expect(RestClient::Request).to receive(:execute).and_raise(PAYMENT_REQUIRED_ERROR)
+
+      expect {
+        Sendle::Api::Ping.execute
+      }.to raise_error(Sendle::Api::Errors::PaymentRequired)
+    end
   end
 
 end

data/spec/sendle/api/quote_spec.rb

@@ -0,0 +1,103 @@
+require "spec_helper"
+
+describe Sendle::Api::Quote do
+
+  describe "#execute" do
+    let(:params) {
+      {
+        pickup_suburb: 'woolloomooloo',
+        pickup_postcode: '2011',
+        delivery_suburb: 'eastgardens',
+        delivery_postcode: '2036',
+        kilogram_weight: '1'
+      }
+    }
+
+    it "makes the correct request" do
+      expected_params = {
+        method: :get,
+        url: Sendle::Api::Quote.url,
+        headers: {
+          accept: :json, 
+          content_type: :json,
+          params: params
+        }
+      }
+      expect(RestClient::Request).to receive(:execute).with(hash_including(expected_params)).and_return(QUOTE_NO_PLAN_RESPONSE)
+
+      Sendle::Api::Quote.execute(params)
+    end
+
+    it "throws an error if params are missing" do
+      expect {
+        Sendle::Api::Quote.execute
+      }.to raise_error(Sendle::Api::Errors::MissingParams, "The following params are required: pickup_suburb, pickup_postcode, delivery_suburb, delivery_postcode, kilogram_weight. Please check your request and try again.")
+    end
+
+    it "returns correct response" do
+      expect(RestClient::Request).to receive(:execute).and_return(QUOTE_NO_PLAN_RESPONSE)
+
+      response = Sendle::Api::Quote.execute(params)
+
+      expect(response.json).to eq JSON.parse(QUOTE_NO_PLAN_RESPONSE)
+    end
+
+    context "passing in a plan_name" do
+      it "checks a valid plan name is passed in" do
+        PLANS.each do |plan|
+          params[:plan_name] = plan
+          expect(RestClient::Request).to receive(:execute).and_return(QUOTE_NO_PLAN_RESPONSE)
+          Sendle::Api::Quote.execute(params)
+        end
+
+        params[:plan_name] = 'invalid-plan'
+
+        expect {
+          Sendle::Api::Quote.execute(params)
+        }.to raise_error(Sendle::Api::Errors::InvalidPlan, "invalid-plan is not in the list of valid plans: easy, premium, pro")
+      end
+
+      it "respects the plan_name param" do
+        expected_params = {
+          method: :get,
+          url: Sendle::Api::Quote.url,
+          headers: {
+            accept: :json, 
+            content_type: :json,
+            params: params.merge(plan_name: PLAN_EASY)
+          }
+        }
+        expect(RestClient::Request).to receive(:execute).with(hash_including(expected_params)).and_return(QUOTE_NO_PLAN_RESPONSE)
+
+        Sendle::Api::Quote.execute(params.merge(plan_name: PLAN_EASY))
+      end
+    end
+
+    it "passes optional params" do
+      expected_params = {
+        method: :get,
+        url: Sendle::Api::Quote.url,
+        headers: {
+          accept: :json, 
+          content_type: :json,
+          params: params.merge(cubic_metre_volume: 0.5)
+        }
+      }
+      expect(RestClient::Request).to receive(:execute).with(hash_including(expected_params)).and_return(QUOTE_NO_PLAN_RESPONSE)
+
+      Sendle::Api::Quote.execute(params.merge(cubic_metre_volume: 0.5))
+    end
+
+    it "handles 422" do
+      expect(RestClient::Request).to receive(:execute).and_raise(UNPROCESSABLE_ENTITY_ERROR)
+      
+      params[:kilogram_weight] = "sdfsdf"
+
+      expect {
+        Sendle::Api::Quote.execute(params)
+      }.to raise_error(Sendle::Api::Errors::UnprocessableEntity, "Please fix the following errors and try again - kilogram_weight: is not a number")
+    end
+    
+  end
+
+end

data/spec/sendle/api_spec.rb

@@ -17,4 +17,26 @@ describe Sendle::Api do
 
     expect(Sendle::Api.sendle_id).to eq sendle_id
   end
+
+  it "turns off sandbox mode by default" do
+    expect(Sendle::Api.sandbox).to eq false
+  end
+
+  it "allows turning on sandbox mode" do
+    Sendle::Api.sandbox = true
+
+    expect(Sendle::Api.sandbox).to eq true
+  end
+
+  it "uses sandbox api uri when in sandbox mode" do
+    Sendle::Api.sandbox = true
+
+    expect(Sendle::Api.base_url).to eq 'https://sandbox.sendle.com/api/'
+  end
+
+  it "uses live api uri when not in sandbox mode" do
+    Sendle::Api.sandbox = false
+
+    expect(Sendle::Api.base_url).to eq 'https://www.sendle.com/api/'
+  end
 end

data/spec/sendle/errors/missing_params_spec.rb

@@ -0,0 +1,13 @@
+require "spec_helper"
+
+describe Sendle::Api::Errors::MissingParams do
+
+  describe "#to_s" do
+    it "formats the message" do
+      error = Sendle::Api::Errors::MissingParams.new(%w( pickup_address deliver_address ))
+
+      expect(error.to_s).to eq "The following params are required: pickup_address, deliver_address. Please check your request and try again."
+    end
+  end
+
+end

data/spec/support/helpers.rb

@@ -4,4 +4,18 @@ def json_headers
   { headers: { accept: :json, content_type: :json } }
 end
 
-UNAUTHORIZED_ERROR = RestClient::Unauthorized.new("{\"error\":\"unauthorised\",\"error_description\":\"The authorisation details are not valid. Either the Sendle ID or API key are incorrect.\"}")
+UNAUTHORIZED_ERROR = RestClient::Unauthorized.new("{\"error\":\"unauthorised\",\"error_description\":\"The authorisation details are not valid. Either the Sendle ID or API key are incorrect.\"}")
+
+PAYMENT_REQUIRED_ERROR = RestClient::PaymentRequired.new("{\"error\":\"payment_required\",\"error_description\":\"The account associated with this API key has no method of payment. Please go to your Account Settings in your Sendle Dashboard and add a payment method.\"}")
+
+UNPROCESSABLE_ENTITY_ERROR = RestClient::UnprocessableEntity.new("{\"messages\":{\"kilogram_weight\":[\"is not a number\"]},\"error\":\"unprocessable_entity\",\"error_description\":\"The data you supplied is invalid. Error messages are in the messages section. Please fix those fields and try again.\"}")
+
+PRECONDITION_FAILED_ERROR = RestClient::PreconditionFailed.new("{\"error\":\"precondition_failed\",\"error_description\":\"The account associated with this API key has not accepted the dangerous goods terms. Please visit your Account Settings in https://www.sendle.com/dashboard/ to view and accept these terms.\"}")
+
+QUOTE_NO_PLAN_RESPONSE = "[{\"quote\":{\"gross\":{\"amount\":9.75,\"currency\":\"AUD\"},\"net\":{\"amount\":8.86,\"currency\":\"AUD\"},\"tax\":{\"amount\":0.89,\"currency\":\"AUD\"}},\"plan_name\":\"Easy\"},{\"quote\":{\"gross\":{\"amount\":8.75,\"currency\":\"AUD\"},\"net\":{\"amount\":7.95,\"currency\":\"AUD\"},\"tax\":{\"amount\":0.8,\"currency\":\"AUD\"}},\"plan_name\":\"Premium\"},{\"quote\":{\"gross\":{\"amount\":5.98,\"currency\":\"AUD\"},\"net\":{\"amount\":5.44,\"currency\":\"AUD\"},\"tax\":{\"amount\":0.54,\"currency\":\"AUD\"}},\"plan_name\":\"Pro\"}]"
+
+ORDER_CREATED_RESPONSE = "{\"order_id\":\"9dbadcd6-ee57-488e-a175-49e378ad29ff\",\"state\":\"Pickup\",\"order_url\":\"https://sendle-sandbox.herokuapp.com/api/orders/9dbadcd6-ee57-488e-a175-49e378ad29ff\",\"labels\":null,\"scheduling\":{\"is_cancellable\":true,\"pickup_date\":\"2016-05-05\"},\"description\":\"Kryptonite\",\"confirmed_not_dangerous\":false,\"kilogram_weight\":\"1.0\",\"cubic_metre_volume\":\"0.01\",\"customer_reference\":\"SupBdayPressie\",\"sender\":{\"contact\":{\"name\":\"Lex Luthor\",\"phone\":\"0412 345 678\",\"email\":\"bobl53@gmail.com\",\"sendle_id\":\"bobl53_gmail_com\"},\"address\":{\"address_line1\":\"123 Gotham Ln\",\"address_line2\":null,\"suburb\":\"Sydney\",\"state_name\":\"NSW\",\"postcode\":\"2000\",\"country\":\"Australia\"},\"instructions\":\"Knock loudly\"},\"receiver\":{\"contact\":{\"name\":\"Clark Kent\",\"phone\":null,\"email\":\"clarkissuper@dailyplanet.xyz\"},\"address\":{\"address_line1\":\"80 Wentworth Park Road\",\"address_line2\":null,\"suburb\":\"Glebe\",\"state_name\":\"NSW\",\"postcode\":\"2037\",\"country\":\"Australia\"},\"instructions\":\"Give directly to Clark\"}}"
+
+ORDER_GET_RESPONSE = "{\"order_id\":\"9dbadcd6-ee57-488e-a175-49e378ad29ff\",\"state\":\"Pickup\",\"order_url\":\"https://sendle-sandbox.herokuapp.com/api/orders/9dbadcd6-ee57-488e-a175-49e378ad29ff\",\"labels\":[{\"format\":\"pdf\",\"size\":\"a4\",\"url\":\"https://sendle-sandbox.herokuapp.com/api/orders/9dbadcd6-ee57-488e-a175-49e378ad29ff/labels/a4.pdf\"},{\"format\":\"pdf\",\"size\":\"cropped\",\"url\":\"https://sendle-sandbox.herokuapp.com/api/orders/9dbadcd6-ee57-488e-a175-49e378ad29ff/labels/cropped.pdf\"}],\"scheduling\":{\"is_cancellable\":true,\"pickup_date\":\"2016-05-05\",\"estimated_delivery_date_minimum\":\"2016-05-05\",\"estimated_delivery_date_maximum\":\"2016-05-06\"},\"description\":\"Kryptonite\",\"confirmed_not_dangerous\":false,\"kilogram_weight\":\"1.0\",\"cubic_metre_volume\":\"0.01\",\"customer_reference\":\"SupBdayPressie\",\"sender\":{\"contact\":{\"name\":\"Lex Luthor\",\"phone\":\"0412 345 678\",\"email\":\"bobl53@gmail.com\",\"sendle_id\":\"bobl53_gmail_com\"},\"address\":{\"address_line1\":\"123 Gotham Ln\",\"address_line2\":null,\"suburb\":\"Sydney\",\"state_name\":\"NSW\",\"postcode\":\"2000\",\"country\":\"Australia\"},\"instructions\":\"Knock loudly\"},\"receiver\":{\"contact\":{\"name\":\"Clark Kent\",\"phone\":null,\"email\":\"clarkissuper@dailyplanet.xyz\"},\"address\":{\"address_line1\":\"80 Wentworth Park Road\",\"address_line2\":null,\"suburb\":\"Glebe\",\"state_name\":\"NSW\",\"postcode\":\"2037\",\"country\":\"Australia\"},\"instructions\":\"Give directly to Clark\"}}"
+
+ORDER_DELETE_RESPONSE = "{\"order_id\":\"9dbadcd6-ee57-488e-a175-49e378ad29ff\",\"state\":\"Cancelled\",\"order_url\":\"https://sendle-sandbox.herokuapp.com/api/orders/9dbadcd6-ee57-488e-a175-49e378ad29ff\",\"customer_reference\":\"SupBdayPressie\",\"cancelled_at\":\"2016-05-02 23:53:51 UTC\",\"cancellation_message\":\"Cancelled by 4GZwvmnr6Gr8Nd2XJrhKYhxF during picking up\"}"

data/spec/support/shared_examples/with_credentials_spec.rb

@@ -32,7 +32,7 @@ shared_examples_for "a resource action with credentials" do
 
       expect {
         described_resource.send(described_action)
-      }.to_not raise_error 
+      }.to_not raise_error Sendle::Api::Errors::MissingApiKey
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sendle-api
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.11
 platform: ruby
 authors:
 - Bobby Lei
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-29 00:00:00.000000000 Z
+date: 2016-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -103,22 +103,45 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- Changelog.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/sendle/api.rb
+- lib/sendle/api/actions/base.rb
+- lib/sendle/api/actions/create.rb
+- lib/sendle/api/actions/destroy.rb
 - lib/sendle/api/actions/index.rb
+- lib/sendle/api/actions/show.rb
+- lib/sendle/api/constants.rb
+- lib/sendle/api/errors/invalid_plan.rb
 - lib/sendle/api/errors/missing_api_key.rb
+- lib/sendle/api/errors/missing_params.rb
 - lib/sendle/api/errors/missing_sendle_id.rb
+- lib/sendle/api/errors/payment_required.rb
+- lib/sendle/api/errors/precondition_failed.rb
 - lib/sendle/api/errors/unauthorized.rb
+- lib/sendle/api/errors/unprocessable_entity.rb
+- lib/sendle/api/factories/errors.rb
+- lib/sendle/api/order.rb
 - lib/sendle/api/ping.rb
+- lib/sendle/api/quote.rb
+- lib/sendle/api/resource.rb
+- lib/sendle/api/responses/json.rb
 - lib/sendle/api/responses/pong.rb
+- lib/sendle/api/sugars/create.rb
+- lib/sendle/api/sugars/destroy.rb
+- lib/sendle/api/sugars/index.rb
+- lib/sendle/api/sugars/show.rb
+- lib/sendle/api/utils.rb
 - lib/sendle/api/version.rb
-- lib/sendle/utils/actions.rb
 - sendle-api.gemspec
+- spec/sendle/api/order_spec.rb
 - spec/sendle/api/ping_spec.rb
+- spec/sendle/api/quote_spec.rb
 - spec/sendle/api_spec.rb
+- spec/sendle/errors/missing_params_spec.rb
 - spec/spec_helper.rb
 - spec/support/helpers.rb
 - spec/support/shared_examples/with_credentials_spec.rb
@@ -148,8 +171,11 @@ signing_key:
 specification_version: 4
 summary: Ruby bindings for the Sendle API
 test_files:
+- spec/sendle/api/order_spec.rb
 - spec/sendle/api/ping_spec.rb
+- spec/sendle/api/quote_spec.rb
 - spec/sendle/api_spec.rb
+- spec/sendle/errors/missing_params_spec.rb
 - spec/spec_helper.rb
 - spec/support/helpers.rb
 - spec/support/shared_examples/with_credentials_spec.rb

data/lib/sendle/utils/actions.rb

@@ -1,19 +0,0 @@
-module Sendle
-  module Api
-    module Utils
-      class Actions
-
-        def self.check_for_missing_credentials
-          raise Sendle::Api::Errors::MissingSendleId if Sendle::Api.sendle_id.nil?
-          raise Sendle::Api::Errors::MissingApiKey if Sendle::Api.api_key.nil?
-        end
-
-        def self.json_headers
-          { accept: :json, content_type: :json }
-        end
-
-      end
-    end
-  end
-
-end