Class: Mints::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(host, api_key, scope = nil, session_token = nil, debug = false) ⇒ Client

Returns a new instance of Client.



12
13
14
15
16
17
18
 
# File 'lib/client.rb', line 12

def initialize(host, api_key, scope = nil, session_token = nil, debug = false)
    @host = host
    @api_key = api_key
    @session_token = session_token
    @debug = debug
    self.set_scope(scope)
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(name, *args, &block) ⇒ Object 



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/client.rb', line 48

def method_missing(name, *args, &block)
  puts name
  name.to_s.include?("__") ? separator = "__" : separator = "_"        
  # split the name to identify their elements

  name_spplited = name.to_s.split(separator)
  # count the elments

  name_len = name_spplited.size
  # the action always be the first element

  action = name_spplited.first
  raise 'NoActionError' unless ['get', 'create', 'post', 'update', 'put'].include?(action)
  # the object always be the last element

  object = separator == "__" ? name_spplited.last.gsub("_","-") : name_spplited.last
  # get intermediate url elements

  route_array = []
  (name_len-1).times do |n|
      if n == 0 or n == name_len-1
        next
      end
      n = name_spplited[n]
      self.replacements().each do |object|
        n = n.gsub(object[:old_value], object[:new_value])
      end
      route_array.push n
  end
  route = route_array.join("/")
  
  
  slug = nil
  uri = Addressable::URI.new
  if action == "get"
    if args.first.class == Hash
      uri.query_values = args.first
    elsif args.first.class == String or Integer
      slug = args.first
      uri.query_values = args[1]
    end
    url = self.get_url(route, object, uri, slug)
    response = self.send("#{@scope}_#{action}", url)
  elsif action == "post" or action == "create"
    if args[1].class == Hash
      uri.query_values = args[1]
    end
    url = self.get_url(route, object, uri, slug)
    action = 'post'
    data = args[0]
    response = self.send("#{@scope}_#{action}", url, {data: data})
  elsif action == "put" or action == "update"
     if args.first.class == String or Integer
      slug = args.first
      uri.query_values = args[2]
    end
    url = self.get_url(route, object, uri, slug)
    action = 'put'
    id = args[0]
    data = args[1]
    response = self.send("#{@scope}_#{action}", "#{url}", {data: data})
  end

  if response.response.code == "404"
    raise 'NotFoundError'
  elsif response.response.code == "500"
    raise 'InternalServerError'  
  end
  return JSON.parse(response.body)        
end

Instance Attribute Details

#api_key ⇒ Object (readonly)

Returns the value of attribute api_key.



7
8
9
 
# File 'lib/client.rb', line 7

def api_key
  @api_key
end

#base_url ⇒ Object (readonly)

Returns the value of attribute base_url.



9
10
11
 
# File 'lib/client.rb', line 9

def base_url
  @base_url
end

#host ⇒ Object (readonly)

Returns the value of attribute host.



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

def host
  @host
end

#scope ⇒ Object (readonly)

Returns the value of attribute scope.



8
9
10
 
# File 'lib/client.rb', line 8

def scope
  @scope
end

#session_token ⇒ Object

Returns the value of attribute session_token.



10
11
12
 
# File 'lib/client.rb', line 10

def session_token
  @session_token
end

Instance Method Details

#contact_get(url) ⇒ Object

Start contact context



183
184
185
186
187
188
189
190
 
# File 'lib/client.rb', line 183

def contact_get(url)
  headers = {
    "ApiKey" => @api_key,
    "Accept" => "application/json"
  }
  headers["Authorization"] = "Bearer #{@session_token}" if @session_token
  return self.http_get(url, headers)
end

#contact_post(url, data) ⇒ Object 



192
193
194
195
196
197
198
199
 
# File 'lib/client.rb', line 192

def contact_post(url, data)
  headers = {
    "ApiKey" => @api_key,
    "Accept" => "application/json"
  }
  headers["Authorization"] = "Bearer #{@session_token}" if @session_token
  return self.http_post(url, headers, data)
end

#contact_put(url, data) ⇒ Object 



201
202
203
204
205
206
207
208
 
# File 'lib/client.rb', line 201

def contact_put(url, data)
  headers = {
    "ApiKey" => @api_key,
    "Accept" => "application/json"
  }
  headers["Authorization"] = "Bearer #{@session_token}" if @session_token
  return self.http_post(url, headers, data)
end

#get_url(route, object, uri, slug = nil) ⇒ Object 



114
115
116
117
118
119
120
 
# File 'lib/client.rb', line 114

def get_url(route, object, uri, slug = nil)
  if (slug)
    return "#{@host}#{@base_url}/#{route}/#{object}/#{slug}#{uri}"
  else
    return "#{@host}#{@base_url}/#{route}/#{object}#{uri}"
  end
end

#http_get(url, headers = nil) ⇒ Object

HTTTP CLIENTS ###### Simple HTTP GET



146
147
148
149
150
151
152
153
154
 
# File 'lib/client.rb', line 146

def http_get(url, headers = nil)
  if @debug
    puts "Url:"
    puts url
    puts "Headers:"
    puts headers
  end
  return headers ? HTTParty.get(url, :headers => headers) : HTTParty.get(url)
end

#http_post(url, headers = nil, data = nil) ⇒ Object

Simple HTTP POST



157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/client.rb', line 157

def http_post(url, headers = nil, data = nil)
  if @debug
    puts "Url:"
    puts url
    puts "Headers:"
    puts headers
    puts "Data:"
    puts data
  end
  return headers ? HTTParty.post(url, :headers=> headers, :body => data) : HTTParty.post(url, :body => data)  
end

#http_put(url, headers = nil, data = nil) ⇒ Object

Simple HTTP PUT



170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/client.rb', line 170

def http_put(url, headers = nil, data = nil)
  if @debug
    puts "Url:"
    puts url
    puts "Headers:"
    puts headers
    puts "Data:"
    puts data
  end
  return headers ? HTTParty.put(url, :headers=> headers, :body => data) : HTTParty.put(url, :body => data)
end

#public_get(url, headers = nil) ⇒ Object

End User Context



240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/client.rb', line 240

def public_get(url, headers = nil)
  h = {
    "Accept" => "application/json",
    "Content-Type" => "application/json",
    "ApiKey" => @api_key,
    "ContactToken" => @session_token
  }
  if headers
    headers.each do |k,v|
      h[k] = v
    end
  end
  self.http_get(url, h)
end

#public_post(url, headers = nil, data) ⇒ Object 



255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/client.rb', line 255

def public_post(url, headers = nil, data)
  h = {
    "Accept" => "application/json",
    "Content-Type" => "application/json",
    "ApiKey" => @api_key,
    "ContactToken" => @session_token
  }
  if headers
    headers.each do |k,v|
      h[k] = v
    end
  end
  self.http_post(url, h, data)
end

#public_put(url, headers = nil, data) ⇒ Object 



270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/client.rb', line 270

def public_put(url, headers = nil, data)
  h = {
    "Accept" => "application/json", 
    "Content-Type" => "application/json", 
    "ApiKey" => @api_key,
    "ContactToken" => @session_token
  }
  if headers
    headers.each do |k,v|
      h[k] = v
    end
  end
  self.http_put(url, h, data)
end

#raw(action, url, options = nil, data = nil, base_url = nil) ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/client.rb', line 20

def raw(action, url, options = nil, data = nil, base_url = nil)
  base_url = @base_url if !base_url
  uri = ""
  if (options && options.class == Hash)
    uri = Addressable::URI.new
    uri.query_values = options
  end

  full_url = "#{@host}#{base_url}#{url}#{uri}"
  if action === 'get'          
    response = self.send("#{@scope}_#{action}", "#{full_url}")
  elsif action === 'create' or action === 'post'
    action = 'post'
    response = self.send("#{@scope}_#{action}", "#{full_url}", data)          
  elsif action === 'put' or action === 'patch' or action ==='update'
    action = 'put'
    response = self.send("#{@scope}_#{action}", "#{full_url}", data)
  end
  if (response.response.code == "404")
    raise 'NotFoundError'
  end
  parsed_response = JSON.parse(response.body) 
  if parsed_response.key?('data')
    return parsed_response['data']
  end
  return parsed_response
end

#replacements ⇒ Object 



122
123
124
125
126
127
128
 
# File 'lib/client.rb', line 122

def replacements
  return [
      {old_value: '_', new_value: '-'},
      {old_value: 'people', new_value: 'crm'},
      {old_value: 'store', new_value: 'ecommerce'}
  ]
end

#set_scope(scope) ⇒ Object 



130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/client.rb', line 130

def set_scope(scope)
  @scope = scope
  if scope == "public"
      @base_url = "/api/v1"
  elsif scope == "contact"
      @base_url = "/api/v1"
  elsif scope == "user"
      @base_url = "/api/user/v1"
  else
      @scope = "public"
      @base_url = "/api/v1"
  end
end

#user_get(url) ⇒ Object

Start User context



211
212
213
214
215
216
217
218
 
# File 'lib/client.rb', line 211

def user_get(url)
  headers = {
    "ApiKey" => @api_key,
    "Accept" => "application/json"
  }
  headers["Authorization"] = "Bearer #{@session_token}" if @session_token
  return self.http_get(url, headers)
end

#user_post(url, data) ⇒ Object 



220
221
222
223
224
225
226
227
 
# File 'lib/client.rb', line 220

def user_post(url, data)
  headers = {
    "ApiKey" => @api_key,
    "Accept" => "application/json"
  }
  headers["Authorization"] = "Bearer #{@session_token}" if @session_token
  return self.http_post(url, headers, data)
end

#user_put(url, data) ⇒ Object 



229
230
231
232
233
234
235
236
237
 
# File 'lib/client.rb', line 229

def user_put(url, data)
  headers = {
    "ApiKey" => @api_key,
    "Accept" => "application/json",
    "Content-Type" => "application/json"
  }
  headers["Authorization"] = "Bearer #{@session_token}" if @session_token
  return self.http_put(url, headers, data)
end