cordial 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 00e097395ce9076449736493f8ed557b941ac8ce
-  data.tar.gz: c7cde2dd40046ae267bc7330dbb3ea9a7fb7b582
+  metadata.gz: 0dcf152bb33ca690ab905e561239fe97eda9c585
+  data.tar.gz: e2aabb3f2ba3808f9afc9ebcc18b7d21c9bacd01
 SHA512:
-  metadata.gz: d28fd6abcbc527439679b89f71f5d3b4898c3d5e3aa73792e104c9c32acfeec62c2c5d2f8cf132437ec866f4a7458656f7d3d5b10310caa110513e4c1268837d
-  data.tar.gz: fc6ba4dab4ba050346a558a5ca76308c7c682c3d60eaf413b9ecf565502ed799a47f845ee5aff34255d58ba41fe50682b4ba23fbec052590539b571baada2e54
+  metadata.gz: 2396e02c793ac977fea04f1613391311d7f55333814ddb4f0b6b3cece11a6a5e707c449ea5dda7dd74ad5ff27e900150b1adf1e6ca3fd816e0dd96e5266afc0f
+  data.tar.gz: 91ab6d0cbcf3d0a600f997e9a5acdaa46aaf409f45c28c5c0df5dfa4869f0e417d90f20f368fa307c83b4f2609367b2b348f5d31ebbcba1469a5eef3fe5d7d94

data/lib/cordial/orders.rb

@@ -0,0 +1,65 @@
+module Cordial
+  # Wraps all interaction with the Order resource.
+  # @see https://api.cordial.io/docs/v1/#!/orders
+  class Orders
+    include ::HTTParty
+    extend Client
+
+    # Find an order
+    # @example Usage
+    #  Cordial::Orders.find(id: 1)
+    # @example Response when the order was found
+    # {
+    #   "_id"=>"5b3a774a2cab4e1a59d0cc6d",
+    #   "orderID"=>"1",
+    #   "purchaseDate"=>"2015-01-10T01:47:43+0000",
+    #   "items"=>[
+    #     {
+    #       "productID"=>"1",
+    #       "sku"=>"123",
+    #       "name"=>"Test product",
+    #       "attr"=>{
+    #         "color"=>"blue",
+    #         "size"=>"L"
+    #        },
+    #       "amount"=>0
+    #     }
+    #   ],
+    #   "cID"=>"5aea409bbb3dc2f9bc27158f",
+    #   "totalAmount"=>0
+    # }
+    #
+    # @example Response when the order was not found.
+    #  {"error"=>true, "message"=>"record not found"}
+    def self.find(id:)
+      client.get("/orders/#{id}")
+    end
+
+    # Create a new order.
+    # Posting more than one time the same "orderID" name will generate an error.
+    #
+    # @example Usage.
+    # Cordial::Orders.create(
+    #   id: 1,
+    #   email: 'cordial@example.com',
+    #   purchase_date: '2015-01-09 17:47:43',
+    #   items: [{productID: '1',
+    #            sku: '123',
+    #            name: 'Test product',
+    #            attr: { color: 'blue', size: 'L' }}])
+    # @example response whe the orderID is not on cordial
+    # {"success"=>true}
+    #
+    # @example Response when orderID already exist on cordial.
+    # {"error"=>true, "messages"=>"ID must be unique"}
+    def self.create(id:, email:, purchase_date:, items:)
+      client.post('/orders',
+                  body: {
+                    orderID: id,
+                    email: email,
+                    purchaseDate: purchase_date,
+                    items: items
+                  }.to_json)
+    end
+  end
+end

data/lib/cordial/products.rb

@@ -7,7 +7,7 @@ module Cordial
 
     # Find a product.
     # @example Usage
-    #  Cordial::products.find(product_id: 1)
+    #  Cordial::Products.find(id: 1)
     # @example Response when the product was found.
     # {
     #   "_id"=>"5b28275fe1dc0fa0c872abec",
@@ -37,8 +37,8 @@ module Cordial
     # If the product already exists it will be updated.
     # @example Usage.
     #  Cordial::Products.create(
-    #    product_id: 1,
-    #    product_name: 'Test Product',
+    #    id: 1,
+    #    name: 'Test Product',
     #    price: 99.99,
     #    variants: [{
     #      sku: '123',

data/lib/cordial/version.rb

@@ -1,3 +1,3 @@
 module Cordial
-  VERSION = '0.1.3'.freeze
+  VERSION = '0.1.4'.freeze
 end

data/lib/cordial.rb

@@ -4,6 +4,7 @@ require "cordial/version"
 require "cordial/client"
 require "cordial/contacts"
 require "cordial/products"
+require "cordial/orders"
 
 module Cordial
   class << self

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cordial
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Andrew Hood
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-25 00:00:00.000000000 Z
+date: 2018-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -130,6 +130,7 @@ files:
 - lib/cordial.rb
 - lib/cordial/client.rb
 - lib/cordial/contacts.rb
+- lib/cordial/orders.rb
 - lib/cordial/products.rb
 - lib/cordial/version.rb
 - lib/utils/compact.rb