Add support for Heroku button; move docs around a bit

Author: Matt Swanson

Gemfile

@@ -21,13 +21,6 @@ group :development, :test do
   gem "shotgun", "~> 0.9.0"
 end
 
-group :heroku do
-  gem "excon", "~> 0.31.0"
-  gem "formatador", "~> 0.2.4"
-  gem "netrc", "~> 0.7.7"
-  gem "rendezvous", "~> 0.0.2"
-end
-
 gem "activerecord", "~> 4.0"
 # need to work around bug in 4.0.1 https://github.com/rails/arel/pull/216
 gem 'arel', git: 'git://github.com/rails/arel.git', branch: '4-0-stable'

Gemfile.lock

@@ -48,7 +48,6 @@ GEM
     diff-lcs (1.2.5)
     docile (1.1.1)
     dotenv (0.9.0)
-    excon (0.31.0)
     faker (1.2.0)
       i18n (~> 0.5)
     feedbag (0.9.2)
@@ -60,7 +59,6 @@ GEM
     foreman (0.63.0)
       dotenv (>= 0.7)
       thor (>= 0.13.6)
-    formatador (0.2.4)
     highline (1.6.20)
     hpricot (0.8.6)
     i18n (0.6.9)
@@ -73,7 +71,6 @@ GEM
     mini_portile (0.5.2)
     minitest (4.7.5)
     multi_json (1.8.2)
-    netrc (0.7.7)
     nokogiri (1.6.1)
       mini_portile (~> 0.5.0)
     pg (0.17.1)
@@ -94,7 +91,6 @@ GEM
       rack-test (>= 0.5)
     raindrops (0.12.0)
     rake (10.1.1)
-    rendezvous (0.0.2)
     rest-client (1.6.7)
       mime-types (>= 1.16)
     rspec (2.14.1)
@@ -165,23 +161,19 @@ DEPENDENCIES
   coveralls (~> 0.7)
   delayed_job (~> 4.0)
   delayed_job_active_record (~> 4.0)
-  excon (~> 0.31.0)
   faker (~> 1.2)
   feedbag (~> 0.9.2)
   feedjira (~> 1.3.0)
   foreman (~> 0.63.0)
-  formatador (~> 0.2.4)
   highline (~> 1.6, >= 1.6.20)
   i18n (~> 0.6.9)
   loofah (~> 2.0.0)
-  netrc (~> 0.7.7)
   nokogiri (~> 1.6)
   pg (~> 0.17.1)
   pry-byebug (~> 1.2)
   rack-test (~> 0.6.2)
   racksh (~> 1.0)
   rake (~> 10.1, >= 10.1.1)
-  rendezvous (~> 0.0.2)
   rspec (~> 2.14, >= 2.14.1)
   rspec-html-matchers (~> 0.4.3)
   shotgun (~> 0.9.0)

README.md

@@ -18,42 +18,12 @@ But it does have keyboard shortcuts and was made with love!
 
 Stringer is a Ruby (2.0.0+) app based on Sinatra, ActiveRecord, PostgreSQL, Backbone.js and DelayedJob.
 
-Instructions are provided for deploying to Heroku (runs fine on the free plan) but Stringer can be deployed anywhere that supports Ruby (setup instructions for a Linux-based VPS are provided [here](/docs/VPS.md), and for OpenShift, provided [here](/docs/OpenShift.md)).
+[![Deploy to Heroku](https://cdn.herokuapp.com/deploy/button.svg)](https://heroku.com/deploy)
 
-```sh
-git clone git://github.com/swanson/stringer.git
-cd stringer
-heroku create
-git push heroku master
-
-heroku config:set APP_URL=`heroku apps:info | grep -o 'http[^"]*'`
-heroku config:set SECRET_TOKEN=`openssl rand -hex 20`
-
-heroku run rake db:migrate
-heroku restart
-
-heroku addons:add scheduler
-heroku addons:open scheduler
-```
-
-Add an hourly task that runs `rake lazy_fetch` (if you are not on Heroku you may want `rake fetch_feeds` instead).
-
-Load the app and follow the instructions to import your feeds and start using the app.
+Stringer will run just fine on the Heroku free plan.
 
----
-
-In the event that you need to change your password, run `heroku run rake change_password` from the app folder.
-
-## Updating the app
-
-From the app's directory:
-
-```sh
-git pull
-git push heroku master
-heroku run rake db:migrate
-heroku restart
-```
+Instructions are provided for deploying to [Heroku manually](/docs/Heroku.md), to any Ruby 
+compatible [Linux-based VPS](/docs/VPS.md), and to [OpenShift](/docs/OpenShift.md).
 
 ## Niceties
 
@@ -107,7 +77,7 @@ To set your locale on Heroku, run `heroku config:set LOCALE=en`.
 
 If you would like to translate Stringer to your preferred language, please use [LocaleApp](http://www.localeapp.com/projects/4637).
 
-### Clean up old read stories
+### Clean up old read stories on Heroku
 
 If you are on the Heroku free plan, there is a 10k row limit so you will
 eventually run out of space.

Rakefile

@@ -81,135 +81,4 @@ begin
   task :default => [:speedy_tests]
 rescue LoadError
   # allow for bundle install --without development:test
-end
-
-desc "deploy stringer on Heroku"
-task :deploy do
-
-  require 'excon'
-  require 'formatador'
-  require 'json'
-  require 'netrc'
-  require 'rendezvous'
-  require 'securerandom'
-
-  Formatador.display_line("[negative]<> deploying stringer to Heroku[/]")
-
-  # grab netrc credentials, set by toolbelt via `heroku login`
-  Formatador.display_line("[negative]<> reading your global Heroku credentials from ~/.netrc (set when you ran heroku login)...[/]")
-  _, password = Netrc.read['api.heroku.com']
-
-  # setup excon for API calls
-  heroku = Excon.new(
-    'https://api.heroku.com',
-    :headers => {
-      "Accept"        => "application/vnd.heroku+json; version=3",
-      "Authorization" => "Basic #{[':' << password].pack('m').delete("\r\n")}",
-      "Content-Type"  => "application/json"
-    }
-  )
-
-  #heroku create
-  Formatador.display_line("[negative]<> creating app[/]")
-  app_data = JSON.parse(heroku.post(:path => "/apps").body)
-
-  #git push heroku master
-  Formatador.display_line("[negative]<> pushing code to [underline]#{app_data['name']}[/]")
-  `git push git@heroku.com:#{app_data['name']}.git master`
-
-  heroku.reset # reset socket as git push may take long enough for timeout
-
-  #heroku config:set SECRET_TOKEN=`openssl rand -hex 20`
-  Formatador.display_line("[negative]<> setting SECRET_TOKEN on [underline]#{app_data['name']}[/]")
-  heroku.patch(
-    :body       => { "SECRET_TOKEN" => SecureRandom.hex(20) }.to_json,
-    :path       => "/apps/#{app_data['id']}/config-vars"
-  )
-
-  #heroku run rake db:migrate
-  Formatador.display_line("[negative]<> running `rake db:migrate` on [underline]#{app_data['name']}[/]")
-  run_data = JSON.parse(heroku.post(
-    :body => {
-      "attach"  => true,
-      "command" => "rake db:migrate"
-    }.to_json,
-    :path => "/apps/#{app_data['id']}/dynos"
-  ).body)
-  Rendezvous.start(
-    :url => run_data['attach_url']
-  )
-
-  heroku.reset # reset socket as db:migrate may take long enough for timeout
-
-  #heroku restart
-  Formatador.display_line("[negative]<> restarting [underline]#{app_data['name']}[/]")
-  heroku.delete(:path => "/apps/#{app_data['id']}/dynos")
-
-  #heroku addons:add scheduler
-  Formatador.display_line("[negative]<> adding scheduler:standard to [underline]#{app_data['name']}[/]")
-  heroku.post(
-    :body => { "plan" => { "name" => "scheduler:standard" } }.to_json,
-    :path => "/apps/#{app_data['id']}/addons"
-  )
-
-  #heroku addons:open scheduler
-  Formatador.display_lines([
-    "[negative]<> Add `[bold]rake lazy_fetch[/][negative]` hourly task at [underline]https://api.heroku.com/apps/#{app_data['id']}/addons/scheduler:standard[/]",
-    "[negative]<> Impatient? After adding feeds, immediately fetch the latest with `heroku run rake fetch_feeds -a #{app_data['name']}`",
-    "[negative]<> stringer available at [underline]#{app_data['web_url']}[/]"
-  ])
-end
-
-desc "update stringer on heroku"
-task :update, :app do |task, args|
-
-  require 'excon'
-  require 'formatador'
-  require 'json'
-  require 'netrc'
-  require 'rendezvous'
-
-  unless args.app
-    Formatador.display_line("[negative]! Error: App required, please run as `bundle exec rake update[app]`[/]")
-    exit
-  end
-
-  Formatador.display_line("[negative]<> updating Heroku stringer on [underline]#{args.app}[/]")
-
-  # grab netrc credentials, set by toolbelt via `heroku login`
-  Formatador.display_line("[negative]<> reading your global Heroku credentials from ~/.netrc (set when you ran heroku login)...[/]")
-  _, password = Netrc.read['api.heroku.com']
-
-  # setup excon for API calls
-  heroku = Excon.new(
-    'https://api.heroku.com',
-    :headers => {
-      "Accept"        => "application/vnd.heroku+json; version=3",
-      "Authorization" => "Basic #{[':' << password].pack('m').delete("\r\n")}",
-      "Content-Type"  => "application/json"
-    }
-  )
-
-  #git push heroku master
-  Formatador.display_line("[negative]<> pushing code to [underline]#{args.app}[/]")
-  `git push git@heroku.com:#{args.app}.git master`
-
-  #heroku run rake db:migrate
-  Formatador.display_line("[negative]<> running `rake db:migrate` on [underline]#{args.app}[/]")
-  run_data = JSON.parse(heroku.post(
-    :body => {
-      "attach"  => true,
-      "command" => "rake db:migrate"
-    }.to_json,
-    :path => "/apps/#{args.app}/dynos"
-  ).body)
-  Rendezvous.start(
-    :url => run_data['attach_url']
-  )
-
-  heroku.reset # reset socket as db:migrate may take long enough for timeout
-
-  #heroku restart
-  Formatador.display_line("[negative]<> restarting [underline]#{args.app}[/]")
-  heroku.delete(:path => "/apps/#{args.app}/dynos")
-end
+end

app.json

@@ -0,0 +1,27 @@
+{
+  "name": "Stringer",
+  "description": "A self-hosted, anti-social RSS reader.",
+  "logo": "https://raw.githubusercontent.com/swanson/testing-hb/master/screenshots/logo.png",
+  "keywords": [
+    "RSS",
+    "Ruby"
+  ],
+  "website": "https://github.com/swanson/stringer",
+  "success_url": "/heroku",
+  "scripts": {
+    "postdeploy": "rake db:migrate"
+  },
+  "env": {
+    "SECRET_TOKEN": {
+      "description": "Secret key used as the session secret",
+      "generator": "secret"
+    },
+    "LOCALE": {
+      "description": "Specify the translation locale you wish to use",
+      "value": "en"
+    }
+  },
+  "addons": [
+    "scheduler:standard"
+  ]
+}

app/controllers/debug_controller.rb

@@ -7,4 +7,8 @@ class Stringer < Sinatra::Base
       pending_migrations: MigrationStatus.new.pending_migrations
     }
   end
+
+  get "/heroku" do
+    erb :heroku
+  end
 end

app/helpers/authentication_helpers.rb

@@ -13,6 +13,7 @@ def needs_authentication?(path)
       return false if !UserRepository.setup_complete?
       return false if path == "/login" || path == "/logout"
       return false if path =~ /css/ || path =~ /js/ || path =~ /img/
+      return false if path == "/heroku"
       true
     end
 

app/views/heroku.erb

@@ -0,0 +1,19 @@
+<div class="setup" id="heroku-setup">
+  <h1><%= t('tutorial.heroku_one_more_thing') %></h1>
+
+  <p>
+    <%= t('tutorial.heroku_hourly_task') %>
+  </p>
+  <p>
+    <%= t('tutorial.heroku_scheduler') %>:
+  </p>
+  <pre>
+    Task: rake lazy_fetch
+    Dyno Size: 1X
+    Frequency: Hourly
+  </pre>
+</div>
+
+<div class="center">
+  <a href="/" id="start" class="btn btn-primary"><%= t('tutorial.ready') %></a>
+</div>

config/locales/en.yml

@@ -142,6 +142,9 @@ en:
     as_read: as read
     click_to_read: (click to read)
     description: We're getting you some stories to read, give us a second.
+    heroku_hourly_task: You need to add an hourly task to check for new stories. 
+    heroku_one_more_thing: One more thing...
+    heroku_scheduler: Go to the Heroku Scheduler and add this task
     mark_all: mark all
     ready: Okay, it's ready!
     refresh: refresh

docs/Heroku.md

@@ -0,0 +1,36 @@
+```sh
+git clone git://github.com/swanson/stringer.git
+cd stringer
+heroku create
+git push heroku master
+
+heroku config:set APP_URL=`heroku apps:info | grep -o 'http[^"]*'`
+heroku config:set SECRET_TOKEN=`openssl rand -hex 20`
+
+heroku run rake db:migrate
+heroku restart
+
+heroku addons:add scheduler
+heroku addons:open scheduler
+```
+
+Add an hourly task that runs `rake lazy_fetch` (if you are not on Heroku you may want `rake fetch_feeds` instead).
+
+Load the app and follow the instructions to import your feeds and start using the app.
+
+See the "Niceties" section of the README for a few more tips and tricks for getting the most out of Stringer on Heroku.
+
+## Updating the app
+
+From the app's directory:
+
+```sh
+git pull
+git push heroku master
+heroku run rake db:migrate
+heroku restart
+```
+
+## Password Reset
+
+In the event that you need to change your password, run `heroku run rake change_password` from the app folder.