sniffles 0.1.2 → 0.1.3

data/README.md

@@ -1,8 +1,19 @@
 # Sniffles
 ## Description
-Sniffles parses HTML pages and searches for common patterns suggesting a page is using popular CMS, CSS, and JS libraries.
+Sniffles parses HTML pages and searches for common patterns suggesting a page is using a popular CMS or advertising platform as well as CSS and JS libraries.
 
-**Work in Progress!**
+The master branch is continuously tested against Rubies 1.8.7, 1.9.2, and 1.9.3 thanks to the fantastic [Travis-CI](http://travis-ci.org/#!/ezkl/sniffles).
+
+Current CI status: [![Build Status](https://secure.travis-ci.org/ezkl/sniffles.png?branch=master)](http://travis-ci.org/ezkl/sniffles)
+
+
+### What is a sniffer?
+This library uses the term **sniffer** to refer to a pattern that determines where a page is using a particular platform or library. A sniffer may also include methods to extract other metadata once a platform or library has been identified.
+
+### Work in progress!
+Sniffles should be considered a work in progress. Many of the matching patterns are little more than regular expressions matching commonly found "Powered by" text. 
+
+If you find a bug or want to add a feature to a sniffer, [open an issue](https://github.com/ezkl/sniffles/issues/new)! The URL of an example page that Sniffles misidentifies is help. Pull requests are, of course, greatly appreciated.
 
 ## Installation
 Rubygems:
@@ -27,7 +38,7 @@ You can pass in a single sniffer:
 Or multiple sniffers:
 
     Sniffles.sniff(response.body, :google_analytics, :kissmetrics)
-    # => {:google_analytics=>{:found=>true, :ua=>"UA-185209-2"}, :kissmetrics=>{:found=>false}}
+    # => { :google_analytics=> { :found=>true, :ua=>"UA-185209-2"}, :kissmetrics=>{:found=>false} }
     
 Or an entire group of sniffers:
 
@@ -39,12 +50,18 @@ Or an entire group of sniffers:
     # :mixpanel=>{:found=>true},
     # :quantcast=>{:found=>true}}
 
-## Sniffers (v0.1.2)
+## Sniffers (v0.1.3)
+Here are a list of currently implemented sniffers, grouped by category. You can see a list of unimplemented sniffers by [filtering issues by "sniffer"](https://github.com/ezkl/sniffles/issues?labels=sniffer&state=open).
+
 ### Advertising
 * AdMeld
 * AdSense
 * BuySellAds
 * Casale
+* GumGum
+* Kontera
+* TheDeck
+* TribalFusion
 
 ### Analytics
 * ChartBeat
@@ -52,16 +69,25 @@ Or an entire group of sniffers:
 * Google Analytics
 * KISSMetrics
 * MixPanel
+* Piwik
 * Quantcast
 
 ### CMS
+* BigCommerce
 * Blogger
 * CS-Cart
+* FlatPress
+* Invision
+* Joomla
 * MovableType
+* MyBB
 * osCommerce
 * phpBB
 * Posterous
+* PrestaShop
+* Shopify
 * Tumblr
+* TypePad
 * Vanilla
 * vBulletin
 * WordPress
@@ -69,4 +95,11 @@ Or an entire group of sniffers:
 * ZenCart
 
 ### Javascript
-* jQuery
+* jQuery
+
+## Contributors
+For a complete list see [github](https://github.com/ezkl/sniffles/contributors).
+
+### Special Thanks 
+* [Jake Austwick](https://github.com/JakeAustwick)
+* [dchuk](https://github.com/dchuk)

data/lib/sniffles/sniffers/advertising/gumgum.rb

@@ -0,0 +1,24 @@
+module Sniffles
+  module Sniffers
+    class Gumgum
+      include Text
+      
+      attr_accessor :doc
+      attr_reader :output
+      
+      def initialize(response_body)
+        @output = {}        
+        parse(response_body) && process_document
+      end
+      
+      def process_document
+        @output[:found] = found?
+      end
+      
+      private
+      def found?
+        match? /cdn\.gumgum\.com/
+      end
+    end
+  end
+end

data/lib/sniffles/sniffers/advertising/kontera.rb

@@ -0,0 +1,24 @@
+module Sniffles
+  module Sniffers
+    class Kontera
+      include Text
+      
+      attr_accessor :doc
+      attr_reader :output
+      
+      def initialize(response_body)
+        @output = {}        
+        parse(response_body) && process_document
+      end
+      
+      def process_document
+        @output[:found] = found?
+      end
+      
+      private
+      def found?
+        match? /kona\.kontera\.com/
+      end
+    end
+  end
+end

data/lib/sniffles/sniffers/advertising/thedeck.rb

@@ -0,0 +1,24 @@
+module Sniffles
+  module Sniffers
+    class Thedeck
+      include Text
+      
+      attr_accessor :doc
+      attr_reader :output
+      
+      def initialize(response_body)
+        @output = {}        
+        parse(response_body) && process_document
+      end
+      
+      def process_document
+        @output[:found] = found?
+      end
+      
+      private
+      def found?
+        match? /connect\.decknetwork\.net/
+      end
+    end
+  end
+end

data/lib/sniffles/sniffers/advertising/tribalfusion.rb

@@ -0,0 +1,24 @@
+module Sniffles
+  module Sniffers
+    class Tribalfusion
+      include Text
+      
+      attr_accessor :doc
+      attr_reader :output
+      
+      def initialize(response_body)
+        @output = {}        
+        parse(response_body) && process_document
+      end
+      
+      def process_document
+        @output[:found] = found?
+      end
+      
+      private
+      def found?
+        match? /a\.tribalfusion\.com/
+      end
+    end
+  end
+end

data/lib/sniffles/sniffers/analytics/google_analytics.rb

@@ -19,7 +19,7 @@ module Sniffles
       
       private
       def found?
-        match?(/\.google\-analytics\.com|urchinTracker/i)
+        match?(/google\-analytics\.com\/ga\.js|urchinTracker/i)
       end
       
       def parse_google_analytics_ua

data/lib/sniffles/sniffers/analytics/piwik.rb

@@ -0,0 +1,24 @@
+module Sniffles
+  module Sniffers
+    class Piwik
+      include Text
+      
+      attr_accessor :doc
+      attr_reader :output
+      
+      def initialize(response_body)
+        @output = {}        
+        parse(response_body) && process_document
+      end
+      
+      def process_document
+        @output[:found] = found?
+      end
+      
+      private
+      def found?
+        match?(/Piwik\.getTracker/)
+      end
+    end
+  end
+end

data/lib/sniffles/sniffers/cms/bigcommerce.rb

@@ -0,0 +1,24 @@
+module Sniffles
+  module Sniffers
+    class Bigcommerce
+      include Text
+      
+      attr_accessor :doc
+      attr_reader :output
+      
+      def initialize(response_body)
+        @output = {}        
+        parse(response_body) && process_document
+      end
+      
+      def process_document
+        @output[:found] = found?
+      end
+      
+      private
+      def found?
+        match? /config\.ShopPath/
+      end
+    end
+  end
+end

data/lib/sniffles/sniffers/cms/flatpress.rb

@@ -0,0 +1,35 @@
+module Sniffles
+  module Sniffers
+    class Flatpress
+      include HTML
+      
+      attr_accessor :doc
+      attr_reader :output
+      
+      def initialize(response_body)
+        @output = {}        
+        parse(response_body) && process_document
+      end
+      
+      def process_document
+        if @output[:found] = found?
+          parse_version
+        end
+      end
+      
+      private
+      def found?
+        !!(meta_generator_content =~ /FlatPress/)
+      end
+      
+      def parse_version
+        version_capture = (meta_generator_content.match /FlatPress fp\-([\d]+\.[\d]+\.[\d]+)/)
+        @output[:version] = (version_capture ? version_capture[1] : false)
+      end
+
+      def meta_generator_content
+        text_at("//meta[@name='generator']/@content")
+      end
+    end
+  end
+end

data/lib/sniffles/sniffers/cms/invision.rb

@@ -0,0 +1,35 @@
+module Sniffles
+  module Sniffers
+    class Invision
+      include HTML
+      
+      attr_accessor :doc
+      attr_reader :output
+      
+      def initialize(response_body)
+        @output = {}        
+        parse(response_body) && process_document
+      end
+      
+      def process_document
+        if @output[:found] = found?
+          parse_version
+        end
+      end
+      
+      private
+      def found?
+        !!(copyright_link =~ /Forum Software by IP\.Board/)
+      end
+      
+      def parse_version
+        version_capture = (copyright_link.match /Software by IP\.Board ([\d]+\.[\d]+\.[\d]+(?: Beta [\d]+))/)
+        @output[:version] = version_capture ? version_capture[1] : false
+      end
+      
+      def copyright_link
+        text_at("//p[@id='copyright']/a")
+      end
+    end
+  end
+end

data/lib/sniffles/sniffers/cms/joomla.rb

@@ -0,0 +1,34 @@
+module Sniffles
+  module Sniffers
+    class Joomla
+      include HTML
+      
+      attr_accessor :doc
+      attr_reader :output
+      
+      def initialize(response_body)
+        @output = {}        
+        parse(response_body) && process_document
+      end
+      
+      def process_document
+        if @output[:found] = found?
+          parse_version
+        end
+      end
+      
+      private
+      def found?
+        !!(meta_generator_content =~ /Joomla!/)
+      end
+      
+      def parse_version
+        @output[:version] = (meta_generator_content =~ /Joomla! ([\d]+\.[\d]+)/ ? $1 : false)
+      end
+
+      def meta_generator_content
+        text_at("//meta[@name='generator']/@content")
+      end
+    end
+  end
+end

data/lib/sniffles/sniffers/cms/mybb.rb

@@ -0,0 +1,24 @@
+module Sniffles
+  module Sniffers
+    class Mybb
+      include HTML
+      
+      attr_accessor :doc
+      attr_reader :output
+      
+      def initialize(response_body)
+        @output = {}        
+        parse(response_body) && process_document
+      end
+      
+      def process_document
+        @output[:found] = found?
+      end
+      
+      private
+      def found?
+        !!(@doc.text =~ /Powered By MyBB/)
+      end
+    end
+  end
+end

data/lib/sniffles/sniffers/cms/prestashop.rb

@@ -0,0 +1,28 @@
+module Sniffles
+  module Sniffers
+    class Prestashop
+      include HTML
+      
+      attr_accessor :doc
+      attr_reader :output
+      
+      def initialize(response_body)
+        @output = {}        
+        parse(response_body) && process_document
+      end
+      
+      def process_document
+        @output[:found] = found?
+      end
+      
+      private
+      def found?
+        meta_generator_content == "PrestaShop"
+      end
+
+      def meta_generator_content
+        text_at("//meta[@name='generator']/@content")
+      end
+    end
+  end
+end

data/lib/sniffles/sniffers/cms/shopify.rb

@@ -0,0 +1,24 @@
+module Sniffles
+  module Sniffers
+    class Shopify
+      include Text
+      
+      attr_accessor :doc
+      attr_reader :output
+      
+      def initialize(response_body)
+        @output = {}        
+        parse(response_body) && process_document
+      end
+      
+      def process_document
+        @output[:found] = found?
+      end
+      
+      private
+      def found?
+        match? /cdn\.shopify\.com/
+      end
+    end
+  end
+end

data/lib/sniffles/sniffers/cms/typepad.rb

@@ -0,0 +1,28 @@
+module Sniffles
+  module Sniffers
+    class Typepad
+      include HTML
+      
+      attr_accessor :doc
+      attr_reader :output
+      
+      def initialize(response_body)
+        @output = {}        
+        parse(response_body) && process_document
+      end
+      
+      def process_document
+        @output[:found] = found?
+      end
+      
+      private
+      def found?
+        meta_generator_content == "http://www.typepad.com/"
+      end
+
+      def meta_generator_content
+        text_at("//meta[@name='generator']/@content")
+      end
+    end
+  end
+end