shipping_easy 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b51569e520e425f916ee5b73f0fcd9086ec23aa1
-  data.tar.gz: 5c9bf4c89f508e002327c37b3670fd3ac3fdd0b8
+  metadata.gz: 3c67cb9d5219b8a9fcf9bffdc123ab2a02bdeed0
+  data.tar.gz: 3341af1622a0df5f7aac16b5bf9c86f06fce3bf6
 SHA512:
-  metadata.gz: 0d2f8ce7d601b671c76186ab78eebe8fc2ccc886abf7af13c2adcc3a5071f10a134ea4511db8749ba97854d196dc59547d31918da9ac389711ff2832744c20fe
-  data.tar.gz: e7c656651793f6fc67c5883e44b09e1d33397383ce5be7e87b7edc39fb65b129662846942363efc9311128b1b8651574ea6e1824c5667966d1433ef9078e28fe
+  metadata.gz: 0b070887687e1a6d9d267c88a4c16c1bb128a4cc8e19202c061a496ecb2ff7f5b7aabff0e5f3df61d9e897340beeb3a711867a288d3fd406dc5a111a0456f480
+  data.tar.gz: 00cf62427239f916acb74b19fad9c88c90cb8e824731db5734269f41cb6c89debe34f2f68524fc0bf85b56a6412bd130d8f5228eee39f86060be49e3804663a1

data/README.md

@@ -1,8 +1,17 @@
+[![Code Climate](https://codeclimate.com/repos/5315eeefe30ba01aa501c119/badges/92e9ca8e93ca2cbc260b/gpa.png)](https://codeclimate.com/repos/5315eeefe30ba01aa501c119/feed)
+
 # ShippingEasy
 
-Still in development. Please hold.
+This is the official wrapper for the ShippingEasy API. Currently the API only exposes several functions so this wrapper only handles the following calls:
+
+* Adding an order to a ShippingEasy store
+* Cancelling an order before it has been shipped
+
+We will keep this library up to date as we expand our API offerings.
+
+## Setup
 
-## Installation
+### Installation
 
 Add this line to your application's Gemfile:
 
@@ -16,6 +25,307 @@ Or install it yourself as:
 
     $ gem install shipping_easy
 
+### Configuration
+
+You will need a ShippingEasy API key and secret to sign your API requests. These can be found in your account's settings (https://app.shippingeasy.com/settings/api_credentials).
+
+Once you have the credentials, add them to the libary's configuration. Do this in an intializer if you're running a Rails app:
+
+    ShippingEasy.configure do |config|
+      config.api_key = 'd8e8fca2dc0f896fd7cb4cb0031ba249'
+      config.api_secret = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
+    end
+
+
+If you are a 3rd party plugin developer and have a staging account with ShippingEasy, you can change the base URL like so:
+
+    config.base_url = 'https://staging.shippingeasy.com'
+
+## Authentication
+
+The ShippingEasy API will hit a callback URL when an order, or a part of an order, has been shipped. The request to the callback URL will be also signed with the same shared secret found in the store's API settings.
+
+This gem provides an Authenticator to handle verifying the signed request from ShippingEasy. Here's an example of how to use it (after you configured the library with your credentials in the step above):
+
+    ShippingEasy::Authenticator.authenticate(method: :post, path: "/callback", body: "{\"shipment\":{\"id\":\"1234\"}}")
+    # => true
+
+The arguments for the constructor are as follows:
+
+* **method** - The method of the http request. E.g. "post" or "get".
+* **path** - The path of the request's uri. E.g. "/orders/callback"
+* **params** - An associative array of the request's query string parameters. E.g. array("api_signature" => "asdsadsad", "api_timestamp" => "1234567899")
+* **body** - The request body as a JSON string.
+* **api_secret** - Optional. The ShippingEasy API secret for the customer account. Defaults to the global configuration if set.
+
+## API Calls
+
+### Adding an order
+
+To add an order to a store, simply call the create method on the Order resource class. (A comprehensive list of the data attributes and their definitions can be found below.)
+
+    payload = { order: "external_order_identifier" => "ABC123", "subtotal_including_tax" => "12.38", ... }
+    ShippingEasy::Resources::Order.create(store_api_key: "d8821dde1d32f408def40b77273d5c11", payload: payload)
+
+If successful the call will return a JSON hash with the ShippingEasy order ID, as well as the external order identifier originally supplied in your call.
+
+    { "order" => { "id" => "27654", "external_order_identifier" => "ABC123" } }
+
+#### Possible Exceptions
+
+##### ShippingEasy::AccessDeniedError
+Your credentials could not be authenticated or the store api_key could not be found.
+
+##### ShippingEasy::InvalidRequestError
+The order could not be created on the server for one or more of the following reasons:
+
+* The JSON payload could not be parsed.
+* One or more of the supplied data attributes failed validation and is missing or incorrect.
+* An order with the supplied external_order_identifier already exists for that store.
+
+The exception will contain a message that indicates which of these conditions failed.
+
+#### Order Attributes
+
+The following is a list of attributes that should be provided to the ShippingEasy_Order object as a associative array.
+
+An example hash for the create order API call may be found here: https://gist.github.com/twmills/9349053.
+
+**ext_order_identifier**
+: *Required.* The e-commerce system's order ID.
+
+**ordered_at**
+: *Required.* Timestamp when the order was created.
+
+**order_status**
+: Possible values are "awaiting_shipment", "awaiting_payment", "awaiting_fulfillment", "awaiting_shipment", "partially_shipped". Default is "awaiting_shipment".
+
+**total_including_tax**
+: Defaults to 0.0 if not specified.
+
+**total_excluding_tax**
+: Defaults to 0.0 if not specified.
+
+**discount_amount**
+: Defaults to 0.0 if not specified.
+
+**coupon_discount**
+: Defaults to 0.0 if not specified.
+
+**subtotal_including_tax**
+: Defaults to 0.0 if not specified.
+
+**subtotal_excluding_tax**
+: Defaults to 0.0 if not specified.
+
+**subtotal_tax**
+: Defaults to 0.0 if not specified.
+
+**total_tax**
+: Defaults to 0.0 if not specified.
+
+**base_shipping_cost**
+: Defaults to 0.0 if not specified.
+
+**shipping_cost_including_tax**
+: Defaults to 0.0 if not specified.
+
+**shipping_cost_excluding_tax**
+: Defaults to 0.0 if not specified.
+
+**shipping_cost_tax**
+: Defaults to 0.0 if not specified.
+
+**base_handling_cost**
+: Defaults to 0.0 if not specified.
+
+**handling_cost_excluding_tax**
+: Defaults to 0.0 if not specified.
+
+**handling_cost_including_tax**
+: Defaults to 0.0 if not specified.
+
+**handling_cost_tax**
+: Defaults to 0.0 if not specified.
+
+**base_wrapping_cost**
+: Defaults to 0.0 if not specified.
+
+**wrapping_cost_excluding_tax**
+: Defaults to 0.0 if not specified.
+
+**wrapping_cost_including_tax**
+: Defaults to 0.0 if not specified.
+
+**wrapping_cost_tax**
+: Defaults to 0.0 if not specified.
+
+**notes**
+: Customer notes on the order.
+
+**billing_company**
+: Company name for billing address
+
+**billing_first_name**
+: Customer first name for billing address
+
+**billing_last_name**
+: Customer last name for billing address
+
+**billing_address**
+: First address line for billing address
+
+**billing_address2**
+: Additional address line for billing address
+
+**billing_city**
+: City name for billing address
+
+**billing_state**
+: State name for billing address
+
+**billing_country**
+: Country name for billing address
+
+**billing_postal_code**
+: Postal code for billing address
+
+**billing_phone_number**
+: Phone number.
+
+**billing_email**
+: Email address
+
+**recipients**
+: A nested associative array of recipient attributes. At least one recipient is required.
+
+**recipients > company**
+: Company name for shipping address
+
+**recipients > first_name**
+: Customer first name for shipping address
+
+**recipients > last_name**
+: Customer last name for shipping address
+
+**recipients > address**
+: *Required.* First address line for shipping address
+
+**recipients > address2**
+: Additional address line for shipping address
+
+**recipients > city**
+: City name for shipping address
+
+**recipients > state**
+: State name for shipping address
+
+**recipients > country**
+: Country name for shipping address
+
+**recipients > residential**
+: Whether or not address is residential or not. Value can be "true" or "false".
+
+**recipients > postal_code**
+: *Required.* Postal code for shipping address
+
+**recipients > postal_code_plus_4**
+: Postal code plus 4 for shipping address
+
+**recipients > phone_number**
+: Customer phone number
+
+**recipients > email**
+: Customer email address
+
+**recipients > base_cost**
+: Cost before tax for all line items sent to this recipient
+
+**recipients > cost_excluding_tax**
+: Cost before tax for all line items sent to this recipient
+
+**recipients > cost_including_tax**
+: Cost including tax for all line items sent to this recipient
+
+**recipients > cost_tax**
+: Cost of the tax for all line items sent to this recipient
+
+**recipients > base_handling_cost**
+: Handling cost before tax for all line items sent to this recipient
+
+**recipients > handling_cost_excluding_tax**
+: Handling cost before tax for all line items sent to this recipient
+
+**recipients > handling_cost_including_tax**
+: Handling cost including tax for all line items sent to this recipient
+
+**recipients > handling_cost_tax**
+: Handling cost of the tax for all line items sent to this recipient
+
+**recipients > shipping_zone_id**
+: ID of the shipping zone.
+
+**recipients > shipping_zone_name**
+: Name of the shipping zone.
+
+**recipients > shipping_method**
+: Method of shipment.
+
+**recipients > items_total**
+: Total number of items.
+
+**recipients > items_shipped**
+: Total number of items shipped.
+
+**recipients > line_items**
+: A nested associative array of line item attributes. At least one line item is required.
+
+**recipients > line_items > item_name**
+: Name of the item/product.
+
+**recipients > line_items > sku**
+: SKU of the item/product.
+
+**recipients > line_items > bin_picking_number**
+: Bin number where the item may be stored in a warehouse.
+
+**recipients > line_items > weight_in_ounces**
+: Weight of the line item in ounces.
+
+**recipients > line_items > quantity**
+: Quantity of the the items for the line item.
+
+**recipients > line_items > total_excluding_tax**
+: Total excluding tax for the line item.
+
+**recipients > line_items > unit_price**
+: Unit price of the item.
+
+### Cancelling an order
+
+Sometimes an e-commerce system will mark an order as shipped outside of the ShippingEasy system. Therefore an API call is required to remove this order from ShippingEasy so that it is not double-shipped.
+
+Here's an example using your store's API key and the e-commerce order identifier used to create the order in ShippingEasy:
+
+    ShippingEasy::Resources::Cancellation.create(store_api_key: "d8821dde1d32f408def40b77273d5c11", external_order_identifier: "ABC123")
+
+If successful the call will return a JSON hash with the ShippingEasy order ID, as well as the external order identifier originally supplied in your call.
+
+    { "order" => { "id" => "27654", "external_order_identifier" => "ABC123" } }
+
+#### Possible Exceptions
+
+##### ShippingEasy::AccessDeniedError
+Your credentials could not be authenticated or the store api_key could not be found.
+
+##### ShippingEasy::InvalidRequestError
+The cancellation could not complete for one or more of the following reasons:
+
+* The order could not be found.
+* The order has already been marked as shipped in the ShippingEasy system and cannot be cancelled.
+
+The exception will contain a message that indicates which of these conditions failed.
+
 ## Contributing
 
 1. Fork it

data/lib/shipping_easy/authenticator.rb

@@ -24,7 +24,7 @@ module ShippingEasy
     #           :params - The query params passed in as part of the request.
     #           :body - The body of the request which should normally be a JSON payload.
     def initialize(options = {})
-      @api_secret = options.fetch(:api_secret)
+      @api_secret = options.fetch(:api_secret, ShippingEasy.api_secret)
       @method = options.fetch(:method, :get)
       @path = options.fetch(:path)
       @body = options.fetch(:body, nil)

data/lib/shipping_easy/http/response_handler.rb

@@ -16,11 +16,12 @@ class ShippingEasy::Http::ResponseHandler
 
   def run
     case status
-      when 401 then raise ShippingEasy::AccessDeniedError, response.body
-      when 404 then raise ShippingEasy::ResourceNotFoundError, response.body
-      when 200, 201 then JSON.parse(response.body)
-      else
-        raise ShippingEasy::Error, response.body
+    when 200, 201 then JSON.parse(response.body)
+    when 400 then raise ShippingEasy::InvalidRequestError, response.body
+    when 401 then raise ShippingEasy::AccessDeniedError, response.body
+    when 404 then raise ShippingEasy::ResourceNotFoundError, response.body
+    else
+      raise ShippingEasy::Error, response.body
     end
   end
 

data/lib/shipping_easy/version.rb

@@ -1,3 +1,3 @@
 module ShippingEasy
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/lib/shipping_easy.rb

@@ -42,6 +42,7 @@ module ShippingEasy
 
   class Error < StandardError; end
   class ResourceNotFoundError < Error; end
+  class InvalidRequestError < Error; end
   class RequestExpiredError < Error
     def initialize(msg = "The request has expired.")
       super(msg)

data/spec/authenticator_spec.rb

@@ -13,6 +13,12 @@ describe ShippingEasy::Authenticator, api: true do
   let(:signature) { ShippingEasy::Signature.new(api_secret: api_secret, method: method, path: path, params: params, body: request_body) }
   subject { ShippingEasy::Authenticator.new(api_secret: api_secret, method: method, path: path, params: params_with_signature, body: request_body) }
 
+  before do
+    ShippingEasy.configure do |config|
+      config.api_secret = api_secret
+    end
+  end
+
   describe "#initialize" do
     specify { subject.api_secret.should == api_secret }
     specify { subject.method.should == :post }
@@ -23,6 +29,11 @@ describe ShippingEasy::Authenticator, api: true do
     specify { subject.expected_signature.should be_a(ShippingEasy::Signature) }
   end
 
+  context "when api_secret is not supplied" do
+    subject { ShippingEasy::Authenticator.new(api_secret: api_secret, method: method, path: path, params: params_with_signature, body: request_body) }
+    specify { subject.api_secret.should == api_secret }
+  end
+
   describe "#request_expires_at" do
     specify { subject.request_expires_at.to_s.should == (Time.now - ShippingEasy::Authenticator::EXPIRATION_INTERVAL).to_s }
   end

data/spec/http/response_handler_spec.rb

@@ -16,6 +16,10 @@ describe ShippingEasy::Http::ResponseHandler do
     context "when success" do
       specify { subject.run.should == body }
     end
+    context "when request is invalid" do
+      let(:status) { 400 }
+      specify { expect { subject.run }.to raise_error(ShippingEasy::InvalidRequestError) }
+    end
     context "when authentication fails" do
       let(:status) { 401 }
       specify { expect { subject.run }.to raise_error(ShippingEasy::AccessDeniedError) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shipping_easy
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - ShippingEasy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-03 00:00:00.000000000 Z
+date: 2014-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday