pinboard_tools 0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 54e48d7bb927ea39cb94f22ad0a3d55ab930db5f
+  data.tar.gz: 77044fc0e716639ae0907dd1a354b2d478b9be1f
+SHA512:
+  metadata.gz: f4d8b22711c00c3c1c921b44b5829f5a9529f051f1d24085c68a4820b28962fd83568d69f2b7d60b3c49ca827be1fc725ab39f0138fec8a08b7ba6074c33f2c3
+  data.tar.gz: 61f216d601ebc4598154720cd37719f7df11180f56a3e6a4da9bb117e298d7d941e76c9e0a8fd69694a86ef399effa50612b446171c094cf316c4e8afddebf69

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,56 @@
+# rcov generated
+coverage
+coverage.data
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# config files
+.yml
+
+# jeweler generated
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore:
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+.DS_Store
+*.yml
+.env
+*.gem
+Gemfile.lock
+
+# For TextMate
+#*.tmproj
+#tmtags
+
+# For emacs:
+#*~
+#\#*
+#.\#*
+
+# For vim:
+#*.swp
+
+# For redcar:
+#.redcar
+
+# For rubinius:
+#*.rbc

data/.ruby-version

@@ -0,0 +1 @@
+2.1.1

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+gem 'pinboard'
+gem 'nokogiri-plist'
+gem 'embedly'
+gem 'progress_bar'
+gem "docopt"
+gem "highline"

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Nick Prokesch
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,73 @@
+#Pinboard Tools
+
+## Synopsis
+
+Pinboard Tools is a helpful organizer for your existing [Pinboard](http://www.pinboard.in) bookmarks. When run against user-specified tags, it will find the appropriate title, synopsis and keyword tags for each matching article URL and save them to Pinboard as unread items. Pinboard Tools uses the [Embedly API][7071-001], in order to optimize speed, quality, and consistency. 
+
+## Code Example
+
+    |2.0.0-p0| giggy in ~/dev/pinboard_tools    
+    $  pinboard_tools tag fever
+    => [##########################################################] [1/1] [100.00%] [00:03] [00:00] [0.32/s]
+
+
+## Motivation
+
+I have been saving articles to Pinboard for about a year, but attempted to use various auto-tagging systems, such as [delicio.us](http://delicio.us) tagging suggestions and [IFTTT](http://IFTTT.com) RSS tags. The result of those two workflows resulted in a mess of useless tags, and an almost useless tag cloud. 
+
+I needed a way to make sense of my existing bookmarks, to make them browsable by tag and searchable, with correct article titles (not just the ones added by saving from an article link), and usable descriptions. The [Embedly Extract API][7071-002] does a beautiful job of handling these tasks, using a hierarchy of acceptable meta data sources within articles. [Embedly][7071-001] can determine which element on a page is best suited for the data you want to retrieve. 
+
+After a bit of tinkering, I came up with this simple script. It gets all of your pinboard articles, filters them by tag, and passes each one through Embedly, replacing existing meta-data.
+
+## Installation
+
+You will need:
+
+* A [Pinboard][7071-003] account
+* An [Embedly API ][7071-001] key (free for 5000 requests per month)
+
+Install the gem
+
+    gem install pinboard_tools
+
+To configure, run the `init` command to store your Pinboard login and Embedly API token
+  
+      pinboard_tools init
+
+You will be prompted for you [pinboard][7071-003] username and password, as well as your [Embedly][7071-001] API key. 
+ 
+*  I have only tested against Ruby 2.1.1
+  
+    
+  
+
+## Usage
+
+    pinboard_tools <command> <argument>
+   
+ Pinboard Tools accepts two arguments. 
+ 
+     pinboard_tools safari [-v]
+Runs the Safari Reading List import to Pinboard task. This will parse your Reading List plist file, extract resolvable URLs, use Embedly to determine the correct metadata, and add each item to Pinboard. Once complete, it will clear out the Reading List to prevent duplicate tasks and minimize future Embedly API usage. 
+
+    pinboardtools tag [optional tag name] [-v]
+ Runs the pinboard re-tagger task. When run without a tag name, it will process every article you saved to Pinboard. If you specify a tag (case sensitive), it will process every article that has that tag, and replace the metadata of the item with Embedly data. 
+
+ Adding the `-v` option to either command will display a progress bar for the parsing queue.
+
+## Tests
+
+Tests are written in cucumber, and ensure your connection to pinboard and Embedly.
+
+## Contributors
+
+All suggestions and pull requests are welcome. Add all issues and bugs to the Issues page.
+
+## License
+
+Licensed under the [MIT license][7071-005]. 
+[7071-001]: http://embed.ly/ "Embedly: Front-end developer tools for websites and apps"
+[7071-002]: http://embed.ly/docs/extract/api "Extract - API | Embedly"
+[7071-003]: http://pinboard.in/ "Pinboard: social bookmarking for introverts"
+[7071-004]: https://github.com/bundler/bundler/ "bundler/bundler · GitHub"
+[7071-005]: http://opensource.org/licenses/MIT "The MIT License (MIT) | Open Source Initiative"

data/Rakefile

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+require 'highline/import'
+require 'yaml'
+namespace :pinboard do
+  task :login do
+    say("\nPlease enter your Pinboard credentials")
+    puts ""
+    user    = ask("Pinboard username:   ")
+    pass    = ask("Pinboard password:   ") { |q| q.echo = "*" }
+    embedly = ask("Embedly API key:     ")
+    this = {pinboard_user: user.to_s, pinboard_pass: pass.to_s, embedly_key: embedly.to_s}
+    puts this.to_yaml
+    dir = %x{mkdir -p config} rescue false
+
+    config_path = File.expand_path("../config/pinboard.yml", __FILE__)
+        File.open(config_path, "w") do |f|
+          f.write(this.to_yaml)
+        end
+  end
+end

data/bin/pinboard_tools

@@ -0,0 +1,59 @@
+#!/usr/bin/ruby
+
+require_relative '../lib/pinboard_tools'
+require "docopt"
+doc = <<DOCOPT
+LazyCupid
+
+Usage:
+  #{__FILE__} init
+  #{__FILE__} tag [<tag>] [-v]
+  #{__FILE__} safari [-v]
+
+  Options:
+  -h        Show this screen.
+  --version     Show version.
+  tag=<tag>     tags to target for re-tagging.
+  safari      import safari reading list.
+  -v      Show console output.
+  init      Setup pingboard and Embedly credentials.
+
+DOCOPT
+
+
+begin
+  begin
+    options = Docopt::docopt(doc)
+  rescue Exception => e
+    puts e.message
+    exit
+  end
+  # puts options
+  verbose = options["-v"]
+
+  if options["-h"]
+    require "pp"
+    pp Docopt::docopt(doc)
+  elsif options["init"]
+    say("\nPlease enter your Pinboard credentials")
+    user    = ask("Pinboard username:   ")
+    pass    = ask("Pinboard password:   ") { |q| q.echo = "*" }
+    embedly = ask("Embedly API key:     ")
+    this = {pinboard_user: user.to_s, pinboard_pass: pass.to_s, embedly_key: embedly.to_s}
+    dir = %x{mkdir -p ../../config}
+    %x{touch ../../config/pinboard.yml}
+    config_path = File.expand_path("../../config/pinboard.yml", __FILE__)
+    File.open(config_path, "w") do |f|
+      f.write(this.to_yaml)
+    end
+  elsif options["tag"]
+    tags = options["<tag>"]
+    tagger = PinboardTools::Tagger.new(tag: tags, verbose: verbose)
+    tagger.run
+  elsif options["-s"] || options["safari"]
+    import = PinboardTools::SafariReadingListImporter.new(verbose: verbose)
+    import.run
+  end
+rescue Interrupt, SystemExit
+  print "\rShutting down..."
+end

data/lib/pinboard_tools.rb

@@ -0,0 +1,10 @@
+require_relative "pinboard_tools/version"
+require 'highline/import'
+
+module PinboardTools
+
+  Dir[File.dirname(__FILE__) + '/pinboard_tools/*.rb'].each do |file|
+    require file
+  end
+
+end

data/lib/pinboard_tools/pinboard_tagger.rb

@@ -0,0 +1,116 @@
+require 'pinboard'
+require 'progress_bar'
+require 'embedly'
+require 'yaml'
+require 'open-uri'
+
+# Detect if a string contains only a numeric value
+class String
+  def is_number?
+    true if Float(self) rescue false
+  end
+end
+
+
+module PinboardTools
+
+  # Replaces keywords on select Pinboard articles via Embed.ly
+  #
+  # @param tag [Symbol] defines a string tag for tagger to filter articles by
+  #
+  class Tagger
+    attr_reader :pb_user, :pb_pass, :pinboard
+
+    def initialize(args)
+      config_path = File.expand_path("../../../config/pinboard.yml", __FILE__)
+      @config = YAML.load_file(config_path)
+      begin
+        @embedly_key = @config[:embedly_key].to_s
+        @pb_user = @config[:pinboard_user]
+        @pb_pass = @config[:pinboard_pass]
+      rescue
+        puts "Credentials not found. Please run `pinboardtools init`"
+        exit
+      end
+      @errors = 0
+      # @_tag = Array.new
+      @_tag = args[:tag]
+      @verbose = args[:verbose]
+      @pinboard = {}
+    end
+
+    # Handles downloading new metadata for articles via Embed.ly Extract API
+    #
+    # @param url [String] URL of article to fetch keywords for
+    # @return [Hash] A collection of important metadata tags for article:
+    #   keywords [Array] 5 most relevant keywords for article
+    #   title [String] the most likely title for the article
+    #   excert [String] an excerpt or description for the article
+    #
+    def get_metadata(url)
+      title, description, tags, error_code, type = "", "", Array.new, nil, nil
+      embedly_api = Embedly::API.new :key => @embedly_key
+      # single url
+      obj = embedly_api.extract :url => url
+      obj.each do |i|
+        i.keywords.each do |k|
+          tags.push k["name"] unless k["name"].is_number?
+        end
+        tags << "unread"
+        title = i.title
+        desription = i.description
+        error_code = ""
+        error_code = i.respond_to?(:error_code) ? i.error_code : 200
+        # p i
+        type = i.type
+      end
+      return {keywords: tags.take(5), title: title, excerpt: description, error_code: error_code, type: type}
+    end
+
+    # Initiates new Pinboard session, fetches articles to be re-tagged, and applies new tags
+    #
+    def run
+      pinboard = Pinboard::Client.new(:username => @pb_user, password: @pb_pass)
+      posts = []
+      # unless @_tag.empty? && @_tag.is_a Array
+      if @_tag.is_a? Array
+        @_tag.each do |t|
+          pinboard.posts(tag: t).each {|p| posts << p}
+        end
+      else
+        begin
+          posts = pinboard.posts(:tag => @_tag)
+        rescue Exception => e
+          posts = pinboard.posts
+        end
+      end
+      # else
+      # posts = pinboard.posts(:results => 10)
+      # end
+      bar = ProgressBar.new(posts.size)
+      posts.each do |post|
+
+        tag_list = Array.new
+        post_metadata = get_metadata(post.href)
+        params = {
+          url: post.href,
+          description: post_metadata[:title],
+          tags: post_metadata[:keywords],
+          replace: true,
+          :public => true,
+          :toread => true,
+          :type => post_metadata[:type]
+        }
+        if post_metadata[:error_code] == 404
+          pinboard.delete(post.href)
+        elsif params[:type] != "html"
+          pinboard.add(url: post.href, tags: [params[:type]], description: post.href)
+        else
+          pinboard.add(params) rescue @errors += 1
+        end
+        bar.increment! if @verbose
+      end
+      puts "#{@errors} errors."
+    end
+  end
+end

data/lib/pinboard_tools/srl_to_pinboard.rb

@@ -0,0 +1,62 @@
+#!/usr/bin/env ruby
+
+require 'net/https'
+require 'open-uri'
+require 'pinboard'
+require 'progress_bar'
+require 'embedly'
+require_relative 'pinboard_tagger'
+
+class String
+  def is_number?
+    true if Float(self) rescue false
+  end
+end
+
+module PinboardTools
+
+  class SafariReadingListImporter
+    attr_accessor :tagger
+
+    def initialize(args)
+      @tagger = Tagger.new(tag: nil, verbose: args[:verbose])
+    end
+
+    def run
+      links = Array.new
+
+      # from gist: https://gist.github.com/andphe/3232343
+      input = %x[/usr/bin/plutil -convert xml1 -o - ~/Library/Safari/Bookmarks.plist | grep -E  -o '<string>http[s]{0,1}:/.*</string>' | grep -v icloud | sed -E 's/<\/{0,1}string>/g']
+
+      input.scan(/(http.+){/).each do |url|
+        links.push url.first
+
+        # p link
+      end
+
+      pinboard, bar = Pinboard::Client.new(:username => tagger.pb_user, password: tagger.pb_pass), ProgressBar.new(links.size)
+
+      links.reverse_each do |url|
+        begin
+          meta = tagger.get_metadata(url)
+
+          article = {
+            url: url,
+            description: meta[:title],
+            extended: meta[:excerpt],
+            tags: meta[:keywords],
+            replace: true,
+            toread: true,
+            :public => false
+          }
+
+          pinboard.add(article) rescue false
+        rescue
+        end
+
+        bar.increment!
+      end
+      clear_list = %x{cp -R ~/dev/pinboard_tools/lib/Bookmarks.plist ~/Library/Safari/Bookmarks.plist}
+    end
+  end
+end

data/lib/pinboard_tools/version.rb

@@ -0,0 +1,3 @@
+module PinboardTools
+  PinboardTools::VERSION = '0.4'
+end

data/pinboard_tools.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pinboard_tools/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pinboard_tools"
+  spec.version       = PinboardTools::VERSION
+  spec.authors       = ["Nick Prokesch"]
+  spec.email         = ["nick@prokes.ch"]
+  spec.summary       = %q{a helpful organizer for your existing Pinboard bookmarks}
+  spec.description   = %q{Auto-tagger with embedly support, safari reading list importer, dead link remover}
+  spec.homepage      = "https://github.com/prokizzle/pinboard_tools"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.require_paths    = ["lib"]
+  spec.bindir = 'bin'
+  spec.executables << 'pinboard_tools'
+
+  spec.add_dependency "pinboard", "~> 0.1"
+  spec.add_dependency "nokogiri-plist", "~> 0.5"
+  spec.add_dependency "progress_bar", "~> 1.0"
+  spec.add_dependency "embedly", "~> 1.8"
+  spec.add_dependency "docopt", "~> 0.5"
+  spec.add_dependency "highline", "~> 1.6"
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'pinboard_tagger'
+
+class Test::Unit::TestCase
+end

data/test/test_pinboard_tagger.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestPinboardTagger < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: pinboard_tools
+version: !ruby/object:Gem::Version
+  version: '0.4'
+platform: ruby
+authors:
+- Nick Prokesch
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pinboard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: nokogiri-plist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: progress_bar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: embedly
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: docopt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: Auto-tagger with embedly support, safari reading list importer, dead
+  link remover
+email:
+- nick@prokes.ch
+executables:
+- pinboard_tools
+extensions: []
+extra_rdoc_files: []
+files:
+- ".document"
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/pinboard_tools
+- config/pinboard.yml
+- lib/Bookmarks.plist
+- lib/pinboard_tools.rb
+- lib/pinboard_tools/pinboard_tagger.rb
+- lib/pinboard_tools/srl_to_pinboard.rb
+- lib/pinboard_tools/version.rb
+- pinboard_tools.gemspec
+- test/helper.rb
+- test/test_pinboard_tagger.rb
+homepage: https://github.com/prokizzle/pinboard_tools
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: a helpful organizer for your existing Pinboard bookmarks
+test_files: []