cookie_extractor 0.0.1 → 0.1.0

data/bin/cookie_extractor

@@ -2,10 +2,22 @@
 
 require File.expand_path(File.join(File.dirname(__FILE__), "..", "lib", "cookie_extractor"))
 
-# TODO: detect firefox or chrome input file and/or locate it automatically
+# TODO: Locate cookie dbs automatically
 filename = ARGV.first
-if filename
-  puts CookieExtractor::FirefoxCookieExtractor.new(filename).extract.join("\n")
+unless filename
+  puts "Usage: (Firefox) cookie_extractor /path/to/cookies.sqlite"
+  puts "       (Chrome)  cookie_extractor /path/to/Cookies"
+  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 "Usage: cookie_extractor /path/to/cookies.sqlite"
+  puts "Error: File '#{filename}' does not exist"
 end

data/cookie_extractor.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |s|
   s.authors     = ["Jeff Dallien"]
   s.email       = ["jeff@dallien.net"]
   s.homepage    = "http://github.com/jdallien/cookie_extractor"
-  s.summary     = %q{Create cookies.txt from Firefox cookies}
-  s.description = %q{Extract cookies from Firefox sqlite databases into a wget-compatible cookies.txt file.}
+  s.summary     = %q{Create cookies.txt from Firefox or Chrome/Chromium cookies}
+  s.description = %q{Extract cookies from Firefox, Chrome or Chromium sqlite databases into a wget-compatible cookies.txt file.}
 
   s.rubyforge_project = "cookie_extractor"
 
@@ -18,6 +18,6 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_development_dependency "rspec"
-  s.add_runtime_dependency "sqlite3-ruby"
+  s.add_development_dependency "rspec", "~> 2.8"
+  s.add_runtime_dependency "sqlite3-ruby", "~> 1.3"
 end

data/lib/cookie_extractor/browser_detector.rb

@@ -0,0 +1,31 @@
+module CookieExtractor
+  class BrowserNotDetectedException < Exception; end
+
+  class BrowserDetector
+
+    def self.new_extractor(db_filename)
+      browser = detect_browser(db_filename)
+      if browser
+        CookieExtractor.const_get("#{browser}CookieExtractor").new(db_filename)
+      else
+        raise BrowserNotDetectedException, "Could not detect browser type."
+      end
+    end
+
+    def self.detect_browser(db_filename)
+      db = SQLite3::Database.new(db_filename)
+      browser = 
+        if has_table?(db, 'moz_cookies')
+          'Firefox'
+        elsif has_table?(db, 'cookies')
+          'Chrome'
+        end
+      db.close
+      browser
+    end
+
+    def self.has_table?(db, table_name)
+      db.table_info(table_name).size > 0
+    end
+  end
+end

data/lib/cookie_extractor/chrome_cookie_extractor.rb

@@ -0,0 +1,29 @@
+require 'sqlite3'
+
+module CookieExtractor
+  class ChromeCookieExtractor
+    include Common
+
+    def initialize(cookie_file)
+      @cookie_file = cookie_file
+    end
+
+    def extract
+      db = SQLite3::Database.new @cookie_file
+      db.results_as_hash = true
+      result = []
+      db.execute("SELECT * FROM cookies") do |row|
+        result << [ row['host_key'],
+          true_false_word(is_domain_wide(row['host_key'])),
+          row['path'],
+          true_false_word(row['secure']),
+          row['expires_utc'],
+          row['name'],
+          row['value']
+        ].join("\t")
+      end
+      db.close
+      result
+    end
+  end
+end

data/lib/cookie_extractor/common.rb

@@ -0,0 +1,19 @@
+module CookieExtractor
+  module Common
+    private
+
+    def is_domain_wide(hostname)
+      hostname[0..0] == "."
+    end
+
+    def true_false_word(value)
+      if value == "1" || value == 1 || value == true
+        "TRUE"
+      elsif value == "0" || value == 0 || value == false
+        "FALSE"
+      else
+        raise "Invalid value passed to true_false_word: #{value.inspect}"
+      end
+    end
+  end
+end

data/lib/cookie_extractor/firefox_cookie_extractor.rb

@@ -2,6 +2,7 @@ require 'sqlite3'
 
 module CookieExtractor
   class FirefoxCookieExtractor
+    include Common
 
     def initialize(cookie_file)
       @cookie_file = cookie_file
@@ -10,9 +11,9 @@ module CookieExtractor
     def extract
       db = SQLite3::Database.new @cookie_file
       db.results_as_hash = true
-      @result = []
+      result = []
       db.execute("SELECT * FROM moz_cookies") do |row|
-        @result << [ row['host'],
+        result << [ row['host'],
           true_false_word(is_domain_wide(row['host'])),
           row['path'],
           true_false_word(row['isSecure']),
@@ -21,23 +22,8 @@ module CookieExtractor
           row['value']
         ].join("\t")
       end
-      @result
-    end
-
-    private
-
-    def is_domain_wide(hostname)
-      hostname[0..0] == "."
-    end
-
-    def true_false_word(value)
-      if value == "1" || value == 1 || value == true
-        "TRUE"
-      elsif value == "0" || value == 0 || value == false
-        "FALSE"
-      else
-        raise "Invalid value passed to true_false_word: #{value.inspect}"
-      end
+      db.close
+      result
     end
   end
 end

data/lib/cookie_extractor/version.rb

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

data/lib/cookie_extractor.rb

@@ -1,5 +1,8 @@
 require "cookie_extractor/version"
+require "cookie_extractor/common"
 require "cookie_extractor/firefox_cookie_extractor"
+require "cookie_extractor/chrome_cookie_extractor"
+require "cookie_extractor/browser_detector"
 
 module CookieExtractor
 end

data/spec/browser_detector_spec.rb

@@ -0,0 +1,43 @@
+require File.join(File.dirname(__FILE__), "spec_helper")
+
+describe CookieExtractor::BrowserDetector, "determining the correct extractor to use" do
+  before :each do
+    @fake_cookie_db = double("cookie database", :close => true)
+    SQLite3::Database.should_receive(:new).
+      with('filename').
+        and_return(@fake_cookie_db)
+  end
+
+  describe "given a sqlite database with a 'moz_cookies' table" do
+    before :each do
+      @fake_cookie_db.should_receive(:table_info).
+        with("moz_cookies").
+          and_return(
+            { 'name' => 'some_field',
+              'type' => "some_type" })
+    end
+
+    it "should return a firefox extractor instance" do
+      extractor = CookieExtractor::BrowserDetector.new_extractor('filename')
+      extractor.instance_of?(CookieExtractor::FirefoxCookieExtractor).should be_true
+    end
+  end
+
+  describe "given a sqlite database with a 'cookies' table" do
+    before :each do
+      @fake_cookie_db.should_receive(:table_info).
+        with("moz_cookies").
+          and_return([])
+      @fake_cookie_db.should_receive(:table_info).
+        with("cookies").
+          and_return(
+            [{ 'name' => 'some_field',
+              'type' => "some_type" }])
+    end
+
+    it "should return a chrome extractor instance" do
+      extractor = CookieExtractor::BrowserDetector.new_extractor('filename')
+      extractor.instance_of?(CookieExtractor::ChromeCookieExtractor).should be_true
+    end
+  end
+end

data/spec/chrome_cookie_extractor_spec.rb

@@ -0,0 +1,126 @@
+require File.join(File.dirname(__FILE__), "spec_helper")
+
+describe CookieExtractor::ChromeCookieExtractor do
+  before :each do
+    @fake_cookie_db = double("cookie database",
+      :results_as_hash= => true,
+      :close => true)
+    SQLite3::Database.should_receive(:new).
+      with('filename').
+        and_return(@fake_cookie_db)
+  end
+
+  describe "opening and closing a sqlite db" do
+    before :each do
+      @fake_cookie_db.should_receive(:execute).and_yield(
+        { 'host_key' => '.dallien.net',
+          'path' => '/',
+          'secure' => '0',
+          'expires_utc' => '1234567890',
+          'name' => 'NAME',
+          'value' => 'VALUE'})
+      @extractor = CookieExtractor::ChromeCookieExtractor.new('filename')
+    end
+
+    it "should close the db when finished" do
+      @fake_cookie_db.should_receive(:close)
+      @extractor.extract
+    end
+  end
+
+  describe "with a cookie that has a host starting with a dot" do
+    before :each do
+      @fake_cookie_db.should_receive(:execute).and_yield(
+        { 'host_key' => '.dallien.net',
+          'path' => '/',
+          'secure' => '0',
+          'expires_utc' => '1234567890',
+          'name' => 'NAME',
+          'value' => 'VALUE'})
+      @extractor = CookieExtractor::ChromeCookieExtractor.new('filename')
+      @result = @extractor.extract
+    end
+
+    it "should return one cookie string" do
+      @result.size.should == 1
+    end
+
+    it "should put TRUE in the domain wide field" do
+      cookie_string = @result.first
+      cookie_string.split("\t")[1].should == "TRUE"
+    end
+
+    it "should build the correct cookie string" do
+      cookie_string = @result.first
+      cookie_string.should ==
+        ".dallien.net\tTRUE\t/\tFALSE\t1234567890\tNAME\tVALUE"
+    end
+  end
+
+  describe "with a cookie that has a host not starting with a dot" do
+    before :each do
+      @fake_cookie_db.should_receive(:execute).and_yield(
+        { 'host_key' => 'jeff.dallien.net',
+          'path' => '/path',
+          'secure' => '1',
+          'expires_utc' => '1234567890',
+          'name' => 'NAME',
+          'value' => 'VALUE'})
+      @extractor = CookieExtractor::ChromeCookieExtractor.new('filename')
+      @result = @extractor.extract
+    end
+
+    it "should return one cookie string" do
+      @result.size.should == 1
+    end
+
+    it "should put FALSE in the domain wide field" do
+      cookie_string = @result.first
+      cookie_string.split("\t")[1].should == "FALSE"
+    end
+
+    it "should build the correct cookie string" do
+      cookie_string = @result.first
+      cookie_string.should ==
+        "jeff.dallien.net\tFALSE\t/path\tTRUE\t1234567890\tNAME\tVALUE"
+    end
+  end
+
+  describe "with a cookie that is not marked as secure" do
+    before :each do
+      @fake_cookie_db.should_receive(:execute).and_yield(
+        { 'host_key' => '.dallien.net',
+          'path' => '/',
+          'secure' => '0',
+          'expires_utc' => '1234567890',
+          'name' => 'NAME',
+          'value' => 'VALUE'})
+      @extractor = CookieExtractor::ChromeCookieExtractor.new('filename')
+      @result = @extractor.extract
+    end
+
+    it "should put FALSE in the secure field" do
+      cookie_string = @result.first
+      cookie_string.split("\t")[3].should == "FALSE"
+    end
+  end
+
+  describe "with a cookie that is marked as secure" do
+    before :each do
+      @fake_cookie_db.should_receive(:execute).and_yield(
+        { 'host_key' => '.dallien.net',
+          'path' => '/',
+          'secure' => '1',
+          'expires_utc' => '1234567890',
+          'name' => 'NAME',
+          'value' => 'VALUE'})
+      @extractor = CookieExtractor::ChromeCookieExtractor.new('filename')
+      @result = @extractor.extract
+    end
+
+    it "should put TRUE in the secure field" do
+      cookie_string = @result.first
+      cookie_string.split("\t")[3].should == "TRUE"
+    end
+  end
+end

data/spec/firefox_cookie_extractor_spec.rb

@@ -2,12 +2,32 @@ require File.join(File.dirname(__FILE__), "spec_helper")
 
 describe CookieExtractor::FirefoxCookieExtractor do
   before :each do
-    @fake_cookie_db = double("cookie database", :results_as_hash= => true)
+    @fake_cookie_db = double("cookie database",
+      :results_as_hash= => true,
+      :close => true)
     SQLite3::Database.should_receive(:new).
       with('filename').
         and_return(@fake_cookie_db)
   end
 
+  describe "opening and closing a sqlite db" do
+    before :each do
+      @fake_cookie_db.should_receive(:execute).and_yield(
+        {'host' => '.dallien.net',
+          'path' => '/',
+          'isSecure' => '0',
+          'expiry' => '1234567890',
+          'name' => 'NAME',
+          'value' => 'VALUE'})
+      @extractor = CookieExtractor::FirefoxCookieExtractor.new('filename')
+    end
+
+    it "should close the db when finished" do
+      @fake_cookie_db.should_receive(:close)
+      @extractor.extract
+    end
+  end
+
   describe "with a cookie that has a host starting with a dot" do
     before :each do
       @fake_cookie_db.should_receive(:execute).and_yield(

metadata

@@ -1,61 +1,47 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: cookie_extractor
-version: !ruby/object:Gem::Version 
-  hash: 29
+version: !ruby/object:Gem::Version
+  version: 0.1.0
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 1
-  version: 0.0.1
 platform: ruby
-authors: 
+authors:
 - Jeff Dallien
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-02-20 00:00:00 -05:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rspec
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &17748000 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.8'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: sqlite3-ruby
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *17748000
+- !ruby/object:Gem::Dependency
+  name: sqlite3-ruby
+  requirement: &17747360 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
   type: :runtime
-  version_requirements: *id002
-description: Extract cookies from Firefox sqlite databases into a wget-compatible cookies.txt file.
-email: 
+  prerelease: false
+  version_requirements: *17747360
+description: Extract cookies from Firefox, Chrome or Chromium sqlite databases into
+  a wget-compatible cookies.txt file.
+email:
 - jeff@dallien.net
-executables: 
+executables:
 - cookie_extractor
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .rvmrc
 - Gemfile
@@ -65,44 +51,38 @@ files:
 - bin/cookie_extractor
 - cookie_extractor.gemspec
 - lib/cookie_extractor.rb
+- lib/cookie_extractor/browser_detector.rb
+- lib/cookie_extractor/chrome_cookie_extractor.rb
+- lib/cookie_extractor/common.rb
 - lib/cookie_extractor/firefox_cookie_extractor.rb
 - lib/cookie_extractor/version.rb
+- spec/browser_detector_spec.rb
+- spec/chrome_cookie_extractor_spec.rb
 - spec/cookie_extractor_spec.rb
 - spec/firefox_cookie_extractor_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: http://github.com/jdallien/cookie_extractor
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: cookie_extractor
-rubygems_version: 1.4.2
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
-summary: Create cookies.txt from Firefox cookies
+summary: Create cookies.txt from Firefox or Chrome/Chromium cookies
 test_files: []
-