browser_details 0.0.2 → 0.0.3

data/README.md

@@ -5,6 +5,26 @@ used to make a request.
 
 When possible this includes whether the browser has Javascript enabled or not.
 
+### Before
+
+    Started GET "/" for 127.0.0.1 at 2012-12-26 21:25:14 +0000
+    Processing by HomeController#index as HTML
+    ...
+    Started POST "/posts" for 127.0.0.1 at 2012-12-26 21:25:19 +0000
+    Processing by PostsController#create as HTML
+    ...
+
+### After
+
+    Started GET "/" for 127.0.0.1 at 2012-12-26 21:25:14 +0000
+    Chrome 23.0.1271.95 (Macintosh)
+    Processing by HomeController#index as HTML
+    ...
+    Started POST "/posts" for 127.0.0.1 at 2012-12-26 21:25:19 +0000
+    Chrome 23.0.1271.95 (Macintosh), JS enabled
+    Processing by PostsController#create as HTML
+    ...
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/browser_details.rb

@@ -3,27 +3,57 @@
 require "browser_details/version"
 require "useragent"
 
+# Public: Middleware for logging the browser details of each request.
+#
 class BrowserDetails
 
+  # Set up the log_message method.
   if defined?(Hatchet)
+    # If Hatchet is defined include it and define a method for its logger.
     include Hatchet
 
-    LOGGER = :hatchet
+    def log_message(env, message)
+      log.info(message)
+    end
   elsif defined?(Rails)
-    LOGGER = :rails
+    # If Rails is defined define a method for its logger.
+    def log_message(env, message)
+      Rails.logger.info(message)
+    end
   else
-    LOGGER = :rack
+    # Otherwise check if the env includes a logger and if so log to that.
+    def log_message(env, message)
+      if env['rack.logger']
+        env['rack.logger'].info(message)
+      end
+    end
   end
 
+  # Make whatever log_message method that was defined private.
+  private :log_message
+
+  # Public: Creates a new instance.
+  #
+  # app - The application this middleware is wrapping.
+  #
   def initialize(app)
     @app = app
   end
 
+  # Public: Log the browser details if possible and then forward the request on
+  # to the wrapped application.
+  #
+  # env - The environment of the request.
+  #
+  # Returns the result generated by the wrapped application.
+  #
   def call(env)
+    request = Rack::Request.new(env)
     message = []
 
-    if env['HTTP_USER_AGENT']
-      agent = UserAgent.parse(env['HTTP_USER_AGENT'])
+    # Add the user agent details to the message if present.
+    if request.user_agent
+      agent = UserAgent.parse(request.user_agent)
 
       agent_details = [agent.browser]
       agent_details << 'Mobile' if agent.mobile?
@@ -33,9 +63,12 @@ class BrowserDetails
       message << agent_details.join(' ')
     end
 
-    request = Rack::Request.new(env)
-
-    if request['utf8']
+    # Add whether Javascript is enabled or not if it is possible to tell.
+    if request.xhr?
+      # AJAX request - JS probably enabled.
+      message << 'JS enabled'
+    elsif request['utf8']
+      # Have a utf8 element - check if changed by JS.
       message << if request['utf8'] == '✓'
         'JS disabled'
       else
@@ -43,26 +76,16 @@ class BrowserDetails
       end
     end
 
+    # Log a message if any details were gathered.
     unless message.empty?
       log_message(env, message.join(', '))
     end
 
+    # Delegate to the application we are wrapping.
     @app.call(env)
   end
 
-  def log_message(env, message)
-    case LOGGER
-    when :hatchet
-      log.info(message)
-    when :rails
-      Rails.logger.info(message)
-    when :rack
-      if env['rack.logger']
-        env['rack.logger'].info(message)
-      end
-    end
-  end
-
 end
 
+# Require the Railtie if Rails is present.
 require 'browser_details/railtie' if defined?(Rails)

data/lib/browser_details/railtie.rb

@@ -1,5 +1,8 @@
 class BrowserDetails
 
+  # Public: Railtie for initializing the BrowserDetails middleware and making
+  # the browser_details.js file available.
+  #
   class Railtie < Rails::Railtie
     initializer "browser_details.insert_middleware" do |app|
       app.config.middleware.use BrowserDetails

data/lib/browser_details/version.rb

@@ -1,3 +1,5 @@
 class BrowserDetails
-  VERSION = "0.0.2"
+
+  VERSION = "0.0.3"
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: browser_details
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors: