browser.rb 0.16.0

data/lib/Browser/Rendering.rb

@@ -0,0 +1,108 @@
+# Browser/Rendering.rb
+# Browser::Rendering
+
+# The renderers, once.  CSV, JSON and a plist, each over records and their column
+# names, which is the shape Bookmarks and History both arrive at: Bookmarks by
+# flattening its tree, History from its query.  Including it gives a class to_csv,
+# to_json, to_plist, dump and readable?; the class supplies results, to_objects and
+# column_names.
+
+require 'csv'
+require 'date'
+require 'json'
+require 'cfpropertylist'
+
+require_relative './Unreadable'
+
+class Browser
+  module Rendering
+    class CSV
+      def render
+        ::CSV.generate do |csv|
+          csv << @column_names
+          rows.each{|row| csv << row}
+        end
+      end
+
+      private
+
+      def initialize(records, column_names)
+        @records = records
+        @column_names = column_names
+      end
+
+      def rows
+        @records.collect{|record| record.values_at(*@column_names)}
+      end
+    end
+
+    class JSON
+      def render
+        @records.to_json
+      end
+
+      private
+
+      def initialize(records)
+        @records = records
+      end
+    end
+
+    class Plist
+      def render
+        list = CFPropertyList::List.new
+        list.value = CFPropertyList.guess(@records)
+        list.to_str(CFPropertyList::List::FORMAT_XML)
+      end
+
+      private
+
+      def initialize(records)
+        @records = records
+      end
+    end
+
+    def to_csv
+      CSV.new(to_objects, column_names).render
+    end
+
+    def to_json
+      JSON.new(to_objects).render
+    end
+
+    def to_plist
+      Plist.new(to_objects).render
+    end
+
+    def dump(format: :csv, filename: nil, path: '.')
+      full_path = (
+        if filename
+          filename.include?(File::SEPARATOR) ? filename : File.join(path, filename)
+        else
+          File.join(path, dump_filename(format))
+        end
+      )
+      File.write(full_path, public_send("to_#{format}"))
+      full_path
+    rescue Errno::ENOENT => e
+      raise "Cannot write to #{full_path}: #{e.message}"
+    end
+
+    def readable?
+      results
+      true
+    rescue Browser::Unreadable
+      false
+    end
+
+    private
+
+    def dump_filename(extension)
+      [@browser_instance.name, @browser_instance.profile_name, kind, Date.today].compact.join('_') + ".#{extension}"
+    end
+
+    def kind
+      self.class.name.split('::').last
+    end
+  end
+end

data/lib/Browser/Safari.rb

@@ -0,0 +1,48 @@
+# Browser/Safari.rb
+# Browser::Safari
+
+require_relative './Base'
+
+class Browser
+  class Safari < Base
+    DEFAULT_PROFILE_NAME = nil # Safari doesn't have profiles.
+
+    class << self
+      def bookmarks_location(profile_name: nil)
+        profile_name ||= DEFAULT_PROFILE_NAME
+        File.expand_path("#{root_path}/Bookmarks.plist")
+      end
+
+      def history_location(profile_name: nil)
+        profile_name ||= DEFAULT_PROFILE_NAME
+        File.expand_path("#{root_path}/History.db")
+      end
+
+      private
+
+      def root_path
+        "~/Library/Safari"
+      end
+
+      def profiles_path
+        nil # Safari doesn't have profiles.
+      end
+
+      def bookmarks_format
+        :plist
+      end
+
+      def history_format
+        :sqlite
+      end
+
+      def bookmarks_sql
+        nil
+      end
+
+      def history_sql
+        'SELECT history_items.id, history_items.url, history_visits.visit_time FROM history_items LEFT JOIN history_visits WHERE history_items.id = history_visits.history_item ORDER BY visit_time DESC;'
+      end
+    end
+  end
+end

data/lib/Browser/TorBrowser.rb

@@ -0,0 +1,26 @@
+# Browser/TorBrowser.rb
+# Browser::TorBrowser
+
+require_relative './FirefoxBased'
+
+class Browser
+  class TorBrowser < FirefoxBased
+    class << self
+      private
+
+      def root_path
+        "~/Library/Application Support/TorBrowser-Data"
+      end
+
+      # Tor Browser keeps its profiles under Browser where Firefox uses Profiles.
+      def profiles_path
+        "#{root_path}/Browser"
+      end
+
+      # And its profiles.ini beside them, where Firefox keeps its own beside Profiles.
+      def profiles_ini_path
+        File.expand_path("#{profiles_path}/profiles.ini")
+      end
+    end
+  end
+end

data/lib/Browser/Unreadable.rb

@@ -0,0 +1,11 @@
+# Browser/Unreadable.rb
+# Browser::Unreadable
+
+# Raised when a browser's data cannot be read: the file is not there, the browser
+# has it locked, or the format library cannot open it.  The underlying exception is
+# available as #cause, which Ruby sets when this is raised from a rescue.
+
+class Browser
+  class Unreadable < StandardError
+  end
+end

data/lib/Browser/VERSION.rb

@@ -0,0 +1,6 @@
+# Browser/VERSION.rb
+# Browser::VERSION
+
+class Browser
+  VERSION = '0.16.0'
+end

data/lib/browser-classes.rb

@@ -0,0 +1,12 @@
+# browser-classes.rb
+
+# Instead of writing Browser::Brave.new or Browser.new(:brave), write Brave.new.
+
+require_relative './browser'
+
+Brave      = Browser::Brave
+Chrome     = Browser::Chrome
+Chromium   = Browser::Chromium
+Firefox    = Browser::Firefox
+Safari     = Browser::Safari
+TorBrowser = Browser::TorBrowser

data/lib/browser.rb

@@ -0,0 +1,29 @@
+# browser.rb
+# Browser
+
+require_relative './Browser/VERSION'
+
+class Browser
+  LIST = %w{
+    Brave
+    Chrome
+    Chromium
+    Firefox
+    Safari
+    TorBrowser
+  }
+end
+
+Browser::LIST.each do |browser|
+  browser_filename = File.expand_path("#{__FILE__}/../Browser/#{browser}")
+  require browser_filename
+end
+
+class Browser
+  def self.new(name = nil, **options)
+    return super(**options) unless self == Browser
+    browser_name = LIST.detect{|browser| browser.downcase == name.to_s.downcase.delete('_')}
+    raise ArgumentError, "Unknown browser: #{name.inspect}." unless browser_name
+    const_get(browser_name).new(**options)
+  end
+end

data/test/Browser/Bookmark_test.rb

@@ -0,0 +1,72 @@
+# Bookmark_test.rb
+
+gem 'minitest'
+gem 'minitest-spec-context'
+
+require 'minitest/autorun'
+require 'minitest-spec-context'
+require 'rspec/expectations/minitest_integration'
+
+lib_dir = File.expand_path(File.join(__FILE__, '..', '..', '..', 'lib'))
+$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+
+require 'browser'
+
+describe Browser::Bookmark do
+  describe "#leaf? and #folder?" do
+    it "a bookmark with a url is a leaf" do
+      bookmark = Browser::Bookmark.new(title: 'Home', url: 'https://example.com/')
+      expect(bookmark.leaf?).to be(true)
+      expect(bookmark.folder?).to be(false)
+    end
+
+    it "a bookmark without a url is a folder" do
+      folder = Browser::Bookmark.new(title: 'Bar', children: [])
+      expect(folder.folder?).to be(true)
+      expect(folder.leaf?).to be(false)
+    end
+  end
+
+  describe "#name" do
+    it "is the title unless given, which is what a browser stores where that differs from what it shows" do
+      expect(Browser::Bookmark.new(title: 'Bookmarks Menu').name).to eq('Bookmarks Menu')
+      expect(Browser::Bookmark.new(title: 'Bookmarks Menu', name: 'menu').name).to eq('menu')
+    end
+  end
+
+  describe "#flatten" do
+    subject do
+      Browser::Bookmark.new(children: [
+        Browser::Bookmark.new(title: 'Bar', children: [
+          Browser::Bookmark.new(title: 'Home', url: 'https://example.com/'),
+          Browser::Bookmark.new(title: 'Work', children: [
+            Browser::Bookmark.new(title: 'Mail', url: 'https://mail.example.com/'),
+          ]),
+        ]),
+        Browser::Bookmark.new(title: 'Top', url: 'https://top.example.com/'),
+        Browser::Bookmark.new(title: 'Empty', children: []),
+      ])
+    end
+
+    it "returns a record per leaf, and none for folders" do
+      expect(subject.flatten.length).to eq(3)
+    end
+
+    it "carries the folder path each leaf sits under, nesting joined by /" do
+      expect(subject.flatten).to eq([
+        {title: 'Home', url: 'https://example.com/', folder: 'Bar'},
+        {title: 'Mail', url: 'https://mail.example.com/', folder: 'Bar/Work'},
+        {title: 'Top', url: 'https://top.example.com/', folder: ''},
+      ])
+    end
+
+    it "the rootless, titleless node adds nothing to the path" do
+      expect(subject.flatten.first[:folder]).to eq('Bar')
+    end
+
+    it "an empty folder contributes no records" do
+      empty = Browser::Bookmark.new(title: 'Empty', children: [])
+      expect(empty.flatten).to eq([])
+    end
+  end
+end

data/test/Browser/Brave_test.rb

@@ -0,0 +1,143 @@
+# Brave_test.rb
+
+gem 'minitest'
+gem 'minitest-spec-context'
+
+require 'minitest/autorun'
+require 'minitest-spec-context'
+require 'rspec/expectations/minitest_integration'
+
+lib_dir = File.expand_path(File.join(__FILE__, '..', '..', '..', 'lib'))
+$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+
+require 'browser'
+
+describe Browser::Brave do
+  let(:bookmarks_fixtures_location){File.expand_path("#{__FILE__}/../../fixtures/Brave_bookmarks.json")}
+  let(:history_fixtures_location){File.expand_path("#{__FILE__}/../../fixtures/ChromiumBased_history.sqlite")}
+  let(:expected_history_sql){'SELECT * FROM urls ORDER BY last_visit_time DESC;'}
+
+  describe Browser::Brave::DEFAULT_PROFILE_NAME do
+    let(:expected_default_profile_name){'Default'}
+
+    it "contains the correct default profile name" do
+      expect(Browser::Brave::DEFAULT_PROFILE_NAME).to eq(expected_default_profile_name)
+    end
+  end
+
+  context "class methods" do
+    subject{Browser::Brave}
+
+    describe '.bookmarks_location' do
+      let(:expected_bookmarks_location){File.expand_path('~/Library/Application Support/BraveSoftware/Brave-Browser/Default/Bookmarks')}
+
+      it "contains the correct bookmarks location" do
+        expect(subject.bookmarks_location).to eq(expected_bookmarks_location)
+      end
+    end
+
+    describe '.history_location' do
+      let(:expected_history_location){File.expand_path('~/Library/Application Support/BraveSoftware/Brave-Browser/Default/History')}
+
+      it "contains the correct history location" do
+        expect(subject.history_location).to eq(expected_history_location)
+      end
+    end
+
+    describe ".bookmarks_sql" do
+      it "returns the bookmarks sql" do
+        expect(subject.send(:bookmarks_sql)).to be_nil
+      end
+    end
+
+    describe ".history_sql" do
+      it "returns the history sql" do
+        expect(subject.send(:history_sql)).to eq(expected_history_sql)
+      end
+    end
+  end
+
+  context "instance methods" do
+    subject{Browser::Brave.new(bookmarks_location: bookmarks_fixtures_location, history_location: history_fixtures_location)}
+
+    let(:browser_name){'Brave'}
+    let(:default_profile_name){'Default'}
+    let(:expected_history) do
+      [
+        {'id' => 1, 'url' => 'https://www.chromium.org/chromium-projects/', 'title' => 'Home', 'visit_count' => 3, 'typed_count' => 1, 'last_visit_time' => 13403232000000000, 'hidden' => 0},
+        {'id' => 2, 'url' => 'chrome://welcome/', 'title' => 'Welcome', 'visit_count' => 1, 'typed_count' => 0, 'last_visit_time' => 13403231000000000, 'hidden' => 0},
+      ]
+    end
+
+    describe "#initialize" do
+      it "returns an instance of Browser" do
+        expect(subject).to be_a(Browser::Brave)
+      end
+
+      it "assigns @bookmarks_location" do
+        expect(subject.instance_variable_get(:@bookmarks_location)).to eq(bookmarks_fixtures_location)
+      end
+
+      it "assigns @history_location" do
+        expect(subject.instance_variable_get(:@history_location)).to eq(history_fixtures_location)
+      end
+
+      it "takes the default profile name when none is given" do
+        expect(subject.profile_name).to eq(default_profile_name)
+      end
+    end
+
+    describe "#name" do
+      it "returns name" do
+        expect(subject.name).to eq(browser_name)
+      end
+    end
+
+    let(:expected_bookmarks) do
+      [
+        {title: 'Welcome to Brave', url: 'chrome://welcome/', folder: 'Bookmarks bar'},
+      ]
+    end
+
+    describe "#bookmarks" do
+      it "returns an instance of Browser::Bookmarks" do
+        expect(subject.bookmarks).to be_a(Browser::Bookmarks)
+      end
+
+      it "returns the bookmarks" do
+        expect(subject.bookmarks.to_objects).to eq(expected_bookmarks)
+      end
+    end
+
+    describe "#history" do
+      it "returns an instance of Browser::History" do
+        expect(subject.history).to be_a(Browser::History)
+      end
+
+      it "returns the history" do
+        expect(subject.history.to_json).to eq(expected_history.to_json)
+      end
+    end
+
+    describe "#readable?" do
+      it "is true when the data is there" do
+        expect(subject.bookmarks.readable?).to be(true)
+        expect(subject.history.readable?).to be(true)
+      end
+    end
+
+    context "WHEN the data is not there" do
+      subject{Browser::Brave.new(bookmarks_location: '/nonexistent/file', history_location: '/nonexistent/file')}
+
+      it "is not readable" do
+        expect(subject.bookmarks.readable?).to be(false)
+        expect(subject.history.readable?).to be(false)
+      end
+
+      it "raises Browser::Unreadable" do
+        expect{subject.bookmarks.to_json}.to raise_error(Browser::Unreadable)
+        expect{subject.history.to_json}.to raise_error(Browser::Unreadable)
+      end
+    end
+  end
+end

data/test/Browser/Chrome_test.rb

@@ -0,0 +1,143 @@
+# Chrome_test.rb
+
+gem 'minitest'
+gem 'minitest-spec-context'
+
+require 'minitest/autorun'
+require 'minitest-spec-context'
+require 'rspec/expectations/minitest_integration'
+
+lib_dir = File.expand_path(File.join(__FILE__, '..', '..', '..', 'lib'))
+$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+
+require 'browser'
+
+describe Browser::Chrome do
+  let(:bookmarks_fixtures_location){File.expand_path("#{__FILE__}/../../fixtures/Chromium_bookmarks.json")}
+  let(:history_fixtures_location){File.expand_path("#{__FILE__}/../../fixtures/ChromiumBased_history.sqlite")}
+  let(:expected_history_sql){'SELECT * FROM urls ORDER BY last_visit_time DESC;'}
+
+  describe Browser::Chrome::DEFAULT_PROFILE_NAME do
+    let(:expected_default_profile_name){'Default'}
+
+    it "contains the correct default profile name" do
+      expect(Browser::Chrome::DEFAULT_PROFILE_NAME).to eq(expected_default_profile_name)
+    end
+  end
+
+  context "class methods" do
+    subject{Browser::Chrome}
+
+    describe '.bookmarks_location' do
+      let(:expected_bookmarks_location){File.expand_path('~/Library/Application Support/Google/Chrome/Default/Bookmarks')}
+
+      it "contains the correct bookmarks location" do
+        expect(subject.bookmarks_location).to eq(expected_bookmarks_location)
+      end
+    end
+
+    describe '.history_location' do
+      let(:expected_history_location){File.expand_path('~/Library/Application Support/Google/Chrome/Default/History')}
+
+      it "contains the correct history location" do
+        expect(subject.history_location).to eq(expected_history_location)
+      end
+    end
+
+    describe ".bookmarks_sql" do
+      it "returns the bookmarks sql" do
+        expect(subject.send(:bookmarks_sql)).to be_nil
+      end
+    end
+
+    describe ".history_sql" do
+      it "returns the history sql" do
+        expect(subject.send(:history_sql)).to eq(expected_history_sql)
+      end
+    end
+  end
+
+  context "instance methods" do
+    subject{Browser::Chrome.new(bookmarks_location: bookmarks_fixtures_location, history_location: history_fixtures_location)}
+
+    let(:browser_name){'Chrome'}
+    let(:default_profile_name){'Default'}
+    let(:expected_history) do
+      [
+        {'id' => 1, 'url' => 'https://www.chromium.org/chromium-projects/', 'title' => 'Home', 'visit_count' => 3, 'typed_count' => 1, 'last_visit_time' => 13403232000000000, 'hidden' => 0},
+        {'id' => 2, 'url' => 'chrome://welcome/', 'title' => 'Welcome', 'visit_count' => 1, 'typed_count' => 0, 'last_visit_time' => 13403231000000000, 'hidden' => 0},
+      ]
+    end
+
+    describe "#initialize" do
+      it "returns an instance of Browser" do
+        expect(subject).to be_a(Browser::Chrome)
+      end
+
+      it "assigns @bookmarks_location" do
+        expect(subject.instance_variable_get(:@bookmarks_location)).to eq(bookmarks_fixtures_location)
+      end
+
+      it "assigns @history_location" do
+        expect(subject.instance_variable_get(:@history_location)).to eq(history_fixtures_location)
+      end
+
+      it "takes the default profile name when none is given" do
+        expect(subject.profile_name).to eq(default_profile_name)
+      end
+    end
+
+    describe "#name" do
+      it "returns name" do
+        expect(subject.name).to eq(browser_name)
+      end
+    end
+
+    let(:expected_bookmarks) do
+      [
+        {title: 'Home', url: 'https://www.chromium.org/chromium-projects/', folder: 'Bookmarks Bar'},
+      ]
+    end
+
+    describe "#bookmarks" do
+      it "returns an instance of Browser::Bookmarks" do
+        expect(subject.bookmarks).to be_a(Browser::Bookmarks)
+      end
+
+      it "returns the bookmarks" do
+        expect(subject.bookmarks.to_objects).to eq(expected_bookmarks)
+      end
+    end
+
+    describe "#history" do
+      it "returns an instance of Browser::History" do
+        expect(subject.history).to be_a(Browser::History)
+      end
+
+      it "returns the history" do
+        expect(subject.history.to_json).to eq(expected_history.to_json)
+      end
+    end
+
+    describe "#readable?" do
+      it "is true when the data is there" do
+        expect(subject.bookmarks.readable?).to be(true)
+        expect(subject.history.readable?).to be(true)
+      end
+    end
+
+    context "WHEN the data is not there" do
+      subject{Browser::Chrome.new(bookmarks_location: '/nonexistent/file', history_location: '/nonexistent/file')}
+
+      it "is not readable" do
+        expect(subject.bookmarks.readable?).to be(false)
+        expect(subject.history.readable?).to be(false)
+      end
+
+      it "raises Browser::Unreadable" do
+        expect{subject.bookmarks.to_json}.to raise_error(Browser::Unreadable)
+        expect{subject.history.to_json}.to raise_error(Browser::Unreadable)
+      end
+    end
+  end
+end