roo_on_rails 1.6.0 → 1.7.0

data/lib/roo_on_rails/checks/papertrail/log_destination_exists.rb

@@ -0,0 +1,39 @@
+require 'roo_on_rails/checks/env_specific'
+require 'roo_on_rails/checks/papertrail/token'
+
+module RooOnRails
+  module Checks
+    module Papertrail
+      # Check for a configured log destination in Papertrail.
+      #
+      # Input context
+      # - papertrail.client: a connected Papertrail client
+      #
+      # Output context:
+      # - papertrail.dest.host, .port: the destination logging host
+      class LogDestinationExists < Base
+        requires Token
+
+        # The shared log destination
+        NAME = 'default'.freeze
+
+        def intro
+          "Checking for log destination #{bold NAME}..."
+        end
+
+        def call
+          data = context.papertrail.client.list_destinations.find { |h|
+            h['syslog']['description'] == NAME
+          }
+
+          fail! "Log destination #{bold NAME} not found" if data.nil?
+
+          context.papertrail!.dest!.host = data['syslog']['hostname']
+          context.papertrail!.dest!.port = data['syslog']['port']
+
+          pass "logging to #{context.papertrail.dest.host}:#{context.papertrail.dest.port}"
+        end
+      end
+    end
+  end
+end

data/lib/roo_on_rails/checks/papertrail/system_exists.rb

@@ -0,0 +1,78 @@
+require 'roo_on_rails/checks/env_specific'
+require 'roo_on_rails/checks/heroku/app_exists'
+require 'roo_on_rails/checks/heroku/token'
+require 'roo_on_rails/checks/papertrail/token'
+require 'roo_on_rails/checks/papertrail/drain_exists'
+
+module RooOnRails
+  module Checks
+    module Papertrail
+      # Checks that the app is declared in Papertrail
+      #
+      # Input context
+      # - heroku.api_client: a connected PlatformAPI client
+      # - heroku.app.{env}: an existing app name.
+      # - papertrail.system_name.{env}: a Papertrail system name / token
+      # - papertrail.client
+      # - papertrail.dest.host, .port
+      #
+      # Output context:
+      # - papertrail.system_id.{env}
+      class SystemExists < EnvSpecific
+        requires Heroku::AppExists
+        requires Heroku::Token
+        requires Token
+        requires DrainExists
+        requires LogDestinationExists
+
+        def intro
+          "Checking that #{bold app_name} is logging to Papertrail"
+        end
+
+        def call
+          data = context.papertrail.client.list_systems.find { |h|
+            h['hostname'] == system_token
+          }
+          fail! "no system with token '#{system_token}' found" if data.nil?
+
+          if data.syslog.hostname != context.papertrail.dest.host ||
+             data.syslog.port != context.papertrail.dest.port
+            final_fail! "system found, but is listening to #{data.syslog.hostname}:#{data.syslog.port} instead of #{context.papertrail.dest.host}:#{context.papertrail.dest.port}"
+          end
+
+          context.papertrail.system_id![env] = data.id
+          pass "found system #{data.id} for token #{system_token}"
+        end
+
+        def fix
+          # cause the app to log something
+          dyno = heroku.dyno.create(app_name, command: 'date')
+
+          # wait a bit
+          10.times do
+            begin
+              heroku.dyno.info(app_name, dyno['id'])
+              sleep 0.5
+            rescue Excon::Error::NotFound
+              break
+            end
+          end
+        end
+
+        private
+
+        def system_token
+          context.papertrail.system_name[env]
+        end
+
+        def app_name
+          context.heroku.app[env]
+        end
+
+        def heroku
+          context.heroku.api_client
+        end
+      end
+    end
+  end
+end

data/lib/roo_on_rails/checks/papertrail/system_named.rb

@@ -0,0 +1,55 @@
+require 'roo_on_rails/checks/env_specific'
+require 'roo_on_rails/checks/heroku/app_exists'
+require 'roo_on_rails/checks/papertrail/token'
+require 'roo_on_rails/checks/papertrail/system_exists'
+
+module RooOnRails
+  module Checks
+    module Papertrail
+      # Checks that the Papertrail system for an app in named like the app
+      #
+      # Input context
+      # - heroku.app.{env}
+      # - papertrail.system_id.{env}: a Papertrail system ID
+      # - papertrail.client
+      #
+      # Output context:
+      # - None
+      class SystemNamed < EnvSpecific
+        requires Heroku::AppExists
+        requires Token
+        requires SystemExists
+
+        def intro
+          "Checking that #{bold app_name} is named in Papertrail"
+        end
+
+        def call
+          data = context.papertrail.client.get_system(system_id)
+
+          fail! "wrong name for Papertrail system '#{system_id}' found" if data.name != app_name
+
+          pass "system #{system_id} named #{app_name}"
+        end
+
+        def fix
+          context.papertrail.client.update_system(name: app_name)
+        end
+
+        private
+
+        def system_id
+          context.papertrail.system_id[env]
+        end
+
+        def app_name
+          context.heroku.app[env]
+        end
+
+        def heroku
+          context.heroku.api_client
+        end
+      end
+    end
+  end
+end

data/lib/roo_on_rails/checks/papertrail/token.rb

@@ -0,0 +1,50 @@
+require 'roo_on_rails/checks/base'
+require 'roo_on_rails/checks/git/origin'
+require 'roo_on_rails/papertrail_client'
+require 'io/console'
+require 'shellwords'
+
+module RooOnRails
+  module Checks
+    module Papertrail
+      # Output context:
+      # - papertrail.client: a connected Papertrail client
+      class Token < Base
+        requires Git::Origin
+
+        def initialize(papertrail_client: nil, **options)
+          @papertrail_client = papertrail_client || PapertrailClient
+          super(**options)
+        end
+
+        def intro
+          'Obtaining Papertrail auth token...'
+        end
+
+        def call
+          status, token = shell.run 'git config papertrail.token'
+          fail! 'no Papertrail API token configured' if token.strip.empty? || !status
+          token.strip!
+
+          client = @papertrail_client.new(token: token)
+          begin
+            client.list_destinations
+          rescue Faraday::ClientError => e
+            fail! "connecting to Papertrail failed (#{e.message})"
+          end
+
+          pass "connected to Papertrail's API"
+          context.papertrail!.client = client
+        end
+
+        def fix
+          say 'Enter your Papertrail API token:'
+          say 'This can be found at https://papertrailapp.com/account/profile'
+          say '(the token will not be echoed on the terminal; paste and press enter)'
+          token = IO.console.getpass.strip
+          system "git config papertrail.token #{Shellwords.shellescape token}"
+        end
+      end
+    end
+  end
+end

data/lib/roo_on_rails/config.rb

@@ -8,6 +8,22 @@ module RooOnRails
         path = Pathname '.roo_on_rails.yml'
         path.exist? ? super(path) : new
       end
+
+      def sidekiq_enabled?
+        enabled? 'SIDEKIQ_ENABLED'
+      end
+
+      def google_auth_enabled?
+        enabled? 'GOOGLE_AUTH_ENABLED', default: false
+      end
+
+      private
+
+      ENABLED_PATTERN = /\A(YES|TRUE|ON|1)\Z/i
+
+      def enabled?(var, default: 'true')
+        ENABLED_PATTERN === ENV.fetch(var, default).to_s
+      end
     end
   end
 end

data/lib/roo_on_rails/default.env

@@ -1,3 +1,7 @@
+GOOGLE_AUTH_ENABLED=true
+GOOGLE_AUTH_CLIENT_ID=''
+GOOGLE_AUTH_CLIENT_SECRET=''
+GOOGLE_AUTH_ALLOWED_DOMAINS=''
 NEW_RELIC_LOG=stdout
 NEW_RELIC_AGENT_ENABLED=true
 NEW_RELIC_MONITOR_MODE=true

data/lib/roo_on_rails/papertrail_client.rb

@@ -0,0 +1,45 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'json'
+
+module RooOnRails
+  class PapertrailClient
+    def initialize(token:)
+      @token = token
+    end
+
+    def list_destinations
+      _conn.get('destinations.json').body
+    end
+
+    def list_systems
+      _conn.get('systems.json').body
+    end
+
+    def get_system(id)
+      _conn.get('systems/%s.json' % id).body
+    end
+
+    def update_system(id, data)
+      _conn.put('systems/%s.json' % id, system: data).body
+    end
+
+    # private
+
+    def _conn
+      @_conn ||= Faraday.new(_api_url, headers: { 'X-Papertrail-Token' => @token }) do |conf|
+        conf.response :mashify
+        conf.response :json
+        conf.response :raise_error
+        # conf.response :logger
+        conf.request :json
+
+        conf.adapter Faraday.default_adapter
+      end
+    end
+
+    def _api_url
+      @_api_url = URI.parse('https://papertrailapp.com/api/v1')
+    end
+  end
+end

data/lib/roo_on_rails/rack/google_oauth.rb

@@ -0,0 +1,34 @@
+require 'rack'
+
+module RooOnRails
+  module Rack
+    class GoogleOauth
+      OAUTH_CALLBACK = '/auth/google_oauth2/callback'.freeze
+
+      def initialize(app, *args, &block)
+        @app = app
+        @args = args
+        @strategy = block
+      end
+
+      def call(env)
+        if is_oauth_callback?(env)
+          @strategy.call(env)
+        else
+          send_to_upstream(env)
+        end
+      end
+
+      private
+
+      def send_to_upstream(env)
+        @app.call(env)
+      end
+
+      def is_oauth_callback?(env)
+        request = ::Rack::Request.new(env)
+        request.fullpath.start_with?(OAUTH_CALLBACK)
+      end
+    end
+  end
+end

data/lib/roo_on_rails/railties/google_auth.rb

@@ -0,0 +1,36 @@
+require 'roo_on_rails/config'
+require 'omniauth'
+require 'omniauth-google-oauth2'
+require 'active_support/core_ext/object/blank'
+
+module RooOnRails
+  module Railties
+    class GoogleAuth < Rails::Railtie
+      initializer 'roo_on_rails.google_auth' do |app|
+        if RooOnRails::Config.google_auth_enabled?
+          $stderr.puts 'initializer roo_on_rails.google_auth'
+
+          google_oauth2_client_id = ENV.fetch('GOOGLE_AUTH_CLIENT_ID')
+          google_oauth2_client_secret = ENV.fetch('GOOGLE_AUTH_CLIENT_SECRET')
+
+          options = {
+            path_prefix: '/auth',
+            prompt: 'consent',
+          }
+
+          domain_list = ENV.fetch('GOOGLE_AUTH_ALLOWED_DOMAINS', '').split(',').reject(&:blank?)
+          options[:hd] = domain_list if domain_list.any?
+
+          app.config.middleware.use ::OmniAuth::Builder do
+            provider :google_oauth2,
+              google_oauth2_client_id,
+              google_oauth2_client_secret,
+              options
+          end
+        else
+          $stderr.puts 'skipping initializer roo_on_rails.google_auth'
+        end
+      end
+    end
+  end
+end

data/lib/roo_on_rails/railties/sidekiq.rb

@@ -1,4 +1,5 @@
 require 'sidekiq'
+require 'roo_on_rails/config'
 require 'roo_on_rails/statsd'
 require 'roo_on_rails/sidekiq/settings'
 require 'roo_on_rails/sidekiq/sla_metric'
@@ -8,11 +9,14 @@ module RooOnRails
     class Sidekiq < Rails::Railtie
       initializer 'roo_on_rails.sidekiq' do |app|
         require 'hirefire-resource'
-        $stderr.puts 'initializer roo_on_rails.sidekiq'
-        if ENV.fetch('SIDEKIQ_ENABLED', 'true').to_s =~ /\A(YES|TRUE|ON|1)\Z/i
+        
+        if RooOnRails::Config.sidekiq_enabled?
+          $stderr.puts 'initializer roo_on_rails.sidekiq'
           config_sidekiq
           config_sidekiq_metrics
           config_hirefire(app)
+        else
+          $stderr.puts 'skipping initializer roo_on_rails.sidekiq'
         end
       end
 

data/lib/roo_on_rails/version.rb

@@ -1,3 +1,3 @@
 module RooOnRails
-  VERSION = '1.6.0'.freeze
+  VERSION = '1.7.0'.freeze
 end

data/roo_on_rails.gemspec

@@ -32,6 +32,10 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'hirefire-resource'
   spec.add_runtime_dependency 'sidekiq'
   spec.add_runtime_dependency 'dogstatsd-ruby'
+  spec.add_runtime_dependency 'omniauth-google-oauth2'
+  spec.add_runtime_dependency 'faraday'
+  spec.add_runtime_dependency 'faraday_middleware'
+
   spec.add_development_dependency 'bundler', '~> 1.13'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
@@ -40,4 +44,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'memfs'
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'codecov'
+  spec.add_development_dependency 'rack-test'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roo_on_rails
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Julien Letessier
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-11 00:00:00.000000000 Z
+date: 2017-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv-rails
@@ -170,6 +170,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: omniauth-google-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -282,6 +324,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Scaffolding for building services
 email:
 - julien.letessier@gmail.com
@@ -308,6 +364,7 @@ files:
 - bin/console
 - bin/setup
 - exe/roo_on_rails
+- gemfiles/.bundle/config
 - gemfiles/rails_3.gemfile
 - gemfiles/rails_3.gemfile.lock
 - gemfiles/rails_4.gemfile
@@ -325,6 +382,8 @@ files:
 - lib/roo_on_rails/checks/git/origin.rb
 - lib/roo_on_rails/checks/github/branch_protection.rb
 - lib/roo_on_rails/checks/github/token.rb
+- lib/roo_on_rails/checks/google_oauth/_template.rb
+- lib/roo_on_rails/checks/google_oauth/initializer.rb
 - lib/roo_on_rails/checks/helpers.rb
 - lib/roo_on_rails/checks/heroku/app_exists.rb
 - lib/roo_on_rails/checks/heroku/drains_metrics.rb
@@ -334,6 +393,12 @@ files:
 - lib/roo_on_rails/checks/heroku/token.rb
 - lib/roo_on_rails/checks/heroku/toolbelt_installed.rb
 - lib/roo_on_rails/checks/heroku/toolbelt_working.rb
+- lib/roo_on_rails/checks/papertrail/all.rb
+- lib/roo_on_rails/checks/papertrail/drain_exists.rb
+- lib/roo_on_rails/checks/papertrail/log_destination_exists.rb
+- lib/roo_on_rails/checks/papertrail/system_exists.rb
+- lib/roo_on_rails/checks/papertrail/system_named.rb
+- lib/roo_on_rails/checks/papertrail/token.rb
 - lib/roo_on_rails/checks/sidekiq/settings.rb
 - lib/roo_on_rails/checks/sidekiq/sidekiq.rb
 - lib/roo_on_rails/config.rb
@@ -342,9 +407,12 @@ files:
 - lib/roo_on_rails/environment.rb
 - lib/roo_on_rails/harness.rb
 - lib/roo_on_rails/logfmt.rb
+- lib/roo_on_rails/papertrail_client.rb
+- lib/roo_on_rails/rack/google_oauth.rb
 - lib/roo_on_rails/rack/safe_timeouts.rb
 - lib/roo_on_rails/railtie.rb
 - lib/roo_on_rails/railties/database.rb
+- lib/roo_on_rails/railties/google_auth.rb
 - lib/roo_on_rails/railties/http.rb
 - lib/roo_on_rails/railties/new_relic.rb
 - lib/roo_on_rails/railties/rake_tasks.rb