Class: App42::Review::ReviewService

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

Overview

The service is a Review & Rating manager for any item. The item can be anything which has an id

e.g. App on a AppStore/Marketplace, items in a catalogue, articles, blogs etc. It manages the comments and its associated rating. It also provides methods to fetch average, highest etc. Reviews. Reviews can be also be muted or unmuted if it has any objectionable content.

See Also:

Instance Method Summary collapse

Constructor Details

#initialize(api_key, secret_key, base_url) ⇒ ReviewService

this is a constructor that takes

Parameters:

  • apiKey
  • secretKey
  • baseURL 


32
33
34
35
36
37
38
39
 
# File 'lib/review/ReviewService.rb', line 32

def initialize(api_key, secret_key, base_url)
  puts "Session Service->initialize"
  @api_key = api_key
  @secret_key = secret_key
  @base_url = base_url
  @resource = "review"
  @version = "1.0"
end

Instance Method Details

#create_review(userID, itemID, reviewComment, reviewRating) ⇒ Object

Creates review for the specified item on the cloud

Parameters:

  • userId —

    • The user who has created the review

  • itemId —

    • The item for which the review has to be created

  • reviewComment —

    • The review comment

  • reviewRating —

    • Review rating in double

Returns:

  • Review object containing the review which has been created

Raises:

  • App42Exception



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
 
# File 'lib/review/ReviewService.rb', line 58

def create_review(userID, itemID, reviewComment, reviewRating)
  puts "create_review Called "
  puts "Base url #{@base_url}"
  response = nil
  reviewObj = nil
  reviewObj = Review.new()
  util = Util.new
  util.throwExceptionIfNullOrBlank(userID, "User Id");
  util.throwExceptionIfNullOrBlank(itemID, "Item Id");
  util.throwExceptionIfNullOrBlank(reviewComment, "Review Comment");
  util.throwExceptionIfNullOrBlank(reviewRating, "Review Rating");
  begin
    connection = App42::Connection::RESTConnection.new(@base_url)
    body = {'app42' => {"review"=> {
      "userId" => userID,
      "itemId" => itemID,
      "comment" => reviewComment,
      "rating" => (reviewRating.to_i).to_s
      }}}.to_json
    puts "Body #{body}"
    params = Hash.new
    query_params = Hash.new
    params = {
      'apiKey'=> @api_key,
      'version' => @version,
      'timeStamp' => util.get_timestamp_utc,
    }
    query_params = params.clone
    params.store("body", body)
    signature = util.sign(@secret_key, params)
    resource_url = "#{@version}/#{@resource}"
    response = connection.post(signature, resource_url, query_params, body)
    review = ReviewResponseBuilder.new
    reviewObj = review.buildResponse(response)
  rescue  App42Exception =>e
    raise e
  rescue  Exception => e
    raise App42Exception.new(e)
  end
  return reviewObj
end

#get_all_reviews ⇒ Object

Fetches all reviews for the App

Returns:

  • ArrayList of Review object containing all the reviews for the App

Raises:

  • App42Exception



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
 
# File 'lib/review/ReviewService.rb', line 108

def get_all_reviews()
  puts "getAllAttribute Review Called "
  puts "Base url #{@base_url}"
  response = nil
  reviewList = nil
  reviewList = Array.new
  util = Util.new
  begin
    connection = App42::Connection::RESTConnection.new(@base_url)
    query_params = Hash.new
    params = {
      'apiKey'=> @api_key,
      'version' => @version,
      'timeStamp' => util.get_timestamp_utc,
    }
    query_params = params.clone
    puts query_params
    signature = util.sign(@secret_key, params)
    resource_url = "#{@version}/#{@resource}"
    response = connection.get(signature, resource_url, query_params)
    review = ReviewResponseBuilder.new
    reviewList = review.buildArrayResponse(response)
  rescue  App42Exception =>e
    raise e
  rescue  Exception => e
    raise App42Exception.new(e)
  end
  return reviewList
end

#get_all_reviews_by_paging(max, offset) ⇒ Object

Fetches all reviews for the App by Paging.

Parameters:

  • max —

    • Maximum number of records to be fetched

  • offset —

    • From where the records are to be fetched

Returns:

  • ArrayList of Review object containing all the reviews for the App

Raises:

  • App42Exception



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/review/ReviewService.rb', line 151

def get_all_reviews_by_paging(max, offset)
  puts "get_all_reviews_by_paging Called "
  puts "Base url #{@base_url}"
  response = nil
  reviewList = nil
  reviewList = Array.new
  util = Util.new
  util.validateMax(max);
  util.throwExceptionIfNullOrBlank(max, "Max");
  util.throwExceptionIfNullOrBlank(offset, "Offset");
  begin
    connection = App42::Connection::RESTConnection.new(@base_url)
    query_params = Hash.new
    params = {
      'apiKey'=> @api_key,
      'version' => @version,
      'timeStamp' => util.get_timestamp_utc,
    }
    query_params = params.clone
    params.store("max", "" + (max.to_i).to_s);
    params.store("offset", "" + (offset.to_i).to_s);
    puts query_params
    signature = util.sign(@secret_key, params)
    resource_url = "#{@version}/#{@resource}/paging/#{(max.to_i).to_s}/#{(offset.to_i).to_s}"
    response = connection.get(signature, resource_url, query_params)
    review = ReviewResponseBuilder.new
    reviewList = review.buildArrayResponse(response)
  rescue  App42Exception =>e
    raise e
  rescue  Exception => e
    raise App42Exception.new(e)
  end
  return reviewList
end

#get_all_reviews_count ⇒ Object

Fetches count of all reviews for the App

Returns:

  • App42Response containing count of all the reviews for the App

Raises:

  • App42Exception



513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
 
# File 'lib/review/ReviewService.rb', line 513

def get_all_reviews_count()
  puts "get_all_reviews_count Called "
  puts "Base url #{@base_url}"
  response = nil;
  responseObj = App42Response.new
  util = Util.new()
  begin
    connection = App42::Connection::RESTConnection.new(@base_url)
    query_params = Hash.new
    params = {
      'apiKey'=> @api_key,
      'version' => @version,
      'timeStamp' => util.get_timestamp_utc,
    }
    query_params = params.clone
    puts query_params
    signature = util.sign(@secret_key, params)
    resource_url = "#{@version}/#{@resource}/count"
    response = connection.get(signature, resource_url, query_params)
    responseObj.strResponse=(response)
    responseObj.isResponseSuccess=(true)
    responseObj = ReviewResponseBuilder.new()
    responseObj.getTotalRecords(response);
  rescue  App42Exception =>e
    raise e
  rescue  Exception => e
    raise App42Exception.new(e)
  end
  return responseObj
end

#get_average_review_by_item(itemId) ⇒ Object

Fetches the average review for the specified itemId

Parameters:

  • itemId —

    • The item for which the average review has to be fetched

Returns:

  • Review object containing the average review for a item

Raises:

  • App42Exception



379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
 
# File 'lib/review/ReviewService.rb', line 379

def get_average_review_by_item(itemId)
  puts "get_average_review_by_item Review Called "
  puts "Base url #{@base_url}"
  response = nil
  reviewObj = nil
  reviewObj = Review.new()
  util = Util.new
  util.throwExceptionIfNullOrBlank(itemId, "Item Id");
  begin
    connection = App42::Connection::RESTConnection.new(@base_url)
    query_params = Hash.new
    params = {
      'apiKey'=> @api_key,
      'version' => @version,
      'timeStamp' => util.get_timestamp_utc,
    }
    query_params = params.clone
    params.store("itemId", itemId);
    puts query_params
    signature = util.sign(@secret_key, params)
    resource_url = "#{@version}/#{@resource}/#{itemId}/average"
    response = connection.get(signature, resource_url, query_params)
    review = ReviewResponseBuilder.new
    reviewObj = review.buildResponse(response)
  rescue  App42Exception =>e
    raise e
  rescue  Exception => e
    raise App42Exception.new(e)
  end
  return reviewObj
end

#get_highest_review_by_item(itemId) ⇒ Object

Fetches the highest review for the specified itemId

Parameters:

  • itemId —

    • The item for which the highest review has to be fetched

Returns:

  • Review object containing the highest review for a item

Raises:

  • App42Exception



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/review/ReviewService.rb', line 292

def get_highest_review_by_item(itemId)
  puts "get_highest_review_by_item Review Called "
  puts "Base url #{@base_url}"
  response = nil
  reviewObj = nil
  reviewObj = Review.new()
  util = Util.new
  util.throwExceptionIfNullOrBlank(itemId, "Item Id");
  begin
    connection = App42::Connection::RESTConnection.new(@base_url)
    query_params = Hash.new
    params = {
      'apiKey'=> @api_key,
      'version' => @version,
      'timeStamp' => util.get_timestamp_utc,
    }
    query_params = params.clone
    puts params
    params.store("itemId", itemId);
    puts query_params
    signature = util.sign(@secret_key, params)
    resource_url = "#{@version}/#{@resource}/#{itemId}/highest"
    response = connection.get(signature, resource_url, query_params)
    review = ReviewResponseBuilder.new
    reviewObj = review.buildResponse(response)
  rescue  App42Exception =>e
    raise e
  rescue  Exception => e
    raise App42Exception.new(e)
  end
  return reviewObj
end

#get_lowest_review_by_item(itemId) ⇒ Object

Fetches the lowest review for the specified itemId

Parameters:

  • itemId —

    • The item for which the lowest review has to be fetched

Returns:

  • Review object containing the lowest review for a item

Raises:

  • App42Exception



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/review/ReviewService.rb', line 336

def get_lowest_review_by_item(itemId)
  puts "get_lowest_review_by_item Review Called "
  puts "Base url #{@base_url}"
  response = nil
  reviewObj = nil
  reviewObj = Review.new()
  util = Util.new
  util.throwExceptionIfNullOrBlank(itemId, "Item Id");
  begin
    connection = App42::Connection::RESTConnection.new(@base_url)
    query_params = Hash.new
    params = {
      'apiKey'=> @api_key,
      'version' => @version,
      'timeStamp' => util.get_timestamp_utc,
    }
    query_params = params.clone
    params.store("itemId", itemId);
    puts query_params
    signature = util.sign(@secret_key, params)
    resource_url = "#{@version}/#{@resource}/#{itemId}/lowest"
    response = connection.get(signature, resource_url, query_params)
    review = ReviewResponseBuilder.new
    reviewObj = review.buildResponse(response)
  rescue  App42Exception =>e
    raise e
  rescue  Exception => e
    raise App42Exception.new(e)
  end
  return reviewObj
end

#get_review_by_item_by_paging(itemId, max, offset) ⇒ Object

Fetches All Reviews based on the itemId by Paging.

Parameters:

  • itemId —

    • The item for which reviews have to be fetched

  • max —

    • Maximum number of records to be fetched

  • offset —

    • From where the records are to be fetched

Returns:

  • ArrayList of Review object containing all the reviews for a item

Raises:

  • App42Exception



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/review/ReviewService.rb', line 244

def get_review_by_item_by_paging(itemId, max, offset)
  puts "get_review_by_item_by_paging Called "
  puts "Base url #{@base_url}"
  response = nil
  reviewList = nil;
  reviewList = Array.new
  util = Util.new
  util.validateMax(max);
  util.throwExceptionIfNullOrBlank(max, "Max");
  util.throwExceptionIfNullOrBlank(offset, "Offset");
  util.throwExceptionIfNullOrBlank(itemId, "Item Id");
  begin
    connection = App42::Connection::RESTConnection.new(@base_url)
    params = Hash.new
    query_params = Hash.new
    params = {
      'apiKey'=> @api_key,
      'version' => @version,
      'timeStamp' => util.get_timestamp_utc,
    }
    query_params = params.clone
    params.store("max", "" + (max.to_i).to_s);
    params.store("offset", "" + (offset.to_i).to_s);
    params.store("itemId", "" +  itemId);
    signature = util.sign(@secret_key, params)
    resource_url = "#{@version}/#{@resource}/item/#{itemId}/#{(max.to_i).to_s}/#{(offset.to_i).to_s}"
    response = connection.get(signature, resource_url, query_params)
    review = ReviewResponseBuilder.new
    reviewList = review.buildArrayResponse(response)
  rescue  App42Exception =>e
    raise e
  rescue  Exception => e
    raise App42Exception.new(e)
  end
  return reviewList
end

#get_reviews_by_item(itemId) ⇒ Object

Fetches All Reviews based on the itemId

Parameters:

  • itemId —

    • The item for which reviews have to be fetched

Returns:

  • ArrayList of Review object containing all the reviews for a item

Raises:

  • App42Exception



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/review/ReviewService.rb', line 197

def get_reviews_by_item(itemId)
  puts "get_reviews_by_item Called "
  puts "Base url #{@base_url}"
  response = nil
  reviewList = nil;
  reviewList = Array.new
  util = Util.new
  util.throwExceptionIfNullOrBlank(itemId, "Item Id");
  begin
    connection = App42::Connection::RESTConnection.new(@base_url)
    params = Hash.new
    query_params = Hash.new
    params = {
      'apiKey'=> @api_key,
      'version' => @version,
      'timeStamp' => util.get_timestamp_utc,
    }
    query_params = params.clone
    params.store("itemId", itemId);
    signature = util.sign(@secret_key, params)
    resource_url = "#{@version}/#{@resource}/item/#{itemId}"
    response = connection.get(signature, resource_url, query_params)
    review = ReviewResponseBuilder.new
    reviewList = review.buildArrayResponse(response)
  rescue  App42Exception =>e
    raise e
  rescue  Exception => e
    raise App42Exception.new(e)
  end
  return reviewList
end

#get_reviews_count_by_item(itemId) ⇒ Object

Fetches count of All Reviews based on the itemId

Parameters:

  • itemId —

    • The item for which count of reviews have to be fetched

Returns:

  • App42Response containing count of all the reviews for a item

Raises:

  • App42Exception



555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
 
# File 'lib/review/ReviewService.rb', line 555

def get_reviews_count_by_item(itemId)
  puts "get_reviews_count_by_item Called "
  puts "Base url #{@base_url}"
  response = nil;
  responseObj = App42Response.new
  util = Util.new
  util.throwExceptionIfNullOrBlank(itemId, "Item Id");
  begin
    connection = App42::Connection::RESTConnection.new(@base_url)
    query_params = Hash.new
    params = {
      'apiKey'=> @api_key,
      'version' => @version,
      'timeStamp' => util.get_timestamp_utc,
    }
    query_params = params.clone
    params.store("itemId", itemId)
    puts query_params
    signature = util.sign(@secret_key, params)
    resource_url = "#{@version}/#{@resource}/item/#{itemId}/count"
    response = connection.get(signature, resource_url, query_params)
    responseObj.strResponse=(response)
    responseObj.isResponseSuccess=(true)
    responseObj = ReviewResponseBuilder.new()
    responseObj.getTotalRecords(response);
  rescue  App42Exception =>e
    raise e
  rescue  Exception => e
    raise App42Exception.new(e)
  end
  return responseObj
end

#mute(reviewId) ⇒ Object

Mutes the specified review

Parameters:

  • reviewId —

    • The Id of the review which has to be muted

Returns:

  • App42Response if muted successfully

Raises:

  • App42Exception



422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
 
# File 'lib/review/ReviewService.rb', line 422

def mute(reviewId)
  puts "mute review Called "
  puts "Base url #{@base_url}"
  response = nil
  reviewObj = nil
  reviewObj = Review.new()
  util = Util.new
  util.throwExceptionIfNullOrBlank(reviewId, "Review Id");
  begin
    connection = App42::Connection::RESTConnection.new(@base_url)
    body = {'app42' => {"review"=> {
      "id" => reviewId
      }}}.to_json
    puts "Body #{body}"
    query_params = Hash.new
    params = {
      'apiKey'=> @api_key,
      'version' => @version,
      'timeStamp' => util.get_timestamp_utc,
    }
    query_params = params.clone
    params.store("body", body)
    puts query_params
    signature = util.sign(@secret_key, params)
    resource_url = "#{@version}/#{@resource}/mute"
    response = connection.put(signature, resource_url, query_params, body)
    review = ReviewResponseBuilder.new
    reviewObj = review.buildResponse(response)
  rescue  App42Exception =>e
    raise e
  rescue  Exception => e
    raise App42Exception.new(e)
  end
  return reviewObj
end

#unmute(reviewId) ⇒ Object

UnMutes the specified review

Parameters:

  • reviewId —

    • The Id of the review which has to be unmuted

Returns:

  • App42Response if unmuted successfully

Raises:

  • App42Exception



469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
 
# File 'lib/review/ReviewService.rb', line 469

def unmute(reviewId)
  puts "unmute review Called "
  puts "Base url #{@base_url}"
  response = nil
  reviewObj = nil
  reviewObj = Review.new()
  util = Util.new
  util.throwExceptionIfNullOrBlank(reviewId, "Review Id");
  begin
    connection = App42::Connection::RESTConnection.new(@base_url)
    body = {'app42' => {"review"=> {
      "id" => reviewId
      }}}.to_json
    puts "Body #{body}"
    query_params = Hash.new
    params = {
      'apiKey'=> @api_key,
      'version' => @version,
      'timeStamp' => util.get_timestamp_utc,
    }
    query_params = params.clone
    params.store("body", body)
    puts query_params
    signature = util.sign(@secret_key, params)
    resource_url = "#{@version}/#{@resource}/unmute"
    response = connection.put(signature, resource_url, query_params, body)
    review = ReviewResponseBuilder.new
    reviewObj = review.buildResponse(response)
  rescue  App42Exception =>e
    raise e
  rescue  Exception => e
    raise App42Exception.new(e)
  end
  return reviewObj
end