browser_details 0.0.4 → 0.0.5

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MzNjYTU4NzkzMzIyMGY5NGZmNmYyNzI0YjQyZGY0MzQ3MTUxMDdjMg==
+  data.tar.gz: !binary |-
+    ZDkxYjMxZGIxMDU2YjQ3YzlkYjg5ZjM2ZTAxYzU5MGQ5ODg5NGE5Yw==
+SHA512:
+  metadata.gz: !binary |-
+    NWNhY2Y4ZWYyZGEwYzcwOTJkZDQ4ZDY0Y2FhOTZlYWYxZmRkNmUzMjJlYzk5
+    NjM5ZDExNmE0YjgwMzg1MTczZGI5MDRiZTA0NDJjZjBiMjcwODc4NTJiZGU3
+    MDM3NTBiODlmZDU5MTQ5ZmMwNTg4M2ViZmNlYjViZmM0Y2I1YWE=
+  data.tar.gz: !binary |-
+    MWEwZGYzZGZkZDViNjU4OWE4ZmE4ZWY1N2M0MDAxOTRkMTk0MTAzYWNhMzRl
+    MjYxMGYwYmY4ZDUyYjU4NmJiMzk0ZjgxZDMwYjk5MzNjOTc0NWI2Zjk5YmFm
+    MzJlZTk3MTYwODM3Yzc1ODhjMTM2YjZiNDJkMGMyMGE2NGVlN2E=

data/README.md

@@ -1,9 +1,19 @@
 # Browser Details
 
-Browser Details is a Rack Middleware that logs information about the browser
-used to make a request.
+Have you ever had the conversation:
+
+> **Your site doesn't work.**  
+> What browser are you using and do you have Javascript enabled?
+>
+> **What's a browser?**  
+> :unamused:
+
+Browser Details makes that problem disappear by capturing a user's browser
+details in your logs. You will get the exact browser version they are using and
+their OS dumped into your logs, and when possible you'll get whether they have
+JS enabled too. All entirely unobtrustively.
 
-When possible this includes whether the browser has Javascript enabled or not.
+You may never need to speak to a user ever again!
 
 ### Before
 
@@ -17,14 +27,20 @@ When possible this includes whether the browser has Javascript enabled or not.
 ### After
 
     Started GET "/" for 127.0.0.1 at 2012-12-26 21:25:14 +0000
-    Chrome 23.0.1271.95 (Macintosh)
+    Chrome 23.0.1271.95 (Macintosh, Intel Mac OS X 10_7_5)
     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
+    Chrome 23.0.1271.95 (Macintosh, Intel Mac OS X 10_7_5), JS enabled
     Processing by PostsController#create as HTML
     ...
 
+### How?
+
+Browser Details is a Rack Middleware that logs information about the browser
+used to make a request. When possible this includes whether the browser has
+Javascript enabled or not.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -68,6 +84,14 @@ The Javascript detection is currently reliant on Rails. If you would like your
 application to be able to detect whether Javascript is enabled too, please
 create an issue, or even better open a pull request.
 
+### Custom usage
+
+If you want to use the message elsewhere, you can request the message directly:
+
+```ruby
+details = BrowserDetails.message(request)
+```
+
 ## Contributing
 
 1. Fork it

data/lib/browser_details.rb

@@ -6,7 +6,6 @@ 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.
@@ -49,6 +48,24 @@ class BrowserDetails
   #
   def call(env)
     request = Rack::Request.new(env)
+    message = self.class.message(request)
+
+    # Log a message if any details were gathered.
+    unless message.empty?
+      log_message(env, message)
+    end
+
+    # Delegate to the application we are wrapping.
+    @app.call(env)
+  end
+
+  # Public: Creates a browser details message for a request.
+  #
+  # request - The Rack::Request to extract brower details from.
+  #
+  # Returns a String of browser details for the request.
+  #
+  def self.message(request)
     message = []
 
     # Add the user agent details to the message if present.
@@ -68,23 +85,18 @@ class BrowserDetails
       # AJAX request - JS probably enabled.
       message << 'JS enabled'
     elsif request['utf8']
-      # Have a utf8 element - check if changed by JS.
+      # Have a utf8 parameter - check if changed by JS.
       message << if request['utf8'] == '✓'
+        # Value unchanged - JS was not executed and therefore disabled.
         'JS disabled'
       else
+        # Value changed - JS was executed and therefore enabled.
         'JS enabled'
       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)
+    message.join(', ')
   end
-
 end
 
 # Require the Railtie if Rails is present.

data/lib/browser_details/version.rb

@@ -1,5 +1,5 @@
 class BrowserDetails
 
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 
 end

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: browser_details
 version: !ruby/object:Gem::Version
-  version: 0.0.4
-  prerelease: 
+  version: 0.0.5
 platform: ruby
 authors:
 - Garry Shutler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-27 00:00:00.000000000 Z
+date: 2013-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: useragent
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -43,28 +40,26 @@ files:
 - README.md
 homepage: https://github.com/gshutler/browser_details
 licenses: []
+metadata: {}
 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.24
+rubygems_version: 2.1.11
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Browser Details is a Rack Middleware that logs information about the browser
   used to make a request
 test_files: []
-has_rdoc: