vend 0.0.4

data/lib/vend/http_client.rb

@@ -0,0 +1,119 @@
+require 'net/http'
+require 'json'
+require 'cgi'
+module Vend
+  class HttpClient
+
+    UNAUTHORIZED_MESSAGE = "Client not authorized. Check your store URL and credentials are correct and try again."
+
+    include Logable
+
+    attr_accessor :base_url, :verify_ssl, :username, :password
+    alias :verify_ssl? :verify_ssl
+
+    def initialize(options = {})
+      @base_url = options[:base_url]
+      @username = options[:username]
+      @password = options[:password]
+      @verify_ssl = if options.has_key?(:verify_ssl)
+                      options[:verify_ssl]
+                    else
+                      true
+                    end
+    end
+
+    # sets up a http connection
+    def get_http_connection(host, port)
+      http = Net::HTTP.new(host, port)
+      http.use_ssl = true
+      http.verify_mode = verify_mode
+      http
+    end
+
+    # Makes a request to the specified path within the Vend API
+    # E.g. request('foo') will make a GET request to
+    #      http://storeurl.vendhq.com/api/foo
+    #
+    # The HTTP method may be specified, by default it is GET.
+    #
+    # An optional hash of arguments may be specified. Possible options include:
+    #   :method - The HTTP method
+    #     E.g. request('foo', :method => :post) will perform a POST request for
+    #          http://storeurl.vendhq.com/api/foo
+    #
+    #   :url_params - The URL parameters for GET requests.
+    #     E.g. request('foo', :url_params => {:bar => "baz"}) will request
+    #          http://storeurl.vendhq.com/api/foo?bar=baz
+    #
+    #   :id - The ID required for performing actions on specific resources
+    #         (e.g. delete).
+    #     E.g. request('foos', :method => :delete, :id => 1) will request
+    #          DELETE http://storeurl.vendhq.com/api/foos/1
+    #
+    #   :body - The request body
+    #     E.g. For submitting a POST to http://storeurl.vendhq.com/api/foo
+    #          with the JSON data {"baz":"baloo"} we would call
+    #          request('foo', :method => :post, :body => '{\"baz\":\"baloo\"}'
+    #
+    def request(path, options = {})
+      options = {:method => :get}.merge options
+      url = URI.parse(base_url + path) 
+      http = get_http_connection(url.host, url.port)
+
+      # FIXME extract method
+      method = ("Net::HTTP::" + options[:method].to_s.classify).constantize
+      request = method.new(url.path + url_params_for(options[:url_params]))
+      request.basic_auth username, password
+
+      request.body = options[:body] if options[:body]
+      logger.debug url
+      response = http.request(request)
+      raise Unauthorized.new(UNAUTHORIZED_MESSAGE) if response.kind_of?(Net::HTTPUnauthorized)
+      raise HTTPError.new(response) unless response.kind_of?(Net::HTTPSuccess)
+      logger.debug response
+      JSON.parse response.body unless response.body.nil? or response.body.empty?
+    end
+
+    # Returns the SSL verification mode, based upon the value of verify_ssl?
+    def verify_mode
+      if verify_ssl?
+        OpenSSL::SSL::VERIFY_PEER
+      else
+        OpenSSL::SSL::VERIFY_NONE
+      end
+    end
+
+    # Internal method to parse URL parameters.
+    # Returns an empty string from a nil argument
+    #
+    # E.g. url_params_for({:field => "value"}) will return ?field=value
+    # url_params_for({:field => ["value1","value2"]}) will return ?field[]=value1&field[]=value2
+    protected
+    def url_params_for(options)
+      ary = Array.new
+      if !options.nil?
+        options.each do |option,value|
+          if value.class == Array
+            ary << value.collect { |key| "#{option}%5B%5D=#{CGI::escape(key.to_s)}" }.join('&')
+          else
+            ary << "#{option}=#{CGI::escape(value.to_s)}"
+          end
+        end
+        '?'.concat(ary.join('&'))
+      else
+        ''
+      end
+    end
+
+    protected
+    # Modifies path with the provided options
+    def expand_path_with_options(path, options)
+      # FIXME - Remove from here
+      if options[:id]
+        path += "/#{options[:id]}"
+      end
+      return path
+    end
+
+  end
+end

data/lib/vend/logable.rb

@@ -0,0 +1,9 @@
+module Vend
+  module Logable
+    attr_accessor :logger
+
+    def logger
+      @logger ||= NullLogger.new
+    end
+  end
+end

data/lib/vend/null_logger.rb

@@ -0,0 +1,9 @@
+module Vend
+  class NullLogger
+    def debug(*args) ; end
+    def info(*args) ; end
+    def warn(*args) ; end
+    def error(*args) ; end
+    def fatal(*args) ; end
+  end
+end

data/lib/vend/pagination_info.rb

@@ -0,0 +1,30 @@
+module Vend
+  class PaginationInfo
+    attr_reader :response
+
+    def initialize(response)
+      @response = response
+    end
+
+    def pages
+      pagination['pages']
+    end
+
+    def page
+      pagination['page']
+    end
+
+    def paged?
+      !response['pagination'].nil?
+    end
+
+    def last_page?
+      pages == page
+    end
+
+    protected
+    def pagination
+      @pagination ||= (response['pagination'] || {"pages" => 1, "page" => 1})
+    end
+  end
+end

data/lib/vend/resource/customer.rb

@@ -0,0 +1,11 @@
+module Vend
+  module Resource
+
+    class Customer < Vend::Base
+      url_scope :since
+      findable_by :email
+      findable_by :name, :as => :q
+    end
+
+  end
+end

data/lib/vend/resource/outlet.rb

@@ -0,0 +1,7 @@
+module Vend
+  module Resource
+
+    class Outlet < Vend::Base; end
+
+  end
+end

data/lib/vend/resource/payment_type.rb

@@ -0,0 +1,7 @@
+module Vend
+  module Resource
+
+    class PaymentType < Vend::Base; end
+
+  end
+end

data/lib/vend/resource/product.rb

@@ -0,0 +1,12 @@
+module Vend
+  module Resource
+
+    class Product < Vend::Base
+      url_scope :since
+      url_scope :active
+
+      cast_attribute :supply_price, Float
+    end
+
+  end
+end

data/lib/vend/resource/register.rb

@@ -0,0 +1,7 @@
+module Vend
+  module Resource
+
+    class Register < Vend::Base; end
+
+  end
+end

data/lib/vend/resource/register_sale.rb

@@ -0,0 +1,19 @@
+
+module Vend
+  module Resource
+
+    class RegisterSale < Vend::Base
+      url_scope :since
+      url_scope :outlet_id
+      url_scope :tag
+      findable_by :state, :as => :status
+
+      def register_sale_products
+        attrs["register_sale_products"].collect do |sale_product_attrs|
+          RegisterSaleProduct.new(sale_product_attrs)
+        end
+      end
+    end
+
+  end
+end

data/lib/vend/resource/register_sale_product.rb

@@ -0,0 +1,21 @@
+module Vend
+  module Resource
+    # Note this class does not have a corresponding endpoint in the vend api
+    # It is used to provide a consistent interface to clients using this gem
+    class RegisterSaleProduct
+      attr_reader :attrs
+
+      def initialize(attrs)
+        @attrs = attrs
+      end
+
+      def method_missing(method_name, *args, &block)
+        if attrs.keys.include? method_name.to_s
+          attrs[method_name.to_s]
+        else
+          super(method_name)
+        end
+      end
+    end
+  end
+end

data/lib/vend/resource/tax.rb

@@ -0,0 +1,7 @@
+module Vend
+  module Resource
+
+    class Tax < Vend::Base; end
+
+  end
+end

data/lib/vend/resource/user.rb

@@ -0,0 +1,7 @@
+module Vend
+  module Resource
+
+    class User < Vend::Base; end
+
+  end
+end

data/lib/vend/resource_collection.rb

@@ -0,0 +1,132 @@
+require 'forwardable'
+module Vend
+  # This is an enumerable class which allows iteration over a collection of
+  # resources.  This class will automatically fetch paginated results if the
+  # target_class supports it.
+  class ResourceCollection
+
+    class PageOutOfBoundsError  < StandardError ; end
+    class AlreadyScopedError    < StandardError ; end
+    class ScopeNotFoundError    < StandardError ; end
+
+    include Enumerable
+    extend Forwardable
+
+    attr_reader :client, :target_class, :endpoint, :request_args
+
+    def_delegators :pagination, :pages, :page
+    def_delegators :target_class, :accepts_scope?
+
+    def initialize(client, target_class, endpoint, request_args = {})
+      @client       = client
+      @target_class = target_class
+      @endpoint     = endpoint
+      @request_args = request_args
+    end
+
+    def each
+      # If each has previously been invoked on this collection, the response
+      # member will already be set, causing last_page? to immeadiatly return
+      # true.  So reset it here.
+      self.response = nil
+
+      until last_page?
+        target_class.build_from_json(client, get_next_page).map do |resource|
+          yield resource
+        end
+      end
+      self
+    end
+
+    def pagination
+      if response.instance_of? Hash
+        PaginationInfo.new(response)
+      end
+    end
+
+    def last_page?
+      pagination && pagination.last_page?
+    end
+
+    def paged?
+      pagination && pagination.paged?
+    end
+
+    def scopes
+      @scopes ||= []
+    end
+
+    # Adds a new URL scope parameter to this ResourceCollection. Calling
+    # scope(:foo, 'bar') will effectively append '/foo/bar' to the resource
+    # URL.
+    def scope(name, value)
+      raise AlreadyScopedError if has_scope?(name)
+      scopes << Scope.new(name, value)
+      self
+    end
+
+    def has_scope?(name)
+      scopes.any? {|s| s.name == name }
+    end
+
+    def method_missing(method_name, *args, &block)
+      if accepts_scope?(method_name)
+        scope(method_name, *args)
+      else
+        super
+      end
+    end
+
+    def respond_to?(method_name)
+      return true if accepts_scope?(method_name)
+      super
+    end
+
+    def increment_page
+      if paged?
+        page_scope = get_or_create_page_scope
+        page_scope.value = page_scope.value + 1
+      end
+    end
+
+    def get_scope(name)
+      
+      result = scopes.find { |scope| scope.name == name }
+      if result.nil?
+        raise ScopeNotFoundError.new(
+          "Scope: #{name} was not found in #{scopes}."
+        )
+      end
+      return result
+    end
+
+    def get_or_create_page_scope
+      unless has_scope? :page
+        scope(:page, page)
+      end
+      get_scope :page
+    end
+
+    def url
+      increment_page
+      endpoint_with_scopes
+    end
+
+    def endpoint_with_scopes
+      endpoint + scopes.join
+    end
+
+    protected
+    attr_accessor :response
+
+    protected
+    def get_next_page
+      if last_page?
+        raise PageOutOfBoundsError.new(
+          "get_next_page called when already on last page"
+        )
+      end
+      self.response = client.request(url, request_args)
+    end
+  end
+end

data/lib/vend/scope.rb

@@ -0,0 +1,27 @@
+module Vend
+  class Scope
+
+    attr_reader :name
+    attr_accessor :value
+
+    DATETIME_FORMAT = "%Y-%m-%d %H:%M:%S"
+
+    def initialize(name, value)
+      @name = name
+      @value = value
+    end
+
+    def escaped_value
+      if value.instance_of? Time
+        result = value.strftime(DATETIME_FORMAT)
+      else
+        result = value.to_s
+      end
+      CGI::escape(result)
+    end
+
+    def to_s
+      "/%s/%s" % [name, escaped_value]
+    end
+  end
+end