android_reviews 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8aa10d844718876bba16958406f8c051903e2cbb
+  data.tar.gz: b341d934c1bcc44eca3f2e38cf44d7447747d213
+SHA512:
+  metadata.gz: cfcaccad6c65fa527e53050dd7fb5f56175b8c64249a1244aa344a2732c86f5324a70f009b17c9fd8e8715caaa199cf38b93671932601e4f340b1c8f669abda5
+  data.tar.gz: 34840720e6f1d417248a2fcc9088e010597321d336f7031d050544db2e06e43c3b466f22114395198a6e4b4f8674bc32a24cb6054b61d0760fdd07fef0b6195d

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.5

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Carl Mercier
+
+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,38 @@
+# AndroidReviews
+
+Simple Ruby Gem to scrape Android reviews from the Google Play Store
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'android_reviews'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install android_reviews
+
+## Usage
+
+`ar = AndroidReviews.new 'com.facebook.katana'
+ar.reviews # => returns an array
+ar.each_review do |review| # => yields as reviews are scraped. Recommended.
+  puts review
+end
+`
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/cmer/android_reviews.
+
+
+## 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/android_reviews.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'android_reviews/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "android_reviews"
+  spec.version       = AndroidReviews::VERSION
+  spec.authors       = ["Carl Mercier"]
+  spec.email         = ["carl@carlmercier.com"]
+
+  spec.summary       = %q{Android Play Store app reviews scraper for Ruby}
+  spec.description   = %q{Android Play Store app reviews scraper for Ruby}
+  spec.homepage      = "http://github.com/cmer/android_reviews"
+  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('nokogiri', '~> 1.6.7rc3')
+  spec.add_dependency('rest-client', '~> 2.0.0rc2')
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.4"
+  spec.add_development_dependency "vcr", "~> 3.0"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "byebug"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "android_reviews"
+
+# 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/lib/android_reviews.rb

@@ -0,0 +1,92 @@
+require 'android_reviews/version'
+require 'android_reviews/throttled_error'
+require 'object'
+require 'rest-client'
+require 'nokogiri'
+
+class AndroidReviews
+  attr_accessor :pages_per_minute, :language, :user_agent, :review_sort_order, :review_type
+
+  URL = "https://play.google.com/store/getreviews?authuser=0"
+  DEFAULT_USER_AGENT = "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/46.0.2490.80 Safari/537.36"
+
+  def initialize(app_id, pages_per_minute: 6, language: 'en', user_agent: DEFAULT_USER_AGENT)
+    @app_id            = app_id
+    @pages_per_minute  = pages_per_minute
+    @language          = language
+    @user_agent        = user_agent
+    @review_sort_order = 0
+    @review_type       = 0
+  end
+
+  def each_review
+    count = 0
+    current_page = 0
+
+    while body = fetch(current_page)
+      body.gsub!(/^\)\]\}\'/, '')
+      parsed = JSON.parse(body)
+      html = parsed[0][2]
+      html_doc = Nokogiri::HTML(html)
+
+      html_doc.css('.single-review').each do |node|
+        count += 1
+        review = review_from_node(node)
+        yield review
+      end # review loop
+
+      current_page += 1
+      throttle_sleep
+    end # page loop
+
+    count
+  end
+
+  def reviews
+    reviews = []
+    each_review do |r|
+      reviews << r
+    end
+    reviews
+  end
+
+protected
+  def fetch(page)
+    headers = {
+      "origin" => "https://play.google.com",
+      "accept-encoding" =>  "gzip, deflate",
+      "accept-language" =>  "en-US,en;q=0.8",
+      "user-agent" =>  @user_agent,
+      "content-type" =>  "application/x-www-form-urlencoded;charset=UTF-8",
+      "accept" =>  "*/*",
+      "referer" =>  "https://play.google.com/store/apps/details?id=#{@app_id}&hl=#{@language}",
+      "authority" =>  "play.google.com"
+    }
+
+    data = "reviewType=#{@review_type}&pageNum=#{page}&id=#{@app_id}&reviewSortOrder=#{@review_sort_order}&xhr=1&hl=#{@language}"
+
+    response = nil
+    begin
+      response = RestClient.post URL, data, headers
+      response.code == 200 ? response.body : nil
+    rescue RestClient::Found
+      raise ThrottledError
+      nil
+    end
+  end
+
+  def review_from_node(node)
+    {
+      author_name: node.css('.author-name a').text.strip,
+      review_date: Date.parse(node.css('.review-date').text.strip),
+      rating:      node.css('.review-info-star-rating .tiny-star').attr('aria-label').text.match(/([1-5])/)[0].strip,
+      title:       node.css('.review-title').text.strip,
+      body:        node.search('.review-body').xpath('text()').text.strip,
+      avatar_url:  node.css('.responsive-img-hdpi .author-image').attr('style').text.match(/\((.*)\)/)[1]
+    }
+  end
+
+  def throttle_sleep
+    sleep(60 / pages_per_minute.to_f) if pages_per_minute
+  end
+end

data/lib/android_reviews/throttled_error.rb

@@ -0,0 +1,7 @@
+class AndroidReviews
+  class ThrottledError < StandardError
+    def initialize(msg="Google Play Store throttled you!")
+      super(msg)
+    end
+  end
+end

data/lib/android_reviews/version.rb

@@ -0,0 +1,3 @@
+class AndroidReviews
+  VERSION = "0.1.0"
+end

data/lib/object.rb

@@ -0,0 +1,9 @@
+class Object
+  def blank?
+    respond_to?(:empty?) ? empty? : !self
+  end
+
+  def present?
+    !blank?
+  end
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: android_reviews
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Carl Mercier
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.7rc3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.7rc3
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0rc2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0rc2
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  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: webmock
+  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: 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'
+description: Android Play Store app reviews scraper for Ruby
+email:
+- carl@carlmercier.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- android_reviews.gemspec
+- bin/console
+- bin/setup
+- lib/android_reviews.rb
+- lib/android_reviews/throttled_error.rb
+- lib/android_reviews/version.rb
+- lib/object.rb
+homepage: http://github.com/cmer/android_reviews
+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: Android Play Store app reviews scraper for Ruby
+test_files: []
+has_rdoc: