voight_kampff 0.1.4 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2fda1e6dfa4eb9d13fc6e97ed8a017e6c3e0a75a
+  data.tar.gz: 82792de66dc04e759c31937bd098839ba6841e10
+SHA512:
+  metadata.gz: f10cf36a22e05ad573a979fd7e3ded7aa77a9da4fc1ea5b912e4548bab8719509f8d564bd68bea8807c5e78b623c75edc04d4188498ac8ab58dae47780c99127
+  data.tar.gz: 0d3500dd716f6ff8310d2ffede85bc3c813d6d370a1993fe075c90052212b270d56964bc1b7fdaf8f6bc9cb0e564a7a0d37025c187fe2943c4b50cfb5b04c396

data/.autotest

@@ -0,0 +1,22 @@
+#-*- ruby -*-
+# For more doc, see http://docs.seattlerb.org/ZenTest/Autotest.html
+
+require 'autotest/restart'
+
+Autotest.add_hook :initialize do |at|
+
+  at.clear_mappings
+
+  # hardcoded lib and tests path
+  at.libs = '.:lib:tests/spec'
+
+  # test lib being tested against
+  at.testlib = 'tests/spec/minitest_helper'
+
+  at.order = :random
+
+  # matches lib/test_here.rb => tests/spec/test_here.rb
+  at.add_mapping(%r%^lib/(.*)\.rb$%) { |_, m|
+    ["tests/spec/#{m[1]}_spec.rb"]
+  }
+end

data/.gitignore

@@ -0,0 +1,7 @@
+.DS_Store
+*~
+Gemfile.lock
+.bundle
+*.rbc
+coverage
+doc

data/CHANGELOG.rdoc

@@ -0,0 +1,16 @@
+== 0.1.4 (2011-09-06)
+* Handle nil user agent string
+* (@adamcrown)
+
+== 0.1.3 (2011-09-06)
+* Added httpclient dependency
+* fixed broken links in README
+*  (@halloffame)
+
+== 0.1.1 (2011-05-16)
+* Added Rails Support
+* (@adamcrown)
+
+== 0.0.0 (2011-05-11)
+* First commit
+* (@adamcrown)

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://www.rubygems.org'
+
+gem 'rake'
+
+gemspec
+
+

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    voight_kampff (0.1.4)
+      httpclient (~> 2.2)
+      nokogiri (~> 1.6.0)
+
+GEM
+  remote: https://www.rubygems.org/
+  specs:
+    httpclient (2.3.3)
+    json (1.8.0)
+    mini_portile (0.5.1)
+    minitest (4.7.5)
+    nokogiri (1.6.0)
+      mini_portile (~> 0.5.0)
+    rake (10.1.0)
+    rdoc (4.0.1)
+      json (~> 1.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest (~> 4.7)
+  rake
+  rdoc (>= 2.4.2)
+  voight_kampff!

data/README.markdown

@@ -0,0 +1,63 @@
+Voight-Kampff
+=============
+[![Build Status](https://travis-ci.org/nbit001/voight-kampff.png?branch=master)](https://travis-ci.org/nbit001/voight-kampff)
+
+Voight-Kampff relies on [user agent](http://en.wikipedia.org/wiki/User_agent) list for its detection. It can easily tell you if a request is coming from a crawler, spider or bot. This can be especially helpful in analytics such as page hit tracking.
+
+Installation
+============
+`gem install voight_kampff`
+
+Configuration
+=============
+
+A YAML file is used to match [user agent strings](http://simplyfast.info/browser) to their types.
+
+If you'd like to use an [updated list](http://www.user-agents.org/) or make your own customizations, run `rake voight_kampff:import_user_agents`. This will download a user_agents.yml file into your Rails `/config` directory.
+
+To use [Regular Expression](http://en.wikipedia.org/wiki/Regular_expression) matching, just set `string_match: regex` in your user_agent entry. The first match will be used so you should probably put your Regular Expression entries toward the bottom of the file.
+
+Usage
+=====
+There are three ways to use Voight-Kampff
+
+1. In your [Ruby on Rails](http://rubyonrails.org) controllers:  
+   `request.bot?`
+
+2. Through the `VoightKampff` module:  
+   `VoightKampff.bot? 'your user agent string'`
+
+3. Through a `VoightKampff::Test` instance:  
+   `VoightKampff::Test.new('your user agent string').bot?`
+
+All of the above examples accept `human?`, `bot?`, `browser?`, `checker?`, `downloader?`, `proxy?`, `crawler?` and `spam?` methods. All of these methods will return `true`, `false`, or `nil` (if it doesn't recognize the user agent).
+
+FAQ
+===
+__Q:__ __What's with the name?__  
+__A:__ It's the [machine in Blade Runner](http://en.wikipedia.org/wiki/Blade_Runner#Voight-Kampff_machine) that is used to test whether someone is a human or a replicant.
+
+__Q:__ __My browser isn't being matched__  
+__A:__ The list is being pulled from [user-agents.org](http://www.user-agents.org).
+If you'd  like to have entries added to the list please [create a new issue](https://github.com/biola/Voight-Kampff/issues/new) or send me a [pull request](https://github.com/biola/Voight-Kampff/pulls). And if you know of a better source for this sort of data, please [let me know](mailto:adam@obledesign.com).
+
+CONTRIBUTING
+===========
+  PR without tests will not get merged, Make sure you write tests for api and rails app.
+  Feel free to ask for help, if you do not know how to write a determined test.
+
+RUNNING TESTS?
+=============
+
+  * bundle install
+  * rake
+  * rake test #code tests
+  * rake spec #app tests
+
+AUTOMATE TESTS? Fear not
+=======================
+  * gem install autotest-standalone
+  * autotest
+  * that's it
+  * wq
+

data/Rakefile

@@ -0,0 +1,20 @@
+#require 'bundler/setup'
+require 'rake/testtask'
+
+_PATTERN_ = 'tests/spec/**/*_spec.rb'
+
+Bundler::GemHelper.install_tasks
+
+task :default => :test
+
+##
+# Setup rake test in order to
+# run minitest speclike tests
+# libs << path.. to load {minitest, spec, test}_helper.rb
+Rake::TestTask.new do |t|
+  t.libs << 'tests/spec'
+  t.pattern     = _PATTERN_
+  t.test_files  = FileList[_PATTERN_]
+  t.verbose     = false
+end
+

data/config/initializers/extend_action_dispatch_requset.rb

@@ -5,7 +5,7 @@ module ActionDispatch
     def human?
       voight_kampff_test.human?
     end
-    
+
     def bot?
       voight_kampff_test.bot?
     end
@@ -18,11 +18,11 @@ module ActionDispatch
     def checker?
       voight_kampff_test.checker?
     end
-    
+
     def downloader?
       voight_kampff_test.downloader?
     end
-    
+
     def proxy?
       voight_kampff_test.proxy?
     end
@@ -36,7 +36,7 @@ module ActionDispatch
     end
 
     private
-    
+
     def voight_kampff_test
       @voight_kampff ||= VoightKampff::Test.new(user_agent)
     end

data/lib/tasks/voight_kampff.rake

@@ -4,6 +4,7 @@ namespace :voight_kampff do
   task :import_user_agents, :url do |t, args|
     args.with_defaults :url => 'http://www.user-agents.org/allagents.xml'
     agents = VoightKampff::UserAgentsParser.new(args[:url])
+
     file = File.open(Rails.root.join('config','user_agents.yml'), 'w')
     file.write(agents.to_yaml)
   end

data/lib/voight_kampff/base.rb

@@ -0,0 +1,7 @@
+module VoightKampff
+
+
+
+
+
+end

data/lib/voight_kampff/test.rb

@@ -4,7 +4,7 @@ module VoightKampff
 
     attr_accessor :user_agent_string
     attr_accessor :types
-    
+
     def initialize(user_agent_string)
       load_agents
       @user_agent_string = user_agent_string
@@ -24,7 +24,7 @@ module VoightKampff
 
     def has_type?(*types)
       return nil if agent.empty?
-      
+
       types.any? do |type|
         @types.include? type
       end
@@ -46,11 +46,11 @@ module VoightKampff
     def checker?
       has_type? :checker
     end
-    
+
     def downloader?
       has_type? :downloader
     end
-    
+
     def proxy?
       has_type? :proxy
     end
@@ -64,21 +64,21 @@ module VoightKampff
     end
 
     private
-    
+
     def load_agents
       @@agents ||= []
       if @@agents.empty?
-      
+
         base_paths = [VoightKampff.root]
         base_paths << Rails.root if defined? Rails
         rel_path = ['config', 'user_agents.yml']
-        
+
         base_paths.any? do |base_path|
           if File.exists? base_path.join(*rel_path)
             @@agents = YAML.load(File.open(base_path.join(*rel_path), 'r'))
           end
         end
-        
+
       end
     end
 

data/lib/voight_kampff/user_agents_parser.rb

@@ -37,7 +37,7 @@ module VoightKampff
     end
 
     private
-    
+
     def clarify_type(type)
       case type.downcase.to_sym
         when :b then 'browser'

data/lib/voight_kampff/version.rb

@@ -1,5 +1,3 @@
 module VoightKampff
-
-  VERSION = '0.1.4'
-
+  VERSION = '0.2.0'
 end

data/lib/voight_kampff.rb

@@ -14,7 +14,7 @@ module VoightKampff
     def human?(user_agent_string)
       test(user_agent_string).human?
     end
-    
+
     def bot?(user_agent_string)
       test(user_agent_string).bot?
     end
@@ -27,11 +27,11 @@ module VoightKampff
     def checker?(user_agent_string)
       test(user_agent_string).checker?
     end
-    
+
     def downloader?(user_agent_string)
       test(user_agent_string).downloader?
     end
-    
+
     def proxy?(user_agent_string)
       test(user_agent_string).proxy?
     end
@@ -45,7 +45,7 @@ module VoightKampff
     end
 
     private
-    
+
     def test(user_agent_string)
       VoightKampff::Test.new(user_agent_string)
     end

data/tests/spec/minitest_helper.rb

@@ -0,0 +1,2 @@
+require 'minitest/autorun'
+require 'minitest/pride'

data/tests/spec/voight_kampff_spec.rb

@@ -0,0 +1,10 @@
+require 'minitest_helper'
+require 'voight_kampff/base.rb'
+
+class Test
+  include VoightKampff
+end
+
+describe VoightKampff do
+
+end

data/tests/test_app/.gitignore

@@ -0,0 +1,15 @@
+# See http://help.github.com/ignore-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
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp

data/tests/test_app/Gemfile

@@ -0,0 +1,39 @@
+source 'https://rubygems.org'
+
+gem 'rails', '3.2.13'
+
+# Bundle edge Rails instead:
+# gem 'rails', :git => 'git://github.com/rails/rails.git'
+
+gem 'sqlite3'
+
+gem 'voight_kampff', :path => '../../'
+
+# Gems used only for assets and not required
+# in production environments by default.
+group :assets do
+  gem 'sass-rails',   '~> 3.2.3'
+  gem 'coffee-rails', '~> 3.2.1'
+
+  # See https://github.com/sstephenson/execjs#readme for more supported runtimes
+  # gem 'therubyracer', :platforms => :ruby
+
+  gem 'uglifier', '>= 1.0.3'
+end
+
+gem 'jquery-rails'
+
+# To use ActiveModel has_secure_password
+# gem 'bcrypt-ruby', '~> 3.0.0'
+
+# To use Jbuilder templates for JSON
+# gem 'jbuilder'
+
+# Use unicorn as the app server
+# gem 'unicorn'
+
+# Deploy with Capistrano
+# gem 'capistrano'
+
+# To use debugger
+# gem 'debugger'

data/tests/test_app/Gemfile.lock

@@ -0,0 +1,123 @@
+PATH
+  remote: ../../
+  specs:
+    voight_kampff (0.1.4)
+      httpclient (~> 2.2)
+      nokogiri
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (3.2.13)
+      actionpack (= 3.2.13)
+      mail (~> 2.5.3)
+    actionpack (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.5)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.13)
+      activesupport (= 3.2.13)
+      builder (~> 3.0.0)
+    activerecord (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
+    activesupport (3.2.13)
+      i18n (= 0.6.1)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.4)
+    coffee-rails (3.2.2)
+      coffee-script (>= 2.2.0)
+      railties (~> 3.2.0)
+    coffee-script (2.2.0)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.6.3)
+    erubis (2.7.0)
+    execjs (1.4.0)
+      multi_json (~> 1.0)
+    hike (1.2.3)
+    httpclient (2.3.3)
+    i18n (0.6.1)
+    journey (1.0.4)
+    jquery-rails (3.0.4)
+      railties (>= 3.0, < 5.0)
+      thor (>= 0.14, < 2.0)
+    json (1.8.0)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.23)
+    mini_portile (0.5.1)
+    multi_json (1.7.7)
+    nokogiri (1.6.0)
+      mini_portile (~> 0.5.0)
+    polyglot (0.3.3)
+    rack (1.4.5)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.3)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (3.2.13)
+      actionmailer (= 3.2.13)
+      actionpack (= 3.2.13)
+      activerecord (= 3.2.13)
+      activeresource (= 3.2.13)
+      activesupport (= 3.2.13)
+      bundler (~> 1.0)
+      railties (= 3.2.13)
+    railties (3.2.13)
+      actionpack (= 3.2.13)
+      activesupport (= 3.2.13)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (10.1.0)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    sass (3.2.9)
+    sass-rails (3.2.6)
+      railties (~> 3.2.0)
+      sass (>= 3.1.10)
+      tilt (~> 1.3)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.7)
+    thor (0.18.1)
+    tilt (1.4.1)
+    treetop (1.4.14)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.37)
+    uglifier (2.1.2)
+      execjs (>= 0.3.0)
+      multi_json (~> 1.0, >= 1.0.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  coffee-rails (~> 3.2.1)
+  jquery-rails
+  rails (= 3.2.13)
+  sass-rails (~> 3.2.3)
+  sqlite3
+  uglifier (>= 1.0.3)
+  voight_kampff!

data/tests/test_app/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+TestApp::Application.load_tasks

data/tests/test_app/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/tests/test_app/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/tests/test_app/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>TestApp</title>
+  <%= stylesheet_link_tag    "application", :media => "all" %>
+  <%= javascript_include_tag "application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/tests/test_app/config/application.rb

@@ -0,0 +1,62 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+if defined?(Bundler)
+  # If you precompile assets before deploying to production, use this line
+  Bundler.require(*Rails.groups(:assets => %w(development test)))
+  # If you want your assets lazily compiled in production, use this line
+  # Bundler.require(:default, :assets, Rails.env)
+end
+
+module TestApp
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+
+    # Enable escaping HTML in JSON.
+    config.active_support.escape_html_entities_in_json = true
+
+    # Use SQL instead of Active Record's schema dumper when creating the database.
+    # This is necessary if your schema can't be completely dumped by the schema dumper,
+    # like if you have constraints or database-specific column types
+    # config.active_record.schema_format = :sql
+
+    # Enforce whitelist mode for mass assignment.
+    # This will create an empty whitelist of attributes available for mass-assignment for all models
+    # in your app. As such, your models will need to explicitly whitelist or blacklist accessible
+    # parameters by using an attr_accessible or attr_protected declaration.
+    config.active_record.whitelist_attributes = true
+
+    # Enable the asset pipeline
+    config.assets.enabled = true
+
+    # Version of your assets, change this if you want to expire all your assets
+    config.assets.version = '1.0'
+  end
+end

data/tests/test_app/config/boot.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])

data/tests/test_app/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/tests/test_app/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+TestApp::Application.initialize!