widgets_api_client 0.0.9.2 → 0.0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b15a95afa5a46ed1479921ca8da5a930a4050d5aabb7a2f5f6fdf618d4f5e32
-  data.tar.gz: 4e9dda7e41b1d2ea71c14267cc5cf43d8e7b46c15ce78735e9d5ea9dd1ef4770
+  metadata.gz: abfa8dc11102c5118e2bcfc08d6a25b3c889b26483d01683070545f5d783619c
+  data.tar.gz: 7b94eaf58703e06d638f0168fc03f57e5d90359ec12a0ad140999bec4775eacd
 SHA512:
-  metadata.gz: 9bee356231cd71febc8dcf67f186b99e39b671100deb74aaa077b13bba93cf9db9c3e2f9a4979d0aab4129e129204711116ce3ff99f3ff6b22ca2b42c42dfe99
-  data.tar.gz: 5e958dbd17abeaeb1f7a00b0021d54a0669710ecd03c79f7610baa4d1dc488464c0a1822176f80de17b5e41686686bf008515bdc4ed0eb36ff8f4fb86dd595d9
+  metadata.gz: 36fdd7a781c578e29090dd2ff623b5a12d21b8ce76120bbf191a081228325e0f6ac7ab263610f3c3e8dac6010474632353735b8f14d94904ee82ed98c40fb86c
+  data.tar.gz: 3bac93832b82b94581c5858889e693b89a0d43729b30a125bc310c5eb31e02cf82363fe9325d066f51273e4e573e16b21fee00c20ea5d12fc1f740b645da0c43

data/lib/domain/application_config.rb

@@ -9,6 +9,13 @@ class ApplicationConfig
   @@base_url = ''
   @@config = {}
 
+  #
+  # Sets Application Configuration
+  #
+  # @param [String] client_id
+  # @param [String] client_secret
+  # @param [String] base_url
+  #
   def self.set_config(client_id, client_secret, base_url)
     @@client_id = client_id
     @@client_secret = client_secret

data/lib/widgets_api_client.rb

@@ -6,61 +6,142 @@ require File.dirname(__FILE__) + '/services/widget_service'
 require File.dirname(__FILE__) + '/services/user_widget_service'
 require File.dirname(__FILE__) + '/domain/application_config'
 
+#
+# Interface for gem methods
+#
 class WidgetsApiClient
+  
+  #
+  # Sets Application Configuration
+  #
+  # @param [String] client_id
+  # @param [String] client_secret
+  # @param [String] base_url
+  #
   def self.set_config(client_id, client_secret, base_url)
     ApplicationConfig.set_config(client_id, client_secret, base_url)
   end
 
+  #
+  # Return Client Id
+  #
+  # @return [String]
+  #
   def self.client_id
     ApplicationConfig.client_id
   end
 
-  # Create authentication token
+  #
+  # Creates authentication token
+  #
+  # @param [object] auth_data Authentication object
+  #
+  # @return [Json] Response with brearer and refresh token
+  #
   def self.create_authentication_token(auth_data)
     AuthenticationService.create_authentication(auth_data)
   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)
     AuthenticationService.refresh_authentication_token(auth_data, bearer_token)
   end
 
-  # Revoke authentication token
+  #
+  # 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)
     AuthenticationService.revoke_authentication_token(auth_data, bearer_token)
   end
 
-  # Create user
+  #
+  # Creates User
+  #
+  # @param [Object] user User Object for create
+  #
+  # @return [Json] Response of create user
+  #
   def self.create_user(user_data)
     UserService.create_user(user_data)
   end
 
-  # Update user
+  #
+  # 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_data, bearer_token)
     UserService.update_user(user_data, bearer_token)
   end
 
-  # Check email
+  #
+  # Verifies if email is already registered
+  #
+  # @param [Object] user user object conatining email
+  #
+  # @return [Json] Response of verify email
+  #
   def self.check_email(user_data)
     UserService.check_email(user_data)
   end
 
-  # Reset password
+  #
+  # Sends email with reset password link
+  #
+  # @param [Object] user User object
+  #
+  # @return [Json] Response of reset password
+  #
   def self.reset_password(user_data)
     UserService.reset_password(user_data)
   end
 
-  # Change password
+  #
+  # 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_data, bearer_token)
     UserService.change_password(user_data, bearer_token)
   end
 
-  # Show logged in user
+  #
+  # 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)
     UserService.show_logged_in_user(bearer_token)
   end
 
-  # Show user id
+  #
+  # 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)
     UserService.show_user_id(user_id, bearer_token)
   end
@@ -120,7 +201,7 @@ b = User.new
     b.first_name = "sam"
     b.last_name = "test"
     b.password = "password"
-    b.email = "sam@gmail.com"
+    b.email = "sam1@gmail.com"
     b.image_url = "https://static.thenounproject.com/png/961-200.png"
     WidgetsApiClient.set_config("277ef29692f9a70d511415dc60592daf4cf2c6f6552d3e1b769924b2f2e2e6fe", "d6106f26e8ff5b749a606a1fba557f44eb3dca8f48596847770beb9b643ea352",
        "https://showoff-rails-react-production.herokuapp.com")

metadata

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