spaceship 0.0.15 → 0.1.0

data/lib/spaceship/tunes/language_converter.rb

@@ -0,0 +1,44 @@
+module Spaceship
+  module Tunes
+    class LanguageConverter
+      class << self
+        # Converts the iTC format (English_CA, Brazilian Portuguese) to language short codes: (en-US, de-DE)
+        def from_itc_to_standard(from)
+          result = mapping.find { |a| a['name'] == from }
+          (result || {}).fetch('locale', nil)
+        end
+
+        # Converts the language short codes: (en-US, de-DE) to the iTC format (English_CA, Brazilian Portuguese)
+        def from_standard_to_itc(from)
+          result = mapping.find { |a| a['locale'] == from || (a['alternatives'] || []).include?(from) }
+          (result || {}).fetch('name', nil)
+        end
+
+        private
+          # Path to the gem to fetch resoures
+          def spaceship_gem_path
+            if Gem::Specification::find_all_by_name('spaceship').any?
+              return Gem::Specification.find_by_name('spaceship').gem_dir
+            else
+              return './'
+            end
+          end
+
+          # Get the mapping JSON parsed
+          def mapping
+            @languages ||= JSON.parse(File.read(File.join(spaceship_gem_path, "lib", "assets", "languageMapping.json")))
+          end
+      end
+    end
+  end
+end
+
+class String
+  def to_language_code
+    Spaceship::Tunes::LanguageConverter.from_itc_to_standard(self)
+  end
+
+  def to_full_language
+    Spaceship::Tunes::LanguageConverter.from_standard_to_itc(self)
+  end
+end

data/lib/spaceship/tunes/language_item.rb

@@ -0,0 +1,54 @@
+module Spaceship
+  module Tunes
+    # Represents one attribute (e.g. name) of an app in multiple languages
+    class LanguageItem
+      attr_accessor :identifier # title or description
+      attr_accessor :original_array # reference to original array
+
+      def initialize(identifier, ref)
+        self.identifier = identifier.to_s
+        self.original_array = ref
+      end
+
+      def [](key)
+        get_lang(key)[identifier]['value']
+      end
+
+      def []=(key, value)
+        get_lang(key)[identifier]['value'] = value
+      end
+
+      def get_lang(lang)
+        result = self.original_array.find do |current|
+          current['language'] == lang
+        end
+        return result if result
+
+        raise "Language '#{lang}' is not activated for this app version."
+      end
+
+      # @return (Array) An array containing all languages that are already available
+      def keys
+        self.original_array.collect { |l| l.fetch('language') }
+      end
+
+      # @return (Array) An array containing all languages that are already available
+      #   alias for keys
+      def languages
+        keys
+      end
+
+      def inspect
+        result = ""
+        self.original_array.collect do |current|
+          result += "#{current.fetch('language')}: #{current.fetch(identifier, {}).fetch('value')}\n"
+        end
+        result
+      end
+
+      def to_s
+        inspect
+      end
+    end
+  end
+end

data/lib/spaceship/tunes/processing_build.rb

@@ -0,0 +1,30 @@
+module Spaceship
+  module Tunes
+    # Represents a build which doesn't have a version number yet and is either processing or is stuck
+    class ProcessingBuild < Build
+
+      # @return [String] The state of this build
+      # @example
+      #   ITC.apps.betaProcessingStatus.InvalidBinary
+      # @example
+      #   ITC.apps.betaProcessingStatus.Created
+      # @example
+      #   ITC.apps.betaProcessingStatus.Uploaded
+      attr_accessor :state
+
+      # @return (Integer) The number of ticks since 1970 (e.g. 1413966436000)
+      attr_accessor :upload_date
+
+      attr_mapping(
+        'state' => :state,
+        'uploadDate' => :upload_date
+      )
+
+      class << self
+        def factory(attrs)
+          self.new(attrs)
+        end
+      end
+    end
+  end
+end

data/lib/spaceship/tunes/spaceship.rb

@@ -0,0 +1,26 @@
+module Spaceship
+  module Tunes
+    class << self
+      # This client stores the default client when using the lazy syntax
+      # Spaceship.app instead of using the spaceship launcher
+      attr_accessor :client
+
+      # Authenticates with Apple's web services. This method has to be called once
+      # to generate a valid session. The session will automatically be used from then
+      # on.
+      # 
+      # This method will automatically use the username from the Appfile (if available)
+      # and fetch the password from the Keychain (if available)
+      # 
+      # @param user (String) (optional): The username (usually the email address)
+      # @param password (String) (optional): The password
+      # 
+      # @raise InvalidUserCredentialsError: raised if authentication failed
+      # 
+      # @return (Spaceship::Client) The client the login method was called for
+      def login(user = nil, password = nil)
+        @client = TunesClient.login(user, password)
+      end
+    end
+  end
+end

data/lib/spaceship/tunes/tester.rb

@@ -0,0 +1,177 @@
+module Spaceship
+  module Tunes
+    class Tester < TunesBase
+
+      # @return (String) The identifier of this tester, provided by iTunes Connect
+      # @example 
+      #   "60f858b4-60a8-428a-963a-f943a3d68d17"
+      attr_accessor :tester_id
+
+      # @return (String) The email of this tester
+      # @example 
+      #   "tester@spaceship.com"
+      attr_accessor :email
+      
+      # @return (String) The first name of this tester
+      # @example 
+      #   "Cary"
+      attr_accessor :first_name
+
+      # @return (String) The last name of this tester
+      # @example 
+      #   "Bennett"
+      attr_accessor :last_name
+
+      # @return (Array) An array of registered devices for this user
+      # @example
+      #    [{
+      #      "model": "iPhone 6",
+      #      "os": "iOS",
+      #      "osVersion": "8.3",
+      #      "name": null
+      #    }]
+      attr_accessor :devices
+
+      attr_mapping(
+        'testerId' => :tester_id,
+        'emailAddress.value' => :email,
+        'firstName.value' => :first_name,
+        'lastName.value' => :last_name,
+        'devices' => :devices
+      )
+
+      class << self
+
+        # @return (Hash) All urls for the ITC used for web requests
+        def url
+          raise "You have to use a subclass: Internal or External"
+        end
+
+        # Create a new object based on a hash.
+        # This is used to create a new object based on the server response.
+        def factory(attrs)
+          self.new(attrs)
+        end
+
+        # @return (Array) Returns all beta testers available for this account
+        def all
+          client.testers(self).map { |tester| self.factory(tester) }
+        end
+
+        # @return (Spaceship::Tunes::Tester) Returns the tester matching the parameter
+        #   as either the Tester id or email
+        # @param identifier (String) (required): Value used to filter the tester
+        def find(identifier)
+          all.find do |tester|
+            (tester.tester_id == identifier.to_s or tester.email == identifier)
+          end
+        end
+
+        # Create new tester in iTunes Connect
+        # @param email (String) (required): The email of the new tester
+        # @param first_name (String) (optional): The first name of the new tester
+        # @param last_name (String) (optional): The last name of the new tester
+        # @example 
+        #   Spaceship::Tunes::Tester.external.create!(email: "tester@mathiascarignani.com", first_name: "Cary", last_name:"Bennett")
+        # @return (Tester): The newly created tester
+        def create!(email: nil, first_name: nil, last_name: nil) 
+          data = client.create_tester!(tester: self,
+                                        email: email,
+                                   first_name: first_name,
+                                    last_name: last_name)
+          self.factory(data)
+        end
+
+        #####################################################
+        # @!group App
+        #####################################################
+
+        # @return (Array) Returns all beta testers available for this account filtered by app
+        # @param app_id (String) (required): The app id to filter the testers
+        def all_by_app(app_id) 
+          client.testers_by_app(self, app_id).map { |tester| self.factory(tester) }
+        end
+
+        # @return (Spaceship::Tunes::Tester) Returns the tester matching the parameter
+        #   as either the Tester id or email
+        # @param app_id (String) (required): The app id to filter the testers
+        # @param identifier (String) (required): Value used to filter the tester
+        def find_by_app(app_id, identifier)
+          all_by_app(app_id).find do |tester|
+            (tester.tester_id == identifier.to_s or tester.email == identifier)
+          end
+        end
+
+        # Add all testers to the app received
+        # @param app_id (String) (required): The app id to filter the testers
+        def add_all_to_app!(app_id)
+          # TODO: Change to not make one request for each tester
+          all.each do |tester|
+            begin
+              tester.add_to_app!(app_id)
+            rescue => ex
+              if ex.to_s.include?"testerEmailExistsInternal" or ex.to_s.include?"duplicate.email"
+                # That's a non-relevant error message by iTC
+                # ignore that
+              else
+                raise ex
+              end
+            end
+          end
+        end
+      end
+
+      def setup
+        self.devices ||= [] # by default, an empty array instead of nil
+      end
+
+      #####################################################
+      # @!group Subclasses
+      #####################################################
+      class External < Tester 
+        def self.url(app_id = nil)
+          {
+            index: "ra/users/pre/ext",
+            index_by_app: "ra/user/externalTesters/#{app_id}/",
+            create: "ra/users/pre/create",
+            delete: "ra/users/pre/ext/delete",
+            update_by_app: "ra/user/externalTesters/#{app_id}/"
+          }
+        end
+      end
+
+      class Internal < Tester 
+        def self.url(app_id = nil)
+          {
+            index: "ra/users/pre/int",
+            index_by_app: "ra/user/internalTesters/#{app_id}/",
+            create: nil,
+            delete: nil,
+            update_by_app: "ra/user/internalTesters/#{app_id}/"
+          }
+        end
+      end
+
+      # Delete current tester
+      def delete! 
+        client.delete_tester!(self)
+      end
+
+      #####################################################
+      # @!group App
+      #####################################################
+
+      # Add current tester to list of the app testers
+      # @param app_id (String) (required): The id of the application to which want to modify the list
+      def add_to_app!(app_id)
+        client.add_tester_to_app!(self, app_id)
+      end
+
+      # Remove current tester from list of the app testers
+      # @param app_id (String) (required): The id of the application to which want to modify the list
+      def remove_from_app!(app_id)
+        client.remove_tester_from_app!(self, app_id)
+      end
+    end
+  end
+end

data/lib/spaceship/tunes/tunes.rb

@@ -0,0 +1,12 @@
+require 'spaceship/tunes/tunes_base'
+require 'spaceship/tunes/application'
+require 'spaceship/tunes/app_version'
+require 'spaceship/tunes/app_submission'
+require 'spaceship/tunes/tunes_client'
+require 'spaceship/tunes/language_item'
+require 'spaceship/tunes/app_status'
+require 'spaceship/tunes/app_screenshot'
+require 'spaceship/tunes/language_converter'
+require 'spaceship/tunes/build'
+require 'spaceship/tunes/processing_build'
+require 'spaceship/tunes/build_train'

data/lib/spaceship/tunes/tunes_base.rb

@@ -0,0 +1,15 @@
+module Spaceship
+  module Tunes
+    class TunesBase < Spaceship::Base
+      class << self
+        def client
+          (
+            @client or
+            Spaceship::Tunes.client or
+            raise "Please login using `Spaceship::Tunes.login('user', 'password')`"
+          )
+        end
+      end
+    end
+  end
+end

data/lib/spaceship/tunes/tunes_client.rb

@@ -0,0 +1,360 @@
+module Spaceship
+  class TunesClient < Spaceship::Client
+
+    #####################################################
+    # @!group Init and Login
+    #####################################################
+
+    def self.hostname
+      "https://itunesconnect.apple.com/WebObjects/iTunesConnect.woa/"
+    end
+
+    # Fetches the latest login URL from iTunes Connect
+    def login_url
+      cache_path = "/tmp/spaceship_itc_login_url.txt"
+      begin
+        cached = File.read(cache_path) 
+      rescue Errno::ENOENT
+      end
+      return cached if cached
+
+      host = "https://itunesconnect.apple.com"
+      begin
+        url = host + request(:get, self.class.hostname).body.match(/action="(\/WebObjects\/iTunesConnect.woa\/wo\/.*)"/)[1]
+        raise "" unless url.length > 0
+
+        File.write(cache_path, url) # TODO
+        return url
+      rescue => ex
+        puts ex
+        raise "Could not fetch the login URL from iTunes Connect, the server might be down"
+      end
+    end
+
+    def send_login_request(user, password)
+      response = request(:post, login_url, {
+        theAccountName: user,
+        theAccountPW: password
+      })
+
+      if response['Set-Cookie'] =~ /myacinfo=(\w+);/
+        # To use the session properly we'll need the following cookies:
+        #  - myacinfo
+        #  - woinst
+        #  - wosid
+
+        begin
+          cooks = response['Set-Cookie']
+
+          to_use = [
+            "myacinfo=" + cooks.match(/myacinfo=(\w+)/)[1],
+            "woinst=" + cooks.match(/woinst=(\w+)/)[1],
+            "wosid=" + cooks.match(/wosid=(\w+)/)[1]
+          ]
+
+          @cookie = to_use.join(';')
+        rescue => ex
+          # User Credentials are wrong
+          raise InvalidUserCredentialsError.new(response)
+        end
+        
+        return @client
+      else
+        # User Credentials are wrong
+        raise InvalidUserCredentialsError.new(response)
+      end
+    end
+
+    def handle_itc_response(data)
+      return unless data
+      return unless data.kind_of?Hash
+ 
+      if data.fetch('sectionErrorKeys', []).count == 0 and
+        data.fetch('sectionInfoKeys', []).count == 0 and 
+        data.fetch('sectionWarningKeys', []).count == 0
+        
+        logger.debug("Request was successful")
+      end
+
+      def handle_response_hash(hash)
+        errors = []
+        if hash.kind_of?Hash
+          hash.each do |key, value|
+            errors = errors + handle_response_hash(value)
+
+            if key == 'errorKeys' and value.kind_of?Array and value.count > 0
+              errors = errors + value
+            end
+          end
+        elsif hash.kind_of?Array
+          hash.each do |value|
+            errors = errors + handle_response_hash(value)
+          end
+        else
+          # We don't care about simple values
+        end
+        return errors
+      end
+
+      errors = handle_response_hash(data)
+      errors = errors + data.fetch('sectionErrorKeys') if data['sectionErrorKeys']
+
+      # Sometimes there is a different kind of error in the JSON response
+      different_error = data.fetch('messages', {}).fetch('error', nil)
+      errors << different_error if different_error
+
+      raise errors.join(' ') if errors.count > 0 # they are separated by `.` by default
+
+      puts data['sectionInfoKeys'] if data['sectionInfoKeys']
+      puts data['sectionWarningKeys'] if data['sectionWarningKeys']
+
+      return data
+    end
+
+
+    #####################################################
+    # @!group Applications
+    #####################################################
+
+    def applications
+      r = request(:get, 'ra/apps/manageyourapps/summary')
+      parse_response(r, 'data')['summaries']
+    end
+
+    # Creates a new application on iTunes Connect
+    # @param name (String): The name of your app as it will appear on the App Store. 
+    #   This can't be longer than 255 characters.
+    # @param primary_language (String): If localized app information isn't available in an 
+    #   App Store territory, the information from your primary language will be used instead.
+    # @param version (String): The version number is shown on the App Store and should 
+    #   match the one you used in Xcode.
+    # @param sku (String): A unique ID for your app that is not visible on the App Store.
+    # @param bundle_id (String): The bundle ID must match the one you used in Xcode. It 
+    #   can't be changed after you submit your first build.
+    def create_application!(name: nil, primary_language: nil, version: nil, sku: nil, bundle_id: nil, bundle_id_suffix: nil)
+      # First, we need to fetch the data from Apple, which we then modify with the user's values
+      r = request(:get, 'ra/apps/create/?appType=ios')
+      data = parse_response(r, 'data')
+
+      # Now fill in the values we have
+      data['versionString']['value'] = version
+      data['newApp']['name']['value'] = name
+      data['newApp']['bundleId']['value'] = bundle_id
+      data['newApp']['primaryLanguage']['value'] = primary_language || 'English_CA'
+      data['newApp']['vendorId']['value'] = sku
+      data['newApp']['bundleIdSuffix']['value'] = bundle_id_suffix
+
+      # Now send back the modified hash
+      r = request(:post) do |req|
+        req.url 'ra/apps/create/?appType=ios'
+        req.body = data.to_json
+        req.headers['Content-Type'] = 'application/json'
+      end
+        
+      data = parse_response(r, 'data')
+      handle_itc_response(data)
+    end
+
+    def create_version!(app_id, version_number)
+      r = request(:post) do |req|
+        req.url "ra/apps/version/create/#{app_id}"
+        req.body = { version: version_number.to_s }.to_json
+        req.headers['Content-Type'] = 'application/json'
+      end
+
+      parse_response(r, 'data')
+    end
+
+    def get_resolution_center(app_id)
+      r = request(:get, "ra/apps/#{app_id}/resolutionCenter?v=latest")
+      data = parse_response(r, 'data')
+    end
+
+    #####################################################
+    # @!group AppVersions
+    #####################################################
+
+    def app_version(app_id, is_live)
+      raise "app_id is required" unless app_id
+
+      v_text = (is_live ? 'live' : nil)
+
+      r = request(:get, "ra/apps/version/#{app_id}", {v: v_text})
+      parse_response(r, 'data')
+    end
+
+    def update_app_version!(app_id, is_live, data)
+      raise "app_id is required" unless app_id
+
+      v_text = (is_live ? 'live' : nil)
+
+      r = request(:post) do |req|
+        req.url "ra/apps/version/save/#{app_id}?v=#{v_text}"
+        req.body = data.to_json
+        req.headers['Content-Type'] = 'application/json'
+      end
+      
+      handle_itc_response(r.body['data'])
+    end
+
+    #####################################################
+    # @!group Build Trains
+    #####################################################
+
+    def build_trains(app_id)
+      raise "app_id is required" unless app_id
+
+      r = request(:get, "ra/apps/#{app_id}/trains/")
+      data = parse_response(r, 'data')
+    end
+
+    def update_build_trains!(app_id, data)
+      raise "app_id is required" unless app_id
+
+      r = request(:post) do |req|
+        req.url "ra/apps/#{app_id}/trains/"
+        req.body = data.to_json
+        req.headers['Content-Type'] = 'application/json'
+      end
+
+      handle_itc_response(r.body['data'])
+    end
+    
+    #####################################################
+    # @!group Submit for Review
+    #####################################################
+    
+    def send_app_submission(app_id, data, stage)
+      raise "app_id is required" unless app_id
+
+      r = request(:post) do |req|
+        req.url "ra/apps/#{app_id}/version/submit/#{stage}"
+        req.body = data.to_json
+        req.headers['Content-Type'] = 'application/json'
+      end
+      
+      handle_itc_response(r.body['data'])
+      parse_response(r, 'data')
+    end
+
+    #####################################################
+    # @!group Testers
+    #####################################################
+    def testers(tester)
+      url = tester.url[:index]
+      r = request(:get, url)
+      parse_response(r, 'data')['testers']
+    end
+
+    def testers_by_app(tester, app_id) 
+      url = tester.url(app_id)[:index_by_app]
+      r = request(:get, url)
+      parse_response(r, 'data')['users']
+    end
+
+    def create_tester!(tester: nil, email: nil, first_name: nil, last_name: nil) 
+      url = tester.url[:create]
+      raise "Action not provided for this tester type." unless url
+
+      data = {
+        testers: [
+          {
+            emailAddress: {
+              value: email
+            }, 
+            firstName: {
+              value: first_name
+            },
+            lastName: {
+              value: last_name
+            },
+            testing: {
+              value: true
+            }
+          }
+        ]
+      }
+
+      r = request(:post) do |req|
+        req.url url
+        req.body = data.to_json
+        req.headers['Content-Type'] = 'application/json'
+      end
+
+      data = parse_response(r, 'data')['testers']
+      handle_itc_response(data) || data[0]
+    end
+
+    def delete_tester!(tester)
+      url = tester.class.url[:delete]
+      raise "Action not provided for this tester type." unless url
+
+      data = [
+        {
+          emailAddress: {
+            value: tester.email
+          }, 
+          firstName: {
+            value: tester.first_name
+          },
+          lastName: {
+            value: tester.last_name
+          },
+          testing: {
+            value: false
+          }, 
+          testerId: tester.tester_id
+        }
+      ]
+
+      r = request(:post) do |req|
+        req.url url
+        req.body = data.to_json
+        req.headers['Content-Type'] = 'application/json'
+      end
+
+      data = parse_response(r, 'data')['testers']
+      handle_itc_response(data) || data[0]
+    end
+
+    def add_tester_to_app!(tester, app_id)
+      update_tester_from_app!(tester, app_id, true)
+    end
+
+    def remove_tester_from_app!(tester, app_id)
+      update_tester_from_app!(tester, app_id, false)
+    end
+
+    private 
+      def update_tester_from_app!(tester, app_id, testing)
+        url = tester.class.url(app_id)[:update_by_app]
+        data = {
+          users: [
+            {
+              emailAddress: {
+                value: tester.email
+              }, 
+              firstName: {
+                value: tester.first_name
+              },
+              lastName: {
+                value: tester.last_name
+              },
+              testing: {
+                value: testing
+              }
+            }
+          ]
+        }
+
+        r = request(:post) do |req|
+          req.url url
+          req.body = data.to_json
+          req.headers['Content-Type'] = 'application/json'
+        end
+          
+        data = parse_response(r, 'data')
+        handle_itc_response(data)
+      end
+  end
+end