stay_awake 0.0.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Tobias Bühlmann
+
+MIT License
+
+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,50 @@
+# stay_awake
+
+## About
+stay_awake requests websites periodically. It's written especially for Heroku, that puts applications to sleep when there are no requests coming in.
+
+## Installation
+### Gem
+    $ gem install stay_awake
+### Bundler
+```ruby
+gem 'stay_awake'
+```
+### Bundler (head)
+```ruby
+gem 'stay_awake', :github => 'tbuehlmann/stay_awake'
+```
+
+## Usage
+```ruby
+buzzer = StayAwake.configure do |c|
+  c.app_name = 'app_name'
+end
+
+buzzer.buzz
+```
+
+### Sinatra
+Put the `StayAwake.configure` block inside Sinatra's `configure` block, run `buzz` and you're done.
+
+### Rails
+Put the StayAwake.configure block inside an initializer, run `buzz` and you're done.
+
+### Configuration Defaults
+| Configuration | Type | Default |
+|:-:|:-:|:-:|
+| `app_name` | `String` | `nil` |
+| `url` | `string` | `nil`|
+| `request_method` | `Symbol` | `:head` |
+| `interval` | `Integer` | `300` |
+| `logger` | `Logger` | `Logger.new(STDOUT)` |
+| `strategy` | `StayAwake::Strategy` | `StayAwake.strategies` |
+
+You can either use `app_name` or `url`, but `url` has precedence over `app_name`. If just `app_name` is given, it will be translated to `http://app_name.herokuapp.com/`.
+
+When using em-http-request, the buzzing will begin on the `next_tick`.
+
+### Supported HTTP Libraries
+- [em-http-request](https://github.com/igrigorik/em-http-request "em-http-request")
+- [HTTParty](https://github.com/jnunemaker/httparty "HTTParty")
+- [net/http](http://www.ruby-doc.org/stdlib-1.9.3/libdoc/net/http/rdoc/index.html "net/http")

data/lib/stay_awake.rb

@@ -0,0 +1,45 @@
+require 'logger'
+require 'securerandom'
+require 'singleton'
+
+module StayAwake
+  def self.config
+    Configuration.instance
+  end
+
+  def self.configure(&block)
+    yield config
+    self
+  end
+
+  def self.logger
+    config.logger
+  end
+
+  def self.strategies
+    @strategies ||= []
+  end
+
+  def self.buzz
+    Buzzer.instance.buzz
+  end
+
+  def self.buzzing?
+    Buzzer.instance.buzzing?
+  end
+
+  def self.shut_off
+    Buzzer.instance.shut_off
+  end
+
+  require 'stay_awake/buzzer'
+  require 'stay_awake/configuration'
+  require 'stay_awake/strategy'
+  require 'stay_awake/version'
+
+  module Strategies
+    require 'stay_awake/strategies/em_http_request'
+    require 'stay_awake/strategies/httparty'
+    require 'stay_awake/strategies/net_http'
+  end
+end

data/lib/stay_awake/buzzer.rb

@@ -0,0 +1,47 @@
+module StayAwake
+  class Buzzer
+    include Singleton
+
+    def initialize
+      @buzzing = false
+      @strategy = nil
+    end
+
+    def buzzing?
+      @buzzing
+    end
+
+    def buzz
+      unless buzzing?
+        if StayAwake.config.url
+          url = StayAwake.config.url
+        elsif StayAwake.config.app_name
+          url = "http://#{StayAwake.config.app_name}.herokuapp.com/"
+        else
+          raise ConfigurationError.new('config.url or config.app_name needed.')
+        end
+
+        start_buzzing(url)
+        @buzzing = true
+      end
+    end
+
+    def shut_off
+      @strategy.shut_off if buzzing?
+      @buzzing = false
+    end
+
+    private
+
+    def start_buzzing(url)
+      strategies = [StayAwake.config.strategy].flatten
+      @strategy = strategies.select(&:available?).first
+
+      if @strategy
+        @strategy.buzz(url)
+      else
+        raise ConfigurationError.new('No valid Strategy given.')
+      end
+    end
+  end
+end

data/lib/stay_awake/configuration.rb

@@ -0,0 +1,22 @@
+module StayAwake
+  class Configuration
+    include Singleton
+
+    attr_accessor :app_name
+    attr_accessor :url
+    attr_accessor :request_method
+    attr_accessor :interval
+    attr_accessor :logger
+    attr_accessor :strategy
+
+    def initialize
+      @request_method = :head
+      @interval = 5*60
+      @logger = Logger.new(STDOUT)
+      @logger.progname = :stay_awake
+      @strategy = StayAwake.strategies
+    end
+  end
+
+  class ConfigurationError < StandardError; end
+end

data/lib/stay_awake/sinatra.rb

@@ -0,0 +1,4 @@
+module StayAwake
+  module Sinatra
+  end
+end

data/lib/stay_awake/strategies/em_http_request.rb

@@ -0,0 +1,40 @@
+module StayAwake
+  module Strategies
+    class EmHttpRequest
+      include Singleton, Strategy
+
+      def self.available?
+        defined?(EventMachine::HttpRequest) ? true : false
+      end
+
+      def self.buzz(url)
+        StayAwake.logger.info 'Starting buzzing using EventMachine::HttpRequest.'
+
+        EM.next_tick do
+          @timer = EM::PeriodicTimer.new(StayAwake.config.interval) do
+            uuid = SecureRandom.uuid
+            request = EventMachine::HttpRequest.new(url)
+            StayAwake.logger.debug "Starting HTTP Request (#{uuid})."
+            request = request.send(StayAwake.config.request_method)
+
+            request.callback do
+              StayAwake.logger.debug "HTTP Response arrived (#{uuid})."
+            end
+
+            request.errback do
+              StayAwake.logger.error "HTTP Request failed (#{uuid})."
+            end
+
+            # TODO: Timeout?
+          end
+        end
+      end
+
+      def self.shut_off
+        @timer.cancel
+        @timer = nil
+        StayAwake.logger.info 'Stopped buzzing.'
+      end
+    end
+  end
+end

data/lib/stay_awake/strategies/httparty.rb

@@ -0,0 +1,42 @@
+module StayAwake
+  module Strategies
+    class Httparty
+      include Singleton, Strategy
+
+      def self.available?
+        defined?(HTTParty) ? true : false
+      end
+
+      def self.buzz(url)
+        require 'timeout'
+        StayAwake.logger.info 'Starting buzzing using HTTParty.'
+
+        @thread = Thread.new do
+          loop do
+            begin
+              Timeout.timeout(30) do
+                uuid = SecureRandom.uuid
+                StayAwake.logger.debug "Starting HTTP Request (#{uuid})."
+                HTTParty.send(StayAwake.config.request_method, url)
+                StayAwake.logger.debug "HTTP Response arrived (#{uuid})."
+                # TODO: Failing request?
+              end
+            rescue Timeout::Error
+              StayAwake.logger.error "HTTP Timeout Error after 30 seconds (#{uuid})."
+            rescue StandardError => e
+              StayAwake.logger.error e.message
+            end
+
+            sleep StayAwake.config.interval
+          end
+        end
+      end
+
+      def self.shut_off
+        @thread.kill
+        @thread = nil
+        StayAwake.logger.info 'Stopped buzzing.'
+      end
+    end
+  end
+end

data/lib/stay_awake/strategies/net_http.rb

@@ -0,0 +1,54 @@
+module StayAwake
+  module Strategies
+    class NetHttp
+      include Singleton, Strategy
+
+      def self.available?
+        begin
+          require 'net/http'
+          require 'uri'
+          true
+        rescue LoadError
+          false
+        end
+      end
+
+      def self.buzz(url)
+        require 'timeout'
+        StayAwake.logger.info 'Starting buzzing using net/http.'
+
+        @thread = Thread.new do
+          loop do
+            begin
+              Timeout.timeout(30) do
+                uuid = SecureRandom.uuid
+                StayAwake.logger.debug "Starting HTTP Request (#{uuid})."
+                
+                uri = URI.parse(url)
+                http = Net::HTTP.new(uri.host, uri.port)
+                request_method = StayAwake.config.request_method.to_s.capitalize
+                request_class = Kernel.const_get("Net::HTTP::#{request_method}")
+                response = http.request(request_class.new(uri.request_uri))
+                
+                StayAwake.logger.debug "HTTP Response arrived (#{uuid})."
+                # TODO: Failing request?
+              end
+            rescue Timeout::Error
+              StayAwake.logger.error "HTTP Timeout Error after 30 seconds (#{uuid})."
+            rescue StandardError => e
+              StayAwake.logger.error e.message
+            end
+
+            sleep StayAwake.config.interval
+          end
+        end
+      end
+
+      def self.shut_off
+        @thread.kill
+        @thread = nil
+        StayAwake.logger.info 'Stopped buzzing.'
+      end
+    end
+  end
+end

data/lib/stay_awake/strategy.rb

@@ -0,0 +1,22 @@
+module StayAwake
+  module Strategy
+    def self.included(base)
+      StayAwake.strategies << base
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def available?(*args)
+        raise NotImplementedError
+      end
+
+      def buzz(*args)
+        raise NotImplementedError
+      end
+
+      def shut_off(*args)
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/stay_awake/version.rb

@@ -0,0 +1,3 @@
+module StayAwake
+  VERSION = '0.0.1'
+end

data/stay_awake.gemspec

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'stay_awake/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'stay_awake'
+  spec.version       = StayAwake::VERSION
+  spec.authors       = ['Tobias Bühlmann']
+  spec.email         = ['tobias.buehlmann@gmx.de']
+  spec.description   = "Requests websites so they won't fall asleep. Like on Heroku."
+  spec.summary       = "stay_awake requests websites like Heroku so they won't fall asleep. It supports the HTTP libraries em-http-request, HTTParty and net/http."
+  spec.homepage      = 'https://github.com/tbuehlmann/stay_awake'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.2'
+  spec.add_development_dependency 'em-http-request', '~> 1.0'
+  spec.add_development_dependency 'httparty', '~> 0.10'
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: stay_awake
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Tobias Bühlmann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: em-http-request
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: Requests websites so they won't fall asleep. Like on Heroku.
+email:
+- tobias.buehlmann@gmx.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- lib/stay_awake.rb
+- lib/stay_awake/buzzer.rb
+- lib/stay_awake/configuration.rb
+- lib/stay_awake/sinatra.rb
+- lib/stay_awake/strategies/em_http_request.rb
+- lib/stay_awake/strategies/httparty.rb
+- lib/stay_awake/strategies/net_http.rb
+- lib/stay_awake/strategy.rb
+- lib/stay_awake/version.rb
+- stay_awake.gemspec
+homepage: https://github.com/tbuehlmann/stay_awake
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: stay_awake requests websites like Heroku so they won't fall asleep. It supports
+  the HTTP libraries em-http-request, HTTParty and net/http.
+test_files: []