lita-heroku-keepalive 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7c3bcfec6700740119aaea22cfd8ed7aaab8c652
+  data.tar.gz: 359a86385206e72bbed7e74d4c29ea1c4977e679
+SHA512:
+  metadata.gz: b686230f3ed99acc4c2d64c630767ef0de6a869cedccb59970cc93567c20e66c398cf77e5995fcebe3fe8971ab0d9b2cfbd6ee30dda1bff2555d561dd63097b1
+  data.tar.gz: d9e8e1c14e3946a105fdb43203ccfed0398a3970ebbf10afabd3ad1124bac99c0ef80cd9c170ef82f706b67e168bc9d18e61d1e4ace829abb82a663b1e98462e

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Ronghai Wei
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,68 @@
+# lita-heroku-keepalive
+
+A gem that keeps the Lita Heroku free web dyno alive.
+Note that a [free Heroku dyno can only run for 18 hours/day](https://blog.heroku.com/archives/2015/5/7/new-dyno-types-public-beta#hobby-and-free-dynos), so it will be required to sleep for at least 6 hours. Accessing your Lita during a sleep period will wake it, but it will return to sleep after 30 minutes.
+
+## Installation
+
+Add lita-heroku-keepalive to your Lita instance's Gemfile:
+
+``` ruby
+gem "lita-heroku-keepalive"
+```
+
+And then execute:
+
+    $ bundle
+
+install it yourself as:
+	
+    $ gem install lita-heroku-keepalive
+
+## Configuration
+
+
+lita-heroku-keepalive is configured by four environment variables:
+
+* `LITA_HEROKU_KEEPALIVE_URL` - required, the complete URL to keepalive, including a trailing slash.
+* `LITA_HEROKU_WAKEUP_TIME` - optional,  the time of day (HH:MM) when lita should wake up.  Default: 6:00 (6 am)
+* `LITA_HEROKU_SLEEP_TIME` - optional, the time of day (HH:MM) when lita should go to sleep. Default: 22:00 (10 pm)
+* `LITA_HEROKU_KEEPALIVE_INTERVAL` - the interval minutes in which to keepalive, in minutes. Default: 5 (minutes)
+
+You *must* set `LITA_HEROKU_KEEPALIVE_URL` and it *must* include a trailing slash – otherwise the script won't run. 
+You can find out the value for this by running `heroku apps:info`. Copy the `Web URL` and run:
+
+```
+heroku config:set LITA_HEROKU_KEEPALIVE_URL=PASTE_WEB_URL_HERE
+```
+
+If you want to trust a shell snippet from the Internet, here's a one-liner:
+
+```
+heroku config:set LITA_HEROKU_KEEPALIVE_URL=$(heroku apps:info -s | grep web_url | cut -d= -f2)
+```
+
+`LITA_HEROKU_WAKEUP_TIME` and `LITA_HEROKU_SLEEP_TIME` define the waking hours - between these times the keepalive will ping your Heroku app.  Outside of those times, the ping will be suppressed, allowing the dyno to shut down. These times are based on the timezone of your Heroku application which defaults to UTC.  You can change this with:
+
+```
+heroku config:add TZ="America/New_York"
+```
+
+
+## Usage
+
+TODO: Describe the plugin's features and how to use them.
+
+
+## Waking Lita Up
+
+This gem will keep the dyno alive once it is awake, but something needs to wake it up. You can use the [Heroku Scheduler](https://devcenter.heroku.com/articles/scheduler) to wake the dyno up. Add the scheduler addon by running:
+
+```
+heroku addons:create scheduler:standard
+```
+The scheduler must be manually configured from the web interface, so run `heroku addons:open scheduler` and configure it to run `curl ${LITA_HEROKU_KEEPALIVE_URL}heroku/keepalive` at the time configured for `LITA_HEROKU_WAKEUP_TIME`.
+
+![Heroku Scheduler Screenshot](https://cloud.githubusercontent.com/assets/173/9414275/2e4b67ea-4805-11e5-80d0-d6b26ead50ef.png)
+
+Note that the Scheduler's time is in UTC. If you changed your application's timezone with `TZ`, you'll need to convert that time to UTC for the wakup job. For example, if `LITA_HEROKU_WAKEUP_TIME` is set to `06:00` and `TZ` is set to `America/New_York`, you'll need to set the Scheduler to run at 10:00 AM UTC.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/lita-heroku-keepalive.rb

@@ -0,0 +1,12 @@
+require "lita"
+
+Lita.load_locales Dir[File.expand_path(
+  File.join("..", "..", "locales", "*.yml"), __FILE__
+)]
+
+require "lita/handlers/heroku_keepalive"
+
+Lita::Handlers::HerokuKeepalive.template_root File.expand_path(
+  File.join("..", "..", "templates"),
+ __FILE__
+)

data/lib/lita/handlers/heroku_keepalive.rb

@@ -0,0 +1,48 @@
+require 'time'
+module Lita
+  module Handlers
+    class HerokuKeepalive < Handler
+      # insert handler code here
+      WAKE_UP_TIME = (ENV["LITA_HEROKU_WAKEUP_TIME"] || "06:00").split(":").map(&:to_i)
+      SLEEP_TIME = (ENV["LITA_HEROKU_SLEEP_TIME"] || "22:00").split(":").map(&:to_i)
+      WALKE_UP_OFFSET = ( WAKE_UP_TIME[0] * 60 + WAKE_UP_TIME[1]) % 1440
+      AWAKE_MINUTES =  ((SLEEP_TIME[0] + 24) * 60  + SLEEP_TIME[1] - WALKE_UP_OFFSET) % 1440
+      
+      KEEPALIVE_INTERVAL = (ENV["LITA_HEROKU_KEEPALIVE_INTERVAL"] || "5" ) .to_i * 60
+      KEEPALIVE_URL = ENV["LITA_HEROKU_KEEPALIVE_URL"] || ENV["HEROKU_URL"]
+      
+      if KEEPALIVE_URL
+      	unless KEEPALIVE_URL[-1] == '/'
+          KEEPALIVE_URL = KEEPALIVE_URL + "/"
+        end
+        
+        http.get "/heroku/keepalive" do |request, response|
+          #log.info ">>>>>>>"
+          response.body << "OK"
+        end
+        http.post "/heroku/keepalive" do |request, response|
+          response.body << "OK"
+        end
+
+        on(:loaded) do
+          log.info "staring ping keep alive url #{KEEPALIVE_URL}heroku/keepalive"
+          every(KEEPALIVE_INTERVAL) do
+            now = Time.now
+            minutes = (60 * (now.hour + 24) + now.min - WALKE_UP_OFFSET) % (60 * 24)
+            if minutes <= AWAKE_MINUTES
+              log.info "Keepalive ping..."
+              http.get "#{KEEPALIVE_URL}heroku/keepalive" 
+            else
+              log.info "skipping keep alive, time to rest"
+            end
+          end
+        end
+      else
+        puts(" LITA_HEROKU_KEEPALIVE_URL is missing.\n`heroku config:set LITA_HEROKU_KEEPALIVE_URL=$(heroku apps:info -s  | grep web_url | cut -d= -f2)`")
+      end
+      
+      
+      Lita.register_handler(self)
+    end
+  end
+end

data/lita-heroku-keepalive.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |spec|
+  spec.name          = "lita-heroku-keepalive"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Ronghai Wei"]
+  spec.email         = ["Ronghai.Wei@msn.com"]
+  spec.description   = "Based on hubot-heroku-keepalive, to keep Heroku's free tire live"
+  spec.summary       = "Keep Heroku's free tier live"
+  spec.homepage      = "https://github.com/ronghai/lita-heroku-keepalive"
+  spec.license       = "MIT"
+  spec.metadata      = { "lita_plugin_type" => "handler" }
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "lita", ">= 4.7"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "rspec", ">= 3.0.0"
+end

data/locales/en.yml

@@ -0,0 +1,4 @@
+en:
+  lita:
+    handlers:
+      heroku_keepalive:

data/spec/lita/handlers/heroku_keepalive_spec.rb

@@ -0,0 +1,4 @@
+require "spec_helper"
+
+describe Lita::Handlers::HerokuKeepalive, lita_handler: true do
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require "lita-heroku-keepalive"
+require "lita/rspec"
+
+# A compatibility mode is provided for older plugins upgrading from Lita 3. Since this plugin
+# was generated with Lita 4, the compatibility mode should be left disabled.
+Lita.version_3_compatibility_mode = false

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: lita-heroku-keepalive
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ronghai Wei
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lita
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Based on hubot-heroku-keepalive, to keep Heroku's free tire live
+email:
+- Ronghai.Wei@msn.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/lita-heroku-keepalive.rb
+- lib/lita/handlers/heroku_keepalive.rb
+- lita-heroku-keepalive.gemspec
+- locales/en.yml
+- spec/lita/handlers/heroku_keepalive_spec.rb
+- spec/spec_helper.rb
+- templates/.gitkeep
+homepage: https://github.com/ronghai/lita-heroku-keepalive
+licenses:
+- MIT
+metadata:
+  lita_plugin_type: handler
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.2
+signing_key: 
+specification_version: 4
+summary: Keep Heroku's free tier live
+test_files:
+- spec/lita/handlers/heroku_keepalive_spec.rb
+- spec/spec_helper.rb