peekapp 0.1.0

data/.gitignore

@@ -0,0 +1,5 @@
+pkg/*
+*.gem
+.bundle
+test.rb
+.rvmrc

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,20 @@
+PATH
+  remote: .
+  specs:
+    peekapp (0.1.0)
+      curb (>= 0.7.9)
+      json (>= 1.4.6)
+      nokogiri (>= 1.4.4)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    curb (0.7.10)
+    json (1.5.0)
+    nokogiri (1.4.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  peekapp!

data/README.markdown

@@ -0,0 +1,42 @@
+Retrieve reviews and ratings from the App Store.
+
+# Installation
+    gem install peekapp
+
+## How to
+
+For advanced functionnalities you should read the source. Peekapp can only retrieve ratings & reviews from the Canadian App Store (*this will be fixed soon*).
+
+    require "peekapp"
+
+    # Get the App
+    app = Peekapp::Apps::find 390574988 # App ID
+
+    # Get reviews for this App
+    app.reviews
+    # => [#<Review:0x102237a28 @data={
+    #       :title    => "Amazing",
+    #       :comment  => "Best Twitter app on the face of the planet!",
+    #       :username => "Thomas Gallagher",
+    #       :rating   => 5,
+    #       :user_id  => 33308895,
+    #       :version  => "2.0",
+    #       :date     => "9-Oct-2009",
+    #       :id       => 131605495
+    #    }>, ...]
+
+    # And the ratings...
+    app.ratings
+    # => [#Rating:0x1029372a23 @data={
+    #      :current => { "1": 38, "2": 12, "3": 23, "4": 25, "5": 105 },
+    #      :all     => { "1": 2736, "2": 749, "3": 1045, "4": 1103, "5": 3880 },
+    #      :store_id => "143455-5,12"
+    #    }>, ...]
+
+## Warning
+Since Peekapp is **scraping** the App Store, you might experience some problems if Apple change iTunes' html layout. I've made some tests and the App Store is updated every 20 minutes (*ballpark*). So don't waste your time trying to get *real time* ratings & reviews.
+
+## Todo
+  - Create unit tests w/ [FakeWeb](https://github.com/chrisk/fakeweb)
+  - Allow international App Stores
+  - iTunes Connect support

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/peekapp.rb

@@ -0,0 +1,10 @@
+require "yaml"
+require "curb"
+require "json"
+require "nokogiri"
+
+require "peekapp/base.rb"
+require "peekapp/version.rb"
+require "peekapp/apps.rb"
+require "peekapp/reviews.rb"
+require "peekapp/ratings.rb"

data/lib/peekapp/apps.rb

@@ -0,0 +1,46 @@
+module Peekapp
+
+  module Apps
+
+    def self.search query # {{{
+      result = JSON.parse(Peekapp::query(:url => $peekapp_config[:search_url], :keywords => query.gsub(' ', '%20')))
+      result['results'].map { |a| App.new a }
+    end # }}}
+
+    def self.find id # {{{
+      result = JSON.parse(Peekapp::query :url => $peekapp_config[:app_url], :app_id => id)
+      raise AppNotFound if result["resultCount"] < 1
+      result["results"].map{ |a| App.new a }.first
+    end # }}}
+
+  end
+
+  class App
+
+    attr_accessor :_reviews, :_ratings
+
+    def initialize data # {{{
+      @data = data
+    end # }}}
+
+    def id # {{{
+      @data["trackId"]
+    end # }}}
+
+    def method_missing method # {{{
+      @data[method.to_s]
+    end # }}}
+
+    def ratings options={} # {{{
+      self._ratings = Peekapp::Ratings.from_app self.id, ["143455-5,12"], options if self._ratings.nil? or options[:force_refresh]
+      self._ratings
+    end # }}}
+
+    def reviews options={} # {{{
+      self._reviews = Peekapp::Reviews.from_app self.id, ["143455-5,12"], options if self._reviews.nil? or options[:force_refresh]
+      self._reviews
+    end # }}}
+
+  end
+
+end

data/lib/peekapp/base.rb

@@ -0,0 +1,26 @@
+$peekapp_config = YAML::load(File.open("#{File.dirname(__FILE__)}/config/default.yml"))
+
+module Peekapp
+
+  def self.query args # {{{
+    c = Curl::Easy.perform(parse_url(args)) do |request|
+      request.headers["User-Agent"] = $peekapp_config[:user_agent]
+      request.headers["X-Apple-Store-Front"] = "#{args[:store_id]}" if args[:store_id]
+    end
+    c.body_str
+  end # }}}
+
+  def self.parse_url data # {{{
+    url = data[:url]
+    data.each_pair{|k,v| url = url.gsub("|#{k}|", v.to_s) if k != :url}
+    url
+  end # }}}
+
+  def self.load_exceptions # {{{
+    exceptions = YAML::load(File.open("#{File.dirname(__FILE__)}/config/exceptions.yml"))
+    exceptions.each { |error| self.module_eval("#{error} = Class.new(StandardError)") }
+  end # }}}
+
+end
+
+Peekapp::load_exceptions

data/lib/peekapp/config/default.yml

@@ -0,0 +1,5 @@
+:user_agent: "iTunes/10.0.1 (Macintosh; Intel Mac OS X 10.6.4) AppleWebKit/533.18.1"
+:reviews_url: "http://ax.itunes.apple.com/WebObjects/MZStore.woa/wa/customerReviews?update=1&id=|app_id|&appVersion=|app_version|&sort=4&displayable-kind=11&page=|page|"
+:ratings_url: "http://itunes.apple.com/WebObjects/MZStore.woa/wa/customerReviews?id=|app_id|&displayable-kind=11"
+:app_url: "http://ax.itunes.apple.com/WebObjects/MZStoreServices.woa/wa/wsLookup?id=|app_id|"
+:search_url: "http://ax.itunes.apple.com/WebObjects/MZStoreServices.woa/wa/wsSearch?term=|keywords|&entity=software"

data/lib/peekapp/config/exceptions.yml

@@ -0,0 +1,4 @@
+- AppNotFound
+- ReviewsUnavailableForThisApp
+- LatestReviewReached
+

data/lib/peekapp/ratings.rb

@@ -0,0 +1,66 @@
+module Peekapp
+
+  module Ratings
+
+    def self.from_app id, stores, options = {} # {{{
+      rating = Array.new
+      stores.each do |s|
+        rating << parse({
+          :dom => Peekapp::query({
+            :url => $peekapp_config[:ratings_url],
+            :page => 1,
+            :app_id => id,
+            :store_id => s,
+            :app_version => (options[:app_version] ? options[:app_version] : "all")
+          }),
+          :store_id => s
+        })
+      end
+      rating
+    end # }}}
+
+    def self.parse data # {{{
+      rating = Rating.new :store_id => data[:store_id]
+      dom = Nokogiri::HTML.parse(data[:dom])
+      nb_ratings_section = dom.css("div.ratings-histogram").count
+
+      dom.css("div.ratings-histogram").each_with_index do |r,i|
+        data = Hash.new
+        result = true
+        r.css("div.vote").each_with_index{ |v,j| data.merge!({(5-j) => v.css("span.total").children.to_s.to_i }) }
+
+        if nb_ratings_section === 1 or i === 1
+          rating.set :key => :all, :value => data
+          rating.set :key => :current, :value => data if nb_ratings_section === 1
+        else
+          rating.set :key => :current, :value => data
+        end
+      end
+
+      rating.set :key => :all, :value => {1 => 0, 2 => 0, 3 => 0, 4 => 0, 5 => 0} if nb_ratings_section < 1
+      rating
+    end # }}}
+
+  end
+
+  class Rating
+
+    def initialize data # {{{
+      @data = data
+    end # }}}
+
+    def id # {{{
+      @data[:id]
+    end # }}}
+
+    def set args # {{{
+      @data.merge!({args[:key] => args[:value]})
+    end # }}}
+
+    def method_missing method # {{{
+      @data[method.to_sym]
+    end # }}}
+
+  end
+
+end

data/lib/peekapp/reviews.rb

@@ -0,0 +1,75 @@
+module Peekapp
+
+  module Reviews
+
+    def self.from_app id, stores, options = {} # {{{
+      reviews = Array.new
+      begin
+        stores.each do |s|
+          args = {
+            :url         => $peekapp_config[:reviews_url],
+            :app_id      => id,
+            :store_id    => s,
+            :page        => (options[:page] ? options[:page] : 1),
+            :app_version => (options[:app_version] ? options[:app_version] : "all")
+          }
+          dom = Peekapp::query args
+          begin
+            nb_page = Nokogiri::HTML.parse(dom).css("div.paginated-content").first["total-number-of-pages"].to_i 
+          rescue
+            raise ReviewsUnavailableForThisApp
+          end
+          nb_page.times do |z|
+            # dom is already instanciated for z === 0
+            args[:page] = z+1
+            dom = Peekapp::query args if z > 0
+            parse(dom).each do |p|
+              raise LatestReviewReached if p.id === options[:latest_review_id].to_s
+              reviews << p
+            end
+          end
+        end
+      rescue LatestReviewReached
+        # Do nothing... just get out.
+      end
+      reviews
+    end # }}}
+
+    def self.parse data # {{{
+      reviews = Array.new
+      dom = Nokogiri::HTML.parse(data)
+      dom.css("div.customer-review").each do |r|
+        # That's some ugly stuff... I know
+        reviews << Review.new({
+          :id          => r.css("a.report").first["href"].split("=").last,
+          :title       => r.css("span.customerReviewTitle").children.to_s,
+          :comment     => r.css("p.content").children.to_s.gsub("\n", "").gsub("  ", ""),
+          :username    => r.css("a.reviewer").children.to_s.gsub("\n", "").gsub(" ", ""),
+          :user_id     => r.css("a.reviewer").first["href"].split('=').last,
+          :rating      => r.css("div.rating").first['aria-label'].split(' ').first.to_i,
+          :date        => r.css("span.user-info").children.to_s.split(" -\n").last.gsub("\n", "").gsub(" ", ""),
+          :version     => r.css("span.user-info").children.to_s.split(" -\n")[1].split(" - ").first.split(" ").last.to_s,
+        })
+      end
+      reviews
+    end # }}}
+
+  end
+
+  class Review
+
+    def initialize data # {{{
+      @data = data
+    end # }}}
+
+    def id # {{{
+      @data[:id]
+    end # }}}
+
+    def method_missing method # {{{
+      @data[method.to_sym]
+    end # }}}
+
+  end
+
+end

data/lib/peekapp/version.rb

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

data/peekapp.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "peekapp/version"
+
+Gem::Specification.new do |s|
+  s.name        = "peekapp"
+  s.version     = Peekapp::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Samuel Garneau"]
+  s.email       = ["samgarneau@gmail.com"]
+  s.homepage    = "http://github.com/garno/peekapp"
+  s.summary     = %q{Retrieve ratings & reviews from the App Store}
+  s.description = %q{Easily scrape the App Store to retrieve ratings & reviews.}
+
+  #s.rubyforge_project = "peekapp"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency('nokogiri', '>= 1.4.4')
+  s.add_dependency('json', '>= 1.4.6')
+  s.add_dependency('curb', '>= 0.7.9')
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification 
+name: peekapp
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Samuel Garneau
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-17 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 4
+        - 4
+        version: 1.4.4
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 4
+        - 6
+        version: 1.4.6
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: curb
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 17
+        segments: 
+        - 0
+        - 7
+        - 9
+        version: 0.7.9
+  type: :runtime
+  version_requirements: *id003
+description: Easily scrape the App Store to retrieve ratings & reviews.
+email: 
+- samgarneau@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.markdown
+- Rakefile
+- lib/peekapp.rb
+- lib/peekapp/apps.rb
+- lib/peekapp/base.rb
+- lib/peekapp/config/default.yml
+- lib/peekapp/config/exceptions.yml
+- lib/peekapp/ratings.rb
+- lib/peekapp/reviews.rb
+- lib/peekapp/version.rb
+- peekapp.gemspec
+has_rdoc: true
+homepage: http://github.com/garno/peekapp
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Retrieve ratings & reviews from the App Store
+test_files: []
+