lightspeed_restaurant 3.3.3 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 340ce0c747aaa516dc5c4bbed52c1842c138ecc4d6777e953a41ae649b1a60b1
-  data.tar.gz: 975aedc38edeba28cde45a90d07833e6c34a58578444e948bb424b20dc0a68ca
+  metadata.gz: 819c48f8c7338828400e8fd788fa7f5d51951c8e71bd1cd86337dc329a666990
+  data.tar.gz: 4ad3e802b271568b2724c8a0a18e66a56c2dbe076f7c6a7efd6fbde14f27fd40
 SHA512:
-  metadata.gz: d057e14d22367a2ee8882b8e1dc3d2b3baff505e68867e6747e3e53b37844742c490e1844c8094636681d039992de64f0f9bd7e82c447ee43be459c8a6b0478e
-  data.tar.gz: c7a1262ea1ef6fd00cc99be0815bcd9c84b45c4e2a62aef103f38c20c1d1b5153fb8cb8b721b8da6ce42d36add021fc38b8c15733f6e1bc5e3da44a6cfe45565
+  metadata.gz: 4d0e9268772e1021354f60fc515f400d23dff8ea135c6ab5185d35dd2989695f08d52dc94fd8e1fe6003f5b7789e7f358cc043833701a40b523f25fdb783ca7d
+  data.tar.gz: 9f53439e6203bfe3ea7426fb44f5c1fc29db25f1c7956221190b99c28a702bb7d572672b213b271250e4df9ded357beea9d0ff02415ec20c4ed7890e2ed8ba2b

data/.github/workflows/ci.yml

@@ -7,18 +7,19 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby: [2.6]
+        ruby: ['3.3', '3.4.0-preview2']
 
     steps:
     - uses: actions/checkout@master
 
     - name: Set up the Ruby version
-      uses: actions/setup-ruby@v1
+      uses: ruby/setup-ruby@v1
       with:
-        ruby-version: ${{ matrix.ruby }}
+        ruby-version: '3.3'
+        bundler-cache: true
 
     - name: Ruby gem cache
-      uses: actions/cache@v1
+      uses: actions/cache@v4
       with:
         path: vendor/bundle
         key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
@@ -27,7 +28,6 @@ jobs:
 
     - name: Set up the environment
       run: |
-        gem install bundler
         bundle config path vendor/bundle
         bundle install --jobs 4 --retry 3
 
@@ -38,18 +38,19 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby: [2.6]
+        ruby: ['3.3', '3.4.0-preview2']
 
     steps:
     - uses: actions/checkout@master
 
     - name: Set up the Ruby version
-      uses: actions/setup-ruby@v1
+      uses: ruby/setup-ruby@v1
       with:
-        ruby-version: ${{ matrix.ruby }}
+        ruby-version: '3.3'
+        bundler-cache: true
 
     - name: Ruby gem cache
-      uses: actions/cache@v1
+      uses: actions/cache@v4
       with:
         path: vendor/bundle
         key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
@@ -58,7 +59,6 @@ jobs:
 
     - name: Set up the environment
       run: |
-        gem install bundler
         bundle config path vendor/bundle
         bundle install --jobs 4 --retry 3
 

data/.rubocop.yml

@@ -1,44 +1,87 @@
 require: rubocop-rspec
 
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
 Layout/LineLength:
-  Max: 100
+  Enabled: false
 
-Metrics/ParameterLists:
-  Max: 6
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
 
-Metrics/MethodLength:
-  Max: 15
+Lint/ConstantDefinitionInBlock:
+  Enabled: false
 
-Style/StringLiterals:
-  EnforcedStyle: single_quotes
-  SupportedStyles:
-    - single_quotes
-    - double_quotes
-  ConsistentQuotesInMultiline: false
+Lint/MissingSuper:
+  Enabled: false
+
+Lint/NonDeterministicRequireOrder:
+  Enabled: false
+
+Lint/SuppressedException:
+  Enabled: false
+
+Lint/ToJSON:
+  Enabled: false
+
+Lint/UselessMethodDefinition:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
 
 Metrics/BlockLength:
   Severity: warning
   Exclude:
     - spec/**/*
 
-Lint/SuppressedException:
+Metrics/ClassLength:
+  Max: 200
+  Severity: warning
+
+Metrics/ParameterLists:
+  Max: 6
+  MaxOptionalParameters: 6
+
+Metrics/MethodLength:
+  Max: 15
+
+Naming/BinaryOperatorParameterName:
+  Enabled: false
+
+RSpec/ContextWording:
+  Enabled: false
+
+RSpec/InstanceVariable:
+  Enabled: false
+
+RSpec/LeakyConstantDeclaration:
   Enabled: false
 
 RSpec/MultipleExpectations:
   Max: 3
 
-Security/YAMLLoad:
+RSpec/MessageSpies:
   Enabled: false
 
-Style/Documentation:
+RSpec/NoExpectationExample:
   Enabled: false
 
-Layout/MultilineMethodCallIndentation:
+RSpec/StubbedMock:
+  Enabled: false
+
+RSpec/ExampleLength:
   Enabled: false
 
 Style/ClassAndModuleChildren:
   Enabled: false
 
+Style/Documentation:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
 Style/PercentLiteralDelimiters:
   PreferredDelimiters:
     default: ()
@@ -48,6 +91,12 @@ Style/PercentLiteralDelimiters:
     '%w': '[]'
     '%W': '[]'
 
-Metrics/ClassLength:
-  Max: 200
-  Severity: warning
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+  SupportedStyles:
+    - single_quotes
+    - double_quotes
+  ConsistentQuotesInMultiline: false
+
+Security/YAMLLoad:
+  Enabled: false

data/.ruby-version

@@ -1 +1 @@
-ruby-2.6.5
+ruby-3.3.6

data/CHANGELOG.md

@@ -1,8 +1,18 @@
 # Changelog
 
+## 3.5.0 / 2024-12-10
+
+- Add `externalPaymentProvider` resource endpoints
+- Add `webhook` resource endpoints
+- Upgrade ruby version to 3.3.6
+
+## 3.4.0 / 2021-04-08
+
+- Add `find` endpoint for the InventoryProduct
+
 ## 3.3.3 / 2021-04-08
 
-- Add `find` endpoint for the company 
+- Add `find` endpoint for the company
 
 ## 3.3.2 / 2020-03-20
 

data/README.md

@@ -2,7 +2,7 @@
 
 [![Code Climate](https://codeclimate.com/github/chronogolf/lightspeed_restaurant/badges/gpa.svg)](https://codeclimate.com/github/chronogolf/lightspeed_restaurant) [![Gem Version](https://badge.fury.io/rb/lightspeed_restaurant.svg)](https://badge.fury.io/rb/lightspeed_restaurant)
 
-[Lightspeed Restaurant API Client](https://github.com/chronogolf/lightspeed_restaurant) is a gem for interacting with [Lightspeed Restaurant](https://www.lightspeedhq.com/products/restaurant/) API.
+[Lightspeed Restaurant API Client](https://github.com/chronogolf/lightspeed_restaurant) is a gem for interacting with [Lightspeed Restaurant](https://www.lightspeedhq.com/pos/restaurant/) API.
 Lightspeed Restaurant is point of sale that helps bars, restaurants, and cafés deliver a better customer experience and run a more profitable business.
 
 ## Installation
@@ -10,7 +10,7 @@ Lightspeed Restaurant is point of sale that helps bars, restaurants, and cafés
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'lightspeed_restaurant'
+gem "lightspeed_restaurant"
 ```
 
 And then execute:
@@ -26,23 +26,29 @@ Or install it yourself as:
 ### Basic Usage
 
 First, set your api token:
+
 ```ruby
 LightspeedRestaurantClient.api_token = "YOUR_API_TOKEN_HERE"
 ```
+
 Next, make requests using the resource class you need:
+
 ```ruby
 customers = LightspeedRestaurantClient::Customer.all
 customer  = customers.first
-customer.firstName = 'Tom'
+customer.firstName = "Tom"
 customer.save
 ```
-That's it!
+
+That"s it!
 
 ### Using a custom API configuration per action
+
 Each action support a configuration object as the last param, allows you to setup `api_token`, `base_uri`
 Sample usage:
+
 ```ruby
-LightspeedRestaurantClient::Customer.all(LightspeedRestaurantClient.default_configuration.with(api_token: 'MY_OTHER_TOKEN', base_uri: 'other_ls_resto_uri'))
+LightspeedRestaurantClient::Customer.all(LightspeedRestaurantClient.default_configuration.with(api_token: "MY_OTHER_TOKEN", base_uri: "other_ls_resto_uri"))
 ```
 
 ### Available operations
@@ -54,28 +60,33 @@ LightspeedRestaurantClient::Customer.all
 ```
 
 #### Find
+
 ```ruby
 LightspeedRestaurantClient::Customer.find(123)
 ```
 
 #### Create
+
 ```ruby
-LightspeedRestaurantClient::Customer.create(...firstName: 'Tom', email: 'tom@brady.com'...)
+LightspeedRestaurantClient::Customer.create(...firstName: "Tom", email: "tom@brady.com"...)
 ```
 
 #### Update
+
 ```ruby
-LightspeedRestaurantClient::Customer.update(123, { email: 'tom@brady.com' })
+LightspeedRestaurantClient::Customer.update(123, { email: "tom@brady.com" })
 ```
 
 #### Save
+
 ```ruby
 customer = LightspeedRestaurantClient::Customer.find(123)
-customer.firstName = 'Micheal'
+customer.firstName = "Micheal"
 customer.save
 ```
 
 #### Destroy
+
 ```ruby
 customer = LightspeedRestaurantClient::Customer.find(123)
 customer.destroy
@@ -85,6 +96,7 @@ customer.destroy
 
 By default the logs are done on STDOUT.
 You can specify your own logger (it has to respond to info and error methods, like the Rails logger) :
+
 ```ruby
 LightspeedRestaurantClient.logger = "YOUR_LOGGER"
 ```
@@ -94,13 +106,15 @@ LightspeedRestaurantClient.logger = "YOUR_LOGGER"
 Pull requests are welcome on GitHub at https://github.com/chronogolf/lightspeed_restaurant.
 
 ## About Us
-[![Chronogolf][crest]](https://www.chronogolf.com)
 
-[Chronogolf](https://www.chronogolf.com)'s mission is to facilitate the interactions between golf managers and golf players. We are building software that allows golf directors to better manage their course, together with a marketplace to find & book games in real-time. We are constantly innovating and trying to challenge the status quo.
+[![Chronogolf by Lightspeed][crest]](https://www.lightspeedhq.com)
+
+[Chronogolf by Lightspeed](https://www.lightspeedhq.com/golf/)'s mission is to facilitate the interactions between golf managers and golf players. We are building software that allows golf directors to better manage their course, together with a marketplace to find & book games in real-time. We are constantly innovating and trying to challenge the status quo.
 
-Find more informations at https://pro.chronogolf.com
+Learn more at [https://www.lightspeedhq.com/golf/](https://www.lightspeedhq.com/golf/)
 
 ## Future Improvements
+
 - Improve destroy operation to handle destroy by passing an ID (or an array of IDs)
 - Add missing resources (Company, Reservation, Floor, Table...)
 - Improve test coverage
@@ -109,4 +123,4 @@ Find more informations at https://pro.chronogolf.com
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 
-[crest]: https://cdn2.chronogolf.com/assets/logos/Github%20-%20Header.png
+[crest]: ./logo.png

data/lib/lightspeed_restaurant/company.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'lightspeed_restaurant/base'
+require 'lightspeed_restaurant/operations/find'
 require 'lightspeed_restaurant/operations/list'
 
 module LightspeedRestaurantClient

data/lib/lightspeed_restaurant/errors/lightspeed_restaurant_error.rb

@@ -2,12 +2,7 @@
 
 module LightspeedRestaurantClient
   class LightspeedRestaurantClientError < StandardError
-    attr_reader :message
-    attr_reader :http_status
-    attr_reader :http_body
-    attr_reader :http_headers
-    attr_reader :request_id
-    attr_reader :json_body
+    attr_reader :message, :http_status, :http_body, :http_headers, :request_id, :json_body
 
     def initialize(message = nil, http_status = nil, http_body = nil, http_headers = nil)
       @message = message

data/lib/lightspeed_restaurant/external_payment_provider.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'lightspeed_restaurant/base'
+require 'lightspeed_restaurant/operations/list'
+require 'lightspeed_restaurant/operations/find'
+require 'lightspeed_restaurant/operations/create'
+
+module LightspeedRestaurantClient
+  class ExternalPaymentProvider < LightspeedRestaurantClient::Base
+    extend Operations::Create
+    extend Operations::Find
+    extend Operations::List
+
+    def self.resource_name
+      'externalPaymentProvider'
+    end
+
+    def self.default_resource_path
+      "/rest/partner/v1/#{resource_name}/"
+    end
+  end
+end

data/lib/lightspeed_restaurant/inventory_product.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'lightspeed_restaurant/base'
+require 'lightspeed_restaurant/operations/find'
+
+module LightspeedRestaurantClient
+  class InventoryProduct < LightspeedRestaurantClient::Base
+    extend Operations::Find
+
+    def self.resource_name
+      'Inventory/Product'
+    end
+
+    def self.default_resource_path
+      "/rest/#{resource_name.downcase}"
+    end
+  end
+end

data/lib/lightspeed_restaurant/operations/create.rb

@@ -14,9 +14,10 @@ module LightspeedRestaurantClient
       private
 
       def handle_create_response(response, attributes)
-        case response
-        when Numeric
+        if response.is_a?(Numeric)
           attributes.merge(id: response)
+        elsif self == LightspeedRestaurantClient::ExternalPaymentProvider
+          response.merge(id: response['data']['id'])
         else
           response
         end

data/lib/lightspeed_restaurant/operations/find.rb

@@ -4,9 +4,17 @@ module LightspeedRestaurantClient
   module Operations
     module Find
       def find(id, configuration = nil)
-        response = JSON.parse(LightspeedRestaurantClient.get(default_resource_path + "/#{id}", {}, configuration))
+        response = JSON.parse(LightspeedRestaurantClient.get(default_resource_path + id_path(id), {}, configuration))
         new(response)
       end
+
+      private
+
+      def id_path(id)
+        return id.to_s if self == LightspeedRestaurantClient::ExternalPaymentProvider
+
+        "/#{id}"
+      end
     end
   end
 end

data/lib/lightspeed_restaurant/operations/list.rb

@@ -19,7 +19,7 @@ module LightspeedRestaurantClient
       def handle_list_response(response)
         case response
         when Hash
-          response['results']
+          response['results'] || response['data']
         else
           response
         end

data/lib/lightspeed_restaurant/operations/renew.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module LightspeedRestaurantClient
+  module Operations
+    module Renew
+      def renew(id, configuration = nil)
+        response = JSON.parse(LightspeedRestaurantClient.post("#{default_resource_path}/#{id}/renew", {}, {}, configuration))
+        new(response)
+      end
+    end
+  end
+end

data/lib/lightspeed_restaurant/request.rb

@@ -6,6 +6,7 @@ require 'lightspeed_restaurant/errors/authentication_error'
 require 'lightspeed_restaurant/errors/invalid_request_error'
 require 'lightspeed_restaurant/errors/not_found_error'
 require 'lightspeed_restaurant/errors/rate_limit_error'
+require 'lightspeed_restaurant/errors/unauthorized_error'
 require 'uri'
 
 module LightspeedRestaurantClient
@@ -19,7 +20,7 @@ module LightspeedRestaurantClient
       @headers    = { 'Content-Type' => 'application/json', 'X-Auth-Token' => token }
       @body       = body.to_json
       @query      = query
-      @path       = '/PosServer' + path
+      @path       = "/PosServer#{path}"
       @connection = Excon.new(@base_uri)
       @logger = logger || begin
         require 'logger'
@@ -73,22 +74,22 @@ module LightspeedRestaurantClient
 
     def response_object_error(response)
       APIError.new("Invalid response object from API: #{JSON.parse(response.body)['description']}",
-        response.status, response.body, response.headers)
+                   response.status, response.body, response.headers)
     end
 
     def invalid_request_error(response)
       InvalidRequestError.new(JSON.parse(response.body)['description'],
-        response.status, response.body, response.headers)
+                              response.status, response.body, response.headers)
     end
 
     def authentication_error(response)
       AuthenticationError.new(JSON.parse(response.body)['description'],
-        response.status, response.body, response.headers)
+                              response.status, response.body, response.headers)
     end
 
     def rate_limit_error(response)
       RateLimitError.new(JSON.parse(response.body)['description'],
-        response.status, response.body, response.headers)
+                         response.status, response.body, response.headers)
     end
   end
 end

data/lib/lightspeed_restaurant/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LightspeedRestaurantClient
-  VERSION = '3.3.3'
+  VERSION = "3.5.0"
 end

data/lib/lightspeed_restaurant/webhook.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'lightspeed_restaurant/base'
+require 'lightspeed_restaurant/operations/list'
+require 'lightspeed_restaurant/operations/find'
+require 'lightspeed_restaurant/operations/create'
+require 'lightspeed_restaurant/operations/renew'
+
+module LightspeedRestaurantClient
+  class Webhook < LightspeedRestaurantClient::Base
+    extend Operations::Create
+    extend Operations::List
+    extend Operations::Find
+    extend Operations::Renew
+
+    def self.resource_name
+      'Webhooks'
+    end
+
+    def self.default_resource_path
+      "/rest/v1/#{resource_name.downcase}/subscriptions"
+    end
+  end
+end

data/lib/lightspeed_restaurant.rb

@@ -6,19 +6,21 @@
 require 'excon'
 require 'json'
 
-require 'lightspeed_restaurant/version'
-require 'lightspeed_restaurant/request'
+require 'lightspeed_restaurant/company'
 require 'lightspeed_restaurant/configuration'
-
-require 'lightspeed_restaurant/customer'
 require 'lightspeed_restaurant/customer_credit_change'
-require 'lightspeed_restaurant/customer_loyalty_card'
 require 'lightspeed_restaurant/customer_establishment_order'
-require 'lightspeed_restaurant/receipt'
-require 'lightspeed_restaurant/company'
+require 'lightspeed_restaurant/customer_loyalty_card'
+require 'lightspeed_restaurant/customer'
+require 'lightspeed_restaurant/external_payment_provider'
+require 'lightspeed_restaurant/inventory_product'
 require 'lightspeed_restaurant/payment_type'
-require 'lightspeed_restaurant/product_group'
 require 'lightspeed_restaurant/product_group_product'
+require 'lightspeed_restaurant/product_group'
+require 'lightspeed_restaurant/receipt'
+require 'lightspeed_restaurant/request'
+require 'lightspeed_restaurant/version'
+require 'lightspeed_restaurant/webhook'
 
 module LightspeedRestaurantClient
   class << self

data/lightspeed_restaurant.gemspec

@@ -22,8 +22,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency('excon', '~> 0.71.0')
-  spec.add_dependency('json', '~> 2.3')
+  spec.add_dependency('excon', '~> 0.91.0')
+  spec.add_dependency('json', '~> 2.6.1')
 
   spec.add_development_dependency('pry')
   spec.add_development_dependency('rake')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lightspeed_restaurant
 version: !ruby/object:Gem::Version
-  version: 3.3.3
+  version: 3.5.0
 platform: ruby
 authors:
 - Olivier Buffon, Laurent Cobos, Sybil Deboin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-08 00:00:00.000000000 Z
+date: 2024-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.71.0
+        version: 0.91.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.71.0
+        version: 0.91.0
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: 2.6.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: 2.6.1
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -173,10 +173,13 @@ files:
 - lib/lightspeed_restaurant/errors/not_found_error.rb
 - lib/lightspeed_restaurant/errors/rate_limit_error.rb
 - lib/lightspeed_restaurant/errors/unauthorized_error.rb
+- lib/lightspeed_restaurant/external_payment_provider.rb
+- lib/lightspeed_restaurant/inventory_product.rb
 - lib/lightspeed_restaurant/operations/create.rb
 - lib/lightspeed_restaurant/operations/destroy.rb
 - lib/lightspeed_restaurant/operations/find.rb
 - lib/lightspeed_restaurant/operations/list.rb
+- lib/lightspeed_restaurant/operations/renew.rb
 - lib/lightspeed_restaurant/operations/save.rb
 - lib/lightspeed_restaurant/operations/update.rb
 - lib/lightspeed_restaurant/payment_type.rb
@@ -185,7 +188,9 @@ files:
 - lib/lightspeed_restaurant/receipt.rb
 - lib/lightspeed_restaurant/request.rb
 - lib/lightspeed_restaurant/version.rb
+- lib/lightspeed_restaurant/webhook.rb
 - lightspeed_restaurant.gemspec
+- logo.png
 homepage: https://github.com/chronogolf/lightspeed_restaurant
 licenses:
 - MIT
@@ -205,7 +210,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Ruby bindings for the Lightspeed Restaurant API