Class: Mints::Contact

Inherits:
Object
  • Object
show all
Includes:
MintsHelper
Defined in:
lib/contact.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from MintsHelper

#correct_json, #data_transform, #get_query_results

Constructor Details

#initialize(host, api_key, session_token = nil, contact_token_id = nil, debug = false) ⇒ Contact

Initialize.

Class constructor

Parameters

host

(String) – It’s the visitor IP.

api_key

(String) – Mints instance api key.

contact_token_id

(Integer) – Cookie ‘mints_contact_id’ value (mints_contact_token).

Return

Returns a Contact object


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

def initialize(host, api_key, session_token = nil, contact_token_id = nil, debug = false)
  @client = Mints::Client.new(host, api_key, "contact", session_token, contact_token_id, debug)
end

Instance Attribute Details

#client ⇒ Object (readonly)

Returns the value of attribute client.


6
7
8
 
# File 'lib/contact.rb', line 6

def client
  @client
end

Instance Method Details

#change_password(data) ⇒ Object

Change Password.

Change password without email. To change the password a contact must be logged.

Parameters:

data

(Hash) – A new password allocated in a data key.

Example

@mints_contact.("email@example.com", "password")
data = { "password": "123456" }
@data = @mints_contact.change_password(data)


117
118
119
 
# File 'lib/contact.rb', line 117

def change_password(data)
  return @client.raw("post", "/contacts/change-password", nil, data_transform(data))
end

#login(email, password) ⇒ Object

Login.

Starts a contact session.

Parameters:

email

(String) – The email that will be logged.

password

(String) – The password of the email.

Example

@mints_contact.("email@example.com", "password")


32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/contact.rb', line 32

def (email, password)
  data = {
    email: email,
    password: password
  }
  response = @client.raw("post", "/contacts/login", nil, {data: data}.to_json)
  if response.key? "session_token"
    @client.session_token = response["session_token"]
  end
  return response
end

#logout ⇒ Object

Logout.

Ends a contact session previously logged.

Example

@mints_contact.("email@example.com", "password")
@mints_contact.logout


98
99
100
101
102
103
104
 
# File 'lib/contact.rb', line 98

def logout
  response = @client.raw("post", "/contacts/logout") if session_token?
  if response["success"]
    @client.session_token = nil
  end 
  return response
end

#magic_link_login(token) ⇒ Object

Magic Link Login.

Starts a contact session with a token received in the contact email. The token will be received by send_magic_link method.

Parameters:

token

(String) – The email token that will be used to log in.

Example

@mints_contact.(
  "d8618c6d-a165-41cb-b3ec-d053cbf30059:zm54HtRdfHED8dpILZpjyqjPIceiaXNLfOklqM92fveBS0nDtyPYBlI4CPlPe3zq"
)


55
56
57
58
59
60
61
 
# File 'lib/contact.rb', line 55

def (token)
  response = @client.raw("get", "/contacts/magic-link-login/#{token}", nil, '/api/v1')
  if response.key? "session_token"
    @client.session_token = response["session_token"]
  end
  return response
end

#me(options = nil) ⇒ Object

Me.

Get contact logged info.

First Example

@mints_contact.me

Second Example

options = { 
  "attributes": true,
  "taxonomies": true
} 
@data = @mints_contact.me(options)


174
175
176
 
# File 'lib/contact.rb', line 174

def me(options = nil)
  return @client.raw("get", "/contacts/me", options)
end

#oauth_login(data) ⇒ Object

OAuth Login.

Login a contact using oauth.


157
158
159
 
# File 'lib/contact.rb', line 157

def (data)
  return @client.raw("post", "/contacts/oauth-login", nil, data)
end

#recover_password(data) ⇒ Object

Recover Password.

Send a email that contains a token to a contact. That token will be used in reset_password to establish a new password.

Parameters:

data

(Hash) – It’s a data key where will be hosted the destination email.

Example

data = { "email": "email@example.com" }
@mints_contact.recover_password(data)


131
132
133
 
# File 'lib/contact.rb', line 131

def recover_password(data)
  return @client.raw("post", "/contacts/recover-password", nil, data_transform(data))
end

#register(data) ⇒ Object

Register.

Register a contact.

Parameters:

data

(Hash) – It’s the register data.

Example

data = {
  "email": "email@example.com",
  "given_name": "Given Name",
  "last_name": "Last Name",
  "password": "password"
}
@mints_contact.register(data);


221
222
223
 
# File 'lib/contact.rb', line 221

def register(data)
  return @client.raw("post", "/contacts/register", nil, data_transform(data))
end

#reset_password(data) ⇒ Object

Reset Password.

Reset password using a token. The token is obtained by recover_password method.

Parameters:

data

(Hash) – It’s a set of data which contains all the information to reset a contact password.

Example

data = { 
  "email": "email@example.com", 
  "password": "password", 
  "password_confirmation": "password", 
  "token": "644aa3aa0831d782cc42e42b11aedea9a2234389af4f429a8d96651295ecfa09" 
}
@mints_contact.reset_password(data)


150
151
152
 
# File 'lib/contact.rb', line 150

def reset_password(data)
  return @client.raw("post", "/contacts/reset-password", nil, data_transform(data))
end

#send_magic_link(email, template_slug, redirectUrl = '', lifeTime = 1440, maxVisits = nil) ⇒ Object

Send magic link to contact by email. That magic link will be used in magic_link_login method.

Parameters:

email

(String) – Contact’s email.

template_slug

(String) – Email template’s slug to be used in the email.

redirectUrl

(String) – Url to be redirected in the implemented page.

lifeTime

(Integer) – Maximum time of use in minutes.

maxVisits

(Integer) – The maximum number of uses of a token.

First Example

@mints_contact.send_magic_link("email@example.com", "template_slug")

Second Example

@mints_contact.send_magic_link("email@example.com", "template_slug", "", 1440, 3)


79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/contact.rb', line 79

def send_magic_link(email, template_slug, redirectUrl = '', lifeTime = 1440, maxVisits = nil)
  data = {
    email: email,
    lifeTime: lifeTime,
    maxVisits: maxVisits,
    redirectUrl: redirectUrl,
    templateId: template_slug
  }
  response = @client.raw("post", "/contacts/magic-link", nil, { data: data }.to_json, '/api/v1')
  return response
end

#status ⇒ Object

Status.

Get contact logged status.

Example

@mints_contact.status


184
185
186
 
# File 'lib/contact.rb', line 184

def status
  return @client.raw("get", "/contacts/status")
end

#update(data) ⇒ Object

Update.

Update logged contact attributes.

Parameters:

data

(Hash) – It’s the data to update with a session active.

Example

@mints_contact.("email@example.com", "password")
data = {
  "given_name": "Given Name", 
  "last_name": "Last Name"
}
@mints_contact.update(data)


202
203
204
 
# File 'lib/contact.rb', line 202

def update(data)
  return @client.raw("put", "/contacts/update", nil, data_transform(data))
end