Rack::SimpleUserAgent is stupidly simple UA detector
Ruby Shell
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
lib/rack
sample/sinatra
test
.gitignore
.travis.yml
CODE_OF_CONDUCT.md
Gemfile
LICENSE.txt
README.md
Rakefile
rack-simple_user_agent.gemspec

README.md

Rack::SimpleUserAgent

Gem Version Build Status Coverage Status Code Climate Dependency Status

Rack::SimpleUserAgent is Rack::Request extension which detects user-agent from user-agent string. No complicated logic for the detection, it simply(stupidly) checks if user-agent includes particular string or not.

Installation

Add this line to your application's Gemfile:

gem 'rack-simple_user_agent'

Available Detection Methods

request ─ from_smartdevice?
        │ ├─ from_ios?
        │ ├─ from_android?
        │ └─ from_windows_phone?
        │
        ├ from_smartphone?
        │ ├─ from_android_mobile?
        │ ├─ from_iphone?
        │ ├─ from_ipod?
        │ └─ from_windows_phone?
        │
        ├ from_tablet?
        │ ├─ from_ipad?
        │ └─ from_android_tablet?
        │
        └ from_googlebot?
          ├─ from_googlebot_news?
          ├─ from_googlebot_images?
          └─ from_googlebot_video?

Usage

on Rails

Installing rack-simple_user_agent automatically makes all detection methods available.

Action Pack Variants Usage

These methods are useful when you use the Rails' Action Pack Variants (as of Rails4.1).

class ApplicationController < ActionController::Base
  before_action :set_request_variant

  def set_request_variant
    request.variant = :smartphone if request.from_smartphone?
  end
end

Then, you can use two types of view. For example:

app/views/projects/show.html.erb
app/views/projects/show.html+smartphone.erb

on Sinatra

require "sinatra"
require "rack/simple_user_agent"

configure do
  use Rack::SimpleUserAgent
end

get "/" do
  if request.from_smartphone?
    "Hello World from smartphone"
  elsif request.from_tablet?
    "Hello World from tablet"
  else
    "Hello World"
  end
end

Testing

bundle exec rake test

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/toshimaru/rack-simple_user_agent. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.