amazon_order 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e3a6bf0fa3f7452a0d5902ad1f18573a91533e3b
+  data.tar.gz: 20b21eb7ee25fb98487583bb8369f371acef22bc
+SHA512:
+  metadata.gz: 56ee5c0283f97849f9cc461b780ceab6cbc4e468fd039066cef4f1ba3968b60b1cc5e34192c100eb8f8ec786435aa5e9d3b0620d2e0009d516fba0a53b00be81
+  data.tar.gz: 3679036cfa689b836654f8c57c4bcd093fecdc3ca4a17a900f49457ba424d71bb99eb36aa53bd3d2fc0b14c3fb01c2a8b6525ca92e71568ccc4262a6cf5c9b9f

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.env
+/.byebug_history
+/.ruby-version
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.4
+before_install: gem install bundler -v 1.14.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Kazuho Yamaguchi
+
+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,154 @@
+# AmazonOrder
+
+[![Gem Version](https://badge.fury.io/rb/amazon_order.svg)](https://badge.fury.io/rb/amazon_order)
+[![Build Status](https://travis-ci.org/kyamaguchi/amazon_order.svg?branch=master)](https://travis-ci.org/kyamaguchi/amazon_order)
+
+Scrape information of amazon orders from amazon site
+
+##### Fetch Amazon Orders information
+
+![amazon_order_fetch](https://user-images.githubusercontent.com/275284/27861994-1d257558-61be-11e7-9cd3-9abe7fcb0716.gif)
+
+##### Load orders information
+
+![amazon_order_load](https://user-images.githubusercontent.com/275284/27862028-3d19a5be-61be-11e7-8627-1593237c1085.gif)
+
+Recorded with [Recordit](http://recordit.co/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'amazon_order'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install amazon_order
+
+## Usage
+
+### Setup
+
+[chromedriver](https://sites.google.com/a/chromium.org/chromedriver/downloads) is required. Please [download chromedriver](http://chromedriver.storage.googleapis.com/index.html) and update chromedriver regularly.  
+
+Create _.env_ following the instructions of https://github.com/kyamaguchi/amazon_auth
+
+```
+amazon_auth
+
+vi .env
+```
+
+And `Dotenv.load` or `gem 'dotenv-rails'` may be required when you use this in your app.
+
+### Run
+
+In console
+
+```ruby
+require 'amazon_order'
+client = AmazonOrder::Client.new(verbose: true, limit: 10)
+client.fetch_amazon_orders
+# Fetch orders of specified year
+client.fetch_orders_for_year(year: 2016)
+
+# Fetch all pages of specified year
+client = AmazonOrder::Client.new(limit: nil)
+client.sign_in
+client.go_to_amazon_order_page
+client.fetch_orders_for_year(year: 2015)
+```
+
+Downloaded pages will be stored into `order` directory.
+You can reset by moving that directory.
+
+Once `fetch_amazon_orders` succeeds, you can load orders information of downloaded pages anytime.
+(You don't need to fetch pages with launching browser every time.)
+
+```ruby
+orders = client.load_amazon_orders;nil
+orders.size
+
+# Sum of order_total
+orders.map(&:order_total).sum
+
+# Products
+products = orders.map(&:products).flatten;nil
+products.size
+
+# Sum of order_total by year
+orders.group_by{|o| o.order_placed.strftime('%Y') }.sort_by{|year,_| year }.map{|year,records| puts [year, records.map(&:order_total).sum].inspect };nil
+```
+
+Example of data
+
+```ruby
+console> pp orders.first.to_hash
+{"order_placed"=>Wed, 25 Aug 2010,
+ "order_number"=>"503-5746373-6335034",
+ "order_total"=>2940.0,
+ "shipment_status"=>nil,
+ "shipment_note"=>nil,
+ "order_details_path"=>
+  "/gp/your-account/order-details/...",
+ "all_products_displayed"=>false,
+ :products=>
+  [{"title"=>"メタプログラミングRuby",
+ ...
+}
+
+console> pp products.first.to_hash
+{"title"=>"メタプログラミングRuby",
+ "path"=>"/gp/product/4048687158/...",
+ "content"=>"Paolo Perrotta, 角征典...",
+ "image_url"=>
+ "https://images-fe.ssl-images-amazon.com/images/I/51TODrMIEnL.jpg"}
+```
+
+#### Options
+
+Limit fetching with number of pages: `client = AmazonOrder::Client.new(limit: 5)`
+`limit: nil` for no limit. default is 5
+
+Set year range: `client = AmazonOrder::Client.new(year_from: 2012, year_to: 2013)`
+default is Time.current.year
+
+##### Options of amazon_auth gem
+
+Firefox: `driver: :firefox`
+
+Output debug log: `debug: true`
+
+## Notice
+
+This may not work well with amazon.com because I don't have enough data of order pages.
+(amazon.co.jp will be OK)
+
+## Development
+
+```ruby
+client = AmazonOrder::Client.new(debug: true)
+```
+
+### Testing
+
+Test parsing of all your orders pages
+
+```
+ORDERS_DIR=/path/to/testapp/orders rspec spec/amazon_order/parser_spec.rb
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kyamaguchi/amazon_order.
+
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/amazon_order.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'amazon_order/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "amazon_order"
+  spec.version       = AmazonOrder::VERSION
+  spec.authors       = ["Kazuho Yamaguchi"]
+  spec.email         = ["kzh.yap@gmail.com"]
+
+  spec.summary       = %q{Scrape information of amazon orders}
+  spec.description   = %q{Scrape information of amazon orders}
+  spec.homepage      = "https://github.com/kyamaguchi/amazon_order"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "amazon_auth", "~> 0.3.3"
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "pry-rescue"
+  spec.add_development_dependency "pry-stack_explorer"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "amazon_order"
+
+# 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(__FILE__)

data/bin/setup

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

data/lib/amazon_order.rb

@@ -0,0 +1,11 @@
+require 'amazon_auth'
+require "amazon_order/version"
+require "amazon_order/client"
+require "amazon_order/parsers/base"
+require "amazon_order/parsers/order"
+require "amazon_order/parsers/product"
+require "amazon_order/parser"
+require "amazon_order/writer"
+
+module AmazonOrder
+end

data/lib/amazon_order/client.rb

@@ -0,0 +1,108 @@
+module AmazonOrder
+  class Client
+    include AmazonAuth::CommonExtension
+
+    attr_accessor :session, :options
+
+    def initialize(options = {})
+      @options = options
+      @base_dir = @options.fetch(:base_dir, 'orders')
+      @client = AmazonAuth::Client.new(@options)
+      extend(AmazonAuth::SessionExtension)
+    end
+
+    def year_from
+      options.fetch(:year_from, Time.current.year)
+    end
+
+    def year_to
+      options.fetch(:year_to, Time.current.year)
+    end
+
+    def limit
+      options.fetch(:limit, 5)
+    end
+
+    def session
+      @session ||= @client.session
+    end
+
+    def fetch_amazon_orders
+      sign_in
+      go_to_amazon_order_page
+      year_to.to_i.downto(year_from.to_i) do |year|
+        fetch_orders_for_year(year: year)
+      end
+    end
+
+    def load_amazon_orders
+      orders = []
+      Dir.glob("#{@base_dir}/*html").each do |filepath|
+        log "Loading #{filepath}"
+        parser = AmazonOrder::Parser.new(filepath)
+        orders += parser.orders
+      end
+      orders.sort_by{|o| -o.fetched_at.to_i }.uniq(&:order_number)
+    end
+
+    def sign_in
+      @client.sign_in
+    end
+
+    def go_to_amazon_order_page
+      link = links_for('a').find{|link| link =~ %r{/order-history} }
+      session.visit link
+    end
+
+    def fetch_orders_for_year(options = {})
+      year = options.fetch(:year, Time.current.year)
+      if switch_year(year)
+        save_page_for(year, current_page_node.try!(:text))
+        while (node = next_page_node) do
+          session.visit node.attr('href')
+          save_page_for(year, current_page_node.text)
+          break if limit && limit <= current_page_node.text.to_i
+        end
+      end
+    end
+
+    def switch_year(year)
+      return true if year.to_i == selected_year
+      session.first('.order-filter-dropdown .a-dropdown-prompt').click
+      option = session.all('.a-popover-wrapper .a-dropdown-link').find{|e| e.text.gsub(/\D+/,'').to_i == year.to_i }
+      return false if option.nil?
+      option.click
+      sleep 2
+      log "Year:#{year} -> #{number_of_orders}"
+      true
+    rescue => e
+      puts "#{e.message}\n#{e.backtrace.join("\n")}"
+      false
+    end
+
+    def save_page_for(year, page)
+      log "Saving year:#{year} page:#{page}"
+      path = ['order', year.to_s, "p#{page}", Time.current.strftime('%Y%m%d%H%M%S')].join('-') + '.html'
+      session.save_page(File.join(@base_dir, path))
+    end
+
+    def selected_year
+      wait_for_selector('#orderFilter')
+      doc.css('#orderFilter option').find{|o| !o.attr('selected').nil? }.attr('value').gsub(/\D+/,'').to_i
+    end
+
+    def number_of_orders
+      doc.css('#controlsContainer .num-orders').text.strip
+    end
+
+    def current_page_node
+      wait_for_selector('.a-pagination .a-selected')
+      doc.css('.a-pagination .a-selected a').first
+    end
+
+    def next_page_node
+      wait_for_selector('.a-pagination .a-selected')
+      doc.css('.a-pagination .a-selected ~ .a-normal').css('a').first
+    end
+  end
+end

data/lib/amazon_order/parser.rb

@@ -0,0 +1,27 @@
+module AmazonOrder
+  class Parser
+    attr_accessor :fetched_at
+
+    def initialize(filepath, options = {})
+      @filepath = filepath
+
+      @fetched_at = if (m = File.basename(@filepath).match(/\D(\d{14})/))
+        Time.strptime(m[1], '%Y%m%d%H%M%S')
+      else
+        File.ctime(@filepath)
+      end
+    end
+
+    def orders
+      @orders ||= doc.css(".order").map{|e| AmazonOrder::Parsers::Order.new(e, fetched_at: fetched_at) }
+    end
+
+    def doc
+      @doc ||= Nokogiri::HTML(body)
+    end
+
+    def body
+      @body ||= File.read(@filepath)
+    end
+  end
+end

data/lib/amazon_order/parsers/base.rb

@@ -0,0 +1,43 @@
+module AmazonOrder
+  module Parsers
+    class Base
+      attr_accessor :fetched_at
+
+      def initialize(node, options = {})
+        @node = node
+        @fetched_at = options[:fetched_at]
+      end
+
+      def inspect
+        "#<#{self.class.name}:#{self.object_id} #{self.to_hash}>"
+      end
+
+      def to_hash
+        hash = {}
+        self.class::ATTRIBUTES.each do |f|
+          hash[f] = send(f)
+        end
+        yield(hash) if block_given?
+        hash
+      end
+
+      def values
+        self.class::ATTRIBUTES.map{|a| send(a) }
+      end
+
+      def parse_date(date_text)
+        begin
+          Date.parse(date_text)
+        rescue ArgumentError => e
+          m = date_text.match(/\A(?<year>\d{4})年(?<month>\d{1,2})月(?<day>\d{1,2})日\z/)
+          Date.new(m[:year].to_i, m[:month].to_i, m[:day].to_i)
+        end
+      end
+
+      def get_original_image_url(url)
+        parts = url.split('/')
+        (parts[0..-2] + [parts.last.split('.').values_at(0,-1).join('.')]).join('/')
+      end
+    end
+  end
+end

data/lib/amazon_order/parsers/order.rb

@@ -0,0 +1,52 @@
+module AmazonOrder
+  module Parsers
+    class Order < Base
+      ATTRIBUTES = %w[
+                     order_placed order_number order_total
+                     shipment_status shipment_note
+                     order_details_path
+                     all_products_displayed
+                   ]
+
+      def order_placed
+        @_order_placed ||= parse_date(@node.css('.order-info .a-col-left .a-column')[0].css('.value').text.strip)
+      end
+
+      def order_number
+        @_order_number ||= @node.css('.order-info .a-col-right .a-row')[0].css('.value').text.strip
+      end
+
+      def order_total
+        @_order_total ||= @node.css('.order-info .a-col-left .a-column')[1].css('.value').text.strip.gsub(/[^\d\.]/,'').to_f
+      end
+
+      def shipment_status
+        # class names like "shipment-is-delivered" in '.shipment' node may be useful
+        @_shipment_status ||= @node.css('.shipment .shipment-top-row').present? ? @node.css('.shipment .shipment-top-row .a-row')[0].text.strip : nil
+      end
+
+      def shipment_note
+        @_shipment_note ||= @node.css('.shipment .shipment-top-row').present? ? @node.css('.shipment .shipment-top-row .a-row')[1].text.strip : nil
+      end
+
+      def order_details_path
+        @_order_details_path ||= @node.css('.order-info .a-col-right .a-row')[1].css('a.a-link-normal')[0].attr('href')
+      end
+
+      def all_products_displayed
+        @_all_products_displayed ||= @node.css('.a-box.order-info ~ .a-box .a-col-left .a-row').last.css('.a-link-emphasis').present?
+      end
+
+      def products
+        @_products ||= @node.css('.a-box.order-info ~ .a-box .a-col-left .a-row')[0].css('.a-fixed-left-grid').map{|e| AmazonOrder::Parsers::Product.new(e, fetched_at: fetched_at) }
+      end
+
+
+      def to_hash
+        super do |hash|
+          hash.merge!(products: products.map(&:to_hash))
+        end
+      end
+    end
+  end
+end

data/lib/amazon_order/parsers/product.rb

@@ -0,0 +1,28 @@
+module AmazonOrder
+  module Parsers
+    class Product < Base
+      ATTRIBUTES = %w[
+                     title
+                     path
+                     content
+                     image_url
+                   ]
+
+      def title
+        @_title ||= @node.css('.a-col-right .a-row')[0].text.strip
+      end
+
+      def path
+        @_path ||= @node.css('.a-col-right .a-row a')[0].attr('href') rescue nil
+      end
+
+      def content
+        @_content ||= @node.css('.a-col-right .a-row')[1..-1].map(&:text).join.gsub(/\s+/, ' ').strip
+      end
+
+      def image_url
+        @_image_url ||= get_original_image_url(@node.css('.a-col-left img')[0].attr('src'))
+      end
+    end
+  end
+end

data/lib/amazon_order/version.rb

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

data/lib/amazon_order/writer.rb

@@ -0,0 +1,45 @@
+module AmazonOrder
+  class Writer
+    def initialize(base_dir, options = {})
+      @base_dir = base_dir
+      @output_dir = options.fetch(:output_dir, 'tmp')
+    end
+
+    def print_orders
+      data['orders']
+    end
+
+    def print_produts
+      data['products']
+    end
+
+    def generate_csv
+      require 'csv'
+      FileUtils.mkdir_p(@output_dir)
+      %w[orders products].map do |resource|
+        next if data[resource].blank?
+        csv_file = "#{@output_dir}/#{resource}#{Time.current.strftime('%Y%m%d%H%M%S')}.csv"
+        puts "    Writing #{csv_file}"
+        CSV.open(csv_file, 'wb') do |csv|
+          data[resource].each{|r| csv << r }
+        end
+        csv_file
+      end
+    end
+
+    private
+
+    def data
+      @_data ||= begin
+        data = {'orders' => [], 'products' => []}
+        Dir.glob("#{@base_dir}/*html").each do |filepath|
+          puts "    Parsing #{filepath}"
+          parser = AmazonOrder::Parser.new(filepath)
+          data['orders'] += parser.orders.map(&:values)
+          data['products'] += parser.orders.map(&:products).flatten.map(&:values)
+        end
+        data
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: amazon_order
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kazuho Yamaguchi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: amazon_auth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: pry-rescue
+  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: pry-stack_explorer
+  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: Scrape information of amazon orders
+email:
+- kzh.yap@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- amazon_order.gemspec
+- bin/console
+- bin/setup
+- lib/amazon_order.rb
+- lib/amazon_order/client.rb
+- lib/amazon_order/parser.rb
+- lib/amazon_order/parsers/base.rb
+- lib/amazon_order/parsers/order.rb
+- lib/amazon_order/parsers/product.rb
+- lib/amazon_order/version.rb
+- lib/amazon_order/writer.rb
+homepage: https://github.com/kyamaguchi/amazon_order
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Scrape information of amazon orders
+test_files: []