rack-user_agent 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d29f9a9c7d2bf94c948b6a8af1f27a2d791a7544
+  data.tar.gz: 858b3d9b30b8c877fb7b6d68e0d397f22c99d3c4
+SHA512:
+  metadata.gz: cd37882adcb3e5479dcf607eb2afcc94702f9c312309d9f2edeaec30c9bdfcce96d90e11c52cbd99fb695b031895a41e8eb5ee57d83b854d20e3497e437b33ac
+  data.tar.gz: 3522df8a6a7c2dda33b29c1c6a144dde3c075e5c7ef34e741419f313a6b4b52c602c6fa9f17be6b8f6a9a1aeb94ce6aa96b05db8c484e31aa0f05a029c4d731b

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,7 @@
+rvm:
+- 2.1.5
+branches:
+  only:
+    - master
+script:
+  - "bundle exec rake"

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rack-user_agent.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Takashi Kokubun
+
+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,97 @@
+# Rack::UserAgent [![Build Status](https://travis-ci.org/k0kubun/rack-user_agent.svg)](https://travis-ci.org/k0kubun/rack-user_agent)
+
+Rack::Request extension for handling User-Agent.  
+Thanks to [woothee](https://github.com/woothee/woothee-ruby), Rack::UserAgent supports various User-Agents.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack-user_agent'
+```
+
+## Usage
+
+### Rails
+
+If you bundle "rack-user\_agent", Rack::UserAgent will be automatically inserted when started.  
+Additional methods for `request` will be available with no cost.
+
+```ruby
+class ApplicationController < ActionController::Base
+  before_action :set_request_variant
+
+  def index
+    request.user_agent       #=> "Mozilla/5.0 (Macintosh; ..."
+    request.device_type      #=> :pc
+    request.os               #=> "Mac OSX"
+    request.browser          #=> "Chrome"
+    request.from_pc?         #=> true
+    request.from_smartphone? #=> false
+  end
+
+  private
+
+  # It is useful for Action Pack variants, which is new feature from Rails 4.1.
+  # You can switch view templates by +pc or +smartphone in file name.
+  # http://guides.rubyonrails.org/4_1_release_notes.html#action-pack-variants
+  def set_request_variant
+    request.variant = request.device_type # :pc, :smartphone
+  end
+end
+```
+
+### Sinatra
+
+You can also manually use Rack::UserAgent for any Rack apps.
+
+```ruby
+require "sinatra"
+require "rack/user_agent"
+
+configure do
+  use Rack::UserAgent
+end
+
+get "/" do
+  request.user_agent       #=> "Mozilla/5.0 (Linux; Android 4.3; Nexus 7 ..."
+  request.device_type      #=> :smartphone
+  request.os               #=> "Android"
+  request.os_version       #=> "4.3"
+  request.browser          #=> "Chrome"
+  request.browser_version  #=> "29.0.1547.72"
+  request.from_smartphone? #=> true
+end
+```
+
+## Available Methods
+
+### Attributes
+- request.device\_type
+- request.os
+- request.os\_version
+- request.browser
+- request.browser\_version
+- request.browser\_vendor
+
+### Helpers
+- request.from\_pc?
+- request.from\_smartphone?
+- request.from\_mobilephone?
+- request.from\_appliance?
+- request.from\_crawler?
+
+### Detectors
+APIs compatible with [rack-smartphone\_detector](https://github.com/ihara2525/rack-smartphone_detector)
+
+- request.smartphone\_version
+- request.from\_iphone?
+- request.from\_ipad?
+- request.from\_android?
+- request.from\_android\_tablet?
+- request.from\_windows\_phone?
+
+## License
+
+MIT License

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new { |t| t.pattern = "spec/**/*_spec.rb" }
+
+task default: :test
+

data/lib/rack/user_agent.rb

@@ -0,0 +1,25 @@
+require "woothee"
+require "rack/user_agent/checker"
+require "rack/user_agent/detector"
+require "rack/user_agent/result"
+require "rack/user_agent/version"
+require 'rack/user_agent/railtie' if defined?(Rails::Railtie)
+
+module Rack
+  class UserAgent
+    def initialize(app, options = {})
+      @app = app
+    end
+
+    def call(env)
+      env["rack.woothee"] = ::Woothee.parse(env["HTTP_USER_AGENT"] || "")
+      @app.call(env)
+    end
+  end
+
+  class Request
+    include Rack::UserAgent::Checker
+    include Rack::UserAgent::Detector
+    include Rack::UserAgent::Result
+  end
+end

data/lib/rack/user_agent/checker.rb

@@ -0,0 +1,29 @@
+require "rack/user_agent/result"
+
+module Rack
+  class UserAgent
+    module Checker
+      include Result
+
+      def from_pc?
+        device_type == :pc
+      end
+
+      def from_smartphone?
+        device_type == :smartphone
+      end
+
+      def from_mobilephone?
+        device_type == :mobilephone
+      end
+
+      def from_appliance?
+        device_type == :appliance
+      end
+
+      def from_crawler?
+        device_type == :crawler
+      end
+    end
+  end
+end

data/lib/rack/user_agent/detector.rb

@@ -0,0 +1,49 @@
+require "rack/user_agent/result"
+
+# This module aims to provide APIs compatible with:
+# https://github.com/ihara2525/rack-smartphone_detector
+module Rack
+  class UserAgent
+    module Detector
+      include Result
+
+      def smartphone_version
+        suppress_unknown(os_version)
+      end
+
+      def from_iphone?
+        os == "iPhone"
+      end
+
+      def from_ipad?
+        os == "iPad"
+      end
+
+      def from_android?
+        os == "Android" && android_mobile?
+      end
+
+      def from_android_tablet?
+        os == "Android" && !android_mobile?
+      end
+
+      def from_windows_phone?
+        os == "Windows Phone OS"
+      end
+
+      private
+
+      def android_mobile?
+        (user_agent =~ /Android.+Mobi(le)?/).nil?.!
+      end
+
+      def suppress_unknown(version)
+        if version == "UNKNOWN"
+          nil
+        else
+          version
+        end
+      end
+    end
+  end
+end

data/lib/rack/user_agent/railtie.rb

@@ -0,0 +1,9 @@
+module Rack
+  class UserAgent
+    class Railtie < ::Rails::Railtie
+      initializer "rack-user_agent.configure_rails_initialization" do |app|
+        app.config.middleware.insert_before(ActionDispatch::ParamsParser, Rack::UserAgent)
+      end
+    end
+  end
+end

data/lib/rack/user_agent/result.rb

@@ -0,0 +1,35 @@
+module Rack
+  class UserAgent
+    module Result
+      def device_type
+        woothee_result[:category]
+      end
+
+      def os
+        woothee_result[:os]
+      end
+
+      def os_version
+        woothee_result[:os_version]
+      end
+
+      def browser
+        woothee_result[:name]
+      end
+
+      def browser_version
+        woothee_result[:version]
+      end
+
+      def browser_vendor
+        woothee_result[:vendor]
+      end
+
+      private
+
+      def woothee_result
+        env["rack.woothee"]
+      end
+    end
+  end
+end

data/lib/rack/user_agent/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class UserAgent
+    VERSION = "0.2.1"
+  end
+end

data/rack-user_agent.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/user_agent/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-user_agent"
+  spec.version       = Rack::UserAgent::VERSION
+  spec.authors       = ["Takashi Kokubun"]
+  spec.email         = ["takashikkbn@gmail.com"]
+  spec.summary       = %q{Rack::Request extension for handling User-Agent.}
+  spec.description   = %q{Rack::Request extension for handling User-Agent.}
+  spec.homepage      = "https://github.com/k0kubun/rack-user_agent"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rack", "~> 1.5"
+  spec.add_dependency "woothee", "~> 1.0.0"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "rack-test"
+end

data/rails_sample/.gitignore

@@ -0,0 +1,16 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp

data/rails_sample/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+gem 'rails', '4.1.5'
+gem 'sqlite3'
+gem 'sass-rails', '~> 4.0.3'
+gem 'uglifier', '>= 1.3.0'
+gem 'coffee-rails', '~> 4.0.0'
+gem 'jquery-rails'
+gem 'turbolinks'
+gem 'jbuilder', '~> 2.0'
+gem 'sdoc', '~> 0.4.0',          group: :doc
+gem 'spring',        group: :development
+gem 'pry'
+
+gem 'rack-user_agent', path: '..'

data/rails_sample/Gemfile.lock

@@ -0,0 +1,142 @@
+PATH
+  remote: ..
+  specs:
+    rack-user_agent (0.0.1)
+      rack (~> 1.5)
+      woothee (~> 1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.1.5)
+      actionpack (= 4.1.5)
+      actionview (= 4.1.5)
+      mail (~> 2.5.4)
+    actionpack (4.1.5)
+      actionview (= 4.1.5)
+      activesupport (= 4.1.5)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    actionview (4.1.5)
+      activesupport (= 4.1.5)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+    activemodel (4.1.5)
+      activesupport (= 4.1.5)
+      builder (~> 3.1)
+    activerecord (4.1.5)
+      activemodel (= 4.1.5)
+      activesupport (= 4.1.5)
+      arel (~> 5.0.0)
+    activesupport (4.1.5)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    arel (5.0.1.20140414130214)
+    builder (3.2.2)
+    coderay (1.1.0)
+    coffee-rails (4.0.1)
+      coffee-script (>= 2.2.0)
+      railties (>= 4.0.0, < 5.0)
+    coffee-script (2.3.0)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.8.0)
+    erubis (2.7.0)
+    execjs (2.2.2)
+    hike (1.2.3)
+    i18n (0.6.11)
+    jbuilder (2.2.5)
+      activesupport (>= 3.0.0, < 5)
+      multi_json (~> 1.2)
+    jquery-rails (3.1.2)
+      railties (>= 3.0, < 5.0)
+      thor (>= 0.14, < 2.0)
+    json (1.8.1)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    method_source (0.8.2)
+    mime-types (1.25.1)
+    minitest (5.4.3)
+    multi_json (1.10.1)
+    polyglot (0.3.5)
+    pry (0.10.0)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (4.1.5)
+      actionmailer (= 4.1.5)
+      actionpack (= 4.1.5)
+      actionview (= 4.1.5)
+      activemodel (= 4.1.5)
+      activerecord (= 4.1.5)
+      activesupport (= 4.1.5)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.1.5)
+      sprockets-rails (~> 2.0)
+    railties (4.1.5)
+      actionpack (= 4.1.5)
+      activesupport (= 4.1.5)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.3.2)
+    rdoc (4.1.2)
+      json (~> 1.4)
+    sass (3.2.19)
+    sass-rails (4.0.4)
+      railties (>= 4.0.0, < 5.0)
+      sass (~> 3.2.2)
+      sprockets (~> 2.8, < 2.12)
+      sprockets-rails (~> 2.0)
+    sdoc (0.4.1)
+      json (~> 1.7, >= 1.7.7)
+      rdoc (~> 4.0)
+    slop (3.6.0)
+    spring (1.1.3)
+    sprockets (2.11.3)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.2.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (>= 2.8, < 4.0)
+    sqlite3 (1.3.10)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    tilt (1.4.1)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    turbolinks (2.5.2)
+      coffee-rails
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    uglifier (2.5.3)
+      execjs (>= 0.3.0)
+      json (>= 1.8.0)
+    woothee (1.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  coffee-rails (~> 4.0.0)
+  jbuilder (~> 2.0)
+  jquery-rails
+  pry
+  rack-user_agent!
+  rails (= 4.1.5)
+  sass-rails (~> 4.0.3)
+  sdoc (~> 0.4.0)
+  spring
+  sqlite3
+  turbolinks
+  uglifier (>= 1.3.0)