gecko-ruby 0.9.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9a15bbf88b9aebbbc1e5a7c0724657f445db9da7182986efa59340a158ab476
-  data.tar.gz: 3528a3d9d2478ec1bece4ee9ca13cd195a3a7ae19535456379c27cc10c79674a
+  metadata.gz: 0eb1c65172dc30ba079cc816764f1329d5a2bf1f8835b425b9aebcaee117230f
+  data.tar.gz: c2003acbfe9bc3c7c80497610ae7e4193937d52e7a2e9671f5d9bd38309e8208
 SHA512:
-  metadata.gz: 6c2e0c53ae78878be8c6ed89fc0ae48286bc0242332b0b914f6a0c8696314f1544dca0213305683a8d4966f42832d0e710d91ef8ce48bb10919c0fb3724ef5c9
-  data.tar.gz: a80856cebaf487f55918709bd2c8bda50aa5c49e24fd6a213b42a1c95a9b3577341b2b7ed2965a2c674ebe19ec5846bea7bb1da6d16610356bede2a98fffc3fe
+  metadata.gz: 5e43314e5da9020c7b7440585205aabd7e37342bd0a25a8c56025c6abf2416e347ed591a3293123c5d1934c929c90e64a14cfe6eaa0f902c188943276db1c9c2
+  data.tar.gz: 1c831c98c2b1cc0cdec7a9fe2ba6c1f70e942eef2b70c201892f124cceee21b2c0ff6d08ea4714119b40d2d0cc1b993258991f92998aac8f066c78924e8e7e9b

data/.github/config/rubocop_linter_action.yml

@@ -0,0 +1,7 @@
+---
+check_name: 'Rubocop Results'
+check_scope: 'modified'
+versions:
+  - rubocop
+  - rubocop-minitest
+  - rubocop-performance

data/.github/workflows/testing.yml

@@ -0,0 +1,26 @@
+---
+name: Ruby Tests
+
+'on': [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ['2.4', '2.5', '2.6', '2.7']
+    name: Ruby ${{ matrix.ruby }}
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Run Tests
+        run: |
+          gem install bundler --no-document
+          bundle install --jobs 4 --retry 3
+          bundle exec rake
+      - name: Rubocop
+        uses: andrewmcodes/rubocop-linter-action@v3.1.0
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

data/.rubocop.yml

@@ -1,5 +1,8 @@
 AllCops:
   DisplayCopNames: true
+  Exclude:
+    - 'bin/*'
+    - 'generate.thor'
 
 # class Example
 # ...
@@ -9,33 +12,34 @@ AllCops:
 Layout/AccessModifierIndentation:
   EnforcedStyle: outdent
 
-Style/Blocks:
-  Enabled: false
-
-# Allows foo(bar: baz)
-Style/BracesAroundHashParameters:
-  Enabled: false
-
 Layout/DotPosition:
   EnforcedStyle: leading
 
-Layout/IndentHash:
+Layout/FirstHashElementIndentation:
   EnforcedStyle: consistent
 
-Metrics/LineLength:
+Layout/LineLength:
   Max: 120
 
-Style/RedundantSelf:
-  Enabled: false
+Layout/HashAlignment:
+  EnforcedColonStyle: table
 
-# We like neatly-aligned code
-Layout/SpaceBeforeFirstArg:
+Metrics/AbcSize:
+  Exclude:
+    - 'test/**/*.rb'
+
+Naming/FileName:
+  Exclude:
+    - 'lib/gecko-ruby.rb'
+
+Naming/PredicateName:
   Enabled: false
 
-Layout/SpaceAroundEqualsInParameterDefault:
+Naming/AccessorMethodName:
   Enabled: false
 
-Layout/SpaceInsideHashLiteralBraces:
+# We like neatly-aligned code
+Layout/SpaceBeforeFirstArg:
   Enabled: false
 
 # Allow single or double quotes
@@ -63,7 +67,10 @@ Layout/MultilineOperationIndentation:
   Enabled: false
 
 Style/ClassAndModuleChildren:
-  EnforcedStyle: compact
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
 
 Style/DoubleNegation:
   Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.10.0 (2020-0406)
+- Add extra delegated attributes to invoice record
+- [BREAKING] Update Image record to latest API with product and multiple variant support
+
 ## 0.9.1 (2019-07-29)
 - Fix issue with LiquidCompat that broke during refactor
 

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in gecko.gemspec

data/README.md

@@ -1,4 +1,4 @@
-# TradeGecko RubyGem [![Build Status](https://travis-ci.org/tradegecko/gecko.png)](https://travis-ci.org/tradegecko/gecko) [![Code Climate](https://codeclimate.com/github/tradegecko/gecko.png)](https://codeclimate.com/github/tradegecko/gecko)
+# TradeGecko RubyGem ![Build Status](https://github.com/tradegecko/gecko/workflows/Ruby%20Tests/badge.svg) [![Code Climate](https://codeclimate.com/github/tradegecko/gecko.png)](https://codeclimate.com/github/tradegecko/gecko)
 The official TradeGecko API RubyGem
 
 ## Introduction

data/Rakefile

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 
 require 'rake/testtask'
 
-task :default => [:test]
+task default: [:test]
 
 Rake::TestTask.new do |t|
   t.libs << 'test'

data/gecko-ruby.gemspec

@@ -1,5 +1,6 @@
-# coding: utf-8
-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 'gecko/version'
 
@@ -8,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.version = Gecko::VERSION
   spec.authors = ["Bradley Priest"]
   spec.email = ['bradley@tradegecko.com']
-  spec.description = %q{A Ruby interface to the TradeGecko API.}
+  spec.description = 'A Ruby interface to the TradeGecko API.'
   spec.summary = spec.description
   spec.homepage = 'https://github.com/tradegecko/gecko/'
   spec.license = 'MIT'
@@ -19,17 +20,17 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency "dotenv"
   spec.add_development_dependency "minitest"
-  spec.add_development_dependency "vcr"
-  spec.add_development_dependency "webmock"
   spec.add_development_dependency "mocha"
-  spec.add_development_dependency "timecop"
-  spec.add_development_dependency "dotenv"
-  spec.add_development_dependency "thor"
   spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "thor"
+  spec.add_development_dependency "timecop"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
 
+  spec.add_dependency "activesupport"
   spec.add_dependency "oauth2", "> 1.1.0"
   spec.add_dependency "virtus"
-  spec.add_dependency "activesupport"
 end

data/generate.thor

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/inflector'
 class Generate < Thor
   include Thor::Actions
@@ -7,7 +9,7 @@ class Generate < Thor
     @model_name = model_name
     @file_name  = model_name.underscore
     @plural     = ask "What is the underscore plural of #{@model_name}? (#{@file_name}s):"
-    @plural     = @plural.to_s.length > 0 ? @plural : @file_name + "s"
+    @plural     = !@plural.to_s.empty? ? @plural : @file_name + "s"
     create_file "lib/gecko/record/#{@file_name}.rb", model_template
     create_file "test/record/#{@file_name}_adapter_test.rb", test_adapter_template
     create_file "test/record/#{@file_name}_test.rb", test_template
@@ -16,6 +18,7 @@ class Generate < Thor
   end
 
 private
+
   def default_plural?
     @plural == @file_name + "s"
   end

data/lib/gecko-ruby.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require 'gecko'

data/lib/gecko.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'virtus'
 require 'active_support/inflector'
 require 'active_support/notifications'

data/lib/gecko/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'faraday'
 require 'oauth2/version'
 require 'gecko/version'
@@ -57,7 +59,7 @@ module Gecko
     # @return [undefined]
     #
     # @api private
-    def initialize(client_id, client_secret, options={})
+    def initialize(client_id, client_secret, options = {})
       setup_oauth_client(client_id, client_secret, options)
     end
 
@@ -107,29 +109,29 @@ module Gecko
     #
     # @api private
     def adapter_for(klass_name)
-      self.public_send(klass_name.to_sym)
+      public_send(klass_name.to_sym)
+    end
+
+    def self.default_headers
+      {
+        'User-Agent' => ["Gecko/#{Gecko::VERSION}",
+                         "OAuth2/#{OAuth2::Version}",
+                         "Faraday/#{Faraday::VERSION}",
+                         "Ruby/#{RUBY_VERSION}"].join(' ')
+      }
     end
 
   private
 
     def setup_oauth_client(client_id, client_secret, options)
       defaults = {
-        site:          'https://api.tradegecko.com',
-        authorize_url: 'https://go.tradegecko.com/oauth/authorize',
+        site:            'https://api.tradegecko.com',
+        authorize_url:   'https://go.tradegecko.com/oauth/authorize',
         connection_opts: {
-          headers:     self.class.default_headers
+          headers: self.class.default_headers
         }
       }
       @oauth_client = OAuth2::Client.new(client_id, client_secret, defaults.merge(options))
     end
-
-    def self.default_headers
-      {
-        'User-Agent' => ["Gecko/#{Gecko::VERSION}",
-                         "OAuth2/#{OAuth2::Version.to_s}",
-                         "Faraday/#{Faraday::VERSION}",
-                         "Ruby/#{RUBY_VERSION}"].join(' ')
-      }
-    end
   end
 end

data/lib/gecko/ext/liquid_compat.rb

@@ -56,20 +56,20 @@ module Gecko
 
     ## 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
+      return unless invokable_methods.include?(method_or_key.to_s) && method_arity(method_or_key.to_sym) <= 0
+
+      public_send(method_or_key)
     end
 
-    alias_method :[], :invoke_drop
+    alias [] invoke_drop
 
     ## 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)
+        denylist = Gecko::Record::Base.public_instance_methods + Liquid::Drop.public_instance_methods
+        denylist -= %i[to_liquid id created_at updated_at]
+        allowlist = public_methods + @delegate.public_methods
+        available_methods = (allowlist - denylist).map(&:to_s)
         available_methods.reject! { |method_name| method_name.ends_with?("=") }
         Set.new(available_methods)
       end
@@ -78,8 +78,8 @@ module Gecko
   protected
 
     def method_arity(method_name)
-      if self.methods.include?(method_name)
-        self.method(method_name).arity
+      if methods.include?(method_name)
+        method(method_name).arity
       else
         @delegate.method(method_name).arity
       end

data/lib/gecko/ext/log_subscriber.rb

@@ -13,7 +13,7 @@ class GeckoLogSubscriber < ActiveSupport::LogSubscriber
     @odd = false
   end
 
-  def request(event)
+  def request(event) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
     RequestStore.store[ENV_KEY] = []
     payload = event.payload
 
@@ -27,11 +27,11 @@ class GeckoLogSubscriber < ActiveSupport::LogSubscriber
     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
+    name = if odd?
+             color(name, CYAN, true)
+           else
+             color(name, MAGENTA, true)
+           end
 
     query = color(query, nil, true)
 

data/lib/gecko/helpers/association_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gecko
   module Helpers
     # Helper for has_many/belongs_to relationships
@@ -24,7 +26,7 @@ module Gecko
         # @return [undefined]
         #
         # @api public
-        def belongs_to(model_name, options={})
+        def belongs_to(model_name, options = {})
           class_name  = options[:class_name] || model_name.to_s.classify
           foreign_key = model_name.to_s.foreign_key.to_sym
 
@@ -55,20 +57,20 @@ module Gecko
         # @return [undefined]
         #
         # @api public
-        def has_many(association_name, options={})
+        def has_many(association_name, options = {}) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
           model_name = association_name.to_s.singularize
           class_name = options[:class_name] || model_name.classify
           foreign_key = model_name.foreign_key.pluralize.to_sym
           readonly    = options.key?(:readonly) ? options[:readonly] : true
 
-          define_method association_name do
+          define_method association_name do # rubocop:disable Metrics/MethodLength
             collection_proxies[association_name] ||= begin
-              ids = self.attributes[foreign_key]
-              if ids.any?
-                collection = @client.adapter_for(class_name).find_many(ids)
-              else
-                collection = []
-              end
+              ids = attributes[foreign_key]
+              collection = if ids.any?
+                             @client.adapter_for(class_name).find_many(ids)
+                           else
+                             []
+                           end
 
               build_collection_proxy(collection, {
                 embedded:         options[:embedded],

data/lib/gecko/helpers/inspection_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gecko
   module Helpers
     # Helper for providing custom #inspect values to Records
@@ -39,9 +41,9 @@ module Gecko
         if value.is_a?(String) && value.length > 50
           "#{value[0..50]}...".inspect
         elsif value.is_a?(DateTime) || value.is_a?(Time)
-          %("#{value.strftime("%Y-%m-%d %H:%M:%S")}")
+          %("#{value.strftime('%Y-%m-%d %H:%M:%S')}")
         elsif value.is_a?(Date)
-          %("#{value.strftime("%Y-%m-%d")}")
+          %("#{value.strftime('%Y-%m-%d')}")
         else
           value.inspect
         end

data/lib/gecko/helpers/record_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gecko
   module Helpers
     # Helper for registering valid record types

data/lib/gecko/helpers/serialization_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gecko
   module Helpers
     # Provides serialization to records
@@ -28,6 +30,7 @@ module Gecko
         attribute_hash = {}
         attribute_set.each do |attribute|
           next unless writeable?(attribute)
+
           serialize_attribute(attribute_hash, attribute)
         end
 
@@ -46,6 +49,7 @@ module Gecko
       def writeable?(attribute)
         return if attribute.options[:readonly]
         return true unless attribute.options[:writeable_on]
+
         case attribute.options[:writeable_on]
         when :update
           persisted?
@@ -75,7 +79,7 @@ module Gecko
       # @return [String]
       #
       # @api private
-      def _serialize(serialized)
+      def _serialize(serialized) # rubocop:disable Metrics/MethodLength
         if serialized.respond_to?(:serializable_hash)
           serialized.serializable_hash
         else