is_crawler 0.1.0 → 0.1.1

data/README.md

@@ -19,7 +19,7 @@ Or install it yourself as:
 
 ## Usage
 
-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:
+You can use the `is_crawler?` method with just a user agent string to determine if the that string matches *any* known crawler, like so:
 
     class MyController < ActionController::Base
       include IsCrawler
@@ -32,7 +32,13 @@ You can use the `is_crawler?` method with just a user agent string to determine
       end
     end
 
-...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!
+...or provide one or more crawlers to find out if the string matches *specific* crawlers: `is_crawler?("Some User Agent/1.0", :facebook, :google)`
+
+You can also define custom crawlers like this:
+
+    Crawler::CUSTOM << Crawler.new(:custom_crawler_name, "string that is always present in crawler requests")
+
+That's it!
 
 ## Contributing
 

data/lib/crawler.rb

@@ -1,25 +1,29 @@
 class Crawler < Struct.new(:name, :ua_string)
+  DEFAULT = [
+              Crawler.new(:addthis, "AddThis.com"),
+              Crawler.new(:alexa, "ia_archiver"),
+              Crawler.new(:archive_org, "archive.org_bot"),
+              Crawler.new(:bing, "bingbot"),
+              Crawler.new(:bitly, "bitlybot"),
+              Crawler.new(:exabot, "Exabot"),
+              Crawler.new(:facebook, "facebookexternalhit"),
+              Crawler.new(:flipboard, "FlipboardProxy"),
+              Crawler.new(:google, "Googlebot"),
+              Crawler.new(:google_web_preview, "Google Web Preview"),
+              Crawler.new(:msn, "MSNBot"),
+              Crawler.new(:openwebspider, "OpenWebSpider"),
+              Crawler.new(:technorati, "Technoratibot"),
+              Crawler.new(:twitter, "Twitterbot"),
+              Crawler.new(:yahoo, "Yahoo! Slurp"),
+              Crawler.new(:yahoo_jp, "Y!J"),
+              Crawler.new(:yandex, "Yandex")
+            ].freeze
+
+  CUSTOM = []
+
   class << self
     def all
-      [
-        Crawler.new(:addthis, "AddThis.com"),
-        Crawler.new(:alexa, "ia_archiver"),
-        Crawler.new(:archive_org, "archive.org_bot"),
-        Crawler.new(:bing, "bingbot"),
-        Crawler.new(:bitly, "bitlybot"),
-        Crawler.new(:exabot, "Exabot"),
-        Crawler.new(:facebook, "facebookexternalhit"),
-        Crawler.new(:flipboard, "FlipboardProxy"),
-        Crawler.new(:google, "Googlebot"),
-        Crawler.new(:google_web_preview, "Google Web Preview"),
-        Crawler.new(:msn, "MSNBot"),
-        Crawler.new(:openwebspider, "OpenWebSpider"),
-        Crawler.new(:technorati, "Technoratibot"),
-        Crawler.new(:twitter, "Twitterbot"),
-        Crawler.new(:yahoo, "Yahoo! Slurp"),
-        Crawler.new(:yahoo_jp, "Y!J"),
-        Crawler.new(:yandex, "Yandex")
-      ]
+      DEFAULT + CUSTOM
     end
 
     def matches_any? user_agent

data/lib/is_crawler/version.rb

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

data/spec/lib/crawler_spec.rb

@@ -44,4 +44,44 @@ describe Crawler do
       it { should be_nil }
     end
   end
+
+  describe 'Custom Crawler' do
+    let(:custom_crawler) { Crawler.new(:custom, "Custom/1.0") }
+    before { Crawler::CUSTOM << custom_crawler }
+    context '.matches_any' do
+      subject { Crawler.matches_any?(user_agent) }
+      context 'When the provided string matches the custom crawler' do
+        let(:user_agent) { "Custom/1.0" }
+        it { should be_true }
+      end
+
+      context 'When the provided string does not match the custom crawler' do
+        it { should be_false }
+      end
+    end
+
+    context '.which_crawler' do
+      subject { Crawler.which_crawler(user_agent) }
+      context 'When the provided string matches the custom crawler' do
+        let(:user_agent) { "Custom/1.0" }
+        it { should be custom_crawler.name }
+      end
+
+      context 'When the provided string does not match the custom crawler' do
+        it { should_not be custom_crawler.name }
+      end
+    end
+
+    context '#matches?' do
+      subject { custom_crawler.matches?(user_agent) }
+      context 'When the provided string matches the custom crawler' do
+        let(:user_agent) { "Custom/1.0" }
+        it { should be_true }
+      end
+
+      context 'When the provided string does not match the custom crawler' do
+        it { should be_false }
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: is_crawler
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -76,7 +76,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 737772547991189407
+      hash: 4337176170739540644
 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: 737772547991189407
+      hash: 4337176170739540644
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24