spaceship 0.0.15 → 0.1.0

data/lib/spaceship/tunes/application.rb

@@ -0,0 +1,253 @@
+module Spaceship
+  module Tunes
+    class Application < TunesBase
+      
+      # @return (String) The App identifier of this app, provided by iTunes Connect
+      # @example 
+      #   "1013943394"
+      attr_accessor :apple_id
+
+      # @return (String) The name you provided for this app (in the default language)
+      # @example
+      #   "Spaceship App"
+      attr_accessor :name
+
+      # @return (String) the supported platform of this app
+      # @example 
+      #   "ios"
+      attr_accessor :platform
+
+      # @return (String) The Vendor ID provided by iTunes Connect
+      # @example 
+      #   "1435592086"
+      attr_accessor :vendor_id
+
+      # @return (String) The bundle_id (app identifier) of your app
+      # @example 
+      #   "com.krausefx.app"
+      attr_accessor :bundle_id
+
+      # @return (String) Last modified
+      attr_accessor :last_modified
+
+      # @return (Integer) The number of issues provided by iTunes Connect
+      attr_accessor :issues_count
+
+      # @return (String) The URL to a low resolution app icon of this app (340x340px). Might be nil
+      # @example 
+      #   "https://is1-ssl.mzstatic.com/image/thumb/Purple7/v4/cd/a3/e2/cda3e2ac-4034-c6af-ee0c-3e4d9a0bafaa/pr_source.png/340x340bb-80.png"
+      # @example
+      #   nil
+      attr_accessor :app_icon_preview_url
+
+      # @return [Array] A list of binaries which are not even yet processing based on the version
+      #   Those builds are usually the ones that are just stuck on iTunes Connect...
+      attr_accessor :pre_processing_builds
+
+      attr_mapping(
+        'adamId' => :apple_id,
+        'name' => :name,
+        'appType' => :platform,
+        'vendorId' => :vendor_id,
+        'bundleId' => :bundle_id,
+        'lastModifiedDate' => :last_modified,
+        'issuesCount' => :issues_count,
+        'iconUrl' => :app_icon_preview_url
+      )
+
+      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)
+          self.new(attrs)
+        end
+
+        # @return (Array) Returns all apps available for this account
+        def all
+          client.applications.map { |application| self.factory(application) }
+        end
+
+        # @return (Spaceship::Tunes::Application) Returns the application matching the parameter
+        #   as either the App ID or the bundle identifier
+        def find(identifier)
+          all.find do |app|
+            (app.apple_id == identifier.to_s or app.bundle_id == identifier)
+          end
+        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!(name: nil, primary_language: nil, version: nil, sku: nil, bundle_id: nil, bundle_id_suffix: nil)
+          client.create_application!(name: name, 
+                         primary_language: primary_language, 
+                                  version: version, 
+                                      sku: sku, 
+                                bundle_id: bundle_id,
+                                bundle_id_suffix: bundle_id_suffix)
+        end
+      end
+
+      #####################################################
+      # @!group Getting information
+      #####################################################
+
+      # @return (Spaceship::AppVersion) Receive the version that is currently live on the
+      #  App Store. You can't modify all values there, so be careful. 
+      def live_version
+        v = Spaceship::AppVersion.find(self, self.apple_id, true)
+      end
+
+      # @return (Spaceship::AppVersion) Receive the version that can fully be edited
+      def edit_version
+        # Apple's server will respond with the same version if there is only one, for both v=live and v=
+        # That's why we have to check in the app_summary.json request if there are 2 versions or just one
+        # if there is only one version, we'll return nil
+        if raw_data['versions'].count == 1
+          return nil # only live version, user should create a new version
+        end
+
+        Spaceship::AppVersion.find(self, self.apple_id, false)
+      end
+
+      # @return (Spaceship::AppVersion) This will return the `edit_version` if available
+      #   and fallback to the `edit_version`. Use this to just access the latest data
+      def latest_version
+        edit_version || live_version
+      end
+
+      # @return (String) An URL to this specific resource. You can enter this URL into your browser
+      def url
+        "https://itunesconnect.apple.com/WebObjects/iTunesConnect.woa/ra/ng/app/#{self.apple_id}"
+      end
+
+      # @return (Hash) Contains the reason for rejection. 
+      #  if everything is alright, the result will be
+      #  `{"sectionErrorKeys"=>[], "sectionInfoKeys"=>[], "sectionWarningKeys"=>[], "replyConstraints"=>{"minLength"=>1, "maxLength"=>4000}, "appNotes"=>{"threads"=>[]}, "betaNotes"=>{"threads"=>[]}, "appMessages"=>{"threads"=>[]}}`
+      def resolution_center
+        client.get_resolution_center(apple_id)
+      end
+
+      #####################################################
+      # @!group Modifying
+      #####################################################
+     
+      # Create a new version of your app
+      def create_version!(version_number)
+        if edit_version
+          raise "Cannot create a new version for this app as there already is an `edit_version` available"
+        end
+
+        client.create_version!(apple_id, version_number)
+
+        # Since we have stored the outdated raw_data, we need to refresh this object
+        # otherwise `edit_version` will return nil
+        # TODO: implemented -reload method
+      end
+
+      #####################################################
+      # @!group Builds
+      #####################################################
+
+      # A reference to all the build trains
+      # @return [Hash] a hash, the version number being the key
+      def build_trains
+        Tunes::BuildTrain.all(self, self.apple_id)
+      end
+
+      def pre_processing_builds
+        data = client.build_trains(apple_id) # we need to fetch all trains here to get the builds
+        
+        data.fetch('processingBuilds', []).collect do |attrs|
+          attrs.merge!(build_train: self)
+          Tunes::ProcessingBuild.factory(attrs)
+        end
+      end
+
+      #####################################################
+      # @!group Submit for Review
+      #####################################################
+      
+      def create_submission
+        version = self.latest_version
+        if version.nil?
+          raise "Could not find a valid version to submit for review"
+        end
+        
+        Spaceship::AppSubmission.create(self, self.apple_id, version)
+      end
+
+      #####################################################
+      # @!group General
+      #####################################################
+      def setup
+        
+      end
+
+      #####################################################
+      # @!group Testers
+      #####################################################
+
+      # Add all testers (internal and external) to the current app list
+      def add_all_testers!
+        Tunes::Tester.external.add_all_to_app!(self.apple_id)
+        Tunes::Tester.internal.add_all_to_app!(self.apple_id)
+      end
+
+      # @return (Array) Returns all external testers available for this app
+      def external_testers
+        Tunes::Tester.external.all_by_app(self.apple_id)
+      end
+
+      # @return (Array) Returns all internal testers available for this app
+      def internal_testers
+        Tunes::Tester.internal.all_by_app(self.apple_id)
+      end
+
+      # @return (Spaceship::Tunes::Tester.external) Returns the external tester matching the parameter
+      #   as either the Tester id or email
+      # @param identifier (String) (required): Value used to filter the tester
+      def find_external_tester(identifier)
+        Tunes::Tester.external.find_by_app(self.apple_id, identifier)
+      end
+
+      # @return (Spaceship::Tunes::Tester.internal) Returns the internal tester matching the parameter
+      #   as either the Tester id or email
+      # @param identifier (String) (required): Value used to filter the tester
+      def find_internal_tester(identifier)
+        Tunes::Tester.internal.find_by_app(self.apple_id, identifier)
+      end
+
+      # Add external tester to the current app list, if it doesn't exist will be created
+      # @param email (String) (required): The email of the tester
+      # @param first_name (String) (optional): The first name of the tester (Ignored if user already exist)
+      # @param last_name (String) (optional): The last name of the tester (Ignored if user already exist)
+      def add_external_tester!(email: nil, first_name: nil, last_name: nil)
+        raise "Tester is already on #{self.name} betatesters" if find_external_tester(email)
+
+        tester = Tunes::Tester.external.find(email) || Tunes::Tester.external.create!(email: email, 
+                                                                                 first_name: first_name, 
+                                                                                  last_name: last_name)
+        tester.add_to_app!(self.apple_id)
+      end
+
+      # Remove external tester from the current app list that matching the parameter
+      #   as either the Tester id or email
+      # @param identifier (String) (required): Value used to filter the tester
+      def remove_external_tester!(identifier)
+        tester = find_external_tester(identifier)
+
+        raise "Tester is not on #{self.name} betatesters" unless tester
+
+        tester.remove_from_app!(self.apple_id)
+      end
+    end
+  end
+end

data/lib/spaceship/tunes/build.rb

@@ -0,0 +1,128 @@
+module Spaceship
+  module Tunes
+    # Represents a build which is inside the build train
+    class Build < TunesBase
+
+      #####################################################
+      # @!group General metadata
+      #####################################################
+      
+      # @return (Spaceship::Tunes::Application) A reference to the build train this build is contained in
+      attr_accessor :build_train
+
+      # @return (Integer) The ID generated by iTunes Connect
+      attr_accessor :id
+
+      # @return (Boolean)
+      attr_accessor :valid
+
+      # @return (String) The build version (not the version number)
+      attr_accessor :build_version
+
+      # @return (String) The version number (e.g. 1.3)
+      attr_accessor :train_version
+
+      # @return (Integer) The number of ticks since 1970 (e.g. 1413966436000)
+      attr_accessor :upload_date
+
+      # @return (String) URL to the app icon of this build (150x150px)
+      attr_accessor :icon_url
+
+      # @return (String)
+      attr_accessor :app_name
+
+      # @return (String) The platform of this build (e.g. 'ios')
+      attr_accessor :platform
+
+      # @return (Integer) When is this build going to be invalid
+      attr_accessor :internal_expiry_date
+
+      # @return (Bool) Does this build support WatchKit?
+      attr_accessor :watch_kit_enabled
+
+      # @return (Bool): 
+      attr_accessor :ready_to_install
+
+      #####################################################
+      # @!group Analytics
+      #####################################################
+
+      # @return (Integer) Number of installs of this build
+      attr_accessor :install_count
+
+      # @return (Integer) Number of installs for this build that come from internal users
+      attr_accessor :internal_install_count
+
+      # @return (Integer) Number of installs for this build that come from external users
+      attr_accessor :external_install_count
+
+      # @return (Integer) Might be nil. The number of sessions for this build
+      attr_accessor :session_count
+
+      # @return (Integer) Might be nil. The number of crashes of this build
+      attr_accessor :crash_count
+
+      attr_mapping(
+        'uploadDate' => :upload_date,
+        'iconUrl' => :icon_url,
+        'buildVersion' => :build_version,
+        'trainVersion' => :train_version,
+        'appName' => :app_name,
+        'platform' => :platform,
+        'id' => :id,
+        'valid' => :valid,
+
+        'installCount' => :install_count,
+        'internalInstallCount' => :internal_install_count,
+        'externalInstallCount' => :external_install_count,
+        'sessionCount' => :session_count,
+        'crashCount' => :crash_count,
+        'internalExpiry' => :internal_expiry_date,
+        'watchKitEnabled' => :watch_kit_enabled,
+        'readyToInstall' => :ready_to_install,
+      )
+
+      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)
+          self.new(attrs)
+        end
+      end
+    end
+  end
+end
+
+# Example response
+  # "buildVersion": "0.9.10",
+  # "trainVersion": "0.9.10",
+  # "uploadDate": 1413966436000,
+  # "iconUrl": "https://is5-ssl.mzstatic.com/image/thumb/Newsstand5/v4/e8/ab/f8/e8abf8ca-6c22-a519-aa1b-c73901c4917e/Icon-60@2x.png.png/150x150bb-80.png",
+  # "appName": "Yeahaa",
+  # "platform": "ios",
+  # "betaEntitled": false,
+  # "id": 523299,
+  # "valid": true,
+  # "missingExportCompliance": false,
+  # "waitingForExportComplianceApproval": false,
+  # "addedInternalUsersCount": 0,
+  # "addedExternalUsersCount": 0,
+  # "invitedExternalUsersCount": 0,
+  # "invitedInternalUsersCount": 0,
+  # "acceptedInternalUsersCount": 0,
+  # "acceptedExternalUsersCount": 0,
+  # "installCount": 0,
+  # "internalInstallCount": 0,
+  # "externalInstallCount": 0,
+  # "sessionCount": null,
+  # "crashCount": null,
+  # "promotedVersion": null,
+  # "internalState": "noBetaEntitlement",
+  # "betaState": "noBetaEntitlement",
+  # "internalExpiry": 1416562036000,
+  # "externalExpiry": 0,
+  # "watchKitEnabled": false,
+  # "readyToInstall": false,
+  # "sdkBuildWhitelisted": true,
+  # "internalTesting": null,
+  # "externalTesting": null

data/lib/spaceship/tunes/build_train.rb

@@ -0,0 +1,79 @@
+module Spaceship
+  module Tunes
+    # Represents a build train of builds from iTunes Connect
+    # A build train is all builds for a given version number with different build numbers
+    class BuildTrain < TunesBase
+
+      # @return (Spaceship::Tunes::Application) A reference to the application
+      #   this train is for
+      attr_accessor :application
+
+      # @return (Array) An array of all builds that are inside this train (Spaceship::Tunes::Build)
+      attr_reader :builds
+
+      # @return (String) The version number of this train
+      attr_reader :version_string
+
+      # @return (String) Platform (e.g. "ios")
+      attr_reader :platform
+
+      # @return (Bool) Is beta testing enabled for this train? Only one train can have enabled testing.
+      attr_reader :testing_enabled
+
+      # @return (Array) An array of all builds that are inside this train (Spaceship::Tunes::Build)
+      #  I never got this to work to properly try and debug this
+      attr_reader :processing_builds
+
+      attr_mapping(
+        'versionString' => :version_string,
+        'platform' => :platform,
+        'testing.value' => :testing_enabled
+      )
+
+      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)
+          self.new(attrs)
+        end
+
+        # @param application (Spaceship::Tunes::Application) The app this train is for
+        # @param app_id (String) The unique Apple ID of this app
+        def all(application, app_id)
+          data = client.build_trains(app_id)
+          result = {}
+          data['trains'].each do |attrs|
+            attrs.merge!(application: application)
+            current = self.factory(attrs)
+            result[current.version_string] = current
+          end
+          result
+        end
+      end
+
+      # Setup all the builds and processing builds
+      def setup
+        @builds = self.raw_data['builds'].collect do |attrs|
+          attrs.merge!(build_train: self)
+          Tunes::Build.factory(attrs)
+        end
+
+        @processing_builds = self.raw_data['buildsInProcessing'].collect do |attrs|
+          attrs.merge!(build_train: self)
+          Tunes::Build.factory(attrs)
+        end
+      end
+
+      def update_testing_status!(new_value)
+        data = client.build_trains(self.application.apple_id)
+        data['trains'].each do |train|
+          train['testing']['value'] = false
+          train['testing']['value'] = new_value if train['versionString'] == version_string
+        end
+        result = client.update_build_trains!(application.apple_id, data)
+        self.testing_enabled = new_value
+        result
+      end
+    end
+  end
+end