Merge pull request #170 from bigcommerce/RUBY-17

RUBY-17: Add frozen_string_literal magic comment to all files

Author: splittingred

.rubocop.yml

@@ -33,9 +33,6 @@ Naming/VariableNumber:
 ########################################################################################################################
 # TO FIX
 ########################################################################################################################
-Style/FrozenStringLiteralComment:
-  Enabled: false
-
 Layout/EmptyLineAfterGuardClause:
   Enabled: false
 

CHANGELOG.md

@@ -1,10 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec
-
-group :development do
-  gem 'pry'
-  gem 'rspec'
-  gem 'rubocop'
-  gem 'simplecov'
-end

Gemfile

@@ -1,6 +1,8 @@
-require 'bundler/gem_tasks'
+# frozen_string_literal: true
 
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+
 RSpec::Core::RakeTask.new do |spec|
   spec.pattern = 'spec/**/*_spec.rb'
   spec.verbose = false

Rakefile

@@ -1,4 +1,4 @@
-# frozen_string_literal : true
+# frozen_string_literal: true
 
 $LOAD_PATH.unshift(File.expand_path('lib', __dir__))
 require 'bigcommerce/version'

bigcommerce.gemspec

@@ -1,14 +1,28 @@
+# frozen_string_literal: true
+
 module Bigcommerce
   class Config < Hashie::Mash
+    BC_API_ENDPOINT_ENV_KEY = 'BC_API_ENDPOINT'
     DEFAULTS = {
       base_url: 'https://api.bigcommerce.com'
     }.freeze
 
+    ##
+    # @return [String]
+    #
     def api_url
       return url if auth == 'legacy'
 
-      base = ENV['BC_API_ENDPOINT'].to_s.empty? ? DEFAULTS[:base_url] : ENV['BC_API_ENDPOINT']
-      "#{base}/stores/#{store_hash}/v2"
+      "#{base_url}/stores/#{store_hash}/v2"
+    end
+
+    private
+
+    ##
+    # @return [String]
+    #
+    def base_url
+      ENV[BC_API_ENDPOINT_ENV_KEY].to_s.empty? ? DEFAULTS[:base_url] : ENV[BC_API_ENDPOINT_ENV_KEY]
     end
   end
 end

lib/bigcommerce/config.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 module Bigcommerce
   module Connection
+    LEGACY_AUTH_MODE = 'legacy'
     HEADERS = {
       'accept' => 'application/json',
       'content-type' => 'application/json',
@@ -12,7 +15,7 @@ def self.build(config)
       Faraday.new(url: config.api_url, ssl: ssl_options) do |conn|
         conn.request :json
         conn.headers = HEADERS
-        if config.auth == 'legacy'
+        if config.auth == LEGACY_AUTH_MODE
           conn.use Faraday::Request::BasicAuthentication, config.username, config.api_key
         else
           conn.use Bigcommerce::Middleware::Auth, config

lib/bigcommerce/connection.rb

@@ -42,13 +42,15 @@ module HttpErrors
       509 => Bigcommerce::BandwidthLimitExceeded
     }.freeze
 
+    X_RETRY_AFTER_HEADER_KEY = 'x-retry-after'
+
     def throw_http_exception!(code, env)
       return unless ERRORS.key?(code)
 
       response_headers = Faraday::Utils::Headers.new(env.response_headers)
 
-      unless response_headers['x-retry-after'].nil?
-        response_headers[:retry_after] = response_headers['x-retry-after'].to_i
+      unless response_headers[X_RETRY_AFTER_HEADER_KEY].nil?
+        response_headers[:retry_after] = response_headers[X_RETRY_AFTER_HEADER_KEY].to_i
       end
 
       raise ERRORS[code].new(response_headers), env.body

lib/bigcommerce/exception.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bigcommerce/exception'
 
 module Bigcommerce

lib/bigcommerce/middleware/http_exception.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 
 module Bigcommerce