bulkippt 0.0.1 → 0.0.2

data/README.md

@@ -1,6 +1,6 @@
 # Bulkippt
 
-TODO: Write a gem description
+Allows you to upload your bookmarks to kippt.com in bulk. You'll need a kippt.com account (of course) from which you'll obtain your API token along with your username. From there, all you need is a CSV file with url, title and description headers and the loader will push those links to kippt.com on your behalf.
 
 ## Installation
 
@@ -17,8 +17,18 @@ Or install it yourself as:
     $ gem install bulkippt
 
 ## Usage
-
-TODO: Write usage instructions here
+```ruby
+require 'kippt'
+require 'bulkippt'
+require 'yaml' # if you store your creds in a yaml file
+
+creds = YAML.load(File.open(File.expand_path('./config/my_kippt_creds.yml')))
+service = Kippt::Client.new(username: creds['username'], token: creds['token'])
+loader = Bulkippt::Loader.new(client, Logger.new(STDOUT))
+csv_path = File.expand_path('./my_bookmarks.csv')
+bookmarks = loader.extract_bookmarks csv_path
+submitted = loader.submit_bookmarks bookmarks
+```
 
 ## Contributing
 

data/lib/bulkippt/fake_service.rb

@@ -0,0 +1,42 @@
+require 'ostruct'
+
+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

data/lib/bulkippt/version.rb

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

data/lib/bulkippt.rb

@@ -1,4 +1,5 @@
 require "bulkippt/version"
+require "bulkippt/fake_service"
 
 require 'csv'
 require 'logger'
@@ -28,40 +29,20 @@ module Bulkippt
 
     def extract_bookmarks(file_path)
       begin
-        raise Exception, "CSV not found: #{file_path}" if !File.exists?(file_path)
-
+        validate_file_path 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
+        validate_headers(normalize_headers(@csv.headers))
+        parse_csv(@csv)
       rescue => e
         @logger.error e.message
       end
     end
 
     def submit_bookmarks(bookmarks)
-      submitted = []
       begin
+        submitted = []
         bookmarks.each do |bookmark|
-          clip = @service.clips.build
-          clip.url = bookmark.url
-          clip.title = bookmark.title
-          clip.notes = bookmark.description
+          clip = clip_from_bookmark bookmark
           if clip.save
             submitted << clip
             @logger.info "SUCCESS: #{clip.title} #{clip.url}"
@@ -75,5 +56,43 @@ module Bulkippt
       end
     end
 
+    private
+
+    def parse_csv(csv)
+      result = []
+      csv.each do |b|
+        row = {}
+        b.to_hash.each_pair {|k,v| row.merge!({k.downcase => v})}
+        result << bookmark_instance(row['url'], row['title'], row.fetch('description',''), row.fetch('folder',''))
+      end
+      result
+    end
+
+    def normalize_headers(headers)
+      headers.map(&:downcase)
+    end
+
+    def validate_file_path(file_path)
+      raise Exception, "CSV not found: #{file_path}" if !File.exists?(file_path)
+    end
+
+    def validate_headers(headers)
+      #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'
+    end
+
+    def bookmark_instance(url, title, desc, folder)
+      OpenStruct.new(url: url, title: title, description: desc, folder: folder)
+    end
+
+    def clip_from_bookmark(bookmark)
+      clip = @service.clips.build
+      clip.url = bookmark.url
+      clip.title = bookmark.title
+      clip.notes = bookmark.description
+      clip
+    end
+
   end
 end

data/spec/spec_helper.rb

@@ -1,43 +1,2 @@
 %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

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bulkippt
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-11 00:00:00.000000000 Z
+date: 2012-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kippt
@@ -90,6 +90,7 @@ files:
 - Rakefile
 - bulkippt.gemspec
 - lib/bulkippt.rb
+- lib/bulkippt/fake_service.rb
 - lib/bulkippt/version.rb
 - spec/data/empty.csv
 - spec/data/good.csv