Module: Delphix

Includes:
Utils
Defined in:
lib/delphix.rb,
lib/delphix/utils.rb,
lib/delphix/version.rb,
lib/delphix/web_client.rb,
lib/delphix/web_request.rb,
lib/delphix/web_response.rb

Overview

Author: Stefano Harding <[email protected]> License: Apache License, Version 2.0 Copyright: © 2014-2015 Stefano Harding

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Defined Under Namespace

Modules: ClassMethods, InstanceMethods, Utils, Version Classes: WebClient, WebRequest, WebResponse

Constant Summary collapse

API_ENDPOINT = 
'/resources/json/delphix'
HTTP_HEADERS = 
{
  'Accept'       =>  'application/json; charset=UTF-8',
  'Content-Type' =>  'application/json; charset=UTF-8',
  'User-Agent'   =>  'Delphix-Ruby-Client/1.0.0'
}
VERSION = 
Delphix::Version.string
@@timeout =

Default timeout value in seconds.

10
@@default_headers =

Default headers

{}

Class Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Utils

#request_id, #utc_httpdate

Class Attribute Details

.api_passwd ⇒ String

Returns password for authentication.

Returns:

  • (String) —

    password for authentication



90
91
92
 
# File 'lib/delphix.rb', line 90

def api_passwd
  @api_passwd
end

.api_user ⇒ String

Returns username to authenticate with.

Returns:

  • (String) —

    username to authenticate with



87
88
89
 
# File 'lib/delphix.rb', line 87

def api_user
  @api_user
end

.api_version ⇒ Hash

Returns containing the major, minor and micro version numbers.

Returns:

  • (Hash) —

    containing the major, minor and micro version numbers.



81
82
83
 
# File 'lib/delphix.rb', line 81

def api_version
  @api_version
end

.last_request ⇒ Hash

Returns retruns the last request.

Returns:

  • (Hash) —

    retruns the last request



68
69
70
 
# File 'lib/delphix.rb', line 68

def last_request
  @last_request
end

.last_response ⇒ Hash

Returns retruns the last response.

Returns:

  • (Hash) —

    retruns the last response



71
72
73
 
# File 'lib/delphix.rb', line 71

def last_response
  @last_response
end

.server ⇒ String

Returns Delphix server address.

Returns:

  • (String) —

    Delphix server address



84
85
86
 
# File 'lib/delphix.rb', line 84

def server
  @server
end

.session ⇒ Hash, ...

Returns:

  • (Hash) —

    retruns current session state

  • (#code) —

    the response code from Delphix engine

  • (#headers) —

    beautified with symbols and underscores

  • (#body) —

    parsed response body

  • (#raw_body) —

    un-parsed response body



78
79
80
 
# File 'lib/delphix.rb', line 78

def session
  @session
end

.verbose ⇒ Nothing

Returns enables verbosity.

Returns:

  • (Nothing) —

    enables verbosity



93
94
95
 
# File 'lib/delphix.rb', line 93

def verbose
  @verbose
end

Class Method Details

.api_url(resource = nil) ⇒ URL

Returns the API endpoint for a given resource namespace by combining the server address with the appropriate HTTP headers.

Parameters:

  • resource (Resource) (defaults to: nil) —

    namespace

Returns:

  • (URL) —

    return the URL for the API endpoint



104
105
106
 
# File 'lib/delphix.rb', line 104

def self.api_url(resource = nil)
  'http://' + @server + resource
end

.clear_default_headers ⇒ Hash

Returns The HTTP headers sent with a POST/GET/DELETE.

Returns:

  • (Hash) —

    The HTTP headers sent with a POST/GET/DELETE.



89
90
91
 
# File 'lib/delphix/web_client.rb', line 89

def self.clear_default_headers
  @@default_headers = {}
end

.cookies ⇒ Hash

Establish a session with the Delphix engine and return an identifier through browser cookies. This session will be reused in subsequent calls, the same session credentials and state are preserved without requiring a re-authentication call. Sessions do not persisit between incovations.

Returns:

  • (Hash) —

    cookies containing the new session cookies



122
123
124
125
126
 
# File 'lib/delphix.rb', line 122

def self.cookies
  @resp ||= Delphix.post session_url,
    type: 'APISession', version: @api_version
  @resp.cookies
end

.default_header(name, value) ⇒ Hash

Returns The result of the key/value pair.

Parameters:

  • name (String, Symbol) —

    A string or symbol used to identify the key portion of the HTTP headers.

  • value (String, Symbol, Array) —

    A string, symbol or array containing the values of the HTTP header.

Returns:

  • (Hash) —

    The result of the key/value pair.



82
83
84
 
# File 'lib/delphix/web_client.rb', line 82

def self.default_header(name, value)
  @@default_headers[name] = value
end

.login(user = @api_user, passwd = @api_passwd) ⇒ Fixnum, ...

Authenticates the session so that API calls can be made. Only supports basic password authentication.

Parameters:

  • user (String) (defaults to: @api_user) —

    user name to authenticate with

  • passwd (String) (defaults to: @api_passwd) —

    password to authenticate with

Returns:

  • (Fixnum, #code) —

    the response code from Delphix engine

  • (Hash, #headers) —

    headers, beautified with symbols and underscores

  • (Hash, #body) —

    body parsed response body where applicable (JSON responses are parsed to Objects/Associative Arrays)

  • (Hash, #raw_body) —

    raw_body un-parsed response body



147
148
149
150
 
# File 'lib/delphix.rb', line 147

def self.(user = @api_user, passwd = @api_passwd)
  Delphix.post ,
    type: 'LoginRequest', username: user, password: passwd
end

.timeout(seconds) ⇒ undefined

Parameters:

  • seconds (Integer) —

    Set the number of seconds to wait for an HTTP timeout.

Returns:

  • (undefined) 


98
99
100
 
# File 'lib/delphix/web_client.rb', line 98

def self.timeout(seconds)
  @@timeout = seconds
end

Instance Method Details

#alert ⇒ String

A helper method to return the URL for the resource by using the resource_url shorthand.

Returns:

  • (String) —

    The API path to alert.



237
238
239
240
241
242
243
244
 
# File 'lib/delphix.rb', line 237

[ :alert, :container, :database, :environment, :group, :host, :job,
  :login, :policy, :repository, :session, :snapshot, :source,
  :sourceconfig, :template, :timeflow, :user
].each do |name|
  define_singleton_method(name.to_s + '_url') do
    api_url('/resources/json/delphix/' + name.to_s)
  end
end

#container ⇒ String

A helper method to return the URL for the resource by using the resource_url shorthand.

Returns:

  • (String) —

    The API path to container.



237
238
239
240
241
242
243
244
 
# File 'lib/delphix.rb', line 237

[ :alert, :container, :database, :environment, :group, :host, :job,
  :login, :policy, :repository, :session, :snapshot, :source,
  :sourceconfig, :template, :timeflow, :user
].each do |name|
  define_singleton_method(name.to_s + '_url') do
    api_url('/resources/json/delphix/' + name.to_s)
  end
end

#database ⇒ String

A helper method to return the URL for the resource by using the resource_url shorthand.

Returns:

  • (String) —

    The API path to database.



237
238
239
240
241
242
243
244
 
# File 'lib/delphix.rb', line 237

[ :alert, :container, :database, :environment, :group, :host, :job,
  :login, :policy, :repository, :session, :snapshot, :source,
  :sourceconfig, :template, :timeflow, :user
].each do |name|
  define_singleton_method(name.to_s + '_url') do
    api_url('/resources/json/delphix/' + name.to_s)
  end
end

#environment ⇒ String

A helper method to return the URL for the resource by using the resource_url shorthand.

Returns:

  • (String) —

    The API path to environment.



237
238
239
240
241
242
243
244
 
# File 'lib/delphix.rb', line 237

[ :alert, :container, :database, :environment, :group, :host, :job,
  :login, :policy, :repository, :session, :snapshot, :source,
  :sourceconfig, :template, :timeflow, :user
].each do |name|
  define_singleton_method(name.to_s + '_url') do
    api_url('/resources/json/delphix/' + name.to_s)
  end
end

#group ⇒ String

A helper method to return the URL for the resource by using the resource_url shorthand.

Returns:

  • (String) —

    The API path to group.



237
238
239
240
241
242
243
244
 
# File 'lib/delphix.rb', line 237

[ :alert, :container, :database, :environment, :group, :host, :job,
  :login, :policy, :repository, :session, :snapshot, :source,
  :sourceconfig, :template, :timeflow, :user
].each do |name|
  define_singleton_method(name.to_s + '_url') do
    api_url('/resources/json/delphix/' + name.to_s)
  end
end

#host ⇒ String

A helper method to return the URL for the resource by using the resource_url shorthand.

Returns:

  • (String) —

    The API path to host.



237
238
239
240
241
242
243
244
 
# File 'lib/delphix.rb', line 237

[ :alert, :container, :database, :environment, :group, :host, :job,
  :login, :policy, :repository, :session, :snapshot, :source,
  :sourceconfig, :template, :timeflow, :user
].each do |name|
  define_singleton_method(name.to_s + '_url') do
    api_url('/resources/json/delphix/' + name.to_s)
  end
end

#job ⇒ String

A helper method to return the URL for the resource by using the resource_url shorthand.

Returns:

  • (String) —

    The API path to job.



237
238
239
240
241
242
243
244
 
# File 'lib/delphix.rb', line 237

[ :alert, :container, :database, :environment, :group, :host, :job,
  :login, :policy, :repository, :session, :snapshot, :source,
  :sourceconfig, :template, :timeflow, :user
].each do |name|
  define_singleton_method(name.to_s + '_url') do
    api_url('/resources/json/delphix/' + name.to_s)
  end
end

#login ⇒ String

A helper method to return the URL for the resource by using the resource_url shorthand.

Returns:

  • (String) —

    The API path to login.



237
238
239
240
241
242
243
244
 
# File 'lib/delphix.rb', line 237

[ :alert, :container, :database, :environment, :group, :host, :job,
  :login, :policy, :repository, :session, :snapshot, :source,
  :sourceconfig, :template, :timeflow, :user
].each do |name|
  define_singleton_method(name.to_s + '_url') do
    api_url('/resources/json/delphix/' + name.to_s)
  end
end

#method ⇒ Fixnum, ...

Define the #get, #post, and #delete helper methods for sending HTTP requests to the Delphix engine. You shouldn’t need to use these methods directly, but they can be useful for debugging.

The following HTTP methods are supported by the Delphix Appliance:

 GET - Retrieve data from the server where complex input is not needed.
       All GET requests are guaranteed to be read-only, but not all
       read-only requests are required to use GET. Simple input
       (strings, number, boolean values) can be passed as query
       parameters.
POST - Issue a read/write operation, or make a read-only call that
       requires complex input. The optional body of the call is
       expressed as JSON.
DELETE - Delete an object on the system. For languages that don't provide
       a native wrapper for DELETE, or for delete operations with
       optional input, all delete operations can also be invoked as POST
       to the same URL with /delete appended to it.

Each method returns a hash that responds to #code, #headers, #body and #raw_body obtained from parsing the JSON object in the response body.

API request responses are parsed to Objects/Associative Arrays)

Parameters:

  • url (String<URL>) —

    url the url of where to send the request

  • parameters (Hash{Symbol => String}) —

    key-value data of the HTTP

  • block (Block) —

    block to execute when the request returns

Returns:

  • (Fixnum, #code) —

    the response code from Delphix engine

  • (Hash, #headers) —

    headers, beautified with symbols and underscores

  • (Hash, #body) —

    body parsed response body where applicable (JSON

  • (Hash, #raw_body) —

    raw_body un-parsed response body



135
136
137
138
139
140
 
# File 'lib/delphix/web_client.rb', line 135

[:get, :post, :delete].each do |method|
  define_singleton_method(method) do |url, parameters = {}, &callback|
    WebClient.request(method.to_sym, url, @@default_headers,
      parameters.to_json, @@timeout, &callback)
  end
end

#policy ⇒ String

A helper method to return the URL for the resource by using the resource_url shorthand.

Returns:

  • (String) —

    The API path to policy.



237
238
239
240
241
242
243
244
 
# File 'lib/delphix.rb', line 237

[ :alert, :container, :database, :environment, :group, :host, :job,
  :login, :policy, :repository, :session, :snapshot, :source,
  :sourceconfig, :template, :timeflow, :user
].each do |name|
  define_singleton_method(name.to_s + '_url') do
    api_url('/resources/json/delphix/' + name.to_s)
  end
end

#repository ⇒ String

A helper method to return the URL for the resource by using the resource_url shorthand.

Returns:

  • (String) —

    The API path to repository.



237
238
239
240
241
242
243
244
 
# File 'lib/delphix.rb', line 237

[ :alert, :container, :database, :environment, :group, :host, :job,
  :login, :policy, :repository, :session, :snapshot, :source,
  :sourceconfig, :template, :timeflow, :user
].each do |name|
  define_singleton_method(name.to_s + '_url') do
    api_url('/resources/json/delphix/' + name.to_s)
  end
end

#session ⇒ String

A helper method to return the URL for the resource by using the resource_url shorthand.

Returns:

  • (String) —

    The API path to session.



237
238
239
240
241
242
243
244
 
# File 'lib/delphix.rb', line 237

[ :alert, :container, :database, :environment, :group, :host, :job,
  :login, :policy, :repository, :session, :snapshot, :source,
  :sourceconfig, :template, :timeflow, :user
].each do |name|
  define_singleton_method(name.to_s + '_url') do
    api_url('/resources/json/delphix/' + name.to_s)
  end
end

#snapshot ⇒ String

A helper method to return the URL for the resource by using the resource_url shorthand.

Returns:

  • (String) —

    The API path to snapshot.



237
238
239
240
241
242
243
244
 
# File 'lib/delphix.rb', line 237

[ :alert, :container, :database, :environment, :group, :host, :job,
  :login, :policy, :repository, :session, :snapshot, :source,
  :sourceconfig, :template, :timeflow, :user
].each do |name|
  define_singleton_method(name.to_s + '_url') do
    api_url('/resources/json/delphix/' + name.to_s)
  end
end

#source ⇒ String

A helper method to return the URL for the resource by using the resource_url shorthand.

Returns:

  • (String) —

    The API path to source.



237
238
239
240
241
242
243
244
 
# File 'lib/delphix.rb', line 237

[ :alert, :container, :database, :environment, :group, :host, :job,
  :login, :policy, :repository, :session, :snapshot, :source,
  :sourceconfig, :template, :timeflow, :user
].each do |name|
  define_singleton_method(name.to_s + '_url') do
    api_url('/resources/json/delphix/' + name.to_s)
  end
end

#sourceconfig ⇒ String

A helper method to return the URL for the resource by using the resource_url shorthand.

Returns:

  • (String) —

    The API path to sourceconfig.



237
238
239
240
241
242
243
244
 
# File 'lib/delphix.rb', line 237

[ :alert, :container, :database, :environment, :group, :host, :job,
  :login, :policy, :repository, :session, :snapshot, :source,
  :sourceconfig, :template, :timeflow, :user
].each do |name|
  define_singleton_method(name.to_s + '_url') do
    api_url('/resources/json/delphix/' + name.to_s)
  end
end

#template ⇒ String

A helper method to return the URL for the resource by using the resource_url shorthand.

Returns:

  • (String) —

    The API path to template.



237
238
239
240
241
242
243
244
 
# File 'lib/delphix.rb', line 237

[ :alert, :container, :database, :environment, :group, :host, :job,
  :login, :policy, :repository, :session, :snapshot, :source,
  :sourceconfig, :template, :timeflow, :user
].each do |name|
  define_singleton_method(name.to_s + '_url') do
    api_url('/resources/json/delphix/' + name.to_s)
  end
end

#timeflow ⇒ String

A helper method to return the URL for the resource by using the resource_url shorthand.

Returns:

  • (String) —

    The API path to timeflow.



237
238
239
240
241
242
243
244
 
# File 'lib/delphix.rb', line 237

[ :alert, :container, :database, :environment, :group, :host, :job,
  :login, :policy, :repository, :session, :snapshot, :source,
  :sourceconfig, :template, :timeflow, :user
].each do |name|
  define_singleton_method(name.to_s + '_url') do
    api_url('/resources/json/delphix/' + name.to_s)
  end
end

#user ⇒ String

A helper method to return the URL for the resource by using the resource_url shorthand.

Returns:

  • (String) —

    The API path to user.



237
238
239
240
241
242
243
244
 
# File 'lib/delphix.rb', line 237

[ :alert, :container, :database, :environment, :group, :host, :job,
  :login, :policy, :repository, :session, :snapshot, :source,
  :sourceconfig, :template, :timeflow, :user
].each do |name|
  define_singleton_method(name.to_s + '_url') do
    api_url('/resources/json/delphix/' + name.to_s)
  end
end