cookie_extractor 0.1.0 → 0.2.0

data/README.md

@@ -1,15 +1,26 @@
 cookie_extractor
 ----------------
 
-Extract cookies from Firefox sqlite cookie store (eventually Chrome also) into a wget-compatible cookies.txt file.
+Extract cookies from Firefox, Chrome or Chromium sqlite cookie stores into a wget-compatible cookies.txt file.
 
 ### Install ###
 
-gem install cookie_extractor
+    gem install cookie_extractor
 
 ### Usage ###
 
-cookie_extractor /path/to/firefox/cookies.sqlite > cookies.txt
+    cookie_extractor /path/to/firefox/cookies.sqlite > cookies.txt
+    
+    cookie_extractor --guess    # Guess which browser to use and open corresponding file
+    
+    cookie_extractor --browser chrome|chromium|firefox    # Open corresponding  DB
+
+
+Typical locations for the cookies file on Linux are:
+
+ * Firefox: *~/.mozilla/firefox/(profile directory)/cookies.sqlite*
+ * Chrome: *~/.config/google-chrome/Default/Cookies*
+ * Chromium: *~/.config/chromium/Default/Cookies*
 
 ### License ###
 

data/bin/cookie_extractor

@@ -2,22 +2,46 @@
 
 require File.expand_path(File.join(File.dirname(__FILE__), "..", "lib", "cookie_extractor"))
 
-# TODO: Locate cookie dbs automatically
-filename = ARGV.first
-unless filename
-  puts "Usage: (Firefox) cookie_extractor /path/to/cookies.sqlite"
-  puts "       (Chrome)  cookie_extractor /path/to/Cookies"
+
+def usage msg=nil
+  puts msg if msg
+  puts "Usage: cookie_extractor /path/to/cookies.sqlite              Open a DB file"
+  puts "       cookie_extractor --guess                              Guess which browser to use and open corresponding file"
+  puts "       cookie_extractor --browser chrome|chromium|firefox    Open DB corresponding to a particular browser"
   exit
 end
 
-if File.exists?(filename)
-  begin
-    extractor = CookieExtractor::BrowserDetector.new_extractor(filename)
-    puts extractor.extract.join("\n")
-  rescue SQLite3::NotADatabaseException,
-    CookieExtractor::BrowserNotDetectedException
-    puts "Error: File '#{filename}' is not a Firefox or Chrome cookie database"
-  end
-else
-  puts "Error: File '#{filename}' does not exist"
+
+begin
+  extractor =
+    case ARGV.first
+    when '--guess', '-g'
+      begin
+        CookieExtractor::BrowserDetector.guess()
+      rescue CookieExtractor::NoCookieFileFoundException
+        abort "Error: we couldn't find any supported broswer's cookies"
+      end
+    when '--browser', '-b'
+      browser = ARGV[1]
+      usage "Error: Please supply a browser name" unless browser
+      begin
+        CookieExtractor::BrowserDetector.browser_extractor(browser)
+      rescue CookieExtractor::InvalidBrowserNameException
+        abort "Error: '#{browser}' is not a valid browser name"
+      rescue CookieExtractor::NoCookieFileFoundException
+        abort "Error: Could not locate cookie file for browser #{browser}"
+      end
+    when nil
+      usage
+    else
+      filename = ARGV.first
+      abort "Error: #{filename} does not exist" unless File.exists?(filename)
+      CookieExtractor::BrowserDetector.new_extractor(filename)
+    end
+  puts extractor.extract.join("\n")
+rescue SQLite3::NotADatabaseException,
+  CookieExtractor::BrowserNotDetectedException        
+  abort "Error: File '#{filename}' is not a Firefox or Chrome cookie database"
 end
+
+

data/lib/cookie_extractor/browser_detector.rb

@@ -1,7 +1,40 @@
 module CookieExtractor
   class BrowserNotDetectedException < Exception; end
+  class InvalidBrowserNameException < Exception; end
+  class NoCookieFileFoundException < Exception; end
 
   class BrowserDetector
+    COOKIE_LOCATIONS = {
+      "chrome" => "~/.config/google-chrome/Default/Cookies",
+      "chromium" => "~/.config/chromium/Default/Cookies",
+      "firefox" => "~/.mozilla/firefox/*.default/cookies.sqlite"
+    }
+
+    # Returns the extractor of the most recently used browser's cookies
+    #   or raise NoCookieFileFoundException if there are no cookies
+    def self.guess
+      most_recently_used_detected_browsers.each { |browser, path|
+        begin
+          extractor = self.browser_extractor(browser)
+        rescue BrowserNotDetectedException, NoCookieFileFoundException
+          # better try the next one...
+        else
+          return extractor
+        end
+      }
+      # If we make it here, we've failed...
+      raise NoCookieFileFoundException, "Couldn't find any browser's cookies"
+    end
+
+    # Open a browser's cookie file using intelligent guesswork
+    def self.browser_extractor(browser)
+      raise InvalidBrowserNameException, "Browser must be one of: #{self.supported_browsers.join(', ')}" unless self.supported_browsers.include?(browser)
+      paths = Dir.glob(File.expand_path(COOKIE_LOCATIONS[browser]))
+      if paths.length < 1 or not File.exists?(paths.first)
+        raise NoCookieFileFoundException, "File #{paths.first} does not exist!"
+      end
+      self.new_extractor(paths.first)
+    end
 
     def self.new_extractor(db_filename)
       browser = detect_browser(db_filename)
@@ -12,6 +45,10 @@ module CookieExtractor
       end
     end
 
+    def self.supported_browsers
+      COOKIE_LOCATIONS.keys
+    end
+
     def self.detect_browser(db_filename)
       db = SQLite3::Database.new(db_filename)
       browser = 
@@ -27,5 +64,15 @@ module CookieExtractor
     def self.has_table?(db, table_name)
       db.table_info(table_name).size > 0
     end
+
+    def self.most_recently_used_detected_browsers
+      COOKIE_LOCATIONS.select { |browser, path|
+        Dir.glob(File.expand_path(path)).any?
+      }.sort_by { |browser, path|
+        File.mtime(Dir.glob(File.expand_path(path)).first)
+      }.reverse
+    end
+
+    private_class_method :most_recently_used_detected_browsers
   end
 end

data/lib/cookie_extractor/version.rb

@@ -1,3 +1,3 @@
 module CookieExtractor
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/cookie_extractor.rb

@@ -1,3 +1,6 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
 require "cookie_extractor/version"
 require "cookie_extractor/common"
 require "cookie_extractor/firefox_cookie_extractor"

data/spec/browser_detector_spec.rb

@@ -41,3 +41,40 @@ describe CookieExtractor::BrowserDetector, "determining the correct extractor to
     end
   end
 end
+
+describe CookieExtractor::BrowserDetector, "guessing the location of the cookie file" do
+  describe "when no cookie files are found in the standard locations" do
+    before :each do
+      Dir.stub!(:glob).and_return([])
+    end
+
+    it "should raise NoCookieFileFoundException" do
+      lambda { CookieExtractor::BrowserDetector.guess }.
+        should raise_error(CookieExtractor::NoCookieFileFoundException)
+    end
+  end
+
+  describe "when multiple cookie files are found in the standard locations" do
+    before :each do
+      cookie_locations = CookieExtractor::BrowserDetector::COOKIE_LOCATIONS
+      Dir.stub!(:glob).and_return([cookie_locations['chrome']],
+                                  [],
+                                  [cookie_locations['firefox']])
+    end
+
+    describe "and chrome was the most recently used" do
+      before :each do
+        File.should_receive(:mtime).twice.and_return(
+          Time.parse("July 2 2013 00:00:00"),
+          Time.parse("July 1 2013 00:00:00"))
+      end
+
+      it "should build a ChromeCookieExtractor" do
+        CookieExtractor::BrowserDetector.
+          should_receive(:browser_extractor).
+            once.with("chrome")
+        CookieExtractor::BrowserDetector.guess
+      end
+    end
+  end 
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cookie_extractor
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-23 00:00:00.000000000 Z
+date: 2013-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &17748000 !ruby/object:Gem::Requirement
+  requirement: &16244180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '2.8'
   type: :development
   prerelease: false
-  version_requirements: *17748000
+  version_requirements: *16244180
 - !ruby/object:Gem::Dependency
   name: sqlite3-ruby
-  requirement: &17747360 !ruby/object:Gem::Requirement
+  requirement: &16243580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,7 +32,7 @@ dependencies:
         version: '1.3'
   type: :runtime
   prerelease: false
-  version_requirements: *17747360
+  version_requirements: *16243580
 description: Extract cookies from Firefox, Chrome or Chromium sqlite databases into
   a wget-compatible cookies.txt file.
 email: