roo_on_rails 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 213753be11bedb855c752ec49f3ad7eba9b65aaa
-  data.tar.gz: a6b32aa80c06c64a9ba661933043391d8d407c67
+  metadata.gz: b45d0f189c82243df2453d720547a7c7d7100e3b
+  data.tar.gz: cee0095e6548020f230d34d803c18ca98440f18c
 SHA512:
-  metadata.gz: 359431c5ef3b923886cb8a4f8042d017b8dc650b760da97a7fae2c269cbbcb6c6e1cc74857c8fbd3a504024ab54c19aae584631381e5b00e99be3b60590ac2ef
-  data.tar.gz: d9bd7a03a37b17e29c469ef89ef7ccbdf2ecfa46f8cf87dcd2361db45cb066c45a18188866811b661835459bdb552e6e3c9e63079ab36c285f32edfe6ace5378
+  metadata.gz: bdb535531b139b82612d8c77ac1088de2a1e132961a35866b3aa911ab0b2b5bd27a596f5f136625d5d0e887434ae9610f9de239b766b07a4362c0e88d6833950
+  data.tar.gz: 3de9f215afe327094c19a120cd7ba522b987cd4d04cd847ac1cfcf3ca66ada4cbab6cff74675f0e9619d50e715435b9cdaf58c6887ac3325b258fce24be175ae

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# v1.1.0 (2017-02-20)
+
+Features:
+
+- `roo_on_rails` command, with basic Heroku app checks
+
 # v1.0.1 (2017-01-20)
 
 Bug fixes:

data/Gemfile

@@ -2,3 +2,6 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in roo_on_rails.gemspec
 gemspec
+
+gem 'guard'
+gem 'guard-rspec'

data/Guardfile

@@ -0,0 +1,70 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w(erb haml slim))
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.call("routing/#{m[1]}_routing"),
+      rspec.spec.call("controllers/#{m[1]}_controller"),
+      rspec.spec.call("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  # watch(rails.spec_helper)     { rspec.spec_dir }
+  # watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  # watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  # watch(rails.view_dirs)     { |m| rspec.spec.call("features/#{m[1]}") }
+  # watch(rails.layouts)       { |m| rspec.spec.call("features/#{m[1]}") }
+
+  # Turnip features and steps
+  # watch(%r{^spec/acceptance/(.+)\.feature$})
+  # watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+  #   Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  # end
+end

data/README.md

@@ -20,14 +20,36 @@ Remove the following configuration files:
 
 - `newrelic.yml` or `config/newrelic.yml`
 
+Also remove any other gem-specific configuration from your repository.
+
 And then execute:
 
     $ bundle
 
 Then re-run your test suite to make sure everything is shipshape.
 
+## Usage
+
+Run the following from your app's top-level directory:
+
+```
+bundle exec roo_on_rails
+```
+
+This will run a series of checks of your application's setup, as descirbed
+below.
+
+
 ## Features
 
+### App validation
+
+Running the `roo_on_rails` script currently checks for:
+
+- compliant Heroku app naming;
+- presence of the Heroku preboot flag.
+
+
 ### New Relic configuration
 
 We enforce configuration of New Relic.

data/exe/roo_on_rails

@@ -1,3 +1,9 @@
 #!/usr/bin/env ruby
+require 'rubygems'
+require 'pry'
+require 'roo_on_rails/config'
+require 'roo_on_rails/harness'
 
-require "roo_on_rails"
+module RooOnRails
+  Harness.new(try_fix: true, context: Config.load).run
+end

data/lib/roo_on_rails/checks/base.rb

@@ -0,0 +1,93 @@
+require 'roo_on_rails/checks'
+require 'roo_on_rails/checks/helpers'
+require 'roo_on_rails/shell'
+require 'bundler'
+
+module RooOnRails
+  module Checks
+    class Base
+      include Helpers
+
+      # Add `dependencies` to the list of prerequisites for this check.
+      # If none are specified, return the list of dependencies.
+      def self.requires(*dependencies)
+        @requires ||= Set.new
+        dependencies.any? ? @requires.merge(dependencies) : @requires
+      end
+
+
+      def initialize(options = {})
+        @options = options.dup
+        @fix     = @options.delete(:fix) { false }
+        @context = @options.delete(:context) { Hashie::Mash.new }
+        @shell   = @options.delete(:shell) { Shell.new }
+      end
+
+      def run
+        resolve dependencies
+        say intro
+        call
+        true
+      rescue Failure => e
+        raise if e === FinalFailure
+        raise unless @fix
+        say "\t· attempting to fix", %i[yellow]
+        fix
+        say "\t· re-checking", %i[yellow]
+        call
+      end
+
+      protected
+
+      attr_reader :shell, :context, :options
+
+      # Returns prerequisite checks. Can be overriden.
+      def dependencies
+        self.class.requires.map { |k|
+          k.new(fix: @fix, context: @context, shell: @shell, **@options)
+        }
+      end
+
+      def intro
+        self.class.name
+      end
+
+      def call
+        fail! "this check wasn't implemented"
+      end
+
+      def fix
+        fail! "can't fix this on my own"
+      end
+
+      def pass(msg)
+        say "\t✔ #{msg}", :green
+      end
+
+      def fail!(msg)
+        say "\t✘ #{msg}", :red
+        raise Failure, msg
+      end
+
+      def final_fail!(msg)
+        say "\t✘ #{msg}", :red
+        raise FinalFailure, msg
+      end
+
+      # Return a unique signature for this check
+      def signature
+        [self.class.name]
+      end
+
+      private
+
+      # Run each dependency, then mark them as run.
+      def resolve(deps)
+        deps.each do |dep|
+          context.deps ||= {}
+          context.deps[dep.signature.join('/')] ||= dep.run
+        end
+      end
+    end
+  end
+end

data/lib/roo_on_rails/checks/env_specific.rb

@@ -0,0 +1,20 @@
+require 'roo_on_rails/checks/base'
+
+module RooOnRails
+  module Checks
+    # Base class for checks that are applicable per-environment.
+    # The `env` passed to the initializer becomes part of the check signature.
+    class EnvSpecific < Base
+      attr_reader :env
+
+      def initialize(**options)
+        super(options)
+        @env = @options[:env]
+      end
+      
+      def signature
+        super + [@env]
+      end
+    end
+  end
+end

data/lib/roo_on_rails/checks/environment.rb

@@ -0,0 +1,22 @@
+require 'roo_on_rails/checks/env_specific'
+require 'roo_on_rails/checks/heroku/app_exists'
+require 'roo_on_rails/checks/heroku/preboot_enabled'
+
+module RooOnRails
+  module Checks
+    class Environment < EnvSpecific
+      requires Heroku::PrebootEnabled
+
+      def call
+        # nothing to do
+      end
+
+      protected
+
+      def intro
+        "Validated #{bold @env} environment"
+      end
+    end
+  end
+end
+

data/lib/roo_on_rails/checks/git/origin.rb

@@ -0,0 +1,27 @@
+require 'roo_on_rails/checks/base'
+
+module RooOnRails
+  module Checks
+    module Git
+      class Origin < Base
+        # Output context:
+        # - git_org (string)
+        # - git_repo (string)
+        def intro
+          "Checking your Git origin remote..."
+        end
+
+        def call
+          status, url = shell.run "git config remote.origin.url"
+          fail! "Origin does not seem to be configured." unless status
+          
+          org, repo = url.strip.sub(%r{\.git$}, '').split(%r{[:/]}).last(2)
+          context.git_org  = org
+          context.git_repo = repo
+          pass "organisation #{bold org}, repository: #{bold repo}"
+        end
+      end
+    end
+  end
+end
+

data/lib/roo_on_rails/checks/helpers.rb

@@ -0,0 +1,27 @@
+require 'forwardable'
+require 'singleton'
+require 'thor'
+
+module RooOnRails
+  module Checks
+    module Helpers
+      class Receiver < Thor::Group
+        include Singleton
+        include Thor::Actions
+      end
+
+      def self.included(by)
+        by.class_eval do
+          extend Forwardable
+          delegate %i[say set_color] => :'RooOnRails::Checks::Helpers::Receiver.instance'
+        end
+      end
+
+      def bold(str)
+        "\e[1;4m#{str}\e[22;24m"
+      end
+    end
+  end
+end
+
+

data/lib/roo_on_rails/checks/heroku/app_exists.rb

@@ -0,0 +1,65 @@
+require 'roo_on_rails/checks/env_specific'
+require 'roo_on_rails/checks/git/origin'
+require 'roo_on_rails/checks/heroku/token'
+require 'active_support/core_ext/enumerable'
+
+module RooOnRails
+  module Checks
+    module Heroku
+      # Check if a corresponding app exists on Heroku (for a given environment)
+      # 
+      # Input context
+      # - git_repo: the name of the repository
+      # - heroku.api_client: a connected PlatformAPI client
+      # - app_name_stem (optional): a name override
+      #
+      # Output context:
+      # - heroku.app.{env}: an app name.
+      class AppExists < EnvSpecific
+        requires Git::Origin, Heroku::Token
+
+        def intro
+          "Checking if #{bold env} app exist..."
+        end
+
+        def call
+          all_apps = client.app.list.map { |a| a['name'] }
+          matches = all_apps.select { |a| candidates.include?(a) }
+
+          if matches.empty?
+            fail! "no apps with matching names detected"
+          end
+
+          if matches.many?
+            final_fail! "multiple matching apps detected: #{candidates.map { |c| bold c}.join(', ')}"
+          end
+
+          context.heroku.app![env] = matches.first
+          pass "found app #{bold matches.first}"
+        end
+
+        private
+
+        def name_stem
+          context.app_name_stem || context.git_repo.delete('.')
+        end
+
+        def candidates
+          [
+            ['deliveroo', 'roo', nil],
+            [name_stem],
+            [env],
+          ].tap { |a|
+            a.replace a.first.product(*a[1..-1])
+          }.map { |c|
+            c.compact.join('-')
+          }
+        end
+
+        def client
+          context.heroku.api_client
+        end
+      end
+    end
+  end
+end

data/lib/roo_on_rails/checks/heroku/login.rb

@@ -0,0 +1,30 @@
+require 'roo_on_rails/checks/base'
+require 'roo_on_rails/checks/heroku/toolbelt_working'
+
+module RooOnRails
+  module Checks
+    module Heroku
+      class Login < Base
+        requires ToolbeltWorking
+
+        def intro
+          "Checking if you're signed in to Heroku..."
+        end
+
+        def call
+          status, email = shell.run "heroku whoami"
+          if status
+            pass "logged in as #{bold email.strip}"
+          else
+            fail! "not logged in"
+          end
+        end
+
+        def fix
+          shell.run! "heroku auth:login --sso"
+        end
+      end
+    end
+  end
+end
+

data/lib/roo_on_rails/checks/heroku/preboot_enabled.rb

@@ -0,0 +1,43 @@
+require 'roo_on_rails/checks/env_specific'
+require 'roo_on_rails/checks/git/origin'
+require 'roo_on_rails/checks/heroku/app_exists'
+
+module RooOnRails
+  module Checks
+    module Heroku
+      # Input context
+      # - heroku.api_client: a connected PlatformAPI client
+      # - heroku.app.{env}: an existing app name.
+      class PrebootEnabled < EnvSpecific
+        requires Git::Origin, Heroku::AppExists
+        
+        def intro
+          "Checking preboot status on #{bold app_name}"
+        end
+
+        def call
+          status = client.app_feature.info(app_name, 'preboot')
+          if status['enabled']
+            pass 'preboot enabled'
+          else
+            fail! 'preboot disabled'
+          end
+        end
+
+        private
+
+        def fix
+          client.app_feature.update(app_name, 'preboot', enabled: true)
+        end
+
+        def app_name
+          context.heroku.app[env]
+        end
+
+        def client
+          context.heroku.api_client
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+require 'roo_on_rails/checks/base'
+require 'roo_on_rails/checks/heroku/login'
+require 'platform-api'
+
+module RooOnRails
+  module Checks
+    module Heroku
+      # Output context:
+      # - heroku.api_client: a connected PlatformAPI client
+      class Token < Base
+        requires Login
+
+        def intro
+          "Obtaining Heroku auth token..."
+        end
+
+        def call
+          status, token = shell.run "heroku auth:token"
+          fail! "could not get a token" unless status
+
+          context.heroku!.api_client = PlatformAPI.connect_oauth(token.strip)
+          pass "connected to Heroku's API"
+        end
+      end
+    end
+  end
+end

data/lib/roo_on_rails/checks/heroku/toolbelt_installed.rb

@@ -0,0 +1,23 @@
+require 'roo_on_rails/checks/base'
+
+module RooOnRails
+  module Checks
+    module Heroku
+      class ToolbeltInstalled < Base
+        def intro
+          "Checking if the Heroku Toolbelt is installed..."
+        end
+
+        def call
+          status, path = shell.run "which heroku"
+          if status
+            pass "found #{bold path.strip} binary"
+          else
+            fail! "'heroku' binary missing"
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/roo_on_rails/checks/heroku/toolbelt_working.rb

@@ -0,0 +1,24 @@
+require 'roo_on_rails/checks/base'
+require 'roo_on_rails/checks/heroku/toolbelt_installed'
+
+module RooOnRails
+  module Checks
+    module Heroku
+      class ToolbeltWorking < Base
+        requires ToolbeltInstalled
+
+        def intro
+          "Checking if the Heroku Toolbelt is working..."
+        end
+
+        def call
+          if shell.run? 'heroku status > /dev/null'
+            pass 'read heroku status'
+          else
+            fail! "could not run 'heroku status'"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/roo_on_rails/checks.rb

@@ -0,0 +1,7 @@
+module RooOnRails
+  module Checks
+    Failure = Class.new(StandardError)
+    FinalFailure = Class.new(Failure)
+  end
+end
+

data/lib/roo_on_rails/config.rb

@@ -0,0 +1,13 @@
+require 'hashie'
+require 'pathname'
+
+module RooOnRails
+  class Config < Hashie::Mash
+    class << self
+      def load
+        path = Pathname '.roo_on_rails.yml'
+        path.exist? ? super(path) : new
+      end
+    end
+  end
+end

data/lib/roo_on_rails/harness.rb

@@ -0,0 +1,28 @@
+require 'thor'
+require 'hashie'
+require 'roo_on_rails/checks/environment'
+
+module RooOnRails
+  class Harness
+    include Thor::Shell
+
+    def initialize(try_fix: false, context: nil)
+      @try_fix = try_fix
+      @context = context || Hashie::Mash.new
+    end
+
+    def run
+      [
+        Checks::Environment.new(env: 'staging',    fix: @try_fix, context: @context),
+        Checks::Environment.new(env: 'production', fix: @try_fix, context: @context),
+      ].each(&:run)
+      self
+    rescue Shell::CommandFailed
+      say 'A command failed to run, aborting', %i[bold red]
+      exit 2
+    rescue Checks::Failure
+      say 'A check failed, exiting', %i[bold red]
+      exit 1
+    end
+  end
+end

data/lib/roo_on_rails/shell.rb

@@ -0,0 +1,21 @@
+require 'bundler'
+require 'roo_on_rails/checks'
+
+module RooOnRails
+  class Shell
+    CommandFailed = Class.new(StandardError)
+
+    def run(cmd)
+      result = Bundler.with_clean_env { %x{#{cmd}} }
+      return [$?.success?, result]
+    end
+
+    def run!(cmd)
+      raise CommandFailed.new(cmd) unless run(cmd).first
+    end
+
+    def run?(cmd)
+      run(cmd).first
+    end
+  end
+end

data/lib/roo_on_rails/version.rb

@@ -1,3 +1,3 @@
 module RooOnRails
-  VERSION = '1.0.2'
+  VERSION = '1.1.0'
 end

data/lib/roo_on_rails.rb

@@ -1,7 +1,9 @@
 require 'roo_on_rails/version'
-require 'dotenv/rails-now'
 
 module RooOnRails
 end
 
-require 'roo_on_rails/railtie' if defined?(Rails)
+if defined?(Rails)
+  require 'dotenv/rails-now'
+  require 'roo_on_rails/railtie'
+end

data/roo_on_rails.gemspec

@@ -24,6 +24,8 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'dotenv-rails', '~> 2.1'
   spec.add_runtime_dependency 'newrelic_rpm', '~> 3.17'
   spec.add_runtime_dependency 'rails', '~> 5.0'
+  spec.add_runtime_dependency 'platform-api', '~> 0.8'
+  spec.add_runtime_dependency 'hashie', '~> 3.4'
 
   spec.add_development_dependency "bundler", "~> 1.13"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roo_on_rails
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Julien Letessier
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-09 00:00:00.000000000 Z
+date: 2017-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv-rails
@@ -52,6 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: platform-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -135,6 +163,7 @@ files:
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -142,8 +171,23 @@ files:
 - bin/setup
 - exe/roo_on_rails
 - lib/roo_on_rails.rb
+- lib/roo_on_rails/checks.rb
+- lib/roo_on_rails/checks/base.rb
+- lib/roo_on_rails/checks/env_specific.rb
+- lib/roo_on_rails/checks/environment.rb
+- lib/roo_on_rails/checks/git/origin.rb
+- lib/roo_on_rails/checks/helpers.rb
+- lib/roo_on_rails/checks/heroku/app_exists.rb
+- lib/roo_on_rails/checks/heroku/login.rb
+- lib/roo_on_rails/checks/heroku/preboot_enabled.rb
+- 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/config.rb
 - lib/roo_on_rails/default.env
+- lib/roo_on_rails/harness.rb
 - lib/roo_on_rails/railtie.rb
+- lib/roo_on_rails/shell.rb
 - lib/roo_on_rails/version.rb
 - roo_on_rails.gemspec
 homepage: https://github.com/deliveroo/roo_on_rails