lucid_shopify 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa7a124e765e51f59294a364b97b006e5898b96cf2613745c66ac35051ec46ab
-  data.tar.gz: deb41acf5b31b21a7eee70bf644b8daff3badf6e716653076df2760940545145
+  metadata.gz: f6f55b3ddbd880a63fa9b5afdd2d41ef31ba8a3e1d9cac38cda26c4247cac0f2
+  data.tar.gz: 40361daabb00f6bc9f8269cc97c06d68b748f2271d8d802f9eb763b89c3e9390
 SHA512:
-  metadata.gz: d86eb37763f25cdbc7fd686a9bd0fe31e5139db86d33a87a11cf27bd8ce05c7617f3b02a978a4f4194f67f6fad44f86ee299ad69e25cea2ca2843980a5761183
-  data.tar.gz: bfd6ace749c04766bd6270350fdcce7ac4593f0881c561091ce2b70fca3caeae25a78bc41efb0b7cf12b19033ccbbcd2cf834da8e99dd9d249fa356ed857b56d
+  metadata.gz: 11bb3dd84382f4d700ab0714d8b9c84c80222b2dac28870e68a26df97832a11c499d07c1a30f2c22b3c938b98893918cd7e5ee1f87fa83f7897a9019c27a6c15
+  data.tar.gz: bd289c3cdac7201be678821547363dadd135c16dd0b50696a248c326be68fba84f5432763e1a1dc375e52daa2d06feeae4a6759d2746b86d541e44fb5de42fda

data/README.md

@@ -129,6 +129,10 @@ charge:
     client.get(credentials, 'orders', since_id: since_id)['orders']
     client.post_json(credentials, 'orders', new_order)
 
+Request logging is disabled by default. To enable it:
+
+    LucidShopify.config.logger = Logger.new(STDOUT)
+
 
 ### Make throttled API requests
 

data/lib/lucid_shopify/config.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'forwardable'
+require 'logger'
 
 require 'lucid_shopify'
 
@@ -11,7 +12,7 @@ module LucidShopify
     extend Forwardable
 
     # TODO: *Config.dry_initializer.attributes (version 2.0.0+)
-    def_delegators :config, :api_key, :shared_secret, :scope, :billing_callback_uri, :webhook_uri
+    def_delegators :config, :api_key, :shared_secret, :scope, :billing_callback_uri, :webhook_uri, :logger
 
     # @param config [Config]
     attr_writer :config
@@ -43,5 +44,21 @@ module LucidShopify
     param :billing_callback_uri
     # @return [String]
     param :webhook_uri
+
+    #
+    # @return [Logger]
+    #
+    def logger
+      @logger ||= Logger.new(File::NULL)
+    end
+
+    #
+    # @param new_logger [Logger]
+    #
+    def logger=(new_logger)
+      raise ArgumentError, 'not a Logger' unless new_logger.is_a?(Logger)
+
+      @logger = new_logger
+    end
   end
 end

data/lib/lucid_shopify/request.rb

@@ -16,12 +16,12 @@ module LucidShopify
     # @return [String] the endpoint relative to the base URL
     param :path, reader: :private
     # @return [Hash]
-    param :options, default: proc { {} }
+    param :options, default: -> { {} }
 
     # @return [Hash]
-    param :http_headers, default: proc { build_headers }
+    param :http_headers, default: -> { build_headers }
     # @return [String]
-    param :url, default: proc { build_url }
+    param :url, default: -> { build_url }
 
     #
     # @return [String]

data/lib/lucid_shopify/response.rb

@@ -39,7 +39,7 @@ module LucidShopify
     # @return [String]
     param :data
     # @return [Hash] the parsed response body
-    param :data_hash, default: proc { parse_data }
+    param :data_hash, default: -> { parse_data }
 
     #
     # @return [Hash]

data/lib/lucid_shopify/send_request.rb

@@ -32,19 +32,25 @@ module LucidShopify
     # @raise [Response::ServerError] for status 5xx
     #
     def call(request, attempts: default_attempts)
-      res = @strategy.(request) do
-        res = send(request)
+      req = request
+
+      log_request(req)
+
+      res = @strategy.(req) do
+        res = send(req)
 
-        Response.new(request, res.code, res.headers.to_h, res.to_s)
+        Response.new(req, res.code, res.headers.to_h, res.to_s)
       end
 
+      log_response(req, res)
+
       res.assert!.data_hash
     rescue HTTP::ConnectionError,
            HTTP::ResponseError,
            HTTP::TimeoutError => e
       raise NetworkError.new(e), e.message if attempts.zero?
 
-      call(request, attempts: attempts - 1)
+      call(req, attempts: attempts - 1)
     end
 
     #
@@ -58,6 +64,36 @@ module LucidShopify
       @http.headers(req.http_headers).__send__(req.http_method, req.url, req.options)
     end
 
+    #
+    # @param request [Request]
+    #
+    def log_request(request)
+      req = request
+
+      LucidShopify.config.logger.info('<%s> [%i] %s %s %s' % [
+        self.class.to_s,
+        req.object_id,
+        req.http_method.to_s.upcase,
+        req.url,
+        req.options[:params]&.to_json || '{}'
+      ])
+    end
+
+    #
+    # @param request [Request]
+    # @param response [Response]
+    #
+    def log_response(request, response)
+      req = request
+      res = response
+
+      LucidShopify.config.logger.info('<%s> [%i] %i' % [
+        self.class.to_s,
+        req.object_id,
+        res.status_code
+      ])
+    end
+
     #
     # @return [Integer]
     #

data/lib/lucid_shopify/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LucidShopify
-  VERSION = '0.16.0'
+  VERSION = '0.17.0'
 end

data/lib/lucid_shopify/webhook.rb

@@ -15,7 +15,7 @@ module LucidShopify
     # @return [String]
     param :data
     # @return [Hash] the parsed request body
-    param :data_hash, default: proc { parse_data }
+    param :data_hash, default: -> { parse_data }
 
     #
     # @return [Hash]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lucid_shopify
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Kelsey Judson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-23 00:00:00.000000000 Z
+date: 2018-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv