Class: Emarsys::DataObject

Inherits:

Object

• Object
• Emarsys::DataObject

Defined in:

lib/emarsys/data_object.rb

Direct Known Subclasses

Condition, Contact, ContactList, Email, EmailCategory, EmailLaunchStatus, EmailStatusCode, Event, Export, Field, File, Folder, Form, Language, Segment, Source

Class Method Summary

• .delete(account, method_name, params) ⇒ Hash

  Make a HTTP DELETE request.

• .get(account, method_name, params) ⇒ Hash

  Make a HTTP GET request.

• .parameterize_params(params) ⇒ String

  Custom Parameterizer for Emarsys.

• .post(account, method_name, params) ⇒ Hash

  Make a HTTP POST request.

• .put(account, method_name, params) ⇒ Hash

  Make a HTTP PUT request.

Instance Method Summary

• #request(account, http_verb, method_name, params) ⇒ Hash

  Make a HTTP request.

Class Method Details

.delete(account, method_name, params) ⇒ Hash

Make a HTTP DELETE request

Parameters:

• account (Symbol) —

  Configuration account to use

• method_name (String) —

  The path, relative to Emarsys.api_endpoint

• params (Hash) —

  custom params hash

Returns:

• (Hash)

# File 'lib/emarsys/data_object.rb', line 48

def delete(account, method_name, params)
  self.new.request account, 'delete', method_name, params
end

.get(account, method_name, params) ⇒ Hash

Make a HTTP GET request

Parameters:

• account (Symbol) —

  Configuration account to use

• method_name (String) —

  The path, relative to Emarsys.api_endpoint

• params (Hash) —

  custom params hash

Returns:

• (Hash)

# File 'lib/emarsys/data_object.rb', line 14

def get(account, method_name, params)
  if params.empty?
    self.new.request account, 'get', method_name, params
  else
    self.new.request account, 'get', [method_name, parameterize_params(params)].join("/"), {}
  end
end

.parameterize_params(params) ⇒ String

Custom Parameterizer for Emarsys

Parameters:

• params (Hash) —

  custom params hash

Returns:

• (String) —

  {key1 => value1, key2 => value2 is returned as ?key1=value1&key2=value2

# File 'lib/emarsys/data_object.rb', line 56

def parameterize_params(params)
  '?' + params.map{|k, v| "#{url_encode(k)}=#{url_encode(v)}"}.join('&')
end

.post(account, method_name, params) ⇒ Hash

Make a HTTP POST request

Parameters:

• account (Symbol) —

  Configuration account to use

• method_name (String) —

  The path, relative to Emarsys.api_endpoint

• params (Hash) —

  custom params hash

Returns:

• (Hash)

# File 'lib/emarsys/data_object.rb', line 28

def post(account, method_name, params)
  self.new.request account, 'post', method_name, params
end

.put(account, method_name, params) ⇒ Hash

Make a HTTP PUT request

Parameters:

• account (Symbol) —

  Configuration account to use

• method_name (String) —

  The path, relative to Emarsys.api_endpoint

• params (Hash) —

  custom params hash

Returns:

• (Hash)

# File 'lib/emarsys/data_object.rb', line 38

def put(account, method_name, params)
  self.new.request account, 'put', method_name, params
end

Instance Method Details

#request(account, http_verb, method_name, params) ⇒ Hash

Make a HTTP request

Parameters:

• account (Symbol) —

  Configuration account to use

• http_verb (String) —

  Http method

• method_name (String) —

  The path, relative to Emarsys.api_endpoint

• params (Hash) —

  custom params hash

Returns:

• (Hash)

# File 'lib/emarsys/data_object.rb', line 76

def request(account, http_verb, method_name, params)
  response = Emarsys::Request.new(account, http_verb, method_name, params).send_request
end