shipping_easy 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5ff1cf485fdfa4f09bf7dbd69c89230897d98bc0
-  data.tar.gz: d14eaf59c001dfb06ce92aaefaa7e8c3d247c189
+  metadata.gz: 8a863c6fb799dcc090fef67943634033515c54b6
+  data.tar.gz: 22875fa0281196e5642dfd7be2194155010868b1
 SHA512:
-  metadata.gz: cbbc3019268e0f8fc9ae38325ed377d4f716be23ee920ffdc200a7b90d42cfde9a92083bfdefc7d3adfbb3390c14f0ab4c21c8ee60a849bce127f2eb28c377fa
-  data.tar.gz: 870a7e66a8279a5ba38fc37abc1e7b8073760da54d33233e31c4282100b0911065a9f3771b74739dc22a5b3af5bde99d2a065df14e4dc1964fb9a4b7e43cacb0
+  metadata.gz: 5314211e423575528620acacea83c4db39f8af1f5db519a7332901328aaa5b3f3e14ad47505b36cec708f79eaef21d55173eaa38ec7848a92691be62d9addd8b
+  data.tar.gz: 2770b3eceb26aa5369715209b5ea1540e7d91a0fb766e7cde303a7c2a0dedfcf6a24d4bcbc2961c0c359e778475bfd931b76cff532cc7f733f32b68ec8b90654

data/CHANGELOG

@@ -1,2 +1,5 @@
+v0.3.1
+- Class-level options were being deleted rather than fetched, so subsequent calls were not working.
+
 v0.3.0
 - Added find and find_all methods to Order.

data/README.md

@@ -2,12 +2,16 @@
 
 # ShippingEasy
 
-This is the official wrapper for the ShippingEasy API. Currently the API only exposes several functions so this wrapper only handles the following calls:
+This is the official wrapper for the ShippingEasy API. 
 
-* Adding an order to a ShippingEasy store
-* Cancelling an order before it has been shipped
+The ShippingEasy API supports the following features:
 
-We will keep this library up to date as we expand our API offerings.
+* Secure, authenticated intake of orders for shipment
+* Cancellation of orders that no longer need to be shipped
+* A callback facility that provides shipment information (carrier, cost, tracking number, etc.) for an order
+* Query capabilities to read order data from ShippingEasy
+
+We will keep this library up to date as we expand the ShippingEasy API.
 
 ## Setup
 
@@ -62,7 +66,7 @@ The arguments for the constructor are as follows:
 
 ### Finding an order
 
-To retrieve a specific order, call the find method on the Order resource class with a ShippingEasy order ID specified.
+To retrieve a specific order, call the find method on the Order resource class.
 
     ShippingEasy::Resources::Order.find(id: 876)
 
@@ -129,7 +133,7 @@ https://gist.github.com/twmills/005b3c4ab9c85330a801
 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 orders could not retrieved for one or more of the following reasons:
 
 * The API timestamp could not be parsed.
 
@@ -404,6 +408,36 @@ The cancellation could not complete for one or more of the following reasons:
 
 The exception will contain a message that indicates which of these conditions failed.
 
+## Making requests via curl
+First you will need to create an API signature. Concatenate these into a plaintext string using the following order:
+
+1. Capitilized method of the request. E.g. "POST"
+2. The URI path
+3. The query parameters sorted alphabetically and concatenated together into a URL friendly format: param1=ABC&param2=XYZ
+4. The request body as a string if one exists
+
+All parts are then concatenated together with an ampersand. The result resembles something like this:
+
+    "POST&/api/orders&api_key=f9a7c8ebdfd34beaf260d9b0296c7059&api_timestamp=1401803554&{\"orders\":{\"name\":\"Flip flops\",\"cost\":\"10.00\",\"shipping_cost\":\"2.00\"}}"
+
+Finally, using your API secret encrypt the string using HMAC sha256. In ruby, it looks like this:
+
+    OpenSSL::HMAC::hexdigest("sha256", api_secret, "POST&/api/orders&api_key=f9a7c8ebdfd34beaf260d9b0296c7059&api_timestamp=1401803554&{\"orders\":{\"name\":\"Flip flops\",\"cost\":\"10.00\",\"shipping_cost\":\"2.00\"}}")
+
+### API timestamp
+You must include an API timestamp in your requests. The timestamp should be an integer representation of the current time.
+
+### Example curl request
+
+````shell
+curl -H "Content-Type: application/json" --data @body.json "https://app.shippingeasy.com/api/stores/27aa472e16faa83dd13b7758d31974ed/orders?api_key=f9a7c8ebdfd34beaf260d9b0296c7059&api_timestamp=1401803554&api_signature=c65f43beed46e581939898a78acd10064cfa146845e97885ec02124d7ad648e4"
+````
+
+An example body.json can be found here:
+
+https://gist.github.com/twmills/3f4636b835c611ab3f7f
+
+
 ## Contributing
 
 1. Fork it

data/lib/shipping_easy/resources/base.rb

@@ -3,8 +3,8 @@ class ShippingEasy::Resources::Base
   def self.command(name, command_options = {}, &block)
     define_singleton_method name do |options = {}|
       request_options = {}
-      request_options[:relative_path] = command_options.delete(:relative_path) || block.call(options)
-      request_options[:http_method] = command_options.delete(:http_method) || :get
+      request_options[:relative_path] = command_options.fetch(:relative_path, block.call(options))
+      request_options[:http_method] = command_options.fetch(:http_method, :get)
       request_options[:payload] = options.delete(:payload) if options.has_key?(:payload)
       request_options[:params] = options unless options.nil? || options.empty?
       execute_request!(request_options)

data/lib/shipping_easy/version.rb

@@ -1,3 +1,3 @@
 module ShippingEasy
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shipping_easy
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - ShippingEasy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-21 00:00:00.000000000 Z
+date: 2014-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday