lightspeed_pos 0.1.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f479289d48eb83582ea0f30e93bf82644e0a5cad
-  data.tar.gz: a0b8758eaeeaa5f7f6f044cc9bdd3689156f6d03
+SHA256:
+  metadata.gz: 698710d57a5ef3c30c022c2f050b9df04976227b2482a3075c851b27db3642fe
+  data.tar.gz: 6abdc460a2cd345883c2cb853c9c6c16051273606914d7ba5fcaa72089402dae
 SHA512:
-  metadata.gz: be2f7ba8a83b024b43def375f084ab63f695087651563e690f4ec235c453b1f19d54cf0e938f5fd31a04fb83e110d8c0fde4c5006bac7c405f6da6c987bc9891
-  data.tar.gz: e04d5d7c4dabf225688e79e5bf071cd86c371ec5dd2fffea4d88721970ceeb4558cf3b996a24b42ebaf3a3f9be15cd2d72ee3b5dec07011bfc38a4d37bbeaa41
+  metadata.gz: 03f3b9db98a4145a9751b2990beabccf96d79a78fece26a40a3163ffe0d8604ea41ad0316b52ce9a3e27f77fea1e6cb0ce708438bc37c22cacef0a0401ef9245
+  data.tar.gz: 3c8f3710b4f8e76bda81e5e02265115c0252c38b8c177ff707c9dab53026da1d8598504d77ae9d31c3a17a0cfa2796d5cd293355b25b7c8aeca4e44762e26830

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,69 +1,77 @@
-AlignHash:
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  NewCops: enable
+  SuggestExtensions:
+    rubocop-rake: false
+    rubocop-rspec: false
+
+Layout/HashAlignment:
   EnforcedLastArgumentHashStyle: always_ignore
 
-AlignParameters:
+Layout/ParameterAlignment:
   Enabled: false
 
-LineLength:
+Layout/LineLength:
   Max: 180
 
-ClassLength:
+Metrics/ClassLength:
   Enabled: true
   Severity: refactor
   Max: 300
 
-MethodLength:
+Metrics/MethodLength:
   Enabled: true
   Max: 30
   Severity: refactor
 
-CyclomaticComplexity:
+Metrics/CyclomaticComplexity:
   Max: 10
   Severity: refactor
 
-EndAlignment:
+Layout/EndAlignment:
   Enabled: false
 
-StringLiterals:
+Style/StringLiterals:
   Enabled: false
 
-Documentation:
+Style/Documentation:
   Enabled: false
 
-PercentLiteralDelimiters:
+Style/PercentLiteralDelimiters:
   PreferredDelimiters:
     '%w': '{}'
 
-MethodDefParentheses:
+Style/MethodDefParentheses:
   Enabled: false
 
-PredicateName:
-  NamePrefixBlacklist:
+Naming/PredicateName:
+  ForbiddenPrefixes:
     - is_
     - have_
 
-IndentHash:
+Layout/FirstHashElementIndentation:
   EnforcedStyle: consistent
 
 # breaks using if blocks with assignments
-IndentationWidth:
+Layout/IndentationWidth:
   Enabled: false
 
-CaseIndentation:
-  IndentWhenRelativeTo: end
-
-FormatString:
-  Enabled: false
+Layout/CaseIndentation:
+  EnforcedStyle: end
 
-ActionFilter:
+Style/FormatString:
   Enabled: false
 
 # different methods calls that do exactly the same thing are a smell, regardless of semantics
-SignalException:
+Style/SignalException:
   EnforcedStyle: only_raise
 
-DoubleNegation:
+Style/DoubleNegation:
+  Enabled: false
+
+Style/TrailingCommaInArrayLiteral:
   Enabled: false
 
-TrailingComma:
+Style/TrailingCommaInArguments:
   Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,284 @@
+# 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: 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/TrailingEmptyLines:
+  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/MethodParameterName:
+  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: 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,11 @@
 language: ruby
 rvm:
-  - 2.2.2
-  - 2.1.6
+  - 2.5
+  - 2.6
+  - 2.7
+  - 3.0
 script:
-  - 'bundle exec rspec spec'
   - 'bundle exec rubocop'
+  - 'bundle exec rspec spec'
 cache: bundler
 sudo: false

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in lightspeed-pos.gemspec

data/README.markdown

@@ -1,46 +1,50 @@
 # Lightspeed POS
 
-[![Build Status](https://travis-ci.org/radar/lightspeed-pos.svg?branch=master)](https://travis-ci.org/radar/lightspeed-pos)
-[![Code Climate](https://codeclimate.com/github/radar/lightspeed-pos/badges/gpa.svg)](https://codeclimate.com/github/radar/lightspeed-pos)
+An _unofficial_ gem for interacting with [Lightspeed's Point of Sale API](http://www.lightspeedpos.com/retail/help/developers/api/basics/), ([documentation](http://cloud-docs.lightspeedapp.com/API/APIHelp.help)).
 
-
-An _unofficial_ gem for interacting with [Lightspeed's Point of Sale API](http://www.lightspeedpos.com/retail/help/developers/api/basics/). Works with API keys for the time being.
-
-Most definitely not production ready yet, but you can help by submitting pull requests!
+Not all endpoints are implemented yet, but you can help by submitting pull requests!
 
 ## Getting Started
 
 First, intialize a new client:
 
 ```ruby
-client = Lightspeed::Client.new(api_key: "YOUR_API_KEY_HERE")
+client = Lightspeed::Client.new(oauth_token_holder: yourOAuthAwareObjectHere)
 ```
 
-**OR** you may also choose to pass through an OAuth access token if you have one:
-
-```ruby
-client = Lightspeed::Client.new(oauth_token: "YOUR_ACCESS_TOKEN_HERE")
-```
+`yourOAuthAwareObjectHere` must be an object that responds to `oauth_token` and `refresh_oauth_token`. `oauth_token` must return an access token, and `refresh_oauth_token` must handle the refreshing of expired access tokens, so that a subsequent call to `oauth_token` will return a new, unexpired access token.
 
 Next, make a request for your accounts:
 
 ```ruby
-accounts = client.accounts
+accounts = client.accounts.all
 ```
 
 Pick the account you want to use, and then start using it:
 
 ```ruby
 account = accounts.first
-account.items # This will return the first 100 items from the account
+account.items.first
 ```
 
-## Account Resources
+## Resources
 
-Account resources share a common API. Account resources that are currently supported by this library are:
+resources share a common API. Resources that are currently supported by this library are:
 
+* Accounts
 * Categories
+* Employees
 * Items
+* Item Matrices
+* Item Attribute Sets
+* Images
+* Inventories
+* Orders
+* Sales
+* 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.
 
@@ -52,6 +56,28 @@ You can fetch a list of items with this:
 account.items.all
 ```
 
+You can pass query parameters to this by using the `params` keyword:
+
+```ruby
+account.items.all(params: { itemMatrixID: 0 })
+```
+
+You can enumerate over a group of 100 resources at a time (the max in a single request) using `each_page`
+
+```ruby
+account.items.each_page! do |items|
+  # ItemImporter.import(items)
+end
+```
+
+Or enumerate over each resource using #each (this still only does a request for each 100 items)
+
+```ruby
+account.items.each do |item|
+  # ItemImporter.import(item)
+end
+```
+
 ### Show
 
 You can fetch a particular item by its ID by doing this:
@@ -59,15 +85,19 @@ You can fetch a particular item by its ID by doing this:
 ```ruby
 account.items.find(1)
 ```
+If item with id of `1` is not there, this will raise `Lightspeed::Error::NotFound`
+
+You can fetch the first item using `first`
+```ruby
+account.items.first
+```
 
 ### Create
 
 You can create a particular item by calling `create`:
 
 ```ruby
-account.items.create({
-  description: "Onesie"
-})
+account.items.create(description: "Onesie")
 ```
 
 ### Update
@@ -75,24 +105,51 @@ account.items.create({
 You can update a particular item by calling `update`, passing that item's ID and providing a list of attributes to update:
 
 ```ruby
-account.items.update(1, {
-  description: "Onesie"
-})
+account.items.update(1, description: "Onesie")
+# OR
+account.items.find(1)
+item.update(description: "Onesie")
 ```
 
-This method isn't available on items themselves because I couldn't work out how to share the account ID easily there.
-
 ### Destroy
 
 You can destroy a particular item by calling `destroy` and passing that item's ID:
 
 ```ruby
-account.items.destroy(1)
+account.images.destroy(1)
+# OR
+account.images.find(1)
+item.destroy
 ```
 
-For the `Items` resource, this is aliased to `archive`:
+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
 
-```ruby
-account.items.archive(1)
 ```
+$ 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.**