rafter-fulfillment 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NjY2NWQ2NGVhYWExNDY5YTMyMTcxOGFlMmM5OGM0ZDIxYTA4NTM1OA==
+  data.tar.gz: !binary |-
+    NWM2ZWQxY2M2NzU4YTU2OTRjNjhjNGExMmNkNDA4M2IwMDZkOGQ2MQ==
+SHA512:
+  metadata.gz: !binary |-
+    Y2E5OWE1ZjAxZGZkMWRjODVlOWJhZTliYjE1ZWU1YzE4ODQ2OTJiMWY2NDVm
+    NTQyNGEyNzMzZjY2MDZmZmQxOGFhZjk2NWNlNWU1NzVlYTE4NTMzMjgwZjJi
+    ODliNGIyZDczNzZjMzM0MmRkZjFjOGExYjBlNTNjYTk3OGJkZWQ=
+  data.tar.gz: !binary |-
+    ZDUyYmFiMGIxNmU0N2FhMDQ3YzRiOWMwMThhZGM3Zjg5MTdkMjFjYmVkYzY0
+    ZGNiNDhjZjJiMjU5MmNhM2UwMzJmOWNiMGFjM2QyYjM4MmY0YTg1OGJiOWM5
+    NmZiZTI5YjQyNTVkMTM4ZmUxODQ2MTA4MzJkOGFkODBiZmVlNjk=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.ruby-gemset

@@ -0,0 +1 @@
+rafter-fulfillment

data/.ruby-version

@@ -0,0 +1 @@
+ruby-1.9.3-p484

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rafter-fulfillment.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2014 Rafter, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,246 @@
+# Rafter Fulfillment Client
+
+## Examples
+
+Please note that the examples provided below are intended to be an interaction blueprint and are subject to change.
+
+# Rafter-Fulfillment installation & initialization
+
+To use the Rafter fulfillment client, install with:
+```ruby
+gem install rafter-fulfillment
+```
+
+To initialize the client do the following in Ruby:
+```ruby
+@client = Fulfillment::Client.new(:api_key => 'API-KEY', :host => 'FULFILLMENT-HOST')
+```
+
+* ```API-KEY``` will be given to you by your Rafter technical contact.
+* ```FULFILLMENT-HOST``` will be fulfillment-service.rafter.com for Rafter's production environment.
+
+# Order methods
+
+### Fulfillment::Order.show(client, public_id)
+Shows an order. Response includes resource location information to the order's OrderItems.
+```ruby
+order = Fulfillment::Order.show(@client, @public_id)
+```
+
+### Fulfillment::Order.search(@client, search\_options\_hash)
+Search for orders matching parameters passed in search\_options\_hash.  The resource will be a PagedResult of Orders.
+```ruby
+search_options_hash = {
+  :client_reference_id => 'TEST_ORDER_42'
+}
+@orders = Fulfillment::Order.search(@client, search_options_hash)
+```
+
+### Fulfillment::Order.reject(@client, public\_id, rejected\_code)
+Rejects an order given order\_public\_id. Only orders in the processing status can be rejected.
+Orders will acknowledged order items cannot be rejected.
+```ruby
+rejected_order = Fulfillment::Order.reject(@client, @order.public_id, @order_item.public_id, 1)
+```
+OR
+```ruby
+rejected_order = @order.reject(Fulfillment::Order::REJECT_OUT_OF_STOCK)
+```
+
+Possible rejected\_codes are as follows:
+
+* ```REJECT_CODE_BAD_ORDER_INFO``` invalid order information
+* ```REJECT_CODE_GENERIC``` miscellaneous rejection
+* ```REJECT_CODE_OUT_OF_STOCK``` fulfillment provider is temporarily out of stock
+
+### Fulfillment::Order.processing\_transition(client, public_id)
+Moves a ready order into the processing state.
+This should be done on an order in the ready state to acknowledge it for processing.
+Only the authenticated fulfillment_provider can call this method.
+```ruby
+processing_order = Fulfillment::Order.processing_transition(@client, @public_id)
+```
+OR
+```ruby
+processing_order = order.process
+```
+
+### Fulfillment::Order.shipping\_transition(client, public_id)
+Moves a processing order into the shipping state.
+This should be done on an order in the processing state to indicate it is ready for further shipment information.
+Only the authenticated fulfillment_provider can call this method.
+```ruby
+shipping_order = Fulfillment::Order.shipping_transition(@client, @public_id)
+```
+OR
+```ruby
+shipping_order = order.shipping
+```
+
+### Fulfillment::Order.shipped\_transition(client, public_id, order_shipment_hashes_array)
+Moves a shipping order into the shipped state. This should be done on an order in the shipping state.
+Only the authenticated fulfillment_provider can call this method.
+```ruby
+shipped_order = Fulfillment::Order.shipped_transition(@client, @public_id)
+```
+OR
+```ruby
+shipped_order = order.shipped
+```
+
+# Order Item methods
+
+### Fulfillment::OrderItem.show(client, order\_public\_id, order\_item\_public\_id)
+Shows an OrderItem given order_public_id.
+```ruby
+order_item = Fulfillment::OrderItem.show(@client, @order.public_id, order_item_public_id)
+```
+
+### Fulfillment::OrderItem.list(client, order\_public\_id)
+
+List all OrderItems for order_public_id.  Resource returned will be a PagedResult of OrderItems.
+```ruby
+order_items = Fulfillment::OrderItem.list(@client, @order.public_id).results
+```
+OR
+```ruby
+order_items = @order.order_items.results
+```
+
+### Fulfillment::OrderItem.process(client, order\_public\_id, order\_item\_public_id)
+
+* Moves a RafterItem to processing status given order\_public\_id.
+* Sets RafterItem quantity_requested to quantity_accepted.
+* SupplyItem's should not use this method. Use Fulfillment::OrderItem.acknowledge.
+
+```ruby
+processing_order_item = Fulfillment::OrderItem.process(@client, @order.public_id, @order_item.public_id)
+```
+OR
+```ruby
+processing_order_item = @order_item.process
+```
+
+### Fulfillment::OrderItem.acknowledge(client, order\_public\_id, order\_item\_public_id, acknowledgements)```
+
+* Acknowledges SupplyItem quantity given order\_public\_id.
+* Order must be **ready** or **processing**
+* If quantity_rejected equals the quantity_requested that the OrderItem was created with then the OrderItem will be marked as rejected.
+* Will error if quantity_accepted is decreased for an Order Item.
+
+```ruby
+acknowledgement_hash = {"quantity_accepted" => 3, "quantity_rejected" => 0}
+order_item = Fulfillment::OrderItem.acknowledge(@client, @order.public_id, @order_item.public_id, acknowledgement_hash)
+```
+OR
+```ruby
+order_item_with_acknowledgements = @order_item.acknowledge({"quantity_accepted" => 10, "quantity_rejected" => 2})
+```
+
+### Fulfillment::OrderItem.reject(client, order\_public\_id, order\_item\_public_id, rejected\_code)```
+
+* Rejects an OrderItem given order\_public\_id.
+* Cannot be rejected if previously acknowledged with a quantity_accepted greater than 0.
+* Sets quantity_rejected to quantity_requested.
+
+```ruby
+rejected_order_item = Fulfillment::OrderItem.reject(@client, @order.public_id, @order_item.public_id, 1)
+```
+OR
+```ruby
+rejected_order_item = @order_item.reject(rejected_code)
+```
+
+Possible rejected\_codes are as follows:
+```ruby
+GENERIC_REJECTION = 1 # un-categorized rejection reason
+OUT_OF_STOCK_REJECTION = 2 # fulfillment provider is temporarily out of stock
+ITEM_NOT_STOCKED_REJECTION = 3 # fulfillment provider does not know about this item at all
+RESERVE_EXHAUSTED_REJECTION = 4
+INVALID_QUANTITY_REJECTION = 5
+```
+
+# Shipment methods
+
+
+### Fulfillment::Shipment.create(client, order_public_id, shipment_hash)
+
+Creates shipping information for an existing order.  The order must be in the shipping state.
+
+* The shipment\_hash must contain a ship\_date, tracking\_number, carrier, carrier\_code, a client\_reference\_id, and a fulfillment\_order\_items element containing a list of public IDs that correspond to order line items.  
+* Fulfillment\_order\_items may not be an empty array.  
+* Limited to 100 fulfillment order items on the initial create.  
+* A Shipment resource is returned. 
+* If quantity\_shorted is not provided it will be defaulted to 0. 
+* If quantity\_shipped is not provided it will be defaulted to 1.
+* Will not create Shipment if ShipmentItems are created with more quantity_shipped than quantity_accepted on an OrderItem.
+
+```ruby
+shipment_hash = {
+  :tracking_number => '1Z1234567',
+  :carrier => 'UPS',
+  :carrier_code => 'Second Day',
+  :shipment_reference_id => 'TEST_SHIP_6',
+  :fulfillment_order_items => [
+    {
+      :public_id => 'FOIfb27e0',
+      :quantity_shipped => '2',
+      :quantity_shorted => '1'
+    },
+    {
+      :public_id => 'FOI4eeae3'
+    }
+  ]
+}
+shipment = Fulfillment::Shipment.create(@client, @order.public_id, shipment_hash)
+```
+
+###Fulfillment::Shipment.show(client, shipment_public_id)
+
+Shows a shipment. Response includes resource location information to the shipment items.
+```ruby
+shipment = Fulfillment::Shipment.show(@client, @shipment_public_id)`
+```
+
+###Fulfillment::Shipment.add(client, order_public_id, shipment_public_id, shipment_item_hashes_array)
+
+Adds items to a shipment.  Limited to 100 items at a time, and returning an error if this limit is exceeded.
+The Shipment resource returned will include a location to the order items added as well as the new total number of order items for this order. If quantity\_shorted is not provided it will be defaulted to 0. If quantity\_shipped is not provided it will be defaulted to 1.
+```ruby
+shipment_item_hashes_array = [
+  {
+    :public_id => 'FOIfb27e0',
+    :quantity_shipped => '2',
+    :quantity_shorted => '1'
+  },
+  {
+    :public_id => 'FOI4eeae3'
+  }
+]
+shipment = Fulfillment::Shipment.add(@client, @order.public_id, @shipment.public_id, shipment_item_hashes_array)
+```
+
+###Fulfillment::Shipment.close(client, order_public_id, shipment_public_id)
+
+Moves a FulfillmentShipment into the 'closed' state to signify nothing more will be added to the shipment.
+```ruby
+closed_shipment = Fulfillment::Shipment.close(client, order_public_id, shipment_public_id)
+```
+
+###Fulfillment::Shipment.list(client)
+
+List all shipments.  The resource will be a PagedResult of Shipments.
+```ruby
+shipments = Fulfillment::Shipment.list(client)
+```
+
+###Fulfillment::Shipment.shipment_items(client, shipment_public_id)
+
+List items in a shipment.  The resource will be a PagedResult of ShipmentItems.
+```ruby
+shipment_items = Fulfillment::Shipment.shipment_items(client, shipment_public_id)
+```
+OR
+```ruby
+shipment_items = @shipment.shipment_items
+```