market_bot 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,19 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem "typhoeus", "~> 0.2.4"
+gem "nokogiri", "~> 1.5.0"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+  gem "ZenTest", "~> 4.6.2"
+  gem "ruby-debug19", ">= 0.11.6", :require => "ruby-debug"
+  gem "rdoc", ">= 3.9.4"
+end

data/Gemfile.lock

@@ -0,0 +1,54 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ZenTest (4.6.2)
+    archive-tar-minitar (0.5.2)
+    columnize (0.3.4)
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    linecache19 (0.5.12)
+      ruby_core_source (>= 0.1.4)
+    mime-types (1.16)
+    nokogiri (1.5.0)
+    rake (0.9.2)
+    rcov (0.9.10)
+    rdoc (3.9.4)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    ruby-debug-base19 (0.11.25)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby_core_source (0.1.5)
+      archive-tar-minitar (>= 0.5.2)
+    typhoeus (0.2.4)
+      mime-types
+      mime-types
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ZenTest (~> 4.6.2)
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  nokogiri (~> 1.5.0)
+  rcov
+  rdoc (>= 3.9.4)
+  rspec (~> 2.3.0)
+  ruby-debug19 (>= 0.11.6)
+  typhoeus (~> 0.2.4)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Chad Remesch
+
+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/NOTES.txt

@@ -0,0 +1,61 @@
+URLs:
+- id can be one of the below IDs or an application ID which usually starts with com.
+- category is optional and works with a subset of the below IDs.
+https://market.android.com/details?id=&cat=
+https://market.android.com/details?id=com.angrymobgames.muffinknightfree
+
+Data Models:
+Android::Leaderboard
+Android::Leaderboard::Stat
+Android::App
+Android::App::Stat
+
+IDs:
+apps_topselling_paid
+apps_topselling_free
+apps_topselling_new_free
+apps_topselling_new_paid
+apps_editors_choice
+apps_topselling_paid_game
+apps_movers_shakers
+apps_featured
+apps_tablet_featured
+apps_topgrossing
+
+Categories:
+GAME
+ARCADE
+BRAIN
+CARDS
+CASUAL
+GAME_WALLPAPER
+RACING
+SPORTS_GAMES
+GAME_WIDGETS
+APPLICATION
+BOOKS_AND_REFERENCE
+BUSINESS
+COMICS
+COMMUNICATION
+EDUCATION
+ENTERTAINMENT
+FINANCE
+HEALTH_AND_FITNESS
+LIBRARIES_AND_DEMO
+LIFESTYLE
+APP_WALLPAPER
+MEDIA_AND_VIDEO
+MEDICAL
+MUSIC_AND_AUDIO
+NEWS_AND_MAGAZINES
+PERSONALIZATION
+PHOTOGRAPHY
+PRODUCTIVITY
+SHOPPING
+SOCIAL
+SPORTS
+TOOLS
+TRANSPORTATION
+TRAVEL_AND_LOCAL
+WEATHER
+APP_WIDGETS

data/README.markdown

@@ -0,0 +1,68 @@
+# Market Bot - High performance Ruby scraper for Google's Android Market
+
+Market Bot is a high performance Ruby scraper for Google's Android Market with a simple to use API.  It is built on top of Nokogiri and Typhoeus.
+
+## Dependencies
+
+* Nokogiri
+* Typhoeus
+
+## Installation
+
+    gem install market_bot
+
+## Usage Examples (using batch API for downloading)
+
+    require 'rubygems'
+    require 'market_bot'
+
+    # Create a hydra object with 20 http workers.
+    hydra = Typhoeus::Hydra.new(:max_concurrency => 20)
+
+    # Download/parse the leaderboard.
+    lb = MarketBot::Android::Leaderboard.new(:apps_topselling_paid, :arcade, :hydra => hydra)
+    lb.enqueue_update
+    hydra.run
+
+    # Download/parse the details for the first and last entries of the leaderboard.
+    first_app = MarketBot::Android::App.new(lb.results.first[:market_id], :hydra => hydra)
+    last_app = MarketBot::Android::App.new(lb.results.last[:market_id], :hydra => hydra)
+    first_app.enqueue_update
+    last_app.enqueue_update
+    hydra.run
+
+    puts "First place app (#{first_app.title}) price: #{first_app.price}"
+    puts "Last place app (#{last_app.title}) price: #{last_app.price}"
+
+## Benchmarks
+
+Below are fairly typical results using 20 http workers (Typhoeus::Hydra.new(:max_concurrency => 20).  The first benchmark downloads/parses a leaderboard containing 504 entries.  The second benchmark takes those 504 entries, converts them to MarketBot::Android::App objects and then downloads/parses their details.  Note that 20 workers are used to prevent DOSing the market servers.  Higher values may work, but I don't recommend it.
+
+    $ rake benchmark:android
+    ----------------------------------------------------
+    Benchmark Leaderboard: Top Selling Paid Apps
+    ----------------------------------------------------
+    app count: 504
+    time: 3.16 seconds
+
+    ----------------------------------------------------
+    Benchmark Apps: top Selling Paid Apps
+    ----------------------------------------------------
+    app count: 504
+    time: 35.685 seconds
+
+## Contributing to Market Bot
+
+1. Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+2. Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+3. Fork the project.
+4. Start a feature/bugfix branch.
+5. Commit and push until you are happy with your contribution.
+6. Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+7. Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2011 Chad Remesch. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,114 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "market_bot"
+  gem.homepage = "http://github.com/chadrem/market_bot"
+  gem.license = "MIT"
+  gem.summary = %Q{Market Bot: High performance Ruby scraper for Google's Android Market}
+  gem.description = %Q{Market Bot is a high performance Ruby scraper for Google's Android Market with a simple to use API.  It is built on top of Nokogiri and Typhoeus.}
+  gem.email = "chad@remesch.com"
+  gem.authors = ["Chad Remesch"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "market_bot #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'typhoeus'
+
+namespace :spec do
+  namespace :data do
+    def download(url, save_path)
+      resp = Typhoeus::Request.get(url)
+      File.open(save_path, "w") do |file|
+        file.puts(resp.body)
+      end
+    end
+
+    desc 'download the latest test data used by the specs'
+    task :update do
+      download('https://market.android.com/details?id=com.bluefroggaming.popdat',
+               File.join(File.dirname(__FILE__), 'spec', 'market_bot', 'android', 'data', 'app_1.txt'))
+
+      download('https://market.android.com/details?id=apps_topselling_paid',
+               File.join(File.dirname(__FILE__), 'spec', 'market_bot', 'android', 'data', 'leaderboard-apps_topselling_paid-page1.txt'))
+
+      download('https://market.android.com/details?id=apps_topselling_paid&start=24&num=24',
+               File.join(File.dirname(__FILE__), 'spec', 'market_bot', 'android', 'data', 'leaderboard-apps_topselling_paid-page2.txt'))
+
+      download('https://market.android.com/details?id=apps_topselling_paid&start=48&num=24',
+               File.join(File.dirname(__FILE__), 'spec', 'market_bot', 'android', 'data', 'leaderboard-apps_topselling_paid-page3.txt'))
+
+      download('https://market.android.com/details?id=apps_topselling_paid&cat=ARCADE&start=1000&num=24',
+               File.join(File.dirname(__FILE__), 'spec', 'market_bot', 'android', 'data', 'leaderboard-apps_topselling_paid-page4.txt'))
+    end
+  end
+end
+
+namespace :benchmark do
+  task :android do
+    require 'market_bot'
+    require 'benchmark'
+
+    hydra = Typhoeus::Hydra.new(:max_concurrency => 20)
+
+    leaderboard = nil
+    leaderboard_ms = Benchmark.realtime {
+      leaderboard = MarketBot::Android::Leaderboard.new(:apps_topselling_paid, nil, :hydra => hydra)
+      leaderboard.update
+    }
+
+    puts '----------------------------------------------------'
+    puts 'Benchmark Leaderboard: Top Selling Paid Apps'
+    puts '----------------------------------------------------'
+    puts "app count: #{leaderboard.results.length}"
+    puts "time: #{leaderboard_ms.round(3)} seconds"
+    puts
+
+    apps = nil
+    apps_ms = Benchmark.realtime {
+      apps = leaderboard.results.map{ |r| MarketBot::Android::App.new(r[:market_id], :hydra => hydra).enqueue_update }
+      hydra.run
+    }
+
+    puts '----------------------------------------------------'
+    puts 'Benchmark Apps: top Selling Paid Apps'
+    puts '----------------------------------------------------'
+    puts "app count: #{apps.length}"
+    puts "time: #{apps_ms.round(3)} seconds"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/market_bot/android/app.rb

@@ -0,0 +1,71 @@
+module MarketBot
+  module Android
+
+    class App
+      MARKET_ATTRIBUTES = [:title, :rating, :updated, :current_version, :requires_android,
+                          :category, :installs, :size, :price, :content_rating, :description]
+
+      attr_reader :app_id
+      attr_reader *MARKET_ATTRIBUTES
+      attr_reader :hydra
+
+      def self.parse(html)
+        result = {}
+
+        doc = Nokogiri::HTML(html)
+
+        result[:title]            = doc.title.gsub(/ - Android Market$/, '')
+        result[:rating]           = doc.css('.doc-metadata').first.elements[2].elements[4].text[6].to_i
+        result[:updated]          = doc.css('.doc-metadata').first.elements[2].elements[6].text
+        result[:current_version]  = doc.css('.doc-metadata').first.elements[2].elements[8].text
+        result[:requires_android] = doc.css('.doc-metadata').first.elements[2].elements[10].text
+        result[:category]         = doc.css('.doc-metadata').first.elements[2].elements[12].text
+        result[:installs]         = doc.css('.doc-metadata').first.elements[2].elements[14].children.first.text
+        result[:size]             = doc.css('.doc-metadata').first.elements[2].elements[16].text
+        result[:price]            = doc.css('.doc-metadata').first.elements[2].elements[18].text
+        result[:content_rating]   = doc.css('.doc-metadata').first.elements[2].elements[20].text
+        result[:description]      = doc.css('#doc-original-text').first.text
+
+        result
+      end
+
+      def initialize(app_id, options={})
+        @app_id = app_id
+        @hydra = options[:hydra] || Typhoeus::Hydra.hydra
+      end
+
+      def market_url
+        "https://market.android.com/details?id=#{@app_id}"
+      end
+
+      def update
+        resp = Typhoeus::Request.get(market_url)
+        result = App.parse(resp.body)
+        update_callback(result)
+
+        self
+      end
+
+      def enqueue_update
+        request = Typhoeus::Request.new(market_url)
+        request.on_complete do |response|
+          result = App.parse(response.body)
+          update_callback(result)
+        end
+        hydra.queue(request)
+
+        self
+      end
+
+    private
+      def update_callback(result)
+        MARKET_ATTRIBUTES.each do |a|
+          attr_name = "@#{a}"
+          attr_value = result[a]
+          instance_variable_set(attr_name, attr_value)
+        end
+      end
+    end
+
+  end
+end

data/lib/market_bot/android/leaderboard/constants.rb

@@ -0,0 +1,59 @@
+module MarketBot
+  module Android
+
+    class Leaderboard
+      IDENTIFIERS = [
+        :apps_editors_choice,
+        :apps_featured,
+        :apps_movers_shakers,
+        :apps_tablet_featured,
+        :apps_topgrossing,
+        :apps_topselling_free,
+        :apps_topselling_new_free,
+        :apps_topselling_new_paid,
+        :apps_topselling_paid,
+        :apps_topselling_paid_game
+      ]
+
+      CATEGORIES = [
+        :application,
+        :app_wallpaper,
+        :app_widgets,
+        :arcade,
+        :books_and_reference,
+        :brain,
+        :business,
+        :cards,
+        :casual,
+        :comics,
+        :communication,
+        :education,
+        :entertainment,
+        :finance,
+        :game,
+        :game_wallpaper,
+        :game_widgets,
+        :health_and_fitness,
+        :libraries_and_demo,
+        :lifestyle,
+        :media_and_video,
+        :medical,
+        :music_and_audio,
+        :news_and_magazines,
+        :personalization,
+        :photography,
+        :productivity,
+        :racing,
+        :shopping,
+        :social,
+        :sports,
+        :sports_games,
+        :tools,
+        :transportation,
+        :travel_and_local,
+        :weather
+      ]
+    end
+
+  end
+end

data/lib/market_bot/android/leaderboard.rb

@@ -0,0 +1,112 @@
+module MarketBot
+  module Android
+
+    class Leaderboard
+      attr_reader :identifier, :category
+      attr_reader :hydra
+
+      def self.parse(html)
+        results = []
+        doc = Nokogiri::HTML(html)
+
+        doc.css('.snippet').each do |snippet_node|
+          result = {}
+
+          details_node = snippet_node.css('.details')
+
+          unless snippet_node.css('.ratings').empty?
+            stars_text = snippet_node.css('.ratings').first.attributes['title'].value
+            result[:stars] = /Rating: (.+) stars .*/.match(stars_text)[1].to_i
+          else
+            result[:stars] = nil
+          end
+
+          result[:title] = details_node.css('.title').first.attributes['title'].to_s
+          result[:price_usd] = details_node.css('.buy-button-price').children.first.text.gsub(' Buy', '')
+          result[:developer] = details_node.css('.attribution').children.first.text
+          result[:market_id] = details_node.css('.title').first.attributes['href'].to_s.gsub('/details?id=', '').gsub(/&feature=.*$/, '')
+          result[:market_url] = "https://market.android.com/details?id=#{result[:market_id]}"
+
+          result[:price_usd] = '$0.00' if result[:price_usd] == 'Install'
+
+          results << result
+        end
+
+        results
+      end
+
+      def initialize(identifier, category=nil, options={})
+        @identifier = identifier
+        @category = category
+        @hydra = options[:hydra] || Typhoeus::Hydra.hydra
+        @parsed_results = []
+      end
+
+      def market_urls(options={})
+        results = []
+
+        min_page = options[:min_page] || 1
+        max_page = options[:max_page] || 25
+
+        (min_page..max_page).each do |page|
+          start_val = (page - 1) * 24
+
+          url = 'https://market.android.com/details?id=' + identifier.to_s
+          url << "&cat=#{category.to_s.upcase}" if category
+          url << "&start=#{start_val}"
+          url << "&num=24"
+
+          results << url
+        end
+
+        results
+      end
+
+      def enqueue_update(options={})
+        min_rank = options[:min_rank] || 1
+        max_rank = options[:max_rank] || 500
+
+        min_page = rank_to_page(min_rank)
+        max_page = rank_to_page(max_rank)
+
+        @parsed_results = []
+
+        urls = market_urls(:min_page => min_page, :max_page => max_page)
+        urls.each_index{ |i| process_page(urls[i], i+1) }
+
+        self
+      end
+
+      def update(options={})
+        enqueue_update(options)
+        @hydra.run
+
+        self
+      end
+
+      def rank_to_page(rank)
+        ((rank - 1) / 24) + 1
+      end
+
+      def results
+        raise 'Results do not exist yet.' unless @parsed_results
+        @parsed_results.reject{ |page| page.nil? || page.empty? }.flatten
+      end
+
+    private
+      def process_page(url, page_num)
+        request = Typhoeus::Request.new(url)
+        request.on_complete do |response|
+          result = Leaderboard.parse(response.body)
+          update_callback(result, page_num)
+        end
+        @hydra.queue(request)
+      end
+
+      def update_callback(result, page)
+        @parsed_results[page] = result
+      end
+    end
+
+  end
+end

data/lib/market_bot.rb

@@ -0,0 +1,7 @@
+require 'typhoeus'
+require 'nokogiri'
+
+require 'market_bot/android/app'
+require 'market_bot/android/leaderboard/constants'
+require 'market_bot/android/leaderboard'
+

data/spec/market_bot/android/app_spec.rb

@@ -0,0 +1,84 @@
+require File.expand_path(File.dirname(__FILE__) + '../../../spec_helper')
+
+include MarketBot::Android
+
+test_id = 'com.bluefroggaming.popdat'
+test_src_data = read_file(File.dirname(__FILE__), 'data', 'app_1.txt')
+
+def check_getters(app)
+  it 'should populate the getters' do
+    app.title.should == 'Pop Dat'
+    app.rating.should == 4
+    app.updated.should == 'August 27, 2011'
+    app.current_version.should == '1.0'
+    app.requires_android.should == '2.2 and up'
+    app.category.should == 'Arcade & Action'
+    app.installs.should == '50 - 100'
+    app.size.should == '18M'
+    app.price.should == 'Free'
+    app.content_rating.should == 'Everyone'
+    app.description.should =~ /^Experience the next level of chain/
+  end
+end
+
+describe 'App' do
+  context 'Construction' do
+    it 'should copy the app_id param' do
+      app = App.new(test_id)
+      app.app_id.should == test_id
+    end
+
+    it 'should copy optional params' do
+      hydra = Typhoeus::Hydra.new
+      app = App.new(test_id, :hydra => hydra)
+      app.hydra.should equal(hydra)
+    end
+  end
+
+  it 'should generate market URLs' do
+   App.new(test_id).market_url.should == "https://market.android.com/details?id=#{test_id}"
+  end
+
+  context 'Parsing' do
+    it 'should populate a hash with the correct keys/values' do
+      result = App.parse(test_src_data)
+
+      result[:title].should == 'Pop Dat'
+      result[:rating].should == 4
+      result[:updated].should == 'August 27, 2011'
+      result[:current_version].should == '1.0'
+      result[:requires_android].should == '2.2 and up'
+      result[:category].should == 'Arcade & Action'
+      result[:installs].should == '50 - 100'
+      result[:size].should == '18M'
+      result[:price].should == 'Free'
+      result[:content_rating].should == 'Everyone'
+      result[:description].should =~ /^Experience the next level of chain/
+
+      result
+    end
+  end
+
+  context 'Updating' do
+    response = Typhoeus::Response.new(:code => 200, :headers => '', :body => test_src_data)
+
+    context 'Quick API' do
+      app = App.new(test_id)
+      hydra = Typhoeus::Hydra.hydra
+      hydra.stub(:get, app.market_url).and_return(response)
+
+      app.update
+      check_getters(app)
+    end
+
+    context 'Batch API' do
+      hydra = Typhoeus::Hydra.new
+      app = App.new(test_id, :hydra => hydra)
+      hydra.stub(:get, app.market_url).and_return(response)
+
+      app.enqueue_update
+      hydra.run
+      check_getters(app)
+    end
+  end
+end