spaceship 0.31.10 → 0.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4b410b389cf8004d24c610840d5e830680c1725d
-  data.tar.gz: 18b0892ee506b0b7cd73df036d44d830c068d5f3
+  metadata.gz: 446e6df28c4691d7dea2ecb1d0e9ef8543c418a7
+  data.tar.gz: 7ea38ddea78ce1183853b9e619b724ada951a8da
 SHA512:
-  metadata.gz: 03390791a5a2bff1e17f109c649055ff8aff11e16bdf3cd6b1addb79e30128e7153ffe7d7e3e23e95386e94fd893102bb890b72b8bc266776695a47e4709e8dd
-  data.tar.gz: 453285e84082f6909f743eb4d39b5efdd130d809b6d5581cefe22d1f4248c08ffc6a162b042a0885013b7d1911ea18adcb275791f4865e3c1c8dba42c3fbd675
+  metadata.gz: 27fc2dd359daf036dc9e0d22274ccf99ff9336239a765d9ba1c0ff18a23f7d2062498e345f4d74cc08d29a9c52ed24ad82ebe7a09c72df7fb7635f90d4031f1c
+  data.tar.gz: e28fd65e2a39cac2d175a3f615bde469ba0f30b00c0af1700345fd9046ec93bba459c157dbbfe39ea323e2f16d9c6dec58ff2818274d1dc35e94e5cc3800d0e7

data/lib/spaceship/client.rb

@@ -310,6 +310,11 @@ module Spaceship
 
     def itc_service_key
       return @service_key if @service_key
+
+      # Check if we have a local cache of the key
+      itc_service_key_path = File.expand_path("~/Library/Caches/spaceship_itc_service_key.txt")
+      return File.read(itc_service_key_path) if File.exist?(itc_service_key_path)
+
       # Some customers in Asia have had trouble with the CDNs there that cache and serve this content, leading
       # to "buffer error (Zlib::BufError)" from deep in the Ruby HTTP stack. Setting this header requests that
       # the content be served only as plain-text, which seems to work around their problem, while not affecting
@@ -319,7 +324,12 @@ module Spaceship
       headers = { 'Accept-Encoding' => 'identity' }
       # We need a service key from a JS file to properly auth
       js = request(:get, "https://itunesconnect.apple.com/itc/static-resources/controllers/login_cntrl.js", nil, headers)
-      @service_key ||= js.body.match(/itcServiceKey = '(.*)'/)[1]
+      @service_key = js.body.match(/itcServiceKey = '(.*)'/)[1]
+
+      # Cache the key locally
+      File.write(itc_service_key_path, @service_key)
+
+      return @service_key
     end
 
     #####################################################

data/lib/spaceship/portal/portal_client.rb

@@ -9,29 +9,6 @@ module Spaceship
       "https://developer.apple.com/services-account/#{PROTOCOL_VERSION}/"
     end
 
-    # Fetches the latest API Key from the Apple Dev Portal
-    def api_key
-      cache_path = File.expand_path("~/Library/Caches/spaceship_api_key.txt")
-      begin
-        cached = File.read(cache_path)
-      rescue Errno::ENOENT
-      end
-      return cached if cached
-
-      landing_url = "https://developer.apple.com/account/"
-      logger.info("GET: " + landing_url)
-      headers = @client.get(landing_url).headers
-      results = headers['location'].match(/.*appIdKey=(\h+)/)
-      if (results || []).length > 1
-        api_key = results[1]
-        FileUtils.mkdir_p(File.dirname(cache_path))
-        File.write(cache_path, api_key) if api_key.length == 64
-        return api_key
-      else
-        raise "Could not find latest API Key from the Dev Portal - the server might be slow right now"
-      end
-    end
-
     def send_login_request(user, password)
       response = send_shared_login_request(user, password)
       return response if self.cookie.include?("myacinfo")
@@ -353,9 +330,9 @@ module Spaceship
     end
 
     def create_provisioning_profile!(name, distribution_method, app_id, certificate_ids, device_ids, mac: false, sub_platform: nil)
-      # Calling provisioning_profiles uses a different api end point than creating or deleting them so we
-      # use a different entity to gather the csrf token
-      ensure_csrf(Spaceship::App)
+      ensure_csrf(Spaceship::ProvisioningProfile) do
+        fetch_csrf_token_for_provisioning
+      end
 
       params = {
         teamId: team_id,
@@ -372,9 +349,9 @@ module Spaceship
     end
 
     def download_provisioning_profile(profile_id, mac: false)
-      # Calling provisioning_profiles uses a different api end point than creating or deleting them so we
-      # use a different entity to gather the csrf token
-      ensure_csrf(Spaceship::App)
+      ensure_csrf(Spaceship::ProvisioningProfile) do
+        fetch_csrf_token_for_provisioning
+      end
 
       r = request(:get, "account/#{platform_slug(mac)}/profile/downloadProfileContent", {
         teamId: team_id,
@@ -389,9 +366,9 @@ module Spaceship
     end
 
     def delete_provisioning_profile!(profile_id, mac: false)
-      # Calling provisioning_profiles uses a different api end point than creating or deleting them so we
-      # use a different entity to gather the csrf token
-      ensure_csrf(Spaceship::App)
+      ensure_csrf(Spaceship::ProvisioningProfile) do
+        fetch_csrf_token_for_provisioning
+      end
 
       r = request(:post, "account/#{platform_slug(mac)}/profile/deleteProvisioningProfile.action", {
         teamId: team_id,
@@ -401,9 +378,9 @@ module Spaceship
     end
 
     def repair_provisioning_profile!(profile_id, name, distribution_method, app_id, certificate_ids, device_ids, mac: false)
-      # Calling provisioning_profiles uses a different api end point than creating or deleting them so we
-      # use a different entity to gather the csrf token
-      ensure_csrf(Spaceship::App)
+      ensure_csrf(Spaceship::ProvisioningProfile) do
+        fetch_csrf_token_for_provisioning
+      end
 
       r = request(:post, "account/#{platform_slug(mac)}/profile/regenProvisioningProfile.action", {
         teamId: team_id,
@@ -418,6 +395,27 @@ module Spaceship
       parse_response(r, 'provisioningProfile')
     end
 
+    # We need a custom way to fetch the csrf token for the provisioning profile requests, since
+    # we use a separate API endpoint (host of Xcode API) to fetch the provisioning profiles
+    # All we do is fetch one profile (if exists) to get a valid csrf token with its time stamp
+    # This method is being called from all requests that modify, create or downloading provisioning
+    # profiles.
+    # Source https://github.com/fastlane/fastlane/issues/5903
+    def fetch_csrf_token_for_provisioning(mac: false)
+      req = request(:post) do |r|
+        r.url "https://developer.apple.com/services-account/#{PROTOCOL_VERSION}/account/#{platform_slug(mac)}/profile/listProvisioningProfiles.action"
+        r.params = {
+          teamId: team_id,
+          pageSize: 1,
+          pageNumber: 1,
+          sort: "name=asc"
+        }
+      end
+
+      parse_response(req, 'provisioningProfiles')
+      return nil
+    end
+
     private
 
     # This is a cache of entity type (App, AppGroup, Certificate, Device) to csrf_tokens
@@ -428,6 +426,8 @@ module Spaceship
     # Ensures that there are csrf tokens for the appropriate entity type
     # Relies on store_csrf_tokens to set csrf_tokens to the appropriate value
     # then stores that in the correct place in cache
+    # This method also takes a block, if you want to send a custom request, instead of
+    # calling `.all` on the given klass. This is used for provisioning profiles.
     def ensure_csrf(klass)
       if csrf_cache[klass]
         self.csrf_tokens = csrf_cache[klass]
@@ -438,13 +438,13 @@ module Spaceship
 
       # If we directly create a new resource (e.g. app) without querying anything before
       # we don't have a valid csrf token, that's why we have to do at least one request
-      klass.all
+      block_given? ? yield : klass.all
 
       # Update 18th August 2016
       # For some reason, we have to query the resource twice to actually get a valid csrf_token
       # I couldn't find out why, the first response does have a valid Set-Cookie header
       # But it still needs this second request
-      klass.all
+      block_given? ? yield : klass.all
 
       csrf_cache[klass] = self.csrf_tokens
     end

data/lib/spaceship/tunes/app_ratings.rb

@@ -0,0 +1,107 @@
+module Spaceship
+  module Tunes
+    # Represents app ratings from iTunesConnect
+    class AppRatings < TunesBase
+      # @return (Spaceship::Tunes::Application) A reference to the application
+      #   this version is for
+      attr_accessor :application
+
+      # @return (Spaceship::Tunes::AppRatingSummary) A summary of the overall ratings for the application
+      attr_accessor :rating_summary
+
+      # @return (Hash) mapping country codes to a (Spaceship::Tunes::AppRatingSummary) summary of ratings for that country
+      attr_reader :store_fronts
+
+      # @return (Hash) of iTunesConnect version id's to readable version numbers
+      attr_reader :versions
+
+      attr_mapping({
+        'versions' => :versions
+      })
+
+      class << self
+        # Create a new object based on a hash.
+        # This is used to create a new object based on the server response.
+        def factory(attrs)
+          obj = self.new(attrs)
+
+          obj.unfold_rating_summary(attrs['ratings'])
+          obj.unfold_store_fronts(attrs['storeFronts'])
+
+          return obj
+        end
+      end
+
+      def unfold_rating_summary(attrs)
+        unfolded_rating_summary = AppRatingSummary.new(attrs)
+        instance_variable_set(:@rating_summary, unfolded_rating_summary)
+      end
+
+      def unfold_store_fronts(attrs)
+        unfolded_store_fronts = {}
+
+        attrs.each do |info|
+          unfolded_store_fronts[info['countryCode']] = AppRatingSummary.new(info['ratings'])
+        end
+
+        instance_variable_set(:@store_fronts, unfolded_store_fronts)
+      end
+
+      # @return (Array) of raw hashes representing user reviews for the given store front (and optional versionId)
+      def reviews(store_front, versionId = '')
+        client.get_reviews(application.apple_id, application.platform, store_front, versionId)
+      end
+    end
+
+    class AppRatingSummary < TunesBase
+      # @return (Integer) total number of reviews recevied
+      attr_reader :review_count
+
+      # @return (Integer) total number of ratings recevied
+      attr_reader :rating_count
+
+      # @return (Integer) total number of one star ratings recevied
+      attr_reader :one_star_rating_count
+
+      # @return (Integer) total number of two star ratings recevied
+      attr_reader :two_star_rating_count
+
+      # @return (Integer) total number of three star ratings recevied
+      attr_reader :three_star_rating_count
+
+      # @return (Integer) total number of four star ratings recevied
+      attr_reader :four_star_rating_count
+
+      # @return (Integer) total number of five star ratings recevied
+      attr_reader :five_star_rating_count
+
+      attr_mapping({
+        'reviewCount' => :review_count,
+        'ratingCount' => :rating_count,
+        'ratingOneCount' => :one_star_rating_count,
+        'ratingTwoCount' => :two_star_rating_count,
+        'ratingThreeCount' => :three_star_rating_count,
+        'ratingFourCount' => :four_star_rating_count,
+        'ratingFiveCount' => :five_star_rating_count
+      })
+
+      class << self
+        # Create a new object based on a hash.
+        # This is used to create a new object based on the server response.
+        def factory(attrs)
+          obj = self.new(attrs)
+          return obj
+        end
+      end
+
+      # @return (Float) the average rating for this summary (rounded to 2 decimal places)
+      def average_rating
+        ((self.one_star_rating_count +
+          (self.two_star_rating_count * 2) +
+          (self.three_star_rating_count * 3) +
+          (self.four_star_rating_count * 4) +
+          (self.five_star_rating_count * 5)) / self.rating_count.to_f).round(2)
+      end
+    end
+  end
+end

data/lib/spaceship/tunes/application.rb

@@ -120,6 +120,12 @@ module Spaceship
         client.get_resolution_center(apple_id, platform)
       end
 
+      def ratings
+        attrs = client.get_rating_summary(apple_id, platform)
+        attrs[:application] = self
+        Tunes::AppRatings.factory(attrs)
+      end
+
       # kept for backward compatibility
       # tries to guess the platform of the currently submitted apps
       # note that as ITC now supports multiple app types, this might break

data/lib/spaceship/tunes/tunes.rb

@@ -7,6 +7,7 @@ require 'spaceship/tunes/tunes_client'
 require 'spaceship/tunes/language_item'
 require 'spaceship/tunes/app_status'
 require 'spaceship/tunes/app_image'
+require 'spaceship/tunes/app_ratings'
 require 'spaceship/tunes/app_version_ref'
 require 'spaceship/tunes/app_version_history'
 require 'spaceship/tunes/app_version_states_history'

data/lib/spaceship/tunes/tunes_client.rb

@@ -271,6 +271,16 @@ module Spaceship
       parse_response(r, 'data')
     end
 
+    def get_rating_summary(app_id, platform, versionId = '')
+      r = request(:get, "ra/apps/#{app_id}/reviews/summary?platform=#{platform}&versionId=#{versionId}")
+      parse_response(r, 'data')
+    end
+
+    def get_reviews(app_id, platform, storefront, versionId = '')
+      r = request(:get, "ra/apps/#{app_id}/reviews?platform=#{platform}&storefront=#{storefront}&versionId=#{versionId}")
+      parse_response(r, 'data')['reviews']
+    end
+
     #####################################################
     # @!group AppVersions
     #####################################################

data/lib/spaceship/version.rb

@@ -1,4 +1,4 @@
 module Spaceship
-  VERSION = "0.31.10".freeze
+  VERSION = "0.32.0".freeze
   DESCRIPTION = "Ruby library to access the Apple Dev Center and iTunes Connect".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spaceship
 version: !ruby/object:Gem::Version
-  version: 0.31.10
+  version: 0.32.0
 platform: ruby
 authors:
 - Felix Krause
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-25 00:00:00.000000000 Z
+date: 2016-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: credentials_manager
@@ -341,6 +341,7 @@ files:
 - lib/spaceship/portal/ui/select_team.rb
 - lib/spaceship/tunes/app_details.rb
 - lib/spaceship/tunes/app_image.rb
+- lib/spaceship/tunes/app_ratings.rb
 - lib/spaceship/tunes/app_screenshot.rb
 - lib/spaceship/tunes/app_status.rb
 - lib/spaceship/tunes/app_submission.rb
@@ -391,7 +392,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Ruby library to access the Apple Dev Center and iTunes Connect