is_crawler 0.0.3 → 0.1.0

data/README.md

@@ -19,7 +19,7 @@ Or install it yourself as:
 
 ## Usage
 
-You can use the `is_any_crawler?` method to determine if the given string, as you might have guessed, matches *any* (noteworthy) crawler, like so:
+You can use the `is_crawler?` method with just a user agent string to determine if the that string matches *any* (noteworthy) crawler, like so:
 
     class MyController < ActionController::Base
       include IsCrawler
@@ -32,7 +32,7 @@ You can use the `is_any_crawler?` method to determine if the given string, as yo
       end
     end
 
-...or the `is_crawler?("Some User Agent/1.0", :facebook, :google)` methods to determine if you're dealing with one or more specific crawlers. That's it!
+...or provide one or more crawlers `is_crawler?("Some User Agent/1.0", :facebook, :google)` to find out if the string matches one of those crawlers in specific. That's it!
 
 ## Contributing
 

data/Rakefile

@@ -1,6 +1,8 @@
 require "bundler/gem_tasks"
 require 'rspec/core/rake_task'
 
-RSpec::Core::RakeTask.new(:test)
+RSpec::Core::RakeTask.new(:test) do |config|
+  config.rspec_opts = "-cf d"
+end
 
 task default: [:test, :build]

data/lib/crawler.rb

@@ -25,6 +25,10 @@ class Crawler < Struct.new(:name, :ua_string)
     def matches_any? user_agent
       all.detect { |crawler| crawler.matches? user_agent } != nil
     end
+
+    def which_crawler user_agent
+      all.detect {|crawler| crawler.matches? user_agent }.name rescue nil
+    end
   end
 
   def matches? user_agent

data/lib/is_crawler/version.rb

@@ -1,3 +1,3 @@
 module IsCrawler
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/lib/is_crawler.rb

@@ -2,16 +2,11 @@ require './lib/is_crawler/version'
 require './lib/crawler'
 
 module IsCrawler
-  def is_any_crawler? requesting_user_agent
-    Crawler.matches_any? requesting_user_agent
-  end
-
   def is_crawler? requesting_user_agent, *specific_crawlers
-    crawler = which_crawler(requesting_user_agent)
-    crawler && specific_crawlers.include?(crawler.name) ? true : false
-  end
-
-  def which_crawler requesting_user_agent
-    Crawler.all.detect {|crawler| crawler.matches? requesting_user_agent }
+    if specific_crawlers && specific_crawlers.size > 0
+      specific_crawlers.include?(Crawler.which_crawler(requesting_user_agent))
+    else
+      Crawler.matches_any?(requesting_user_agent) unless specific_crawlers.size > 0
+    end
   end
 end

data/spec/is_crawler_spec.rb

@@ -1,10 +1,39 @@
 describe IsCrawler do
-  describe '#is_any_crawler?' do
-    let(:user_agent) { "Commodo Vestibulum/1.0" }
-    subject { Test.new.is_any_crawler?(user_agent) }
-    it 'defers to Crawler#matches_any?' do
-      Crawler.should_receive(:matches_any?).with(user_agent)
-      subject
+  let(:user_agent) { "Commodo Vestibulum/1.0" }
+
+  describe '#is_crawler?' do
+    context 'When specific crawlers are provided' do
+      subject { Test.new.is_crawler?(user_agent, :facebook, :google) }
+      context 'When the provided string matches a crawler' do
+        context 'and it is in the specified list' do
+          context 'as the first element' do
+            let(:user_agent) { "facebookexternalhit/1.1" }
+            it { should be_true }
+          end
+
+          context 'as a subsequent element' do
+            let(:user_agent) { "Googlebot/1.1" }
+            it { should be_true }
+          end
+        end
+
+        context 'and it is not in the specified list' do
+          let(:user_agent) { "Twitterbot/1.1" }
+          it { should be_false }
+        end
+      end
+
+      context 'When the provided string matches no crawlers' do
+        it { should be_false }
+      end
+    end
+
+    context 'When no specific crawlers are provided' do
+      subject { Test.new.is_crawler?(user_agent) }
+      it 'defers to Crawler#matches_any' do
+        Crawler.should_receive(:matches_any?).with(user_agent)
+        subject
+      end
     end
   end
 end

data/spec/lib/crawler_spec.rb

@@ -1,6 +1,6 @@
 describe Crawler do
+  let(:user_agent) { "Commodo Vestibulum/1.0" }
   describe '.matches_any?' do
-    let(:user_agent) { "Commodo Vestibulum/1.0" }
     subject { Crawler.matches_any?(user_agent) }
 
     context 'When an unknown user agent is encountered' do
@@ -20,14 +20,28 @@ describe Crawler do
   describe '#matches?' do
     Crawler.all.each do |crawler|
       describe "Comparing #{crawler.name.to_s}'s known UA string" do
-        it 'with a matching string' do
-          crawler.matches?(crawler.ua_string).should == true
+        subject { crawler.matches?(user_agent) }
+        context "with a string containing '#{crawler.ua_string}'" do
+          let(:user_agent) { "Mozilla/5.0 #{crawler.ua_string}/1.1 (KHTML, like Gecko)" }
+          it { should be_true }
         end
 
-        it 'with a non-matching string' do
-          crawler.matches?('Commodo Vestibulum/1.0').should == false
+        context 'with a non-matching string' do
+          it { should be_false }
         end
       end
     end
   end
+
+  describe '#which_crawler' do
+    subject { Crawler.which_crawler(user_agent) }
+    context 'When the provided string matches a crawler' do
+      let(:user_agent) { "facebookexternalhit/1.1" }
+      it { should == :facebook }
+    end
+
+    context 'When the provided string matches no crawlers' do
+      it { should be_nil }
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: is_crawler
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-28 00:00:00.000000000 Z
+date: 2013-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -76,7 +76,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2598137808850490808
+      hash: 737772547991189407
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -85,7 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2598137808850490808
+      hash: 737772547991189407
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24