rails_version 0.2.2

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,5 @@
+source 'https://rubygems.org'
+
+group :development do
+  gem "rake"  
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jamon Holmgren
+
+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,46 @@
+# RailsVersion
+
+This gem works with http://railsversion.herokuapp.com to track all of your Rails apps
+and the versions they are running. This gives you one place to see all of your rails
+application versions.
+
+## Installation
+
+As usual, add this line to your application's Gemfile and bundle afterward:
+
+    gem 'rails_version', ">= 0.2.0", :group => :production, :git => "git://github.com/clearsightstudio/rails_version.git"
+
+Sign up and get your API key from http://railsversion.herokuapp.com, then go to your config/environments/production.rb file and add this:
+
+    RailsVersion::Config.api_key = "API_KEY_HERE"
+
+## Manual Ping
+
+If you want to manually trigger a ping, go to:
+
+    http://example.com/?rails_version_ping=API_KEY_HERE
+
+Just replace example.com with your domain name and API_KEY_HERE with your API key.
+
+## Configuration Options
+
+We have good defaults, but we do expose some config options:
+
+* `RailsVersion::Config.server_url = "http://yourserver/ping"` - allows you to ping your own server instead of ours.
+* `RailsVersion::Config.ping_type = :server | :image | :script` - :server is default and the safest, but you can also inject an image or javascript tag into your HTML if the :server option isn't working for you.
+* `RailsVersion::Config.frequency = 100` - 100 is a 1% chance on page load of pinging our server (default). Turn this down if you have a lot of traffic or up if you have very little traffic. Your server should ping ours about once every couple days on average.
+* `RailsVersion::Config.api_key = "API_KEY_HERE"` - *required* API key from http://railsversion.herokuapp.com if you're using our server.
+
+## Code Climate
+
+Version 0.1.0 Grade: A
+
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/clearsightstudio/rails_version)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b feature/my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/lib/rails_version.rb

@@ -0,0 +1,53 @@
+require "rails_version/version"
+require "rails_version/pinger"
+require "rails_version/rails_version_mixin"
+require 'rails_version/railtie' if defined? Rails
+
+module RailsVersion
+  class Config
+    ##
+    # :singleton-method:
+    # Specify what URL this gem will ping with its information.
+    def self.server_url
+      @@server_url ||= "https://railsversion.herokuapp.com/ping"
+    end
+    def self.server_url=(v)
+      @@server_url = v
+    end
+
+    ##
+    # :singleton-method:
+    # Specify what type of ping to use.
+    # Options:
+    # :server (default: safest, server-side)
+    # :image  (embed img tag before </body>)
+    # :script (embeds external js tag)
+    def self.ping_type
+      @@ping_type ||= :server
+    end
+    def self.ping_type=(v)
+      @@ping_type = v
+    end
+
+    ##
+    # :singleton-method:
+    # Tells the client how frequent (randomly out of 10000) to ping
+    # the server. Default is 100 (1% of page loads).
+    def self.frequency
+      @@frequency ||= 100
+    end
+    def self.frequency=(v)
+      @@frequency = v
+    end
+
+    ##
+    # :singleton-method:
+    # API Key obtained from railsversion.herokuapp.com
+    def self.api_key
+      @@api_key ||= nil
+    end
+    def self.api_key=(v)
+      @@api_key = v
+    end
+  end
+end

data/lib/rails_version/pinger.rb

@@ -0,0 +1,43 @@
+module RailsVersion
+  class Pinger
+    attr_accessor :body, :version, :host
+
+    def initialize(request, response)
+      @body = response.body.to_s
+      @host = request.host.to_s
+      @version = "Non-Rails"
+      @version = Rails.version.to_s if Object.const_defined?('Rails')
+    end
+
+    def ping!
+      case RailsVersion::Config.ping_type.to_sym
+      when :server
+        require 'open-uri'
+        open(ping_url) # Ping the server.
+        return false
+      when :script
+        inject_script_before_end_body_tag(ping_script)
+      else
+        inject_script_before_end_body_tag(ping_image)
+      end
+    rescue Timeout::Error
+      false
+    end
+
+    def inject_script_before_end_body_tag(ping_html)
+      @body.sub! /<\/[bB][oO][dD][yY]>/, "#{ping_html}</body>" if @body && @body.respond_to?(:sub!)
+    end
+
+    def ping_script
+      "<script language='text/javascript' src='#{ping_url}'></script>"
+    end
+
+    def ping_image
+      "<img src='#{ping_url}' style='display:none;visibility:hidden' width='0' height='0' />"
+    end
+
+    def ping_url
+      "#{RailsVersion::Config.server_url}/#{RailsVersion::Config.api_key}/?site=#{@host}&rails_version=#{@version}"
+    end
+  end
+end

data/lib/rails_version/rails_version_mixin.rb

@@ -0,0 +1,13 @@
+module RailsVersion
+  module RailsVersionMixin
+    def ping_rails_version_server
+      # Rolls the dice. If random number is < than your frequency, trigger the script
+      raise StandardError.new("RailsVersion requires RailsVersion::Config.api_key to be set in this environment.") unless RailsVersion::Config.api_key
+      manual_ping = params[:rails_version_ping] == RailsVersion::Config.api_key
+      if manual_ping || rand(10000) < RailsVersion::Config.frequency
+        pinger = RailsVersion::Pinger.new(request, response)
+        response.body = pinger.body if pinger.ping!
+      end
+    end
+  end
+end

data/lib/rails_version/railtie.rb

@@ -0,0 +1,8 @@
+module RailsVersion
+  class Railtie < Rails::Railtie
+    initializer "rails_version" do |app|
+      ActionController::Base.send :include, RailsVersion::RailsVersionMixin
+      ActionController::Base.send :after_filter, :ping_rails_version_server
+    end
+  end
+end

data/lib/rails_version/version.rb

@@ -0,0 +1,3 @@
+module RailsVersion
+  VERSION = "0.2.2"
+end

data/rails_version.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/rails_version/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Jamon Holmgren"]
+  gem.email         = ["jamon@clearsightstudio.com"]
+  gem.description   = %q{ Pings a server and reports the current app's Rails version. }
+  gem.summary       = %q{ Pings a server and reports the current app's Rails version. }
+  gem.homepage      = "https://github.com/clearsightstudio/rails_version"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test)/})
+  gem.name          = "rails_version"
+  gem.require_paths = ["lib", "rails"]
+  gem.version       = RailsVersion::VERSION
+  gem.add_development_dependency 'actionpack'
+end

data/test/rails_version_test.rb

@@ -0,0 +1,46 @@
+require 'test/unit'
+require 'rails_version'
+require 'rails_version/pinger'
+
+class FakeRequest
+  def host
+    "www.example.com"
+  end
+end
+
+class FakeResponse
+  def body
+    "<html><body><h1>TEST</h1><p>TEST2</p></body></html>"
+  end
+end
+
+
+class RailsVersionTest < Test::Unit::TestCase
+  def test_pinger_injects_script
+    RailsVersion::Config.ping_type = :script
+    RailsVersion::Config.api_key = "TESTSCRIPT"
+    pinger = RailsVersion::Pinger.new(FakeRequest.new, FakeResponse.new)
+    pinger.ping!
+    body = pinger.body
+    assert body.include?("</script></body>")
+    assert body.include?("/TESTSCRIPT/")
+  end
+  def test_pinger_injects_image
+    RailsVersion::Config.ping_type = :image
+    RailsVersion::Config.api_key = "TESTIMAGE"
+    pinger = RailsVersion::Pinger.new(FakeRequest.new, FakeResponse.new)
+    pinger.ping!
+    body = pinger.body
+    assert body.include?("<img src='")
+    assert body.include?("/TESTIMAGE/")
+  end
+  def test_pinger_server
+    RailsVersion::Config.ping_type = :server
+    RailsVersion::Config.api_key = "TESTSERVER"
+    pinger = RailsVersion::Pinger.new(FakeRequest.new, FakeResponse.new)
+    pinger.ping!
+    # Pretty weak, I know, but at least we know the library was loaded
+    # and there aren't major syntax errors.
+    assert Object.const_defined?('Net')
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: rails_version
+version: !ruby/object:Gem::Version
+  version: 0.2.2
+  prerelease: 
+platform: ruby
+authors:
+- Jamon Holmgren
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! ' Pings a server and reports the current app''s Rails version. '
+email:
+- jamon@clearsightstudio.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/rails_version.rb
+- lib/rails_version/pinger.rb
+- lib/rails_version/rails_version_mixin.rb
+- lib/rails_version/railtie.rb
+- lib/rails_version/version.rb
+- rails_version.gemspec
+- test/rails_version_test.rb
+homepage: https://github.com/clearsightstudio/rails_version
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- rails
+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.22
+signing_key: 
+specification_version: 3
+summary: Pings a server and reports the current app's Rails version.
+test_files:
+- test/rails_version_test.rb
+has_rdoc: