bulkippt 0.0.1

data/.gitignore

@@ -0,0 +1,19 @@
+*.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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bulkippt.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,24 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara request specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/requests/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+

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,29 @@
+# Bulkippt
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'bulkippt'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bulkippt
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`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/bulkippt.gemspec

@@ -0,0 +1,25 @@
+# -*- 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"
+  gem.version       = Bulkippt::VERSION
+  gem.authors       = ["Johnny Boursiquot"]
+  gem.email         = ["jboursiquot@gmail.com"]
+  gem.description   = %q{Imports bookmarks (url, title, etc) into your kippt.com account in bulk}
+  gem.summary       = %q{Imports bookmarks (url, title, etc) into your kippt.com account in bulk}
+  gem.homepage      = "https://github.com/jboursiquot/bulkippt"
+
+  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'
+
+  gem.add_development_dependency 'rake','~> 0.9'
+  gem.add_development_dependency 'rspec','~> 2.11'
+  gem.add_development_dependency 'fivemat', '~> 1.1'
+end

data/lib/bulkippt.rb

@@ -0,0 +1,79 @@
+require "bulkippt/version"
+
+require 'csv'
+require 'logger'
+
+module Bulkippt
+
+  class Loader
+
+    attr_reader :service, :logger
+
+    def initialize(service, logger = Logger.new(STDOUT))
+      @service = service
+      @logger = logger
+    end
+
+    def credentials_valid?
+      begin
+        @account = @service.account
+        true
+      rescue Kippt::APIError => e
+        false
+      rescue => e
+        @logger.error e.message
+        false
+      end
+    end
+
+    def extract_bookmarks(file_path)
+      begin
+        raise Exception, "CSV not found: #{file_path}" if !File.exists?(file_path)
+
+        @csv = CSV.read(file_path, {headers: true})
+        headers = @csv.headers.map(&:downcase) #normalize colum titles
+
+        #url and title are required, description and folder are not
+        raise Exception, "Missing 'url' column" unless headers.include? 'url'
+        raise Exception, "Missing 'title' column" unless headers.include? 'title'
+
+        bookmarks = []
+        @csv.each do |b|
+          row = {}
+          b.to_hash.each_pair do |k,v|
+            row.merge!({k.downcase => v}) 
+          end
+          bookmark = OpenStruct.new(url: row['url'], title: row['title'])
+          bookmark.description = row['description'] if headers.include? 'description'
+          bookmark.folder = row['folder'] if headers.include? 'folder'
+          bookmarks << bookmark
+        end
+        bookmarks
+      rescue => e
+        @logger.error e.message
+      end
+    end
+
+    def submit_bookmarks(bookmarks)
+      submitted = []
+      begin
+        bookmarks.each do |bookmark|
+          clip = @service.clips.build
+          clip.url = bookmark.url
+          clip.title = bookmark.title
+          clip.notes = bookmark.description
+          if clip.save
+            submitted << clip
+            @logger.info "SUCCESS: #{clip.title} #{clip.url}"
+          else
+            @logger.error "FAILURE: #{clip.title} #{clip.url} | #{clip.errors[]}"
+          end
+        end
+        submitted
+      rescue => e
+        @logger.error e.message
+      end
+    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_spec.rb

@@ -0,0 +1,59 @@
+require_relative '../spec_helper'
+
+describe "Bulkippt" do
+
+  context "when asked to verify credentials" do
+
+    it "should detect that a given set of credentials is incorrect" do
+      Bulkippt::Loader.new(Bulkippt::FakeService.new('invalid', 'invalid')).credentials_valid?.should be_false
+    end
+
+    it "should detect that a given set of credentials is correct" do
+      Bulkippt::Loader.new(Bulkippt::FakeService.new('valid', 'valid')).credentials_valid?.should be_true
+    end
+
+  end
+
+  context "when parsing an invalid CSV" do
+
+    let :bad_csv do
+      File.expand_path './spec/data/empty.csv'
+    end
+
+    it "should raise an error when it can't find the file specified" do
+      loader = Bulkippt::Loader.new(Bulkippt::FakeService.new('valid','valid'))
+      expect {loader.extract_bookmarks('/does/not/exist.csv')}.to raise_error
+    end
+
+    it "should raise an error when missing the require url and title columns" do
+      loader = Bulkippt::Loader.new(Bulkippt::FakeService.new('valid', 'valid'))
+      expect { loader.extract_bookmarks bad_csv }.to raise_error
+    end
+
+  end
+
+  context "when parsing a valid CSV" do
+
+    let :good_csv do
+      File.expand_path './spec/data/good.csv'
+    end
+
+    it "should find all the bookmarks" do
+      loader = Bulkippt::Loader.new(Bulkippt::FakeService.new('valid', 'valid'))
+      clips = loader.extract_bookmarks good_csv
+      clips.class.should == Array
+      clips.size.should >= 3
+    end
+
+    it "should use the service to submit the bookmarks" do
+      loader = Bulkippt::Loader.new(Bulkippt::FakeService.new('valid', 'valid'))
+      bookmarks = loader.extract_bookmarks good_csv
+      saved = loader.submit_bookmarks bookmarks
+      saved.class.should == Array
+      saved.first.url.should == 'http://www.kippt.com'
+      saved.first.title.should == 'Kippt'
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,43 @@
+%w{kippt json}.each{ |lib| require lib}
+%w{bulkippt}.each { |file| require File.join(File.dirname(__FILE__),"../lib", file)}
+
+module Bulkippt
+
+  class FakeService
+
+    attr_reader :username, :token, :clips
+
+    def initialize(username, token)
+      @username = username
+      @token = token
+      @clips = Clips.new
+    end
+
+    def account
+      if credentials_valid?(@username, @token) 
+        {username: @username, token: @token}.to_json
+      else 
+        raise Kippt::APIError, "Can't find an user with this username and api_key"
+      end
+    end
+
+    def credentials_valid?(username, token)
+      return false if username != 'valid' && @token != 'valid'
+      true
+    end
+
+  end
+
+  class Clips
+    def build
+      Clip.new
+    end
+  end
+
+  class Clip < OpenStruct
+    def save
+      self
+    end
+  end
+
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: bulkippt
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Johnny Boursiquot
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-11 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !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'
+description: Imports bookmarks (url, title, etc) into your kippt.com account in bulk
+email:
+- jboursiquot@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bulkippt.gemspec
+- lib/bulkippt.rb
+- lib/bulkippt/version.rb
+- spec/data/empty.csv
+- spec/data/good.csv
+- spec/lib/bulkippt_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jboursiquot/bulkippt
+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: Imports bookmarks (url, title, etc) into your kippt.com account in bulk
+test_files:
+- spec/data/empty.csv
+- spec/data/good.csv
+- spec/lib/bulkippt_spec.rb
+- spec/spec_helper.rb