class FriendlyScore::API
Attributes
application_id[R]
application_secret[R]
Public Class Methods
new(application_id, application_secret)
click to toggle source
A new instance of API
.
@param application_id
[Integer] application id @param application_secret
[String] application secret
# File lib/friendly_score/api.rb, line 9 def initialize application_id, application_secret @application_id = application_id @application_secret = application_secret end
Public Instance Methods
show(id)
click to toggle source
Returns user data (api: 'api/show')
@param id [Integer] identificator of user @return [FriendlyScore::User]
# File lib/friendly_score/api.rb, line 18 def show id endpoint = get_endpoint Endpoints::Show endpoint.perform id end
show_partner_user(partner_user_id)
click to toggle source
Returns partner user
@param partner_user_id [String] identificaotr of partner user @return [FriendlyScore::User]
# File lib/friendly_score/api.rb, line 27 def show_partner_user partner_user_id endpoint = get_endpoint Endpoints::ShowPartnerUser endpoint.perform partner_user_id end
user_positive(id, positive)
click to toggle source
Sets is user positive or not
@param id [Integer] users identificator @param positive [Integer] 1 if user is positive, 0 if not
# File lib/friendly_score/api.rb, line 36 def user_positive id, positive endpoint = get_endpoint Endpoints::UserPositive endpoint.validate id, positive endpoint.perform id, positive end
user_status(id, status, status_description)
click to toggle source
Sets users status with description
@param id [Integer] users identificator @param status [Integer] any integer number @param status_description [String] status description
# File lib/friendly_score/api.rb, line 47 def user_status id, status, status_description endpoint = get_endpoint Endpoints::UserStatus endpoint.perform id, status, status_description end
users()
click to toggle source
List of all application users
@return [List<FriendlyScore::User>] list of all users
# File lib/friendly_score/api.rb, line 55 def users endpoint = get_endpoint Endpoints::Users endpoint.perform end
Private Instance Methods
get_endpoint(endpoint_class)
click to toggle source
# File lib/friendly_score/api.rb, line 62 def get_endpoint endpoint_class @endpoints ||= {} unless @endpoints[endpoint_class] @endpoints[endpoint_class] = endpoint_class.new( @application_id, @application_secret, responder ) end @endpoints[endpoint_class] end
responder()
click to toggle source
# File lib/friendly_score/api.rb, line 72 def responder @responder ||= Responder.new end