Class: SwiftypeEnterprise::Client

Inherits:
Object
  • Object
show all
Includes:
ContentSourceDocuments, Request
Defined in:
lib/swiftype-enterprise/client.rb

Overview

API client for the Swiftype Enterprise API.

Defined Under Namespace

Modules: ContentSourceDocuments

Constant Summary collapse

DEFAULT_TIMEOUT = 
15

Class Method Summary collapse

Instance Method Summary collapse

Methods included from ContentSourceDocuments

#destroy_documents, #index_documents

Methods included from Request

#delete, #get, #post, #put, #request

Constructor Details

#initialize(options = {}) ⇒ Client

Create a new SwiftypeEnterprise::Client client

Parameters:

  • options (Hash) (defaults to: {}) —

    a hash of configuration options that will override what is set on the SwiftypeEnterprise class.

Options Hash (options):

  • :access_token (String) —

    an Access Token to use for this client

  • :overall_timeout (Numeric) —

    overall timeout for requests in seconds (default: 15s)

  • :open_timeout (Numeric) —

    the number of seconds Net::HTTP (default: 15s) will wait while opening a connection before raising a Timeout::Error



24
25
26
 
# File 'lib/swiftype-enterprise/client.rb', line 24

def initialize(options = {})
  @options = options
end

Class Method Details

.configure(&block) ⇒ Object 



13
14
15
 
# File 'lib/swiftype-enterprise/client.rb', line 13

def self.configure(&block)
  SwiftypeEnterprise.configure &block
end

Instance Method Details

#access_token ⇒ Object 



28
29
30
 
# File 'lib/swiftype-enterprise/client.rb', line 28

def access_token
  @options[:access_token] || SwiftypeEnterprise.access_token
end

#open_timeout ⇒ Object 



32
33
34
 
# File 'lib/swiftype-enterprise/client.rb', line 32

def open_timeout
  @options[:open_timeout] || DEFAULT_TIMEOUT
end

#overall_timeout ⇒ Object 



36
37
38
 
# File 'lib/swiftype-enterprise/client.rb', line 36

def overall_timeout
  (@options[:overall_timeout] || DEFAULT_TIMEOUT).to_f
end