vending-machine 0.1.0

data/lib/vend/version.rb

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

data/lib/vending-machine.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + '/vend'

data/spec/resource_spec.rb

@@ -0,0 +1,22 @@
+require_relative "spec_helper"
+
+module Vend
+  describe Resource do
+    describe "#has_many" do
+      it "returns the same instance of ResourceCollection" do
+        class Widget < RemoteResource
+          attribute :name, String
+        end
+        resource = Class.new(RemoteResource) do
+          attribute :id, Integer
+          has_many :widgets, ->{ Widget }
+        end
+        i = resource.new widgets: [{ name: "Knob" }]
+        widgets = i.widgets
+        widgets.send(:records).size.must_equal 1
+        i.widgets << Widget.new(name: "Flange")
+        widgets.send(:records).size.must_equal 2
+      end
+    end
+  end
+end

data/spec/resource_urls_spec.rb

@@ -0,0 +1,59 @@
+###
+# Describes which API URLs are used for collections and resources
+#
+# Consider this the definitive spec for what URL vending machine
+# will be retrieving resources from.
+#
+require_relative 'spec_helper'
+
+module Vend
+  describe "Resource URLs" do
+    extend UrlAssertions
+
+    {
+      Customer: {
+        index: "/api/customers",
+        show: "/api/1.0/customer/:id",
+        create: "/api/customers",
+        update: "/api/customers"
+      },
+      Inventory: {
+        show: "/api/1.0/inventory/:id",
+      },
+      PaymentType: {
+        index: "/api/payment_types"
+      },
+      ProductType: {
+        show: "/api/1.0/product_type/:id"
+      },
+      Product: {
+        index: "/api/products",
+        show: "/api/1.0/product/:id",
+        create: "/api/products",
+        update: "/api/products",
+        destroy: "/api/products/:id"
+      },
+      Sale: {
+        index: "/api/register_sales",
+        show: "/api/1.0/register_sale/:id",
+        create: "/api/register_sales"
+      },
+      Supplier: {
+        show: "/api/1.0/supplier/:id"
+      },
+      Register: {
+        index: "/api/registers",
+      },
+      Tax: {
+        index: "/api/taxes",
+        create: "/api/taxes"
+      },
+      User: {
+        index: "/api/users",
+        show: "/api/1.0/user/:id"
+      }
+    }.each do |class_name, verb_routes|
+      assert_resource_urls("Vend::#{class_name.to_s}".constantize, verb_routes)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require "minitest/autorun"
+require "turn"
+
+require_relative "support/webmock"
+require_relative "support/url_assertions"
+
+$LOAD_PATH.unshift "./lib"
+require "vend"

data/spec/store_spec.rb

@@ -0,0 +1,21 @@
+require_relative "spec_helper"
+
+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.send(:url).must_equal "https://test-store.vendhq.com/api"
+      end
+    end
+
+    describe "#faraday" do
+      it "should be an authorized Faraday client" do
+        store = Vend::Store.new('test-store', "abc", "123")
+        conn = store.send(:faraday)
+        assert auth = conn.headers['Authorization']
+        assert_equal Faraday::Request::BasicAuthentication.header("abc", "123"), auth
+      end
+    end
+  end
+end

data/spec/support/url_assertions.rb

@@ -0,0 +1,23 @@
+module UrlAssertions
+  def assert_resource_urls(klass, verb_routes)
+    verb_routes.each do |verb, route|
+      it "#{klass.name}##{verb} maps to #{route}" do
+        route.gsub!(/^\/api\//,'') # Remove the /api
+        case verb
+        when :index
+          klass.index_path.must_equal route
+        when :show
+          klass.new(id: ":id").show_path.must_equal route
+        when :create
+          klass.create_path.must_equal route
+        when :update
+          klass.new(id: ":id").update_path.must_equal route
+        when :destroy
+          klass.new(id: ":id").destroy_path.must_equal route
+        else
+          raise "I don't know how to #{verb}"
+        end
+      end
+    end
+  end
+end

data/spec/support/webmock.rb

@@ -0,0 +1,53 @@
+require "addressable/uri"
+require "json"
+require "webmock/minitest"
+
+WebMock.disable_net_connect!
+
+##
+# WebMock request expectations.
+module RequestExpectations
+
+  def self.included(klass)
+    klass.before { @expected_requests = [] }
+    klass.after { @expected_requests.each { |sr| assert_requested(sr) } }
+  end
+
+  def stub_and_assert_request(*parameters)
+    stub_request(*parameters).tap do |request|
+      @expected_requests << request
+    end
+  end
+
+  def expect_request(options)
+    rack_method_override!(options, :patch)
+
+    url = options.fetch(:url)
+    parameters = options[:parameters]
+    method = options.fetch(:method)
+    request_body = options[:request_body]
+    request_headers = options[:request_headers]
+    response_body = options[:response_body]
+    response_headers = options[:response_headers]
+
+    if parameters
+      url = Addressable::URI.parse(url).tap do |url|
+        url.query_values = parameters
+      end.to_s
+    end
+
+    request = {}
+    request[:body] = request_body if request_body
+    request[:headers] = request_headers if request_headers
+
+    response = {status: options[:status] || 200}
+    response[:body] = JSON.generate(response_body) if response_body
+    response[:headers] = response_headers if response_headers
+
+    stub_and_assert_request(method, url).
+      with(request).
+      to_return(response)
+  end
+end
+
+MiniTest::Spec.send(:include, RequestExpectations)

data/vending-machine.gemspec

@@ -0,0 +1,46 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vend/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "vending-machine"
+  gem.version       = Vend::VERSION
+  gem.authors       = ["Mal Curtis"]
+  gem.email         = ["mal@mal.co.nz"]
+  gem.description   = %q{Client for the Vend API}
+  gem.summary       = %q{Exposes the Vend API as an object model}
+  gem.homepage      = "https://github.com/snikch/vending-machine"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(spec)/})
+  gem.require_paths = ["lib"]
+
+  ##
+  # Runtime dependencies.
+
+  # Faraday: HTTP client.
+  gem.add_runtime_dependency "faraday"
+  gem.add_runtime_dependency "faraday_middleware"
+
+  # Addressable: URI implementation.
+  gem.add_runtime_dependency "addressable"
+
+  # Virtus: declare attributes on plain Ruby objects.
+  gem.add_runtime_dependency "virtus", "~> 0.5.3"
+
+  ##
+  # Development dependencies.
+
+  # MiniTest: unit test / spec library.
+  gem.add_development_dependency "minitest"
+  gem.add_development_dependency "ansi"
+  gem.add_development_dependency "turn"
+
+  # Rake: build tool.
+  gem.add_development_dependency "rake"
+
+  # WebMock: HTTP request stubs and expectations.
+  gem.add_development_dependency "webmock"
+end

metadata

@@ -0,0 +1,238 @@
+--- !ruby/object:Gem::Specification
+name: vending-machine
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Mal Curtis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-13 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
+email:
+- mal@mal.co.nz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/vend.rb
+- lib/vend/errors.rb
+- lib/vend/has_resources.rb
+- lib/vend/modules/declarative_setters.rb
+- lib/vend/modules/finders.rb
+- lib/vend/modules/paths.rb
+- lib/vend/remote_resource.rb
+- lib/vend/resource.rb
+- lib/vend/resource_collection.rb
+- lib/vend/resources/brand.rb
+- lib/vend/resources/contact.rb
+- lib/vend/resources/customer.rb
+- lib/vend/resources/inventory.rb
+- lib/vend/resources/outlet.rb
+- lib/vend/resources/payment_type.rb
+- lib/vend/resources/price_book_entry.rb
+- lib/vend/resources/product.rb
+- lib/vend/resources/product_type.rb
+- lib/vend/resources/register.rb
+- lib/vend/resources/register_sale_payment.rb
+- lib/vend/resources/register_sale_product.rb
+- lib/vend/resources/sale.rb
+- lib/vend/resources/supplier.rb
+- lib/vend/resources/tax.rb
+- lib/vend/resources/user.rb
+- lib/vend/response.rb
+- lib/vend/store.rb
+- lib/vend/version.rb
+- lib/vending-machine.rb
+- spec/resource_spec.rb
+- spec/resource_urls_spec.rb
+- spec/spec_helper.rb
+- spec/store_spec.rb
+- spec/support/url_assertions.rb
+- spec/support/webmock.rb
+- vending-machine.gemspec
+homepage: https://github.com/snikch/vending-machine
+licenses: []
+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
+signing_key: 
+specification_version: 3
+summary: Exposes the Vend API as an object model
+test_files:
+- spec/resource_spec.rb
+- spec/resource_urls_spec.rb
+- spec/spec_helper.rb
+- spec/store_spec.rb
+- spec/support/url_assertions.rb
+- spec/support/webmock.rb
+has_rdoc: