spaceship 0.0.15 → 0.1.0

data/lib/spaceship/tunes/app_screenshot.rb

@@ -0,0 +1,28 @@
+module Spaceship
+  module Tunes
+    # Represents a screenshot hosted on iTunes Connect
+    class AppScreenshot
+
+      attr_accessor :thumbnail_url
+
+      attr_accessor :sort_order
+
+      attr_accessor :original_file_name
+
+      attr_accessor :url
+
+      attr_accessor :device_type
+
+      attr_accessor :language
+
+      def initialize(hash)
+        self.thumbnail_url = hash[:thumbnail_url]
+        self.sort_order = hash[:sort_order]
+        self.original_file_name = hash[:original_file_name]
+        self.url = hash[:url]
+        self.device_type = hash[:device_type]
+        self.language = hash[:language]
+      end
+    end
+  end
+end

data/lib/spaceship/tunes/app_status.rb

@@ -0,0 +1,63 @@
+module Spaceship
+  module Tunes
+    # Defines the different states of the app
+    # 
+    # As specified by Apple: https://developer.apple.com/library/ios/documentation/LanguagesUtilities/Conceptual/iTunesConnect_Guide/Chapters/ChangingAppStatus.html
+    module AppStatus
+      # You can edit this version, upload new binaries and more
+      PREPARE_FOR_SUBMISSION = "Prepare for Submission"
+
+      # App is currently live in the App Store
+      READY_FOR_SALE = "Ready for Sale"
+
+      # Waiting for Apple's Review
+      WAITING_FOR_REVIEW = "Waiting For Review"
+
+      # Currently in Review
+      IN_REVIEW = "In Review"
+
+      # App rejected for whatever reason
+      REJECTED = "Rejected"
+
+      # The developer took the app from the App Store
+      DEVELOPER_REMOVED_FROM_SALE = "Developer Removed From Sale"
+
+      # Developer rejected this version/binary
+      DEVELOPER_REJECTED = "Developer Rejected" 
+
+      # You have to renew your Apple account to keep using iTunes Connect
+      PENDING_CONTRACT = "Pending Contract"
+
+      UPLOAD_RECEIVED = "Upload Received"
+      PENDING_DEVELOPER_RELEASE = "Pending Developer Release"
+      PROCESSING_FOR_APP_STORE = "Processing for App Store"
+
+      # Unused app states
+      # PENDING_APPLE_RELASE = "Pending Apple Release"
+      
+      # WAITING_FOR_EXPORT_COMPLIANCE = "Waiting For Export Compliance"
+      # METADATA_REJECTED = "Metadata Rejected"
+      # REMOVED_FROM_SALE = "Removed From Sale"
+      # INVALID_BINARY = "Invalid Binary"
+
+
+      # Get the app status matching based on a string (given by iTunes Connect)
+      def self.get_from_string(text)
+        mapping = {
+          'readyForSale' => READY_FOR_SALE,
+          'prepareForUpload' => PREPARE_FOR_SUBMISSION,
+          'devRejected' => DEVELOPER_REJECTED,
+          'pendingContract' => PENDING_CONTRACT,
+          'developerRemovedFromSale' => DEVELOPER_REMOVED_FROM_SALE,
+          'waitingForReview' => WAITING_FOR_REVIEW
+        }
+
+        mapping.each do |k, v| 
+          return v if k == text
+        end
+
+        return nil
+      end
+    end
+  end
+end

data/lib/spaceship/tunes/app_submission.rb

@@ -0,0 +1,149 @@
+module Spaceship
+  module Tunes
+    # Represents a submission for review of an iTunes Connect Application
+    # This class handles the submission of all review information and documents
+    class AppSubmission < TunesBase
+      # @return (Spaceship::Tunes::Application) A reference to the application
+      #   this submission is for
+      attr_accessor :application
+
+      # @return (AppVersion) The version to use for this submission
+      attr_accessor :version
+      
+      # @return (String) The stage of this submission (start, complete)
+      attr_accessor :stage
+      
+      # @return (Boolean) Submitted for Review
+      attr_accessor :submitted_for_review
+
+      # @return (Boolean) Ad ID Info - Limits ads tracking
+      attr_accessor :add_id_info_limits_tracking
+      
+      # @return (Boolean) Ad ID Info - Serves ads
+      attr_accessor :add_id_info_serves_ads
+      
+      # @return (Boolean) Ad ID Info - Tracks actions
+      attr_accessor :add_id_info_tracks_action
+      
+      # @return (Boolean) Ad ID Info - Tracks installs
+      attr_accessor :add_id_info_tracks_install
+      
+      # @return (Boolean) Ad ID Info - Uses idfa
+      attr_accessor :add_id_info_uses_idfa
+      
+      # @return (Boolean) Content Rights - Contains third party content
+      attr_accessor :content_rights_contains_third_party_content
+      
+      # @return (Boolean) Content Rights - Has rights of content
+      attr_accessor :content_rights_has_rights
+            
+      # @return (Boolean) Export Compliance - Available on French Store
+      attr_accessor :export_compliance_available_on_french_store
+      
+      # @return (@TODO) Export Compliance - CCAT File
+      attr_accessor :export_compliance_ccat_file
+      
+      # @return (Boolean) Export Compliance - Contains proprietary cryptography
+      attr_accessor :export_compliance_contains_proprietary_cryptography
+      
+      # @return (Boolean) Export Compliance - Contains third-party cryptography
+      attr_accessor :export_compliance_contains_third_party_cryptography
+      
+      # @return (Boolean) Export Compliance - Is exempt
+      attr_accessor :export_compliance_is_exempt
+      
+      # @return (Boolean) Export Compliance - Uses encryption
+      attr_accessor :export_compliance_uses_encryption
+
+      # @return (String) Export Compliance - App type
+      attr_accessor :export_compliance_app_type
+      
+      # @return (Boolean) Export Compliance - Encryption Updated
+      attr_accessor :export_compliance_encryption_updated
+      
+      # @return (Boolean) Export Compliance - Compliance Required
+      attr_accessor :export_compliance_compliance_required
+      
+      # @return (String) Export Compliance - Platform
+      attr_accessor :export_compliance_platform
+
+      attr_mapping({
+
+        # Ad ID Info Section
+        'adIdInfo.limitsTracking.value' => :add_id_info_limits_tracking,
+        'adIdInfo.servesAds.value' => :add_id_info_serves_ads,
+        'adIdInfo.tracksAction.value' => :add_id_info_tracks_action,
+        'adIdInfo.tracksInstall.value' => :add_id_info_tracks_install,
+        'adIdInfo.usesIdfa.value' => :add_id_info_uses_idfa,
+        
+        # Content Rights Section
+        'contentRights.containsThirdPartyContent.value' => :content_rights_contains_third_party_content,
+        'contentRights.hasRights.value' => :content_rights_has_rights,
+        
+        # Export Compliance Section
+        'exportCompliance.availableOnFrenchStore.value' => :export_compliance_available_on_french_store,
+        'exportCompliance.ccatFile.value' => :export_compliance_ccat_file,
+        'exportCompliance.containsProprietaryCryptography.value' => :export_compliance_contains_proprietary_cryptography,
+        'exportCompliance.containsThirdPartyCryptography.value' => :export_compliance_contains_third_party_cryptography,
+        'exportCompliance.isExempt.value' => :export_compliance_is_exempt,
+        'exportCompliance.usesEncryption.value' => :export_compliance_uses_encryption,
+        'exportCompliance.appType' => :export_compliance_app_type,
+        'exportCompliance.encryptionUpdated' => :export_compliance_encryption_updated,
+        'exportCompliance.exportComplianceRequired' => :export_compliance_compliance_required,
+        'exportCompliance.platform' => :export_compliance_platform
+      })
+
+      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)
+          orig = attrs.dup
+          
+          # fill content rights section if iTC returns nil
+          if attrs["contentRights"].nil?
+            attrs.merge!("contentRights" => {
+              "containsThirdPartyContent" => {
+                "value" => nil
+              },
+              "hasRights" => {
+                "value" => nil
+              }
+            })
+          end
+          
+          obj = self.new(attrs)
+          return obj
+        end
+        
+        # @param application (Spaceship::Tunes::Application) The app this submission is for
+        # @param app_id (String) The unique Apple ID of this app
+        def create(application, app_id, version)
+          stage = "start"
+          attrs = client.send_app_submission(application.apple_id, version.raw_data, stage)
+          attrs.merge!(application: application)
+          attrs.merge!(version: version)
+          attrs.merge!(stage: stage)
+
+          return self.factory(attrs)
+        end
+      end
+      
+      # Save and complete the app submission
+      def complete!
+        @stage = "complete"
+        client.send_app_submission(application.apple_id, raw_data, @stage)
+        @submitted_for_review = true
+      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/apps/#{self.application.apple_id}/version/submit/#{self.stage}"
+      end
+
+      def setup
+        @submitted_for_review = false
+      end
+
+    end
+  end
+end

data/lib/spaceship/tunes/app_version.rb

@@ -0,0 +1,337 @@
+module Spaceship
+  module Tunes
+    # Represents an editable version of an iTunes Connect Application
+    # This can either be the live or the edit version retrieved via the app
+    class AppVersion < TunesBase
+      # @return (Spaceship::Tunes::Application) A reference to the application
+      #   this version is for
+      attr_accessor :application
+
+      # @return (String) The version number of this version
+      attr_accessor :version
+
+      # @return (String) The copyright information of this app
+      attr_accessor :copyright
+
+      # @return (Spaceship::Tunes::AppStatus) What's the current status of this app
+      #   e.g. Waiting for Review, Ready for Sale, ...
+      attr_reader :app_status
+
+      # @return (Bool) Is that the version that's currently available in the App Store?
+      attr_accessor :is_live
+
+      # Categories (e.g. MZGenre.Business)
+      attr_accessor :primary_category
+
+      attr_accessor :primary_first_sub_category
+
+      attr_accessor :primary_second_sub_category
+
+      attr_accessor :secondary_category
+
+      attr_accessor :secondary_first_sub_category
+
+      attr_accessor :secondary_second_sub_category
+
+      # @return (String) App Status (e.g. 'readyForSale'). You should use `app_status` instead
+      attr_accessor :raw_status
+
+      # @return (Bool)
+      attr_accessor :can_reject_version
+
+      # @return (Bool)
+      attr_accessor :can_prepare_for_upload
+
+      # @return (Bool)
+      attr_accessor :can_send_version_live
+
+      # @return (Bool) Should the app automatically be released once it's approved?
+      attr_accessor :release_on_approval
+
+      # @return (Bool)
+      attr_accessor :can_beta_test
+
+      # @return (Bool) Does the binary contain a watch binary?
+      attr_accessor :supports_apple_watch
+
+      # @return (String) URL to the full resolution 1024x1024 app icon
+      attr_accessor :app_icon_url
+
+      # @return (String) Name of the original file
+      attr_accessor :app_icon_original_name
+
+      # @return (String) URL to the full resolution 1024x1024 app icon
+      attr_accessor :watch_app_icon_url
+
+      # @return (String) Name of the original file
+      attr_accessor :watch_app_icon_original_name
+
+      # @return (Integer) a unqiue ID for this version generated by iTunes Connect
+      attr_accessor :version_id
+
+      # @return TODO
+      attr_accessor :company_information
+
+      ####
+      # App Review Information
+      ####
+      # @return (String) App Review Information First Name
+      attr_accessor :review_first_name
+
+      # @return (String) App Review Information Last Name
+      attr_accessor :review_last_name
+
+      # @return (String) App Review Information Phone Number
+      attr_accessor :review_phone_number
+
+      # @return (String) App Review Information Email Address
+      attr_accessor :review_email
+
+      # @return (String) App Review Information Demo Account User Name
+      attr_accessor :review_demo_user
+
+      # @return (String) App Review Information Demo Account Password
+      attr_accessor :review_demo_password
+
+      # @return (String) App Review Information Notes
+      attr_accessor :review_notes
+
+      ####
+      # Localized values:
+      ####
+
+      # @return (Array) Raw access the all available languages. You shouldn't use it probbaly
+      attr_accessor :languages
+
+      # @return (Hash) A hash representing the app name in all languages
+      attr_reader :name
+
+      # @return (Hash) A hash representing the keywords in all languages
+      attr_reader :keywords
+
+      # @return (Hash) A hash representing the description in all languages
+      attr_reader :description
+
+      # @return (Hash) The changelog
+      attr_reader :release_notes
+
+      # @return (Hash) A hash representing the keywords in all languages
+      attr_reader :privacy_url
+
+      # @return (Hash) A hash representing the keywords in all languages
+      attr_reader :support_url
+
+      # @return (Hash) A hash representing the keywords in all languages
+      attr_reader :marketing_url
+
+      # @return (Hash) Represents the screenshots of this app version (read-only)
+      attr_reader :screenshots
+
+
+      attr_mapping({
+        'canBetaTest' => :can_beta_test,
+        'canPrepareForUpload' => :can_prepare_for_upload,
+        'canRejectVersion' => :can_reject_version,
+        'canSendVersionLive' => :can_send_version_live,
+        'copyright.value' => :copyright,
+        'details.value' => :languages,
+        'largeAppIcon.value.originalFileName' => :app_icon_original_name,
+        'largeAppIcon.value.url' => :app_icon_url,
+        'primaryCategory.value' => :primary_category,
+        'primaryFirstSubCategory.value' => :primary_first_sub_category,
+        'primarySecondSubCategory.value' => :primary_second_sub_category,
+        'releaseOnApproval.value' => :release_on_approval,
+        'secondaryCategory.value' => :secondary_category,
+        'secondaryFirstSubCategory.value' => :secondary_first_sub_category,
+        'secondarySecondSubCategory.value' => :secondary_second_sub_category,
+        'status' => :raw_status,
+        'supportsAppleWatch' => :supports_apple_watch,
+        'versionId' => :version_id,
+        'version.value' => :version,
+        'watchAppIcon.value.originalFileName' => :watch_app_icon_original_name,
+        'watchAppIcon.value.url' => :watch_app_icon_url,
+
+        # App Review Information
+        'appReviewInfo.firstName.value' => :review_first_name,
+        'appReviewInfo.lastName.value' => :review_last_name,
+        'appReviewInfo.phoneNumber.value' => :review_phone_number,
+        'appReviewInfo.emailAddress.value' => :review_email,
+        'appReviewInfo.reviewNotes.value' => :review_notes,
+        'appReviewInfo.userName.value' => :review_demo_user,
+        'appReviewInfo.password.value' => :review_demo_password
+      })
+
+      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)
+          orig = attrs.dup
+          obj = self.new(attrs)
+          obj.unfold_languages
+
+          return obj
+        end
+
+        # @param application (Spaceship::Tunes::Application) The app this version is for
+        # @param app_id (String) The unique Apple ID of this app
+        # @param is_live (Boolean) Is that the version that's live in the App Store?
+        def find(application, app_id, is_live = false)
+          attrs = client.app_version(app_id, is_live)
+          attrs.merge!(application: application)
+          attrs.merge!(is_live: is_live)
+
+          return self.factory(attrs)
+        end
+      end
+
+      # @return (Bool) Is that version currently available in the App Store?
+      def is_live?
+        is_live
+      end
+
+      # Call this method to make sure the given languages are available for this app
+      # You should call this method before accessing the name, description and other localized values
+      # This will create the new language if it's not available yet and do nothing if everything's there
+      # def create_languages!(languages)
+      #   raise "Please pass an array" unless languages.kind_of?Array
+
+      #   copy_from = self.languages.first
+      #   languages.each do |language|
+      #     # First, see if it's already available
+      #     found = self.languages.find do |local|
+      #       local['language'] == language
+      #     end
+
+      #     unless found
+      #       new_language = copy_from.dup
+      #       new_language['language'] = language
+      #       [:description, :releaseNotes, :keywords].each do |key|
+      #         new_language[key.to_s]['value'] = nil
+      #       end
+
+      #       self.languages << new_language
+      #       unfold_languages
+
+      #       # Now we need to set a useless `pageLanguageValue` value because iTC says so, after adding a new version
+      #       self.languages.each do |current|
+      #         current['pageLanguageValue'] = current['language']
+      #       end
+      #     end
+      #   end
+
+      #   languages
+      # end
+
+      # Push all changes that were made back to iTunes Connect
+      def save!
+        client.update_app_version!(application.apple_id, is_live?, raw_data)
+      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.application.apple_id}/" + (self.is_live? ? "cur" : "")
+      end
+
+
+      # Private methods
+      def setup
+        # Properly parse the AppStatus
+        status = raw_data['status']
+        @app_status = Tunes::AppStatus.get_from_string(status)
+
+        # Setup the screenshots
+        @screenshots = {}
+        raw_data['details']['value'].each do |row|
+          # Now that's one language right here
+          @screenshots[row['language']] = setup_screenshots(row)
+        end
+      end
+
+
+      # Prefill name, keywords, etc...
+      def unfold_languages
+        {
+          name: :name,
+          keywords: :keywords,
+          description: :description,
+          privacyURL: :privacy_url,
+          supportURL: :support_url,
+          marketingURL: :marketing_url,
+          releaseNotes: :release_notes
+        }.each do |json, attribute|
+          instance_variable_set("@#{attribute}".to_sym, LanguageItem.new(json, languages))
+        end
+      end
+
+      # These methods takes care of properly parsing values that
+      # are not returned in the right format, e.g. boolean as string
+      def release_on_approval
+        super == 'true'
+      end
+
+      def supports_apple_watch
+        (super != nil)
+      end
+
+      def primary_category=(value)
+        value = "MZGenre.#{value}" unless value.include?"MZGenre"
+        super(value)
+      end
+
+      def primary_category=(value)
+        value = "MZGenre.#{value}" unless value.include?"MZGenre"
+        super(value)
+      end
+
+      def primary_first_sub_cate=(value)gory
+        value = "MZGenre.#{value}" unless value.include?"MZGenre"
+        super(value)
+      end
+
+      def primary_second_sub_cat=(value)egory
+        value = "MZGenre.#{value}" unless value.include?"MZGenre"
+        super(value)
+      end
+
+      def secondary_category=(value)
+        value = "MZGenre.#{value}" unless value.include?"MZGenre"
+        super(value)
+      end
+
+      def secondary_first_sub_ca=(value)tegory
+        value = "MZGenre.#{value}" unless value.include?"MZGenre"
+        super(value)
+      end
+
+      def secondary_second_sub_c=(value)ategory
+        value = "MZGenre.#{value}" unless value.include?"MZGenre"
+        super(value)
+      end
+
+      private
+        # generates the nested data structure to represent screenshots
+        def setup_screenshots(row)
+          screenshots = row.fetch('screenshots', {}).fetch('value', nil)
+          return [] unless screenshots
+
+          result = []
+
+          screenshots.each do |device_type, value|
+            value['value'].each do |screenshot|
+              screenshot = screenshot['value']
+              result << Tunes::AppScreenshot.new({
+                url: screenshot['url'],
+                thumbnail_url: screenshot['thumbNailUrl'],
+                sort_order: screenshot['sortOrder'],
+                original_file_name: screenshot['originalFileName'],
+                device_type: device_type,
+                language: row['language']
+              })
+            end
+          end
+
+          return result
+        end
+    end
+  end
+end