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.


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

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 


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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/client.rb', line 82

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.


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

def api_key
  @api_key
end

#base_url ⇒ Object (readonly)

Returns the value of attribute base_url.


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

def base_url
  @base_url
end

#host ⇒ Object (readonly)

Returns the value of attribute host.


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

def host
  @host
end

#scope ⇒ Object (readonly)

Returns the value of attribute scope.


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

def scope
  @scope
end

#session_token ⇒ Object

Returns the value of attribute session_token.


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

def session_token
  @session_token
end

Instance Method Details

#contact_get(url) ⇒ Object

Start contact context


217
218
219
220
221
222
223
224
225
 
# File 'lib/client.rb', line 217

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

#contact_post(url, data) ⇒ Object 


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

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

#contact_put(url, data) ⇒ Object 


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

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

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


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

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


180
181
182
183
184
185
186
187
188
 
# File 'lib/client.rb', line 180

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


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

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


204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/client.rb', line 204

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


277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/client.rb', line 277

def public_get(url, headers = nil)
  h = {
    "Accept" => "application/json",
    "Content-Type" => "application/json",
    "ApiKey" => @api_key
  }
  h["ContactToken"] = @contact_token if @contact_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 


292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/client.rb', line 292

def public_post(url, headers = nil, data)
  h = {
    "Accept" => "application/json",
    "Content-Type" => "application/json",
    "ApiKey" => @api_key
  }
  h["ContactToken"] = @session_token if @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 


307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/client.rb', line 307

def public_put(url, headers = nil, data)
  h = {
    "Accept" => "application/json", 
    "Content-Type" => "application/json", 
    "ApiKey" => @api_key
  }
  h["ContactToken"] = @contact_token if @contact_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 


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
47
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
 
# File 'lib/client.rb', line 21

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}"
  response = nil
  if action === 'get'

    template = ERB.new File.new("#{Rails.root}/mints_config.yml.erb").read
    config = YAML.load template.result(binding)
    url_need_cache = false
    result_from_cache = false
    time = 0

    if config['redis_cache']['use_cache']
      config['redis_cache']['groups'].each do |group|
        group['urls'].each do |url|
            if full_url.match url
              time = group['time']
              url_need_cache = true
              @redis_server = Redis.new(host: config['redis_cache']['redis_host'], port: config['redis_cache']['redis_port'] ? config['redis_cache']['redis_port'] : 6379, db: config['redis_cache']['redis_db'] ? config['redis_cache']['redis_db'] : 1)
              if @redis_server.get(full_url)
                response = @redis_server.get(full_url)
                result_from_cache = true
              else 
                response = self.send("#{@scope}_#{action}", "#{full_url}")
                @redis_server.setex(full_url,time,response)
              end
              break
            end
        end
        break if url_need_cache    
      end
    end

    if !url_need_cache
      response = self.send("#{@scope}_#{action}", "#{full_url}")
    end

  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 result_from_cache
    return parsed_response = JSON.parse(response)
  else
    if (response.response.code == "404")
      raise 'NotFoundError'
    end
    parsed_response = JSON.parse(response.body) 
    return parsed_response
  end        
end

#replacements ⇒ Object 


156
157
158
159
160
161
162
 
# File 'lib/client.rb', line 156

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

#set_scope(scope) ⇒ Object 


164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/client.rb', line 164

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


248
249
250
251
252
253
254
255
 
# File 'lib/client.rb', line 248

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 


257
258
259
260
261
262
263
264
 
# File 'lib/client.rb', line 257

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 


266
267
268
269
270
271
272
273
274
 
# File 'lib/client.rb', line 266

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