bookcrawler 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d599e5d0be33f3bb0f0f6c1f8fbc01fcf682a3e6
+  data.tar.gz: a24d09141afaa07e1f243528b442bd3186efffd8
+SHA512:
+  metadata.gz: 73e59026328d672ae3ee5f46b8c08f795cb3facf85c485f204166e62579314541cddb28787f792d55c3886d1187bf9f19af09a6f6e1a385c0dec02ca17b15d31
+  data.tar.gz: b418b4dae3f2d4e5a1bc4c2cfd8f8c12b37911b9f416b9652f846fa9c2db81137db4dcc4aad5bfeff11664c208bcfaf3ff258b8bfe8635350ef87489cec05897

data/.gitignore

@@ -0,0 +1,37 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+.idea/
+

data/.ruby-version

@@ -0,0 +1 @@
+2.2.2

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,42 @@
+PATH
+  remote: .
+  specs:
+    bookcrawler (0.1.0)
+      vacuum (~> 1.3.0)
+      vcr (~> 2.9.3)
+      webmock (~> 1.19.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.8)
+    awesome_print (1.2.0)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    excon (0.45.4)
+    jeff (1.5.1)
+      excon (>= 0.22.1)
+    minitest (5.5.1)
+    multi_xml (0.5.5)
+    rake (10.4.2)
+    safe_yaml (1.0.4)
+    vacuum (1.3.0)
+      jeff (~> 1.0)
+      multi_xml (~> 0.5.0)
+    vcr (2.9.3)
+    webmock (1.19.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print
+  bookcrawler!
+  bundler (~> 1.10)
+  minitest
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.10.6

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Jorge Manrubia
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Jorge Manrubia
+
+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,50 @@
+# Bookcrawler
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bookcrawler'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bookcrawler
+
+## Usage
+
+Set your [Amazon credentials](https://affiliateprogram.amazon.com/gp/flex/advertising/api/sign-in.html) as env vars:
+
+```
+export AWS_ACCESS_KEY_ID=...
+export AWS_SECRET_ACCESS_KEY=...
+export AMAZON_ASSOCIATES_TRACKING_ID=...
+```
+
+Find a book:
+
+```ruby
+crawler = Bookcrawler::Client.new
+book = crawler.find_by_title('A Clash of Kings')
+
+# <Bookcrawler::Book:
+#   asin: "0553579908",
+#   title: "A Clash of Kings (A Song of Ice and Fire, Book 2)",
+#   author: "George R. R. Martin",
+#   detail_page_url: "http://...",
+#   cover_url: "http://...">
+```
+
+You can fetch the book cover from `cover_url`. Support for covers is not official in the [Amazon Product Advertising API](https://affiliate-program.amazon.com/gp/advertising/api/detail/main.html). The url is generated according to [this article](http://aaugh.com/imageabuse.html).
+
+This gem uses [Vacuum](https://github.com/hakanensari/vacuum) under the hood.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bookcrawler"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bookcrawler.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bookcrawler/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bookcrawler"
+  spec.version       = Bookcrawler::VERSION
+  spec.authors       = ["Jorge Manrubia"]
+  spec.email         = ["jorge.manrubia@gmail.com"]
+
+  spec.summary       = %q{Simple mechanism for fetching books metadata using Amazon Product Advertising API}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/jorgemanrubia/bookcrawler"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+
+  spec.add_dependency "vcr", "~> 2.9.3"
+  spec.add_dependency "vacuum", "~> 1.3.0"
+  spec.add_dependency "webmock", "~> 1.19.0"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "awesome_print"
+end

data/lib/bookcrawler/book.rb

@@ -0,0 +1,18 @@
+require 'ostruct'
+
+module Bookcrawler
+  class Book
+    attr_accessor :asin, :title, :author, :detail_page_url
+
+    def initialize(properties)
+      properties.each do |key, value|
+        self.send("#{key}=", value)
+      end
+    end
+
+    def cover_url
+      #see http://aaugh.com/imageabuse.html
+      "http://images.amazon.com/images/P/#{asin}.01.ZTZZZZZZ.jpg"
+    end
+  end
+end

data/lib/bookcrawler/client.rb

@@ -0,0 +1,66 @@
+require 'ostruct'
+require 'vacuum'
+
+module Bookcrawler
+  class Client
+    def find_by_title(title)
+      entries = find_all_entries_by_title(title)
+      target_entry = entries[0]
+
+      if target_entry
+        create_book_from_vacuum_entry(target_entry)
+      else
+        nil
+      end
+    end
+
+    private
+
+    def vacuum_client
+      @vacuum_client ||= configure_vacuum_client
+    end
+
+    def configure_vacuum_client
+      Vacuum.new.tap do |client|
+        client.configure(
+            associate_tag: ENV['AMAZON_ASSOCIATES_TRACKING_ID']
+        )
+      end
+    end
+
+    def find_all_entries_by_title(title)
+      response = search_book_in_vacuum_by_title(title)
+
+      results = response.to_h
+      ['ItemSearchResponse', 'Items', 'Item'].each do |attribute_name|
+        next unless results
+        results = results[attribute_name]
+      end
+
+      (results || []).collect { |result| vacuum_result_as_object(result) }
+    end
+
+    def search_book_in_vacuum_by_title(title)
+      vacuum_client.item_search(
+          query: {
+              'Keywords' => title,
+              'SearchIndex' => 'Books'
+          }
+      )
+    end
+
+    def vacuum_result_as_object(entry)
+      attributes = entry['ItemAttributes']
+      attributes.merge!('ASIN' => entry['ASIN'], 'DetailPageURL' => entry['DetailPageURL'])
+      OpenStruct.new(attributes)
+    end
+
+    def create_book_from_vacuum_entry(target_entry)
+      Book.new asin: target_entry['ASIN'],
+               title: target_entry['Title'],
+               author: target_entry['Author'],
+               detail_page_url: target_entry['DetailPageURL']
+    end
+
+  end
+end

data/lib/bookcrawler/version.rb

@@ -0,0 +1,3 @@
+module Bookcrawler
+  VERSION = "0.1.0"
+end

data/lib/bookcrawler.rb

@@ -0,0 +1,7 @@
+require "bookcrawler/version"
+require "bookcrawler/book"
+require "bookcrawler/client"
+
+module Bookcrawler
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: bookcrawler
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jorge Manrubia
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.3
+- !ruby/object:Gem::Dependency
+  name: vacuum
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.19.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.19.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- jorge.manrubia@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bookcrawler.gemspec
+- lib/bookcrawler.rb
+- lib/bookcrawler/book.rb
+- lib/bookcrawler/client.rb
+- lib/bookcrawler/version.rb
+homepage: https://github.com/jorgemanrubia/bookcrawler
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Simple mechanism for fetching books metadata using Amazon Product Advertising
+  API
+test_files: []