rails_version 0.2.3 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0fdd0f231ea942e352b396618ab67d34fdc86d76
+  data.tar.gz: 9d2b2c820ba19fdadc1d7e9d211bad7ac81bd634
+SHA512:
+  metadata.gz: d640a82922b0dab6796679c1cea309a04f94b93d0cba651f4f05f773ec0a69a55c5864d74032770590f6db334945fe17097265502bcf89d6e012f6da1b6caa1e
+  data.tar.gz: 88900041e381adc15c6ec60a737f9311ef8a0d3d6dd610ea92f2efa685b289e8f43e59f8da7dcb53a0cb95f50382178d466434c8471556178cd3336340809267

data/Gemfile

@@ -1,5 +1,6 @@
 source 'https://rubygems.org'
 
 group :development do
-  gem "rake"  
+  gem "rake"
+  gem "webmock"
 end

data/README.md

@@ -14,22 +14,25 @@ Sign up and get your API key from http://railsversion.herokuapp.com, then go to
 
     RailsVersion::Config.api_key = "API_KEY_HERE"
 
+If you have an app that has dynamic subdomains (such as multiple sites running on the same app), you can set a "canonical" App Name, so all the domains will be updated when the gem reports on one of them.
+
+    RailsVersion::Config.app_name = "CANONICAL_APP_NAME"
+
 ## Manual Ping
 
 If you want to manually trigger a ping, go to:
 
-    http://example.com/?rails_version_ping=API_KEY_HERE
+    http://yourdomain.com/?rails_version_ping=API_KEY_HERE
 
-Just replace example.com with your domain name and API_KEY_HERE with your API key.
+Just replace yourdomain.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.
+* `RailsVersion::Config.api_key = "API_KEY_HERE"` - *required* Free API key from http://railsversion.herokuapp.com.
 
 ## Code Climate
 

data/lib/rails_version.rb

@@ -9,10 +9,7 @@ module RailsVersion
     # :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
+      @@server_url = "https://railsversion.herokuapp.com/ping"
     end
 
     ##
@@ -49,5 +46,22 @@ module RailsVersion
     def self.api_key=(v)
       @@api_key = v
     end
+
+    ##
+    # :singleton-method:
+    # Canonical App Name
+    # This allows Apps that work with dynamic subdomains to update all
+    # domains on railsversion.herokuap.com with that canonical name
+    # e.g
+    #   Domain 1: example.com
+    #   Domain 2: sub.example.com
+    # When app_name is set, it will send it along to the API when it pings
+    # And both domains will be updated
+    def self.app_name
+      @@app_name ||= nil
+    end
+    def self.app_name=(v)
+      @@app_name = v
+    end
   end
 end

data/lib/rails_version/pinger.rb

@@ -1,10 +1,12 @@
 module RailsVersion
   class Pinger
-    attr_accessor :body, :version, :host
+    attr_accessor :body, :version, :host, :app_name
 
     def initialize(request, response)
+      @modified_body = false
       @body = response.body.to_s
       @host = request.host.to_s
+      @app_name = RailsVersion::Config.app_name.to_s
       @version = "Non-Rails"
       @version = Rails.version.to_s if Object.const_defined?('Rails')
     end
@@ -14,7 +16,6 @@ module RailsVersion
       when :server
         require 'open-uri'
         open(ping_url) # Ping the server.
-        return false
       when :script
         inject_script_before_end_body_tag(ping_script)
       else
@@ -24,7 +25,12 @@ module RailsVersion
       false
     end
 
+    def modified_body?
+      @modified_body
+    end
+
     def inject_script_before_end_body_tag(ping_html)
+      @modified_body = true
       @body.sub! /<\/[bB][oO][dD][yY]>/, "#{ping_html}</body>" if @body && @body.respond_to?(:sub!)
     end
 
@@ -37,7 +43,7 @@ module RailsVersion
     end
 
     def ping_url
-      "#{RailsVersion::Config.server_url}/#{RailsVersion::Config.api_key}/?site=#{@host}&rails_version=#{@version}"
+      "#{RailsVersion::Config.server_url}/#{RailsVersion::Config.api_key}/?site=#{@host}&rails_version=#{@version}&app_name=#{@app_name}"
     end
   end
-end
+end

data/lib/rails_version/rails_version_mixin.rb

@@ -6,10 +6,11 @@ module RailsVersion
       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!
+        pinger.ping!
+        response.body = pinger.body if pinger.modified_body?
       end
     rescue OpenURI::HTTPError
       nil # No HTTPError here! Nuh uh. Nope. Nothing to see here.
     end
   end
-end
+end

data/lib/rails_version/railtie.rb

@@ -5,4 +5,4 @@ module RailsVersion
       ActionController::Base.send :after_filter, :ping_rails_version_server
     end
   end
-end
+end

data/lib/rails_version/version.rb

@@ -1,3 +1,3 @@
 module RailsVersion
-  VERSION = "0.2.3"
+  VERSION = "0.3.0"
 end

data/test/rails_version_test.rb

@@ -1,4 +1,5 @@
 require 'test/unit'
+require 'webmock/minitest'
 require 'rails_version'
 require 'rails_version/pinger'
 
@@ -14,33 +15,50 @@ class FakeResponse
   end
 end
 
-
 class RailsVersionTest < Test::Unit::TestCase
+
   def test_pinger_injects_script
     RailsVersion::Config.ping_type = :script
     RailsVersion::Config.api_key = "TESTSCRIPT"
+    RailsVersion::Config.app_name = "TESTAPP"
     pinger = RailsVersion::Pinger.new(FakeRequest.new, FakeResponse.new)
     pinger.ping!
     body = pinger.body
     assert body.include?("</script></body>")
     assert body.include?("/TESTSCRIPT/")
+    assert body.include?("&app_name=TESTAPP")
   end
+
   def test_pinger_injects_image
     RailsVersion::Config.ping_type = :image
     RailsVersion::Config.api_key = "TESTIMAGE"
+    RailsVersion::Config.app_name = "TESTAPP"
     pinger = RailsVersion::Pinger.new(FakeRequest.new, FakeResponse.new)
     pinger.ping!
     body = pinger.body
     assert body.include?("<img src='")
     assert body.include?("/TESTIMAGE/")
+    assert body.include?("&app_name=TESTAPP")
   end
+
   def test_pinger_server
     RailsVersion::Config.ping_type = :server
     RailsVersion::Config.api_key = "TESTSERVER"
+    RailsVersion::Config.app_name = "TESTAPP"
+    stub_get = stub_request(:get, "https://railsversion.herokuapp.com/ping/TESTSERVER/").with(
+      query: {
+        "app_name" => "TESTAPP",
+        "rails_version" => "Non-Rails",
+        "site" => "www.example.com"
+      }
+    )
+
     pinger = RailsVersion::Pinger.new(FakeRequest.new, FakeResponse.new)
+    url = pinger.ping_url
     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')
+
+    assert url.include?("/TESTSERVER/")
+    assert url.include?("&app_name=TESTAPP")
+    assert_requested(stub_get)
   end
 end

metadata

@@ -1,47 +1,37 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rails_version
-version: !ruby/object:Gem::Version 
-  hash: 17
-  prerelease: 
-  segments: 
-  - 0
-  - 2
-  - 3
-  version: 0.2.3
+version: !ruby/object:Gem::Version
+  version: 0.3.0
 platform: ruby
-authors: 
+authors:
 - Jamon Holmgren
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-02-05 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2014-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: actionpack
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: " Pings a server and reports the current app's Rails version. "
-email: 
+email:
 - jamon@clearsightstudio.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- .gitignore
+files:
+- ".gitignore"
 - Gemfile
 - LICENSE
 - README.md
@@ -55,37 +45,27 @@ files:
 - test/rails_version_test.rb
 homepage: https://github.com/clearsightstudio/rails_version
 licenses: []
-
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
 - rails
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Pings a server and reports the current app's Rails version.
-test_files: 
+test_files:
 - test/rails_version_test.rb