syclink 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e589b7afc92a5b81224d34df04f9aa8de84d4e66
-  data.tar.gz: e50dbfae41eef5d476fb3e9c95b8505401d49c4a
+  metadata.gz: 757f2615ff72bd3c25ef404172faa9308e2a0c7f
+  data.tar.gz: a0a0ccac857393f6a4beae8a50a0f356e5faf578
 SHA512:
-  metadata.gz: 7cdd7ddbcd51e14acacb585bdbfe4f6760c970d63de348200194d5fd222ebe78e6a816d59bdea44db064119ee879f0354b7656099be74f3bfdaedf0a4f78e548
-  data.tar.gz: 4fd0b2f5036a5884a8cb8fdd3991d6058c044e04b828957aa89b43ea594c68bdd3823fa31a65d9b4a15f98756e6fc22a99e9f210bec092ae3e3c21a63205586c
+  metadata.gz: 737469dcc6463c9e13dc21b8cc310c93206bdd18f3a8a9a6ecaf5e164930a48291c4d42ecab3bbee81cc0e7a854cb6a66e27034cf73d14df068b4a16eb9ab48f
+  data.tar.gz: 0dadc454dcba9d28a8b4123a680a109dc860b216274e3800ce6c94259b3f088f3b86e1f6a3e36fb415a8980f2248568b0fbc6607cbdb6af119aaa69a3cd74fe5

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    syclink (0.0.1)
+    syclink (0.0.2)
       gli (= 2.13.1)
+      sqlite3 (= 1.3.10)
 
 GEM
   remote: https://rubygems.org/
@@ -23,11 +24,12 @@ GEM
       rspec-support (~> 3.3.0)
     rspec-support (3.3.0)
     sass (3.4.15)
+    sqlite3 (1.3.10)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  rspec
-  sass
+  rspec (= 3.3.0)
+  sass (= 3.4.15)
   syclink!

data/README.md

@@ -27,14 +27,29 @@ _Website commands_
 * website show    - show all websites or search for websites
 * website remove  - Remove website
 * website create  - Create a HTML representation of the website
+* website check   - Check from links that are not active anymore (pending)
+* website edit    - Open the YAML file for editing (pending)
 
 _Link commands_
-* add    - Add a link
-* file   - Add links from a file
-* update - Update a link
-* delete - Delete a link 
-* list   - List all links with an optional filter
-* find   - Find links based on a search string
+* add link    - Add a link
+* add file    - Add links from a file
+* update link - Update a link
+* update file - Update links saved to a file
+* delete      - Delete one or more links
+* list        - List all links with an optional filter
+* find        - Find links based on a search string
+* merge       - Merge multiple links with same URL
+
+_Import commands_
+* import mf  - Import Mozilla Firefox bookmarks
+* import gc  - Import Google Chrome bookmarks
+* import ie  - Import Internet Explorer bookmarks
+* import dir - Import links to files from a directory
+
+_Export commands_
+* export xml  - Export links in XML fromat (pending)
+* export json - Export links in JSON format (pending)
+* export csv  - Export links in csv format
 
 Commands
 ========
@@ -189,3 +204,66 @@ Following is showing the above sequence in commands
     $ syclink add "http://github.com" --tag DEVELOPMENT
     $ syclink website create
 
+Importing Bookmarks from Webrowsers
+===================================
+
+Firefox
+-------
+The bookmarks of _Firefox_ are located in the user's home folder in
+`~/.mozilla/SOME_CRYPTIC_NAME.default/places.sqlite`.
+
+The database can be explored with _sqlite3_ from the command line
+
+    $ cd ~/.mozilla/SOME_CRYPTIC_NAME.default/
+    $ sqlite3 places.sqlite
+    >
+
+We want to retrieve url, title, description, tag, key and bookmark. tag, key 
+and bookmark are good candidates for tags for the application.
+
+At the command prompt of SQLite3 We can issue the query
+
+````
+sqlite> select p.id, p.url, p.title, b.id, b.fk, b.parent, b.title, 
+   ...> k.keyword, a.content, b_t.title from moz_bookmarks b 
+   ...> left outer join moz_keywords k on b.keyword_id = k.id 
+   ...> left outer join moz_items_annos a on a.item_id = b.id 
+   ...> left outer join moz_bookmarks b_t on b.parent = b_t.id 
+   ...> join moz_places p on p.id = b.fk where p.url like "http%";
+1|https://www.mozilla.org/en-US/firefox/central/||6|1|3|Getting Started|||\
+Bookmarks Toolbar
+2|http://www.ubuntu.com/||8|2|7|Ubuntu|||Ubuntu and Free Software links
+3|http://wiki.ubuntu.com/||9|3|7|Ubuntu Wiki (community-edited website)|||\
+Ubuntu and Free Software links
+4|https://answers.launchpad.net/ubuntu/+addquestion||10|4|7|Make a Support \
+Request to the Ubuntu Community|||Ubuntu and Free Software links
+5|http://www.debian.org/||11|5|7|Debian (Ubuntu is based on Debian)|||Ubuntu \
+and Free Software links
+6|https://one.ubuntu.com/||12|6|7|Ubuntu One - The personal cloud that brings\
+your digital life together|||Ubuntu and Free Software links
+7|https://www.mozilla.org/en-US/firefox/help/||14|7|13|Help and Tutorials|||\
+Mozilla Firefox
+8|https://www.mozilla.org/en-US/firefox/customize/||15|8|13|Customize \
+Firefox|||Mozilla Firefox
+9|https://www.mozilla.org/en-US/contribute/||16|9|13|Get Involved|||Mozilla \
+Firefox
+10|https://www.mozilla.org/en-US/about/||17|10|13|About Us|||Mozilla Firefox
+4717|http://codekata.com/|CodeKata|30|4717|5|CodeKata|liklo|How do you get \
+to be a great musician? It helps to know the theory,
+and to understand the mechanics of your instrument. It helps to have
+talent. But …|Unsorted Bookmarks
+399|http://localhost:3000/|Secondhand | Home|34|399|2|Secondhand | Home|||\
+Bookmarks Menu
+12870|https://www.sqlite.org/cli.html|Command Line Shell For SQLite|35|12870|\
+5|Command Line Shell For SQLite|dark|What is this sqlite all about?|Unsorted \
+Bookmarks
+4717|http://codekata.com/|CodeKata|37|4717|36||||wenga
+12870|https://www.sqlite.org/cli.html|Command Line Shell For SQLite|39|12870|\
+38||||lite
+12883|http://ruby.bastardsbook.com/chapters/sql/#h-2-5|SQL | The Bastards \
+Book of Ruby|40|12883|5|SQL | The Bastards Book of Ruby|||Unsorted Bookmarks
+12883|http://ruby.bastardsbook.com/chapters/sql/#h-2-5|SQL | The Bastards \
+Book of Ruby|42|12883|41||||Ruby
+sqlite> 
+````
+

data/bin/syclink

@@ -14,7 +14,8 @@ include SycLink::Infrastructure
 include SycLink::Formatter
 
 # Commands that need to have a website and a designer object
-WEBSITE_COMMANDS = [ :create, :add, :file, :update, :delete, :list, :find ]
+WEBSITE_COMMANDS = [ :create, :link, :file, :update, :delete, :list, :find,
+                     :dir, :mf, :gc, :ie, :csv, :merge ]
 
 # syclink's configuration directory
 syclink_directory             = File.expand_path("~/.syc/syclink")
@@ -54,7 +55,7 @@ copy_file_if_missing(File.join(File.dirname(__FILE__),
 
 config = load_config(syclink_file)
 
-program_desc 'Create a link list and display it as an html page'
+program_desc 'Create a link-list and display it as an html page'
 
 version SycLink::VERSION
 
@@ -65,63 +66,89 @@ desc 'Website to operate on'
 arg_name 'WEBSITE'
 flag [:w,:website]
 
-desc 'Add a link to the website'
-arg_name 'URL'
+desc 'Add a link from command line or links from a file to the website'
 command :add do |c|
 
-  c.desc 'Name of the link'
-  c.arg_name 'NAME'
-  c.flag [:n, :name]
+  c.desc 'Add a link from the command line to the website'
+  c.arg_name 'URL'
+  c.command :link do |s|
+    s.desc 'Name of the link'
+    s.arg_name 'NAME'
+    s.flag [:n, :name]
 
-  c.desc 'Description of the link'
-  c.arg_name 'DESCRIPTION'
-  c.flag [:d, :description]
+    s.desc 'Description of the link'
+    s.arg_name 'DESCRIPTION'
+    s.flag [:d, :description]
 
-  c.desc 'Tag the link is associated to'
-  c.arg_name 'TAG'
-  c.flag [:t, :tag]
+    s.desc 'Tag the link is associated to'
+    s.arg_name 'TAG'
+    s.flag [:t, :tag]
 
-  c.action do |global_options,options,args|
+    s.action do |global_options,options,args|
 
-    @designer.add_link(args[0], options)
+      @designer.add_link(args[0], options)
 
+    end
   end
-end
 
-desc 'Add links from a file to the website'
-arg_name 'FILE'
-command :file do |c|
+  c.desc 'Add links from a file to the website'
+  c.arg_name 'FILE'
+  c.command :file do |s|
 
-  c.action do |global_options,options,args|
+    s.action do |global_options,options,args|
 
-    @designer.add_links_from_file(args[0])
+      @designer.add_links_from_file(args[0])
 
+    end
   end
 end
 
-desc 'Update a link'
-arg_name 'URL'
+desc 'Update a link from command line or links from file'
 command :update do |c|
 
-  c.desc 'Name of the link'
-  c.arg_name 'NAME'
-  c.flag [:n, :name]
+  c.desc 'Update a link from the command line'
+  c.arg_name 'URL'
+  c.command :link do |s|
 
-  c.desc 'Description of the link'
-  c.arg_name 'DESCRIPTION'
-  c.flag [:d, :description]
+    s.desc 'Name of the link'
+    s.arg_name 'NAME'
+    s.flag [:n, :name]
 
-  c.desc 'Tag the link is associated to'
-  c.arg_name 'TAG'
-  c.flag [:t, :tag]
+    s.desc 'Description of the link'
+    s.arg_name 'DESCRIPTION'
+    s.flag [:d, :description]
 
-  c.action do |global_options,options,args|
+    s.desc 'Tag the link is associated to'
+    s.arg_name 'TAG'
+    s.flag [:t, :tag]
+
+    s.action do |global_options,options,args|
 
-    @designer.update_link(args[0], options)
+      @designer.update_link(args[0], options)
+
+    end
+  end
+
+  c.desc "Update links by reading from file"
+  c.arg_name 'FILE'
+  c.command :file do |s|
+
+    s.action do |global_options,options,args|
+
+      @designer.update_links_from_file(args[0])
+
+    end
 
   end
 end
 
+desc 'Merge links with same URL'
+command :merge do |c|
+  c.action do |global_options,options,args|
+    @designer.merge_links
+  end
+end
+
 desc 'Find a link'
 arg_name 'FIND_STRING'
 command :find do |c|
@@ -131,17 +158,31 @@ command :find do |c|
   c.arg_name 'URL, NAME, DESCRIPTION, TAG'
   c.flag [:c, :columns]
 
+  c.desc 'Table width'
+  c.arg_name 'WIDTH'
+  c.flag [:w, :width], :type => Integer
+
+  c.desc 'Expand table to full width of specified WIDTH'
+  c.default_value true
+  c.switch [:e, :expand]
+
   c.action do |global_options,options,args|
 
-    print_links(@designer.find_links(args[0].downcase), options[:c])
+    if args[0].nil?
+      STDERR.puts "Warning: You need to specify a FIND_STRING"
+      STDERR.puts "If you want to list all links use 'syclink list'"
+    else
+      print_links(@designer.find_links(args[0]), options[:c], options)
+    end
 
   end
 end
 
 desc 'Remove one or more links'
-arg_name 'URL[URL,URL]'
+arg_name 'URL [URL URL]'
 command :delete do |c|
   c.action do |global_options,options,args|
+    p args
     @designer.remove_links(args)
   end
 end
@@ -170,9 +211,17 @@ command :list do |c|
   c.arg_name 'URL, NAME, DESCRIPTION, TAG'
   c.flag [:c, :columns]
 
+  c.desc 'Table width'
+  c.arg_name 'WIDTH'
+  c.flag [:w, :width], :type => Integer
+
+  c.desc 'Expand table to full width of specified WIDTH'
+  c.default_value true
+  c.switch [:e, :expand]
+
   c.action do |global_options,options,args|
     
-    print_links(@designer.list_links(options), options[:c])
+    print_links(@designer.list_links(options), options[:c], options)
 
   end
 end
@@ -232,6 +281,107 @@ command :website do |c|
   c.default_command :create
 end
 
+desc "Import links from Firefox, Chrome, Internet Explorer or directory"
+command :import do |c|
+
+  c.desc 'Import links from Mozilla Firefox'
+  c.arg_name 'PATH_TO_FIREFOX_DATABASE'
+  c.command :mf do |s|
+
+    s.action do |global_options,options,args|
+      unless File.exists? args[0]
+        STDERR.puts <<-HERE.gsub(/^ {10}/, '')
+          Error: #{args[0]} doesn't exist!
+          Firefox stores its bookmarks in a SQLite3 database called
+          places.sqlite. With Ubuntu this database is usually located in
+          '~/.mozilla/firefox/*.default/places.sqlite'. 
+          If you are on Windows
+          the file is located in the user's home directory 
+          '~/AppData/Roaming/Mozilla/Profiles/*.default/places.sqlite'.
+        HERE
+        exit(0)
+      else
+        @designer.import_links(SycLink::Firefox.new(args.shift))
+      end
+    end
+  end
+
+  c.desc 'Import links from Google Chrome'
+  c.arg_name 'PATH_TO_CHROME_BOOKMARKS'
+  c.command :gc do |s|
+
+    s.action do |global_options,options,args|
+      unless File.exists? args[0]
+        STDERR.puts <<-HERE.gsub(/^ {10}/, '')
+          Error: #{args[0]} doesn't exist!
+          Google Chrome stores its bookmarks in a JSON file called
+          Bookmarks. With Ubuntu this file is usually located in
+          '~/.config/chromium/Default/Bookmarks'. 
+          If you are on Windows
+          the file is located in the user's home directory 
+          '~/AppData/Local/Google/Chrome/User Data/Bookmarks'.
+        HERE
+        exit(0)
+      else
+        @designer.import_links(SycLink::Chrome.new(args.shift))
+      end
+    end
+  end
+
+  c.desc 'Import links from Internet Explorer'
+  c.arg_name 'PATH_TO_INTERNET_EXPLORER_BOOKMARKS'
+  c.command :ie do |s|
+
+    s.action do |global_options,options,args|
+      unless File.exists? args[0]
+        STDERR.puts <<-HERE.gsub(/^ {10}/, '')
+          Error: #{args[0]} doesn't exist!
+          Internet Explorer stores its bookmarks in a directory structure.
+          the bookmarks are located in the user's home directory 
+          '~/AppData/Favorites'.
+        HERE
+        exit(0)
+      else
+        @designer.import_links(SycLink::InternetExplorer.new(args.shift))
+      end
+    end
+  end
+
+  c.desc 'Import links from a Directory'
+  c.long_desc <<-HERE.gsub(/^ {4}/, '')
+    The PATH_TO_DIRECTORY can have patterns that allows to import specific
+    files.
+
+    Examples:
+
+    PATH_TO_DIRECTORY/**/*.pdf will import all pdf-files in the directories and
+    sub-directory
+
+    PATH_TO_DIRECTORY/**/* will import all files and sub-directories
+  HERE
+
+  c.arg_name 'PATH_TO_DIRECTORY'
+  c.command :dir do |s|
+
+    s.action do |global_options,options,args|
+      @designer.import_links(SycLink::FileImporter.new(args.shift))
+    end
+  end
+end
+
+desc 'Export to csv'
+command :export do |c|
+
+  c.desc 'Export links to csv'
+  c.command :csv do |s|
+
+    s.action do |global_options,options,args|
+      puts @designer.export(:csv)
+    end
+  end
+
+end
+
 pre do |global,command,options,args|
   
   if WEBSITE_COMMANDS.include?(command.name)
@@ -281,10 +431,10 @@ on_error do |exception|
   end
 end
 
-def print_links(links, columns)
+def print_links(links, columns, opts = {})
   allowed_cols = %w{ url name description tag } 
   cols = columns.delete(' ').downcase.split(',') & allowed_cols
-  SycLink::Formatter.table(links, cols)
+  SycLink::Formatter.table(links, cols, opts)
 end
 
 exit run(ARGV)

data/lib/syclink/chrome.rb

@@ -0,0 +1,37 @@
+require "json"
+
+# Module that creates a link list and generates an html representation
+module SycLink
+
+  # Importer for Google Chrome links
+  class Chrome < Importer
+
+    # Reads the content of the Google Chrome bookmarks file
+    def read
+      serialized = File.read(path)
+      extract_links(JSON.parse(serialized)).flatten.each_slice(4).to_a
+    end
+
+    private
+
+    # Extracts the links from the JSON file
+    def extract_links(json)
+      json["roots"].collect do |key, children|
+        extract_children(children["name"], children["children"])
+      end
+    end
+
+    # Extracts the children from the JSON file
+    def extract_children(tag, children)
+      children.map do |child|
+        if child["children"]
+          extract_children("#{tag},#{child['name']}", child["children"])
+        else
+          [child["url"], child["name"], "", tag]
+        end
+      end
+    end
+
+  end
+
+end

data/lib/syclink/designer.rb

@@ -29,13 +29,31 @@ module SycLink
     # are added to the websie
     def add_links_from_file(file)
       File.foreach(file) do |line|
-        url, name, description, tag = line.split(';')
+        next if line.chomp.empty?
+        url, name, description, tag = line.chomp.split(';')
         website.add_link(Link.new(url, { name: name,
                                          description: description,
                                          tag: tag }))
       end
     end
 
+    # Accepts and SycLink::Importer to import Links and add them to the website
+    def import_links(importer)
+      importer.links.each do |link|
+        website.add_link(link)
+      end
+    end
+
+    # Export links to specified format
+    def export(format)
+      message = "to_#{format.downcase}"
+      if website.respond_to? message
+        website.send(message)
+      else
+        raise "cannot export to #{format}"
+      end
+    end
+
     # List links contained in the website and optionally filter on attributes
     def list_links(args = {})
       website.list_links(args)
@@ -52,6 +70,21 @@ module SycLink
       website.find_links(url).first.update(args)
     end
 
+    def update_links_from_file(file)
+      File.foreach(file) do |line|
+        next if line.chomp.empty?
+        url, name, description, tag = line.chomp.split(';')
+        website.find_links(url).first.update({ name:        name,
+                                               description: description,
+                                               tag:         tag })
+      end
+    end
+
+    # Merge links with same URL
+    def merge_links
+      website.merge_links_on(:url)
+    end
+
     # Deletes one or more links from the website. Returns the deleted links.
     # Expects the links provided in an array
     def remove_links(urls)

data/lib/syclink/exporter.rb

@@ -12,6 +12,12 @@ module SycLink
       renderer.result(binding)
     end
 
+    # Takes an array of row values and converts them to a csv string. Expects
+    # that the importing class is having a method rows.
+    def to_csv
+      rows.map { |row| row.join(';') }.join("\n")
+    end
+
   end
 
 end

data/lib/syclink/file_importer.rb

@@ -0,0 +1,19 @@
+module SycLink
+
+  class FileImporter < Importer
+
+    def read
+      root_dir = File.dirname(path).scan(/^[^\*|\?]*/).first
+      regex = Regexp.new("(?<=#{root_dir}).*")
+      Dir.glob(path).map do |file|
+        url = file
+        name = File.basename(file)
+        description = ""
+        tags = extract_tags(File.dirname(file).scan(regex))
+        [url, name, description, tags]
+      end
+    end
+
+  end
+
+end

data/lib/syclink/firefox.rb

@@ -0,0 +1,36 @@
+require 'sqlite3'
+require_relative 'importer'
+
+# Module that creates a link list and generates an html representation
+module SycLink
+
+  # Importer for Firefox links
+  class Firefox < Importer
+    
+    # Query strig to read links from the Firefox database places.sqlite
+    QUERY_STRING = "select p.url, p.title, b.title, a.content, k.keyword, b_t.title from moz_bookmarks b left outer join moz_keywords k on b.keyword_id = k.id left outer join moz_items_annos a on a.item_id = b.id left outer join moz_bookmarks b_t on b.parent = b_t.id join moz_places p on p.id = b.fk where p.url like 'http%';"
+
+    # Reads the links from the Firefox database places.sqlite
+    def read
+      bookmark_file = Dir.glob(File.expand_path(path)).shift
+      raise "Did not find file #{path}" unless bookmark_file
+
+      db = SQLite3::Database.new(path)
+
+      import = db.execute(QUERY_STRING)
+    end 
+
+    # Returns row values in Arrays
+    def rows
+      read.map do |row|
+        a = row[0]; b = row[1]; c = row[2]; d = row[3]; e = row[4]; f = row[5]
+        [a, 
+         b || c, 
+         (d || '').gsub("\n", ' '), 
+         [e, f].join(',').gsub(/^,|,$/, '')]
+      end
+    end
+
+  end
+
+end