vend 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 36886eb6986fbeb8cea81493ff3f87cfc75d2e7c
-  data.tar.gz: d0bc6a8d32403071b1bcead22e49bd74771cb83b
+  metadata.gz: 64137299cf2287fec6feb5741e6f94d867ba0d43
+  data.tar.gz: 94ac4b34cb4b594b161bc19a8f7ad0733b25357e
 SHA512:
-  metadata.gz: de2eeb7b4b76dd5d1fbbad65784fb63df20c1cd80314886e7cf9bbc5e69642c92340bbcd94c7ff9988d13f07481b9b38cabaac129094e81129bc8d414e352a44
-  data.tar.gz: e1539bfb0b731bb01b9ce40a38d888518b32db7dc66bc259fb223bc5b31048a07f388e52f6c22889641f4adb8e280a7c9e06645f6405e4c5cc01b9f461b885f3
+  metadata.gz: 22537fdc5eec7d1be785e5b4b3a4c4b9926df3b1da3509fa52f4c1f7af4171289ab42c2f65c8047d59e8ba9837675431ba4c2e70d672953720d8b1b3c5ccdcb2
+  data.tar.gz: 4b7ac00c0663fbd08df7b16308d49bd0394319f8c1bcb9598d6a6c14b36ec2028ffe497a2cef8603ca83b5cbde3e15063dc5eb19e6ecafdf88da1596ddf5a0f4

data/.rubocop.yml

@@ -0,0 +1,57 @@
+# class Example
+# ...
+# private
+# ...
+# end
+Style/AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+# Allows foo(bar: baz)
+Style/BracesAroundHashParameters:
+  Enabled: false
+
+Style/DotPosition:
+  EnforcedStyle: leading
+
+Style/IndentHash:
+  EnforcedStyle: consistent
+
+Style/LineLength:
+  Max: 120
+
+Style/RedundantSelf:
+  Enabled: false
+
+# We like neatly-aligned code
+Style/SingleSpaceBeforeFirstArg:
+  Enabled: false
+
+Style/SpaceAroundEqualsInParameterDefault:
+  Enabled: false
+
+Style/SpaceInsideHashLiteralBraces:
+  Enabled: false
+
+# Allow single or double quotes
+Style/StringLiterals:
+  Enabled: false
+
+# Disable this until we can work out how to allow aligning of assignments
+# https://github.com/bbatsov/rubocop/blob/master/spec/rubocop/cop/style/extra_spacing_spec.rb#L23
+Style/ExtraSpacing:
+  Enabled: false
+
+Style/WordArray:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/SignalException:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Style/MultilineOperationIndentation:
+  Enabled: false

data/README.rdoc

@@ -5,7 +5,7 @@ This gem provides access to Vend's REST API.
 == Vend API Documentation
 
 At the time of writing, this is located at
-https://docs.google.com/document/pub?id=13JiV6771UcrkmawFRxzvVl3tf5PGSTBH56RYy0-5cps
+https://developers.vendhq.com/documentation
 
 == Using Vend API via Oauth 2.0
 

data/Rakefile

@@ -6,7 +6,7 @@ require 'rdoc/task'
 
 Dir.glob('lib/tasks/*.rake').each { |r| import r }
 
-task :default => [:spec]
+task default: [:spec]
 
 desc "Run RSpec tests"
 RSpec::Core::RakeTask.new(:spec)

data/example.rb

@@ -5,7 +5,7 @@ STORE = ARGV[0]
 USERNAME = ARGV[1]
 PASSWORD = ARGV[2]
 
-unless STORE and USERNAME and PASSWORD
+unless STORE && USERNAME && PASSWORD
   $stderr.puts "Usage: example.rb store username password"
   exit 1
 end
@@ -16,7 +16,7 @@ logger = Log4r::Logger.new 'vend'
 logger.outputters = Log4r::Outputter.stdout
 client.http_client.logger = client.logger = logger
 
-# puts client.request('products', :method => :put, :body => '{"foo":"bar"}')
+# puts client.request('products', method: :put, body: '{"foo":"bar"}')
 
 # puts "###### Products ######"
 # client.Product.all.each do |product|
@@ -29,7 +29,7 @@ client.http_client.logger = client.logger = logger
 # end
 #
 # puts "###### Creating a Customer ######"
-# response = client.request('customers', :method => :post, :body => '{"customer_code":"foo"}')
+# response = client.request('customers', method: :post, body: '{"customer_code":"foo"}')
 # puts response
 #
 # puts "###### Finding a Customer by name ######"

data/lib/vend.rb

@@ -1,4 +1,4 @@
-$: << File.expand_path(File.dirname(__FILE__))
+$LOAD_PATH << File.expand_path(File.dirname(__FILE__))
 require 'active_support/inflector'
 
 require 'vend/exception'
@@ -19,6 +19,7 @@ require 'vend/resource/register_sale'
 require 'vend/resource/register_sale_product'
 require 'vend/resource/tax'
 require 'vend/resource/user'
+require 'vend/resource/supplier'
 
 require 'vend/http_client'
 require 'vend/client'

data/lib/vend/base.rb

@@ -5,7 +5,6 @@ module Vend
   # Not all CRUD actions are available for every resource, and at current there
   # is no PUT endpoint and hence no update action
   class Base
-
     # Reference to the Vend::Client client object providing the HTTP interface to the
     # API
     attr_reader :client
@@ -26,6 +25,7 @@ module Vend
     def self.attribute_casts
       @attribute_casts ||= {}
     end
+
     # Returns the endpoint name for the resource, used in API urls when making
     # requests.
     def self.endpoint_name
@@ -82,7 +82,7 @@ module Vend
     #
     # And return the corresponding collection of resources
     def self.url_scope(method_name)
-      (class << self ; self ; end).instance_eval do
+      (class << self; self; end).instance_eval do
         define_method(method_name) do |client, arg|
           initialize_collection(client, collection_name).scope(method_name, arg)
         end
@@ -91,26 +91,26 @@ module Vend
     end
 
     def self.findable_by(field, options = {})
-
-      (class << self ; self ; end).instance_eval do
+      (class << self; self; end).instance_eval do
         define_method("find_by_#{field}") do |client, *args|
           search(client, options[:as] || field, *args)
         end
       end
     end
+
     # Sends a search request to the API and initializes a collection of Resources
     # from the response.
     # This method is only used internally by find_by_field methods.
     def self.search(client, field, query)
       initialize_collection(
-        client, collection_name,  :url_params => { field.to_sym => query }
+        client, collection_name,  url_params: { field.to_sym => query }
       )
     end
 
     # Builds a new instance of the described resource using the specified
     # attributes.
     def self.build(client, attrs)
-      self.new(client, :attrs => attrs)
+      self.new(client, attrs: attrs)
     end
 
     # Builds a collection of instances from a JSON response
@@ -131,7 +131,6 @@ module Vend
       ResourceCollection.new(client, self, endpoint, args)
     end
 
-
     # Attempts to pull a singular object from Vend through the singular GET
     # endpoint.
     def self.find(client, id)
@@ -150,7 +149,7 @@ module Vend
     # request.  I.e, to default to 500 items per page:
     #
     #   def default_collection_request_args
-    #     super.merge(:url_params => {:page_size => 500})
+    #     super.merge(url_params: {page_size: 500})
     #   end
     #
     def self.default_collection_request_args
@@ -169,7 +168,7 @@ module Vend
 
     # Overrides method_missing to query the attrs hash for the value stored
     # at the specified key before proxying it to the object
-    def method_missing(method_name, *args, &block)
+    def method_missing(method_name, *_args, &_block)
       if attrs.keys.include? method_name.to_s
         attribute_value_for(method_name)
       else
@@ -191,13 +190,14 @@ module Vend
     def delete!
       raise(Vend::Resource::IllegalAction,
             "#{self.class.name} has no unique ID") unless attrs['id']
-      client.request(singular_name, :method => :delete)
+      client.request(singular_name, method: :delete)
       true
     end
 
-    protected
+  protected
+
     def attribute_value_for(attribute_name)
-      if self.class.attribute_casts.has_key? attribute_name
+      if self.class.attribute_casts.key? attribute_name
         case self.class.attribute_casts[attribute_name].to_s
         when "Float"
           return attrs[attribute_name.to_s].to_f

data/lib/vend/base_factory.rb

@@ -1,7 +1,5 @@
 module Vend
-
   class BaseFactory
-
     attr_reader :client, :target_class
 
     def initialize(client, target_class)
@@ -22,13 +20,11 @@ module Vend
     end
 
     ## Generates find_by_field methods which call a search on the target class
-    #def self.findable_by(field, options = {})
+    # def self.findable_by(field, options = {})
     #  url_param = options[:as] || field
     #  define_method "find_by_#{field.to_s}" do |*args|
     #    target_class.send(:search, @client, url_param, *args)
     #  end
-    #end
-
+    # end
   end
-
 end

data/lib/vend/client.rb

@@ -1,7 +1,6 @@
 require 'forwardable'
 
 module Vend #:nodoc:
-
   # Main access point which allows resources within the Vend gem to
   # make HTTP requests to the Vend API.
   #
@@ -10,7 +9,6 @@ module Vend #:nodoc:
   #   * a valid username and password
   #
   class Client
-
     DEFAULT_OPTIONS = {}
 
     extend Forwardable
@@ -61,6 +59,10 @@ module Vend #:nodoc:
       Vend::BaseFactory.new(self, Resource::User)
     end
 
+    def Supplier #:nodoc:
+      Vend::BaseFactory.new(self, Resource::Supplier)
+    end
+
     # Returns the base API url for the client.
     # E.g. for the store 'foo', it returns https://foo.vendhq.com/api/
     def base_url
@@ -73,10 +75,8 @@ module Vend #:nodoc:
 
     def http_client_options
       options.merge(
-        :base_url => base_url, :username => username, :password => password
+        base_url: base_url, username: username, password: password
       )
     end
-
   end
-
 end

data/lib/vend/http_client.rb

@@ -3,7 +3,6 @@ require 'json'
 require 'cgi'
 module Vend
   class HttpClient
-
     UNAUTHORIZED_MESSAGE = "Client not authorized. Check your store credentials are correct and try again."
     # Read timeout in seconds
     READ_TIMEOUT = 240
@@ -11,14 +10,14 @@ module Vend
     include Logable
 
     attr_accessor :base_url, :verify_ssl, :username, :password, :auth_token
-    alias :verify_ssl? :verify_ssl
+    alias_method :verify_ssl?, :verify_ssl
 
     def initialize(options = {})
       @base_url = options[:base_url]
       @username = options[:username]
       @password = options[:password]
       @auth_token = options[:auth_token]
-      @verify_ssl = if options.has_key?(:verify_ssl)
+      @verify_ssl = if options.key?(:verify_ssl)
                       options[:verify_ssl]
                     else
                       true
@@ -44,27 +43,27 @@ module Vend
     #
     # 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
+    #     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
+    #     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
+    #     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\"}'
+    #          request('foo', method: :post, body: '{\"baz\":\"baloo\"}'
     #
     def request(path, options = {})
-      options = {:method => :get, :redirect_count => 0}.merge options
+      options = {method: :get, redirect_count: 0}.merge options
       raise RedirectionLimitExceeded if options[:redirect_count] > 10
-      url = if path.kind_of?(URI)
+      url = if path.is_a?(URI)
               path
             else
               URI.parse(base_url + path)
@@ -72,7 +71,7 @@ module Vend
       ssl = (url.scheme == 'https')
       http = get_http_connection(url.host, url.port, ssl)
 
-      # FIXME extract method
+      # 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 if username && password
@@ -81,16 +80,16 @@ module Vend
       request.body = options[:body] if options[:body]
       logger.debug url
       response = http.request(request)
-      if response.kind_of?(Net::HTTPRedirection)
+      if response.is_a?(Net::HTTPRedirection)
         location = URI.parse(response['location'])
         logger.debug "Following redirect to %s" % [location]
         options[:redirect_count] = options[:redirect_count] + 1
         request(location, options)
       else
-        raise Unauthorized.new(UNAUTHORIZED_MESSAGE) if response.kind_of?(Net::HTTPUnauthorized)
-        raise HTTPError.new(response) unless response.kind_of?(Net::HTTPSuccess)
+        raise Unauthorized.new(UNAUTHORIZED_MESSAGE) if response.is_a?(Net::HTTPUnauthorized)
+        raise HTTPError.new(response) unless response.is_a?(Net::HTTPSuccess)
         logger.debug response
-        JSON.parse response.body unless response.body.nil? or response.body.empty?
+        JSON.parse response.body unless response.body.nil? || response.body.empty?
       end
     end
 
@@ -103,20 +102,22 @@ module Vend
       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
+  # 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
+      ary = []
       if !options.nil?
-        options.each do |option,value|
+        options.each do |option, value|
           if value.class == Array
-            ary << value.collect { |key| "#{option}%5B%5D=#{CGI::escape(key.to_s)}" }.join('&')
+            ary << value.collect { |key| "#{option}%5B%5D=#{CGI.escape(key.to_s)}" }.join('&')
           else
-            ary << "#{option}=#{CGI::escape(value.to_s)}"
+            ary << "#{option}=#{CGI.escape(value.to_s)}"
           end
         end
         '?'.concat(ary.join('&'))
@@ -125,15 +126,13 @@ module Vend
       end
     end
 
-    protected
+  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
+      # FIXME: - Remove from here
+      path += "/#{options[:id]}" if options[:id]
+      path
     end
-
   end
 end

data/lib/vend/null_logger.rb

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