amazoned 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 541ba9f2538aa8c43fe1ea005c0fad9ac997725a
-  data.tar.gz: a55e881280e3403225242c5f6fd52024d736f5e7
+  metadata.gz: 3ba7bfa8d1ab695dd9354a1a05830ac7bb03950a
+  data.tar.gz: 58a0bc4368b26e1e0dfe34bdb7e45f05664b480c
 SHA512:
-  metadata.gz: c7f6493ad97382f8402837f47df60658f9b1e876a144f12425fc44572a986d0e7bdb632bfa68807effd8b870047206a5e25bc9da655818508c76657da79fb4bf
-  data.tar.gz: 5a3f199d29f2b03dbd1f43e6f943ac804c5119b57dfe028e58e9781adb23b7a7162d0a0ba4cc719faacb37caf4df80926b11b65c03c09aa52019050d19dce3b0
+  metadata.gz: c0c1505564a7145a43bd02363959eec227c50714684c943615718842cbbb35f832c44812e73cac0f3697666d27c907b5b2f435bad086b197bbd8c3787513a283
+  data.tar.gz: 58151e3decb3a18e00078e828bee389e4928c826d8834c045941bb59c6e3a98ff141cbf884b3108f036adb833b34d9c490d7c0982a8f0b38ee34dc73254ad61b

data/README.md

@@ -1,8 +1,7 @@
 # Amazoned
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/amazoned`. To experiment with that code, run `bin/console` for an interactive prompt.
+Amazoned is a ruby HTTP scraper for retrieving product best seller and category rankings from Amazon.  Designed for those who don't have the time to register for Amazon's official product API.
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
@@ -22,7 +21,41 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Use Amazoned to scrape data about a product using the ASIN of the Amazon product.  E.g. for product with an ASIN of B078SX6STW:
+
+```ruby
+    Amazoned::Client.new("B078SX6STW").call
+```
+
+will return back a Ruby hash of:
+
+```ruby
+    {
+        :best_sellers_rank=>[
+          {:rank=>45,
+           :ladder=>"Baby > Baby Care > Pacifiers, Teethers & Teething Relief > Teethers"}
+        ],
+        :rank=>1602,
+        :category=>"Baby",
+        :package_dimensions=>"6.8 x 6.3 x 1.9 inches"
+    }
+```
+
+Amazoned will raise the error `Amazoned::ProductNotFoundError` if the product ASIN does not exist.
+
+Amazoned will raise the error `Amazoned::BotDeniedAccessError`  if the scraper is unable to get past a CAPTCHA wall after trying multiple times for the same ASIN.
+
+To avoid anti-scraper detection, the bot spoofs a new User Agent every request and uses timing jitter to vary how long it sleeps in-between each request.
+
+
+## Configuring Automatic Retries
+The library can be configured to automatically retry requests that fail due to the scraper bot hitting a CAPTCHA page:
+
+```ruby
+    Amazoned.max_network_retries = 2
+```
+
+By default, `max_network_retries` is set to `3`.
 
 ## Development
 

data/lib/amazoned/parser.rb

@@ -63,12 +63,16 @@ class Amazoned::Parser
             product_hash[:rank] = parsed_parent_category.first.delete(',').to_i
             product_hash[:category] = parsed_parent_category.last
 
-            parsed_category = str.partition(")").last.partition("in").map(&:strip).map{|i| i.gsub("#", "")} - ["in"]
-
-            hsh = {}
-            hsh[:rank] = parsed_category.first.delete(',').to_i
-            hsh[:ladder] = parsed_category.last
-            product_hash[:best_sellers_rank] << hsh
+            parsed_categories = str.partition(")").last.split("#").map(&:strip)
+            parsed_categories.each do |pc|
+              next if pc.blank?
+              parsed_category = pc.partition("in").map(&:strip).map{|i| i.gsub("#", "")} - ["in"]
+
+              hsh = {}
+              hsh[:rank] = parsed_category.first.delete(',').to_i
+              hsh[:ladder] = parsed_category.last
+              product_hash[:best_sellers_rank] << hsh
+           end
           end
         end
 

data/lib/amazoned/version.rb

@@ -1,3 +1,3 @@
 module Amazoned
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: amazoned
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - kelseydh