gecko-ruby 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb9de08507d0105e06a6d879856fa389834a6854e27947f24ed4ffd9fb84a64e
-  data.tar.gz: f869506161aa22431c4eed00e71b326678a45d612e4d15754bfaba831b954784
+  metadata.gz: b82efcf479bde2b049bfd09f55185e8c4c5fd29377ca35a8865dc2816c6cba0c
+  data.tar.gz: 838ba153b885dcbca0accf42143733b4e9d79478bcd1d26d57001c3cfda9f4ca
 SHA512:
-  metadata.gz: 2b6eef606da5df282eba8fa943a73a6460d3a5a51cbd824158a6b76bdcef7cc2d817124735839b4ca0af866df6cb1075d348016c626a700767bd7445c4b6733a
-  data.tar.gz: 901d13594b029897e6de3033fa0f153b7ba9d1f0654fa233f5ec5580b9499a0f33c29680a21d4e90a2af30902ba77db12c652f7b74bda58ef3629db0e19a08ad
+  metadata.gz: 607951bf8f6958c8b11814dcaa5c9f8d3d24517dcf0ae2f34e2b443358abdf1f27354a53f227baba505a1bfebae42891519b17cdadecde23c5fd696d0a9ff087
+  data.tar.gz: da203fe38e4d22f35de38d56217489338a5319de2f6cdd82fb8a67d9533a5f97969e2397010323f53598c19203c0e63b422211cf2b296d2db4ca67877ab9d7ee

data/CHANGELOG.md

@@ -1,6 +1,12 @@
+## 0.9.0 (2019-07-24)
+- Added an optional `ActiveSupport::LogSubscriber` class for easy logging,
+  can be enabled via `Gecko.enable_logging`.
+- Added an optional compatibility shim for the Liquid templating language, 
+  can be enabled via `Gecko.install_liquid_shim`.
+
 ## 0.8.0 (2019-07-01)
-- Add `discount_amount` attribute and `discounted_price` helper to `OrderLineItem`'s
-- Drop support for Ruby 2.3
+- Add `discount_amount` attribute and `discounted_price` helper to `OrderLineItem`'s.
+- Drop support for EOL Ruby 2.3 as well.
 
 ## 0.7.1 (2019-03-19)
 - Add `Gecko::Record::Note` model.
@@ -8,7 +14,7 @@
 
 ## 0.7.0 (2019-02-19)
 - Add new `country_code` attribute to Address model.
-- Stop testing on Ruby 2.1 and 2.2
+- Stop testing on Ruby 2.1 and 2.2.
 
 ## 0.6.0 (2018-11-13)
 - Add `Gecko::Record::Webhook` model.
@@ -26,51 +32,51 @@
 - Add minimum `oauth2` gem dependency
 
 ## 0.2.5 (2018-01-15)
-- Add `User#account_name`
+- Add `User#account_name`.
 
 ## 0.2.4 (2017-08-28)
-- Add `Company#tags`
+- Add `Company#tags`.
 
 ## 0.2.3 (2017-08-14)
-- Add support for API idempotency `@client.Record.save(idempotency_key: 'ABCDEF123456')`
-- Marked a couple of fields as readonly that weren't correctly marked so
+- Add support for API idempotency `@client.Record.save(idempotency_key: 'ABCDEF123456')`.
+- Marked a couple of fields as readonly that weren't correctly marked so.
 
 ## 0.2.2 (2016-06-06)
-- Add `@client.Record.peek_all` to return all items currently in identity map
+- Add `@client.Record.peek_all` to return all items currently in identity map.
 
 ## 0.2.1 (2016-06-06) (Yanked)
 ## 0.2.0 (2016-06-06)
-- Support `writeable_on :create` for attributes
-- Allow passing query parameters to `Adapter#count`
-- Add `@client.Record.first` and `@client.Record.forty_two` as helpers
-- Store the last API response at `@client.Record.last_response`
-- Make sure to set Content-Type to `application/json`
-- Clean up some deprecated fields leading up to API release (See [https://developer.tradegecko.com](https://developer.tradegecko.com) for up-to-date attribute list)
+- Support `writeable_on :create` for attributes.
+- Allow passing query parameters to `Adapter#count`.
+- Add `@client.Record.first` and `@client.Record.forty_two` as helpers.
+- Store the last API response at `@client.Record.last_response`.
+- Make sure to set Content-Type to `application/json`.
+- Clean up some deprecated fields leading up to API release (See [https://developer.tradegecko.com](https://developer.tradegecko.com) for up-to-date attribute list).
 
 ## 0.1.0 (2015-11-25)
-- Move default headers to the adapter base class to make it easier to merge them when overriding
-- Clean up old attributes
+- Move default headers to the adapter base class to make it easier to merge them when overriding.
+- Clean up old attributes.
 
 ## 0.0.10 (2015-10-21)
-- Add `first_name`/`last_name` to addresses
+- Add `first_name`/`last_name` to addresses.
 
 ## 0.0.9 (2015-10-02)
-- Add tags to order
+- Add tags to order.
 
 ## 0.0.8 (2015-09-10)
-- Fetch `VariantLocation#committed_stock` as committed
-- Make image uploading work
+- Fetch `VariantLocation#committed_stock` as committed.
+- Make image uploading work.
 
 ## 0.0.7 (2015-03-17)
-- Fix issue with `Order#tax_override`
-- Support sideloaded records without a hack
+- Fix issue with `Order#tax_override`.
+- Support sideloaded records without a hack.
 
 ## 0.0.6 (2015-03-17)
-- Add `Gecko::Record::PaymentTerm`
+- Add `Gecko::Record::PaymentTerm`.
 
 ## 0.0.5 (2015-03-04)
-- Add size to base adapter
-- Update serialization_helper to support serializing arrays correctly
+- Add `size` to base adapter.
+- Update serialization_helper to support serializing arrays correctly.
 
 ## 0.0.4 (2015-01-09)
 - Renamed gem so we can publish it on RubyGems.org

data/README.md

@@ -189,6 +189,9 @@ ActiveSupport::Notifications.subscribe('request.gecko') do |name, start, finish,
 end
 ```
 
+The gem comes with a default `LogSubscriber` that outputs API requests in an ActiveRecord style.
+This is disabled by default and can be included by calling `Gecko.enable_logging`.
+
 ## Checking API limits
 
 The Gecko gem stores a copy of the last API response per adapter.
@@ -204,6 +207,10 @@ client.Product.last_response.headers['X-Rate-Limit-Reset']
 #=> '1412079600'
 ```
 
+## Liquid Compatibility
+A compatibility shim for the Liquid templating language is distributed, but not loaded by default.
+This can be enabled via `Gecko.install_liquid_shim`
+
 ## TODO
 - Deleting records
 - Complete record collection

data/lib/gecko.rb

@@ -32,3 +32,13 @@ require 'gecko/record/purchase_order_line_item'
 require 'gecko/record/tax_type'
 require 'gecko/record/payment_term'
 require 'gecko/record/webhook'
+
+module Gecko
+  def self.enable_logging
+    require 'gecko/ext/log_subscriber'
+  end
+
+  def self.install_liquid_shim
+    require 'gecko/ext/liquid_compat'
+  end
+end

data/lib/gecko/ext/liquid_compat.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+# Including this file enhances every Gecko::Record object to support the Liquid::Drop API.
+#
+# @example
+#   template = Liquid::Template.parse("{{variant.sku}}")
+#   rendered = template.render('variant' => client.Variant.find(123))
+module Gecko
+  # Monkey-patches the base record class with a `to_liquid` method
+  module LiquidCompatibility
+    # The Liquid templating library automatically uses a `to_liquid` method if found.
+    def to_liquid
+      liquid_decorator.new(self)
+    end
+
+  private
+
+    # If you'd like to add custom behviour per-record-type,
+    # override this method and return a subclass.
+    #
+    # @example
+    #
+    #   module MyLiquidCompat
+    #     def liquid_decorator
+    #       "#{self.class.demodulized_name}Decorator".safe_constantize || BaseDecorator
+    #     end
+    #   end
+    #
+    #   Gecko::Record::Base.include(MyLiquidCompat)
+    def liquid_decorator
+      Gecko::BaseDecorator
+    end
+  end
+
+  Gecko::Record::Base.include(LiquidCompatibility)
+  Gecko::Helpers::CollectionProxy.delegate(:to_liquid, to: :@target)
+
+  class BaseDecorator < Liquid::Drop
+    def initialize(delegate)
+      raise 'Turtles all the way down' if delegate.is_a?(BaseDecorator)
+
+      @delegate = delegate
+    end
+
+    def method_missing(method_name, *args, &block)
+      if @delegate.respond_to?(method_name)
+        @delegate.public_send(method_name, *args, &block)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      @delegate.respond_to?(method_name) || super
+    end
+
+    ## Override Liquid::Drop#invoke_drop to also check method arity
+    def invoke_drop(method_or_key)
+      if self.invokable_methods.include?(method_or_key.to_s) && self.method_arity(method_or_key.to_sym) <= 0
+        self.public_send(method_or_key)
+      end
+    end
+
+    ## Override Liquid::Drop#invokable_methods to add extra checks
+    def invokable_methods
+      @invokable_methods ||= begin
+        blacklist = Gecko::Record::Base.public_instance_methods + Liquid::Drop.public_instance_methods
+        blacklist -= [:to_liquid, :id, :created_at, :updated_at]
+        whitelist = self.public_methods + @delegate.public_methods
+        available_methods = (whitelist - blacklist).map(&:to_s)
+        available_methods.reject! { |method_name| method_name.ends_with?("=") }
+        Set.new(available_methods)
+      end
+    end
+
+  protected
+
+    def method_arity(method_name)
+      if self.methods.include?(method_name)
+        self.method(method_name).arity
+      else
+        @delegate.method(method_name).arity
+      end
+    end
+
+    def client
+      @delegate.instance_variable_get(:@client)
+    end
+  end
+end

data/lib/gecko/ext/log_subscriber.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'request_store'
+
+# Requiring this file, or calling `Gecko.enable_logging` will hook into the provided
+# ActiveSupport::Notification hooks on requests and log ActiveRecord-style messages
+# on API requests.
+class GeckoLogSubscriber < ActiveSupport::LogSubscriber
+  ENV_KEY = :"gecko-logger"
+
+  def initialize
+    super
+    @odd = false
+  end
+
+  def request(event)
+    RequestStore.store[ENV_KEY] = []
+    payload = event.payload
+
+    request_path = payload[:request_path]
+
+    if payload[:params] && payload[:verb] == :get
+      request_path = request_path + "?" + payload[:params].to_param
+      RequestStore.store[ENV_KEY] << request_path
+    end
+
+    name  = "#{payload[:model_class]} Load (#{event.duration.round(1)}ms)"
+    query = "#{payload[:verb].to_s.upcase} /#{request_path}"
+
+    if odd?
+      name = color(name, CYAN, true)
+    else
+      name = color(name, MAGENTA, true)
+    end
+
+    query = color(query, nil, true)
+
+    debug("  #{name}  #{query}")
+  end
+
+  def odd?
+    @odd = !@odd
+  end
+end
+
+GeckoLogSubscriber.attach_to :gecko

data/lib/gecko/version.rb

@@ -1,3 +1,3 @@
 module Gecko
-  VERSION = '0.8.0'
+  VERSION = '0.9.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gecko-ruby
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Bradley Priest
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-01 00:00:00.000000000 Z
+date: 2019-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -214,6 +214,8 @@ files:
 - lib/gecko-ruby.rb
 - lib/gecko.rb
 - lib/gecko/client.rb
+- lib/gecko/ext/liquid_compat.rb
+- lib/gecko/ext/log_subscriber.rb
 - lib/gecko/helpers/association_helper.rb
 - lib/gecko/helpers/inspection_helper.rb
 - lib/gecko/helpers/record_helper.rb