Merge pull request #171 from bigcommerce/RUBY-18

RUBY-18: Fix various Rubocop warnings and declare dotenv as a dev dependency

Author: splittingred

.rubocop.yml

@@ -33,24 +33,7 @@ Naming/VariableNumber:
 ########################################################################################################################
 # TO FIX
 ########################################################################################################################
-Layout/EmptyLineAfterGuardClause:
-  Enabled: false
-
-Lint/MissingSuper:
-  Enabled: false
-
-Performance/MethodObjectAsBlock:
-  Exclude:
-    - lib/bigcommerce.rb
-
-Lint/NonDeterministicRequireOrder:
-  Exclude:
-    - lib/bigcommerce.rb
 
 # we should deprecate Ruby < 2.7 support ASAP
 Gemspec/RequiredRubyVersion:
   Enabled: false
-
-Style/ExplicitBlockArgument:
-  Exclude:
-    - lib/bigcommerce.rb

CHANGELOG.md

@@ -1,6 +1,7 @@
 ## Next Release
 Your contribution here.
 
+* [#170](https://github.com/bigcommerce/bigcommerce-api-ruby/pull/170): Fix various Rubocop warnings and declare dotenv as a dev dependency - [@splittingred](https://github.com/splittingred)
 * [#169](https://github.com/bigcommerce/bigcommerce-api-ruby/pull/169): Add frozen_string_literal magic comment to all files - [@splittingred](https://github.com/splittingred)
 * [#168](https://github.com/bigcommerce/bigcommerce-api-ruby/pull/168): Move to CircleCI off of TravisCI - [@splittingred](https://github.com/splittingred)
 * [#168](https://github.com/bigcommerce/bigcommerce-api-ruby/pull/168): Explicitly declare development dependencies in gemspec - [@splittingred](https://github.com/splittingred)

bigcommerce.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'bundler'
   s.add_development_dependency 'bundler-audit', '~> 0.6'
+  s.add_development_dependency 'dotenv', '>= 2.0'
   s.add_development_dependency 'pry', '>= 0.12'
   s.add_development_dependency 'rake', '>= 12.0'
   s.add_development_dependency 'rspec', '~> 3.8'

bin/console

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'bigcommerce'
+require 'pry'
+Pry.start

lib/bigcommerce.rb

@@ -2,22 +2,28 @@
 
 require 'hashie'
 require 'faraday_middleware'
-require 'bigcommerce/version'
-require 'bigcommerce/config'
-require 'bigcommerce/connection'
-require 'bigcommerce/middleware/auth'
-require 'bigcommerce/middleware/http_exception'
-require 'bigcommerce/resources/resource'
+require_relative 'bigcommerce/version'
+require_relative 'bigcommerce/config'
+require_relative 'bigcommerce/connection'
+require_relative 'bigcommerce/path_builder'
+require_relative 'bigcommerce/middleware/auth'
+require_relative 'bigcommerce/middleware/http_exception'
+require_relative 'bigcommerce/resources/resource'
 
 module Bigcommerce
   resources = File.join(File.dirname(__FILE__), 'bigcommerce', 'resources', '**', '*.rb')
-  Dir.glob(resources, &method(:require))
+  Dir.glob(resources).sort.each { |r| require r }
 
   class << self
-    attr_reader :api, :config
+    # @!attribute [r] api
+    #   @return [::Faraday::Connection]
+    attr_reader :api
+    # @!attribute [r] config
+    #   @return [::Bigcommerce::Config]
+    attr_reader :config
 
-    def configure
-      @config = Bigcommerce::Config.new.tap { |h| yield(h) }
+    def configure(&block)
+      @config = Bigcommerce::Config.new.tap(&block)
       @api = Bigcommerce::Connection.build(@config)
     end
   end

lib/bigcommerce/exception.rb

@@ -6,6 +6,7 @@ class HttpError < StandardError
 
     def initialize(headers)
       @response_headers = headers
+      super()
     end
   end
 

lib/bigcommerce/middleware/auth.rb

@@ -3,14 +3,18 @@
 module Bigcommerce
   module Middleware
     class Auth < Faraday::Middleware
+      X_AUTH_CLIENT_HEADER = 'X-Auth-Client'
+      X_AUTH_TOKEN_HEADER = 'X-Auth-Token'
+
       def initialize(app, options = {})
         @app = app
         @options = options
+        super(app)
       end
 
       def call(env)
-        env[:request_headers]['X-Auth-Client'] = @options[:client_id]
-        env[:request_headers]['X-Auth-Token'] = @options[:access_token]
+        env[:request_headers][X_AUTH_CLIENT_HEADER] = @options[:client_id]
+        env[:request_headers][X_AUTH_TOKEN_HEADER] = @options[:access_token]
         @app.call env
       end
     end

lib/bigcommerce/path_builder.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Bigcommerce
+  class PathBuilder
+    # @!attribute [r] uri
+    #   @return [String] The URI of the path to build
+    attr_reader :uri
+
+    ##
+    # @param [String] uri
+    #
+    def initialize(uri)
+      @uri = uri
+    end
+
+    ##
+    # This takes the @uri and inserts the keys to form a path.
+    # To start we make sure that for nil/numeric values, we wrap those into an
+    # array. We then scan the string for %d and %s to find the number of times
+    # we possibly need to insert keys into the URI. Next, we check the size of
+    # the keys array, if the keys size is less than the number of possible keys
+    # in the URI, we will remove the trailing %d or %s, then remove the
+    # trailing /. We then pass the keys into the uri to form the path.
+    # ex. foo/%d/bar/%d => foo/1/bar/2
+    #
+    # @param [Array] keys
+    # @return [String]
+    #
+    def build(keys = [])
+      keys = [] if keys.nil?
+      keys = [keys] if keys.is_a? Numeric
+      ids = uri.scan('%d').count + uri.scan('%s').count
+      str = ids > keys.size ? uri.chomp('%d').chomp('%s').chomp('/') : uri
+      (str % keys).chomp('/')
+    end
+
+    ##
+    # @return [String]
+    #
+    def to_s
+      @uri
+    end
+  end
+end

lib/bigcommerce/request.rb

@@ -3,42 +3,15 @@
 require 'json'
 
 module Bigcommerce
-  class PathBuilder
-    attr_reader :uri
-
-    def initialize(uri)
-      @uri = uri
-    end
-
-    # This takes the @uri and inserts the keys to form a path.
-    # To start we make sure that for nil/numeric values, we wrap those into an
-    # array. We then scan the string for %d and %s to find the number of times
-    # we possibly need to insert keys into the URI. Next, we check the size of
-    # the keys array, if the keys size is less than the number of possible keys
-    # in the URI, we will remove the trailing %d or %s, then remove the
-    # trailing /. We then pass the keys into the uri to form the path.
-    # ex. foo/%d/bar/%d => foo/1/bar/2
-    def build(keys = [])
-      keys = [] if keys.nil?
-      keys = [keys] if keys.is_a? Numeric
-      ids = uri.scan('%d').count + uri.scan('%s').count
-      str = ids > keys.size ? uri.chomp('%d').chomp('%s').chomp('/') : uri
-      (str % keys).chomp('/')
-    end
-
-    def to_s
-      @uri
-    end
-  end
-
   class Request < Module
     def initialize(uri)
       @uri = uri
+      super()
     end
 
     def included(base)
       base.extend ClassMethods
-      path_builder = PathBuilder.new @uri
+      path_builder = ::Bigcommerce::PathBuilder.new(@uri)
       base.define_singleton_method :path do
         path_builder
       end
@@ -81,8 +54,13 @@ def build_response_object(response)
         end
       end
 
+      ##
+      # @return [Hash]
+      # @return [Array]
+      #
       def parse(json)
         return [] if json.empty?
+
         JSON.parse(json, symbolize_names: true)
       end
     end

lib/bigcommerce/resource_actions.rb

@@ -2,6 +2,8 @@
 
 module Bigcommerce
   class ResourceActions < Module
+    # @!attribute [r] options
+    #   @return [Hash] Options passed to this module
     attr_reader :options
 
     def initialize(options = {})
@@ -11,6 +13,7 @@ def initialize(options = {})
           mod.options
         end
       end
+      super()
     end
 
     def included(base)
@@ -28,6 +31,7 @@ def all(params = {})
 
       def find(resource_id, params = {})
         raise ArgumentError if resource_id.nil?
+
         get path.build(resource_id), params
       end
 
@@ -37,11 +41,13 @@ def create(params = {})
 
       def update(resource_id, params = {})
         raise ArgumentError if resource_id.nil?
+
         put path.build(resource_id), params
       end
 
       def destroy(resource_id, params = {})
         raise ArgumentError if resource_id.nil?
+
         delete path.build(resource_id), params
       end
 

lib/bigcommerce/subresource_actions.rb

@@ -13,31 +13,37 @@ def included(base)
     module ClassMethods
       def all(parent_id, params = {})
         raise ArgumentError if parent_id.nil?
+
         get path.build(parent_id), params
       end
 
       def find(parent_id, resource_id, params = {})
         raise ArgumentError if [parent_id, resource_id].any?(&:nil?)
+
         get path.build([parent_id, resource_id]), params
       end
 
       def create(parent_id, params = {})
         raise ArgumentError if parent_id.nil?
+
         post path.build(parent_id), params
       end
 
       def update(parent_id, resource_id, params = {})
         raise ArgumentError if [parent_id, resource_id].any?(&:nil?)
+
         put path.build([parent_id, resource_id]), params
       end
 
       def destroy(parent_id, resource_id, params = {})
         raise ArgumentError if [parent_id, resource_id].any?(&:nil?)
+
         delete path.build([parent_id, resource_id]), params
       end
 
       def destroy_all(parent_id, params = {})
         raise ArgumentError if parent_id.nil?
+
         delete path.build(parent_id), params
       end
     end