lightspeed_restaurant 3.1.0 → 3.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83e2c9e1ba5994e82fea005d149d07846a9e7f41c7f2b74b3e45cd42d33f588a
-  data.tar.gz: f6b362e9068216fff247bcb6365bafa8dcd68ead0615cdaf1a8949ef81101c4b
+  metadata.gz: 340ce0c747aaa516dc5c4bbed52c1842c138ecc4d6777e953a41ae649b1a60b1
+  data.tar.gz: 975aedc38edeba28cde45a90d07833e6c34a58578444e948bb424b20dc0a68ca
 SHA512:
-  metadata.gz: aaf589b90f0612e6488a42baeedcb37a83dbbb740b626ec3bf81c03978158747fe96b42ad44af3b26c4e455364bd082a3780c3482963440dd2df10ab5879fcc5
-  data.tar.gz: e0945deffe64bca611cb82b2299b199cf6e4185c085a8a38911530f8975123c4730ff40279a4f512b21cbf3386555df911ee0ec645f42d9831922d621d1e7cc9
+  metadata.gz: d057e14d22367a2ee8882b8e1dc3d2b3baff505e68867e6747e3e53b37844742c490e1844c8094636681d039992de64f0f9bd7e82c447ee43be459c8a6b0478e
+  data.tar.gz: c7a1262ea1ef6fd00cc99be0815bcd9c84b45c4e2a62aef103f38c20c1d1b5153fb8cb8b721b8da6ce42d36add021fc38b8c15733f6e1bc5e3da44a6cfe45565

data/.github/workflows/ci.yml

@@ -0,0 +1,66 @@
+name: CI
+
+on: [push]
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [2.6]
+
+    steps:
+    - uses: actions/checkout@master
+
+    - name: Set up the Ruby version
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+
+    - name: Ruby gem cache
+      uses: actions/cache@v1
+      with:
+        path: vendor/bundle
+        key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-gems-
+
+    - name: Set up the environment
+      run: |
+        gem install bundler
+        bundle config path vendor/bundle
+        bundle install --jobs 4 --retry 3
+
+    - name: Runs tests
+      run: bundle exec rspec
+
+  rubocop:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [2.6]
+
+    steps:
+    - uses: actions/checkout@master
+
+    - name: Set up the Ruby version
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+
+    - name: Ruby gem cache
+      uses: actions/cache@v1
+      with:
+        path: vendor/bundle
+        key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-gems-
+
+    - name: Set up the environment
+      run: |
+        gem install bundler
+        bundle config path vendor/bundle
+        bundle install --jobs 4 --retry 3
+
+    - name: Runs Rubocop
+      run: bundle exec rubocop

data/.gitignore

@@ -9,3 +9,4 @@
 /tmp/
 /vendor/
 /.idea/
+.DS_Store

data/.rubocop.yml

@@ -1,7 +1,7 @@
 require: rubocop-rspec
 
-Metrics/LineLength:
-  Max: 120
+Layout/LineLength:
+  Max: 100
 
 Metrics/ParameterLists:
   Max: 6
@@ -21,7 +21,7 @@ Metrics/BlockLength:
   Exclude:
     - spec/**/*
 
-Lint/HandleExceptions:
+Lint/SuppressedException:
   Enabled: false
 
 RSpec/MultipleExpectations:
@@ -51,6 +51,3 @@ Style/PercentLiteralDelimiters:
 Metrics/ClassLength:
   Max: 200
   Severity: warning
-
-HttpPositionalArguments:
-  Enabled: false

data/.ruby-version

@@ -1 +1 @@
-ruby-2.6.2
+ruby-2.6.5

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+## 3.3.3 / 2021-04-08
+
+- Add `find` endpoint for the company 
+
+## 3.3.2 / 2020-03-20
+
+- Fix CVE-2020-10663 (Update JSON dependency to 2.3)
+
+## 3.3.1 / 2020-02-24
+
+- Introducing `RateLimitError` when status code is `429`
+
+## 3.2.0 / 2019-12-17
+
+- Fix CVE-2019-16779

data/README.md

@@ -1,7 +1,6 @@
 # Lightspeed Restaurant API Client
 
-[![Circle CI](https://circleci.com/gh/chronogolf/lightspeed_restaurant.svg?style=shield&circle-token=94ebc6c7495f5c0bbf9f6a89526395306f223b7e)](https://circleci.com/gh/chronogolf/lightspeed_restaurant)
-[![Dependency Status](https://gemnasium.com/chronogolf/lightspeed_restaurant.svg)](https://gemnasium.com/chronogolf/lightspeed_restaurant) [![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)
+[![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 is point of sale that helps bars, restaurants, and cafés deliver a better customer experience and run a more profitable business.

data/lib/lightspeed_restaurant/company.rb

@@ -5,6 +5,7 @@ require 'lightspeed_restaurant/operations/list'
 
 module LightspeedRestaurantClient
   class Company < LightspeedRestaurantClient::Base
+    extend Operations::Find
     extend Operations::List
 
     def self.resource_name

data/lib/lightspeed_restaurant/errors/rate_limit_error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module LightspeedRestaurantClient
+  class RateLimitError < LightspeedRestaurantClientError
+  end
+end

data/lib/lightspeed_restaurant/operations/create.rb

@@ -4,21 +4,22 @@ module LightspeedRestaurantClient
   module Operations
     module Create
       def create(attributes, configuration = nil)
-        response = LightspeedRestaurantClient.post(default_resource_path, attributes, {}, configuration)
-        payload = build_payload(attributes, response)
-        return new(payload) if is_a?(Class)
+        response = JSON.parse(LightspeedRestaurantClient.post(default_resource_path, attributes, {}, configuration))
+        response = handle_create_response(response, attributes)
+        return new(response) if is_a?(Class)
 
-        self.class.new(payload)
+        self.class.new(response)
       end
 
       private
 
-      def build_payload(attributes, response)
-        JSON.parse(response)
-      rescue JSON::ParserError => error
-        raise error if response.to_i.zero?
-
-        attributes.merge!(id: response.to_i)
+      def handle_create_response(response, attributes)
+        case response
+        when Numeric
+          attributes.merge(id: response)
+        else
+          response
+        end
       end
     end
   end

data/lib/lightspeed_restaurant/operations/list.rb

@@ -5,8 +5,8 @@ module LightspeedRestaurantClient
     module List
       def list(params = {}, configuration = nil)
         response = JSON.parse(LightspeedRestaurantClient.get(resource_path, params, configuration))
-        results = response.is_a?(Array) ? response : response['results']
-        instantiate(results)
+        response = handle_list_response(response)
+        instantiate(response)
       end
       alias all list
 
@@ -16,6 +16,15 @@ module LightspeedRestaurantClient
         respond_to?(:list_resource_path) ? list_resource_path : default_resource_path
       end
 
+      def handle_list_response(response)
+        case response
+        when Hash
+          response['results']
+        else
+          response
+        end
+      end
+
       def instantiate(records)
         records.map do |record|
           is_a?(Class) ? new(record) : self.class.new(record)

data/lib/lightspeed_restaurant/request.rb

@@ -5,12 +5,17 @@ require 'lightspeed_restaurant/errors/api_error'
 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 'uri'
 
 module LightspeedRestaurantClient
   class Request
+    STAGING_URL = 'http://staging-integration.posios.com'
+
+    attr_reader :base_uri, :path, :token, :body, :headers, :query, :logger, :connection
+
     def initialize(base_uri, path, token, body = {}, query = {}, logger = nil)
-      @base_uri   = base_uri || 'http://staging-integration.posios.com'
+      @base_uri   = base_uri || STAGING_URL
       @headers    = { 'Content-Type' => 'application/json', 'X-Auth-Token' => token }
       @body       = body.to_json
       @query      = query
@@ -24,7 +29,7 @@ module LightspeedRestaurantClient
 
     def perform(**args)
       log_request(args[:method])
-      response = @connection.request(args.merge(path: @path, headers: @headers, body: @body, query: @query))
+      response = connection.request(args.merge(path: path, headers: headers, body: body, query: query))
       if [200, 201].include?(response.status)
         response.body
       else
@@ -35,13 +40,13 @@ module LightspeedRestaurantClient
     private
 
     def log_request(http_method)
-      @logger.info('request') do
-        "#{http_method} #{@base_uri}#{@path} : #{@query} - #{@body}"
+      logger.info('request') do
+        "#{http_method} #{base_uri}#{path} : #{query} - #{body}"
       end
     end
 
     def handle_error(response)
-      @logger.error('response') { "Error : #{response.status} #{response.body}" }
+      logger.error('response') { "Error : #{response.status} #{response.body}" }
       case response.status
       when 400
         raise invalid_request_error(response)
@@ -51,6 +56,8 @@ module LightspeedRestaurantClient
         raise unauthorized_error(response)
       when 404
         raise not_found_error(response)
+      when 429
+        raise rate_limit_error(response)
       else
         raise response_object_error(response)
       end
@@ -66,17 +73,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)
     end
   end
 end

data/lib/lightspeed_restaurant/version.rb

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

data/lightspeed_restaurant.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['developers@chronogolf.com']
 
   spec.summary       = 'Ruby bindings for the Lightspeed Restaurant API'
-  spec.description   = 'Lightspeed Restaurant is point of sale that helps bars, restaurants, '\
+  spec.description   = 'Lightspeed Restaurant is a Point Of Sale that helps bars, restaurants, '\
                        'and cafés deliver a better customer experience and run a more profitable business. '\
                        'See https://www.lightspeedhq.com/products/restaurant/ for details'
   spec.homepage      = 'https://github.com/chronogolf/lightspeed_restaurant'
@@ -22,14 +22,12 @@ 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.62.0')
-  spec.add_dependency('json', '~> 1.8.3')
+  spec.add_dependency('excon', '~> 0.71.0')
+  spec.add_dependency('json', '~> 2.3')
 
-  spec.add_development_dependency('bundler-audit')
   spec.add_development_dependency('pry')
   spec.add_development_dependency('rake')
   spec.add_development_dependency('rspec')
-  spec.add_development_dependency('rspec_junit_formatter')
   spec.add_development_dependency('rubocop')
   spec.add_development_dependency('rubocop-rspec')
   spec.add_development_dependency('vcr')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lightspeed_restaurant
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.3.3
 platform: ruby
 authors:
 - Olivier Buffon, Laurent Cobos, Sybil Deboin
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-04-15 00:00:00.000000000 Z
+date: 2021-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -16,42 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.62.0
+        version: 0.71.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.62.0
+        version: 0.71.0
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.3
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.3
-- !ruby/object:Gem::Dependency
-  name: bundler-audit
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -94,20 +80,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec_junit_formatter
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -164,7 +136,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Lightspeed Restaurant is point of sale that helps bars, restaurants,
+description: Lightspeed Restaurant is a Point Of Sale that helps bars, restaurants,
   and cafés deliver a better customer experience and run a more profitable business.
   See https://www.lightspeedhq.com/products/restaurant/ for details
 email:
@@ -173,19 +145,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-gemset"
 - ".ruby-version"
-- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
-- circle.yml
 - lib/lightspeed_restaurant.rb
 - lib/lightspeed_restaurant/base.rb
 - lib/lightspeed_restaurant/company.rb
@@ -199,6 +171,7 @@ files:
 - lib/lightspeed_restaurant/errors/invalid_request_error.rb
 - lib/lightspeed_restaurant/errors/lightspeed_restaurant_error.rb
 - 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/operations/create.rb
 - lib/lightspeed_restaurant/operations/destroy.rb
@@ -217,7 +190,7 @@ homepage: https://github.com/chronogolf/lightspeed_restaurant
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -233,7 +206,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Ruby bindings for the Lightspeed Restaurant API
 test_files: []

data/.travis.yml

@@ -1,4 +0,0 @@
-language: ruby
-rvm:
-  - 2.6.2
-before_install: gem install bundler -v 2.0.1

data/circle.yml

@@ -1,10 +0,0 @@
-machine:
-  timezone:
-    America/New_York
-  environment:
-    RACK_ENV: test
-test:
-  override:
-    - bundle exec bundle-audit check --update
-    - bundle exec rubocop
-    - bundle exec rspec --format RspecJunitFormatter --out $CIRCLE_TEST_REPORTS/junit/rspec.xml --format progress