seko 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5976b3e8bc956648f84a39411a4b6fe0f88edc21
-  data.tar.gz: 29b21e380b0f27c505ef4347d86a280147ee9daa
+  metadata.gz: 8b603e2b49029a30eac30262835d8285ce94dd78
+  data.tar.gz: e403a57825c6840f14eb93ef428af310960d743c
 SHA512:
-  metadata.gz: 70331ad66b6ce7350bd28356bb677f329ac960c0bbfbbf62cc243a871a04dab88d37d76236ce7d273b12ea7a676939e18556b65fc0e6728caa7f8aa3196c6f1f
-  data.tar.gz: 58623c90f93c5019baba0161e9ea257f25b4e534e323338141dc0132f136ca503de8518ce93d24800b1df3b3e1233b4377b50a16648c9a93214488141ec9bf78
+  metadata.gz: 58acd945444a32b1dd26cdde88d7870c69eb7f76b810433c8a0f17ed700e8f87d8ef693d7875b5d308bc6c114b749d96b1244392101abf1de015ea7e79470874
+  data.tar.gz: aaae368484a0e747089fb10196b97fffc1e8b6c03bbe5a9428707ef9940569f69e3a628072bd28c47e83bcda88f5c50ff8756501adf926e7f5ac5c22098ccabb

data/README.md

@@ -43,8 +43,8 @@ config/initializers/seko.rb
 ```ruby
 Seko.configure(
   token:                'SekoAPIToKeN'
-  supplier_code:        'DEFSUPLJLTD001',
-  supplier_description: 'Default Supplier LARSSON & JENNINGS LTD',
+  supplier_code:        'DEFSUPTCLTD001',
+  supplier_description: 'Default Supplier TEST COMPANY LTD',
   supplier_uom:         1,
   warehouses: {
     us: 'US123',
@@ -53,6 +53,23 @@ Seko.configure(
 )
 ```
 
+#### Basics
+
+In order to communicate with Seko(SupplyStream) you need to instantiate an instance of the `Seko::Client` class using the token configured in the configuration step above.
+
+```ruby
+client = Seko::Client.new(Seko.config[:token])
+```
+
+#### Testing vs. Live Mode
+
+In order to use the live endpoint and corresponding live account with Seko you should pass it in as an argument to the client since the default is test mode.
+
+```ruby
+client = Seko::Client.new(Seko.config[:token], { test_mode: false })
+```
+
+
 #### Submit Product
 
 ```ruby
@@ -60,15 +77,19 @@ client   = Seko::Client.new(Seko.config[:token])
 response = client.submit_product(upc: "123456", description: 'A test product')
 ```
 
-#### Submit Receipt
+This will post product information to Supply Stream. However, your account representative will need to apply stock levels.
+
+#### Send Return Request
 
 ```ruby
 line_items = [ { upc: "123456", quantity: 10 } ]
 warehouse  = Seko.config[:warehouses][:us]
 client     = Seko::Client.new(Seko.config[:token])
-response   = client.submit_receipt(line_item_array, warehouse)
+response   = client.send_return_request(line_item_array, warehouse)
 ```
 
+Once a return return request is submited, also know as an Advanced Shipment Notice(ASN), the warehouse will either send a push notification with a Goods Received Notice(GRN) or you can check the GRN status below by using the GUID generated by this request.
+
 #### Submit Company
 
 ```ruby
@@ -80,6 +101,8 @@ client     = Seko::Client.new(Seko.config[:token])
 response   = client.submit_company(company_hash)
 ```
 
+Useful for submitting companies to place wholesale orders.
+
 #### Get Stock
 
 ```ruby
@@ -87,6 +110,8 @@ client   = Seko::Client.new(Seko.config[:token])
 response = client.get_inventory
 ```
 
+Getting inventory will return inventory for all Warehouses configured. Pass in the warehouse identifier to filter the results by warehouse.
+
 #### Check GRN
 
 ```ruby
@@ -94,6 +119,8 @@ client   = Seko::Client.new(Seko.config[:token])
 response = client.check_grn('5b2dcd8e-52c3-4e27-a712-eaacda2dd8fe')
 ```
 
+Check the status of a Return Request(ASN) submitted.
+
 #### Order Status
 
 ```ruby
@@ -101,6 +128,8 @@ client   = Seko::Client.new(Seko.config[:token])
 response = client.order_status('5b2dcd8e-52c3-4e27-a712-eaacda2dd8fe')
 ```
 
+Check the status of an order.
+
 #### Order Tracking
 
 ```ruby
@@ -108,6 +137,8 @@ client   = Seko::Client.new(Seko.config[:token])
 response = client.order_tracking('5b2dcd8e-52c3-4e27-a712-eaacda2dd8fe')
 ```
 
+Get the tracking information for a given order.
+
 #### Cancel Order
 
 ```ruby
@@ -125,6 +156,8 @@ client   = Seko::Client.new(Seko.config[:token])
 response = client.cancel_order('5b2dcd8e-52c3-4e27-a712-eaacda2dd8fe', '001')
 ```
 
+Cancels a placed order, only works if the order isn't already shipped.
+
 #### Stock Movements
 
 ```ruby

data/lib/seko/client.rb

@@ -102,7 +102,7 @@ module Seko
       post(Product.format(product_hash))
     end
 
-    def submit_receipt(line_item_array, warehouse)
+    def send_return_request(line_item_array, warehouse)
       @service  = 'receipts'
       @endpoint = 'submit'
       post(Receipt.format(line_item_array, warehouse))
@@ -166,6 +166,10 @@ module Seko
       "#{API_PATH}#{service}/#{API_VERSION}/#{endpoint}.json"
     end
 
+    def requires_warehouse?
+      true
+    end
+
     private
     def default_options
       { 

data/lib/seko/receipt.rb

@@ -12,14 +12,16 @@ module Seko
       end
     end
 
-    def self.format(items, warehouse)
+    def self.format(return_auth, warehouse)
       {
         "Request" => {
           "List" => {
-            "ReceiptLineItem" => line_items(items)
+            "ReceiptLineItem" => line_items(return_auth[:line_items])
           },
           "Receipt" => {
-            "ASNNumber" => random_asn
+            "ASNNumber"   => random_asn,
+            "HBReference" => return_auth[:number],
+            "IsReturn"    => true
           },
           "ReceiptHeader" => {
             "DCCode" => warehouse

data/lib/seko/version.rb

@@ -1,3 +1,3 @@
 module Seko
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/spec/fixtures/receipt_submit.json

@@ -17,7 +17,9 @@
       ]
     },
     "Receipt": {
-      "ASNNumber": 123456
+      "ASNNumber":   123456,
+      "HBReference": "RMA123456789",
+      "IsReturn":    true
     },
     "ReceiptHeader": {
       "DCCode": "DC123"

data/spec/lib/client_spec.rb

@@ -108,13 +108,13 @@ describe Seko::Client do
     end
   end
 
-  describe '#submit_receipt' do
+  describe '#send_return_request' do
     before do
       stub_post("receipts/v1/submit.json").with(query: {token: token}).
         to_return(body: success_response.to_json, headers: json_headers)
     end
 
-    let(:response) { client.submit_receipt(line_items_array, order_hash[:warehouse]) }
+    let(:response) { client.send_return_request(return_auth_hash, order_hash[:warehouse]) }
 
     it 'sends an POST request with a receipt object' do
       expect(response.success?).to eq(true)

data/spec/lib/receipt_spec.rb

@@ -23,7 +23,7 @@ describe Seko::Receipt do
     it 'formats a fully formed JSON ready hash for receipt' do
       expected_result = fixture(:receipt_submit)
       expect(Seko::Receipt).to receive(:random_asn).and_return(123456)
-      expect(Seko::Receipt.format(line_items_array, 'DC123')).to eq(expected_result)
+      expect(Seko::Receipt.format(return_auth_hash, 'DC123')).to eq(expected_result)
     end
   end
 

data/spec/spec_helper.rb

@@ -94,6 +94,13 @@ def address_hash
   }
 end
 
+def return_auth_hash
+  {
+    number: 'RMA123456789',
+    line_items: line_items_array
+  }
+end
+
 def line_items_array
   [
     {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: seko
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Justin Grubbs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-26 00:00:00.000000000 Z
+date: 2015-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -167,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.6
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A ruby wrapper for interfacing with Seko Logistics' SupplySteam iHub API