pinup 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NmE3YzhkNTM1NjZiY2E4OWUxOTI2M2NmYzI1ZjE1N2M5ZGVhOTk5OQ==
+  data.tar.gz: !binary |-
+    YzA2MzQxNjBiNmE1OWM5YjIwZDM3ZWFlMjZjMDViODAwOTkxOGM5Mw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    Y2Q3ODFlNTAxNzk3NGQ2MzUwNDRhNjU3ZTAyMzFkYzE4OGJlZTMyNTdiZTky
+    Nzc3ZTE3Y2JmZWFjNzMxYzEwNTI2NGY0ZDlhNWE5ODVhYmVjMzBmMWU0YTYx
+    ZmQ3NjEyZTg4ZWVmMmQyYmMzYWRmMDZiMThmM2M5NTFkMWI2MGQ=
+  data.tar.gz: !binary |-
+    OWY4NDNmOWMzZDBkYjY3ZjE3YjY3MzdlNDdjODJjNzgzMjlmYTdkYzYxOWZk
+    YmMxZTE4NDZjM2E0N2IzZDZhNTU3MzE1ZDJhNmE4ZTI2OTc0OGE4ODAzMTc1
+    MWM3ZjY0ZDRlYzc3MTFiOTFmYzVhNmE5MWQ5ZTA1OTVhN2IyOTY=

data/.gitignore

@@ -0,0 +1,53 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+####### OSX #######
+.DS_Store
+.AppleDouble
+.LSOverride
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear on external disk
+.Spotlight-V100
+.Trashes
+
+
+####### Ruby #######
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,5 @@
+# NOTE CI does not run all tests, some tests require valid Pinboard credentials in the netrc file
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,6 @@
+Copyright (c) 2013 Keith Smiley (http://keith.so)
+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,69 @@
+# pinup
+
+Pinup is a [RubyGem](http://rubygems.org/) for quickly getting through your [Pinboard](https://pinboard.in) bookmarks. It allows you to open or list your bookmarks and delete them afterwards (if you'd like).
+
+[![Build Status](https://travis-ci.org/Keithbsmiley/pinup.png?branch=master)](https://travis-ci.org/Keithbsmiley/pinup)
+[![Dependency Status](https://gemnasium.com/Keithbsmiley/pinup.png)](https://gemnasium.com/Keithbsmiley/pinup)
+
+## Authorization
+
+First you need to setup your Pinboard credentials. Either:
+
+```
+pinup authorize
+```
+
+This will ask you for your username and password, which are then used to get your user token from Pinboard and save it to your `~/.netrc`
+
+Or in your `~/.netrc` (get your token from <https://pinboard.in/settings/password> and split it at the `:`)
+
+```
+machine pinboard.in
+  login username
+  password token
+```
+
+Note that in the end these achieve the same result. Your Pinboard username and token (not password) are saved in your `~/.netrc` file. If you'd like to save it in a different location check out the `--path` argument with `pinup authorize -h`
+
+
+## Usage
+
+```
+pinup open
+```
+
+By default this will open your 20 most recent unread or untagged bookmarks in the default browser. If that's not to your fancy you can use some flags to change the behavior:
+
+```
+pinup open --no-untagged
+```
+
+This will open your 20 most recent unread bookmarks, without the untagged ones. There is also a `--no-unread` flag for just untagged entires. Using:
+
+```
+pinup open --no-untagged --no-unread
+```
+
+Will open bookmarks that are both tagged and marked as read. I think you get the idea. But of course you can also limit the number of responses.
+
+```
+pinup open -n 5
+pinup open --number=5
+```
+
+Will show the most recent five bookmarks. You can also delete the bookmarks from Pinboard as they are opened:
+
+```
+pinup open --no-untagged --delete -n 5
+```
+
+There is also a list command that takes the same arguments as `open` but instead of opening the URLs it just prints them one per line to the console. This way you could pipe the output in to another command for additional processing.
+
+## Installation
+
+```
+[sudo] gem install pinup
+```
+
+Pinup requires Ruby 1.9+ I recommend you install it with [rbenv](https://github.com/sstephenson/rbenv/). [RVM](https://rvm.io/) exists as well. Note that this is higher than the default installation on OS X. Ruby 1.8 is [no longer being supported](http://www.ruby-lang.org/en/news/2011/10/06/plans-for-1-8-7/) so I suggest you upgrade anyways.
+

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+# NOTE CI does not run all tests, some tests require valid Pinboard credentials in the netrc file
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = FileList['spec/**/*.rb'].exclude(/authorize|queries/)
+end
+
+task :default => :spec

data/bin/pinup

@@ -0,0 +1,92 @@
+#!/usr/bin/env ruby
+require 'gli'
+require 'pinup'
+
+include GLI::App
+
+program_desc 'Digest your Pinboard bookmarks in bulk'
+
+desc 'Print the version of pinup'
+version Pinup::VERSION
+
+desc "Print your bookmarks URL's to the console"
+command :list do |c|
+  c.desc 'Only show unread items'
+  c.default_value true
+  c.switch :unread
+
+  c.desc 'Only show untagged items'
+  c.default_value true
+  c.switch :untagged
+
+  c.desc 'Delete the items after opening them'
+  c.default_value false
+  c.switch :delete
+
+  c.desc 'The number of recent items to search through'
+  c.default_value 20
+  c.flag [:n, :number]
+
+  c.action do |global_options,options,args|
+    Pinup::List.list_pins(options)
+  end
+end
+
+desc 'Open your bookmarks with the specified settings in your browser'
+command :open do |c|
+  c.desc 'Only show unread items'
+  c.default_value true
+  c.switch :unread
+
+  c.desc 'Only show untagged items'
+  c.default_value true
+  c.switch :untagged
+
+  c.desc 'Delete the items after opening them'
+  c.default_value false
+  c.switch :delete
+
+  c.desc 'The number of recent items to search through'
+  c.default_value 20
+  c.flag [:n, :number]
+
+  c.action do |global_options,options,args|
+    Pinup::Open.open_pins(options)
+  end
+end
+
+desc 'Authorize your user credentials, you must run this first'
+command :authorize do |c|
+  c.desc 'Get your Pinboard credentials from your netrc'
+  c.switch :netrc
+
+  c.desc 'Custom netrc path'
+  c.flag :path
+
+  c.action do |global_options,options,args|
+    Pinup::Authorize.authorize_command(options)
+  end
+end
+
+pre do |global,command,options,args|
+  # Pre logic here
+  # Return true to proceed; false to abort and not call the
+  # chosen command
+  # Use skips_pre before a command to skip this block
+  # on that command only
+  true
+end
+
+post do |global,command,options,args|
+  # Post logic here
+  # Use skips_post before a command to skip this
+  # block on that command only
+end
+
+on_error do |exception|
+  # Error logic here
+  # return false to skip default error handling
+  true
+end
+
+exit run(ARGV)

data/lib/pinup.rb

@@ -0,0 +1,8 @@
+require 'pinup/bookmark'
+require 'pinup/queries'
+require 'pinup/settings'
+require 'pinup/version'
+
+require 'pinup/commands/authorize'
+require 'pinup/commands/list'
+require 'pinup/commands/open'

data/lib/pinup/bookmark.rb

@@ -0,0 +1,29 @@
+class Bookmark
+  attr_accessor :href, :unread, :untagged
+
+  def initialize(options = {})
+    @href     = options['href'] unless options['href'].nil?
+    @unread   = self.class.is_unread(options['toread']) unless options['toread'].nil?
+    @untagged = self.class.is_untagged(options['tags']) unless options['tags'].nil?
+  end
+
+  def self.is_unread(attribute)
+    if attribute == 'yes'
+      true
+    else
+      false
+    end
+  end
+
+  def self.is_untagged(attribute)
+    if attribute.strip.empty?
+      true
+    else
+      false
+    end
+  end
+
+  def to_s
+    "<Bookmark: ##{ self.object_id } URL: #{ @href } Unread: #{ self.unread } Untagged: #{ self.untagged }>"
+  end
+end

data/lib/pinup/commands/authorize.rb

@@ -0,0 +1,114 @@
+require 'io/console'
+require 'net/https'
+require 'uri'
+require 'json'
+require 'netrc'
+require 'colored'
+
+module Pinup
+  class Authorize
+    def self.authorize_command(options)
+      if options[:netrc]
+        authorize_netrc(options)
+      else
+        authorize_credentials(options)
+      end
+    end
+
+    def self.authorize_netrc(options = {})
+      path = DEFAULT_NETRC
+      if options[:path]
+        path = File.expand_path(options[:path])
+      end
+
+      netrc = Netrc.read(path)
+      username, password = netrc[PINBOARD_URL]
+      if username.nil? || password.nil?
+        puts "Couldn't read credentials from #{ path }".red
+        puts 'Valid netrc syntax for pinboard looks like:
+
+            machine pinboard.in
+              login username
+              password apitoken
+        
+              NOTE: Just include the digits from the API token for the password'.yellow
+        return nil
+      end
+
+      token = Pinup::Settings.token(username, password)
+      parameters = JSON_PARAMS.dup
+      parameters[:auth_token] = token
+      response = authorize({ params: parameters })
+
+      if response.code != '200'
+        puts "Invalid user credentials in #{ path }".red
+        return nil
+      elsif !path.nil? && DEFAULT_NETRC != path
+        Pinup::Settings.write_settings({ path: path })
+      else
+        Pinup::Settings.clear_settings
+      end
+
+      return true
+    end
+
+    def self.authorize_credentials(options = {})
+      # Ask for user and pass, save to passed or default netrc location
+      # Reading from options hash for testing
+      username = options[:username] || ask('Enter your username')
+      print 'Enter your password (not saved): ' if options[:password].nil?
+      password = options[:password] || STDIN.noecho(&:gets).chomp
+
+      parameters = { params: JSON_PARAMS.dup, username: username, password: password }
+      response = authorize(parameters)
+
+      if response.code != '200'
+        puts 'Invalid user credentials'.red
+        return nil
+      else
+        path = DEFAULT_NETRC
+        if options[:path]
+          path = File.expand_path(options[:path])
+        end
+
+        json   = JSON.parse(response.body)
+        digits = json['result']
+        token = Pinup::Settings.token(username, digits)
+
+        options[:path]  = path
+        options[:token] = token
+
+        Pinup::Settings.save_token(options)
+
+        return true
+      end
+    end
+
+    def self.ask(string)
+      print "#{ string }: "
+      gets.chomp
+    end
+
+    private
+
+      def self.authorize(options = {})
+        parameters = options[:params]   || {}
+        username   = options[:username] || {}
+        password   = options[:password] || {}
+
+        uri = URI.parse("#{ API_URL }/user/api_token")
+        uri.query = URI.encode_www_form(parameters)
+
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+
+        request = Net::HTTP::Get.new(uri.request_uri)
+        if !username.nil? && !username.empty? && !password.nil? && !password.empty?
+          request.basic_auth(username, password)
+        end
+
+        http.request(request)
+      end
+  end
+end

data/lib/pinup/commands/list.rb

@@ -0,0 +1,21 @@
+module Pinup
+  class List
+    def self.list_pins(options = {})
+      unread   = options[:unread]      unless options[:unread].nil?
+      untagged = options[:untagged]    unless options[:untagged].nil?
+      count    = options[:number].to_i unless options[:number].nil?
+      delete   = options[:delete]      unless options[:delete].nil?
+
+      items        = Pinup::Queries.list_items
+      filtered     = Pinup::Queries.filter_items(items, unread, untagged, count)
+      items_string = Pinup::Queries.item_string(filtered)
+      urls         = items_string.split(/\n/)
+
+      puts items_string
+
+      if delete
+        Pinup::Queries.delete_items(urls)
+      end
+    end
+  end
+end