vending-machine 0.1.2 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8804a13fd883e7691d53c92783030068937095f5
+  data.tar.gz: 2bc3e2c3f83d0931b8c4b21a3cd6027f676afdb0
+SHA512:
+  metadata.gz: 20adbb6dceb11c22a30fdcb12749b60f80e9da9aebd55a5a40eb9676cfe19985b75b364cedb7522afef6e1214d966b8172287e5cc456ae4b82bc54e8539f1175
+  data.tar.gz: 6539ab4faa6cce8598c6a5c10fb0256e6224df8ef102e695e74219c3e7db618099f8cd2913231e0b8e08877749e2987d5f2c5810447742d1290b77b07f9d2e83

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/README.md

@@ -2,9 +2,12 @@
 
 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')
+# Create an instance of your store with Basic Auth
+store = Vend::Store.new({:store_name => 'store_name', :username => 'user_name', :password => 'password'})
+# Create an instance of your store with OAuth
+store = Vend::Store.new({:store_name => 'store_name', :auth_token => 'auth_token'})
 
 # Get all your products
 store.products.order('name', 'ASC').map &:name
@@ -35,13 +38,27 @@ Or install it yourself as:
 
 ## Usage
 
+### Basic Auth and Oauth Support
+Authentication defaults to Basic Auth. You can switch to Oauth by adding the following code to an initializer.
+
+```ruby
+# config/vending_machine.rb
+Vend.config do |config|
+  config.auth_method = :oauth # defaults to :basic_auth
+end
+
+```
+
 ### Get a store instance
 
 All usage revolves around your store, as per Vend itself
 
 
 ```ruby
-store = Vend::Store.new('store_name', 'user_name', 'password')
+# Create an instance of your store with Basic Auth
+store = Vend::Store.new({:store_name => 'store_name', :username => 'user_name', :password => 'password'})
+#Or Create an instance of your store with OAuth
+store = Vend::Store.new({:store_name => 'store_name', :auth_token => 'auth_token'})
 ```
 
 Once you have a store instance you can retrieve your objects
@@ -114,6 +131,28 @@ product.save!
 => true
 ```
 
+#### Creating a Product Variant
+
+Product variants have the same `handle` as another product, but a different `sku`. You can create a variant of a product easily with the `#build_variant`, `#create_variant` and `#create_variant!` methods.
+
+Underneath the hood, it's simply copying attributes to a new instance, then changing the `sku` to either a provided new sku, or appending an incrementing integer to an existing `sku`.
+
+```ruby
+product.sku = 'my-product'
+product.build_variant(sku: 'my-product-alt')
+=> #<Vend::Product>
+
+product.build_variant(sku: 'my-product-alt').sku
+=> 'my-product-alt'
+
+product.build_variant.sku
+=> 'my-product-1'
+
+product.sku = 'my-product-3'
+product.build_variant.sku
+=> 'my-product-4'
+```
+
 ### Register Sales
 
 ```ruby
@@ -136,6 +175,18 @@ store.registers.map &:name
 => ["Main Register", "Back office Register"]
 ```
 
+#### Open register
+
+```ruby
+store.registers.first.open!
+```
+
+#### Close register
+
+```ruby
+store.registers.first.close!
+```
+
 ### Suppliers
 
 ```ruby
@@ -164,12 +215,25 @@ store.users.map &:name
 => ["A cashier", "Mal Curtis", "Joe Bloggs"]
 ```
 
+## Tips
+
+### Figuring out what attributes a resource has
+Want to know what attributes are on a particular resource? Use `#attributes`. Vending Machine will map all returned attributes to a resource, only a portion of which are defined in the resource’s code (for validation and type coercion).
+
+```ruby
+store.taxes.first.attributes
+=> {:id=>"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
+ :rate=>0.15,
+ :default=>true,
+ :name=>"NZ GST"}
+```
+
 ## 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 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)
+* COMPLETE: 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.rb

@@ -2,6 +2,7 @@ $: << File.expand_path(File.dirname(__FILE__))
 %w{
   version
   errors
+  config
 
   modules/declarative_setters
   modules/finders
@@ -42,5 +43,13 @@ module Vend
     def domain
       @domain || "vendhq.com"
     end
+
+    def config(&block)
+      if block_given?
+        block.call(Vend::Config)
+      else
+        Vend::Config
+      end
+    end
   end
 end

data/lib/vend/config.rb

@@ -0,0 +1,22 @@
+module Vend
+  module Config
+    class << self
+
+      VALID_AUTHENTICATION_METHODS = %i(basic_auth oauth)
+      DEFAULT_AUTHENTICATION_METHOD = :basic_auth
+
+      def auth_method=(method)
+        if VALID_AUTHENTICATION_METHODS.include?(method.to_sym)
+          @auth_method = method.to_sym
+        else
+          raise Vend::InvalidConfig("%s is not a valid authentication method" % method)
+        end
+      end
+
+      def auth_method
+        @auth_method || DEFAULT_AUTHENTICATION_METHOD
+      end
+
+    end
+  end
+end

data/lib/vend/errors.rb

@@ -9,4 +9,6 @@ module Vend
 
   class ServerError < Error; end
 
+  class InvalidConfig < Error; end
+
 end

data/lib/vend/modules/paths.rb

@@ -31,6 +31,14 @@ module Vend::Paths
     [ self.class.collection_api_path, id ].compact.join("/")
   end
 
+  def close_path
+    [ self.class.collection_api_path, id, 'close' ].compact.join("/")
+  end
+
+  def open_path
+    [ self.class.collection_api_path, id, 'open' ].compact.join("/")
+  end
+
   def self.included(base)
     base.extend(ClassMethods)
   end

data/lib/vend/remote_resource.rb

@@ -18,7 +18,7 @@ module Vend
 
     def save!
       save_path = id ? update_path : self.class.create_path
-      method = id ? :put : :post
+      method = id ? :post : :post
       response = store.send(method, path: save_path,
         data: sendable_attributes.to_json,
         status: 200
@@ -41,6 +41,8 @@ module Vend
       self
     end
 
+
+
     private
 
     def sendable_attributes

data/lib/vend/resource_collection.rb

@@ -59,7 +59,26 @@ module Vend
     end
 
     def remote_records
-      http_response.data.first.last
+      # Is there pagination info?
+      pagination = http_response.data["pagination"]
+
+      if pagination
+        # Get all pages
+        data = []
+        page = 1
+        pages = pagination["pages"]
+        while page <= pages
+          http_response.data.delete("pagination")
+          data.concat(http_response.data.first.last)
+          @_http_response = nil
+          page += 1
+          (@parameters ||= {})[:page] = page
+        end
+        @parameters.delete(:page)
+        data
+      else
+        http_response.data.first.last
+      end
     end
 
     def records
@@ -74,3 +93,4 @@ module Vend
     end
   end
 end
+

data/lib/vend/resources/register.rb

@@ -5,5 +5,23 @@ module Vend
     attribute :register_close_time, DateTime
     attribute :register_open_time, DateTime
     attribute :register_open_count_sequence, Integer
+
+    # Close register
+    def close!
+      self.attributes = store.post(
+        path: close_path,
+        status: 200
+      ).data
+      self
+    end
+
+    # Open register
+    def open!
+      self.attributes = store.post(
+        path: open_path,
+        status: 200
+      ).data
+      self
+    end
   end
 end

data/lib/vend/store.rb

@@ -6,8 +6,14 @@ module Vend
   class Store
     include HasResources
 
-    def initialize name, username, password
-      @name, @credentials = name, [ username, password ]
+    def initialize(credentials={})
+      @authenticator = Vend::Config.auth_method
+      case @authenticator
+      when :basic_auth
+        @name, @credentials = credentials[:store_name], [credentials[:username], credentials[:password]]
+      when :oauth
+        @name, @auth_token =  credentials[:store_name], credentials[:auth_token]
+      end
     end
 
     ##
@@ -47,6 +53,7 @@ module Vend
         response.headers,
         response.body
       )
+
     end
 
     ##
@@ -95,7 +102,12 @@ module Vend
       @_faraday ||= Faraday.new(url) do |conn|
         conn.request :json
         conn.response :json
-        conn.basic_auth *@credentials
+        case @authenticator
+        when :basic_auth
+          conn.basic_auth *@credentials
+        when :oauth
+          conn.authorization :Bearer, @auth_token
+        end
         conn.adapter Faraday.default_adapter
       end
     end

data/lib/vend/version.rb

@@ -1,3 +1,3 @@
 module Vend
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/spec/store_spec.rb

@@ -4,18 +4,28 @@ module Vend
   describe Store do
     describe "#url" do
       it "should be the store api endpoint" do
-        store = Vend::Store.new('test-store', :a, :a)
+        store = Vend::Store.new({:store_name => 'test-store', :username => :a, :password => :a})
         store.send(:url).must_equal "https://test-store.vendhq.com/api"
       end
     end
 
-    describe "#faraday" do
+    describe "#faraday with basic auth" do
       it "should be an authorized Faraday client" do
-        store = Vend::Store.new('test-store', "abc", "123")
+        store = Vend::Store.new({:store_name => 'test-store', :username => 'abc', :password => '123'})
         conn = store.send(:faraday)
         assert auth = conn.headers['Authorization']
         assert_equal Faraday::Request::BasicAuthentication.header("abc", "123"), auth
       end
     end
+
+    describe "#faraday with oauth" do
+      it "should be an authorized Faraday client" do
+        Vend::Config.auth_method = :oauth
+        store = Vend::Store.new({:store_name => 'test-store', :auth_token => 'my-dummy-token'})
+        conn = store.send(:faraday)
+        assert auth = conn.headers['Authorization']
+        assert_equal Faraday::Request::Authorization.header("Bearer", "my-dummy-token"), auth
+      end
+    end
   end
 end

metadata

@@ -1,158 +1,139 @@
 --- !ruby/object:Gem::Specification
 name: vending-machine
 version: !ruby/object:Gem::Version
-  version: 0.1.2
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - Mal Curtis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-16 00:00:00.000000000 Z
+date: 2014-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: virtus
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.5.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.5.3
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: ansi
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: turn
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Client for the Vend API
@@ -162,12 +143,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - lib/vend.rb
+- lib/vend/config.rb
 - lib/vend/errors.rb
 - lib/vend/has_resources.rb
 - lib/vend/modules/declarative_setters.rb
@@ -205,27 +188,26 @@ files:
 - vending-machine.gemspec
 homepage: https://github.com/snikch/vending-machine
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Exposes the Vend API as an object model
 test_files:
 - spec/resource_spec.rb
@@ -234,4 +216,3 @@ test_files:
 - spec/store_spec.rb
 - spec/support/url_assertions.rb
 - spec/support/webmock.rb
-has_rdoc: