spaceship 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f1c5ac6945f70388e4e1ad0b2f52a1f185c56fb
-  data.tar.gz: a925727b880ed220b5f1d85dd7b523b7354149f7
+  metadata.gz: bee636c5de7df79ede26deda935649fb5a738e3f
+  data.tar.gz: 0e846d25300e1c0658e036f208991f841d55b5d7
 SHA512:
-  metadata.gz: d50ba6dc463d4b920716eb792f9a00a01240e5c7d42a7980889f32b831818c4007a440fcef48cbe4793ac764e3849646bbd7bb435d2f4bf69eccf029a0bbe11d
-  data.tar.gz: 1ec502faa18764220dd036e782bfafde2f9ea423469060e5b21f639454aebc0e53ffccfa7569f3cfd9f10c661726b712283377bffcb13233c0733bbeed62885a
+  metadata.gz: 5a81882cdb7b1169c78d456e4a9c531da3888632ad6d9ecd9cb36d3b546a1c95db5e98a88369d3996847a5a61b5f6b80663fb2db4b4950d612c417e84989d80b
+  data.tar.gz: c894e87a4e5819716c5959cfeba5b8de19b2b82c91ef46c4ab506225e1fabfedd51058a46b1ca545eaabd7ae48bf8bbad3499a276f453ca930759d0fe7cd9197

data/README.md

@@ -66,17 +66,17 @@ Enough words, here is some code:
 
 ```ruby
 Spaceship.login
- 
+
 # Create a new app
 app = Spaceship.app.create!(bundle_id: "com.krausefx.app", name: "Spaceship App")
- 
+
 # Use an existing certificate
 cert = Spaceship.certificate.production.all.first
- 
+
 # Create a new provisioning profile
 profile = Spaceship.provisioning_profile.app_store.create!(bundle_id: app.bundle_id,
                                                          certificate: cert)
- 
+
 # Print the name and download the new profile
 puts "Created Profile " + profile.name
 profile.download
@@ -84,7 +84,7 @@ profile.download
 
 ## Speed
 
-How fast are tools using `spaceship` compared to web scraping? 
+How fast are tools using `spaceship` compared to web scraping?
 
 ![assets/SpaceshipRecording.gif](assets/SpaceshipRecording.gif)
 
@@ -110,13 +110,15 @@ Most [fastlane tools](https://fastlane.tools) already use `spaceship`, like `sig
 
 The detailed documentation of all available classes is available on [RubyDoc](http://www.rubydoc.info/github/fastlane/spaceship/frames).
 
+You can find the log file here `/tmp/spaceship[time].log`.
+
 # Technical Details
 
 ## HTTP Client
 
-Up until now all [fastlane tools](https://fastlane.tools) used web scraping to interact with Apple's web services. `spaceship` uses a simple HTTP client only, resulting in much less overhead and extremely improved speed. 
+Up until now all [fastlane tools](https://fastlane.tools) used web scraping to interact with Apple's web services. `spaceship` uses a simple HTTP client only, resulting in much less overhead and extremely improved speed.
 
-Advantages of `spaceship` (HTTP client) over web scraping: 
+Advantages of `spaceship` (HTTP client) over web scraping:
 
 - Blazing fast :rocket: 90% faster than previous methods
 - No more overhead by loading images, HTML, JS and CSS files on each page load
@@ -129,18 +131,19 @@ Advantages of `spaceship` (HTTP client) over web scraping:
 I won't go into too much technical details about the various API endpoints, but just to give you an idea:
 
 - `https://idmsa.apple.com`: Used to authenticate to get a valid session
-- `https://developerservices2.apple.com`: 
+- `https://developerservices2.apple.com`:
  - Get a detailed list of all available provisioning profiles
  - This API returns the devices, certificates and app for each of the profiles
  - Register new devices
-- `https://developer.apple.com`: 
- - List all devices, certificates and apps
+- `https://developer.apple.com`:
+ - List all devices, certificates, apps and app groups
  - Create new certificates, provisioning profiles and apps
+ - Disable/enable services on apps and assign them to app groups
  - Delete certificates and apps
  - Repair provisioning profiles
  - Download provisioning profiles
  - Team selection
-- `https://itunesconnect.apple.com`: 
+- `https://itunesconnect.apple.com`:
  - Managing apps
  - Managing beta testers
  - Submitting updates to review
@@ -150,11 +153,11 @@ I won't go into too much technical details about the various API endpoints, but
 
 ## Magic involved
 
-`spaceship` does a lot of magic to get everything working so neatly: 
+`spaceship` does a lot of magic to get everything working so neatly:
 
 - **Sensible Defaults**: You only have to provide the mandatory information (e.g. new provisioning profiles contain all devices by default)
 - **Local Validation**: When pushing changes back to the Apple Dev Portal `spaceship` will make sure only valid data is sent to Apple (e.g. automatic repairing of provisioning profiles)
-- **Various request/response types**: When working with the different API endpoints, `spaceship` has to deal with `JSON`, `XML`, `txt`, `plist` and sometimes even `HTML` responses and requests. 
+- **Various request/response types**: When working with the different API endpoints, `spaceship` has to deal with `JSON`, `XML`, `txt`, `plist` and sometimes even `HTML` responses and requests.
 - **Automatic Pagination**: Even if you have thousands of apps, profiles or certificates, `spaceship` **can** handle your scale. It was heavily tested by first using `spaceship` to create hundreds of profiles and then accessing them using `spaceship`.
 - **Session, Cookie and CSRF token**: All the security aspects are handled by `spaceship`.
 - **Profile Magic**: Create and upload code signing requests, all managed by `spaceship`
@@ -162,9 +165,9 @@ I won't go into too much technical details about the various API endpoints, but
 
 # Credits
 
-The initial release was sponsored by [ZeroPush](https://zeropush.com). 
+The initial release was sponsored by [ZeroPush](https://zeropush.com).
 
-`spaceship` was developed by 
+`spaceship` was developed by
 - [@KrauseFx](https://twitter.com/KrauseFx).
 - [@snatchev](https://twitter.com/snatchev/)
 - [@mathcarignani](https://twitter.com/mathcarignani/)

data/lib/spaceship/base.rb

@@ -175,7 +175,6 @@ module Spaceship
     # This method can be used by subclasses to do additional initialisation
     # using the `raw_data`
     def setup
-
     end
 
     ##

data/lib/spaceship/client.rb

@@ -5,7 +5,6 @@ require 'spaceship/ui'
 require 'spaceship/helper/plist_middleware'
 require 'spaceship/helper/net_http_generic_request'
 
-
 if ENV["DEBUG"]
   require 'openssl'
   # this has to be on top of this file, since the value can't be changed later
@@ -20,12 +19,15 @@ module Spaceship
     attr_accessor :cookie
 
     # The logger in which all requests are logged
-    # /tmp/spaceship.log by default
+    # /tmp/spaceship[time].log by default
     attr_accessor :logger
 
     # Invalid user credentials were provided
     class InvalidUserCredentialsError < StandardError; end
 
+    # Raised when no user credentials were passed at all
+    class NoUserCredentialsError < StandardError; end
+
     class UnexpectedResponse < StandardError; end
 
     # Authenticates with Apple's web services. This method has to be called once
@@ -71,14 +73,14 @@ module Spaceship
     end
 
     # The logger in which all requests are logged
-    # /tmp/spaceship.log by default
+    # /tmp/spaceship[time].log by default
     def logger
       unless @logger
         if $verbose || ENV["VERBOSE"]
           @logger = Logger.new(STDOUT)
         else
           # Log to file by default
-          path = "/tmp/spaceship.log"
+          path = "/tmp/spaceship#{Time.now.to_i}.log"
           @logger = Logger.new(path)
         end
 
@@ -138,11 +140,11 @@ module Spaceship
         require 'credentials_manager'
         data = CredentialsManager::PasswordManager.shared_manager(user, false)
         user ||= data.username
-        password ||= data.password
+        password = data.password
       end
 
-      if user.to_s.empty? or password.to_s.empty?
-        raise InvalidUserCredentialsError.new("No login data provided")
+      if user.to_s.strip.empty? or password.to_s.strip.empty?
+        raise NoUserCredentialsError.new("No login data provided")
       end
 
       send_login_request(user, password) # different in subclasses
@@ -153,94 +155,98 @@ module Spaceship
       !!@cookie
     end
 
+    def with_retry(tries = 5, &block)
+      return block.call
+    rescue Faraday::Error::TimeoutError => ex # New Faraday version: Faraday::TimeoutError => ex
+      unless (tries -= 1).zero?
+        sleep 3
+        retry
+      end
+
+      raise ex # re-raise the exception
+    end
+
     private
-      # Is called from `parse_response` to store the latest csrf_token (if available)
-      def store_csrf_tokens(response)
-        if response and response.headers
-          tokens = response.headers.select { |k, v| %w[csrf csrf_ts].include?(k) }
-          if tokens and not tokens.empty?
-            @csrf_tokens = tokens
-          end
+
+    # Is called from `parse_response` to store the latest csrf_token (if available)
+    def store_csrf_tokens(response)
+      if response and response.headers
+        tokens = response.headers.select { |k, v| %w[csrf csrf_ts].include?(k) }
+        if tokens and not tokens.empty?
+          @csrf_tokens = tokens
         end
       end
+    end
 
       # memoize the last csrf tokens from responses
-      def csrf_tokens
-        @csrf_tokens || {}
-      end
+    def csrf_tokens
+      @csrf_tokens || {}
+    end
 
-      def request(method, url_or_path = nil, params = nil, headers = {}, &block)
-        if session?
-          headers.merge!({'Cookie' => cookie})
-          headers.merge!(csrf_tokens)
-        end
-        headers.merge!({'User-Agent' => 'spaceship'})
+    def request(method, url_or_path = nil, params = nil, headers = {}, &block)
+      if session?
+        headers.merge!({'Cookie' => cookie})
+        headers.merge!(csrf_tokens)
+      end
+      headers.merge!({'User-Agent' => 'spaceship'})
 
-        # Before encoding the parameters, log them
-        log_request(method, url_or_path, params)
+      # Before encoding the parameters, log them
+      log_request(method, url_or_path, params)
 
-        # form-encode the params only if there are params, and the block is not supplied.
-        # this is so that certain requests can be made using the block for more control
-        if method == :post && params && !block_given?
-          params, headers = encode_params(params, headers)
-        end
+      # form-encode the params only if there are params, and the block is not supplied.
+      # this is so that certain requests can be made using the block for more control
+      if method == :post && params && !block_given?
+        params, headers = encode_params(params, headers)
+      end
 
-        response = send_request(method, url_or_path, params, headers, &block)
+      response = send_request(method, url_or_path, params, headers, &block)
 
-        log_response(method, url_or_path, response)
+      log_response(method, url_or_path, response)
 
-        return response
-      end
+      return response
+    end
 
-      def log_request(method, url, params)
-        params_to_log = Hash(params).dup # to also work with nil
-        params_to_log.delete(:accountPassword) # Dev Portal
-        params_to_log.delete(:theAccountPW) # iTC
-        params_to_log = params_to_log.collect do |key, value|
-          "{#{key}: #{value}}"
-        end
-        logger.info("#{method.upcase}: #{url} #{params_to_log.join(', ')}")
+    def log_request(method, url, params)
+      params_to_log = Hash(params).dup # to also work with nil
+      params_to_log.delete(:accountPassword) # Dev Portal
+      params_to_log.delete(:theAccountPW) # iTC
+      params_to_log = params_to_log.collect do |key, value|
+        "{#{key}: #{value}}"
       end
+      logger.info("#{method.upcase}: #{url} #{params_to_log.join(', ')}")
+    end
 
-      def log_response(method, url, response)
-        logger.debug("#{method.upcase}: #{url}: #{response.body}")
-      end
+    def log_response(method, url, response)
+      logger.debug("#{method.upcase}: #{url}: #{response.body}")
+    end
 
       # Actually sends the request to the remote server
       # Automatically retries the request up to 3 times if something goes wrong
-      def send_request(method, url_or_path, params, headers, &block)
-        tries ||= 5
-
-        return @client.send(method, url_or_path, params, headers, &block)
-
-      rescue Faraday::Error::TimeoutError => ex # New Faraday version: Faraday::TimeoutError => ex
-        unless (tries -= 1).zero?
-          sleep 3
-          retry
-        end
-
-        raise ex # re-raise the exception
+    def send_request(method, url_or_path, params, headers, &block)
+      with_retry do
+        @client.send(method, url_or_path, params, headers, &block)
       end
+    end
 
-      def parse_response(response, expected_key = nil)
-        if expected_key
-          content = response.body[expected_key]
-        else
-          content = response.body
-        end
-
-        if content == nil
-          raise UnexpectedResponse.new(response.body)
-        else
-          store_csrf_tokens(response)
-          content
-        end
+    def parse_response(response, expected_key = nil)
+      if expected_key
+        content = response.body[expected_key]
+      else
+        content = response.body
       end
 
-      def encode_params(params, headers)
-        params = Faraday::Utils::ParamsHash[params].to_query
-        headers = {'Content-Type' => 'application/x-www-form-urlencoded'}.merge(headers)
-        return params, headers
+      if content == nil
+        raise UnexpectedResponse.new(response.body)
+      else
+        store_csrf_tokens(response)
+        content
       end
+    end
+
+    def encode_params(params, headers)
+      params = Faraday::Utils::ParamsHash[params].to_query
+      headers = {'Content-Type' => 'application/x-www-form-urlencoded'}.merge(headers)
+      return params, headers
+    end
   end
 end

data/lib/spaceship/helper/net_http_generic_request.rb

@@ -9,4 +9,4 @@ class Net::HTTPGenericRequest
   def supply_default_content_type
     return if content_type
   end
-end
+end

data/lib/spaceship/launcher.rb

@@ -6,17 +6,17 @@ module Spaceship
     # spaceship. You can call `.new` without any parameters, but you'll have to call
     # `.login` at a later point. If you prefer, you can pass the login credentials
     # here already.
-    # 
+    #
     # 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
     def initialize(user = nil, password = nil)
       @client = PortalClient.new
@@ -33,30 +33,30 @@ module Spaceship
     # 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, password) 
+    def login(user, password)
       @client.login(user, password)
     end
 
     # Open up the team selection for the user (if necessary).
-    # 
+    #
     # If the user is in multiple teams, a team selection is shown.
     # The user can then select a team by entering the number
-    # 
+    #
     # Additionally, the team ID is shown next to each team name
     # so that the user can use the environment variable `FASTLANE_TEAM_ID`
     # for future user.
-    # 
-    # @return (String) The ID of the select team. You also get the value if 
+    #
+    # @return (String) The ID of the select team. You also get the value if
     #   the user is only in one team.
     def select_team
       @client.select_team
@@ -71,6 +71,11 @@ module Spaceship
       Spaceship::App.set_client(@client)
     end
 
+    # @return (Class) Access the app groups for this spaceship
+    def app_group
+      Spaceship::AppGroup.set_client(@client)
+    end
+
     # @return (Class) Access the devices for this spaceship
     def device
       Spaceship::Device.set_client(@client)
@@ -86,4 +91,4 @@ module Spaceship
       Spaceship::ProvisioningProfile.set_client(@client)
     end
   end
-end
+end

data/lib/spaceship/portal/app.rb

@@ -4,7 +4,7 @@ module Spaceship
     class App < PortalBase
 
       # @return (String) The identifier of this app, provided by the Dev Portal
-      # @example 
+      # @example
       #   "RGAWZGXSAA"
       attr_accessor :app_id
 
@@ -14,17 +14,17 @@ module Spaceship
       attr_accessor :name
 
       # @return (String) the supported platform of this app
-      # @example 
+      # @example
       #   "ios"
       attr_accessor :platform
 
       # Prefix provided by the Dev Portal
-      # @example 
+      # @example
       #   "5A997XSHK2"
       attr_accessor :prefix
 
       # @return (String) The bundle_id (app identifier) of your app
-      # @example 
+      # @example
       #   "com.krausefx.app"
       attr_accessor :bundle_id
 
@@ -33,7 +33,7 @@ module Spaceship
 
       # @return (Hash) Feature details
       attr_accessor :features
-      
+
       # @return (Array) List of enabled features
       attr_accessor :enabled_features
 
@@ -45,10 +45,10 @@ module Spaceship
 
       # @return (Fixnum) Number of associated app groups
       attr_accessor :app_groups_count
-      
+
       # @return (Fixnum) Number of associated cloud containers
       attr_accessor :cloud_containers_count
-      
+
       # @return (Fixnum) Number of associated identifiers
       attr_accessor :identifiers_count
 
@@ -81,7 +81,7 @@ module Spaceship
         end
 
         # Creates a new App ID on the Apple Dev Portal
-        # 
+        #
         # if bundle_id ends with '*' then it is a wildcard id otherwise, it is an explicit id
         # @param bundle_id [String] the bundle id (app_identifier) of the app associated with this provisioning profile
         # @param name [String] the name of the App
@@ -113,13 +113,27 @@ module Spaceship
         client.delete_app!(app_id)
         self
       end
-      
+
       # Fetch a specific App ID details based on the bundle_id
       # @return (App) The app you're looking for. This is nil if the app can't be found.
       def details
         app = client.details_for_app(self)
         self.class.factory(app)
       end
+
+      # Associate specific groups with this app
+      # @return (App) The updated detailed app. This is nil if the app couldn't be found
+      def associate_groups(groups)
+        app = client.associate_groups_with_app(self, groups)
+        self.class.factory(app)
+      end
+
+      # Update a service for the app with given AppService object
+      # @return (App) The updated detailed app. This is nil if the app couldn't be found
+      def update_service(service)
+        app = client.update_service_for_app(self, service)
+        self.class.factory(app)
+      end
     end
   end
 end

data/lib/spaceship/portal/app_group.rb

@@ -0,0 +1,77 @@
+module Spaceship
+  module Portal
+    # Represents an app group of the Apple Dev Portal
+    class AppGroup < PortalBase
+      # @return (String) The identifier assigned to this group
+      # @example
+      #   "group.com.example.application"
+      attr_accessor :group_id
+
+      # @return (String) The prefix assigned to this group
+      # @example
+      #   "9J57U9392R"
+      attr_accessor :prefix
+
+      # @return (String) The name of this group
+      # @example
+      #   "App Group"
+      attr_accessor :name
+
+      # @return (String) Status of the group
+      # @example
+      #   "current"
+      attr_accessor :status
+
+      # @return (String) The identifier of this app group, provided by the Dev Portal
+      # @example
+      #   "2MAY7NPHAA"
+      attr_accessor :app_group_id
+
+      attr_mapping(
+        'applicationGroup' => :app_group_id,
+        'name' => :name,
+        'prefix' => :prefix,
+        'identifier' => :group_id,
+        'status' => :status
+      )
+
+      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 app groups available for this account
+        def all
+          client.app_groups.map { |group| self.factory(group) }
+        end
+
+        # Creates a new App Group on the Apple Dev Portal
+        #
+        # @param group_id [String] the identifier to assign to this group
+        # @param name [String] the name of the group
+        # @return (AppGroup) The group you just created
+        def create!(group_id: nil, name: nil)
+          new_group = client.create_app_group!(name, group_id)
+          self.new(new_group)
+        end
+
+        # Find a specific App Group group_id
+        # @return (AppGroup) The app group you're looking for. This is nil if the app group can't be found.
+        def find(group_id)
+          all.find do |group|
+            group.group_id == group_id
+          end
+        end
+      end
+
+      # Delete this app group
+      # @return (AppGroup) The app group you just deletd
+      def delete!
+        client.delete_app_group!(app_group_id)
+        self
+      end
+    end
+  end
+end