alexandria-book-collection-manager 0.7.3 → 0.7.4

data/lib/alexandria/book_providers/amazon_aws.rb

@@ -21,45 +21,45 @@
 
 # http://en.wikipedia.org/wiki/Amazon
 
-require 'hpricot'
-require 'alexandria/book_providers/amazon_ecs_util'
+require "hpricot"
+require "alexandria/book_providers/amazon_ecs_util"
 
 module Alexandria
   class BookProviders
     class AmazonProvider < GenericProvider
       include Logging
       include GetText
-      GetText.bindtextdomain(Alexandria::TEXTDOMAIN, charset: 'UTF-8')
+      GetText.bindtextdomain(Alexandria::TEXTDOMAIN, charset: "UTF-8")
 
       # CACHE_DIR = File.join(Alexandria::Library::DIR, '.amazon_cache')
 
-      LOCALES = ['ca', 'de', 'fr', 'jp', 'uk', 'us'].freeze
+      LOCALES = ["ca", "de", "fr", "jp", "uk", "us"].freeze
 
       def initialize
-        super('Amazon', 'Amazon')
+        super("Amazon", "Amazon")
         # prefs.add("enabled", _("Enabled"), true, [true,false])
-        prefs.add('locale', _('Locale'), 'us', AmazonProvider::LOCALES)
-        prefs.add('dev_token', _('Access key ID'), '')
-        prefs.add('secret_key', _('Secret access key'), '')
-        prefs.add('associate_tag', _('Associate Tag'), '')
+        prefs.add("locale", _("Locale"), "us", AmazonProvider::LOCALES)
+        prefs.add("dev_token", _("Access key ID"), "")
+        prefs.add("secret_key", _("Secret access key"), "")
+        prefs.add("associate_tag", _("Associate Tag"), "")
 
         prefs.read
-        token = prefs.variable_named('dev_token')
+        token = prefs.variable_named("dev_token")
         # kill old (shorter) tokens, or previously distributed Access Key Id (see #26250)
 
         if token
           token.new_value = token.value.strip if token.value != token.value.strip
         end
-        token.new_value = '' if token && ((token.value.size != 20) || (token.value == '0J356Z09CN88KB743582'))
+        token.new_value = "" if token && ((token.value.size != 20) || (token.value == "0J356Z09CN88KB743582"))
 
-        secret = prefs.variable_named('secret_key')
+        secret = prefs.variable_named("secret_key")
         if secret
           secret.new_value = secret.value.strip if secret.value != secret.value.strip
         end
 
-        associate = prefs.variable_named('associate_tag')
+        associate = prefs.variable_named("associate_tag")
         if associate
-          associate.new_value = 'rubyalexa-20' if associate.value.strip.empty?
+          associate.new_value = "rubyalexa-20" if associate.value.strip.empty?
           associate.new_value = associate.value.strip if associate.value != associate.value.strip
         end
       end
@@ -67,29 +67,29 @@ module Alexandria
       def search(criterion, type)
         prefs.read
 
-        if prefs['secret_key'].empty?
+        if prefs["secret_key"].empty?
           raise(Amazon::RequestError,
-                'Secret Access Key required for Authentication:' \
-                ' you must sign up for your own Amazon AWS account')
+                "Secret Access Key required for Authentication:" \
+                " you must sign up for your own Amazon AWS account")
         end
 
         if (config = Alexandria::Preferences.instance.http_proxy_config)
           host, port, user, pass = config
-          url = 'http://'
-          url += user + ':' + pass + '@' if user && pass
-          url += host + ':' + port.to_s
-          ENV['http_proxy'] = url
+          url = "http://"
+          url += user + ":" + pass + "@" if user && pass
+          url += host + ":" + port.to_s
+          ENV["http_proxy"] = url
         end
 
-        access_key_id = prefs['dev_token']
+        access_key_id = prefs["dev_token"]
 
         Amazon::Ecs.options = { aWS_access_key_id: access_key_id,
-                                associateTag: prefs['associate_tag'] }
-        Amazon::Ecs.secret_access_key = prefs['secret_key']
+                                associateTag: prefs["associate_tag"] }
+        Amazon::Ecs.secret_access_key = prefs["secret_key"]
         # #req.cache = Amazon::Search::Cache.new(CACHE_DIR)
         locales = AmazonProvider::LOCALES.dup
-        locales.delete prefs['locale']
-        locales.unshift prefs['locale']
+        locales.delete prefs["locale"]
+        locales.unshift prefs["locale"]
         locales.reverse!
 
         begin
@@ -99,7 +99,7 @@ module Alexandria
           when SEARCH_BY_ISBN
             criterion = Library.canonicalise_isbn(criterion)
             # This isn't ideal : I'd like to do an ISBN/EAN-specific search
-            res = Amazon::Ecs.item_search(criterion, response_group: 'ItemAttributes,Images',
+            res = Amazon::Ecs.item_search(criterion, response_group: "ItemAttributes,Images",
                                                      country: request_locale)
             res.items.each do |item|
               products << item
@@ -120,27 +120,27 @@ module Alexandria
             # result with different ISBNs
 
             if products.length > 1
-              log.warn {
+              log.warn do
                 "ISBN search at Amazon[#{request_locale}] got #{products.length} results;" \
-                ' returning the first result only'
-              }
+                " returning the first result only"
+              end
             end
 
           when SEARCH_BY_TITLE
             res = Amazon::Ecs.item_search(criterion,
-                                          response_group: 'ItemAttributes,Images',
+                                          response_group: "ItemAttributes,Images",
                                           country: request_locale)
 
             res.items.each do |item|
-              products << item if item.get('itemattributes/title') =~ /#{criterion}/i
+              products << item if /#{criterion}/i.match?(item.get("itemattributes/title"))
             end
             # #req.keyword_search(criterion) do |product|
 
           when SEARCH_BY_AUTHORS
             criterion = "author:#{criterion}"
             res = Amazon::Ecs.item_search(criterion,
-                                          response_group: 'ItemAttributes,Images',
-                                          country: request_locale, type: 'Power')
+                                          response_group: "ItemAttributes,Images",
+                                          country: request_locale, type: "Power")
             res.items.each do |item|
               products << item
             end
@@ -148,7 +148,7 @@ module Alexandria
 
           when SEARCH_BY_KEYWORD
             res = Amazon::Ecs.item_search(criterion,
-                                          response_group: 'ItemAttributes,Images',
+                                          response_group: "ItemAttributes,Images",
                                           country: request_locale)
 
             res.items.each do |item|
@@ -158,37 +158,37 @@ module Alexandria
           else
             raise InvalidSearchTypeError
           end
-          raise Amazon::RequestError, 'No products' if products.empty?
+          raise Amazon::RequestError, "No products" if products.empty?
           # raise NoResultsError if products.empty?
-        rescue Amazon::RequestError => re
-          log.debug { "Got Amazon::RequestError at #{request_locale}: #{re}" }
+        rescue Amazon::RequestError => ex
+          log.debug { "Got Amazon::RequestError at #{request_locale}: #{ex}" }
           retry unless locales.empty?
           raise NoResultsError
         end
 
         results = []
         products.each do |item|
-          next unless item.get('itemattributes/productgroup') == 'Book'
+          next unless item.get("itemattributes/productgroup") == "Book"
 
-          atts = item.search_and_convert('itemattributes')
-          title = normalize(atts.get('title'))
+          atts = item.search_and_convert("itemattributes")
+          title = normalize(atts.get("title"))
 
-          media = normalize(atts.get('binding'))
-          media = nil if media == 'Unknown Binding'
+          media = normalize(atts.get("binding"))
+          media = nil if media == "Unknown Binding"
 
-          isbn = normalize(atts.get('isbn'))
+          isbn = normalize(atts.get("isbn"))
           isbn = (Library.canonicalise_ean(isbn) if isbn && Library.valid_isbn?(isbn))
           # hack, extract year by regexp (not Y10K compatible :-)
-          /([1-9][0-9]{3})/ =~ atts.get('publicationdate')
+          /([1-9][0-9]{3})/ =~ atts.get("publicationdate")
           publishing_year = Regexp.last_match[1] ? Regexp.last_match[1].to_i : nil
           book = Book.new(title,
-                          atts.get_array('author').map { |x| normalize(x) },
+                          atts.get_array("author").map { |x| normalize(x) },
                           isbn,
-                          normalize(atts.get('manufacturer')),
+                          normalize(atts.get("manufacturer")),
                           publishing_year,
                           media)
 
-          image_url = item.get('mediumimage/url')
+          image_url = item.get("mediumimage/url")
           log.info { "Found at Amazon[#{request_locale}]: #{book.title}" }
           results << [book, image_url]
         end
@@ -196,7 +196,7 @@ module Alexandria
           if results.size == 1
             return results.first
           else
-            log.info { 'Found multiple results for lookup: checking each' }
+            log.info { "Found multiple results for lookup: checking each" }
             query_isbn_canon = Library.canonicalise_ean(criterion)
             results.each do |rslt|
               book = rslt[0]
@@ -206,7 +206,7 @@ module Alexandria
               log.debug { "rejected possible result #{book}" }
             end
             # gone through all and no ISBN match, so just return first result
-            log.info { 'no more results to check. Returning first result, just an approximation' }
+            log.info { "no more results to check. Returning first result, just an approximation" }
             return results.first
           end
         else
@@ -216,19 +216,19 @@ module Alexandria
 
       def url(book)
         isbn = Library.canonicalise_isbn(book.isbn)
-        url = case prefs['locale']
-              when 'fr'
-                'http://www.amazon.fr/exec/obidos/ASIN/%s'
-              when 'uk'
-                'http://www.amazon.co.uk/exec/obidos/ASIN/%s'
-              when 'de'
-                'http://www.amazon.de/exec/obidos/ASIN/%s'
-              when 'ca'
-                'http://www.amazon.ca/exec/obidos/ASIN/%s'
-              when 'jp'
-                'http://www.amazon.jp/exec/obidos/ASIN/%s'
-              when 'us'
-                'http://www.amazon.com/exec/obidos/ASIN/%s'
+        url = case prefs["locale"]
+              when "fr"
+                "http://www.amazon.fr/exec/obidos/ASIN/%s"
+              when "uk"
+                "http://www.amazon.co.uk/exec/obidos/ASIN/%s"
+              when "de"
+                "http://www.amazon.de/exec/obidos/ASIN/%s"
+              when "ca"
+                "http://www.amazon.ca/exec/obidos/ASIN/%s"
+              when "jp"
+                "http://www.amazon.jp/exec/obidos/ASIN/%s"
+              when "us"
+                "http://www.amazon.com/exec/obidos/ASIN/%s"
               end
         url % isbn
       rescue StandardError => ex
@@ -237,7 +237,7 @@ module Alexandria
       end
 
       def normalize(str)
-        str = str.squeeze(' ').strip unless str.nil?
+        str = str.squeeze(" ").strip unless str.nil?
         str
       end
     end

data/lib/alexandria/book_providers/amazon_ecs_util.rb

@@ -1,40 +1,14 @@
 # frozen_string_literal: true
 
-#--
-# Copyright (c) 2006 Herryanto Siatono, Pluit Solutions
+# This file is part of Alexandria.
 #
-# 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.
-#++
-
-# Modified by Cathal Mc Ginley 2008-02-18
-# added Amazon::Ecs.transport - to enable Alexandria's proxy support
-# Modified by Cathal Mc Ginley 2008-08-26
-# Amazon::Element.get now uses inner_text, not inner_html, fixing #21659
-# Modified by Cathal Mc Ginley 2009-08-13
-# Added sign_request and hmac_sha256 methods for Authentication support
-
-require 'net/http'
-require 'hpricot'
-require 'cgi'
-
-require 'digest/sha2'
+# See the file README.md for authorship and licensing information.
+
+require "net/http"
+require "hpricot"
+require "cgi"
+
+require "digest/sha2"
 
 module Amazon
   class RequestError < StandardError; end
@@ -42,17 +16,17 @@ module Amazon
   class Ecs
     include Alexandria::Logging
 
-    SERVICE_URLS = { us: 'http://webservices.amazon.com/onca/xml?Service=AWSECommerceService',
-                     uk: 'http://webservices.amazon.co.uk/onca/xml?Service=AWSECommerceService',
-                     ca: 'http://webservices.amazon.ca/onca/xml?Service=AWSECommerceService',
-                     de: 'http://webservices.amazon.de/onca/xml?Service=AWSECommerceService',
-                     jp: 'http://webservices.amazon.co.jp/onca/xml?Service=AWSECommerceService',
-                     fr: 'http://webservices.amazon.fr/onca/xml?Service=AWSECommerceService' }.freeze
+    SERVICE_URLS = { us: "http://webservices.amazon.com/onca/xml?Service=AWSECommerceService",
+                     uk: "http://webservices.amazon.co.uk/onca/xml?Service=AWSECommerceService",
+                     ca: "http://webservices.amazon.ca/onca/xml?Service=AWSECommerceService",
+                     de: "http://webservices.amazon.de/onca/xml?Service=AWSECommerceService",
+                     jp: "http://webservices.amazon.co.jp/onca/xml?Service=AWSECommerceService",
+                     fr: "http://webservices.amazon.fr/onca/xml?Service=AWSECommerceService" }.freeze
 
     @@options = {}
     @@debug = false
 
-    @@secret_access_key = ''
+    @@secret_access_key = ""
 
     # Default search options
     def self.options
@@ -79,7 +53,7 @@ module Amazon
     end
 
     def self.configure(&_proc)
-      raise ArgumentError, 'Block is required.' unless block_given?
+      raise ArgumentError, "Block is required." unless block_given?
 
       yield @@options
     end
@@ -87,8 +61,8 @@ module Amazon
     # Search amazon items with search terms. Default search index option is 'Books'.
     # For other search type other than keywords, please specify :type => [search type param name].
     def self.item_search(terms, opts = {})
-      opts[:operation] = 'ItemSearch'
-      opts[:search_index] = opts[:search_index] || 'Books'
+      opts[:operation] = "ItemSearch"
+      opts[:search_index] = opts[:search_index] || "Books"
 
       type = opts.delete(:type)
       if type
@@ -102,7 +76,7 @@ module Amazon
 
     # Search an item by ASIN no.
     def self.item_lookup(item_id, opts = {})
-      opts[:operation] = 'ItemLookup'
+      opts[:operation] = "ItemLookup"
       opts[:item_id] = item_id
 
       send_request(opts)
@@ -140,7 +114,7 @@ module Amazon
 
       # Return true if request is valid.
       def is_valid_request?
-        (@doc / 'isvalid').inner_html == 'True'
+        (@doc / "isvalid").inner_html == "True"
       end
 
       # Return true if response has an error.
@@ -150,12 +124,12 @@ module Amazon
 
       # Return error message.
       def error
-        Element.get(@doc, 'error/message')
+        Element.get(@doc, "error/message")
       end
 
       # Return an array of Amazon::Element item objects.
       def items
-        @items ||= (@doc / 'item').map { |item| Element.new(item) }
+        @items ||= (@doc / "item").map { |item| Element.new(item) }
         @items
       end
 
@@ -166,19 +140,19 @@ module Amazon
 
       # Return current page no if :item_page option is when initiating the request.
       def item_page
-        @item_page ||= (@doc / 'itemsearchrequest/itempage').inner_html.to_i
+        @item_page ||= (@doc / "itemsearchrequest/itempage").inner_html.to_i
         @item_page
       end
 
       # Return total results.
       def total_results
-        @total_results ||= (@doc / 'totalresults').inner_html.to_i
+        @total_results ||= (@doc / "totalresults").inner_html.to_i
         @total_results
       end
 
       # Return total pages.
       def total_pages
-        @total_pages ||= (@doc / 'totalpages').inner_html.to_i
+        @total_pages ||= (@doc / "totalpages").inner_html.to_i
         @total_pages
       end
     end
@@ -197,17 +171,17 @@ module Amazon
 
     def self.prepare_url(opts)
       country = opts.delete(:country)
-      country = country.nil? ? 'us' : country
+      country = country.nil? ? "us" : country
       request_url = SERVICE_URLS[country.to_sym]
       raise Amazon::RequestError, "Invalid country '#{country}'" unless request_url
 
-      qs = ''
-      opts.each { |k, v|
+      qs = ""
+      opts.each do |k, v|
         next unless v
 
-        v = v.join(',') if v.is_a? Array
+        v = v.join(",") if v.is_a? Array
         qs << "&#{camelize(k.to_s)}=#{URI.encode(v.to_s)}"
-      }
+      end
       url = "#{request_url}#{qs}"
       # puts ">>> base url >> #{url}"
       signed_url = sign_request(url)
@@ -216,9 +190,9 @@ module Amazon
     end
 
     def self.camelize(s)
-      s.to_s.
-        gsub(/\/(.?)/) { '::' + Regexp.last_match[1].upcase }.
-        gsub(/(^|_)(.)/) { Regexp.last_match[2].upcase }
+      s.to_s
+        .gsub(%r{/(.?)}) { "::" + Regexp.last_match[1].upcase }
+        .gsub(/(^|_)(.)/) { Regexp.last_match[2].upcase }
     end
 
     def self.hmac_sha256(message, key)
@@ -233,9 +207,9 @@ module Amazon
       ipad_bytes = ipad.bytes.map { |b| b }
       opad_bytes = opad.bytes.map { |b| b }
       key_bytes = key.bytes.map { |b| b }
-      ipad_xor = ''
-      opad_xor = ''
-      for i in 0..key.size - 1
+      ipad_xor = ""
+      opad_xor = ""
+      (0..key.size - 1).each do |i|
         ipad_xor << (ipad_bytes[i] ^ key_bytes[i])
         opad_xor << (opad_bytes[i] ^ key_bytes[i])
       end
@@ -260,7 +234,7 @@ module Amazon
       raise AmazonNotConfiguredError unless @@secret_access_key
 
       # Step 0 : Split apart request string
-      url_pattern = /http:\/\/([^\/]+)(\/[^\?]+)\?(.*$)/
+      url_pattern = %r{http://([^/]+)(/[^\?]+)\?(.*$)}
       url_pattern =~ request
       host = Regexp.last_match[1]
       path = Regexp.last_match[2]
@@ -268,21 +242,21 @@ module Amazon
 
       # Step 1: enter the timestamp
       t = Time.now.getutc # MUST be in UTC
-      stamp = t.strftime('%Y-%m-%dT%H:%M:%SZ')
+      stamp = t.strftime("%Y-%m-%dT%H:%M:%SZ")
       param_string += "&Timestamp=#{stamp}"
 
       # Step 2 : URL-encode
-      param_string = param_string.gsub(',', '%2C').gsub(':', '%3A')
+      param_string = param_string.gsub(",", "%2C").gsub(":", "%3A")
       #   NOTE : take care not to double-encode
 
       # Step 3 : Split the parameter/value pairs
-      params = param_string.split('&')
+      params = param_string.split("&")
 
       # Step 4 : Sort params
       params.sort!
 
       # Step 5 : Rejoin the param string
-      canonical_param_string = params.join('&')
+      canonical_param_string = params.join("&")
 
       # Steps 6 & 7: Prepend HTTP request info
       string_to_sign = "GET\n#{host}\n#{path}\n#{canonical_param_string}"
@@ -291,7 +265,7 @@ module Amazon
 
       # Step 8 : Calculate RFC 2104-compliant HMAC with SHA256 hash algorithm
       sig = hmac_sha256(string_to_sign, @@secret_access_key)
-      base64_sig = [sig].pack('m').strip
+      base64_sig = [sig].pack("m").strip
 
       # Step 9 : URL-encode + and = in sig
       base64_sig = CGI.escape(base64_sig)
@@ -334,27 +308,27 @@ module Amazon
     end
 
     # Get the text value of the given path, leave empty to retrieve current element value.
-    def get(path = '')
+    def get(path = "")
       Element.get(@element, path)
     end
 
     # Get the unescaped HTML text of the given path.
-    def get_unescaped(path = '')
+    def get_unescaped(path = "")
       Element.get_unescaped(@element, path)
     end
 
     # Get the array values of the given path.
-    def get_array(path = '')
+    def get_array(path = "")
       Element.get_array(@element, path)
     end
 
     # Get the children element text values in hash format with the element names as the hash keys.
-    def get_hash(path = '')
+    def get_hash(path = "")
       Element.get_hash(@element, path)
     end
 
     # Similar to #get, except an element object must be passed-in.
-    def self.get(element, path = '')
+    def self.get(element, path = "")
       return unless element
 
       result = element.at(path)
@@ -365,21 +339,21 @@ module Amazon
     end
 
     # Similar to #get_unescaped, except an element object must be passed-in.
-    def self.get_unescaped(element, path = '')
+    def self.get_unescaped(element, path = "")
       result = get(element, path)
       CGI.unescapeHTML(result) if result
     end
 
     # Similar to #get_array, except an element object must be passed-in.
-    def self.get_array(element, path = '')
+    def self.get_array(element, path = "")
       return unless element
 
       result = element / path
       if (result.is_a? Hpricot::Elements) || (result.is_a? Array)
         parsed_result = []
-        result.each { |item|
+        result.each do |item|
           parsed_result << Element.get(item)
-        }
+        end
         parsed_result
       else
         [Element.get(result)]
@@ -387,7 +361,7 @@ module Amazon
     end
 
     # Similar to #get_hash, except an element object must be passed-in.
-    def self.get_hash(element, path = '')
+    def self.get_hash(element, path = "")
       return unless element
 
       result = element.at(path)