agent_orange 0.1.1 → 0.1.2

data/README.rdoc

@@ -14,12 +14,16 @@ device, or is a bot (such as Google). It was composed by using techniques gather
 several other libraries/gems in an effort to be consistent and cover as many types
 of agents as possible.
 
-== Status
+== Project Status
 
-=== Improvement stage.
+=== Stable, but needs improvement.
 
-This library is not yet testable but does function. Please contact me if you'd like
-to participate.
+This library does detect the requesting user (device, platform, os, framework, and browser with versions)
+and now has some rpsec tests. While it is stable and no large restructuring is planned, it can use
+some optimizations and improvements to the detection algorithms. The techniques currently in place
+are rather simple, and not perfect (for example, it is currently confused if it sees both Chrome and
+Safari in user agent string, and doesn't pick based on order of appearance). If you'd like to help,
+please contact me.
 
 == Installation
 
@@ -146,9 +150,16 @@ AgentOrange::Version
   
 == Maintainer
 
-* Kevin Elliott - http://kevinelliott.net
+* Kevin Elliott - http://kevinelliott.net - http://github.com/kevinelliott
 * WeLike - http://www.welikeinc.com - http://github.com/welike
 
+== Contributors
+
+A warm thank you to all contributors to the project, who have put effort and time into making this gem more useful.
+
+* David Rice (davidjrice) - RSpec tests and bug fixes.
+* Joshua Siler (eatenbyagrue) - Bot detection, initial test, and bug fixes.
+
 == License
 
 (The MIT License)

data/Rakefile

@@ -1,3 +1,14 @@
 require 'bundler/gem_tasks'
 Dir.glob('./lib/tasks/*.rake').each { |r| import r }
 
+begin
+  require 'rspec/core/rake_task'
+
+  desc "Run all specs"
+  RSpec::Core::RakeTask.new do |t|
+    # t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+    # Put spec opts in a file named .rspec in root
+  end
+
+  task :default => :spec
+end

data/agent_orange.gemspec

@@ -14,8 +14,11 @@ Gem::Specification.new do |s|
 
   s.rubyforge_project = "agent_orange"
 
-  s.files = `git ls-files`.split("\n")
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "bundler"
 
+  s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]

data/lib/agent_orange/version.rb

@@ -1,5 +1,5 @@
 module AgentOrange
-  VERSION = "0.1.1" # This is for the gem and does not conflict with the rest of the functionality
+  VERSION = "0.1.2" # This is for the gem and does not conflict with the rest of the functionality
 
   class Version
     attr_accessor :major, :minor, :patch_level, :build_number

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require File.join(File.dirname(__FILE__), "user_agent_matcher")
+
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'agent_orange'

data/spec/user_agent_matcher.rb

@@ -0,0 +1,16 @@
+class RSpec::Core::ExampleGroup
+
+  class << self
+
+    def detect(user_agent, &block)
+      klass = self.describes
+      subject = klass.new(user_agent)
+      it(user_agent) do
+        yield subject
+      end
+    end
+
+  end
+end
+
+

data/spec/user_agent_spec.rb

@@ -0,0 +1,85 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe AgentOrange::UserAgent do
+
+  describe "Safari" do
+    detect "Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_6_8; de-at) AppleWebKit/533.21.1 (KHTML, like Gecko) Version/5.0.5 Safari/533.21.1" do |ua|
+      ua.device.type.should == :computer
+      ua.device.name.should == "Computer"
+      ua.device.version.should == nil
+
+      ua.device.operating_system.name.should == "Mac OS X"
+      ua.device.operating_system.version.to_s.should == "10.6.8"
+
+      ua.device.platform.name.should == "Macintosh"
+      ua.device.platform.version.should == nil
+
+      ua.device.engine.name.should == "AppleWebKit"
+      ua.device.engine.version.to_s.should == "533.21.1"
+
+      ua.device.engine.browser.name.should == "Safari"
+      ua.device.engine.browser.version.to_s.should == "533.21.1"
+    end
+
+    detect "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_7_1) AppleWebKit/535.5 (KHTML, like Gecko) Chrome/16.0.891.1 Safari/535.5" do |ua|
+      ua.device.type.should == :computer
+      ua.device.name.should == "Computer"
+      ua.device.version.should == nil
+
+      ua.device.operating_system.name.should == "Mac OS X"
+      ua.device.operating_system.version.to_s.should == "10.7.1"
+
+      ua.device.platform.name.should == "Macintosh"
+      ua.device.platform.version.should == nil
+
+      ua.device.engine.name.should == "AppleWebKit"
+      ua.device.engine.version.to_s.should == "535.5"
+
+      ua.device.engine.browser.name.should == "Safari"
+      ua.device.engine.browser.version.to_s.should == "535.5"
+    end
+  end
+
+  describe "Firefox" do
+    detect "Mozilla/5.0 (X11; Linux i686; rv:6.0) Gecko/20100101 Firefox/6.0" do |ua|
+      ua.device.type.should == :computer
+      ua.device.name.should == "Computer"
+      ua.device.version.should == nil
+
+      ua.device.operating_system.name.should == "Linux"
+      ua.device.operating_system.version.to_s.should == "i686"
+
+      ua.device.platform.name.should == "PC"
+      ua.device.platform.version.should == nil
+
+      ua.device.engine.name.should == "Gecko"
+      ua.device.engine.version.to_s.should == "20100101"
+
+      # TODO should be Chrome.
+      ua.device.engine.browser.name.should == "Firefox"
+      ua.device.engine.browser.version.to_s.should == "6.0"
+    end
+  end
+
+  describe "Chrome" do
+    detect "Mozilla/5.0 (Windows NT 5.1) AppleWebKit/535.2 (KHTML, like Gecko) Chrome/15.0.872.0 Safari/535.2" do |ua|
+      ua.device.type.should == :computer
+      ua.device.name.should == "Computer"
+      ua.device.version.should == nil
+
+      ua.device.operating_system.name.should == "Windows"
+      ua.device.operating_system.version.to_s.should == "5.1"
+
+      ua.device.platform.name.should == "PC"
+      ua.device.platform.version.should == nil
+
+      ua.device.engine.name.should == "AppleWebKit"
+      ua.device.engine.version.to_s.should == "535.2"
+
+      # TODO should be Chrome.
+      ua.device.engine.browser.name.should == "Safari"
+      ua.device.engine.browser.version.to_s.should == "535.2"
+    end
+  end
+
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: agent_orange
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 31
   prerelease: 
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Kevin Elliott
@@ -15,9 +15,50 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-24 00:00:00 Z
-dependencies: []
-
+date: 2011-10-25 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
 description: Parse and process User Agents like a secret one
 email: 
 - kevin@welikeinc.com
@@ -45,6 +86,9 @@ files:
 - lib/agent_orange/version.rb
 - lib/tasks/allagents.xml
 - lib/tasks/bot_agent_test.rake
+- spec/spec_helper.rb
+- spec/user_agent_matcher.rb
+- spec/user_agent_spec.rb
 homepage: http://github.com/kevinelliott/agent_orange
 licenses: []
 
@@ -78,5 +122,7 @@ rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
 summary: Parse and process User Agents like a secret one
-test_files: []
-
+test_files: 
+- spec/spec_helper.rb
+- spec/user_agent_matcher.rb
+- spec/user_agent_spec.rb