handshake_service 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b0c53862aa69276500c0eac25fc64bc5108065a
-  data.tar.gz: aa31a03538a462fd7d917d25e8beca4ff779137e
+  metadata.gz: b6014221044bffc0d210e7aecf741aae989ab3f4
+  data.tar.gz: 4952eb9e23bd09eb0580c194a5d2300e5405b2e3
 SHA512:
-  metadata.gz: 736a7c34be6c55f67551d5463efe994c70a69de1ba40bd36aae5cf635b905d936d3fa1212cff7582541512b33f6cb8feb81fb07b00b19bff1164c232703258ee
-  data.tar.gz: 1d2b5048abd8a886f2a4d4955beebed6a936e068e24f6564bf7b1a010ef13c76fcf0dce0ca8b8ffeefba6776d5f71b44ae5b1e5cafe7c45dd81308a3821a5c2a
+  metadata.gz: 3b97a0224445c81ae9dbb49a28e408c34feea6b6b9b206ff74edc310049c34721f8541d7aee24909891daf5ef8a05384f08b88f3ab2f3e05a875dfb361957202
+  data.tar.gz: 4a107452724cdca291e87c1d51fdefad4636344a1188e4e112611ccc47265126dd7a3249a5bb5880d4f747e523aeddf03ab95812309250646158cc53bb8a6f9a

data/lib/handshake_service/version.rb

@@ -1,3 +1,3 @@
 module HandshakeService
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/tasks/auto_annotate_models.rake

@@ -0,0 +1,34 @@
+# NOTE: only doing this in development as some production environments (Heroku)
+# NOTE: are sensitive to local FS writes, and besides -- it's just not proper
+# NOTE: to have a dev-mode tool do its thing in production.
+if(Rails.env.development?)
+  task :set_annotation_options do
+    # You can override any of these by setting an environment variable of the
+    # same name.
+    Annotate.set_defaults({
+      'position_in_routes'   => "before",
+      'position_in_class'    => "before",
+      'position_in_test'     => "before",
+      'position_in_fixture'  => "before",
+      'position_in_factory'  => "before",
+      'show_indexes'         => "true",
+      'simple_indexes'       => "false",
+      'model_dir'            => "app/models",
+      'include_version'      => "false",
+      'require'              => "",
+      'exclude_tests'        => "false",
+      'exclude_fixtures'     => "false",
+      'exclude_factories'    => "false",
+      'ignore_model_sub_dir' => "false",
+      'skip_on_db_migrate'   => "false",
+      'format_bare'          => "true",
+      'format_rdoc'          => "false",
+      'format_markdown'      => "false",
+      'sort'                 => "false",
+      'force'                => "false",
+      'trace'                => "false",
+    })
+  end
+
+  Annotate.load_tasks
+end

data/lib/tasks/deploy.rake

@@ -0,0 +1,327 @@
+require 'librato/metrics'
+
+# A collection of rake tasks to deploy applications to heroku. At the basic level, all that needs to be called
+# in most cases is
+#
+# foreman run rake deploy:staging
+#
+# The foreman gem is used to include .env ENV variables, but if you have those defined elsewhere it can be excluded.
+# Before deploying define the STAGING_APP_NAME ENV variables, etc.
+#
+# These rake tasks will automatically detect schema changes and deploy correctly based on that. To override
+# use the 'rake deploy:staging:migrations' or 'rake deploy:staging:preboot' rake task options.
+class RakeHerokuDeployer
+  def initialize app_env
+    @app_env = app_env
+    @app = ENV["#{app_env.to_s.upcase}_APP_NAME"]
+    @start_time = Time.now.to_i
+
+    if @app.blank?
+      puts "Please add #{app_env.to_s.upcase}_APP_NAME environment variable in order to deploy"
+      exit(1)
+    end
+  end
+
+  # Uses git to determine if there are any DB migrations to run
+  def auto_deploy
+    if schema_change_since_last_release?
+      puts "::::::: Schema Change Detected, Disabling Preboot :::::::::"
+      run_migrations
+    else
+      puts "::::::: No Schema Change, Preboot Enabled :::::::::"
+      deploy
+    end
+  end
+
+  def run_migrations
+    #start_deploy;  turn_off_preboot; push; turn_app_off; backup; migrate; restart; run_data_migrations; turn_app_on; tag; stop_deploy;
+    start_deploy; turn_off_preboot; backup; push; migrate; restart; run_data_migrations; tag; stop_deploy;
+  end
+
+  def deploy
+    # turn_on_preboot; push; restart; tag;
+    start_deploy; turn_on_preboot; push; run_data_migrations; tag; stop_deploy;
+    #start_deploy;  push; turn_app_off; run_data_migrations; turn_app_on; tag; stop_deploy;
+  end
+
+  def backup_deploy
+    backup; deploy;
+  end
+
+  def rollback
+    turn_app_off; push_previous; restart; turn_app_on;
+  end
+
+private
+
+  # 1) Fetch remote heroku branch we are deploying to
+  # 2) Do a diff of our branch to the production one
+  # 3) See if any migrations were added
+  def schema_change_since_last_release?
+    remote_name = "#{@app}-deployer"
+    system("git remote add #{remote_name} git@heroku.com:#{@app}.git") # may already exist, don't error if so
+    exit(1) unless system("git fetch #{remote_name}")
+    diff = `git diff --name-only #{remote_name}/master`
+
+    if diff.blank? # If we get back an empty diff we either have an error or don't want to deploy anyways
+      puts 'No diff for deploying'
+      exit(0) # No need to fail, just exit. Also means nightly builds are green :).
+    end
+
+    exit(1) unless system("git remote remove #{remote_name}")
+    diff.include?("db/migrate/")
+  end
+
+  # Nice to see how long things run
+  def print_current_time
+    puts Time.now
+  end
+
+  def start_deploy
+    return unless ENV["NEPTUNE_API_KEY"].present?
+    puts 'Turning off the neptune API while deploy is happening...'
+    puts 'curl -X GET "https://www.neptune.io/api/v1/maintenance/<api_key>/on'
+    puts `curl -X GET 'https://www.neptune.io/api/v1/maintenance/#{ENV["NEPTUNE_API_KEY"]}/on'`
+  end
+
+  def stop_deploy
+    return unless ENV["NEPTUNE_API_KEY"].present?
+    puts 'Turning on the neptune API since deploy is finished...'
+    puts 'curl -X GET "https://www.neptune.io/api/v1/maintenance/<api_key>/off'
+    puts `curl -X GET 'https://www.neptune.io/api/v1/maintenance/#{ENV["NEPTUNE_API_KEY"]}/off'`
+  end
+
+  def turn_on_preboot
+    puts 'Turning on preboot...'
+    puts `heroku features:enable -a #{@app} preboot`
+    print_current_time
+  end
+
+  def turn_off_preboot
+    puts 'Turning off preboot...'
+    puts `heroku features:disable -a #{@app} preboot`
+    print_current_time
+  end
+
+  def push
+    current_branch = `git rev-parse --abbrev-ref HEAD`.chomp
+    branch_to_branch = (current_branch.length > 0) ? "#{current_branch}:master" : ""
+    puts 'Deploying site to Heroku ...'
+    puts "git push git@heroku.com:#{@app}.git #{branch_to_branch}"
+    puts `git push git@heroku.com:#{@app}.git #{branch_to_branch}`
+    print_current_time
+  end
+
+  def restart
+    puts 'Restarting app servers ...'
+    Bundler.with_clean_env { puts `heroku restart --app #{@app}` }
+    print_current_time
+  end
+
+  def tag
+    return unless @app_env == :production
+
+    release_name = "#{@app}_release-#{Time.now.utc.strftime("%Y%m%d%H%M%S")}"
+    puts "Tagging release as '#{release_name}'"
+    puts `git tag -a #{release_name} -m 'Tagged release'`
+    puts `git push --tags git@heroku.com:#{@app}.git`
+    print_current_time
+  end
+
+  def backup
+    puts 'Backing up the database...'
+    puts "heroku pgbackups:capture --expire --app #{@app}'"
+    puts `heroku pgbackups:capture --expire --app #{@app}`
+    print_current_time
+  end
+
+  def migrate
+    puts 'Running database migrations ...'
+    Bundler.with_clean_env { puts `heroku run 'bundle exec rake db:migrate LOG_LEVEL=info' --app #{@app}` }
+    print_current_time
+  end
+
+  def run_data_migrations
+    run_custom_command_cleanly('rake data:migrate', true)
+  end
+
+  def run_custom_command_cleanly(command, detached = false, log_level = 'info')
+    Bundler.with_clean_env { puts `heroku run#{detached ? ':detached' : ''} '#{command} LOG_LEVEL=#{log_level}' --app #{@app}` }
+    print_current_time
+  end
+
+  def turn_app_off
+    puts 'Putting the app into maintenance mode ...'
+    Bundler.with_clean_env { puts `heroku maintenance:on --app #{@app}` }
+    print_current_time
+  end
+
+  def turn_app_on
+    puts 'Taking the app out of maintenance mode ...'
+    Bundler.with_clean_env { puts `heroku maintenance:off --app #{@app}` }
+    print_current_time
+  end
+
+  def push_previous
+    prefix = "#{@app}_release-"
+    releases = `git tag`.split("\n").select { |t| t[0..prefix.length-1] == prefix }.sort
+    current_release = releases.last
+    previous_release = releases[-2] if releases.length >= 2
+    if previous_release
+      puts "Rolling back to '#{previous_release}' ..."
+
+      puts "Checking out '#{previous_release}' in a new branch on local git repo ..."
+      puts `git checkout #{previous_release}`
+      puts `git checkout -b #{previous_release}`
+
+      puts "Removing tagged version '#{previous_release}' (now transformed in branch) ..."
+      puts `git tag -d #{previous_release}`
+      puts `git push git@heroku.com:#{@app}.git :refs/tags/#{previous_release}`
+
+      puts "Pushing '#{previous_release}' to Heroku master ..."
+      puts `git push git@heroku.com:#{@app}.git +#{previous_release}:master --force`
+
+      puts "Deleting rollbacked release '#{current_release}' ..."
+      puts `git tag -d #{current_release}`
+      puts `git push git@heroku.com:#{@app}.git :refs/tags/#{current_release}`
+
+      puts "Retagging release '#{previous_release}' in case to repeat this process (other rollbacks)..."
+      puts `git tag -a #{previous_release} -m 'Tagged release'`
+      puts `git push --tags git@heroku.com:#{@app}.git`
+
+      puts "Turning local repo checked out on master ..."
+      puts `git checkout master`
+      puts 'All done!'
+    else
+      puts "No release tags found - can't roll back!"
+      puts releases
+    end
+  end
+end
+
+namespace :deploy do
+  namespace :staging do
+    task :migrations do
+      deployer = RakeHerokuDeployer.new(:staging)
+      deployer.run_migrations
+    end
+
+    task :backup_deploy do
+      deployer = RakeHerokuDeployer.new(:staging)
+      deployer.backup_deploy
+    end
+
+    task :rollback do
+      deployer = RakeHerokuDeployer.new(:staging)
+      deployer.rollback
+    end
+
+    task :preboot do
+      deployer = RakeHerokuDeployer.new(:staging)
+      deployer.deploy
+    end
+  end
+
+  task :staging do
+    deployer = RakeHerokuDeployer.new(:staging)
+    deployer.auto_deploy
+  end
+
+  namespace :demo do
+    task :migrations do
+      deployer = RakeHerokuDeployer.new(:demo)
+      deployer.run_migrations
+    end
+
+    task :backup_deploy do
+      deployer = RakeHerokuDeployer.new(:demo)
+      deployer.backup_deploy
+    end
+
+    task :rollback do
+      deployer = RakeHerokuDeployer.new(:demo)
+      deployer.rollback
+    end
+
+    task :preboot do
+      deployer = RakeHerokuDeployer.new(:demo)
+      deployer.deploy
+    end
+  end
+
+  task :demo do
+    deployer = RakeHerokuDeployer.new(:demo)
+    deployer.auto_deploy
+  end
+
+  namespace :production do
+    task :migrations do
+      deployer = RakeHerokuDeployer.new(:production)
+      deployer.run_migrations
+    end
+
+    task :backup_deploy do
+      deployer = RakeHerokuDeployer.new(:production)
+      deployer.backup_deploy
+    end
+
+    task :rollback do
+      deployer = RakeHerokuDeployer.new(:production)
+      deployer.rollback
+    end
+
+    task :preboot do
+      deployer = RakeHerokuDeployer.new(:production)
+      deployer.deploy
+    end
+  end
+
+  task :production do
+    deployer = RakeHerokuDeployer.new(:production)
+    deployer.auto_deploy
+  end
+
+  task :all do
+    deployer = RakeHerokuDeployer.new(:staging)
+    deployer2 = RakeHerokuDeployer.new(:demo)
+    deployer3 = RakeHerokuDeployer.new(:production)
+    deployer.auto_deploy
+    deployer2.auto_deploy
+    deployer3.auto_deploy
+  end
+
+  namespace :all do
+    task :migrations do
+      deployer = RakeHerokuDeployer.new(:staging)
+      deployer2 = RakeHerokuDeployer.new(:demo)
+      deployer3 = RakeHerokuDeployer.new(:production)
+      deployer.run_migrations
+      deployer2.run_migrations
+      deployer3.run_migrations
+    end
+
+    task :backup_deploy do
+      deployer = RakeHerokuDeployer.new(:staging)
+      deployer2 = RakeHerokuDeployer.new(:demo)
+      deployer3 = RakeHerokuDeployer.new(:production)
+      deployer.backup_deploy
+      deployer2.backup_deploy
+      deployer3.backup_deploy
+    end
+
+    task :preboot do
+      deployer = RakeHerokuDeployer.new(:staging)
+      deployer2 = RakeHerokuDeployer.new(:demo)
+      deployer3 = RakeHerokuDeployer.new(:production)
+      deployer.deploy
+      deployer2.deploy
+      deployer3.deploy
+    end
+  end
+
+  # A Helper method to see what the output is
+  task :detect_schema_change do
+    deployer = RakeHerokuDeployer.new(:staging)
+    puts deployer.schema_change_since_last_release?
+  end
+end

data/lib/tasks/elasticsearch.rake

@@ -0,0 +1,85 @@
+# Run with: rake environment elasticsearch:reindex
+# Begins by creating the index using tire:import:model command. This will create the "official" index name, e.g. "things" each time.
+# Then we rename it to, e.g. "things_20121001052916" and alias "things" to it.
+# Assumes usage of the elasticsearch-ruby libraries
+# TODO: Assumes you have a library called ElasticsearchAdminHelper defined with the right methods. Move that helper into this gem
+
+namespace :elasticsearch do
+  desc 'Reindexes all ActiveRecord model indices'
+  task "reindex:all" => :environment do
+    Rails.application.eager_load!
+    include ElasticsearchAdminHelper
+
+    ActiveRecord::Base.descendants.each do |model_class|
+      next unless model_class.respond_to? :__elasticsearch__
+      reindex_model(model_class)
+    end
+
+    puts 'All indices reindexed'
+  end
+
+  desc 'Deletes indices and then reindexes all ActiveRecord model indices assuming none exist yet'
+  task "reindex:all:fresh" => :environment do
+    return unless Rails.env.development? or Rails.env.test?
+
+    Rails.application.eager_load!
+    include ElasticsearchAdminHelper
+
+    # If we don't create the temporary indices, then mass emails (for example) will try
+    # to query users for recipient count and fail
+    ActiveRecord::Base.descendants.each do |model_class|
+      next unless model_class.respond_to? :__elasticsearch__
+      delete_index(model_class.index_name)
+      create_temporary_index(model_class)
+    end
+
+    ActiveRecord::Base.descendants.each do |model_class|
+      next unless model_class.respond_to? :__elasticsearch__
+      reindex_model(model_class, true)
+    end
+
+    puts 'All indices created, aliased and ready'
+  end
+
+  desc 'Deletes indices and then reindexes all ActiveRecord model indices assuming none exist yet. Is used for testing where aliases are not used'
+  task "tests:prepare" => :environment do
+    return unless Rails.env.development? or Rails.env.test?
+
+    Rails.application.eager_load!
+    include ElasticsearchAdminHelper
+
+    # If we don't create the temporary indices, then mass emails (for example) will try
+    # to query users for recipient count and fail
+    ActiveRecord::Base.descendants.each do |model_class|
+      next unless model_class.respond_to? :__elasticsearch__
+      delete_index(model_class.index_name)
+      create_temporary_index(model_class)
+    end
+
+    puts 'All indices created, aliased and ready'
+  end
+
+  Dir.foreach("#{Rails.root}/app/models") do |item|
+    next if item == '.' or item == '..' or not item
+    name = item.split(".")[0].pluralize
+
+    desc "Reindexes #{name} using aliases"
+    task "reindex:#{name}" => :environment do
+      Rails.application.eager_load!
+      include ElasticsearchAdminHelper
+
+      klass = Kernel.const_get(name.classify)
+      reindex_model(klass)
+    end
+
+    desc "Reindexes #{name} using aliases, and deletes the old one first" # because Tire tries to create an index for us sometimes
+    task "reindex:#{name}:delete_old_first" => :environment do
+      Rails.application.eager_load!
+      include ElasticsearchAdminHelper
+
+      klass = Kernel.const_get(name.classify)
+      reindex_model(klass, true)
+    end
+
+  end
+end

data/lib/tasks/heroku.rake

@@ -0,0 +1,16 @@
+# A simple collection of convenient rake tasks for heroku deployed applications
+namespace :heroku do
+  namespace :maintenance do
+    task :on do
+      app = ENV['APPLICATION_NAME']
+      puts `heroku maintenance:on -a #{app}`
+      puts `heroku ps:scale worker=0 urgent=0 clock=0 -a #{app}`
+    end
+
+    task :off do
+      app = ENV['APPLICATION_NAME']
+      puts `heroku maintenance:off -a #{app}`
+      puts `heroku ps:scale worker=2 urgent=2 clock=1 -a #{app}`
+    end
+  end
+end

data/lib/tasks/invalids.rake

@@ -0,0 +1,34 @@
+# Simple helpers to find invalid records and print why they are invalid. May
+# take a while to run depending on size of data
+namespace :invalids do
+  Dir.foreach("#{Rails.root}/app/models") do |item|
+    next if item == '.' or item == '..' or not item
+    name = item.split(".")[0].pluralize
+
+    desc "Finds invalid records for #{name} scaffold"
+    task "find:#{name}" => :environment do
+      Rails.application.eager_load!
+      klass = Kernel.const_get(name.classify)
+
+      invalids = []
+      index = 0
+      klass.find_each do |obj|
+        index += 1
+
+        if index % 1000 == 0
+          ap "invalids at index #{index}"
+          ap invalids
+        end
+
+        next if obj.valid?
+        invalids << { id: obj.id, errors: obj.errors }
+      end
+
+      ap "Invalids at end:"
+      ap invalids
+
+      # This is used for log based alerts
+      ap "LOG NOTIFIER: INVALID RECORDS EXIST" if invalids.count > 0
+    end
+  end
+end

data/lib/tasks/rspec_generator.rake

@@ -0,0 +1,23 @@
+# Finds missing rspec files and generates them for you. May take a while to run, depending
+# on the number of scaffolds in the project.
+namespace :rspec_generator do
+  desc 'Generate rspec specs for all scaffolds that are missing specs'
+  task :generate => :environment do
+    Rails.application.eager_load!
+
+    # Iterate over all 'normal' active record classes. By normal
+    # I mean that rails includes habtm join tables in the list
+    # which we don't want.
+    ActiveRecord::Base.descendants.each do |model_class|
+      next if model_class.name.starts_with?("HABTM_")
+      generate_for_model(model_class)
+    end
+  end
+
+  def generate_for_model(model_class)
+    underscore_name = model_class.name.underscore
+    puts "Generating missing specs for #{underscore_name}"
+    system("rails g rspec:scaffold #{underscore_name} -s --view-specs=false --controller-specs=false --request-specs=true")
+    system("rails g rspec:model #{underscore_name} -s")
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: handshake_service
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Scott Ringwelski
@@ -71,6 +71,12 @@ files:
 - handshake_service.gemspec
 - lib/handshake_service.rb
 - lib/handshake_service/version.rb
+- lib/tasks/auto_annotate_models.rake
+- lib/tasks/deploy.rake
+- lib/tasks/elasticsearch.rake
+- lib/tasks/heroku.rake
+- lib/tasks/invalids.rake
+- lib/tasks/rspec_generator.rake
 homepage: https://github.com/strydercorp/handshake_service
 licenses:
 - MIT