itunes_store_bot 0.1.3

data/itunes_json_responses_example/reviews_summary.json

@@ -0,0 +1,44 @@
+// URL https://itunes.apple.com/gb/customer-reviews/id576939960?dataOnly=true&displayable-kind=11
+// Host: itunes.apple.com
+// X-Apple-Store-Front: 143444,17
+// Accept-Encoding: gzip, deflate
+// Accept-Language: en-us, en;q=0.50
+// Accept: */*
+// User-Agent: iTunes/11.1.5 (Macintosh; OS X 10.9.2) AppleWebKit/537.74.9
+// Connection: keep-alive
+// Referer: https://itunes.apple.com/gb/app/minigore-2-zombies/id576939960?mt=8
+// X-Dsid: 107225448
+// Cookie: itsMetricsR=Search-GB@@Media%20Search%20Pages@@Tab_allResults%7CSwoosh_1%7CLockup_1@@; mz_user_info_version=0; X-JS-SP-TOKEN=ShFFJg7tbLc73quBpXRx9A==; X-JS-TIMESTAMP=1398522586; dssid2=8c2b3fbc-280c-40e1-8ffa-e62cd445996c; itspod=16; mz_at0-107225448=AwQAAAEBAAGuGAAAAABTDGLhY26IOIbXt7Dsyv9cBKkMPiF3XZQ=; mz_at_ssl-107225448=AwUAAAEBAAGuGAAAAABTDGLh9z+4LJ4qMCzdE4BpGWpJVIufa8c=; ns-mzf-inst=35-139-80-104-92-8186-162518-16-nk11; Pod=16; pxro=1; s_fid=66291422B54414F6-23C1CAE2F51BB888; s_vi=[CS]v1|2937EB8085010821-60000101E0001D80[CE]; s_vnum_n2_us=3|12,97|1,0|1; X-Dsid=107225448; xp_ci=3zra8w6zCCqz5KIzAfBz1A0JaXYPl
+// X-Apple-Tz: 3600
+// Pragma: no-cache
+// Cache-Control: no-cache
+
+
+{
+	"adamId": 576939960,
+	"totalNumberOfReviews": 189,
+	"writeUserReviewUrl": "https://userpub.itunes.apple.com/WebObjects/MZUserPublishing.woa/wa/writeUserReview?cc=gb&displayable-kind=11&id=576939960",
+	"clickToRateUrl": "https://userpub.itunes.apple.com/WebObjects/MZUserPublishing.woa/wa/userRateContent?displayable-kind=11&id=576939960",
+	"userReviewsRowUrl": "https://itunes.apple.com/WebObjects/MZStore.woa/wa/userReviewsRow",
+	"userReviewsSortOptions": [{
+		"sortId": 1,
+		"name": "Most Helpful"
+	}, {
+		"sortId": 2,
+		"name": "Most Favorable"
+	}, {
+		"sortId": 3,
+		"name": "Most Critical"
+	}, {
+		"sortId": 4,
+		"name": "Most Recent"
+	}],
+	"kindId": 11,
+	"kindExtId": "iosSoftware",
+	"kindName": "software",
+	"saveUserReviewUrl": "https://userpub.itunes.apple.com/WebObjects/MZUserPublishing.woa/wa/saveUserReview?displayable-kind=11",
+	"ratingAverage": 4.25494000000000038852476791362278163433074951171875,
+	"ratingCount": 506,
+	"ariaLabelForRatings": "4 and a half stars",
+	"ratingCountList": [48, 23, 28, 60, 347]
+}

data/itunes_store_bot.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |s|
+  s.name          = 'itunes_store_bot'
+  s.version       = '0.1.3'
+  s.date          = '2014-04-26'
+  s.summary       = 'Get any iOS App Rating info'
+  s.description   = '[Alpha version] Get your iOS App Rating, number of votes.. from the iTunes Store'
+  s.authors       = ['Stefano Bortolotti']
+  s.files         = `git ls-files`.split($/)
+  s.require_paths = ['lib']
+  s.homepage      = 'http://rubygems.org/gems/itunes_store_bot'
+  s.license       = 'MIT'
+
+  s.add_dependency('http', '~> 0.5', '>= 0.5.0')
+  s.add_dependency('json', '~> 1.8', '>= 1.8.0')
+end

data/lib/itunes_store_bot.rb

@@ -0,0 +1,167 @@
+require 'net/http'
+require 'openssl'
+require 'json'
+
+class AppStoreBot
+
+  def initialize(app_id, app_country='gb')
+    @app_id = app_id
+    @app_country = app_country
+
+    @itunes_domain_url = 'itunes.apple.com'
+    @itunes_http_options = {'User-Agent' => 'iTunes/11.1.5 (Macintosh; OS X 10.9.2) AppleWebKit/537.74.9'}
+    @itunes_reviews_url = ''
+
+    @app_data = {}
+    get_app_info
+  end
+
+  def get_app_data
+    @app_data
+  end
+
+  def update_app_data
+    get_app_info
+    @app_data
+  end
+
+  def get_app_rating
+    @app_data['all_versions'][:ratingAverage]
+  end
+
+  def get_app_voters_count
+    @app_data['all_versions'][:ratingCount]
+  end
+
+  def get_last_app_rating
+    @app_data['last_version'][:ratingAverage]
+  end
+
+  def get_last_app_voters_count
+    @app_data['last_version'][:ratingCount]
+  end
+
+  def get_last_version_reviews(sort_type='4') # 1: , 2: , 3: , 4: most recent
+    get_reviews('last_version', sort_type)
+    @app_data['last_version'][:reviews]
+  end
+
+  def get_all_versions_reviews(sort_type='4') # 1: , 2: , 3: , 4: most recent
+    get_reviews('all_versions', sort_type)
+    @app_data['all_versions'][:reviews]
+  end
+
+  private 
+
+  def get_app_info
+
+    # https://itunes.apple.com/gb/customer-reviews/id576939960?dataOnly=true&displayable-kind=11&appVersion=current
+    http = Net::HTTP.new(@itunes_domain_url, Net::HTTP.https_default_port())
+    http.use_ssl = true
+    http.verify_mode = OpenSSL::SSL::VERIFY_NONE # disable ssl certificate check
+
+    path = "/#{@app_country}/customer-reviews/id#{@app_id}?dataOnly=true&displayable-kind=11"
+    # request the current app json data
+    response = http.request( Net::HTTP::Get.new( path + "&appVersion=current" , @itunes_http_options) )
+
+    if response.code != '200'
+      puts "App Store store website communication (status-code: #{response.code})\n#{response.body}"
+    else
+      data = extract_app_data_from_raw_json( response.body )
+      if data[:error]
+        puts "Application requested couldn't be found [#{data[:error]}]"
+      end
+      @app_data['last_version'] = data
+      #puts "#{@app_data['last_version']}"
+    end
+
+    # request the app all versions json data
+    response2 = http.request( Net::HTTP::Get.new( path , @itunes_http_options) )
+
+    if response2.code != '200'
+      puts "App Store store website communication (status-code: #{response2.code})\n#{response2.body}"
+    else
+      data = extract_app_data_from_raw_json( response2.body )
+      if data[:error]
+        puts "Application requested couldn't be found [#{data[:error]}]"
+      end
+      @app_data['all_versions'] = data
+      #puts "#{@app_data['all_versions']}"
+    end
+
+  end
+
+  def extract_app_data_from_raw_json(data)
+    raw_app_data = JSON.parse( data )
+    set_itunes_review_url_path( raw_app_data['userReviewsRowUrl'] || nil ) unless raw_app_data['error']
+    parsed_app_data = {
+      :ratingCount => raw_app_data['ratingCount'] || 0,
+      :ratingAverage => raw_app_data['ratingAverage'] || 0.0,
+      :ratingCountList => raw_app_data['ratingCountList'] || [0, 0, 0, 0, 0],
+      :numberOfReviews => raw_app_data['totalNumberOfReviews'] || 0,
+      :reviews => []
+    }
+
+    if raw_app_data['error']
+      parsed_app_data[:error] = raw_app_data['error']
+    end
+
+    parsed_app_data
+  end
+
+  def set_itunes_review_url_path(url)
+    if url
+      index = url.index(@itunes_domain_url)
+      @itunes_reviews_url = url[index, url.length].sub! @itunes_domain_url, ""
+    else
+      puts 'Please provide a valid URL string.'
+    end
+  end
+
+  def get_reviews(version='last_version', sort_type='1')
+
+    # https://itunes.apple.com/WebObjects/MZStore.woa/wa/userReviewsRow?cc=gb&id=576939960&displayable-kind=11&startIndex=0&endIndex=8&sort=1&appVersion=current
+    http = Net::HTTP.new(@itunes_domain_url, Net::HTTP.https_default_port())
+    http.use_ssl = true
+    http.verify_mode = OpenSSL::SSL::VERIFY_NONE # disable ssl certificate check
+
+    query_parameters = "?cc=#{@app_country}&id=#{@app_id}&displayable-kind=11&startIndex=0&endIndex=9&sort=#{sort_type}"
+    query_parameters += "&appVersion=current" if ( version == 'last_version' )
+    path = @itunes_reviews_url + query_parameters
+    #puts path
+
+    # request the app json data
+    response = http.request( Net::HTTP::Get.new( path + query_parameters, @itunes_http_options) )
+
+    if response.code != '200'
+      puts "App Store store communication (status-code: #{response.code})\n#{response.body}"
+    else
+      #print "#{response.body}\n"
+      reviews = JSON.parse( response.body )
+      parsed_reviews = []
+
+      reviews['userReviewList'].each do |review|
+        #print "#{review}\n"
+        parsed_reviews.push( { 
+            :title => review['title'],
+            :vote => review['rating'],
+            :body => review['body'],
+            :date => review['date'],
+            :name => review['name'],
+            :id => review['userReviewId']
+          } )
+      end
+      @app_data[version][:reviews] = parsed_reviews
+    end
+  end
+
+end
+
+#a = AppStoreBot.new('457876088', 'us') # minigore 576939960; ASOS 457876088
+#puts "Last App Rating #{a.get_last_app_rating}"
+#puts "Last App Voters count #{a.get_last_app_voters_count}"
+#puts "All time App Rating #{a.get_app_rating}"
+#puts "All time App Voters count #{a.get_app_voters_count}"
+#puts "#{a.get_last_version_reviews('4')}"
+#puts a.get_app_data
+

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: itunes_store_bot
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Stefano Bortolotti
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+description: '[Alpha version] Get your iOS App Rating, number of votes.. from the
+  iTunes Store'
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- README.md
+- itunes_json_responses_example/reviews.json
+- itunes_json_responses_example/reviews_summary.json
+- itunes_store_bot.gemspec
+- lib/itunes_store_bot.rb
+homepage: http://rubygems.org/gems/itunes_store_bot
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Get any iOS App Rating info
+test_files: []