vending-machine 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in vending-machine.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2012 by Mal Curtis
+
+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.

data/LICENSE.txt

@@ -0,0 +1,22 @@
+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.

data/README.md

@@ -0,0 +1,155 @@
+# Vending Machine
+
+Access your [Vend Store](http://vendhq.com) in Ruby! Vending Machine turns the [Vend API](http://docs.vendhq.com/) into Ruby objects, including type coercion and nested objects.
+
+```ruby
+# Create an instance of your store
+store = Vend::Store.new('store_name', 'user_name', 'password')
+
+# Get all your products
+store.products.order('name', 'ASC').map &:name
+=> ["Coffee (Demo)", "Discount", "T-shirt (Demo)", "test"]
+
+# Type coercion
+store.sales.first.total_price.class
+=> Float
+
+# Nested objects
+store.sales.first.register_sale_products.first.class
+=> Vend::RegisterSaleProduct
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'vending-machine'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install vending-machine
+
+## Usage
+
+### Get a store instance
+
+All usage revolves around your store, as per Vend itself
+
+
+```ruby
+store = Vend::Store.new('store_name', 'user_name', 'password')
+```
+
+Once you have a store instance you can retrieve your objects
+
+### Customers
+
+```ruby
+customers = store.customers
+customers.first.customer_code
+=> ["WALKIN"]
+```
+
+### Payment Types
+
+```ruby
+types = store.payment_types
+types.first.name
+=> "Cash"
+```
+
+### Products
+
+```ruby
+store.products.map &:name
+=> ["Coffee (Demo)", "T-shirt (Demo)", "Discount", "test"]
+```
+
+Scopes available: `active`, `order_by`, `order_direction` and an `order` shortcut to do both order by and direction at once. Scopes are chainable.
+
+```ruby
+store.products.active.map &:name
+=> ["T-shirt (Demo)", "Discount", "test"]
+
+store.products.order_by('name').map &:name
+=> ["Coffee (Demo)", "Discount", "T-shirt (Demo)", "test"]
+
+store.products.order_by('name').order_direction('desc').map &:name
+=> ["test", "T-shirt (Demo)", "Discount", "Coffee (Demo)"]
+
+store.products.order('name', 'DESC').map &:name
+=> ["test", "T-shirt (Demo)", "Discount", "Coffee (Demo)"]
+```
+
+### Register Sales
+
+```ruby
+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.register_sale_products.first.to_s
+=> "#<Vend::RegisterSaleProduct:0x007fe238720d68>"
+```
+
+### Registers
+
+```ruby
+store.registers.map &:name
+=> ["Main Register"]
+```
+
+### Suppliers
+
+```ruby
+store.suppliers.map &:name
+=> ["Mal Curtis", "Vend"]
+```
+
+### Taxes
+
+```ruby
+store.taxes.map &:name
+=> ["NZ GST", "AU GST", "Some other tax"]
+```
+
+The `default` scope will provide you the first returned default tax (note, this still retrieves all taxes).
+
+```ruby
+store.taxes.default.name
+=> "NZ GST"
+```
+
+### Users
+
+```ruby
+store.users.map &:name
+=> ["A cashier", "Mal Curtis", "Joe Bloggs"]
+```
+
+## 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]`
+* TODO: Delete resources
+* TODO: Scopes for Customer and Register Sales
+
+## Created By
+
+* [Mal Curtis](https://github.com/snikch). Twitter: [snikchnz](https://twitter.com/snikchnz)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/gem_tasks"
+
+task default: :test
+
+# MiniTest
+require "rake/testtask"
+Rake::TestTask.new do |t|
+  ENV["TESTOPTS"] = "-v"
+  t.pattern = "spec/*_spec.rb"
+end
+
+task :console do
+  sh "irb -rubygems -I lib -r vend.rb"
+end

data/lib/vend.rb

@@ -0,0 +1,46 @@
+$: << File.expand_path(File.dirname(__FILE__))
+%w{
+  version
+  errors
+
+  modules/declarative_setters
+  modules/finders
+  modules/paths
+
+  response
+  resource
+  remote_resource
+  resource_collection
+
+  resources/brand
+  resources/contact
+  resources/customer
+  resources/outlet
+  resources/payment_type
+  resources/product_type
+  resources/supplier
+  resources/register_sale_product
+  resources/register_sale_payment
+  resources/price_book_entry
+  resources/register
+  resources/inventory
+  resources/product
+  resources/user
+  resources/sale
+  resources/tax
+
+  has_resources
+  store
+}.each { |r| require "vend/#{r}" }
+
+module Vend
+  class << self
+    def scheme
+      @scheme || "https"
+    end
+
+    def domain
+      @domain || "vendhq.com"
+    end
+  end
+end

data/lib/vend/errors.rb

@@ -0,0 +1,12 @@
+module Vend
+  class Error < StandardError; end
+
+  class Unauthorized < Error
+    def message; "Unauthorized"; end
+  end
+
+  class ValidationFailed < Error; end
+
+  class ServerError < Error; end
+
+end

data/lib/vend/has_resources.rb

@@ -0,0 +1,34 @@
+module Vend::HasResources
+  def self.included base
+    %w(
+      customers
+      payment_types
+      products
+      registers
+      sales
+      suppliers
+      taxes
+      users
+    ).each do |r|
+      define_method r do
+        if resource = instance_variable_get("@_#{r}")
+          resource
+        else
+          resource_name = r.
+            gsub(/s$/,'').
+            sub(/^[a-z]/) { $&.capitalize }.
+            gsub(/(?:_|(\/))([a-z\d]*)/) { "#{$1}#{$2.capitalize}" }
+
+          case resource_name
+          when 'Taxe'
+            resource_name.gsub! /e$/, ''
+          end
+
+          resource = Vend::ResourceCollection.new(self, "Vend::#{resource_name}".constantize)
+            instance_variable_set("@_#{r}", resource)
+          resource
+        end
+      end
+    end
+  end
+end

data/lib/vend/modules/declarative_setters.rb

@@ -0,0 +1,74 @@
+module Vend::DeclarativeSetters
+  module ClassMethods
+    # The path fragment used for this resource
+    def path(path = nil)
+      @path = path if path
+      @path || (
+        self.
+          name.
+          split('::').
+          last.
+          gsub(/([a-z\d])([A-Z])/,'\1_\2').
+          downcase
+      ) # Underscored class name
+    end
+
+    # Customize the collection api path
+    def collection_api_path(path=nil)
+      @collection_api_path = path if path
+      @collection_api_path || "#{self.path}s"
+    end
+
+    # Customize the resource api path
+    def resource_api_path(path=nil)
+      @resource_api_path = path if path
+      @resource_api_path || "1.0/#{self.path}"
+    end
+
+    # The name of a child collection.
+    def has_many(name, class_proc)
+      define_method "#{name}=" do |items|
+        (@_has_many ||= {})[name] = items
+      end
+      define_method name do
+        has_many_reader(name, class_proc)
+      end
+    end
+
+    # The name of a one to one resource
+    def has_one(name, class_proc)
+      define_method "#{name}=" do |instance|
+        (@_has_one ||= {})[name] = instance
+      end
+      define_method name do
+        has_one_reader(name, class_proc)
+      end
+    end
+
+    # Defines a resource collection scope
+    def collection_scope name, options = {}
+      default = options[:default] || nil
+      collection_method name do |value=default|
+        value = value == false ? "0" : value.to_s
+        current_value = (@parameters ||= {})[name]
+        clear if value != current_value
+        (@parameters ||= {})[name] = value
+        self
+      end
+    end
+
+    # Defines a resource collection method
+    def collection_method name, &block
+      collection_methods[name] = block
+    end
+
+    # Returns all collection methods
+    def collection_methods
+      (@_collection_methods ||= {})
+    end
+  end
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+end

data/lib/vend/modules/finders.rb

@@ -0,0 +1,5 @@
+module Vend::Finders
+  def find(id)
+    @klass.new(id: id, store: store)
+  end
+end

data/lib/vend/modules/paths.rb

@@ -0,0 +1,37 @@
+module Vend::Paths
+  # Collection Paths
+  module ClassMethods
+    def collection_path
+      collection_api_path
+    end
+
+    def index_path
+      collection_path
+    end
+
+    def create_path
+      collection_path
+    end
+  end
+
+  # Instance Paths
+  def resource_path
+    [ self.class.resource_api_path, id ].compact.join("/")
+  end
+
+  def show_path
+    resource_path
+  end
+
+  def update_path
+    self.class.collection_path
+  end
+
+  def destroy_path
+    [ self.class.collection_api_path, id ].compact.join("/")
+  end
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+end