Integrate Linting (#8)

* Integrate rubocop in rake test + lint updates + is_webhook_authentic rename

* Updates

Author: Will Myers

.rubocop.yml

@@ -0,0 +1,17 @@
+Metrics/AbcSize:
+  Max: 40
+
+Metrics/MethodLength:
+  Max: 80
+
+Metrics/ClassLength:
+  Max: 200
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/PerceivedComplexity:
+  Max: 10
+
+Metrics/LineLength:
+  Max: 120

Gemfile

@@ -3,8 +3,9 @@ source 'https://rubygems.org'
 gemspec
 
 group :development do
+  gem 'addressable', '2.4.0'
   gem 'rake', '10.4.2'
+  gem 'rubocop', '0.41.2'
   gem 'test-unit', '3.1.5'
-  gem 'addressable', '2.4.0'
   gem 'webmock', '2.1.0'
 end

README.md

@@ -144,14 +144,14 @@ puts response
 
 Utils houses generic helpers useful in a Button Integration.
 
-### #is_webhook_authentic
+### #webhook_authentic?
 
 Used to verify that requests sent to a webhook endpoint are from Button and that their payload can be trusted. Returns `true` if a webhook request body matches the sent signature and `false` otherwise. See [Webhook Security](https://www.usebutton.com/developers/webhooks/#security) for more details.
 
 ```ruby
 require 'button'
 
-Button::Utils::is_webhook_authentic(
+Button::Utils::webhook_authentic?(
   ENV['WEBHOOK_SECRET'],
   request_body,
   request_headers.fetch('X-Button-Signature')
@@ -163,4 +163,5 @@ Button::Utils::is_webhook_authentic(
 * Building the gem: `gem build button.gemspec`
 * Installing locally: `gem install ./button-X.Y.Z.gem`
 * Installing development dependencies: `bundle install`
+* Running linter: `rake lint`
 * Running tests: `bundle exec rake`

Rakefile

@@ -1,7 +1,11 @@
 require 'rake/testtask'
+require 'rubocop/rake_task'
 
-task(default: [:test])
+task default: [:test]
+task test: [:unit, :lint]
 
-Rake::TestTask.new do |t|
+Rake::TestTask.new(:unit) do |t|
   t.pattern = './test/**/*_test.rb'
 end
+
+RuboCop::RakeTask.new(:lint)

bin/console

@@ -1,5 +1,8 @@
 #!/usr/bin/env ruby
 
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
 require 'irb'
 require "#{File.expand_path('../../lib', __FILE__)}/button.rb"
 

lib/button/client.rb

@@ -2,7 +2,7 @@
 require 'button/errors'
 
 NO_API_KEY_MESSAGE = 'Must provide a Button API key.  Find yours at '\
-  'https://app.usebutton.com/settings/organization'
+  'https://app.usebutton.com/settings/organization'.freeze
 
 module Button
   # Client is the top-level interface for the Button API.  It exposes one
@@ -29,7 +29,7 @@ def initialize(api_key, config = {})
     def merge_defaults(config)
       secure = config.fetch(:secure, true)
 
-      return {
+      {
         secure: secure,
         timeout: config.fetch(:timeout, nil),
         hostname: config.fetch(:hostname, 'api.usebutton.com'),

lib/button/resources/resource.rb

@@ -32,9 +32,8 @@ def initialize(api_key, config)
       @http = Net::HTTP.new(config[:hostname], config[:port])
       @http.use_ssl = config[:secure]
 
-      if not config[:timeout].nil?
-        @http.read_timeout = config[:timeout]
-      end
+      return if config[:timeout].nil?
+      @http.read_timeout = config[:timeout]
     end
 
     def timeout

lib/button/utils.rb

@@ -1,12 +1,14 @@
 require 'openssl'
 
 module Button
+  # Generally handy functions for various aspects of a Button integration
+  #
   module Utils
     # Used to verify that requests sent to a webhook endpoint are from Button
     # and that their payload can be trusted. Returns true if a webhook request
     # body matches the sent signature and false otherwise.
     #
-    def is_webhook_authentic(webhook_secret, request_body, sent_signature)
+    def webhook_authentic?(webhook_secret, request_body, sent_signature)
       computed_signature = OpenSSL::HMAC.hexdigest(
         OpenSSL::Digest.new('sha256'),
         webhook_secret,
@@ -16,6 +18,6 @@ def is_webhook_authentic(webhook_secret, request_body, sent_signature)
       sent_signature == computed_signature
     end
 
-    module_function :is_webhook_authentic
+    module_function :webhook_authentic?
   end
 end

test/button/client_test.rb

@@ -22,12 +22,13 @@ def test_exposes_orders
 
   def test_sets_default_config_parameters
     client = Button::Client.new('sk-XXX')
-    assert_equal(client.orders.config, {
+    assert_equal(
+      client.orders.config,
       hostname: 'api.usebutton.com',
       port: 443,
       secure: true,
       timeout: nil
-    })
+    )
   end
 
   def test_allows_config_overrides

test/button/resources/orders_test.rb

@@ -2,12 +2,13 @@
 
 class OrdersTest < Test::Unit::TestCase
   def setup
-    @orders = Button::Orders.new('sk-XXX', {
+    @orders = Button::Orders.new(
+      'sk-XXX',
       secure: true,
       timeout: nil,
       hostname: 'api.usebutton.com',
       port: 443
-    })
+    )
 
     @headers = {
       'Authorization' => 'Basic c2stWFhYOg==',