lightspeed_restaurant 1.1.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: aa8b609368b750f359883afec36d740604a012fa
-  data.tar.gz: eb514c7033c4e7770f2ce1f62be7dc645cf296c6
+SHA256:
+  metadata.gz: be21149b7c665bad2dfa1c2895724be5788114e80a49731a24565ea2462cb595
+  data.tar.gz: 545ab4f1484b34940b49c3243ba250b41c9be9c07382332611339e01d7f08e53
 SHA512:
-  metadata.gz: ee0076a606539411582588121df6ef017d863eccecc5336428448e485dace47700ca08005d7850a90975cfed2de1405fc75b2b8d984f0a78d3dc225dd2dd8d94
-  data.tar.gz: 68355cf483fc08fe3648cf473fbb56b9c152533b7d90116ff71e073237526e32314c2366d1ee3d1cdee1704f80b852a00f5c5c4dc51467c590c182529b9d4e0a
+  metadata.gz: eeec7eee4a78fc0405f80dace6126e05bdde90fb1c7b5a011d2c79cb34d6217c04246dbbc18e571384984a05de19f22628af467614b45db4da5a8a9aac49c6c0
+  data.tar.gz: e79a49317522eb218c5d2be6b1a519c66962e0f7a1aaccbe0ae06bb0bf70427b777c52bfc15eb2b58d242db9ac2c675b9cd1d51fb2e32b9909381950c6a9089c

data/.rubocop.yml

@@ -1,15 +1,56 @@
+require: rubocop-rspec
+
 Metrics/LineLength:
   Max: 120
 
+Metrics/ParameterLists:
+  Max: 6
+
 Metrics/MethodLength:
-  Max: 20
+  Max: 15
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+  SupportedStyles:
+    - single_quotes
+    - double_quotes
+  ConsistentQuotesInMultiline: false
 
 Metrics/BlockLength:
+  Severity: warning
   Exclude:
-    - 'spec/**/*'
+    - spec/**/*
+
+Lint/HandleExceptions:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Max: 3
+
+Security/YAMLLoad:
+  Enabled: false
 
 Style/Documentation:
-  Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
-    - 'lib/**/*'
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    default: ()
+    '%i': '[]'
+    '%I': '[]'
+    '%r': '{}'
+    '%w': '[]'
+    '%W': '[]'
+
+Metrics/ClassLength:
+  Max: 200
+  Severity: warning
+
+HttpPositionalArguments:
+  Enabled: false

data/.ruby-version

@@ -1 +1 @@
-2.2.8
+ruby-2.5.1

data/Gemfile

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 gemspec

data/README.md

@@ -74,6 +74,14 @@ customer = LightspeedRestaurantClient::Customer.find(123)
 customer.destroy
 ```
 
+### Logs
+
+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"
+```
+
 ## Contributing
 
 Pull requests are welcome on GitHub at https://github.com/chronogolf/lightspeed_restaurant.

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'lightspeed_restaurant'

data/lib/lightspeed_restaurant.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #   Lightspeed Restaurant Ruby Bindings
 #   API spec at http://stating-integration.posios.com/PosServer/swagger-ui.html
 
@@ -15,7 +17,7 @@ require 'lightspeed_restaurant/company'
 
 module LightspeedRestaurantClient
   class << self
-    attr_accessor :api_token, :base_uri
+    attr_accessor :api_token, :base_uri, :logger
 
     def get(path, body = {}, query = {})
       request(path, body, query).perform(method: :get)
@@ -36,7 +38,7 @@ module LightspeedRestaurantClient
     private
 
     def request(path, body, query)
-      Request.new(@base_uri, path, @api_token, body, query)
+      Request.new(@base_uri, path, @api_token, body, query, @logger)
     end
   end
 end

data/lib/lightspeed_restaurant/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module LightspeedRestaurantClient
   class Base
     def initialize(data = {})
@@ -16,8 +18,8 @@ module LightspeedRestaurantClient
 
     private
 
-    def convert_to_obj(h)
-      h.each do |key, value|
+    def convert_to_obj(hash)
+      hash.each do |key, value|
         self.class.send(:attr_accessor, key)
         instance_variable_set("@#{key}", value)
         convert_to_obj(value) if value.is_a? Hash

data/lib/lightspeed_restaurant/company.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'lightspeed_restaurant/base'
 require 'lightspeed_restaurant/operations/list'
 

data/lib/lightspeed_restaurant/customer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'lightspeed_restaurant/base'
 require 'lightspeed_restaurant/operations/list'
 require 'lightspeed_restaurant/operations/find'

data/lib/lightspeed_restaurant/customer_credit_change.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'lightspeed_restaurant/base'
 require 'lightspeed_restaurant/operations/list'
 require 'lightspeed_restaurant/operations/create'

data/lib/lightspeed_restaurant/customer_loyalty_card.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'lightspeed_restaurant/base'
 require 'lightspeed_restaurant/operations/create'
 require 'lightspeed_restaurant/operations/list'

data/lib/lightspeed_restaurant/errors/api_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module LightspeedRestaurantClient
   class APIError < LightspeedRestaurantClientError
   end

data/lib/lightspeed_restaurant/errors/authentication_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module LightspeedRestaurantClient
   class AuthenticationError < LightspeedRestaurantClientError
   end

data/lib/lightspeed_restaurant/errors/invalid_request_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module LightspeedRestaurantClient
   class InvalidRequestError < LightspeedRestaurantClientError
   end

data/lib/lightspeed_restaurant/errors/lightspeed_restaurant_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module LightspeedRestaurantClient
   class LightspeedRestaurantClientError < StandardError
     attr_reader :message

data/lib/lightspeed_restaurant/errors/not_found_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module LightspeedRestaurantClient
   class NotFoundError < LightspeedRestaurantClientError
   end

data/lib/lightspeed_restaurant/errors/unauthorized_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module LightspeedRestaurantClient
   class UnauthorizedError < LightspeedRestaurantClientError
   end

data/lib/lightspeed_restaurant/operations/create.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module LightspeedRestaurantClient
   module Operations
     module Create

data/lib/lightspeed_restaurant/operations/destroy.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module LightspeedRestaurantClient
   module Operations
     module Destroy

data/lib/lightspeed_restaurant/operations/find.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module LightspeedRestaurantClient
   module Operations
     module Find

data/lib/lightspeed_restaurant/operations/list.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module LightspeedRestaurantClient
   module Operations
     module List

data/lib/lightspeed_restaurant/operations/save.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module LightspeedRestaurantClient
   module Operations
     module Save

data/lib/lightspeed_restaurant/operations/update.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module LightspeedRestaurantClient
   module Operations
     module Update

data/lib/lightspeed_restaurant/receipt.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'lightspeed_restaurant/base'
 require 'lightspeed_restaurant/operations/list'
 

data/lib/lightspeed_restaurant/request.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'lightspeed_restaurant/errors/lightspeed_restaurant_error'
 require 'lightspeed_restaurant/errors/api_error'
 require 'lightspeed_restaurant/errors/authentication_error'
@@ -7,16 +9,21 @@ require 'uri'
 
 module LightspeedRestaurantClient
   class Request
-    def initialize(base_uri, path, token, body = {}, query = {})
-      @base_uri   = base_uri || 'http://stating-integration.posios.com'
+    def initialize(base_uri, path, token, body = {}, query = {}, logger = nil)
+      @base_uri   = base_uri || 'http://staging-integration.posios.com'
       @headers    = { 'Content-Type' => 'application/json', 'X-Auth-Token' => token }
       @body       = body.to_json
       @query      = query
       @path       = '/PosServer' + path
       @connection = Excon.new(@base_uri)
+      @logger = logger || begin
+        require 'logger'
+        ::Logger.new($stdout)
+      end
     end
 
     def perform(**args)
+      log_request(args[:method])
       response = @connection.request(args.merge(path: @path, headers: @headers, body: @body, query: @query))
       if [200, 201].include?(response.status)
         response.body
@@ -27,7 +34,14 @@ module LightspeedRestaurantClient
 
     private
 
+    def log_request(http_method)
+      @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}" }
       case response.status
       when 400
         raise invalid_request_error(response)

data/lib/lightspeed_restaurant/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module LightspeedRestaurantClient
-  VERSION = '1.1.2'.freeze
+  VERSION = '2.0.0'
 end

data/lightspeed_restaurant.gemspec

@@ -1,11 +1,13 @@
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'lightspeed_restaurant/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'lightspeed_restaurant'
   spec.version       = LightspeedRestaurantClient::VERSION
-  spec.authors       = ['Olivier Buffon']
+  spec.authors       = ['Olivier Buffon, Laurent Cobos, Sybil Deboin']
   spec.email         = ['olivier@chronogolf.ca']
 
   spec.summary       = 'Ruby bindings for the Lightspeed Restaurant API'
@@ -20,7 +22,7 @@ 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.45.4')
+  spec.add_dependency('excon', '~> 0.62.0')
   spec.add_dependency('json', '~> 1.8.3')
 
   spec.add_development_dependency('bundler-audit')
@@ -29,6 +31,7 @@ Gem::Specification.new do |spec|
   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')
   spec.add_development_dependency('webmock')
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lightspeed_restaurant
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 2.0.0
 platform: ruby
 authors:
-- Olivier Buffon
+- Olivier Buffon, Laurent Cobos, Sybil Deboin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-24 00:00:00.000000000 Z
+date: 2018-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.45.4
+        version: 0.62.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.45.4
+        version: 0.62.0
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  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: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -214,7 +228,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for the Lightspeed Restaurant API