spaceship 0.7.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb67ea61ddcb8fc09c87de04eb400be6a4c0c9e2
-  data.tar.gz: c62c7bc6307daf12b7dd9a890c30241e633ec02c
+  metadata.gz: bb6191ed6a0a0d23338cc28f0f31d3160a1f2a99
+  data.tar.gz: 536a34d8e0ea5fa2240599de967fb5e221dceee1
 SHA512:
-  metadata.gz: 86c17cf18e9949250db8d312822188f2896ba4beff339fd949d876fc0e9bd4c2b017d58dc18bcade5a831682ab8f84cddcdd3d640cbf1fe4b2d22b33d7e7cb38
-  data.tar.gz: bd449519839313194d8128f72b6f1fa74f4a89b03293f35b33b692cf5e638d1014f03ccc01db8fb1dd73db8270dc4a77c5559f52f6f8182725f60ffa442766a7
+  metadata.gz: 3de66c022d9654a8a56360afc24b03824a231bf90aca2e3d06981216def52bc1633de822496a89e30db3103c714a31160633c15d5da8b8bb2119f0181ec3d281
+  data.tar.gz: ba9fe63a3d4410d47a8956d650e08521abc3afd016977c042ff6d55616882f23cb8b36b269fee2cdb26e8d578699e6414a7ae6ffd1e9b02aa2ffa3618b8357e8

data/README.md

@@ -149,6 +149,8 @@ I won't go into too much technical details about the various API endpoints, but
  - Managing beta testers
  - Submitting updates to review
  - Manaing app metadata
+- `https://du-itc.itunesconnect.apple.com`:
+ - Upload icons, screenshots, trailers ...
 
 `spaceship` uses all those API points to offer this seamless experience.
 

data/lib/spaceship/base.rb

@@ -27,9 +27,11 @@ module Spaceship
       def get(*keys)
         lookup(keys)
       end
-      alias [] get
+
+      alias_method :[], :get
 
       def set(keys, value)
+        raise "'keys' must be an array, got #{keys.class} instead" unless keys.kind_of?(Array)
         last = keys.pop
         ref = lookup(keys) || @hash
         ref[last] = value

data/lib/spaceship/client.rb

@@ -18,6 +18,9 @@ module Spaceship
     attr_reader :client
     attr_accessor :cookie
 
+    # The user that is currently logged in
+    attr_accessor :user
+
     # The logger in which all requests are logged
     # /tmp/spaceship[time].log by default
     attr_accessor :logger
@@ -148,6 +151,7 @@ module Spaceship
         raise NoUserCredentialsError.new, "No login data provided"
       end
 
+      self.user = user
       send_login_request(user, password) # different in subclasses
     end
 
@@ -186,10 +190,10 @@ module Spaceship
 
     def request(method, url_or_path = nil, params = nil, headers = {}, &block)
       if session?
-        headers.merge!({'Cookie' => cookie})
+        headers.merge!({ 'Cookie' => cookie })
         headers.merge!(csrf_tokens)
       end
-      headers.merge!({'User-Agent' => 'spaceship'})
+      headers.merge!({ 'User-Agent' => 'spaceship' })
 
       # Before encoding the parameters, log them
       log_request(method, url_or_path, params)
@@ -246,7 +250,7 @@ module Spaceship
 
     def encode_params(params, headers)
       params = Faraday::Utils::ParamsHash[params].to_query
-      headers = {'Content-Type' => 'application/x-www-form-urlencoded'}.merge(headers)
+      headers = { 'Content-Type' => 'application/x-www-form-urlencoded' }.merge(headers)
       return params, headers
     end
   end

data/lib/spaceship/du/du_client.rb

@@ -0,0 +1,100 @@
+module Spaceship
+  # This class is used to upload Digital files (Images, Videos, JSON files) onto the du-itc service.
+  # Its implementation is tied to the tunes module (in particular using +AppVersion+ instances)
+  class DUClient < Spaceship::Client #:nodoc:
+    #####################################################
+    # @!group Init and Login
+    #####################################################
+
+    def self.hostname
+      "https://du-itc.itunes.apple.com"
+    end
+
+    #####################################################
+    # @!group Images
+    #####################################################
+
+    def upload_screenshot(app_version, upload_file, content_provider_id, sso_token_for_image, device)
+      upload_file(app_version, upload_file, '/upload/image', content_provider_id, sso_token_for_image, screenshot_picture_type(device))
+    end
+
+    def upload_large_icon(app_version, upload_file, content_provider_id, sso_token_for_image)
+      upload_file(app_version, upload_file, '/upload/image', content_provider_id, sso_token_for_image, 'MZPFT.LargeApplicationIcon')
+    end
+
+    def upload_watch_icon(app_version, upload_file, content_provider_id, sso_token_for_image)
+      upload_file(app_version, upload_file, '/upload/image', content_provider_id, sso_token_for_image, 'MZPFT.GizmoAppIcon')
+    end
+
+    def upload_geojson(app_version, upload_file, content_provider_id, sso_token_for_image)
+      upload_file(app_version, upload_file, '/upload/geo-json', content_provider_id, sso_token_for_image)
+    end
+
+    def upload_trailer(app_version, upload_file, content_provider_id, sso_token_for_video)
+      upload_file(app_version, upload_file, '/upload/purple-video', content_provider_id, sso_token_for_video)
+    end
+
+    def upload_video_preview(app_version, upload_file, content_provider_id, sso_token_for_image)
+      upload_file(app_version, upload_file, '/upload/app-screenshot-image', content_provider_id, sso_token_for_image)
+    end
+
+    private
+
+    def upload_file(app_version, upload_file, path, content_provider_id, sso_token, du_validation_rule_set = nil)
+      raise "File #{upload_file.file_path} is empty" if upload_file.file_size == 0
+
+      version = app_version.version
+      app_id = app_version.application.apple_id
+      app_type = app_version.app_type
+
+      referrer = app_version.application.url
+
+      r = request(:post) do |req|
+        req.url "#{self.class.hostname}#{path}"
+        req.body = upload_file.bytes
+        req.headers['Accept'] = 'application/json, text/plain, */*'
+        req.headers['Content-Type'] = upload_file.content_type
+        req.headers['X-Apple-Upload-Referrer'] = referrer
+        req.headers['Referrer'] = referrer
+        req.headers['X-Apple-Upload-AppleId'] = app_id
+        req.headers['X-Apple-Jingle-Correlation-Key'] = "#{app_type}:AdamId=#{app_id}:Version=#{version}"
+        req.headers['X-Apple-Upload-itctoken'] = sso_token
+        req.headers['X-Apple-Upload-ContentProviderId'] = content_provider_id
+        req.headers['X-Original-Filename'] = upload_file.file_name
+        req.headers['X-Apple-Upload-Validation-RuleSets'] = du_validation_rule_set if du_validation_rule_set
+        req.headers['Content-Length'] = "#{upload_file.file_size}"
+        req.headers['Connection'] = "keep-alive"
+      end
+      parse_upload_response(r)
+    end
+
+    def picture_type_map
+      # rubocop:enable Style/ExtraSpacing
+      {
+        watch:        "MZPFT.SortedN27ScreenShot",
+        ipad:         "MZPFT.SortedTabletScreenShot",
+        iphone6:      "MZPFT.SortedN61ScreenShot",
+        iphone6Plus:  "MZPFT.SortedN56ScreenShot",
+        iphone4:      "MZPFT.SortedN41ScreenShot",
+        iphone35:     "MZPFT.SortedScreenShot"
+      }
+    end
+
+    def screenshot_picture_type(device)
+      device = device.to_sym
+      raise "Unknown picture type for device: #{device}" unless picture_type_map.key? device
+      picture_type_map[device]
+    end
+
+    def parse_upload_response(response)
+      content = response.body
+      if !content['statusCode'].nil? && content['statusCode'] != 200
+        error_codes = ""
+        error_codes = content['errorCodes'].join(',') unless content['errorCodes'].nil?
+        error_message = "[#{error_codes}] #{content['localizedMessage']}"
+        raise UnexpectedResponse.new, error_message
+      end
+      content
+    end
+  end
+end

data/lib/spaceship/du/upload_file.rb

@@ -0,0 +1,45 @@
+module Spaceship
+  # a wrapper around the concept of file required to make uploads to DU
+  class UploadFile
+    attr_reader :file_path
+    attr_reader :file_name
+    attr_reader :file_size
+    attr_reader :content_type
+    attr_reader :bytes
+
+    class << self
+      def from_path(path)
+        raise "Image must exists at path: #{path}" unless File.exist?(path)
+        path = remove_alpha_channel(path) if File.extname(path).downcase == '.png'
+
+        content_type = Utilities.content_type(path)
+        self.new(
+          file_path: path,
+          file_name: File.basename(path),
+          file_size: File.size(path),
+          content_type: content_type,
+          bytes: File.read(path)
+        )
+      end
+
+      # As things like screenshots and app icon shouldn't contain the alpha channel
+      # This will copy the image into /tmp to remove the alpha channel there
+      # That's done to not edit the original image
+      def remove_alpha_channel(original)
+        path = "/tmp/#{Digest::MD5.hexdigest(original)}.png"
+        FileUtils.copy(original, path)
+        `sips -s format bmp '#{path}' &> /dev/null ` # &> /dev/null since there is warning because of the extension
+        `sips -s format png '#{path}'`
+        return path
+      end
+    end
+
+    private
+
+    def initialize(args)
+      args.each do |k, v|
+        instance_variable_set("@#{k}", v) unless v.nil?
+      end
+    end
+  end
+end

data/lib/spaceship/du/utilities.rb

@@ -0,0 +1,75 @@
+require 'fastimage'
+require "English"
+
+module Spaceship
+  # Set of utility methods useful to work with media files
+  module Utilities #:nodoc:
+    # Identifies the content_type of a file based on its file name extension.
+    # Supports all formats required by DU-UTC right now (video, images and json)
+    # @param path (String) the path to the file
+    def content_type(path)
+      path = path.downcase
+      return 'image/jpeg' if path.end_with?('.jpg')
+      return 'image/png' if path.end_with?('.png')
+      return 'application/json' if path.end_with?('.geojson')
+      return 'video/quicktime' if path.end_with?('.mov')
+      return 'video/mp4' if path.end_with?('.m4v')
+      return 'video/mp4' if path.end_with?('.mp4')
+      raise "Unknown content-type for file #{path}"
+    end
+
+    # Identifies the resolution of a video or an image.
+    # Supports all video and images required by DU-UTC right now
+    # @param path (String) the path to the file
+    def resolution(path)
+      return FastImage.size(path) if content_type(path).start_with?("image")
+      return video_resolution(path) if content_type(path).start_with?("video")
+      raise "Cannot find resolution of file #{path}"
+    end
+
+    # Is the video or image in portrait mode ?
+    # Supports all video and images required by DU-UTC right now
+    # @param path (String) the path to the file
+    def portrait?(path)
+      resolution = resolution(path)
+      resolution[0] < resolution[1]
+    end
+
+    # Grabs a screenshot from the specified video at the specified timestamp using `ffmpeg`
+    # @param video_path (String) the path to the video file
+    # @param timestamp (String) the `ffmpeg` timestamp format (e.g. 00.00)
+    # @param dimensions (Array) the dimension of the screenshot to generate
+    # @return the path to the TempFile containing the generated screenshot
+    def grab_video_preview(video_path, timestamp, dimensions)
+      width, height = dimensions
+      require 'tempfile'
+      tmp = Tempfile.new(['video_preview', ".jpg"])
+      file = tmp.path
+      command = "ffmpeg -y -i \"#{video_path}\" -s #{width}x#{height} -ss \"#{timestamp}\" -vframes 1 \"#{file}\" 2>&1 >/dev/null"
+      # puts "COMMAND: #{command}"
+      `#{command}`
+      raise "Failed to grab screenshot at #{timestamp} from #{video_path} (using #{command})" unless $CHILD_STATUS.to_i == 0
+      tmp.path
+    end
+
+    # identifies the resolution of a video using `ffmpeg`
+    # @param video_path (String) the path to the video file
+    # @return [Array] the resolution of the video
+    def video_resolution(video_path)
+      command = "ffmpeg -i \"#{video_path}\" 2>&1"
+      # puts "COMMAND: #{command}"
+      output = `#{command}`
+      # Note: ffmpeg exits with 1 if no output specified
+      # raise "Failed to find video information from #{video_path} (using #{command})" unless $CHILD_STATUS.to_i == 0
+      output = output.force_encoding("BINARY")
+      video_infos = output.split("\n").select { |l| l =~ /Stream.*Video/ }
+      raise "Unable to find Stream Video information from ffmpeg output of #{command}" if video_infos.count == 0
+      video_info = video_infos[0]
+      res = video_info.match(/.* ([0-9]+)x([0-9]+),.*/)
+      raise "Unable to parse resolution information from #{video_info}" if res.count < 3
+      [res[1].to_i, res[2].to_i]
+    end
+
+    module_function :content_type, :grab_video_preview, :portrait?, :resolution, :video_resolution
+  end
+end

data/lib/spaceship/helper/net_http_generic_request.rb

@@ -5,8 +5,10 @@ require 'net/http'
 # Certain apple endpoints return 415 responses if a Content-Type is supplied.
 # Net::HTTP will default a content-type if none is provided by faraday
 # This monkey-patch allows us to leave out the content-type if we do not specify one.
-class Net::HTTPGenericRequest
-  def supply_default_content_type
-    return if content_type
+module Net
+  class HTTPGenericRequest
+    def supply_default_content_type
+      return if content_type
+    end
   end
 end

data/lib/spaceship/portal/app.rb

@@ -2,7 +2,6 @@ module Spaceship
   module Portal
     # Represents an App ID from the Developer Portal
     class App < PortalBase
-
       # @return (String) The identifier of this app, provided by the Dev Portal
       # @example
       #   "RGAWZGXSAA"

data/lib/spaceship/portal/app_service.rb

@@ -82,9 +82,9 @@ module Spaceship
 
       def ==(other)
         self.class == other.class &&
-        self.service_id == other.service_id &&
-        self.value == other.value &&
-        self.service_uri == other.service_uri
+          self.service_id == other.service_id &&
+          self.value == other.value &&
+          self.service_uri == other.service_uri
       end
 
       #

data/lib/spaceship/portal/portal_client.rb

@@ -1,6 +1,5 @@
 module Spaceship
   class PortalClient < Spaceship::Client
-
     #####################################################
     # @!group Init and Login
     #####################################################
@@ -274,7 +273,7 @@ module Spaceship
     end
 
     def download_certificate(certificate_id, type)
-      {type: type, certificate_id: certificate_id}.each { |k, v| raise "#{k} must not be nil" if v.nil? }
+      { type: type, certificate_id: certificate_id }.each { |k, v| raise "#{k} must not be nil" if v.nil? }
 
       r = request(:post, 'https://developer.apple.com/account/ios/certificate/certificateContentDownload.action', {
         teamId: team_id,

data/lib/spaceship/portal/provisioning_profile.rb

@@ -222,7 +222,7 @@ module Spaceship
                                                 self.type,
                                                 app.app_id,
                                                 certificate_parameter,
-                                                devices.map(&:id) )
+                                                devices.map(&:id))
           end
 
           self.new(profile)
@@ -256,7 +256,6 @@ module Spaceship
             profile.app.bundle_id == bundle_id
           end
         end
-
       end
 
       # Represents a Development profile from the Dev Portal

data/lib/spaceship/tunes/app_details.rb

@@ -63,6 +63,12 @@ module Spaceship
       # Push all changes that were made back to iTunes Connect
       def save!
         client.update_app_details!(application.apple_id, raw_data)
+      rescue Spaceship::TunesClient::ITunesConnectError => ex
+        if ex.to_s == "operation_failed"
+          # That's alright, we get this error message if nothing has changed
+        else
+          raise ex
+        end
       end
 
       # Custom Setters

data/lib/spaceship/tunes/app_image.rb

@@ -0,0 +1,53 @@
+module Spaceship
+  module Tunes
+    # Represents an image hosted on iTunes Connect. Used for icons, screenshots, etc
+    class AppImage < TunesBase
+      HOST_URL = "https://is1-ssl.mzstatic.com/image/thumb"
+
+      attr_accessor :asset_token
+
+      attr_accessor :sort_order
+
+      attr_accessor :original_file_name
+
+      attr_accessor :url
+
+      attr_mapping(
+        'assetToken' => :asset_token,
+        'sortOrder' => :sort_order,
+        'url' => :url,
+        'originalFileName' => :original_file_name
+      )
+
+      class << self
+        def factory(attrs)
+          self.new(attrs)
+        end
+      end
+
+      def reset!(attrs = {})
+        update_raw_data!(
+          {
+            asset_token: nil,
+            original_file_name: nil,
+            sort_order: nil,
+            url: nil
+          }.merge(attrs)
+        )
+      end
+
+      def setup
+        # Since September 2015 we don't get the url any more, so we have to manually build it
+        self.url = "#{HOST_URL}/#{self.asset_token}/0x0ss.jpg"
+      end
+
+      private
+
+      def update_raw_data!(hash)
+        hash.each do |k, v|
+          self.send("#{k}=", v)
+        end
+      end
+    end
+  end
+end

data/lib/spaceship/tunes/app_screenshot.rb

@@ -1,27 +1,16 @@
 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
-
+    class AppScreenshot < Spaceship::Tunes::AppImage
       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]
+      class << self
+        # Create a new object based on a hash.
+        def factory(attrs)
+          self.new(attrs)
+        end
       end
     end
   end