widgets_api_client 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 185557368c2cfbe87f9e6e4bb2579c5dee0e7c5bb48a6d9edba51dc89cc15694
-  data.tar.gz: 705236b3894433070c9b3070e2694e50473350c19cc0fe400f3278a6f98d30ab
+  metadata.gz: 89008eec1366ab100f65284591ddc10556c3c02e749f707216f685c4d158b684
+  data.tar.gz: c63b702e0ec63aaaea1ecbfba0246c8e6fa4596215aaa0688de04739fde56bbe
 SHA512:
-  metadata.gz: acd93e65ba68890963a519adf72431d89f40cbf0ed13ae390696d2af5daee27cf027cf613f22313c9b0bdb5a69d60ff1e7eabb5bdd80585b5913772c6f3c7aac
-  data.tar.gz: 914cb67d36f9b14b83a29270e922c9beea68fed2d86a5c9e34efda1d155fac0e40587344b081b45c5efe1adacdfa0087deb17c4cda08c0702175e6c8c20a3507
+  metadata.gz: 8e56ce66a4ce67530241013ffaa3bf113993a0ca00e22dcbaec51ea2f41b4a0b332d75529e396ac492f4576856fd25fcd0046d24b2bf1266e65f269847b6ac0d
+  data.tar.gz: 58ae7f1cf56a66893ee2a48633a20229971ed76759e14468b86b2b9e0307295802501b7075d717aded517da6ee883cc38d62edf628fb511c1bbcac290475bdd1

data/Gemfile

@@ -7,3 +7,5 @@ gem 'json'
 group :test do
   gem 'simplecov', require: false
 end
+
+gem 'solargraph', group: :development

data/lib/domain/application_config.rb

@@ -1,16 +1,30 @@
+#
+# Sets Application Configurations
+#
 class ApplicationConfig
   @@client_id = ''
   @@client_secret = ''
+  @@base_url = ''
 
   def self.set_config(client_id, client_secret)
     @@client_id = client_id
     @@client_secret = client_secret
   end
 
+  #
+  # Return Client Id
+  #
+  # @return [String]
+  #
   def self.client_id
     @@client_id
   end
 
+  #
+  # Returns Client Secret
+  #
+  # @return [String]
+  #
   def self.client_secret
     @@client_secret
   end

data/lib/domain/authentication.rb

@@ -1,5 +1,8 @@
 require 'json'
 
+#
+# Authentication model conatining token generation attributes
+#
 class Authentication
   attr_accessor :grant_type
   attr_accessor :client_id
@@ -9,6 +12,17 @@ class Authentication
   attr_accessor :token
   attr_accessor :refresh_token
 
+  #
+  # Inialise the authentication model
+  #
+  # @param [String] grant_type Token grant type
+  # @param [String] client_id
+  # @param [String] client_secret
+  # @param [String] username
+  # @param [String] password
+  # @param [String] token Bearer token
+  # @param [String] refresh_token Refresh token
+  #
   def initialize(grant_type: nil, client_id: nil, client_secret: nil,
                  username: nil, password: nil, token: nil, refresh_token: nil)
     self.grant_type = grant_type
@@ -20,6 +34,13 @@ class Authentication
     self.refresh_token = refresh_token
   end
 
+  #
+  # Converts Authentication object to Json object
+  #
+  # @param [Refrence] *data authentication object refrence
+  #
+  # @return [Json] Json represenatation of authentication object
+  #
   def to_json(*data)
     hash = {
       grant_type: @grant_type,
@@ -34,7 +55,14 @@ class Authentication
     hash.to_json(*data)
   end
 
- def self.get_payload(auth_data)
+  #
+  # Gets Json represenatation of authentication object
+  #
+  # @param [Object] auth_data Authentication object
+  #
+  # @return [Json] Json represenatation of authentication object
+  #
+  def self.get_payload(auth_data)
     auth_data.to_json
   end
 end

data/lib/domain/client_info_base.rb

@@ -1,10 +1,20 @@
 require 'json'
 
+#
+# Client Base model conatining client information
+#
 class ClientInfoBase
   attr_accessor :client_id
   attr_accessor :client_secret
   attr_accessor :user
 
+  #
+  # Converts User with client details object to Json object
+  #
+  # @param [refrence] *data User object with client details refrence
+  #
+  # @return [<Type>] Json represenatation of User with client details
+  #
   def to_json(*data)
     {
       client_id: @client_id,

data/lib/domain/user.rb

@@ -1,5 +1,8 @@
 require 'json'
 
+#
+# User model conatining user create and update attributes
+#
 class User
   attr_accessor :first_name
   attr_accessor :last_name
@@ -10,6 +13,16 @@ class User
   attr_accessor :email
   attr_accessor :image_url
 
+  #
+  # Inialise the User model
+  #
+  # @param [String] first_name
+  # @param [String] last_name
+  # @param [String] password
+  # @param [String] date_of_birth
+  # @param [String] email
+  # @param [String] image_url
+  #
   def initialize(first_name: nil, last_name: nil, password: nil,
                  date_of_birth: nil, email: nil, image_url: nil)
     self.first_name = first_name
@@ -22,6 +35,13 @@ class User
     self.image_url = image_url
   end
 
+  #
+  # Converts User object to Json object
+  #
+  # @param [Refrence] *data user object refrence
+  #
+  # @return [Json] Json represenatation of user object
+  #
   def to_json(*data)
     hash = {
       first_name: @first_name,
@@ -37,9 +57,14 @@ class User
     hash.to_json(*data)
   end
 
-    def self.get_payload(user)
+  #
+  # Gets Json represenatation of user object
+  #
+  # @param [Object] user User object
+  #
+  # @return [Json] Json represenatation of user object
+  #
+  def self.get_payload(user)
     user.to_json
   end
 end
-
-

data/lib/domain/user_base.rb

@@ -1,11 +1,21 @@
 require 'json'
 
+#
+# User Base class containing user object
+#
 class UserBase
   attr_accessor :user
 
+  #
+  # Converts User object to Json object
+  #
+  # @param [Refrence] *data user object refrence
+  #
+  # @return [<Type>] Json represenatation of user object
+  #
   def to_json(*data)
     {
       user: @user
     }.to_json(*data)
   end
- end
+end

data/lib/domain/widget.rb

@@ -1,16 +1,33 @@
 require 'json'
 
+#
+# Widget model conatining widget craeate and update attributes
+#
 class Widget
   attr_accessor :name
   attr_accessor :description
   attr_accessor :kind
 
+  #
+  #  Inialise the widget model
+  #
+  # @param [String] name Name of widget
+  # @param [String] description
+  # @param [String] kind Kind of widget - hidden/visible
+  #
   def initialize(name: nil, description: nil, kind: nil)
     self.name = name
     self.description = description
     self.kind = kind
   end
 
+  #
+  # Converts Widget object to Json object
+  #
+  # @param [refrence] *data widget object refrence
+  #
+  # @return [<Type>] Json represenatation of widget object
+  #
   def to_json(*data)
     hash = {
       name: @name,
@@ -21,6 +38,13 @@ class Widget
     hash.to_json(*data)
   end
 
+  #
+  # Gets Json represenatation of widget object
+  #
+  # @param [Object] widget Widget object
+  #
+  # @return [Json] Json represenatation of widget object
+  #
   def self.get_payload(widget)
     widget.to_json
   end

data/lib/domain/widget_base.rb

@@ -1,12 +1,21 @@
 require 'json'
 
+#
+# Widget Base class containing widget object
+#
 class WidgetBase
   attr_accessor :widget
 
+  #
+  # Converts Widget object to Json object
+  #
+  # @param [Refrence] *data widget object refrence
+  #
+  # @return [Json] Json represenatation of widget object
+  #
   def to_json(*data)
     {
       widget: @widget
     }.to_json(*data)
   end
- 
 end

data/lib/services/authentication_service.rb

@@ -3,10 +3,20 @@ require 'json'
 require_relative '../domain/authentication.rb'
 require_relative '../domain/application_config.rb'
 
+#
+# Authentication Service for token activies
+#
 class AuthenticationService
   @@authentication_url = 'https://showoff-rails-react-production.herokuapp.com/oauth/token'
   @@revoke_url = 'https://showoff-rails-react-production.herokuapp.com/oauth/revoke'
 
+  #
+  # Creates authentication token
+  #
+  # @param [object] auth_data Authentication object
+  #
+  # @return [Json] Response with brearer and refresh token
+  #
   def self.create_authentication(auth_data)
     auth_data = get_auth_with_client_info(auth_data)
     auth_payload = Authentication.get_payload(auth_data)
@@ -16,6 +26,14 @@ class AuthenticationService
                                 headers: { 'Content-Type': 'application/json' })
   end
 
+  #
+  # Refresh authentication token
+  #
+  # @param [Object] auth_data Authentication object
+  # @param [String] bearer_token
+  #
+  # @return [Json] Response with brearer and refresh token
+  #
   def self.refresh_authentication_token(auth_data, bearer_token)
     auth_data = get_auth_with_client_info(auth_data)
     auth_payload = Authentication.get_payload(auth_data)
@@ -26,6 +44,14 @@ class AuthenticationService
                                            'Authorization': bearer_token })
   end
 
+  #
+  # Revokes authentication token
+  #
+  # @param [Object] auth_data Authentication object
+  # @param [String] bearer_token
+  #
+  # @return [Json] Response with revoke message
+  #
   def self.revoke_authentication_token(auth_data, bearer_token)
     auth_payload = Authentication.get_payload(auth_data)
     RestClient::Request.execute(method: :post,
@@ -35,6 +61,13 @@ class AuthenticationService
                                            'Authorization': bearer_token })
   end
 
+  #
+  # Sets Client id and secrets to Authentication object
+  #
+  # @param [Object] auth_data Authentication object
+  #
+  # @return [Object] Authentication object
+  #
   def self.get_auth_with_client_info(auth_data)
     auth_data.client_id = ApplicationConfig.client_id
     auth_data.client_secret = ApplicationConfig.client_secret

data/lib/services/user_service.rb

@@ -5,6 +5,9 @@ require_relative '../domain/user.rb'
 require_relative '../domain/user_base.rb'
 require_relative '../domain/application_config.rb'
 
+#
+# User Service for CRUD operation related to user
+#
 class UserService
   @@create_user_url = 'https://showoff-rails-react-production.herokuapp.com/api/v1/users'
   @@create_update_url = 'https://showoff-rails-react-production.herokuapp.com/api/v1/users/me'
@@ -14,6 +17,13 @@ class UserService
   @@show_logged_in_user_url = 'https://showoff-rails-react-production.herokuapp.com/api/v1/users/me'
   @@show_user_id_url = 'https://showoff-rails-react-production.herokuapp.com/api/v1/users/'
 
+  #
+  # Creates User
+  #
+  # @param [Object] user User Object for create
+  #
+  # @return [Json] Response of create user
+  #
   def self.create_user(user)
     user_with_client_info = get_user_with_client_info(user)
     create_user_payload = User.get_payload(user_with_client_info)
@@ -23,6 +33,14 @@ class UserService
                                 headers: { 'Content-Type': 'application/json' })
   end
 
+  #
+  # Updates existing user
+  #
+  # @param [Object] user User Object for update
+  # @param [String] bearer_token
+  #
+  # @return [Json] Response of update user
+  #
   def self.update_user(user, bearer_token)
     user_data = get_user(user)
     update_user_payload = User.get_payload(user_data)
@@ -33,6 +51,13 @@ class UserService
                                            'Authorization': bearer_token })
   end
 
+  #
+  # Verifies if email is already registered
+  #
+  # @param [Object] user user object conatining email
+  #
+  # @return [Json] Response of verify email
+  #
   def self.check_email(user)
     RestClient::Request.execute(method: :get,
                                 url: @@check_email_url,
@@ -42,6 +67,13 @@ class UserService
                                                      client_secret: ApplicationConfig.client_secret } })
   end
 
+  #
+  # Sends email with reset password link
+  #
+  # @param [Object] user User object
+  #
+  # @return [Json] Response of reset password
+  #
   def self.reset_password(user)
     user_with_client_info = get_user_with_client_info(user)
     reset_password_payload = User.get_payload(user_with_client_info)
@@ -51,6 +83,14 @@ class UserService
                                 headers: { 'Content-Type': 'application/json' })
   end
 
+  #
+  # Updates old password to new password
+  #
+  # @param [Object] user User object with old and new password details
+  # @param [String] bearer_token
+  #
+  # @return [Json] Response of change password
+  #
   def self.change_password(user, bearer_token)
     user_data = get_user(user)
     change_password_payload = User.get_payload(user_data)
@@ -61,6 +101,13 @@ class UserService
                                            'Authorization': bearer_token })
   end
 
+  #
+  # Displays logged in user details
+  #
+  # @param [String] bearer_token
+  #
+  # @return [Json] Response containing logged in user details
+  #
   def self.show_logged_in_user(bearer_token)
     RestClient::Request.execute(method: :get,
                                 url: @@show_logged_in_user_url,
@@ -68,6 +115,14 @@ class UserService
                                            'Authorization': bearer_token })
   end
 
+  #
+  # Displays details of user id
+  #
+  # @param [String] user_id
+  # @param [String] bearer_token
+  #
+  # @return [Json] Response containing details of given user id
+  #
   def self.show_user_id(user_id, bearer_token)
     url_with_id = @@show_user_id_url + user_id.to_s
     RestClient::Request.execute(method: :get,
@@ -76,6 +131,13 @@ class UserService
                                            'Authorization': bearer_token })
   end
 
+  #
+  # Sets Client information to user object
+  #
+  # @param [Object] user User Object
+  #
+  # @return [Object] User with client details
+  #
   def self.get_user_with_client_info(user)
     user_with_client_info = ClientInfoBase.new
     user_with_client_info.client_id = ApplicationConfig.client_id
@@ -84,6 +146,13 @@ class UserService
     user_with_client_info
   end
 
+  #
+  # Sets Parent to User object
+  #
+  # @param [Object] user User Object
+  #
+  # @return [Object] User as child object
+  #
   def self.get_user(user)
     user_data = UserBase.new
     user_data.user = user

data/lib/services/user_widget_service.rb

@@ -2,11 +2,21 @@ require 'rest-client'
 require 'json'
 require_relative '../domain/application_config.rb'
 
+#
+# User Widget Service for widget display  based on user details
+#
 class UserWidgetService
   @@own_widgets_url = 'https://showoff-rails-react-production.herokuapp.com/api/v1/users/me/widgets'
   @@widgets_by_user_id_url = 'https://showoff-rails-react-production.herokuapp.com/api/v1/users/'
 
-  def self.private_widgets(bearer_token)
+  #
+  # Displays own widgets
+  #
+  # @param [String] bearer_token
+  #
+  # @return [Json] Response containing list of own widgets
+  #
+  def self.get_private_widgets(bearer_token)
     RestClient::Request.execute(method: :get,
                                 url: @@own_widgets_url,
                                 headers: { 'Content-Type': 'application/json',
@@ -15,7 +25,15 @@ class UserWidgetService
                                            'Authorization': bearer_token })
   end
 
-  def self.private_widgets_with_search_term(search_term, bearer_token)
+  #
+  # Displays own widget with search term
+  #
+  # @param [String] search_term
+  # @param [String] bearer_token
+  #
+  # @return [Json] Response containing list of own widget by search term
+  #
+  def self.get_private_widgets_with_search_term(search_term, bearer_token)
     RestClient::Request.execute(method: :get,
                                 url: @@own_widgets_url,
                                 headers: { 'Content-Type': 'application/json',
@@ -25,7 +43,15 @@ class UserWidgetService
                                            'Authorization': bearer_token })
   end
 
-  def self.widgets_by_user_id(user_id, bearer_token)
+  #
+  # Displays widgets for given user id
+  #
+  # @param [String] user_id
+  # @param [String] bearer_token
+  #
+  # @return [Json] Resopnse containing widgets list for given user id
+  #
+  def self.get_widgets_by_user_id(user_id, bearer_token)
     url_with_id = @@widgets_by_user_id_url + user_id.to_s + '/widgets'
     RestClient::Request.execute(method: :get,
                                 url: url_with_id,
@@ -35,7 +61,16 @@ class UserWidgetService
                                            'Authorization': bearer_token })
   end
 
-  def self.widgets_by_user_id_with_search_term(user_id, search_term, bearer_token)
+  #
+  # Displays widgets for given user id and serach term
+  #
+  # @param [String] user_id
+  # @param [String] search_term
+  # @param [String] bearer_token
+  #
+  # @return [Json] Response contating widget details for user id and serach term
+  #
+  def self.get_widgets_by_user_id_with_search_term(user_id, search_term, bearer_token)
     url_with_id = @@widgets_by_user_id_url + user_id.to_s + '/widgets'
     RestClient::Request.execute(method: :get,
                                 url: url_with_id,

data/lib/services/widget_service.rb

@@ -4,11 +4,22 @@ require_relative '../domain/widget_base.rb'
 require_relative '../domain/widget.rb'
 require_relative '../domain/application_config.rb'
 
+#
+# Widget Service for CRUD operation related to widget
+#
 class WidgetService
   @@create_widget_url = 'https://showoff-rails-react-production.herokuapp.com/api/v1/widgets'
   @@update_destroy_widget_url = 'https://showoff-rails-react-production.herokuapp.com/api/v1/widgets/'
   @@list_widget_url = 'https://showoff-rails-react-production.herokuapp.com/api/v1/widgets/visible'
 
+  #
+  # Creates Widget
+  #
+  # @param [Object] widget Widget object for create
+  # @param [String] bearer_token
+  #
+  # @return [Json] Response of create widget
+  #
   def self.create_widget(widget, bearer_token)
     widget_data = get_widget(widget)
     create_widget_payload = Widget.get_payload(widget_data)
@@ -18,6 +29,15 @@ class WidgetService
                                            'Authorization': bearer_token })
   end
 
+  #
+  # Updates existing widget
+  #
+  # @param [Object] widget Widget object for update
+  # @param [String] widget_id widget to update
+  # @param [String] bearer_token
+  #
+  # @return [Json] Response of update widget
+  #
   def self.update_widget(widget, widget_id, bearer_token)
     update_url_with_widget_id = @@update_destroy_widget_url + widget_id.to_s
     widget_data = get_widget(widget)
@@ -28,7 +48,15 @@ class WidgetService
                                            'Authorization': bearer_token })
   end
 
-  def self.destroy_widget(widget_id, bearer_token)
+  #
+  # Deletes own widget for given widget id
+  #
+  # @param [String] widget_id widgets to delete
+  # @param [String] bearer_token
+  #
+  # @return [Json] Response of delete widget
+  #
+  def self.delete_widget(widget_id, bearer_token)
     destroy_url_with_widget_id = @@update_destroy_widget_url + widget_id.to_s
     RestClient::Request.execute(method: :delete,
                                 url: destroy_url_with_widget_id,
@@ -36,13 +64,27 @@ class WidgetService
                                            'Authorization': bearer_token })
   end
 
-  def self.get_private_widgets(bearer_token)
+  #
+  # Lists own widgets
+  #
+  # @param [String] bearer_token
+  #
+  # @return [String] Response with list of own widgets
+  #
+  def self.get_own_widgets(bearer_token)
     RestClient::Request.execute(method: :get,
                                 url: @@create_widget_url,
                                 headers: { 'Content-Type': 'application/json',
                                            'Authorization': bearer_token })
   end
 
+  #
+  # Lists public widgets
+  #
+  # @param [String] bearer_token
+  #
+  # @return [Json] Response with list of public visible widgets
+  #
   def self.get_public_widgets(bearer_token)
     RestClient::Request.execute(method: :get,
                                 url: @@list_widget_url,
@@ -52,6 +94,14 @@ class WidgetService
                                            'Authorization': bearer_token })
   end
 
+  #
+  # Lists public widgets with search term
+  #
+  # @param [String] search_term
+  # @param [String] bearer_token
+  #
+  # @return [Json] Response with searched public widgets by given search term
+  #
   def self.get_public_widgets_with_search_term(search_term, bearer_token)
     RestClient::Request.execute(method: :get,
                                 url: @@list_widget_url,
@@ -62,6 +112,13 @@ class WidgetService
                                            'Authorization': bearer_token })
   end
 
+  #
+  # Sets Parent to Widget object
+  #
+  # @param [Object] widget Widget Object
+  #
+  # @return [Object] Widget as child object
+  #
   def self.get_widget(widget)
     widget_data = WidgetBase.new
     widget_data.widget = widget

data/lib/widgets_api_client.rb

@@ -63,22 +63,22 @@ class WidgetsApiClient
 
   # Get private widgets
   def self.show_private_widgets(bearer_token)
-    UserWidgetService.private_widgets(bearer_token)
+    UserWidgetService.get_private_widgets(bearer_token)
   end
 
   # Get private widgets with search term
   def self.show_private_widgets_with_search_term(search_term, bearer_token)
-    UserWidgetService.private_widgets_with_search_term(search_term, bearer_token)
+    UserWidgetService.get_private_widgets_with_search_term(search_term, bearer_token)
   end
 
   # Get widgets by user id
   def self.show_widgets_by_user_id(user_id, bearer_token)
-    UserWidgetService.widgets_by_user_id(user_id, bearer_token)
+    UserWidgetService.get_widgets_by_user_id(user_id, bearer_token)
   end
 
   # Get widgets by user id with search term
   def self.show_widgets_by_user_id_with_search_term(user_id, search_term, bearer_token)
-    UserWidgetService.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
 
   # Create widget
@@ -93,12 +93,12 @@ class WidgetsApiClient
 
   # Destroy widget
   def self.destroy_widget(widget_id, bearer_token)
-    WidgetService.destroy_widget(widget_id, bearer_token)
+    WidgetService.delete_widget(widget_id, bearer_token)
   end
 
   # Get private widgets
   def self.get_private_widgets(bearer_token)
-    WidgetService.get_private_widgets(bearer_token)
+    WidgetService.get_own_widgets(bearer_token)
   end
 
   # Get public widgets

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: widgets_api_client
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Sachin Murthy