Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/toshimaru/rack-simple_user_agent
Rack::SimpleUserAgent is stupidly simple UA detector
https://github.com/toshimaru/rack-simple_user_agent
gem rack rails sinatra
Last synced: about 2 months ago
JSON representation
Rack::SimpleUserAgent is stupidly simple UA detector
- Host: GitHub
- URL: https://github.com/toshimaru/rack-simple_user_agent
- Owner: toshimaru
- License: mit
- Created: 2016-04-18T14:39:29.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2024-09-01T21:10:33.000Z (4 months ago)
- Last Synced: 2024-10-11T23:19:55.072Z (3 months ago)
- Topics: gem, rack, rails, sinatra
- Language: Ruby
- Homepage:
- Size: 80.1 KB
- Stars: 13
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Rack::SimpleUserAgent
[](https://badge.fury.io/rb/rack-simple_user_agent)
[](https://codeclimate.com/github/toshimaru/rack-simple_user_agent/test_coverage)
[](https://codeclimate.com/github/toshimaru/rack-simple_user_agent)
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`:
```ruby
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](http://guides.rubyonrails.org/4_1_release_notes.html#action-pack-variants) (as of Rails4.1).
```rb
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
```rb
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
```bash
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](https://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](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the BundledGem project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](./CODE_OF_CONDUCT.md).