Class: WidgetsApiClient

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

Overview

Interface for gem methods

Class Method Summary collapse

Class Method Details

.change_password(user_data, bearer_token) ⇒ Json

Updates old password to new password

Parameters:

  • user_data (Object) —

    User object with old and new password details

  • bearer_token (String)

Returns:

  • (Json) —

    Response of change password



122
123
124
 
# File 'lib/widgets_api_client.rb', line 122

def self.change_password(user_data, bearer_token)
  UserService.change_password(user_data, bearer_token)
end

.check_email(user_data) ⇒ Json

Verifies if email is already registered

Parameters:

  • user_data (Object) —

    user object conatining email

Returns:

  • (Json) —

    Response of verify email



99
100
101
 
# File 'lib/widgets_api_client.rb', line 99

def self.check_email(user_data)
  UserService.check_email(user_data)
end

.client_id ⇒ String

Return Client Id

Returns:

  • (String) 


30
31
32
 
# File 'lib/widgets_api_client.rb', line 30

def self.client_id
  ApplicationConfig.client_id
end

.create_authentication_token(auth_data) ⇒ Json

Creates authentication token

Parameters:

  • auth_data (object) —

    Authentication object

Returns:

  • (Json) —

    Response with brearer and refresh token



41
42
43
 
# File 'lib/widgets_api_client.rb', line 41

def self.create_authentication_token(auth_data)
  AuthenticationService.create_authentication(auth_data)
end

.create_user(user_data) ⇒ Json

Creates User

Parameters:

  • user_data (Object) —

    User Object for create

Returns:

  • (Json) —

    Response of create user



76
77
78
 
# File 'lib/widgets_api_client.rb', line 76

def self.create_user(user_data)
  UserService.create_user(user_data)
end

.create_widget(widget_data, bearer_token) ⇒ Json

Creates Widget

Parameters:

  • widget_data (Object) —

    Widget object for create

  • bearer_token (String)

Returns:

  • (Json) —

    Response of create widget



205
206
207
 
# File 'lib/widgets_api_client.rb', line 205

def self.create_widget(widget_data, bearer_token)
  WidgetService.create_widget(widget_data, bearer_token)
end

.destroy_widget(widget_id, bearer_token) ⇒ Json

Deletes own widget for given widget id

Parameters:

  • widget_id (String) —

    widgets to delete

  • bearer_token (String)

Returns:

  • (Json) —

    Response of delete widget



230
231
232
 
# File 'lib/widgets_api_client.rb', line 230

def self.destroy_widget(widget_id, bearer_token)
  WidgetService.delete_widget(widget_id, bearer_token)
end

.get_private_widgets(bearer_token) ⇒ String

Lists own widgets

Parameters:

  • bearer_token (String)

Returns:

  • (String) —

    Response with list of own widgets



241
242
243
 
# File 'lib/widgets_api_client.rb', line 241

def self.get_private_widgets(bearer_token)
  WidgetService.get_own_widgets(bearer_token)
end

.get_public_widgets(bearer_token) ⇒ Json

Lists public widgets

Parameters:

  • bearer_token (String)

Returns:

  • (Json) —

    Response with list of public visible widgets



252
253
254
 
# File 'lib/widgets_api_client.rb', line 252

def self.get_public_widgets(bearer_token)
  WidgetService.get_public_widgets(bearer_token)
end

.get_public_widgets_with_search_term(search_term, bearer_token) ⇒ Json

Lists public widgets with search term

Parameters:

  • search_term (String)
  • bearer_token (String)

Returns:

  • (Json) —

    Response with searched public widgets by given search term



264
265
266
 
# File 'lib/widgets_api_client.rb', line 264

def self.get_public_widgets_with_search_term(search_term, bearer_token)
  WidgetService.get_public_widgets_with_search_term(search_term, bearer_token)
end

.refresh_authentication_token(auth_data, bearer_token) ⇒ Json

Refresh authentication token

Parameters:

  • auth_data (Object) —

    Authentication object

  • bearer_token (String)

Returns:

  • (Json) —

    Response with brearer and refresh token



53
54
55
 
# File 'lib/widgets_api_client.rb', line 53

def self.refresh_authentication_token(auth_data, bearer_token)
  AuthenticationService.refresh_authentication_token(auth_data, bearer_token)
end

.reset_password(user_data) ⇒ Json

Sends email with reset password link

Parameters:

  • user_data (Object) —

    User object

Returns:

  • (Json) —

    Response of reset password



110
111
112
 
# File 'lib/widgets_api_client.rb', line 110

def self.reset_password(user_data)
  UserService.reset_password(user_data)
end

.revoke_authentication_token(auth_data, bearer_token) ⇒ Json

Revokes authentication token

Parameters:

  • auth_data (Object) —

    Authentication object

  • bearer_token (String)

Returns:

  • (Json) —

    Response with revoke message



65
66
67
 
# File 'lib/widgets_api_client.rb', line 65

def self.revoke_authentication_token(auth_data, bearer_token)
  AuthenticationService.revoke_authentication_token(auth_data, bearer_token)
end

.set_config(client_id, client_secret, base_url) ⇒ Object

Sets Application Configuration

Parameters:

  • client_id (String)
  • client_secret (String)
  • base_url (String) 


21
22
23
 
# File 'lib/widgets_api_client.rb', line 21

def self.set_config(client_id, client_secret, base_url)
  ApplicationConfig.set_config(client_id, client_secret, base_url)
end

.show_logged_in_user(bearer_token) ⇒ Json

Displays logged in user details

Parameters:

  • bearer_token (String)

Returns:

  • (Json) —

    Response containing logged in user details



133
134
135
 
# File 'lib/widgets_api_client.rb', line 133

def self.show_logged_in_user(bearer_token)
  UserService.show_logged_in_user(bearer_token)
end

.show_private_widgets(bearer_token) ⇒ Json

Displays own widgets

Parameters:

  • bearer_token (String)

Returns:

  • (Json) —

    Response containing list of own widgets



156
157
158
 
# File 'lib/widgets_api_client.rb', line 156

def self.show_private_widgets(bearer_token)
  UserWidgetService.get_private_widgets(bearer_token)
end

.show_private_widgets_with_search_term(search_term, bearer_token) ⇒ Json

Displays own widget with search term

Parameters:

  • search_term (String)
  • bearer_token (String)

Returns:

  • (Json) —

    Response containing list of own widget by search term



168
169
170
 
# File 'lib/widgets_api_client.rb', line 168

def self.show_private_widgets_with_search_term(search_term, bearer_token)
  UserWidgetService.get_private_widgets_with_search_term(search_term, bearer_token)
end

.show_user_id(user_id, bearer_token) ⇒ Json

Displays details of user id

Parameters:

  • user_id (String)
  • bearer_token (String)

Returns:

  • (Json) —

    Response containing details of given user id



145
146
147
 
# File 'lib/widgets_api_client.rb', line 145

def self.show_user_id(user_id, bearer_token)
  UserService.show_user_id(user_id, bearer_token)
end

.show_widgets_by_user_id(user_id, bearer_token) ⇒ Json

Displays widgets for given user id

Parameters:

  • user_id (String)
  • bearer_token (String)

Returns:

  • (Json) —

    Resopnse containing widgets list for given user id



180
181
182
 
# File 'lib/widgets_api_client.rb', line 180

def self.show_widgets_by_user_id(user_id, bearer_token)
  UserWidgetService.get_widgets_by_user_id(user_id, bearer_token)
end

.show_widgets_by_user_id_with_search_term(user_id, search_term, bearer_token) ⇒ Json

Displays widgets for given user id and serach term

Parameters:

  • user_id (String)
  • search_term (String)
  • bearer_token (String)

Returns:

  • (Json) —

    Response contating widget details for user id and serach term



193
194
195
 
# File 'lib/widgets_api_client.rb', line 193

def self.show_widgets_by_user_id_with_search_term(user_id, search_term, bearer_token)
  UserWidgetService.get_widgets_by_user_id_with_search_term(user_id, search_term, bearer_token)
end

.update_user(user_data, bearer_token) ⇒ Json

Updates existing user

Parameters:

  • user_data (Object) —

    User Object for update

  • bearer_token (String)

Returns:

  • (Json) —

    Response of update user



88
89
90
 
# File 'lib/widgets_api_client.rb', line 88

def self.update_user(user_data, bearer_token)
  UserService.update_user(user_data, bearer_token)
end

.update_widget(widget_data, widget_id, bearer_token) ⇒ Json

Updates existing widget

Parameters:

  • widget_data (Object) —

    Widget object for update

  • widget_id (String) —

    widget to update

  • bearer_token (String)

Returns:

  • (Json) —

    Response of update widget



218
219
220
 
# File 'lib/widgets_api_client.rb', line 218

def self.update_widget(widget_data, widget_id, bearer_token)
  WidgetService.update_widget(widget_data, widget_id, bearer_token)
end