vending-machine 0.1.0 → 0.1.1

data/README.md

@@ -51,7 +51,7 @@ Once you have a store instance you can retrieve your objects
 ```ruby
 customers = store.customers
 customers.first.customer_code
-=> ["WALKIN"]
+=> "WALKIN"
 ```
 
 ### Payment Types
@@ -69,6 +69,7 @@ store.products.map &:name
 => ["Coffee (Demo)", "T-shirt (Demo)", "Discount", "test"]
 ```
 
+#### Scopes
 Scopes available: `active`, `order_by`, `order_direction` and an `order` shortcut to do both order by and direction at once. Scopes are chainable.
 
 ```ruby
@@ -85,6 +86,34 @@ store.products.order('name', 'DESC').map &:name
 => ["test", "T-shirt (Demo)", "Discount", "Coffee (Demo)"]
 ```
 
+#### Creating a Product
+
+Initialize a new product with `#build`, `#create` or `#create!`.
+
+* `build` create an unsaved instance
+* `create` create an instance, and call `#save`
+* `create!` create an instance, and call `#save!`
+
+
+```ruby
+product = store.products.build name: "Product Name", handle: "prod1", retail_price: 25
+
+# Safe save
+product.save
+=> false
+
+product.error
+=> ["Could not Add or Update: Missing sku"]
+
+# Explosive save
+product.save!
+=> Vend::ValidationFailed: Could not Add or Update: Missing sku
+
+product.sku = 'prod1'
+product.save!
+=> true
+```
+
 ### Register Sales
 
 ```ruby
@@ -93,10 +122,10 @@ sales = store.sales
 sales.map{|sale| sale.total_price + sale.total_tax }
 => [1337.0, 1341.95]
 
-sales.first.register_sale_products.map &:name
-=> ["T-shirt (Demo)"]
+sales.first.products.map &:name
+=> ["T-shirt (Demo)", "Coffee (Demo)"]
 
-sales.first.register_sale_products.first.to_s
+sales.first.products.first
 => "#<Vend::RegisterSaleProduct:0x007fe238720d68>"
 ```
 
@@ -104,7 +133,7 @@ sales.first.register_sale_products.first.to_s
 
 ```ruby
 store.registers.map &:name
-=> ["Main Register"]
+=> ["Main Register", "Back office Register"]
 ```
 
 ### Suppliers
@@ -118,10 +147,10 @@ store.suppliers.map &:name
 
 ```ruby
 store.taxes.map &:name
-=> ["NZ GST", "AU GST", "Some other tax"]
+=> ["NZ GST", "AU GST", "Asshole Tax"]
 ```
 
-The `default` scope will provide you the first returned default tax (note, this still retrieves all taxes).
+The `default` scope will provide you the first returned default tax (note, this still retrieves all taxes from the API).
 
 ```ruby
 store.taxes.default.name
@@ -138,7 +167,9 @@ store.users.map &:name
 ## Status
 * COMPLETE: GET index resources are implemented, with the exception of Stock Control
 * IN PROGRESS: find  singular resources `store.products.find('some_id')`
-* IN PROGRESS: create resources `store.sale.create products: [product1, product2]`
+* IN PROGRESS: create register sales `store.sale.create products: [product1, product2]`
+* COMPLETE: create products
+* IN PROGRESS: Create Product Variants (This seems to happen when posting a new product with a same handle, but different sku)
 * TODO: Delete resources
 * TODO: Scopes for Customer and Register Sales
 

data/lib/vend/remote_resource.rb

@@ -1,10 +1,36 @@
+require 'json'
+
 module Vend
   class RemoteResource < Resource
     include Vend::DeclarativeSetters
     include Vend::Paths
 
+    attr_reader :error
+
     def save
-      id ? save_existing : save_new
+      begin
+        save!
+      rescue ValidationFailed
+        (@error ||= []) << $!.message
+        false
+      end
+    end
+
+    def save!
+      save_path = id ? update_path : self.class.create_path
+      method = id ? :put : :post
+      response = store.send(method, path: save_path,
+        data: sendable_attributes.to_json,
+        status: 200
+      ).data
+
+      if response['status'] && response['status'] == 'error'
+        raise ValidationFailed.
+          new [response['error'], response['details']].join(': ')
+      end
+
+      self.attributes = response[self.class.path]
+      true
     end
 
     def load
@@ -24,23 +50,5 @@ module Vend
       }
       attributes.delete_if{|name,value| blacklist.include? name }.dup
     end
-
-    def save_new
-      self.attributes = store.post(
-        path: create_path,
-        parameters: sendable_attributes,
-        status: 200
-      ).data
-      self
-    end
-
-    def save_existing
-      self.attributes = store.put(
-        path: update_path,
-        parameters: sendable_attributes,
-        status: 200
-      ).data
-      self
-    end
   end
 end

data/lib/vend/resource_collection.rb

@@ -26,6 +26,10 @@ module Vend
       build(attributes).tap(&:save)
     end
 
+    def create!(attributes = {})
+      build(attributes).tap(&:save!)
+    end
+
     def build(attributes)
       @klass.new(attributes.merge store: @store)
     end

data/lib/vend/resources/inventory.rb

@@ -1,9 +1,6 @@
 # TODO: Implement the attribute declaration as a Proc to avoid this
 module Vend
-  class Product < RemoteResource
-  end
-end
-module Vend
+  class Product < RemoteResource; end
   class Inventory < RemoteResource
     attribute :attributed_cost, Float
     attribute :count, Integer

data/lib/vend/resources/product.rb

@@ -15,6 +15,13 @@ module Vend
     attribute :tax, Float
     attribute :tax_rate, Float
 
+    ##
+    # Required Attributes
+    attribute :name, String
+    attribute :handle, String
+    attribute :sku, String
+    attribute :retail_price, Float
+
     ##
     # Scopes
     collection_scope :active, default: true

data/lib/vend/resources/sale.rb

@@ -8,9 +8,11 @@ module Vend
     attribute :total_price, Float
     attribute :total_tax, Float
     attribute :totals, Hash[Symbol => Float] # Requires updated virtus gem
-    #attribute :totals, Array[Float]
     attribute :user, Vend::User
 
+    alias_method :products, :register_sale_products
+    alias_method :payments, :register_sale_payments
+
     path "register_sale"
   end
 end

data/lib/vend/version.rb

@@ -1,3 +1,3 @@
 module Vend
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vending-machine
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-13 00:00:00.000000000 Z
+date: 2012-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -165,7 +165,6 @@ files:
 - .gitignore
 - Gemfile
 - LICENSE
-- LICENSE.txt
 - README.md
 - Rakefile
 - lib/vend.rb

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2012 Mal Curtis
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.