bulkippt-cli 0.0.1

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.rvmrc
+.rspec
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+config/my_kippt_creds.yml
+Guardfile

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Johnny Boursiquot
+
+MIT License
+
+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,36 @@
+# Bulkippt CLI
+
+BulkipptCLI offers a command line interface alternative to using the Bulkippt gem (https://github.com/jboursiquot/bulkippt) in your application. If you just need to import your bookmarks from a CSV into your kippt.com account with a single one-liner from your shell, this is your tool.
+
+## Installation
+    
+	$ gem install bulkippt-cli
+
+## Usage
+
+Upon installation, the bulkippt command should be available to you in the terminal. Running the command without any arguments will list the available tasks you can perform. The built-in help can also assist you with invocation parameters like so:
+
+    $ bulkippt help submit
+
+To invoke the submit task (in test mode): 
+
+    $ bulkippt submit ~/path/to/my/bookmarks.csv -u kippt_username -t kippt_token
+
+The above command will submit the bookmarks you've listed in your CSV using your kippt.com username and token passed in through the -u and -t flags. See developers.kippt.com for that information.
+
+Your bookmarks CSV is expected to have the following columns: url, title, description.
+
+The result of running the command successfully will be something like this:
+
+    I, [2012-11-14T01:40:55.938107 #66997]  INFO -- : SUCCESS: Kippt http://www.kippt.com
+    I, [2012-11-14T01:40:55.938230 #66997]  INFO -- : SUCCESS: Pinboard http://pinboard.in
+    I, [2012-11-14T01:40:55.938288 #66997]  INFO -- : SUCCESS: Delicious http://delicious.com
+    3 bookmarks submitted
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes with tests (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+task :default => [:spec]
+
+desc 'Runs all specs'
+RSpec::Core::RakeTask.new(:spec)

data/bin/bulkippt

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/bulkippt'
+
+Bulkippt::CLI.start

data/bulkippt.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bulkippt/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "bulkippt-cli"
+  gem.version       = Bulkippt::VERSION
+  gem.authors       = ["Johnny Boursiquot"]
+  gem.email         = ["jboursiquot@gmail.com"]
+  gem.description   = %q{BulkipptCLI offers a command line interface alternative to using the Bulkippt gem in your application. If you just need to import your bookmarks from a CSV into your kippt.com account with a single one-liner from your shell, this is your tool.}
+  gem.summary       = %q{BulkipptCLI offers a command line interface alternative to using the Bulkippt gem in your application. If you just need to import your bookmarks from a CSV into your kippt.com account with a single one-liner from your shell, this is your tool.}
+  gem.homepage      = "https://github.com/jboursiquot/bulkippt-cli"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency 'kippt','~> 1.1.0'
+  gem.add_runtime_dependency 'bulkippt','~> 0.0.3'
+  gem.add_runtime_dependency 'thor'
+
+  gem.add_development_dependency 'rake','~> 0.9'
+  gem.add_development_dependency 'rspec','~> 2.11'
+  gem.add_development_dependency 'fivemat', '~> 1.1'
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'pry-debugger'
+
+end

data/lib/bulkippt.rb

@@ -0,0 +1,50 @@
+require 'thor'
+require 'logger'
+require 'bulkippt'
+require 'kippt'
+
+module Bulkippt
+
+  class CLI < Thor
+
+    desc 'submit CSV', 'Submits bookmarks from CSV to kippt.com'
+    method_option :username, aliases: '-u', desc: 'Your kippt.com username'
+    method_option :token, aliases: '-t', desc: 'Your kippt.com token'
+    method_option :environment, aliases: '-e', default: 'production', desc: 'Running environment of tool. When set to test, it will not submit to Kippt.com.'
+    def submit(csv)
+      begin
+        initialize_credentials options['username'], options['token']
+        initialize_bulkippt options['environment']
+
+        csv_path = File.expand_path(csv, __FILE__)
+        raise "File not found: #{csv}" unless File.exists?(csv_path)
+
+        bookmarks = @bulkippt.extract_bookmarks csv_path
+        submitted = @bulkippt.submit_bookmarks bookmarks
+        $stdout.puts "#{submitted.length} bookmarks submitted"
+
+      rescue => e
+        $stderr.puts e.message
+      end
+    end
+
+    private
+
+    def initialize_credentials(username, token)
+      raise 'Missing username argument' if username.nil? || username == 'username'
+      raise 'Missing token argument' if token.nil? || token == 'token'
+      @username = username
+      @token = token
+      nil
+    end
+
+    def initialize_bulkippt(env)
+      kippt = env == 'test' ? Bulkippt::FakeService.new(@username, @token) : Kippt::Client.new(username: @username, token: @token)
+      @bulkippt = Bulkippt::Loader.new(kippt)
+      raise 'Invalid username and/or token' unless @bulkippt.credentials_valid?
+      nil
+    end
+
+  end
+
+end

data/lib/bulkippt/version.rb

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

data/spec/data/good.csv

@@ -0,0 +1 @@
+URL,Title,Description,Folder

data/spec/lib/bulkippt/bulkippt_spec.rb

@@ -0,0 +1,77 @@
+require_relative '../../spec_helper'
+
+describe 'Bulkippt CLI' do
+
+  before(:all) do
+    @username = 'valid'
+    @token = 'valid'
+    @invalid_username = 'invalid'
+    @invalid_token = 'invalid'
+    @empty_csv = File.expand_path('../../../data/empty.csv',__FILE__)
+    @good_csv = File.expand_path('../../../data/good.csv',__FILE__)
+    @bad_csv = '/does/not/exist'
+  end
+
+  context 'when invoked without any parameters' do
+
+    it 'should respond with a task list' do
+      output = `./bin/bulkippt`
+      output.should include 'Tasks:'
+      output.should include 'bulkippt submit CSV'
+    end
+
+  end
+
+  context 'when submit task is invoked with missing or invalid paramters' do
+
+    it "should respond with 'bulkippt submit requires at least 1 argument...' if the csv passed in is invalid" do
+      output = `./bin/bulkippt submit -e test 2>&1`
+      output.should include 'bulkippt submit requires at least 1 argument'
+    end
+
+    it 'should respond with a missing username argument error if the -u|-username parameter is not provided' do
+      output = `./bin/bulkippt submit #{@empty_csv} -e test 2>&1`
+      output.should include 'Missing username argument'
+    end
+
+    it 'should respond with a missing username argument error if the -u|-username parameter is blank' do
+      output = `./bin/bulkippt submit #{@empty_csv} -u -e test 2>&1`
+      output.should include 'Missing username argument'
+    end
+
+    it 'should respond with a missing token argument error if the -t|-token parameter is not provided' do
+      output = `./bin/bulkippt submit #{@empty_csv} -u #{@username} -e test 2>&1`
+      output.should include 'Missing token argument'
+    end
+
+    it 'should respond with a missing token argument error if the -t|-token parameter is blank' do
+      output = `./bin/bulkippt submit #{@empty_csv} -u #{@username} -t -e test 2>&1`
+      output.should include 'Missing token argument'
+    end
+
+    it 'should respond with invalid username and/or token if validation of username/token fails' do
+      output = `./bin/bulkippt submit #{@good_csv} -u #{@invalid_username} -t #{@invalid_token} -e test 2>&1`
+      output.should include 'Invalid username and/or token'
+    end
+
+    it 'should respond with an invalid CSV error if the expected columns are not found in the CSV' do
+      output = `./bin/bulkippt submit #{@empty_csv} -u #{@username} -t #{@token} -e test 2>&1`
+      output.should include "Missing 'url' column"
+    end
+
+    it 'should respond with an invalid CSV error if the CSV cannot be found' do
+      output = `./bin/bulkippt submit #{@bad_csv} -u #{@username} -t #{@token} -e test 2>&1`
+      output.should include "File not found: #{@bad_csv}"
+    end
+
+  end
+
+  context 'when successfully parsing and submitting bookmarks' do
+
+    it 'should respond with at least 3 SUCCESS messages when bookmarks are successfully processed' do
+      output = `./bin/bulkippt submit #{@good_csv} -u #{@username} -t #{@token} -e test 2>&1`
+      output.should include 'SUCCESS'
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+%w{yaml pry}.each{ |lib| require lib}

metadata

@@ -0,0 +1,197 @@
+--- !ruby/object:Gem::Specification
+name: bulkippt-cli
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Johnny Boursiquot
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kippt
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: bulkippt
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: fivemat
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: BulkipptCLI offers a command line interface alternative to using the
+  Bulkippt gem in your application. If you just need to import your bookmarks from
+  a CSV into your kippt.com account with a single one-liner from your shell, this
+  is your tool.
+email:
+- jboursiquot@gmail.com
+executables:
+- bulkippt
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/bulkippt
+- bulkippt.gemspec
+- lib/bulkippt.rb
+- lib/bulkippt/version.rb
+- spec/data/empty.csv
+- spec/data/good.csv
+- spec/lib/bulkippt/bulkippt_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jboursiquot/bulkippt-cli
+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: BulkipptCLI offers a command line interface alternative to using the Bulkippt
+  gem in your application. If you just need to import your bookmarks from a CSV into
+  your kippt.com account with a single one-liner from your shell, this is your tool.
+test_files:
+- spec/data/empty.csv
+- spec/data/good.csv
+- spec/lib/bulkippt/bulkippt_spec.rb
+- spec/spec_helper.rb
+has_rdoc: