browser.rb 0.16.0

data/test/Browser/TorBrowser_test.rb

@@ -0,0 +1,147 @@
+# TorBrowser_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::TorBrowser do
+  let(:places_fixtures_location){File.expand_path("#{__FILE__}/../../fixtures/FirefoxBased_places.sqlite")}
+  let(:expected_bookmarks_sql){'SELECT moz_bookmarks.id, moz_bookmarks.parent, moz_bookmarks.position, moz_bookmarks.type, moz_bookmarks.title, moz_bookmarks.guid, moz_places.url FROM moz_bookmarks LEFT JOIN moz_places ON moz_bookmarks.fk = moz_places.id ORDER BY moz_bookmarks.parent, moz_bookmarks.position;'}
+  let(:expected_history_sql){'SELECT moz_historyvisits.id, moz_places.url, moz_places.title, moz_historyvisits.visit_date FROM moz_historyvisits LEFT JOIN moz_places ON moz_historyvisits.place_id = moz_places.id ORDER BY moz_historyvisits.visit_date DESC;'}
+
+  describe '.default_profile_name' do
+    let(:profiles_ini){"[Profile0]\nName=default\nIsRelative=1\nPath=abcd1234.default\nDefault=1\n\n[General]\nStartWithLastProfile=1\nVersion=2\n"}
+
+    it "is the one profile Tor Browser flags, which sits beside profiles.ini rather than under Profiles" do
+      expect(Browser::TorBrowser.default_profile_name(profiles_ini)).to eq('abcd1234.default')
+    end
+  end
+
+  let(:profile_name){'abcd1234.default'}
+
+  context "class methods" do
+    subject{Browser::TorBrowser}
+
+    describe '.bookmarks_location' do
+      let(:expected_bookmarks_location){File.expand_path('~/Library/Application Support/TorBrowser-Data/Browser/abcd1234.default/places.sqlite')}
+
+      it "contains the correct bookmarks location" do
+        expect(subject.bookmarks_location(profile_name: profile_name)).to eq(expected_bookmarks_location)
+      end
+    end
+
+    describe '.history_location' do
+      let(:expected_history_location){File.expand_path('~/Library/Application Support/TorBrowser-Data/Browser/abcd1234.default/places.sqlite')}
+
+      it "contains the correct history location" do
+        expect(subject.history_location(profile_name: profile_name)).to eq(expected_history_location)
+      end
+    end
+
+    describe ".bookmarks_sql" do
+      it "returns the bookmarks sql" do
+        expect(subject.send(:bookmarks_sql)).to eq(expected_bookmarks_sql)
+      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::TorBrowser.new(bookmarks_location: places_fixtures_location, history_location: places_fixtures_location, profile_name: profile_name)}
+
+    let(:browser_name){'TorBrowser'}
+    let(:expected_history) do
+      [
+        {'id' => 1, 'url' => 'https://addons.mozilla.org/en-US/firefox/', 'title' => 'Extension Starter Pack', 'visit_date' => 1787449152741667},
+      ]
+    end
+
+    describe "#initialize" do
+      it "returns an instance of Browser" do
+        expect(subject).to be_a(Browser::TorBrowser)
+      end
+
+      it "assigns @bookmarks_location" do
+        expect(subject.instance_variable_get(:@bookmarks_location)).to eq(places_fixtures_location)
+      end
+
+      it "assigns @history_location" do
+        expect(subject.instance_variable_get(:@history_location)).to eq(places_fixtures_location)
+      end
+
+      it "assigns @profile_name" do
+        expect(subject.instance_variable_get(:@profile_name)).to eq(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: 'Get Help', url: 'https://support.mozilla.org/products/firefox', folder: 'Bookmarks Menu/Mozilla Firefox'},
+        {title: 'Customize Firefox', url: 'https://support.mozilla.org/kb/customize-firefox-controls-buttons-and-toolbars', folder: 'Bookmarks Menu/Mozilla Firefox'},
+        {title: 'Get Involved', url: 'https://www.mozilla.org/contribute/', folder: 'Bookmarks Menu/Mozilla Firefox'},
+        {title: 'About Us', url: 'https://www.mozilla.org/about/', folder: 'Bookmarks Menu/Mozilla Firefox'},
+        {title: 'Extension Starter Pack', url: 'https://addons.mozilla.org/en-US/firefox/', folder: 'Bookmarks Toolbar'},
+      ]
+    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::TorBrowser.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_test.rb

@@ -0,0 +1,33 @@
+# Browser_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 do
+  describe Browser::LIST do
+    it "contains the expected list of browsers" do
+      expect(Browser::LIST).to eq(%w{
+        Brave
+        Chrome
+        Chromium
+        Firefox
+        Safari
+        TorBrowser
+      })
+    end
+  end
+
+  Browser::LIST.each do |browser|
+    browser_test_filename = File.expand_path("#{__FILE__}/../Browser/#{browser}_test")
+    require browser_test_filename
+  end
+end

data/test/fixtures/Brave_bookmarks.json

@@ -0,0 +1,47 @@
+{
+   "checksum": "1f23f6aebb42e587a2171e6563b63893",
+   "roots": {
+      "bookmark_bar": {
+         "children": [ {
+            "date_added": "13314548862466117",
+            "date_last_used": "0",
+            "guid": "205d9fcc-e76c-4cbf-bb7e-8e9de7847eaa",
+            "id": "5",
+            "meta_info": {
+               "power_bookmark_meta": ""
+            },
+            "name": "Welcome to Brave",
+            "type": "url",
+            "url": "chrome://welcome/"
+         } ],
+         "date_added": "13314548615807175",
+         "date_last_used": "0",
+         "date_modified": "13314548862466117",
+         "guid": "0bc5d13f-2cba-5d74-951f-3f233fe6c908",
+         "id": "1",
+         "name": "Bookmarks bar",
+         "type": "folder"
+      },
+      "other": {
+         "children": [  ],
+         "date_added": "13314548615807200",
+         "date_last_used": "0",
+         "date_modified": "0",
+         "guid": "82b081ec-3dd3-529c-8475-ab6c344590dd",
+         "id": "2",
+         "name": "Other Bookmarks",
+         "type": "folder"
+      },
+      "synced": {
+         "children": [  ],
+         "date_added": "13314548615807201",
+         "date_last_used": "0",
+         "date_modified": "0",
+         "guid": "4cf2e351-0e85-532b-bb37-df045d8f8d0f",
+         "id": "3",
+         "name": "Mobile Bookmarks",
+         "type": "folder"
+      }
+   },
+   "version": 1
+}

data/test/fixtures/Chromium_bookmarks.json

@@ -0,0 +1,47 @@
+{
+   "checksum": "4ac0a80dc7d6a7daa73deb6c6731bca1",
+   "roots": {
+      "bookmark_bar": {
+         "children": [ {
+            "date_added": "13314699512289860",
+            "date_last_used": "0",
+            "guid": "2a8fdff0-de3b-4c0a-8364-74e44677cfbb",
+            "id": "5",
+            "meta_info": {
+               "power_bookmark_meta": ""
+            },
+            "name": "Home",
+            "type": "url",
+            "url": "https://www.chromium.org/chromium-projects/"
+         } ],
+         "date_added": "13314699403179560",
+         "date_last_used": "0",
+         "date_modified": "13314699512289860",
+         "guid": "0bc5d13f-2cba-5d74-951f-3f233fe6c908",
+         "id": "1",
+         "name": "Bookmarks Bar",
+         "type": "folder"
+      },
+      "other": {
+         "children": [  ],
+         "date_added": "13314699403179566",
+         "date_last_used": "0",
+         "date_modified": "0",
+         "guid": "82b081ec-3dd3-529c-8475-ab6c344590dd",
+         "id": "2",
+         "name": "Other Bookmarks",
+         "type": "folder"
+      },
+      "synced": {
+         "children": [  ],
+         "date_added": "13314699403179569",
+         "date_last_used": "0",
+         "date_modified": "0",
+         "guid": "4cf2e351-0e85-532b-bb37-df045d8f8d0f",
+         "id": "3",
+         "name": "Mobile Bookmarks",
+         "type": "folder"
+      }
+   },
+   "version": 1
+}

data/test/gemspec_test.rb

@@ -0,0 +1,42 @@
+# gemspec_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.rb.gemspec' do
+  let(:spec){Gem::Specification.load(File.expand_path('../browser.rb.gemspec', __dir__))}
+
+  it "is a valid specification" do
+    expect(spec.validate).to be(true)
+  end
+
+  it "does not pin a date" do
+    expect(spec.date).to eq(Gem::Specification.new.date)
+  end
+
+  it "takes its version from Browser::VERSION" do
+    expect(spec.version.to_s).to eq(Browser::VERSION)
+  end
+
+  it "declares its runtime dependencies" do
+    expect(spec.runtime_dependencies.map(&:name).sort).to eq(%w{CFPropertyList csv json sqlite3})
+  end
+
+  it "declares its development dependencies" do
+    expect(spec.development_dependencies.map(&:name).sort).to eq(%w{minitest minitest-spec-context rake rspec-expectations})
+  end
+
+  it "ships the files a consumer reads, and no file which is not there" do
+    expect(spec.files).to include('README.md', 'CHANGELOG', 'LICENSE')
+    expect(spec.files.reject{|file| File.exist?(File.expand_path("../#{file}", __dir__))}).to eq([])
+  end
+end

data/test/loading_test.rb

@@ -0,0 +1,35 @@
+# loading_test.rb
+
+gem 'minitest'
+gem 'minitest-spec-context'
+
+require 'minitest/autorun'
+require 'minitest-spec-context'
+require 'rspec/expectations/minitest_integration'
+
+# Each of these wants a process of its own, with nothing on the load path but lib and no
+# RUBYLIB, which is what a consumer of the gem has: within this one everything is loaded
+# already, so nothing here could tell a require which works from one which was never run.
+
+describe 'loading' do
+  def ruby(source, *flags)
+    lib = File.expand_path('../lib', __dir__)
+    IO.popen({'RUBYLIB' => nil}, ['ruby', *flags, "-I#{lib}", '-e', source], err: [:child, :out]){|io| io.read}.strip
+  end
+
+  it "defines Browser::VERSION on require 'browser'" do
+    expect(ruby('require "browser"; print Browser::VERSION')).to match(/\A\d+\.\d+\.\d+\z/)
+  end
+
+  it "patches no core class, nothing under lib/Array or lib/String remaining" do
+    expect(ruby('require "browser"; print $LOADED_FEATURES.grep(%r{/lib/(Array|String)/}).size')).to eq('0')
+  end
+
+  it "gives the top-level names on require 'browser-classes'" do
+    expect(ruby('require "browser-classes"; print Chrome.equal?(Browser::Chrome)')).to eq('true')
+  end
+
+  it "loads without warning under -w" do
+    expect(ruby('require "browser"; require "browser-classes"; print "ok"', '-w')).to eq('ok')
+  end
+end

metadata

@@ -0,0 +1,194 @@
+--- !ruby/object:Gem::Specification
+name: browser.rb
+version: !ruby/object:Gem::Version
+  version: 0.16.0
+platform: ruby
+authors:
+- thoran
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: CFPropertyList
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-spec-context
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Read the bookmarks and history of the web browsers on a machine, Brave,
+  Chrome, Chromium, Firefox, Safari and Tor Browser, and render them to CSV, JSON
+  or a property list.  Bookmarks come through as one representation whatever the browser;
+  history as each browser stores it.
+email: code@thoran.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- browser.rb.gemspec
+- lib/Browser/Base.rb
+- lib/Browser/Bookmark.rb
+- lib/Browser/Bookmarks.rb
+- lib/Browser/Brave.rb
+- lib/Browser/Chrome.rb
+- lib/Browser/Chromium.rb
+- lib/Browser/ChromiumBased.rb
+- lib/Browser/Firefox.rb
+- lib/Browser/FirefoxBased.rb
+- lib/Browser/History.rb
+- lib/Browser/Rendering.rb
+- lib/Browser/Safari.rb
+- lib/Browser/TorBrowser.rb
+- lib/Browser/Unreadable.rb
+- lib/Browser/VERSION.rb
+- lib/browser-classes.rb
+- lib/browser.rb
+- test/Browser/Bookmark_test.rb
+- test/Browser/Brave_test.rb
+- test/Browser/Chrome_test.rb
+- test/Browser/Chromium_test.rb
+- test/Browser/Firefox_test.rb
+- test/Browser/Rendering_test.rb
+- test/Browser/Safari_test.rb
+- test/Browser/TorBrowser_test.rb
+- test/browser_test.rb
+- test/fixtures/Brave_bookmarks.json
+- test/fixtures/ChromiumBased_history.sqlite
+- test/fixtures/Chromium_bookmarks.json
+- test/fixtures/FirefoxBased_places.sqlite
+- test/fixtures/Safari_bookmarks.plist
+- test/fixtures/Safari_history.sqlite
+- test/gemspec_test.rb
+- test/loading_test.rb
+homepage: https://github.com/thoran/browser
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.21
+specification_version: 4
+summary: Read web browser bookmarks and history with Ruby.
+test_files: []