shipping_easy 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57853b3a7460d70af7dd2867a40dd19d52ef72f3
-  data.tar.gz: 0c76624c1ad71e13c64653db58470ba3665697ca
+  metadata.gz: 5ff1cf485fdfa4f09bf7dbd69c89230897d98bc0
+  data.tar.gz: d14eaf59c001dfb06ce92aaefaa7e8c3d247c189
 SHA512:
-  metadata.gz: 26160b7461cd4346d0c8e6ca0f40f01ded8aba1d338afce5fc35023cb3b5083d50ea6f318c113ff7635d0b6c8eec4ab95ac6dfa052ede253f611545471d2afc5
-  data.tar.gz: 74a6bfef1b5168a09d33f186c6b4196832953058088a3b9a38db591269a9aae2f608094abc4bd5bf1d91c266920bab26e434ebfb6069581935107a3cef75640c
+  metadata.gz: cbbc3019268e0f8fc9ae38325ed377d4f716be23ee920ffdc200a7b90d42cfde9a92083bfdefc7d3adfbb3390c14f0ab4c21c8ee60a849bce127f2eb28c377fa
+  data.tar.gz: 870a7e66a8279a5ba38fc37abc1e7b8073760da54d33233e31c4282100b0911065a9f3771b74739dc22a5b3af5bde99d2a065df14e4dc1964fb9a4b7e43cacb0

data/.gitignore

@@ -1,4 +1,6 @@
 *.gem
+.idea
+.ruby-*
 *.rbc
 .bundle
 .config

data/CHANGELOG

@@ -0,0 +1,2 @@
+v0.3.0
+- Added find and find_all methods to Order.

data/README.md

@@ -60,6 +60,81 @@ The arguments for the constructor are as follows:
 
 ## API Calls
 
+### Finding an order
+
+To retrieve a specific order, call the find method on the Order resource class with a ShippingEasy order ID specified.
+
+    ShippingEasy::Resources::Order.find(id: 876)
+
+If successful the call will return a JSON hash with the ShippingEasy order.
+
+Example payload may be found here: 
+
+https://gist.github.com/twmills/491b44fb6e78b20c1266
+
+#### Possible Exceptions
+
+##### ShippingEasy::AccessDeniedError
+Your credentials could not be authenticated or the store api_key could not be found.
+
+##### ShippingEasy::ResourceNotFoundError
+The requested resource could not be found.
+
+##### ShippingEasy::InvalidRequestError
+The order could not be created on the server for one or more of the following reasons:
+
+* The API timestamp could not be parsed.
+
+The exception will contain a message that indicates which of these conditions failed.
+
+### Retrieving multiple orders
+
+To retrieve multiple orders, call the find_all method on the Order resource class with a ShippingEasy order ID specified.
+
+    ShippingEasy::Resources::Order.find_all
+
+If successful the call will return a JSON hash included an array of orders and a hash metadata detailing the conditions used in the search as well as pagination details regarding the response. 
+
+#### Filtering Parameters
+
+**page**
+: The page to return in the paginated result set.
+
+**per_page**
+: The number of result to include per pagein the paginated result set. Defaults to 50 if not specified and the maximum number of results returned per page is 200.
+
+**last_updated_at**
+: Filters the results by the orders' last updated at timestamp and only returns results with a timestamp newer than or equal to the specified value. Defaults to 1 week ago if not specified. The maxiumum time this value can be set to is 3 months ago.
+
+**status**
+: Filters the results by the orders' ShippingEasy order status. Defaults to "shipped". Possible values are "shipped" and "ready_for_shipment". It is possible to pass an array of statuses, e.g. ["shipping", "ready_for_shipment"].
+
+**page**
+: The page to return in the paginated result set.
+
+**store_api_key**
+: By default orders are searched across all the stores on a customer's account. If you would like to filter on a specific API-driven store, include its API key.
+
+#### Filtering Example
+
+    ShippingEasy::Resources::Order.find_all(page: 1, per_page: 1, status: ["ready_for_shipment", "shipped"], last_updated_at: "2014-05-07 14:42:18 UTC")
+    
+An example JSON response may be found here: 
+
+https://gist.github.com/twmills/005b3c4ab9c85330a801
+
+#### 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 API timestamp could not be parsed.
+
+The exception will contain a message that indicates which of these conditions failed.
+
 ### 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.)
@@ -91,7 +166,7 @@ The following is a list of attributes that should be provided to the ShippingEas
 
 An example hash for the create order API call may be found here: https://gist.github.com/twmills/9349053.
 
-**ext_order_identifier**
+**external_order_identifier**
 : *Required.* The e-commerce system's order ID.
 
 **ordered_at**
@@ -301,6 +376,9 @@ An example hash for the create order API call may be found here: https://gist.gi
 **recipients > line_items > unit_price**
 : Unit price of the item.
 
+**recipients > line_items > product_options**
+: Hash of product variations applicable to this line item. E.g. {"color":"red", "size":"XXL"}
+
 ### 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.

data/lib/shipping_easy/http/faraday_adapter.rb

@@ -21,6 +21,13 @@ class ShippingEasy::Http::FaradayAdapter
     end
   end
 
+  def get
+    connection.get do |req|
+      req.url uri, params
+      req.body = request.body
+    end
+  end
+
   def connection
     @connection ||= Faraday.new(url: base_url) do |faraday|
       faraday.adapter Faraday.default_adapter

data/lib/shipping_easy/resources/base.rb

@@ -1,10 +1,13 @@
 class ShippingEasy::Resources::Base
 
-  def self.command(name, command_options, &block)
+  def self.command(name, command_options = {}, &block)
     define_singleton_method name do |options = {}|
-      options[:relative_path] = command_options.fetch(:relative_path, block.call(options))
-      options[:http_method] = command_options.fetch(:http_method, :get)
-      execute_request!(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[:payload] = options.delete(:payload) if options.has_key?(:payload)
+      request_options[:params] = options unless options.nil? || options.empty?
+      execute_request!(request_options)
     end
   end
 

data/lib/shipping_easy/resources/order.rb

@@ -4,4 +4,16 @@ class ShippingEasy::Resources::Order < ShippingEasy::Resources::Base
     "/stores/#{args.delete(:store_api_key)}/orders"
   end
 
+  command :find do |args|
+    "/orders/#{args.delete(:id)}"
+  end
+
+  command :find_all do |args|
+    if args.has_key?(:store_api_key)
+      "/stores/#{args.delete(:store_api_key)}/orders"
+    else
+      "/orders"
+    end
+  end
+
 end

data/lib/shipping_easy/version.rb

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

data/spec/resources/base_spec.rb

@@ -12,24 +12,33 @@ describe ShippingEasy::Resources::Base do
     end
 
     it "extracts options to send to a request" do
+      GenericResource.command(:find_all, http_method: :get) do |args|
+        "/orders"
+      end
+      GenericResource.should_receive(:execute_request!).with({:relative_path=>"/orders",
+                                                              :http_method=>:get,
+                                                              :params => {:page => 2,
+                                                                          :per_page => 3,
+                                                                          :status => [:shipped]}})
 
+      GenericResource.find_all(:page => 2, :per_page => 3, :status => [:shipped] )
     end
 
     context "when a block is provided" do
       it "uses it as the value for the path" do
-        GenericResource.command(:create, method: :post) do |args|
+        GenericResource.command(:create, http_method: :post) do |args|
           "/this/is/the/path"
         end
-        GenericResource.should_receive(:execute_request!).with({:relative_path=>"/this/is/the/path", :http_method=>:get})
+        GenericResource.should_receive(:execute_request!).with({:relative_path=>"/this/is/the/path", :http_method=>:post})
         GenericResource.create
       end
 
       context "and an argument is passed in" do
         it "interpolates it" do
-          GenericResource.command(:create, method: :post) do |args|
+          GenericResource.command(:create, http_method: :post) do |args|
             "/this/is/the/#{args.delete(:name)}"
           end
-          GenericResource.should_receive(:execute_request!).with({:relative_path=>"/this/is/the/ABC123", :http_method=>:get})
+          GenericResource.should_receive(:execute_request!).with({:relative_path=>"/this/is/the/ABC123", :http_method=>:post})
           GenericResource.create(name: "ABC123")
         end
       end

data/spec/resources/order_spec.rb

@@ -0,0 +1,31 @@
+require "spec_helper"
+
+describe ShippingEasy::Resources::Order do
+
+  describe ".find_all" do
+    it "sends a request with the expected options" do
+
+      ShippingEasy::Resources::Order.should_receive(:execute_request!).with({:relative_path=>"/orders",
+                                                              :http_method=>:get,
+                                                              :params => {:page => 2,
+                                                                          :per_page => 3,
+                                                                          :status => [:shipped]}})
+
+      ShippingEasy::Resources::Order.find_all(:page => 2, :per_page => 3, :status => [:shipped])
+    end
+  end
+
+  describe ".find" do
+    it "sends a request with the expected options" do
+      ShippingEasy::Resources::Order.should_receive(:execute_request!).with({:relative_path=>"/orders/2", :http_method=>:get})
+      ShippingEasy::Resources::Order.find(:id => 2)
+    end
+  end
+
+  describe ".create" do
+    it "sends a request with the expected options" do
+      ShippingEasy::Resources::Order.should_receive(:execute_request!).with({:relative_path=>"/stores/123456/orders", :http_method=>:post, payload: { name: "Jack" }})
+      ShippingEasy::Resources::Order.create(:store_api_key => "123456", payload: { name: "Jack" })
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shipping_easy
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - ShippingEasy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-05 00:00:00.000000000 Z
+date: 2014-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -104,6 +104,7 @@ files:
 - .gitignore
 - .rspec
 - .travis.yml
+- CHANGELOG
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -128,6 +129,7 @@ files:
 - spec/http/request_spec.rb
 - spec/http/response_handler_spec.rb
 - spec/resources/base_spec.rb
+- spec/resources/order_spec.rb
 - spec/signature_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/ShippingEasy/shipping_easy-ruby
@@ -150,7 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: The official ShippingEasy API client for Ruby.
@@ -161,5 +163,6 @@ test_files:
 - spec/http/request_spec.rb
 - spec/http/response_handler_spec.rb
 - spec/resources/base_spec.rb
+- spec/resources/order_spec.rb
 - spec/signature_spec.rb
 - spec/spec_helper.rb