ruby-jet 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ab0c6941af59144ef32aede49b14ac55f59b31b9
-  data.tar.gz: 271a0086878c55d64c6232505e074ab30b779c87
+  metadata.gz: 4db850f74e0007fcc41c09b46400d3f26d207523
+  data.tar.gz: 2a956bf74af51e4d5ccc75e28cc0888b0381577c
 SHA512:
-  metadata.gz: 84b566caba7a6e70fce7adb14da6b287fdf88299cb222c8515e65c397d5fd06fa59cb77ba7ff6ed4ea465191a9b32b083b2b99829f224810d7b7c625a4c8dab6
-  data.tar.gz: 84213789ddda46fa88482ffdb13e1870fc7d4dedd489c3cd6a37767aa88e88e5253e20dfcf6c3dd495c7194cd58279cc22901c11cae3edc42aab75128d85caca
+  metadata.gz: 6b163f3737566ed9da2c04bc4df4ca8cb7a4a28af77f015cc97fe83c80e9aa09f111e0bfc396649a332d4cf2f733fd006c281ff8f7af70cb217c237b89a4d463
+  data.tar.gz: 7bfae3a5ebe4e3c086da02f187bfa587776777cdd7d62d7746c8d876e748e5994f84ae99dff387c25802a74ddb646e3bbade83d134a539e4eb2dcf7e783ac8e4

data/README.md

@@ -3,8 +3,144 @@
 [![Build Status](https://travis-ci.org/jasonwells/ruby-jet.svg)](https://travis-ci.org/jasonwells/ruby-jet)
 [![CircleCI](https://circleci.com/gh/jasonwells/ruby-jet.svg?style=shield)](https://circleci.com/gh/jasonwells/ruby-jet)
 [![Dependency Status](https://gemnasium.com/jasonwells/ruby-jet.svg)](https://gemnasium.com/jasonwells/ruby-jet)
-[![Code Climate](https://codeclimate.com/github/jasonwells/ruby-jet/badges/gpa.svg)](https://codeclimate.com/github/jasonwells/ruby-jet)
-[![Test Coverage](https://codeclimate.com/github/jasonwells/ruby-jet/badges/coverage.svg)](https://codeclimate.com/github/jasonwells/ruby-jet/coverage)
 [![Gem Version](https://badge.fury.io/rb/ruby-jet.svg)](https://badge.fury.io/rb/ruby-jet)
 
 [Jet API](https://developer.jet.com/) service calls implemented in Ruby.
+
+## Basic Usage
+
+    require 'Jet'
+
+    jet_client = Jet.client(merchant_id: 'your_merch_id', api_user: 'your_api_user', secret: 'your_secret')
+
+## Products
+[Jet Products API](https://developer.jet.com/docs/merchant-sku)
+
+Product Attributes
+
+```ruby
+attrs = {
+  product_title: 'My Product',
+  ASIN:           '12345ABCDE',
+  brand:          "My Product's Brand",
+  manufacturer:   "My Product's Manufacturer",
+  main_image_url: 'https://c2.q-assets.com/images/products/p/asj/asj-077_1z.jpg',
+  bullets:        [ 'This is bullet line 1',
+                    'This is bullet line 2',
+                  ],
+  product_description: 'This is a terrific product that everyone should own.',
+  multipack_quantity: 1
+}
+```
+
+Call products.update_product to add a new product or update an existing one.
+If the SKU is new, a new product will be created.
+
+```ruby
+response = jet_client.products.update_product('MyNewSku123', attrs)
+```
+
+Retrieve an existing product
+
+```ruby
+product = jet_client.products.get_product('MyNewSku123')
+```
+
+Set the price on a product
+
+```ruby
+response = jet_client.products.update_price('MyNewSku123', price: 30.95)
+```
+
+Update the inventory
+
+```ruby
+response = jet_client.products.update_inventory(
+  'MyNewSku123',
+  fulfillment_nodes: [
+    { fulfillment_node_id: 'node1234', quantity: 100 },
+    { fulfillment_node_id: 'node5678', quantity: 20 }
+  ]
+)
+```
+
+## Retrieve Orders
+[Jet Orders API](https://developer.jet.com/docs/order-status)
+
+get_orders defaults to 'ready' status
+
+```ruby
+response = jet_client.orders.get_orders
+ready_orders = response['order_urls']
+```
+
+Retrieve acknowledged orders
+
+```ruby
+response = jet_client.orders.get_orders(:acknowledged)
+acknowledged_orders = response['order_urls']
+```
+
+Other status options are:
+
+```ruby
+:created
+:ready
+:acknowledged
+:inprogress
+:complete
+```
+
+Retrieve a specific order
+
+```ruby
+order_url = ready_orders.first
+order = jet_client.orders.get_order(order_url)
+```
+
+## Acknowledge an Order
+[Jet Acknowledge Order API](https://developer.jet.com/docs/acknowledge-order)
+
+```ruby
+jet_order_id = order['merchant_order_id']
+response = jet_client.orders.acknowledge_order(
+  jet_order_id,
+  acknowledgement_status: 'accepted',
+  alt_order_id: '232145', # optional
+  order_items: [
+    { order_item_acknowledgement_status: 'fulfillable',
+      order_item_id: 'b81f073b18f548b892f6d4497af16297',
+      alt_order_item_id: '554443322' # optional
+    }
+  ]
+)
+```
+
+Mark Order as shipped
+[Jet Ship Order API](https://developer.jet.com/docs/ship-order)
+
+```ruby
+response = jet_client.orders.ship_order(
+  jet_order_id,
+  alt_order_id: '232145', # optional
+  shipments: [
+    {
+      alt_shipment_id: '11223344', #optional
+      shipment_tracking_number: '1Z12342452342',
+      response_shipment_date: 0.days.from_now,
+      response_shipment_method: 'ups_ground',
+      expected_delivery_date: 4.days.from_now,
+      ship_from_zip_code: '12061',
+      carrier_pick_up_date: 1.days.from_now,
+      carrier: 'UPS',
+      shipment_items: [
+        { shipment_item_id: '76-s2507-i1810',
+          alt_shipment_item_id: '129900120', # optional
+          merchant_sku: 'MyNewSku123',
+          response_shipment_sku_quantity: 1
+        }
+      ]
+    }
+  ]
+)
+```

data/lib/jet.rb

@@ -1,4 +1,5 @@
-class Jet
+# Jet API module
+module Jet
   def self.client(credentials = {})
     Client.new(credentials)
   end

data/lib/jet/client.rb

@@ -1,80 +1,80 @@
 require 'rest-client'
 require 'oj'
 
-class Jet::Client
-  API_URL = 'https://merchant-api.jet.com/api'
-
-  def initialize(config = {})
-    @api_user = config[:api_user]
-    @secret = config[:secret]
-    @merchant_id = config[:merchant_id]
-  end
-
-  def encode_json(data)
-    Oj.dump(data, mode: :compat)
-  end
+module Jet
+  # Jet API Client
+  class Client
+    API_URL = 'https://merchant-api.jet.com/api'.freeze
+
+    def initialize(config = {})
+      @api_user = config[:api_user]
+      @secret = config[:secret]
+      @merchant_id = config[:merchant_id]
+    end
 
-  def decode_json(json)
-    Oj.load(json)
-  end
+    def encode_json(data)
+      Oj.dump(data, mode: :compat)
+    end
 
-  def token
-    if not (@id_token and @token_type and @expires_on > Time.now)
-      body = {
-        user: @api_user,
-        pass: @secret
-      }
-      response = RestClient.post("#{API_URL}/token", encode_json(body))
-      parsed_response = decode_json(response.body)
-      @id_token = parsed_response['id_token']
-      @token_type = parsed_response['token_type']
-      @expires_on = Time.parse(parsed_response['expires_on'])
+    def decode_json(json)
+      Oj.load(json)
     end
 
-    { Authorization: "#{@token_type} #{@id_token}" }
-  end
+    def token
+      unless @id_token && @token_type && @expires_on > Time.now
+        body = { user: @api_user, pass: @secret }
+        response = RestClient.post("#{API_URL}/token", encode_json(body))
+        parsed_response = decode_json(response.body)
+        @id_token = parsed_response['id_token']
+        @token_type = parsed_response['token_type']
+        @expires_on = Time.parse(parsed_response['expires_on'])
+      end
+
+      { Authorization: "#{@token_type} #{@id_token}" }
+    end
 
-  def rest_get_with_token(path, query_params = {})
-    headers = token
-    headers.merge!({ params: query_params }) unless query_params.empty?
-    response = RestClient.get("#{API_URL}#{path}", headers)
-    decode_json(response.body) if response.code == 200
-  end
+    def rest_get_with_token(path, query_params = {})
+      headers = token
+      headers[:params] = query_params unless query_params.empty?
+      response = RestClient.get("#{API_URL}#{path}", headers)
+      decode_json(response.body) if response.code == 200
+    end
 
-  def rest_put_with_token(path, body = {})
-    headers = token
-    response = RestClient.put("#{API_URL}#{path}", body.to_json, headers)
-    decode_json(response.body) if response.code == 200
-  end
+    def rest_put_with_token(path, body = {})
+      headers = token
+      response = RestClient.put("#{API_URL}#{path}", encode_json(body), headers)
+      decode_json(response.body) if response.code == 200
+    end
 
-  def rest_post_with_token(path, body = {})
-    headers = token
-    response = RestClient.post("#{API_URL}#{path}", body.to_json, headers)
-    decode_json(response.body) if response.code == 201
-  end
+    def rest_post_with_token(path, body = {})
+      headers = token
+      response = RestClient.post("#{API_URL}#{path}", encode_json(body), headers)
+      decode_json(response.body) if response.code == 201
+    end
 
-  def orders
-    Orders.new(self)
-  end
+    def orders
+      Orders.new(self)
+    end
 
-  def returns
-    Returns.new(self)
-  end
+    def returns
+      Returns.new(self)
+    end
 
-  def products
-    Products.new(self)
-  end
+    def products
+      Products.new(self)
+    end
 
-  def taxonomy
-    Taxonomy.new(self)
-  end
+    def taxonomy
+      Taxonomy.new(self)
+    end
 
-  def files
-    Files.new(self)
-  end
+    def files
+      Files.new(self)
+    end
 
-  def refunds
-    Refunds.new(self)
+    def refunds
+      Refunds.new(self)
+    end
   end
 end
 
@@ -84,3 +84,4 @@ require 'jet/client/products'
 require 'jet/client/taxonomy'
 require 'jet/client/files'
 require 'jet/client/refunds'
+require 'jet/client/returns'

data/lib/jet/client/files.rb

@@ -1,36 +1,39 @@
-require 'rest-client'
-require 'oj'
 require 'zlib'
 require 'stringio'
 
-class Jet::Client::Files
-  def initialize(client)
-    @client = client
-  end
+module Jet
+  class Client
+    # Files client
+    class Files
+      def initialize(client)
+        @client = client
+      end
 
-  def upload_token
-    @client.rest_get_with_token('/files/uploadToken')
-  end
+      def upload_token
+        @client.rest_get_with_token('/files/uploadToken')
+      end
 
-  def file_upload(url, body)
-    headers = { 'x-ms-blob-type' => 'blockblob' }
-    io = StringIO.new
-    gz = Zlib::GzipWriter.new(io)
-    gz.write(body)
-    gz.close
-    gzipped_body = io.string
-    response = RestClient.put(url, gzipped_body, headers)
-    @client.decode_json(response.body) if response.code == 200
-  end
+      def file_upload(url, body)
+        headers = { 'x-ms-blob-type' => 'blockblob' }
+        io = StringIO.new
+        gz = Zlib::GzipWriter.new(io)
+        gz.write(body)
+        gz.close
+        gzipped_body = io.string
+        response = RestClient.put(url, gzipped_body, headers)
+        @client.decode_json(response.body) if response.code == 200
+      end
 
-  def uploaded_files(url, file_type, file_name)
-    headers = @client.token
-    body = { url: url, file_type: file_type, file_name: file_name }
-    response = RestClient.post("#{Jet::Client::API_URL}/files/uploaded", @client.encode_json(body), headers)
-    @client.decode_json(response.body) if response.code == 200
-  end
+      def uploaded_files(url, file_type, file_name)
+        headers = @client.token
+        body = { url: url, file_type: file_type, file_name: file_name }
+        response = RestClient.post("#{Jet::Client::API_URL}/files/uploaded", @client.encode_json(body), headers)
+        @client.decode_json(response.body) if response.code == 200
+      end
 
-  def jet_file_id(file_id)
-    @client.rest_get_with_token("/files/#{file_id}")
+      def jet_file_id(file_id)
+        @client.rest_get_with_token("/files/#{file_id}")
+      end
+    end
   end
 end

data/lib/jet/client/orders.rb

@@ -1,41 +1,50 @@
-require 'rest-client'
-
-class Jet::Client::Orders
-
-  STATUSES = {
-    created: 'created',
-    ready: 'ready',
-    acknowledged: 'acknowledged',
-    inprogress: 'inprogress',
-    complete: 'complete',
-  }
-
-  def initialize(client)
-    @client = client
-  end
-
-  def get_orders(status = :ready)
-    query_status = STATUSES[status]
-    @client.rest_get_with_token("/orders/#{query_status}")
-  end
-
-  def get_order(order_url)
-    @client.rest_get_with_token(order_url)
-  end
-
-  def get_order_by_id(order_id)
-    @client.rest_get_with_token("/orders/withoutShipmentDetail/#{order_id}")
-  end
-
-  def acknowledge_order(order_id, body = {})
-    @client.rest_put_with_token("/orders/#{order_id}/acknowledge", body)
-  end
-
-  def ship_order(order_id, body = {})
-    @client.rest_put_with_token("/orders/#{order_id}/shipped", body)
-  end
-
-  def get_directed_cancel
-    @client.rest_get_with_token('/orders/directedCancel')
+module Jet
+  class Client
+    # Orders client
+    class Orders
+      STATUSES = {
+        created: 'created',
+        ready: 'ready',
+        acknowledged: 'acknowledged',
+        inprogress: 'inprogress',
+        complete: 'complete'
+      }
+
+      def initialize(client)
+        @client = client
+      end
+
+      def get_orders(status = :ready, params = {})
+        query_status = STATUSES[status]
+        @client.rest_get_with_token("/orders/#{query_status}", params)
+      end
+
+      def get_order(order_url)
+        @client.rest_get_with_token(order_url)
+      end
+
+      def get_order_by_id(order_id)
+        @client.rest_get_with_token("/orders/withoutShipmentDetail/#{order_id}")
+      end
+
+      def acknowledge_order(order_id, body = {})
+        @client.rest_put_with_token("/orders/#{order_id}/acknowledge", body)
+      end
+
+      def ship_order(order_id, body = {})
+        @client.rest_put_with_token("/orders/#{order_id}/shipped", body)
+      end
+
+      def tag_order(order_id, tag)
+        body = { tag: tag } if tag
+        @client.rest_put_with_token("/orders/#{order_id}/tag", body)
+      end
+
+      def check_for_tagged_orders(status, tag, with_tag = true)
+        query_status = STATUSES[status]
+        query_with_tag = with_tag ? true : false
+        @client.rest_get_with_token("/orders/#{query_status}/#{tag}/#{query_with_tag}")
+      end
+    end
   end
 end

data/lib/jet/client/products.rb

@@ -1,39 +1,42 @@
-require 'rest-client'
-
-class Jet::Client::Products
-  def initialize(client)
-    @client = client
-  end
-
-  def update_inventory(merchant_sku, body = {})
-    @client.rest_put_with_token("/merchant-skus/#{merchant_sku}/inventory", body)
-  end
-
-  def get_inventory(merchant_sku)
-    @client.rest_get_with_token("/merchant-skus/#{merchant_sku}/inventory")
-  end
-
-  def update_product(merchant_sku, body = {})
-    @client.rest_put_with_token("/merchant-skus/#{merchant_sku}", body)
-  end
-
-  def get_product(merchant_sku)
-    @client.rest_get_with_token("/merchant-skus/#{merchant_sku}")
-  end
-
-  def update_price(merchant_sku, body = {})
-    @client.rest_put_with_token("/merchant-skus/#{merchant_sku}/price", body)
-  end
-
-  def get_price(merchant_sku)
-    @client.rest_get_with_token("/merchant-skus/#{merchant_sku}/price")
-  end
-
-  def update_image(merchant_sku, body = {})
-    @client.rest_put_with_token("/merchant-skus/#{merchant_sku}/image", body)
-  end
-
-  def get_products(params = {})
-    @client.rest_get_with_token('/merchant-skus', params)
+module Jet
+  class Client
+    # Products client
+    class Products
+      def initialize(client)
+        @client = client
+      end
+
+      def update_inventory(merchant_sku, body = {})
+        @client.rest_put_with_token("/merchant-skus/#{merchant_sku}/inventory", body)
+      end
+
+      def get_inventory(merchant_sku)
+        @client.rest_get_with_token("/merchant-skus/#{merchant_sku}/inventory")
+      end
+
+      def update_product(merchant_sku, body = {})
+        @client.rest_put_with_token("/merchant-skus/#{merchant_sku}", body)
+      end
+
+      def get_product(merchant_sku)
+        @client.rest_get_with_token("/merchant-skus/#{merchant_sku}")
+      end
+
+      def update_price(merchant_sku, body = {})
+        @client.rest_put_with_token("/merchant-skus/#{merchant_sku}/price", body)
+      end
+
+      def get_price(merchant_sku)
+        @client.rest_get_with_token("/merchant-skus/#{merchant_sku}/price")
+      end
+
+      def update_image(merchant_sku, body = {})
+        @client.rest_put_with_token("/merchant-skus/#{merchant_sku}/image", body)
+      end
+
+      def get_products(params = {})
+        @client.rest_get_with_token('/merchant-skus', params)
+      end
+    end
   end
 end

data/lib/jet/client/refunds.rb

@@ -1,28 +1,30 @@
-require 'rest-client'
+module Jet
+  class Client
+    # Refunds client
+    class Refunds
+      STATUSES = {
+        created: 'created',
+        processing: 'processing',
+        accepted: 'accepted',
+        rejected: 'rejected'
+      }.freeze
 
-class Jet::Client::Refunds
+      def initialize(client)
+        @client = client
+      end
 
-  STATUSES = {
-    created: 'created',
-    processing: 'processing',
-    accepted: 'accepted',
-    rejected: 'rejected',
-  }
+      def create_merchant_initiated_refund(order_id, alt_refund_id, body = {})
+        @client.rest_post_with_token("/refunds/#{order_id}/#{alt_refund_id}", body)
+      end
 
-  def initialize(client)
-    @client = client
-  end
-
-  def create_merchant_initiated_refund(order_id, alt_refund_id, body = {})
-    @client.rest_post_with_token("/refunds/#{order_id}/#{alt_refund_id}", body)
-  end
-
-  def check_refund_state(refund_authorization_id)
-    @client.rest_get_with_token("/refunds/state/#{refund_authorization_id}")
-  end
+      def check_refund_state(refund_authorization_id)
+        @client.rest_get_with_token("/refunds/state/#{refund_authorization_id}")
+      end
 
-  def check_for_created_refunds(status)
-    query_status = STATUSES[status]
-    @client.rest_get_with_token("/refunds/#{query_status}")
+      def check_for_created_refunds(status)
+        query_status = STATUSES[status]
+        @client.rest_get_with_token("/refunds/#{query_status}")
+      end
+    end
   end
 end

data/lib/jet/client/returns.rb

@@ -1,32 +1,33 @@
-require 'rest-client'
+module Jet
+  class Client
+    # Returns client
+    class Returns
+      STATUSES = {
+        created: 'created',
+        inprogress: 'inprogress',
+        completed_by_merchant: 'completed%20by%20merchant'
+      }.freeze
 
-class Jet::Client::Returns
+      def initialize(client)
+        @client = client
+      end
 
-  STATUSES = {
-    created: 'created',
-    acknowledged: 'acknowledged',
-    refund_customer_without_return: 'refund%20customer%20without%20return',
-    completed_by_merchant: 'completed%20by%20merchant',
-  }
+      def get_returns(status = :created)
+        query_status = STATUSES[status]
+        @client.rest_get_with_token("/returns/#{query_status}")
+      end
 
-  def initialize(client)
-    @client = client
-  end
-
-  def get_returns(status = :created)
-    query_status = STATUSES[status]
-    @client.rest_get_with_token("/returns/#{query_status}")
-  end
+      def get_return(return_url)
+        @client.rest_get_with_token(return_url)
+      end
 
-  def get_return(return_url)
-    @client.rest_get_with_token(return_url)
-  end
-
-  def get_return_by_id(return_id)
-    @client.rest_get_with_token("/returns/state/#{return_id}")
-  end
+      def get_return_by_id(return_id)
+        @client.rest_get_with_token("/returns/state/#{return_id}")
+      end
 
-  def complete_return(return_id, body = {})
-    @client.rest_put_with_token("/returns/#{return_id}/complete", body)
+      def complete_return(return_id, body = {})
+        @client.rest_put_with_token("/returns/#{return_id}/complete", body)
+      end
+    end
   end
 end

data/lib/jet/client/taxonomy.rb

@@ -1,20 +1,23 @@
-require 'rest-client'
+module Jet
+  class Client
+    # Taxonomy client
+    class Taxonomy
+      def initialize(client)
+        @client = client
+      end
 
-class Jet::Client::Taxonomy
-  def initialize(client)
-    @client = client
-  end
-
-  def get_links(limit, offset, version = "v1")
-    params = { limit: limit, offset: offset }
-    @client.rest_get_with_token("/taxonomy/links/#{version}", params)
-  end
+      def get_links(limit, offset, version = 'v1')
+        params = { limit: limit, offset: offset }
+        @client.rest_get_with_token("/taxonomy/links/#{version}", params)
+      end
 
-  def get_node(node_url)
-    @client.rest_get_with_token(node_url)
-  end
+      def get_node(node_url)
+        @client.rest_get_with_token(node_url)
+      end
 
-  def get_node_attributes(node_url)
-    @client.rest_get_with_token("#{node_url}/attributes")
+      def get_node_attributes(node_url)
+        @client.rest_get_with_token("#{node_url}/attributes")
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-jet
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Jason Wells
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-02 00:00:00.000000000 Z
+date: 2017-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.15'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.15'
+        version: '3.0'
 description: Jet API service calls implemented in Ruby
 email:
 - flipstock@gmail.com
@@ -76,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Jet API for Ruby