cordial 0.1.12 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: abc91b0ced583d2e4807f083d21c969f8c8047f12eeda2bd1a6c73a0cc493a63
-  data.tar.gz: 72964cb60ef7cf3724cb25470b52f94aec62ca88b53489f4a7510533458c3399
+  metadata.gz: fc3770bdbc18b1976cc244a4029ce9b165aee66c1a4c5d71dd057788871ab2cf
+  data.tar.gz: a3c68b2700ba2d5f017234c5f83f38938e03a1700d85b6fc2ce84d709500dfbd
 SHA512:
-  metadata.gz: 961e52a54f0bb6e78fe3006923284c457933d6c5c84953d898652b3fea614b02c33257dd557d09801065c1ed9383966b757e85434d774e583ba399c11c6d6264
-  data.tar.gz: 8b8ca74ffa9e88e1561863c1514b93c1b782c5f2a810ec1b7c581e4a6f67bf522083434908da25df3f57bea7ecb2d119366d2103fa0d3446d5a4eb0caa932672
+  metadata.gz: 1a7839aed557e837f04bf412a2923131ae29a84b21679edba9e7e6ee501ab608e44949bd651d924b6e5d7f10e618deb52c2b7ee762a3220c9d622a00e19839b8
+  data.tar.gz: 4707b6dae09f3be12df850b14e970290c8537128a726ec1158d6e19716ccbc5ee49c052c7f1997d932adc8a842ab6ab0b0cb2753f0265c2715dffda2d02cbd42

data/History.md

@@ -1,4 +1,11 @@
 
+v1.0.0 / 2018-12-04
+==================
+
+  * First stable release!
+  * Update Yardoc for Products
+  * Update Yardoc for Cordial::Orders
+
 v0.1.12 / 2018-10-04
 ==================
 

data/lib/cordial/orders.rb

@@ -1,5 +1,6 @@
 module Cordial
-  # Wraps all interaction with the Order resource.
+  # Pragmatic wrapper around the orders REST Api.
+  #
   # @see https://api.cordial.io/docs/v1/#!/orders
   class Orders
     include ::HTTParty
@@ -8,52 +9,51 @@ module Cordial
     # 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"}
+    # @param id [String|Fixnum] The order's id.
+    #
+    # @return [Hash]
+    # @return [{"error"=>true, "message"=>"record not found"}]
     def self.find(id:)
       client.get("/orders/#{id}")
     end
 
     # Create a new order.
     #
-    # This endpoint does not support the idea of an upsert like others do.
-    # Subsequent calls will fail.
+    # @note This endpoint does not support upsert.
     #
     # @example Usage.
-    # Cordial::Orders.create({...})
+    #   Cordial::Orders.create({...})
     #
-    # @example response when the orderID is not on cordial
-    # {"success"=>true}
-    #
-    # @example Response when orderID already exist on cordial.
-    # {"error"=>true, "messages"=>"ID must be unique"}
+    # @return [{"success"=>true}]
+    # @return [{"error"=>true, "messages"=>"ID must be unique"}]
     def self.create(options)
       order = Cordial::Order.new(options)
       client.post('/orders', body: order.to_json)
     end
 
-    # List orders in Cordial
+    # List Orders matching criteria.
+    #
+    # @example
+    #   Cordial::Orders.index(
+    #     fields: 'orderID,purchaseDate',
+    #     purchaseDate: { 'lt': '2018-10-21 11:11:11' },
+    #     per_page: 5
+    #   )
+    #
+    # @option options [String] :fields Comma delimited string of fields to be returned.
+    # @option options [String] :cID Where Customer ID is..
+    # @option options [String] :email Where email is..
+    # @option options [Hash] :purchaseDate When purchased on, before, and after (YYYY-MM-DD HH:ii:ss)
+    #   {
+    #     'eq': '2018-10-31 11:59:59',
+    #     'lt': '2018-10-31 11:59:59',
+    #     'gt': '2018-10-31 11:59:59'
+    #     }
+    # @option options [Fixnum] :page Which page of results
+    # @option options [Fixnum] :per_page How many results to return on a page (max: 10,000)
+    #
+    # @return [Array<Hash>]
     def self.index(options = {})
       client.get(
         '/orders',

data/lib/cordial/products.rb

@@ -1,41 +1,40 @@
 module Cordial
-  # Wraps all interaction with the Product resource.
+  # Pragmatic wrapper around the products REST Api.
+  #
   # @see https://api.cordial.io/docs/v1/#!/products
   class Products
     include ::HTTParty
     extend Client
 
     # Find a product.
+    #
     # @example Usage
     #  Cordial::Products.find(id: 1)
-    # @example Response when the product was found.
-    # {
-    #   "_id"=>"5b28275fe1dc0fa0c872abec",
-    #   "productID"=>"1",
-    #   "productName"=>"Test Product",
-    #   "price"=>10,
-    #   "variants"=>[
-    #     {
-    #       "sku"=>"123456789",
-    #       "attr"=>{"color"=>"blue", "size"=>"Large"},
-    #       "qty"=>"10"}
-    #   ],
-    #   "accountID"=>645,
-    #   "totalQty"=>10,
-    #   "lm"=>"2018-06-18T21:42:55+0000",
-    #   "ct"=>"2018-06-18T21:42:55+0000"
-    # }
     #
-    # @example Response when the product was not found.
-    #  {"error"=>true, "message"=>"record not found"}
+    # @return [Hash]
+    # @return [{"error"=>true, "message"=>"record not found"}]
     def self.find(id:)
       client.get("/products/#{id}")
     end
 
     # Create a new product.
-    # options keyword argument is for optional parameters
-    # https://support.cordial.com/hc/en-us/articles/203886098#postProducts
-    # If the product already exists it will be updated.
+    #
+    # @note If the product already exists it will be updated.
+    #
+    # @see https://support.cordial.com/hc/en-us/articles/203886098#postProducts
+    #
+    # @param id [String|Fixnum]
+    # @param name [String]
+    #
+    # @option options [Float] :price
+    # @option options [Array<Hash>] :variants
+    # @option options [Boolean] :inStock
+    # @option options [Boolean] :taxable
+    # @option options [Boolean] :enabled
+    # @option options [Array] :tags
+    # @option options [String] :url
+    # @option options [Hash] :properties
+    #
     # @example Usage.
     #  Cordial::Products.create(
     #    id: 1,

data/lib/cordial/version.rb

@@ -1,3 +1,3 @@
 module Cordial
-  VERSION = '0.1.12'.freeze
+  VERSION = '1.0.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cordial
 version: !ruby/object:Gem::Version
-  version: 0.1.12
+  version: 1.0.0
 platform: ruby
 authors:
 - Andrew Hood
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-04 00:00:00.000000000 Z
+date: 2018-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty