Class: Parse::Client

Overview

This class is the core and low level API for the Parse SDK REST interface that is used by the other components. It can manage multiple sessions, which means you can have multiple client instances pointing to different Parse Applications at the same time. It handles sending raw requests as well as providing Request/Response objects for all API handlers. The connection engine is Faraday, which means it is open to add any additional middleware for features you'd like to implement.

Defined Under Namespace

Modules: Connectable Classes: ResponseError

Constant Summary collapse

USER_AGENT_HEADER =

The user agent header key.

"User-Agent".freeze
USER_AGENT_VERSION =

The value for the User-Agent header.

"Parse-Stack v#{Parse::Stack::VERSION}".freeze
DEFAULT_RETRIES =

The default retry count

2
RETRY_DELAY =

The wait time in seconds between retries

1.5

Constants included from API::Hooks

API::Hooks::TRIGGER_NAMES

Class Attribute Summary collapse

Instance Attribute Summary collapse

Attributes included from API::Server

#server_info

Attributes included from API::Config

#config

Class Method Summary collapse

Instance Method Summary collapse

Methods included from API::Users

#create_user, #current_user, #delete_user, #fetch_user, #find_users, #login, #logout, #request_password_reset, #set_service_auth_data, #signup, #update_user

Methods included from API::Sessions

#fetch_session

Methods included from API::Server

#server_health, #server_info!, #server_version

Methods included from API::Schema

#create_schema, #schema, #schemas, #update_schema

Methods included from API::Push

#push

Methods included from API::Objects

#create_object, #delete_object, #fetch_object, #find_objects, #update_object, #uri_path

Methods included from API::Hooks

#create_function, #create_trigger, #delete_function, #delete_trigger, #fetch_function, #fetch_trigger, #functions, #triggers, #update_function, #update_trigger

Methods included from API::Files

#create_file

Methods included from API::Config

#config!, #update_config

Methods included from API::CloudFunctions

#call_function, #trigger_job

Methods included from API::Batch

#batch_request

Methods included from API::Aggregate

#aggregate_objects, #aggregate_uri_path

Methods included from API::Analytics

#send_analytics

Constructor Details

#initialize(opts = {}) ⇒ Client

Create a new client connected to the Parse Server REST API endpoint.

Parameters:

  • opts (Hash) (defaults to: {})

    a set of connection options to configure the client.

Options Hash (opts):

  • :server_url (String)

    The server url of your Parse Server if you are not using the hosted Parse service. By default it will use ENV if available, otherwise fallback to Protocol::SERVER_URL.

  • :app_id (String)

    The Parse application id. Defaults to ENV.

  • :api_key (String)

    Your Parse REST API Key. Defaults to ENV.

  • :master_key (String)

    The Parse application master key (optional). If this key is set, it will be sent on every request sent by the client and your models. Defaults to ENV.

  • :logging (Boolean)

    It provides you additional logging information of requests and responses. If set to the special symbol of :debug, it will provide additional payload data in the log messages. This option affects the logging performed by Middleware::BodyBuilder.

  • :adapter (Object)

    The connection adapter. By default it uses the `Faraday.default_adapter` which is Net/HTTP.

  • :cache (Moneta::Transformer, Moneta::Expires)

    A caching adapter of type Moneta::Transformer or Moneta::Expires that will be used by the caching middleware Middleware::Caching. Caching queries and object fetches can help improve the performance of your application, even if it is for a few seconds. Only successful GET object fetches and non-empty result queries will be cached by default. You may set the default expiration time with the expires option. At any point in time you may clear the cache by calling the #clear_cache! method on the client connection. See Moneta.

  • :expires (Integer)

    Sets the default cache expiration time (in seconds) for successful non-empty GET requests when using the caching middleware. The default value is 3 seconds. If :expires is set to 0, caching will be disabled. You can always clear the current state of the cache using the clear_cache! method on your Parse::Client instance.

  • :faraday (Hash)

    You may pass a hash of options that will be passed to the Faraday constructor.

Raises:

  • Parse::Error::ConnectionError if the client was not properly configured with required keys or url.

  • ArgumentError if the cache instance passed to the :cache option is not of Moneta::Transformer or Moneta::Expires

See Also:


244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
# File 'lib/parse/client.rb', line 244

def initialize(opts = {})
  @server_url     = opts[:server_url] || ENV["PARSE_SERVER_URL"] || Parse::Protocol::SERVER_URL
  @application_id = opts[:application_id] || opts[:app_id] || ENV["PARSE_SERVER_APPLICATION_ID"] || ENV['PARSE_APP_ID']
  @api_key        = opts[:api_key] || opts[:rest_api_key]  || ENV["PARSE_SERVER_REST_API_KEY"] || ENV["PARSE_API_KEY"]
  @master_key     = opts[:master_key] || ENV['PARSE_SERVER_MASTER_KEY'] || ENV["PARSE_MASTER_KEY"]
  opts[:adapter] ||= Faraday.default_adapter
  opts[:expires] ||= 3
  if @server_url.nil? || @application_id.nil? || ( @api_key.nil? && @master_key.nil? )
    raise Parse::Error::ConnectionError, "Please call Parse.setup(server_url:, application_id:, api_key:) to setup a client"
  end
  @server_url += '/' unless @server_url.ends_with?('/')
  #Configure Faraday
  opts[:faraday] ||= {}
  opts[:faraday].merge!(:url => @server_url)
  @conn = Faraday.new(opts[:faraday]) do |conn|
    #conn.request :json

    conn.response :logger if opts[:logging]

    # This middleware handles sending the proper authentication headers to Parse
    # on each request.

    # this is the required authentication middleware. Should be the first thing
    # so that other middlewares have access to the env that is being set by
    # this middleware. First added is first to brocess.
    conn.use Parse::Middleware::Authentication,
                application_id: @application_id,
                master_key: @master_key,
                api_key: @api_key
    # This middleware turns the result from Parse into a Parse::Response object
    # and making sure request that are going out, follow the proper MIME format.
    # We place it after the Authentication middleware in case we need to use then
    # authentication information when building request and responses.
    conn.use Parse::Middleware::BodyBuilder
    if opts[:logging].present? && opts[:logging] == :debug
      Parse::Middleware::BodyBuilder.logging = true
    end

    if opts[:cache].present? && opts[:expires].to_i > 0
      # advanced: provide a REDIS url, we'll configure a Moneta Redis store.
      if opts[:cache].is_a?(String) && opts[:cache].starts_with?("redis://")
        begin
          opts[:cache] = Moneta.new(:Redis, url: opts[:cache])
        rescue LoadError
          puts "[Parse::Middleware::Caching] Did you forget to load the redis gem (Gemfile)?"
          raise
        end
      end

      unless [:key?, :[], :delete, :store].all? { |method| opts[:cache].respond_to?(method) }
        raise ArgumentError, "Parse::Client option :cache needs to be a type of Moneta store"
      end
      self.cache = opts[:cache]
      conn.use Parse::Middleware::Caching, self.cache, {expires: opts[:expires].to_i }
    end

    yield(conn) if block_given?

    conn.adapter opts[:adapter]

  end
  Parse::Client.clients[:default] ||= self
end

Class Attribute Details

.clientsObject (readonly)

Returns the value of attribute clients


167
168
169
# File 'lib/parse/client.rb', line 167

def clients
  @clients
end

Instance Attribute Details

#api_keyString (readonly)

The Parse API key to be sent in every API request.

Returns:


156
# File 'lib/parse/client.rb', line 156

attr_accessor :cache, :retry_limit

#application_idString (readonly) Also known as: app_id

The Parse application identifier to be sent in every API request.

Returns:


156
# File 'lib/parse/client.rb', line 156

attr_accessor :cache, :retry_limit

#cacheMoneta::Transformer, Moneta::Expires

The underlying cache store for caching API requests.

Returns:

  • (Moneta::Transformer, Moneta::Expires)

See Also:


156
157
158
# File 'lib/parse/client.rb', line 156

def cache
  @cache
end

#master_keyString (readonly)

The Parse master key for this application, which when set, will be sent in every API request. (There is a way to prevent this on a per request basis.)

Returns:


156
# File 'lib/parse/client.rb', line 156

attr_accessor :cache, :retry_limit

#retry_limitInteger

If set, returns the current retry count for this instance. Otherwise, returns DEFAULT_RETRIES. Set to 0 to disable retry mechanism.

Returns:

  • (Integer)

    the current retry count for this client.


156
# File 'lib/parse/client.rb', line 156

attr_accessor :cache, :retry_limit

#server_urlString (readonly)

The Parse server url that will be receiving these API requests. By default this will be Protocol::SERVER_URL.

Returns:


156
# File 'lib/parse/client.rb', line 156

attr_accessor :cache, :retry_limit

Class Method Details

.client(conn = :default) ⇒ Parse::Client

Returns or create a new Parse::Client connection for the given connection name.

Parameters:

  • conn (Symbol) (defaults to: :default)

    the name of the connection.

Returns:


179
180
181
# File 'lib/parse/client.rb', line 179

def client(conn = :default)
  @clients[conn] ||= self.new
end

.client?(conn = :default) ⇒ Boolean

Returns true if a Parse::Client has been configured.

Parameters:

  • conn (Symbol) (defaults to: :default)

    the name of the connection.

Returns:

  • (Boolean)

    true if a Parse::Client has been configured.


171
172
173
# File 'lib/parse/client.rb', line 171

def client?(conn = :default)
  @clients[conn].present?
end

.setup(opts = {}) { ... } ⇒ Client

Setup the a new client with the appropriate Parse app keys, middleware and options.

Examples:

Parse.setup app_id: "YOUR_APP_ID",
            api_key: "YOUR_REST_API_KEY",
            master_key: "YOUR_MASTER_KEY", # optional
            server_url: 'https://localhost:1337/parse' #default

Parameters:

  • opts (Hash) (defaults to: {})

    a set of connection options to configure the client.

Options Hash (opts):

  • :server_url (String)

    The server url of your Parse Server if you are not using the hosted Parse service. By default it will use ENV if available, otherwise fallback to Protocol::SERVER_URL.

  • :app_id (String)

    The Parse application id. Defaults to ENV.

  • :api_key (String)

    Your Parse REST API Key. Defaults to ENV.

  • :master_key (String)

    The Parse application master key (optional). If this key is set, it will be sent on every request sent by the client and your models. Defaults to ENV.

  • :logging (Boolean)

    It provides you additional logging information of requests and responses. If set to the special symbol of :debug, it will provide additional payload data in the log messages. This option affects the logging performed by Middleware::BodyBuilder.

  • :adapter (Object)

    The connection adapter. By default it uses the `Faraday.default_adapter` which is Net/HTTP.

  • :cache (Moneta::Transformer, Moneta::Expires)

    A caching adapter of type Moneta::Transformer or Moneta::Expires that will be used by the caching middleware Middleware::Caching. Caching queries and object fetches can help improve the performance of your application, even if it is for a few seconds. Only successful GET object fetches and non-empty result queries will be cached by default. You may set the default expiration time with the expires option. At any point in time you may clear the cache by calling the #clear_cache! method on the client connection. See Moneta.

  • :expires (Integer)

    Sets the default cache expiration time (in seconds) for successful non-empty GET requests when using the caching middleware. The default value is 3 seconds. If :expires is set to 0, caching will be disabled. You can always clear the current state of the cache using the clear_cache! method on your Parse::Client instance.

  • :faraday (Hash)

    You may pass a hash of options that will be passed to the Faraday constructor.

Yields:

  • the block for additional configuration with Faraday middleware.

Returns:

  • (Client)

    a new instance of Client

See Also:


198
199
200
# File 'lib/parse/client.rb', line 198

def setup(opts = {})
  @clients[:default] = self.new(opts, &Proc.new)
end

Instance Method Details

#clear_cache!Object

Clear the client cache


322
323
324
# File 'lib/parse/client.rb', line 322

def clear_cache!
  self.cache.clear if self.cache.present?
end

#delete(uri, body = nil, headers = {}) ⇒ Parse::Response

Send a DELETE request.

Parameters:

  • uri (String)

    the uri path for this request.

  • body (Hash) (defaults to: nil)

    a hash that will be JSON encoded for the body of this request.

  • headers (Hash) (defaults to: {})

    additional headers to send in this request.

Returns:


523
524
525
# File 'lib/parse/client.rb', line 523

def delete(uri, body = nil, headers = {})
  request :delete, uri, body: body, headers: headers
end

#get(uri, query = nil, headers = {}) ⇒ Parse::Response

Send a GET request.

Parameters:

  • uri (String)

    the uri path for this request.

  • query (Hash) (defaults to: nil)

    the set of url query parameters.

  • headers (Hash) (defaults to: {})

    additional headers to send in this request.

Returns:


496
497
498
# File 'lib/parse/client.rb', line 496

def get(uri, query = nil, headers = {})
  request :get, uri, query: query, headers: headers
end

#post(uri, body = nil, headers = {}) ⇒ Parse::Response

Send a POST request.

Parameters:

  • body (Hash) (defaults to: nil)

    a hash that will be JSON encoded for the body of this request.

  • uri (String)

    the uri path for this request.

  • headers (Hash) (defaults to: {})

    additional headers to send in this request.

Returns:


505
506
507
# File 'lib/parse/client.rb', line 505

def post(uri, body = nil, headers = {} )
  request :post, uri, body: body, headers: headers
end

#put(uri, body = nil, headers = {}) ⇒ Parse::Response

Send a PUT request.

Parameters:

  • uri (String)

    the uri path for this request.

  • body (Hash) (defaults to: nil)

    a hash that will be JSON encoded for the body of this request.

  • headers (Hash) (defaults to: {})

    additional headers to send in this request.

Returns:


514
515
516
# File 'lib/parse/client.rb', line 514

def put(uri, body = nil, headers = {})
  request :put, uri, body: body, headers: headers
end

#request(method, uri = nil, body: nil, query: nil, headers: nil, opts: {}) ⇒ Parse::Response

Send a REST API request to the server. This is the low-level API used for all requests to the Parse server with the provided options. Every request sent to Parse through the client goes through the configured set of middleware that can be modified by applying different headers or specific options. This method supports retrying requests a few times when a ServiceUnavailableError is raised.

Parameters:

  • method (Symbol)

    The method type of the HTTP request (ex. :get, :post).

    • This parameter can also be a Request object.

  • uri (String) (defaults to: nil)

    the url path. It should not be an absolute url.

  • body (Hash)

    the body of the request.

  • query (Hash)

    the set of url query parameters to use in a GET request.

  • headers (Hash)

    additional headers to apply to this request.

  • opts (Hash)

    a set of options to pass through the middleware stack.

    • :cache [Integer] the number of seconds to cache this specific request. If set to `false`, caching will be disabled completely all together, which means even if a cached response exists, it will not be used.

    • :use_master_key [Boolean] whether this request should send the master key, if it was configured with Parse.setup. By default, if a master key was configured, all outgoing requests will contain it in the request header. Default `true`.

    • :session_token [String] The session token to send in this request. This disables sending the master key in the request, and sends this request with the credentials provided by the session_token.

    • :retry [Integer] The number of retrties to perform if the service is unavailable. Set to false to disable the retry mechanism. When performing request retries, the client will sleep for a number of seconds (RETRY_DELAY) between requests. The default value is DEFAULT_RETRIES.

Returns:

Raises:

  • Parse::Error::AuthenticationError when HTTP response status is 401 or 403

  • Parse::Error::TimeoutError when HTTP response status is 400 or 408, and the Parse code is 143 or Response::ERROR_TIMEOUT.

  • Parse::Error::ConnectionError when HTTP response status is 404 is not an object not found error.

    • This will also be raised if after retrying a request a number of times has finally failed.

  • Parse::Error::ProtocolError when HTTP response status is 405 or 406

  • Parse::Error::ServiceUnavailableError when HTTP response status is 500 or 503.

  • Parse::Error::ServerError when the Parse response code is less than 100

  • Parse::Error::RequestLimitExceededError when the Parse response code is Response::ERROR_EXCEEDED_BURST_LIMIT.

    • This usually means you have exceeded the burst limit on requests, which will mean you will be throttled for the next 60 seconds.

  • Parse::Error::InvalidSessionTokenError when the Parse response code is 209.

    • This means the session token that was sent in the request seems to be invalid.

See Also:


373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
# File 'lib/parse/client.rb', line 373

def request(method, uri = nil, body: nil, query: nil, headers: nil, opts: {})
  _retry_count ||= self.retry_limit

  if opts[:retry] == false
    _retry_count = 0
  elsif opts[:retry].to_i > 0
    _retry_count = opts[:retry]
  end

  headers ||= {}
  # if the first argument is a Parse::Request object, then construct it
  _request = nil
  if method.is_a?(Request)
    _request     = method
    method       = _request.method
    uri        ||= _request.path
    query      ||= _request.query
    body       ||= _request.body
    headers.merge! _request.headers
  else
    _request = Parse::Request.new(method, uri, body: body, headers: headers, opts: opts)
  end

  # http method
  method = method.downcase.to_sym
  # set the User-Agent
  headers[USER_AGENT_HEADER] = USER_AGENT_VERSION

  if opts[:cache] == false
    headers[Parse::Middleware::Caching::CACHE_CONTROL] = "no-cache"
  elsif opts[:cache].is_a?(Numeric)
    # specify the cache duration of this request
    headers[Parse::Middleware::Caching::CACHE_EXPIRES_DURATION] = opts[:cache].to_s
  end

  if opts[:use_master_key] == false
    headers[Parse::Middleware::Authentication::DISABLE_MASTER_KEY] = "true"
  end

  token = opts[:session_token]
  if token.present?
    token = token.session_token if token.respond_to?(:session_token)
    headers[Parse::Middleware::Authentication::DISABLE_MASTER_KEY] = "true"
    headers[Parse::Protocol::SESSION_TOKEN] = token
  end

  #if it is a :get request, then use query params, otherwise body.
  params = (method == :get ? query : body) || {}
  # if the path does not start with the '/1/' prefix, then add it to be nice.
  # actually send the request and return the body
  response_env = @conn.send(method, uri, params, headers)
  response = response_env.body
  response.request = _request

  case response.http_status
  when 401, 403
    warn "[Parse:AuthenticationError] #{response}"
    raise Parse::Error::AuthenticationError, response
  when 400, 408
    if response.code == Parse::Response::ERROR_TIMEOUT || response.code == 143 #"net/http: timeout awaiting response headers"
      warn "[Parse:TimeoutError] #{response}"
      raise Parse::Error::TimeoutError, response
    end
  when 404
    unless response.object_not_found?
      warn "[Parse:ConnectionError] #{response}"
      raise Parse::Error::ConnectionError, response
    end
  when 405, 406
    warn "[Parse:ProtocolError] #{response}"
    raise Parse::Error::ProtocolError, response
  when 429 # Request over the throttle limit
    warn "[Parse:RequestLimitExceededError] #{response}"
    raise Parse::Error::RequestLimitExceededError, response
  when 500, 503
    warn "[Parse:ServiceUnavailableError] #{response}"
    raise Parse::Error::ServiceUnavailableError, response
  end

  if response.error?
    if response.code <= Parse::Response::ERROR_SERVICE_UNAVAILABLE
      warn "[Parse:ServiceUnavailableError] #{response}"
      raise Parse::Error::ServiceUnavailableError, response
    elsif response.code <= 100
      warn "[Parse:ServerError] #{response}"
      raise Parse::Error::ServerError, response
    elsif response.code == Parse::Response::ERROR_EXCEEDED_BURST_LIMIT
      warn "[Parse:RequestLimitExceededError] #{response}"
      raise Parse::Error::RequestLimitExceededError, response
    elsif response.code == 209 # Error 209: invalid session token
      warn "[Parse:InvalidSessionTokenError] #{response}"
      raise Parse::Error::InvalidSessionTokenError, response
    end
  end

  response
rescue Parse::Error::RequestLimitExceededError, Parse::Error::ServiceUnavailableError => e
  if _retry_count > 0
    warn "[Parse:Retry] Retries remaining #{_retry_count} : #{response.request}"
    _retry_count -= 1
    backoff_delay = RETRY_DELAY * (self.retry_limit - _retry_count)
    _retry_delay = [0,RETRY_DELAY, backoff_delay].sample
    sleep _retry_delay if _retry_delay > 0
    retry
  end
  raise
rescue Faraday::Error::ClientError, Net::OpenTimeout => e
  if _retry_count > 0
    warn "[Parse:Retry] Retries remaining #{_retry_count} : #{_request}"
    _retry_count -= 1
    backoff_delay = RETRY_DELAY * (self.retry_limit - _retry_count)
    _retry_delay = [0,RETRY_DELAY, backoff_delay].sample
    sleep _retry_delay if _retry_delay > 0
    retry
  end
  raise Parse::Error::ConnectionError, "#{_request} : #{e.class} - #{e.message}"
end

#send_request(req) ⇒ Parse::Response

Send a Request object.

Parameters:

Returns:

Raises:

  • ArgumentError if req is not of type Parse::Request.


531
532
533
534
# File 'lib/parse/client.rb', line 531

def send_request(req) #Parse::Request object
  raise ArgumentError, "Object not of Parse::Request type." unless req.is_a?(Parse::Request)
  request req.method, req.path, req.body, req.headers
end

#url_prefixString

Returns the url prefix of the Parse Server url.

Returns:

  • (String)

    the url prefix of the Parse Server url.


317
318
319
# File 'lib/parse/client.rb', line 317

def url_prefix
  @conn.url_prefix
end