kindle_highlights_api 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 206ac339e94e87fb4382f489e9b1eb77dfe67ce2
+  data.tar.gz: df1ef9cd9913b727e96b34108ec603c9efb41138
+SHA512:
+  metadata.gz: a4890d220d0a605c901f53ac30a1b158a62c2b7236771f39e6c7b612e6630a310e526d1b840569699b77608bb41a5b234567de7c3c5f5347d96c5a6568377b98
+  data.tar.gz: b1f7b3ecb0eb6624bcb61caab10902da5ffbab8b1e71cc8b16e1f3e40a3869f764887cbb639c41277c2c52c8ab2e3aab7a19d6b021a161f8120c7a49ec0544ef

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+vendor/bundle
+.DS_Store

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in kindle_highlights_api.gemspec
+gemspec
+
+group :development, :test do
+  gem 'mocha'
+  gem 'fakeweb'
+  gem 'pry'
+  gem 'pry-debugger'
+  gem 'pry-rescue'
+  gem 'pry-stack_explorer'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Gaurav Chande
+
+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,73 @@
+# Kindle Highlights API
+
+A wrapper that helps fetch highlights from Amazon Kindle and play around with them.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'kindle_highlights_api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kindle_highlights_api
+
+## Usage
+
+```ruby
+require 'kindle_highlights_api'
+
+fetcher = KindleHighlightsAPI::Fetcher.new("yourusername@gmail.com", "somepassword")
+
+books = fetcher.fetch
+
+books.count # =>
+19
+
+books.map(&:title) # =>
+[
+  "Smalltalk Best Practice Patterns",
+  "Drawing on the Right Side of the Brain: The Definitive, 4th Edition",
+  "Benjamin Franklin: An American Life",
+  "Mucusless Diet Healing System",
+  "Crucial Conversations Tools for Talking When Stakes Are High, Second Edition",
+  "The War of Art",
+  "A Short History of Nearly Everything",
+  "Einstein: His Life and Universe",
+  "Turn the Ship Around!: A True Story of Turning Followers into Leaders",
+  "The 5 Elements of Effective Thinking",
+  ...
+]
+
+books.first.title # =>
+"Smalltalk Best Practice Patterns"
+
+books.first.highlights # =>
+[
+  "If you are trying to explain why code should be different, it is much more satisfying for you and the learner to be able to discuss the pattern and how it applies to the particular situation.",
+  "I’m constantly amazed at how even a little help cleaning up small problems reveals the source and solution of much bigger problems.",
+  "If you’re programming along, doing nicely, and all of a sudden your program gets balky, makes things hard for you, it’s talking. It’s telling you there is something important missing.",
+  "The problems in the construction of objects are universal. You have to name classes, relate classes via inheritance and delegation, relate methods in the same class and different classes, name variables, and so on. Patterns record these problems and how to approach solving them.",
+  "Keep all of the operations in a method at the same level of abstraction.",
+  "Any time you are sending two or more messages from one object to another in a single method, you may be able to create a Composed Method in the receiver that combines those messages.",
+  "There is probably no coding decision with more effect on the quality of your code than names you give your classes.",
+  "The first thing readers will look at when they look at your code is the names of the classes. Those names will go beyond your code. Insidiously, they leak into everyday conversation—and not just for developers. Ten years down the road, you will hear users who know nothing about programming using the class names you chose.",
+  "Unfortunately, many people get all formal when they go to name a superclass. Just calling it what it is isn’t enough. They have to tack on a flowery, computer science-y, impressive sounding, but ultimately meaningless word, like Object, Thing, Component, Part, Manager, Entity, or Item. You’re creating a vocabulary, not writing a program. Be a poet for a moment. The simple, the punchy, the easily remembered will be far more effective in the long run than some long name that says it all, but in such a way that no one wants to say it at all.",
+  "Name a superclass with a single word that conveys its purpose in the design.",
+  "if I am using inheritance strictly for code sharing, but the role of the subclass is different than the role of the superclass, I go back to Simple Superclass Name."
+  ...
+]
+
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/gauravmc/kindle_highlights_api/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,16 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+desc 'run all tests'
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end
+
+desc 'run kindle_highlights_api console'
+task :console do
+  exec 'pry -I lib -r kindle_highlights_api'
+end
+
+task default: :test

data/kindle_highlights_api.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kindle_highlights_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "kindle_highlights_api"
+  spec.version       = KindleHighlightsAPI::VERSION
+  spec.authors       = ["Gaurav Chande"]
+  spec.email         = ["gmail@gauravchande.com"]
+  spec.summary       = %q{A wrapper that helps fetch Kindle highlights and play around with them.}
+  spec.homepage      = "https://github.com/gauravmc/kindle_highlights_api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 0"
+  spec.add_development_dependency "mechanize", "~> 0"
+end

data/lib/kindle_highlights_api/book.rb

@@ -0,0 +1,19 @@
+module KindleHighlightsAPI
+  class Book
+    def initialize(page)
+      @page = page
+    end
+
+    def self.from_page(page)
+      Book.new(page)
+    end
+
+    def title
+      @title ||= @page.search("span[class=title] a text()").first.content
+    end
+
+    def highlights
+      @highlights ||= @page.search("span[class=highlight] text()").map(&:content)
+    end
+  end
+end

data/lib/kindle_highlights_api/fetcher.rb

@@ -0,0 +1,51 @@
+require 'mechanize'
+
+module KindleHighlightsAPI
+  class Fetcher
+    def initialize(email, password)
+      @email, @password = email, password
+    end
+
+    def fetch
+      fetch_all_books
+    end
+
+    private
+
+    def fetch_all_books
+      page = get_highlights_page
+
+      Array.new.tap do |books|
+        while next_book_link = page.link(id: 'nextBookLink') do
+          books << Book.from_page(page)
+          page = next_book_link.click
+        end
+      end
+    end
+
+    def get_highlights_page
+      kindle_home_page = login_to_amazon_kindle
+      kindle_home_page.link(href: "/your_highlights").click
+    end
+
+    def login_to_amazon_kindle
+      login_page = agent.get("https://kindle.amazon.com/login")
+
+      login_page.form_with(name: 'signIn') do |form|
+        form['email'] = @email
+        form['password'] = @password
+      end.submit
+    end
+
+    def agent
+      @agent ||= Mechanize.new do |a|
+        a.user_agent = 'Individueller User-Agent'
+        a.user_agent_alias = 'Mac Safari'
+        a.open_timeout = 10
+        a.read_timeout = 10
+        a.ssl_version = 'SSLv3'
+        a.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+    end
+  end
+end

data/lib/kindle_highlights_api/version.rb

@@ -0,0 +1,3 @@
+module KindleHighlightsAPI
+  VERSION = "0.2.0"
+end

data/lib/kindle_highlights_api.rb

@@ -0,0 +1,8 @@
+require "kindle_highlights_api/version"
+require "logger"
+
+module KindleHighlightsAPI
+end
+
+require_relative 'kindle_highlights_api/book'
+require_relative 'kindle_highlights_api/fetcher'

data/test/book_test.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+
+module KindleHighlightsAPI
+  class BookTest < MiniTest::Unit::TestCase
+    def test_from_page_creates_a_book_from_the_page
+      expectation = {
+        title: "Drawing on the Right Side of the Brain: The Definitive, 4th Edition",
+        highlight: "learning to draw, without doubt, causes new connections in the brain that can be useful over a lifetime for general thinking. Learning to see in a different way requires that you use your brain differently."
+      }
+
+      page = create_page_from_fixture(:highlights_page_1)
+      book = Book.from_page(page)
+
+      assert_equal expectation[:title], book.title
+      assert book.highlights.include?(expectation[:highlight])
+    end
+
+    private
+
+    def create_page_from_fixture(filename)
+      body = File.open("#{TEST_ROOT}/fixtures/html/#{filename.to_s}.html").read
+      mech = Mechanize.new
+      Mechanize::Page.new(nil, nil, body, nil, mech)
+    end
+  end
+end

data/test/fetcher_test.rb

@@ -0,0 +1,23 @@
+require 'test_helper'
+
+module KindleHighlightsAPI
+  class FetcherTest < MiniTest::Unit::TestCase
+    def test_fetch_returns_an_array_of_all_the_books
+      fetcher = Fetcher.new('some@email.com', 'password')
+
+      books = fetcher.fetch
+
+      expected_books = [
+        "Drawing on the Right Side of the Brain: The Definitive, 4th Edition",
+        "Mucusless Diet Healing System",
+        "Crucial Conversations Tools for Talking When Stakes Are High, Second Edition",
+        "The War of Art",
+        "Smalltalk Best Practice Patterns",
+        "A Short History of Nearly Everything"
+      ]
+
+      assert_equal expected_books, books.map(&:title)
+      assert_equal 6, books.size
+    end
+  end
+end