lightspeed_pos 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3e50edadd52d55b1ed3b2def3b6b10b765d8ac2a
-  data.tar.gz: b59ae04766b48a27126491e94a4b88fbf7a71902
+SHA256:
+  metadata.gz: 8b42db3649e13304941c1fb7770b350bccb22d5751c1f8277c290df0134ea468
+  data.tar.gz: b2f9b9005019a428f673e7d6999fbc3f4900f2923b13342c9050d0deb88dbc51
 SHA512:
-  metadata.gz: 7951c24a7ee73b3840a1145b8f8c8d797e074a1b03277ea4fe814618fd7045116a41d06ae9ea1c8c723f1561e1b84547c0799a5a3d0d13f74fe0bf500a9841bd
-  data.tar.gz: f1c67e762048bfc0a08660027e2742ed6d3d85b33467062cb558b0569fc094498f2490ee41c6e3f250cc39b0316ffd971b3a1162181a8b943b8ccb512beee387
+  metadata.gz: 34f6532de1edfe8417970b7b255557b7882d2bc4df373bdf69631f29bed3b941f7db5eb4a38a1a074bebc539b5e3c6e192d47d3d6db8a5294b6aa4d156fc1c10
+  data.tar.gz: 78455dc05e80e7246e13dd858bcb30d40956a75967ed9e8bb516e24b122be63287b8678d508d29c25483615be7ad7488395cb7a2f1a3c93631c6f819dddef06f

data/.mailmap

@@ -0,0 +1,4 @@
+Dana Sherson <robot@dana.sh> Dan Sherson <me@dansherson.com>
+Dana Sherson <robot@dana.sh> Daniel Sherson <me@dansherson.com>
+Dana Sherson <robot@dana.sh> Dan Sherson <me@danielsherson.com>
+Dana Sherson <robot@dana.sh> Daniel Sherson <me@danielsherson.com>

data/.rubocop.yml

@@ -1,3 +1,5 @@
+inherit_from: .rubocop_todo.yml
+
 AlignHash:
   EnforcedLastArgumentHashStyle: always_ignore
 
@@ -42,7 +44,7 @@ PredicateName:
     - is_
     - have_
 
-IndentHash:
+IndentFirstHashElement:
   EnforcedStyle: consistent
 
 # breaks using if blocks with assignments
@@ -65,7 +67,7 @@ SignalException:
 DoubleNegation:
   Enabled: false
 
-Style/TrailingCommaInLiteral:
+Style/TrailingCommaInArrayLiteral:
   Enabled: false
 
 Style/TrailingCommaInArguments:

data/.rubocop_todo.yml

@@ -0,0 +1,298 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2019-05-06 09:20:12 +1000 using RuboCop version 0.68.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: TreatCommentsAsGroupSeparators, Include.
+# Include: **/*.gemspec
+Gemspec/OrderedDependencies:
+  Exclude:
+    - 'lightspeed_pos.gemspec'
+
+# Offense count: 5
+# Cop supports --auto-correct.
+Layout/EmptyLineAfterGuardClause:
+  Exclude:
+    - 'bin/console'
+    - 'lib/lightspeed/collection.rb'
+    - 'lib/lightspeed/request.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Layout/EmptyLineAfterMagicComment:
+  Exclude:
+    - 'lightspeed_pos.gemspec'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowAdjacentOneLineDefs, NumberOfEmptyLines.
+Layout/EmptyLineBetweenDefs:
+  Exclude:
+    - 'lib/lightspeed/resource.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Layout/EmptyLines:
+  Exclude:
+    - 'lib/lightspeed/resource.rb'
+
+# Offense count: 7
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: empty_lines, no_empty_lines
+Layout/EmptyLinesAroundBlockBody:
+  Exclude:
+    - 'spec/lightspeed/orders_spec.rb'
+    - 'spec/lightspeed/sale_line_spec.rb'
+    - 'spec/lightspeed/sale_spec.rb'
+    - 'spec/lightspeed/sales_spec.rb'
+    - 'spec/lightspeed/special_order_spec.rb'
+    - 'spec/lightspeed/special_orders_spec.rb'
+    - 'spec/lightspeed/vendor_spec.rb'
+
+# Offense count: 7
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: empty_lines, empty_lines_except_namespace, empty_lines_special, no_empty_lines, beginning_only, ending_only
+Layout/EmptyLinesAroundClassBody:
+  Exclude:
+    - 'lib/lightspeed/customer.rb'
+    - 'lib/lightspeed/order.rb'
+    - 'lib/lightspeed/request_throttler.rb'
+    - 'lib/lightspeed/sale.rb'
+    - 'lib/lightspeed/sale_line.rb'
+    - 'lib/lightspeed/vendor.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Layout/LeadingBlankLines:
+  Exclude:
+    - 'lib/lightspeed/item.rb'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, IndentationWidth.
+# SupportedStyles: aligned, indented, indented_relative_to_receiver
+Layout/MultilineMethodCallIndentation:
+  Exclude:
+    - 'lib/lightspeed/collection.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Layout/SpaceAfterNot:
+  Exclude:
+    - 'lib/lightspeed/request.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowForAlignment.
+Layout/SpaceAroundOperators:
+  Exclude:
+    - 'lib/lightspeed/request_throttler.rb'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces.
+# SupportedStyles: space, no_space, compact
+# SupportedStylesForEmptyBraces: space, no_space
+Layout/SpaceInsideHashLiteralBraces:
+  Exclude:
+    - 'spec/lightspeed/sales_spec.rb'
+
+# Offense count: 14
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: final_newline, final_blank_line
+Layout/TrailingBlankLines:
+  Exclude:
+    - 'lib/lightspeed/customer.rb'
+    - 'lib/lightspeed/customers.rb'
+    - 'lib/lightspeed/order.rb'
+    - 'lib/lightspeed/orders.rb'
+    - 'lib/lightspeed/sale.rb'
+    - 'lib/lightspeed/sale_line.rb'
+    - 'lib/lightspeed/sale_lines.rb'
+    - 'lib/lightspeed/sales.rb'
+    - 'lib/lightspeed/special_order.rb'
+    - 'lib/lightspeed/special_orders.rb'
+    - 'spec/lightspeed/sale_line_spec.rb'
+    - 'spec/lightspeed/sale_spec.rb'
+    - 'spec/lightspeed/sales_spec.rb'
+    - 'spec/lightspeed/special_order_spec.rb'
+
+# Offense count: 1
+# Configuration parameters: AllowSafeAssignment.
+Lint/AssignmentInCondition:
+  Exclude:
+    - 'lib/lightspeed/request.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Lint/BigDecimalNew:
+  Exclude:
+    - 'lib/lightspeed/prices.rb'
+    - 'lib/lightspeed/resource.rb'
+
+# Offense count: 3
+Lint/DuplicateMethods:
+  Exclude:
+    - 'lib/lightspeed/resource.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: runtime_error, standard_error
+Lint/InheritException:
+  Exclude:
+    - 'lib/lightspeed/error.rb'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+Lint/ToJSON:
+  Exclude:
+    - 'lib/lightspeed/collection.rb'
+    - 'lib/lightspeed/prices.rb'
+    - 'lib/lightspeed/resource.rb'
+
+# Offense count: 1
+# Configuration parameters: CheckForMethodsWithNoSideEffects.
+Lint/Void:
+  Exclude:
+    - 'lib/lightspeed/resource.rb'
+
+# Offense count: 7
+# Configuration parameters: CountComments, ExcludedMethods.
+# ExcludedMethods: refine
+Metrics/BlockLength:
+  Max: 82
+
+# Offense count: 2
+# Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
+# AllowedNames: io, id, to, by, on, in, at, ip, db
+Naming/UncommunicativeMethodParamName:
+  Exclude:
+    - 'lib/lightspeed/accounts.rb'
+    - 'lib/lightspeed/collection.rb'
+
+# Offense count: 14
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: prefer_alias, prefer_alias_method
+Style/Alias:
+  Exclude:
+    - 'lib/lightspeed/collection.rb'
+    - 'lib/lightspeed/customer.rb'
+    - 'lib/lightspeed/customers.rb'
+    - 'lib/lightspeed/item.rb'
+    - 'lib/lightspeed/items.rb'
+    - 'lib/lightspeed/order.rb'
+    - 'lib/lightspeed/orders.rb'
+    - 'lib/lightspeed/prices.rb'
+    - 'lib/lightspeed/resource.rb'
+    - 'lib/lightspeed/sale.rb'
+    - 'lib/lightspeed/sales.rb'
+    - 'lib/lightspeed/vendor.rb'
+    - 'lib/lightspeed/vendors.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: braces, no_braces, context_dependent
+Style/BracesAroundHashParameters:
+  Exclude:
+    - 'spec/lightspeed/sales_spec.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: Keywords.
+# Keywords: TODO, FIXME, OPTIMIZE, HACK, REVIEW
+Style/CommentAnnotation:
+  Exclude:
+    - 'spec/lightspeed/sales_spec.rb'
+
+# Offense count: 6
+Style/CommentedKeyword:
+  Exclude:
+    - 'lib/lightspeed/error.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/EmptyCaseCondition:
+  Exclude:
+    - 'lib/lightspeed/resource.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/Encoding:
+  Exclude:
+    - 'lightspeed_pos.gemspec'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/ExpandPathArguments:
+  Exclude:
+    - 'lightspeed_pos.gemspec'
+    - 'spec/spec_helper.rb'
+
+# Offense count: 2
+# Configuration parameters: MinBodyLength.
+Style/GuardClause:
+  Exclude:
+    - 'lib/lightspeed/request.rb'
+    - 'lib/lightspeed/resource.rb'
+
+# Offense count: 4
+# Cop supports --auto-correct.
+Style/IfUnlessModifier:
+  Exclude:
+    - 'lib/lightspeed/resource.rb'
+    - 'spec/spec_helper.rb'
+
+# Offense count: 1
+Style/MissingRespondToMissing:
+  Exclude:
+    - 'lib/lightspeed/prices.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: literals, strict
+Style/MutableConstant:
+  Exclude:
+    - 'lib/lightspeed/version.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/OneLineConditional:
+  Exclude:
+    - 'lib/lightspeed/request_throttler.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/ParallelAssignment:
+  Exclude:
+    - 'lib/lightspeed/request_throttler.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/RedundantSelf:
+  Exclude:
+    - 'lib/lightspeed/resource.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/SelfAssignment:
+  Exclude:
+    - 'spec/lightspeed/client_spec.rb'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: MinSize.
+# SupportedStyles: percent, brackets
+Style/SymbolArray:
+  EnforcedStyle: brackets

data/.travis.yml

@@ -1,9 +1,10 @@
 language: ruby
 rvm:
-  - 2.2.2
-  - 2.1.6
+  - 2.3
+  - 2.4
+  - 2.5
 script:
-  - 'bundle exec rspec spec'
   - 'bundle exec rubocop'
+  - 'bundle exec rspec spec'
 cache: bundler
 sudo: false

data/README.markdown

@@ -44,6 +44,7 @@ resources share a common API. Resources that are currently supported by this lib
 * Shops
 * Special Orders
 * Vendors
+* Customers
 
 To work with account resources, you first need to fetch an account. The examples below are for items, but will also work with other types listed above.
 
@@ -126,3 +127,29 @@ For the `Item` resource, `destroy` is aliased to `archive`:
 ## Rate Limiting
 
 This gem respects the `X-LS-API-Bucket-Level` header by pausing before a request that would otherwise overrun the API rate limit. It calls `Kernel.sleep` with the minimum number of seconds needed to avoid hitting the limit, which suspends the current thread during that time. If you need to make API calls across multiple Lightspeed accounts using this gem, its recommended to make requests against each account in a separate thread.
+
+## Contributing
+
+### Local setup
+
+```
+$ bundle install
+```
+
+### How to run Tests
+
+```
+$ rspec
+```
+
+### How to write Tests
+
+This repository uses the [`vcr` gem](https://github.com/vcr/vcr) to record HTTP interactions and replay them during next tests runs.
+
+The following `ENV` variables are required for recording new HTTP interactions.
+
+* `LIGHTSPEED_OAUTH_TOKEN` : not expired OAuth token
+* `LIGHTSPEED_OAUTH_REFRESH_TOKEN` : the OAuth refresh token
+* `LIGHTSPEED_ACCOUNT_ID` : a Ligthspeed account id
+
+**Be careful with the data you set as real API calls will be performed.**

data/lib/lightspeed/account.rb

@@ -12,6 +12,7 @@ require_relative 'sales'
 require_relative 'shops'
 require_relative 'special_orders'
 require_relative 'vendors'
+require_relative 'customers'
 
 module Lightspeed
   class Account < Lightspeed::Resource
@@ -33,7 +34,8 @@ module Lightspeed
       :Sales,
       :Shops,
       :SpecialOrders,
-      :Vendors
+      :Vendors,
+      :Customers
     )
 
     def account

data/lib/lightspeed/customer.rb

@@ -0,0 +1,34 @@
+require_relative 'resource'
+
+module Lightspeed
+  class Customer < Lightspeed::Resource
+    alias_method :archive, :destroy
+
+    fields(
+      customerID: :id,
+      firstName: :string,
+      lastName: :string,
+      dob: :timestamp,
+      archived: :boolean,
+      title: :string,
+      company: :string,
+      companyRegistrationNumber: :string,
+      vatNumber: :string,
+      createTime: :timestamp,
+      timeStamp: :timestamp,
+      creditAccountID: :id,
+      customerTypeID: :id,
+      discountID: :id,
+      taxCategoryID: :id,
+      Contact: :hash,
+      CreditAccount: :hash,
+      CustomerType: :hash,
+      Discount: :hash,
+      Note: :hash,
+      TaxCategory: :hash,
+      CustomFieldValues: :hash
+    )
+
+  end
+end
+

data/lib/lightspeed/customers.rb

@@ -0,0 +1,9 @@
+require_relative 'collection'
+
+require_relative 'customer'
+
+module Lightspeed
+  class Customers < Lightspeed::Collection
+    alias_method :archive, :destroy
+  end
+end

data/lib/lightspeed/request.rb

@@ -56,10 +56,12 @@ module Lightspeed
       perform_raw
     rescue Lightspeed::Error::Throttled
       retry_throttled_request
-    rescue Lightspeed::Error::Unauthorized
+    rescue Lightspeed::Error::Unauthorized => e
+      raise e if @attempted_oauth_token_refresh
       @client.refresh_oauth_token
       set_authorization_header
-      perform_raw
+      @attempted_oauth_token_refresh = true
+      perform
     end
 
     private
@@ -77,7 +79,6 @@ module Lightspeed
     end
 
     def handle_error(response)
-      data = Yajl::Parser.parse(response.body)
       error = case response.code.to_s
       when '400' then Lightspeed::Error::BadRequest
       when '401' then Lightspeed::Error::Unauthorized
@@ -87,7 +88,14 @@ module Lightspeed
       when /5../ then Lightspeed::Error::InternalServerError
       else Lightspeed::Error
       end
-      raise error, data["message"]
+
+      # We may not get back valid JSON for a failed request
+      begin
+        data = Yajl::Parser.parse(response.body)
+        raise error, data["message"]
+      rescue Yajl::ParseError
+        raise error, response.code
+      end
     end
 
     def extract_rate_limits(response)
@@ -110,6 +118,5 @@ module Lightspeed
       when :delete then Net::HTTP::Delete
       end
     end
-
   end
 end

data/lib/lightspeed/version.rb

@@ -1,3 +1,3 @@
 module Lightspeed
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lightspeed_pos
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Ryan Bigg
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-16 00:00:00.000000000 Z
+date: 2019-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -158,8 +158,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".mailmap"
 - ".rspec"
 - ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE
@@ -173,6 +175,8 @@ files:
 - lib/lightspeed/category.rb
 - lib/lightspeed/client.rb
 - lib/lightspeed/collection.rb
+- lib/lightspeed/customer.rb
+- lib/lightspeed/customers.rb
 - lib/lightspeed/employee.rb
 - lib/lightspeed/employees.rb
 - lib/lightspeed/error.rb
@@ -229,7 +233,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A gem for interacting with Lightspeed's Point of Sale system