Merge pull request #37 from RadiusNetworks/add-radius-spec-and-reviewdog

cupakromer · web-flow · commit 50355ce9f835 · 2018-07-23T17:28:54.000-04:00
Add radius-spec and reviewdog
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -0,0 +1,11 @@
+inherit_mode:
+  merge:
+    - AllowedNames
+    - Exclude
+    - IgnoredPatterns
+
+inherit_gem:
+  radius-spec: common_rubocop_rails.yml
+
+AllCops:
+  TargetRubyVersion: 2.2.3 # Until we can drop support
diff --git a/.travis.yml b/.travis.yml
@@ -5,7 +5,9 @@ sudo: false
 before_install:
   - gem update --system
   - gem install bundler
-script: bin/rake
+before_script:
+  - "bin/ci-code-review"
+script: bin/ci
 rvm:
   - 2.5.0
 env:
diff --git a/Gemfile b/Gemfile
@@ -17,3 +17,5 @@ gemspec
 
 rails_dependencies_gemfile = File.expand_path("../Gemfile-rails-dependencies", __FILE__)
 eval_gemfile rails_dependencies_gemfile
+
+gem 'radius-spec', require: false, group: %i[development test] if RUBY_VERSION.to_f >= 2.5
diff --git a/app/controllers/kracken/sessions_controller.rb b/app/controllers/kracken/sessions_controller.rb
@@ -2,6 +2,7 @@
 
 module Kracken
   class SessionsController < ActionController::Base
+    protect_from_forgery with: :exception
 
     def create
       @user = user_class.find_or_create_from_auth_hash(auth_hash)
diff --git a/bin/ci b/bin/ci
@@ -0,0 +1,33 @@
+#!/bin/bash
+
+# script/ci: Setup environment for CI to run tests. This is primarily
+#            designed to run on the continuous integration server.
+
+set -e
+cd "$(dirname "$0")/.."
+
+# setup environment
+export DEFAULT_HOST="https://account.radiusnetworks.com"
+export RAILS_ROOT="$(cd "$(dirname "$0")"/.. && pwd)"
+export RAILS_ENV="test"
+export RACK_ENV="test"
+export RACK_ROOT="$RAILS_ROOT"
+
+# Run the specs for the rails app
+echo " ---> Running tests"
+./bin/rspec --require rails_helper
+
+if [ "$TRAVIS_RUBY_VERSION" = "2.5.0" ]; then
+  # Script for running Rubocop
+  # A Ruby static code analyzer, based on the community Ruby style guide.
+  # http://rubocop.readthedocs.io
+  echo " ---> Running rubocop"
+  ./bin/rubocop --config .rubocop.yml --lint
+fi
+
+# Script for running Brakeman tests
+# Brakeman is a security scanner
+# https://github.com/presidentbeef/brakeman.
+echo " ---> Running breakman"
+gem install --no-rdoc --no-ri brakeman slim coffee-rails
+brakeman --run-all-checks --exit-on-warn --ignore-config config/brakeman.ignore .
diff --git a/bin/ci-code-review b/bin/ci-code-review
@@ -0,0 +1,36 @@
+#!/bin/bash
+
+# Requires REVIEWDOG_GITHUB_API_TOKEN to be set in the envionment. We use a
+# token from the admin account so that the comments look as if they come from
+# Radbot.
+
+# See:
+#   - https://docs.travis-ci.com/user/environment-variables/#Convenience-Variables
+#   - https://docs.travis-ci.com/user/environment-variables/#Default-Environment-Variables
+#   - https://docs.travis-ci.com/user/pull-requests/#Pull-Requests-and-Security-Restrictions
+if [[ "$TRAVIS_PULL_REQUEST" = "false" ]] || [[ "$TRAVIS_BRANCH" = "production" ]]; then
+  exit
+fi
+
+if ! [ "$TRAVIS_RUBY_VERSION" = "2.5.0" ]; then
+  exit
+fi
+
+set -e
+cd "$(dirname "$0")/.."
+
+REVIEWDOG_VERSION="0.9.9"
+
+if ! [ "$(./bin/reviewdog -version)" = "$REVIEWDOG_VERSION" ]; then
+  echo "Installing reviewdog version ${REVIEWDOG_VERSION}..."
+  curl -fsSL https://github.com/haya14busa/reviewdog/releases/download/$REVIEWDOG_VERSION/reviewdog_linux_amd64 \
+    -o ./bin/reviewdog
+  chmod +x ./bin/reviewdog
+fi
+
+echo Rubocop Version: $(./bin/rubocop --version)
+echo Review Dog Version: $(./bin/reviewdog -version)
+
+# Add `-diff="git diff master"` to reviewdog args when running locally
+./bin/rubocop --config .rubocop.yml --extra-details --display-style-guide --rails | \
+  ./bin/reviewdog -f=rubocop -reporter=github-pr-check
diff --git a/bin/rake b/bin/rake
@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 150) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")
diff --git a/bin/rspec b/bin/rspec
@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 150) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")
diff --git a/bin/rubocop b/bin/rubocop
@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rubocop", "rubocop")
diff --git a/kracken.gemspec b/kracken.gemspec
@@ -15,7 +15,9 @@ Gem::Specification.new do |s|
   s.summary     = 'Rails engine that consumes the Kracken'
   s.description = 'Rails engine for use with the Radius Networks Account Server.'
 
-  s.files = Dir['{app,config,db,lib}/**/*', 'MIT-LICENSE', 'Rakefile', 'README.md']
+  s.files = Dir['{app,exe,config,db,lib}/**/*', 'MIT-LICENSE', 'Rakefile', 'README.md']
+  s.bindir      = "exe"
+  s.executables = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
 
   s.add_dependency 'rails', [">= 4.0", "< 6.0"]
   s.add_dependency 'omniauth', '~> 1.0'
diff --git a/lib/kracken.rb b/lib/kracken.rb
@@ -17,7 +17,7 @@ module Kracken
   mattr_accessor :config
   @@config = Config.new
 
-  def self.setup(&block)
+  def self.setup
     yield @@config
   end
 end
diff --git a/lib/kracken/controllers/json_api_compatible.rb b/lib/kracken/controllers/json_api_compatible.rb
@@ -105,9 +105,8 @@ def negotiate_mime
           raise ::ActionController::UnknownFormat
         end
 
-      private
-
         ALLOWED_MEDIA_TYPES = [Mime[:json]].freeze
+        private_constant :ALLOWED_MEDIA_TYPES
       end
       include DataIntegrity
 
diff --git a/lib/kracken/controllers/token_authenticatable.rb b/lib/kracken/controllers/token_authenticatable.rb
@@ -25,7 +25,7 @@ def self.included(base)
       #
       # Modified from https://github.com/rails/rails/blob/60d0aec7/actionpack/lib/action_controller/metal/http_authentication.rb#L490-L499
       if Rails::VERSION::MAJOR >= 5
-        def request_http_token_authentication(realm = 'Application', message = nil)
+        def request_http_token_authentication(realm = 'Application', _message = nil)
           headers["WWW-Authenticate"] = %(Token realm="#{realm.gsub(/"/, "")}")
           raise TokenUnauthorized, "Invalid Credentials"
         end
@@ -115,7 +115,7 @@ def authenticate_user_with_token!
         authenticate_or_request_with_http_token(realm) { |token, _options|
           # Attempt to reduce ivar namespace conflicts with controllers
           @_auth_info = cache_valid_auth(token) {
-            if @current_user = Authenticator.user_with_token(token)
+            if (@current_user = Authenticator.user_with_token(token))
               { id: @current_user.id, team_ids: @current_user.team_ids }
             end
           }
diff --git a/lib/kracken/engine.rb b/lib/kracken/engine.rb
@@ -6,7 +6,7 @@ module Kracken
   class Engine < ::Rails::Engine
     isolate_namespace Kracken
 
-    initializer "kracken.omniauth" do |app|
+    initializer "kracken.omniauth" do |_app|
       Rails.application.config.middleware.use OmniAuth::Builder do
         provider :radius, Kracken.config.app_id, Kracken.config.app_secret
       end
diff --git a/lib/kracken/env.rb b/lib/kracken/env.rb
@@ -1,4 +1,3 @@
-
 # frozen_string_literal: true
 
 # If this gem is loaded via bundler before the rails initializer we need to
@@ -8,7 +7,8 @@
 begin
   require 'dotenv'
   Dotenv.load
-rescue LoadError
+rescue LoadError => e
+  raise unless e.message.include?('dotenv')
 end
 
 module Kracken
diff --git a/lib/kracken/json_api/public_exceptions.rb b/lib/kracken/json_api/public_exceptions.rb
@@ -61,7 +61,7 @@ def capture_error(env)
         end
 
         response
-      rescue Exception => exception
+      rescue Exception => exception # rubocop:disable Lint/RescueException
         wrapper = exception_wrapper(env, exception)
         log_error(env, wrapper)
         render_json_error(wrapper)
@@ -80,7 +80,7 @@ def exception_wrapper(env, exception)
       end
 
       if Rails.env.production?
-        def additional_details(error)
+        def additional_details(_error)
           {}
         end
       else
diff --git a/lib/omniauth/strategies/radius.rb b/lib/omniauth/strategies/radius.rb
@@ -5,7 +5,8 @@
 begin
   require 'dotenv'
   Dotenv.load
-rescue LoadError
+rescue LoadError => e
+  raise unless e.message.include?('dotenv')
 end
 
 module OmniAuth
@@ -26,17 +27,15 @@ def self.provider_url
 
       info do
         raw_info["info"].slice(
-          *%w{
-            first_name
-            last_name
-            email
-            uid
-            confirmed
-            teams
-            linked_accounts
-            admin
-            subscription_level
-          }
+          "first_name",
+          "last_name",
+          "email",
+          "uid",
+          "confirmed",
+          "teams",
+          "linked_accounts",
+          "admin",
+          "subscription_level",
         )
       end
 
diff --git a/spec/kracken/controllers/token_authenticatable_spec.rb b/spec/kracken/controllers/token_authenticatable_spec.rb
@@ -16,7 +16,7 @@ class TokenAuthController < BaseControllerDouble
            :current_user,
            :current_user_id
 
-    def authenticate_or_request_with_http_token(realm = nil)
+    def authenticate_or_request_with_http_token(_realm = nil)
       /\AToken token="(?<token>.*)"\z/ =~ request.env['HTTP_AUTHORIZATION']
       yield token if block_given?
     end
diff --git a/spec/requests/api_spec.rb b/spec/requests/api_spec.rb
@@ -14,11 +14,11 @@ def headers_with_token(token)
 
     # Temporary work around while we support versions of Rails before 4
     if Rails::VERSION::MAJOR >= 5
-      def request_resource(path, params: {}, headers: {})
+      def request_resource(_path, params: {}, headers: {})
         get api_index_path, params: params, headers: headers
       end
     else
-      def request_resource(path, params: {}, headers: {})
+      def request_resource(_path, params: {}, headers: {})
         get api_index_path, params, headers
       end
     end
