insta_readability 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.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/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gem 'readit',:git=>'git@github.com:29decibel/readit.git'
+gem 'highline'
+
+gem 'rspec'
+gem 'mechanize'
+gem 'bourne'
+gem 'mocha'
+gem 'vcr'

data/Gemfile.lock

@@ -0,0 +1,62 @@
+GIT
+  remote: git@github.com:29decibel/readit.git
+  revision: 05446d377d3328f801fe5f7830b952e6acf7d2c6
+  specs:
+    readit (0.0.9)
+      hashie
+      multi_json
+      oauth
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    bourne (1.4.0)
+      mocha (~> 0.13.2)
+    diff-lcs (1.2.4)
+    domain_name (0.5.11)
+      unf (>= 0.0.5, < 1.0.0)
+    hashie (2.0.4)
+    highline (1.6.12)
+    mechanize (2.6.0)
+      domain_name (~> 0.5, >= 0.5.1)
+      mime-types (~> 1.17, >= 1.17.2)
+      net-http-digest_auth (~> 1.1, >= 1.1.1)
+      net-http-persistent (~> 2.5, >= 2.5.2)
+      nokogiri (~> 1.4)
+      ntlm-http (~> 0.1, >= 0.1.1)
+      webrobots (>= 0.0.9, < 0.2)
+    metaclass (0.0.1)
+    mime-types (1.23)
+    mocha (0.13.3)
+      metaclass (~> 0.0.1)
+    multi_json (1.7.2)
+    net-http-digest_auth (1.3)
+    net-http-persistent (2.8)
+    nokogiri (1.5.9)
+    ntlm-http (0.1.1)
+    oauth (0.4.7)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+    unf (0.1.1)
+      unf_ext
+    unf_ext (0.0.6)
+    vcr (2.4.0)
+    webrobots (0.1.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bourne
+  highline
+  mechanize
+  mocha
+  readit!
+  rspec
+  vcr

data/README.md

@@ -0,0 +1,34 @@
+InstaReadability
+=================
+
+Uploads bookmarks to Readability.com from an Instapaper CSV export
+
+Installation
+---
+
+`gem install insta_readability`
+
+
+Dependancies
+---
+You will need to have a Readability Key and Secret in a file as follows:
+
+    ```
+    # ~/.insta_readability.rb
+
+    Readit::Config.consumer_key = 'somename'
+    Readit::Config.consumer_secret = 'someSHA'
+
+    ```
+
+You can generate your key and secret at http://www.readability.com/account/api
+It will be under the _Reader API Key_ section.
+
+Usage
+---
+
+run the following and enter your username and password when prompter:
+
+```
+insta_readability csv_file
+```

data/bin/import

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'insta_readability'
+
+InstaReadability::CLI.run ARGV[0]

data/insta_readability.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require 'insta_readability/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'insta_readability'
+  s.version     = InstaReadability::VERSION
+  s.summary     = "InstaReadability"
+  s.description = "Upload exported Instapaper csv to Readability.com"
+  s.authors     = ["Will Mernagh"]
+  s.email       = 'wmernagh@gmail.com'
+  s.homepage    = 'https://github.com/wmernagh/insta_readability'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/insta_readability.rb

@@ -0,0 +1,6 @@
+require 'insta_readability/bookmark'
+require 'insta_readability/importer'
+require 'insta_readability/cli'
+
+module InstaReadability
+end

data/lib/insta_readability/auth.rb

@@ -0,0 +1,22 @@
+require 'highline/import'
+require 'oauth'
+require 'readit'
+require '~/.insta_readability'
+
+module InstaReadability
+  class Auth
+    def self.get_access_token
+      uname = highline.ask ("Username: ")
+      passwd = highline.ask ("Password: ") {|q| q.echo = false}
+
+      consumer = ::OAuth::Consumer.new(Readit::Config.consumer_key, Readit::Config.consumer_secret, :site=>"https://www.readability.com/", :access_token_path => "/api/rest/v1/oauth/access_token/")
+      consumer.get_access_token(nil, {}, {:x_auth_mode => 'client_auth', :x_auth_username => uname, :x_auth_password => passwd})
+    end
+
+    private
+
+    def self.highline
+      HighLine.new
+    end
+  end
+end

data/lib/insta_readability/bookmark.rb

@@ -0,0 +1,23 @@
+module InstaReadability
+  class Bookmark
+    ATTRIBUTES = [:url, :favorite, :archive, :allow_duplicates]
+    attr_reader *ATTRIBUTES
+
+    def initialize(options={})
+      @archive, @favorite, @allow_duplicates = 0, 0, 0
+      options.each_pair { |attr, value| instance_variable_set("@#{attr}", value) }
+    end
+
+    def ==(o)
+      o.class == self.class && o.to_hash == to_hash
+    end
+    alias_method :eql?, :==
+
+    def to_hash
+      ATTRIBUTES.inject({}) do |hash, attribute|
+        hash[attribute] = self.send attribute.to_s
+        hash
+      end
+    end
+  end
+end

data/lib/insta_readability/cli.rb

@@ -0,0 +1,27 @@
+require 'readit'
+require 'singleton'
+require 'insta_readability/auth'
+require 'insta_readability/instapaper_parser'
+
+module InstaReadability
+  class CLI
+    include Singleton
+    USAGE_MESSAGE = "Usage: $0 PATH_TO_CSV_FILE"
+    attr_reader :auth
+
+    def initialize
+      @auth = Auth.get_access_token
+    end
+
+    def self.run(csv_path='')
+      if csv_path == ''
+        $stderr.print USAGE_MESSAGE
+        return
+      end
+
+      parser   = InstaReadability::InstapaperParser.new csv_path
+      importer = InstaReadability::Importer.new(instance.auth.token, instance.auth.secret)
+      importer.import parser.create_bookmarks
+    end
+  end
+end

data/lib/insta_readability/importer.rb

@@ -0,0 +1,25 @@
+require 'logger'
+module InstaReadability
+  class Importer
+    def initialize(token, secret, logger=::Logger.new($stderr))
+      @logger = logger
+      @api    = Readit::API.new token, secret
+    end
+
+    def import(bookmarks)
+      bookmarks.each do |bm|
+        status = save bm
+        update status['bookmark_id'], bm if status['status'] == '409'
+        @logger.info status
+      end
+    end
+
+    def save(bookmark)
+      @api.bookmark bookmark.to_hash
+    end
+
+    def update(id, bookmark)
+      @api.update_bookmark id, bookmark.to_hash
+    end
+  end
+end

data/lib/insta_readability/instapaper_parser.rb

@@ -0,0 +1,24 @@
+require 'csv'
+
+module InstaReadability
+  class InstapaperParser
+    def initialize(csv_path)
+      @csv_path = csv_path
+    end
+
+    def create_bookmarks
+      bookmarks = []
+
+      CSV.foreach(@csv_path, headers: true) do |row|
+        bookmark = Bookmark.new ({
+          url: row['URL'],
+          favorite: row['Folder'] == 'Starred',
+          archive: row['Folder'] == 'Archive'
+        })
+        bookmarks << bookmark
+      end
+
+      bookmarks
+    end
+  end
+end

data/lib/insta_readability/version.rb

@@ -0,0 +1,3 @@
+module InstaReadability
+  VERSION = "0.0.1"
+end

data/spec/insta_readability/auth_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+require 'highline/import'
+
+describe InstaReadability::Auth do
+  let(:consumer) { stub(:get_access_token) }
+
+  before do
+    @old_stdout = $stdout
+    @old_stdin  = $stdin
+    $stdin      = StringIO.new
+    $stdout     = StringIO.new
+    @terminal   = ::HighLine.new($stdin, $stdout)
+    HighLine.stubs(:new).returns @terminal
+    @terminal.stubs(:ask).with('Username: ').returns 'wmernagh'
+    @terminal.stubs(:ask).with('Password: ').returns 'my-password'
+    OAuth::Consumer.stubs(:new).with(Readit::Config.consumer_key, Readit::Config.consumer_secret, :site=>"https://www.readability.com/", :access_token_path => "/api/rest/v1/oauth/access_token/").returns consumer
+  end
+
+  after do
+    $stdin  = @old_stdin
+    $stdout = @old_stdout
+  end
+
+  describe '.get_access_token' do
+    it 'prompts the user for their username' do
+      InstaReadability::Auth.get_access_token
+      expect(@terminal).to have_received(:ask).with "Username: "
+    end
+
+    it 'prompts the user for their password' do
+      InstaReadability::Auth.get_access_token
+      expect(@terminal).to have_received(:ask).with "Password: "
+    end
+
+    it 'returns the authenticated Readability token' do
+      consumer.stubs(:get_access_token).with(nil, {}, {:x_auth_mode => 'client_auth', :x_auth_username => 'wmernagh', :x_auth_password => 'my-password'}).returns 'token'
+      expect(InstaReadability::Auth.get_access_token).to eq 'token'
+    end
+  end
+end

data/spec/insta_readability/bookmark_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe InstaReadability::Bookmark do
+  describe 'new' do
+    context 'default bookmark' do
+      subject(:bookmark) { InstaReadability::Bookmark.new }
+
+      it 'sets default parameters to false' do
+        expect(bookmark.favorite).to be 0
+        expect(bookmark.archive).to be 0
+        expect(bookmark.allow_duplicates).to be 0
+      end
+    end
+
+    context 'custom bookmark' do
+      subject(:bookmark) do
+        InstaReadability::Bookmark.new url: 'url', favorite: true, archive: true
+      end
+
+      it 'assigns passed in parameters' do
+        expect(bookmark.favorite).to be true
+        expect(bookmark.archive).to be true
+        expect(bookmark.url).to eq 'url'
+      end
+    end
+  end
+
+  describe '==' do
+    let(:source) { InstaReadability::Bookmark.new(url: 1, favorite: 2, archive: 3) }
+
+    context 'all attributes are equal' do
+      let(:bookmark) { InstaReadability::Bookmark.new(url: 1, favorite: 2, archive: 3) }
+
+      it 'is returns true' do
+        expect(source == bookmark).to be true
+      end
+    end
+
+    context 'an attribute is different' do
+      let(:bookmark) { InstaReadability::Bookmark.new(url: 4, favorite: 2, archive: 3) }
+
+      it 'returns false' do
+        expect(source == bookmark).to be false
+      end
+    end
+  end
+
+  describe '#to_hash' do
+    let(:bookmark) { InstaReadability::Bookmark.new(url: 1, favorite: 2, archive: 3) }
+
+    it 'returns a hash of instance variables' do
+      expect(bookmark.to_hash).to eq({ url: 1, favorite: 2, archive: 3, :allow_duplicates=>0 })
+    end
+  end
+end

data/spec/insta_readability/cli_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe InstaReadability::CLI, '.run' do
+  let(:access_token) { OpenStruct.new(token: 'token', secret: 'secret') }
+  subject(:cli)      { InstaReadability::CLI }
+
+  before do
+    @old_stderr = $stderr
+    $stderr = StringIO.new
+    InstaReadability::Auth.stubs(:get_access_token).returns access_token
+  end
+
+  after do
+    $stderr = @old_stderr
+  end
+
+  context 'incorrect args' do
+    it 'does not authenticates the user' do
+      expect(InstaReadability::Auth).to have_received(:get_access_token).never
+    end
+
+    it 'returns without an import attempt' do
+      importer = mock
+      InstaReadability::Importer.stubs(:new).returns importer
+
+      cli.run
+
+      expect(importer).to have_received(:import).never
+    end
+
+    it 'prints out the usage instructions' do
+      $stderr.stubs(:print)
+      usage_message = "Usage: $0 PATH_TO_CSV_FILE"
+
+      cli.run
+
+      expect($stderr).to have_received(:print).with usage_message
+    end
+  end
+
+  context 'correct args' do
+    let(:importer) { mock(:import) }
+    let(:bookmarks) { mock }
+    let(:parser)   { mock(create_bookmarks: bookmarks) }
+
+    before do
+      csv_path = 'path to csv file'
+      InstaReadability::InstapaperParser.stubs(:new).with(csv_path).returns parser
+      InstaReadability::Importer.stubs(:new).with(access_token.token, access_token.secret).returns importer
+      cli.run csv_path
+    end
+
+    it 'authenticates the user' do
+      expect(InstaReadability::Auth).to have_received(:get_access_token)
+    end
+
+    it 'imports the bookmarks' do
+      expect(importer).to have_received(:import).with bookmarks
+    end
+  end
+end

data/spec/insta_readability/importer_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe InstaReadability::Importer do
+  let(:token)  { 'access token' }
+  let(:secret) { 'access token secret' }
+  let(:api)    { mock }
+  let(:logger) { mock }
+
+  subject(:importer) { InstaReadability::Importer.new token, secret, logger }
+
+  before do
+    Readit::API.stubs(:new).with(token, secret).returns api
+  end
+
+  describe 'initialize' do
+    it 'sets a readit api instance' do
+      expect(importer.instance_variable_get(:@api)).to be api
+    end
+  end
+
+  describe '#import' do
+    let(:bookmarks) { [1, 2, 3] }
+    let(:status)    { {:status => '202',:bookmark_id => '233444', :article_id => 't323r2'} }
+
+    before do
+      logger.stubs(:info)
+      importer.stubs(:save).returns(status)
+      importer.import bookmarks
+    end
+
+    it 'imports each bookmark' do
+      bookmarks.each do |bookmark|
+        expect(importer).to have_received(:save).with bookmark
+      end
+    end
+
+    it 'logs the result of the import' do
+      expect(logger).to have_received(:info).with(status).times(3)
+    end
+  end
+
+  describe '#save!' do
+    let(:bookmark) { InstaReadability::Bookmark.new(url: 4, favorite: 2, archive: 3) }
+
+    it 'creates a bookmark at Readability' do
+      api.stubs(:bookmark)
+
+      importer.save(bookmark)
+
+      expect(api).to have_received(:bookmark).with(bookmark.to_hash)
+    end
+  end
+end

data/spec/insta_readability/instapaper_parser_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe InstaReadability::InstapaperParser do
+  let(:csv)  { '/path/to/file' }
+
+  let(:rows) do
+    [
+      {
+        'URL'        => 'http://t.co/4MPuTK9dXn',
+        'Title'      => 'A silly title',
+        'Selection'  => 'No one cares',
+        'Folder'     => 'Archive',
+      },
+      {
+        'URL'        => 'http://t.co/guSIBHxBaV',
+        'Title'      => 'Some silly title',
+        'Selection'  => 'Who cares',
+        'Folder'     => 'Starred',
+      },
+      {
+        'URL'        => 'http://t.co/9FDQCZLDQm',
+        'Title'      => 'Another title',
+        'Selection'  => 'Who cares',
+        'Folder'     => 'Unread',
+      }
+    ]
+  end
+
+  subject(:parser) { InstaReadability::InstapaperParser.new csv }
+
+  before do
+    CSV.stubs(:foreach).with(csv, headers: true).multiple_yields(*rows.collect{|row| [row]})
+  end
+
+  describe 'new' do
+    it 'sets the csv instance variable' do
+      expect(parser.instance_variable_get(:@csv_path)).to be csv
+    end
+  end
+
+  describe '.parse' do
+    it 'parses the csv into bookmarks' do
+      book_params1 = { url: 'http://t.co/4MPuTK9dXn', favorite: false, archive: true }
+      book_params2 = { url: 'http://t.co/guSIBHxBaV', favorite: true, archive: false }
+      book_params3 = { url: 'http://t.co/9FDQCZLDQm', favorite: false, archive: false }
+      bookmarks    = [InstaReadability::Bookmark.new(book_params1), InstaReadability::Bookmark.new(book_params2), InstaReadability::Bookmark.new(book_params3)]
+
+      expect(parser.create_bookmarks).to eq bookmarks
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'bourne'
+require 'mocha/api'
+require 'vcr'
+require 'ostruct'
+require 'insta_readability'
+
+RSpec.configure do |config|
+  config.mock_with :mocha
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: insta_readability
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Will Mernagh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-17 00:00:00.000000000 Z
+dependencies: []
+description: Upload exported Instapaper csv to Readability.com
+email: wmernagh@gmail.com
+executables:
+- import
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- bin/import
+- insta_readability.gemspec
+- lib/insta_readability.rb
+- lib/insta_readability/auth.rb
+- lib/insta_readability/bookmark.rb
+- lib/insta_readability/cli.rb
+- lib/insta_readability/importer.rb
+- lib/insta_readability/instapaper_parser.rb
+- lib/insta_readability/version.rb
+- spec/insta_readability/auth_spec.rb
+- spec/insta_readability/bookmark_spec.rb
+- spec/insta_readability/cli_spec.rb
+- spec/insta_readability/importer_spec.rb
+- spec/insta_readability/instapaper_parser_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/wmernagh/insta_readability
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: InstaReadability
+test_files:
+- spec/insta_readability/auth_spec.rb
+- spec/insta_readability/bookmark_spec.rb
+- spec/insta_readability/cli_spec.rb
+- spec/insta_readability/importer_spec.rb
+- spec/insta_readability/instapaper_parser_spec.rb
+- spec/spec_helper.rb
+has_rdoc: