Class: Spaceship::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/spaceship/ui.rb,
lib/spaceship/portal/ui/select_team.rb,
lib/spaceship/client.rb

Direct Known Subclasses

DUClient, PortalClient, TunesClient

Defined Under Namespace

Classes: AppleTimeoutError, InvalidUserCredentialsError, NoUserCredentialsError, UnexpectedResponse, UserInterface

Constant Summary collapse

PROTOCOL_VERSION = 
"QH65B2"

Instance Attribute Summary collapse

Automatic Paging collapse

Login and Team Selection collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Client

Returns a new instance of Client.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/spaceship/client.rb', line 65

def initialize
  @client = Faraday.new(self.class.hostname) do |c|
    c.response :json, content_type: /\bjson$/
    c.response :xml, content_type: /\bxml$/
    c.response :plist, content_type: /\bplist$/
    c.adapter Faraday.default_adapter

    if ENV['DEBUG']
      # for debugging only
      # This enables tracking of networking requests using Charles Web Proxy
      c.response :logger
      c.proxy "https://127.0.0.1:8888"
    end
  end
end

Instance Attribute Details

#client ⇒ Object (readonly)

Returns the value of attribute client.



18
19
20
 
# File 'lib/spaceship/client.rb', line 18

def client
  @client
end

#cookie ⇒ Object

Returns the value of attribute cookie.



19
20
21
 
# File 'lib/spaceship/client.rb', line 19

def cookie
  @cookie
end

#logger ⇒ Object

The logger in which all requests are logged /tmp/spaceship.log by default



26
27
28
 
# File 'lib/spaceship/client.rb', line 26

def logger
  @logger
end

#user ⇒ Object

The user that is currently logged in



22
23
24
 
# File 'lib/spaceship/client.rb', line 22

def user
  @user
end

Class Method Details

.hostname ⇒ Object 



61
62
63
 
# File 'lib/spaceship/client.rb', line 61

def self.hostname
  raise "You must implemented self.hostname"
end

.login(user = nil, password = nil) ⇒ Spaceship::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)

Parameters:

  • user (String) (defaults to: nil) —

    (optional): The username (usually the email address)

  • password (String) (defaults to: nil) —

    (optional): The password

Returns:

Raises:

  • InvalidUserCredentialsError: raised if authentication failed



52
53
54
55
56
57
58
59
 
# File 'lib/spaceship/client.rb', line 52

def self.(user = nil, password = nil)
  instance = self.new
  if instance.(user, password)
    instance
  else
    raise InvalidUserCredentialsError.new, "Invalid User Credentials"
  end
end

Instance Method Details

#login(user = nil, password = nil) ⇒ Spaceship::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)

Parameters:

  • user (String) (defaults to: nil) —

    (optional): The username (usually the email address)

  • password (String) (defaults to: nil) —

    (optional): The password

Returns:

Raises:

  • InvalidUserCredentialsError: raised if authentication failed



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/spaceship/client.rb', line 144

def (user = nil, password = nil)
  if user.to_s.empty? or password.to_s.empty?
    require 'credentials_manager'

    keychain_entry = CredentialsManager::AccountManager.new(user: user, password: password)
    user ||= keychain_entry.user
    password = keychain_entry.password
  end

  if user.to_s.strip.empty? or password.to_s.strip.empty?
    raise NoUserCredentialsError.new, "No login data provided"
  end

  self.user = user

  begin
    (user, password) # different in subclasses
  rescue InvalidUserCredentialsError => ex
    raise ex unless keychain_entry

    if keychain_entry.invalid_credentials
      (user)
    else
      puts "Please run this tool again to apply the new password"
    end
  end
end

#page_size ⇒ Object

The page size we want to request, defaults to 500



106
107
108
 
# File 'lib/spaceship/client.rb', line 106

def page_size
  @page_size ||= 500
end

#paging ⇒ Object

Handles the paging for you… for free Just pass a block and use the parameter as page number



112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/spaceship/client.rb', line 112

def paging
  page = 0
  results = []
  loop do
    page += 1
    current = yield(page)

    results += current

    break if (current || []).count < page_size # no more results
  end

  return results
end

#session? ⇒ Bool

Returns Do we have a valid session?.

Returns:

  • (Bool) —

    Do we have a valid session?



173
174
175
 
# File 'lib/spaceship/client.rb', line 173

def session?
  !!@cookie
end

#UI ⇒ Object

Public getter for all UI related code rubocop:disable Style/MethodName



11
12
13
 
# File 'lib/spaceship/ui.rb', line 11

def UI
  UserInterface.new(self)
end

#with_retry(tries = 5, &block) ⇒ Object 



177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/spaceship/client.rb', line 177

def with_retry(tries = 5, &block)
  return block.call
rescue Faraday::Error::TimeoutError, AppleTimeoutError => ex # New Faraday version: Faraday::TimeoutError => ex
  unless (tries -= 1).zero?
    logger.warn("Timeout received: '#{ex.message}'.  Retrying after 3 seconds (remaining: #{tries})...")
    sleep 3
    retry
  end

  raise ex # re-raise the exception
end