lightspeed_ruby 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1c8f09a2f9d45e65208c617efe27a6e7b3f4b23d
-  data.tar.gz: 2e728c4ff040d9bd4b69ab7dd4fa6bb81262c50e
+  metadata.gz: b9cee427c44e3a97df29a3fdaf4209bdfcc00daa
+  data.tar.gz: 742e83a6c3d50913075bbd939f02f843b5f89c19
 SHA512:
-  metadata.gz: c948b41df45a51f99b2a87b7db70ad899ffdac5789e079a199c82f379328dfaf572f0eae9e477dbfd8cd9719adebff5bfa964241f9702f3718d9163e5d1b34a1
-  data.tar.gz: 1595326fa3caeaadcb47b04d4433d1145442e4ccb45319eee072c290c44b7a073f5452ef26320cce9216c8d8ff77cb316982709b424b46529109a2d5480ad5b6
+  metadata.gz: dee56f0f7a79fa8d002591935debcdf19ed7a1c8dfa56da3aa10eeff7a3e9f6a8c64080172ad1fd82df8bf03a415e06b5acb4fdcbb980892a151241cd7c841c8
+  data.tar.gz: ecb8fc57d401871aff0bc76180921e9a29c0fe629c0c6b34c9e09487185f8a7f3a74d6009f95054c96eee7d7b5e7231af3829e5d63b3ea6ea06323de4f8bd4a6

data/lib/lightspeed/client.rb

@@ -1,3 +1,4 @@
+require "lightspeed/configuration"
 require "lightspeed/api/tokens"
 require "lightspeed/api/accounts"
 require "lightspeed/api/sales"
@@ -6,6 +7,14 @@ require "lightspeed/api/items"
 require "lightspeed/api/categories"
 
 module Lightspeed
+  def self.configuration
+    @_configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield configuration
+  end
+
   class Client
     API_BASE = "https://api.merchantos.com/API/"
 
@@ -15,25 +24,34 @@ module Lightspeed
       API::Tokens.new(client_id, client_secret, refresh_token)
     end
 
-    def initialize(access_token:, account_id:)
+    def initialize(access_token:, account_id:, configuration:)
       @access_token = access_token
       @account_id = account_id
+      @configuration = configuration
     end
 
     def get(url, params: {}, relations: [])
-      conn.get(url, params.merge(load_relations: "[#{relation_names(relations)}]"))
+      response = conn.get(url, params.merge(load_relations: "[#{relation_names(relations)}]"))
+      rate_limit_wait(response)
+      response
     end
 
     def post(url, body: {})
-      conn.post(url, body)
+      response = conn.post(url, body)
+      rate_limit_wait(response)
+      response
     end
 
     def delete(url)
-      conn.delete(url)
+      response = conn.delete(url)
+      rate_limit_wait(response)
+      response
     end
 
     def put(url, body: {})
-      conn.put(url, body)
+      response = conn.put(url, body)
+      rate_limit_wait(response)
+      response
     end
 
     def accounts; API::Accounts.new(self); end
@@ -44,6 +62,8 @@ module Lightspeed
 
     private
 
+    attr_reader :configuration
+
     def conn
       @conn ||= Faraday.new(API_BASE) do |f|
         f.authorization :Bearer, access_token if access_token
@@ -58,5 +78,19 @@ module Lightspeed
         "\"#{relation.to_s.camelize}\""
       end.join(",")
     end
+
+    def rate_limit_wait(response, points_expense: 10, points_threshold_percentage: 0.5)
+      return unless Lightspeed.configuration.rate_limit || configuration.rate_limit
+
+      bucket_level, bucket_limit = response.headers["x-ls-api-bucket-level"].split("/").map(&:to_f)
+      drip_level = response.headers["x-ls-api-drip-rate"].to_f
+      threshold = bucket_limit * points_threshold_percentage
+
+      return if bucket_level + points_expense <= threshold
+
+      points_over = bucket_level + points_expense - threshold
+      wait_for_points = points_over / drip_level
+      sleep(wait_for_points)
+    end
   end
 end

data/lib/lightspeed/configuration.rb

@@ -0,0 +1,9 @@
+module Lightspeed
+  class Configuration
+    attr_accessor :rate_limit
+
+    def initialize(rate_limit: nil)
+      @rate_limit = rate_limit || false
+    end
+  end
+end

data/lib/lightspeed/version.rb

@@ -1,3 +1,3 @@
 module Lightspeed
-  VERSION = "0.1.8"
+  VERSION = "0.1.9"
 end

data/lightspeed.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.14"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "webmock", "~> 3.1.1"
 
   spec.add_dependency "faraday", "~> 0.12"
   spec.add_dependency "faraday_middleware", "~> 0.11"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lightspeed_ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - Zamith
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-27 00:00:00.000000000 Z
+date: 2017-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.1
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -107,6 +121,7 @@ files:
 - lib/lightspeed/api/sales/sale_lines.rb
 - lib/lightspeed/api/tokens.rb
 - lib/lightspeed/client.rb
+- lib/lightspeed/configuration.rb
 - lib/lightspeed/errors/missing_refresh_token.rb
 - lib/lightspeed/version.rb
 - lightspeed.gemspec