Release Version 11.3.0

Release Version 11.3.0

Author: indrasen715

CHANGELOG.md

@@ -1,5 +1,19 @@
 > **LoginRadius Ruby On Rails SDK Change Log** provides information regarding what has changed, more specifically what changes, improvements and bug fix has been made to the SDK. For more details please refer to the [LoginRadius API Documention](https://docs.loginradius.com/api/v2/sdk-libraries/ruby)
 
+
+# Version 11.3.0
+Release on January 28, 2022
+
+## Enhancements
+
+ - Added a feature to add ApiKey and ApiSecret directly in LoginRadius manual SOTT generation method.
+ - Added Licence and Contribution Guideline file.
+
+
+## Breaking Changes
+
+For developers migrating from v11.2.2, there will be 1 minor breaking change in terms of SDK implementation. In this version, we have added a feature to add ApiKey & ApiSecret directly into the manual SOTT generation method `local_generate_sott()`.
+
 # Version 11.2.2
 Release on September 15, 2021
 

CONTRIBUTING.md

@@ -0,0 +1,41 @@
+# Contributing
+
+[ROR SDK](https://github.com/LoginRadius/ruby-on-rails-sdk) is [MIT](LICENSE) licensed and accepts contributions via GitHub pull requests. This document outlines some of the conventions on development workflow, commit message formatting, contact points, and other resources to make it easier to get your contribution accepted.
+
+## Getting Started
+
+- Fork the repository on GitHub.
+- If you find any bug or Improvement in our existing code-base, please create a pull request as mentioned in Contribution Flow.
+
+## Contribution Flow
+
+This is a rough outline of what a contributor's workflow looks like:
+
+- Create a separate branch from the `dev` branch to base your work.
+- Make commits of logical units.
+- Make sure your commit messages are in the proper format (see below).
+- Push your changes to a topic branch in your fork of the repository.
+- Submit a pull request to the original repository.
+- **Please ensure that you raise a PR on the `dev` branch instead of `master`.**
+
+#### Commit Messages
+
+Please follow the below format while writing commit messages:
+
+```
+  title: One line description about your change
+  <Blank Line>
+  description: An optional description of your changes.
+```
+
+Thanks for your contributions!
+
+## Code of Conduct
+
+### Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+### Our Responsibilities
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2022 LoginRadius Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -35,7 +35,7 @@ Or
 
 
 ````
- gem 'login_radius', '~> 11.2.2'
+ gem 'login_radius', '~> 11.3.0'
 ````
 
 
@@ -5210,7 +5210,23 @@ response = WebHookApi.web_hook_unsubscribe(web_hook_subscribe_model)
 
  ```
 
-  
+
+### Generate SOTT Manually
+SOTT is a secure one-time token that can be created using the API key, API secret, and a timestamp ( start time and end time ). You can manually create a SOTT using the following function.
+
+
+
+```
+time_difference=10 # (Optional) The time_difference will be used to set the expiration time of SOTT, If you do not pass time_difference then the default expiration time of SOTT is 10 minutes.
+
+api_key="" # (Optional) LoginRadius Api Key.
+
+api_secret="" # (Optional) LoginRadius Api Secret (Only Primary Api Secret is used to generate the SOTT manually).
+
+
+sott = AuthenticationApi.local_generate_sott(time_difference,api_key,api_secret);
+print sott
+```
 
 
 

demo/vendor/gems/login_radius/README.md

@@ -3,7 +3,7 @@
 Install the SDK by adding LoginRadius to your application's `Gemfile`.
 
 ```
-gem 'login_radius', '~> 11.2.2'
+gem 'login_radius', '~> 11.3.0'
 ```
 
 Then, run `$ bundle`. A copy of the SDK can also be found on our [Github](https://github.com/LoginRadius/ruby-on-rails-gem/tree/master).

demo/vendor/gems/login_radius/lib/login_radius/request_client.rb

@@ -280,20 +280,25 @@ def create_hash_secret(endpoint, secret_key, headers, body = {})
     end
 
     # Local - Generate SOTT:
-    # Generates a Secured One Time Token locally.
-    #
-    # @params validity_length [Integer]    Length of time the SOTT is valid for in minutes
+    # Generates a Secured One Time Token manually.
     #
+    # @params time_difference [Integer]   (Optional)The time_difference will be used to set the expiration time of SOTT, If you do not pass time_difference then the default expiration time of SOTT is 10 minutes.
+    # @params api_key [String] (Optional) LoginRadius Api Key.
+    # @params api_secret [String] (Optional) LoginRadius Api Secret.
     # @returns sott [String]               LoginRadius Secured One Time Token
-    def local_generate_sott(validity_length = 10)
-      start_time = Time.now.getutc().strftime('%Y/%m/%d %H:%M:%S')
-      end_time = (Time.now.getutc() + (validity_length*60)).strftime('%Y/%m/%d %H:%M:%S')
+    def local_generate_sott(time_difference = 10, api_key="", api_secret="")
+
+      key=!isNullOrWhiteSpace(api_key) ? api_key:ENV['API_KEY']
 
-      plain_text = start_time + '#' + ENV['API_KEY'] + '#' + end_time
+      secret=!isNullOrWhiteSpace(api_secret) ? api_secret:ENV['API_SECRET']
+
+      start_time = Time.now.getutc().strftime('%Y/%m/%d %H:%M:%S')
+      end_time = (Time.now.getutc() + (time_difference*60)).strftime('%Y/%m/%d %H:%M:%S')
+      plain_text = start_time + '#' + key + '#' + end_time
       iter = 10000
       salt = "\x00\x00\x00\x00\x00\x00\x00\x00"
       key_len = KEY_SIZE / 8
-      cipher_key = OpenSSL::PKCS5.pbkdf2_hmac_sha1(ENV['API_SECRET'], salt, iter, key_len)
+      cipher_key = OpenSSL::PKCS5.pbkdf2_hmac_sha1(secret, salt, iter, key_len)
 
       cipher = OpenSSL::Cipher.new('aes-' + KEY_SIZE.to_s + '-cbc')
       cipher.encrypt

demo/vendor/gems/login_radius/lib/login_radius/version.rb

@@ -1,3 +1,3 @@
 module LoginRadius
-  VERSION = "11.2.2"
+  VERSION = "11.3.0"
 end

sdk/src/login_radius/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2022 LoginRadius Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

sdk/src/login_radius/README.md

@@ -3,7 +3,7 @@
 Install the SDK by adding LoginRadius to your application's `Gemfile`.
 
 ```
-gem 'login_radius', '~> 11.2.2'
+gem 'login_radius', '~> 11.3.0'
 ```
 
 Then, run `$ bundle`. A copy of the SDK can also be found on our [Github](https://github.com/LoginRadius/ruby-on-rails-gem/tree/master).

sdk/src/login_radius/lib/login_radius/request_client.rb

@@ -280,20 +280,25 @@ def create_hash_secret(endpoint, secret_key, headers, body = {})
     end
 
     # Local - Generate SOTT:
-    # Generates a Secured One Time Token locally.
-    #
-    # @params validity_length [Integer]    Length of time the SOTT is valid for in minutes
+    # Generates a Secured One Time Token manually.
     #
+    # @params time_difference [Integer]   (Optional)The time_difference will be used to set the expiration time of SOTT, If you do not pass time_difference then the default expiration time of SOTT is 10 minutes.
+    # @params api_key [String] (Optional) LoginRadius Api Key.
+    # @params api_secret [String] (Optional) LoginRadius Api Secret.
     # @returns sott [String]               LoginRadius Secured One Time Token
-    def local_generate_sott(validity_length = 10)
-      start_time = Time.now.getutc().strftime('%Y/%m/%d %H:%M:%S')
-      end_time = (Time.now.getutc() + (validity_length*60)).strftime('%Y/%m/%d %H:%M:%S')
+    def local_generate_sott(time_difference = 10, api_key="", api_secret="")
+
+      key=!isNullOrWhiteSpace(api_key) ? api_key:ENV['API_KEY']
 
-      plain_text = start_time + '#' + ENV['API_KEY'] + '#' + end_time
+      secret=!isNullOrWhiteSpace(api_secret) ? api_secret:ENV['API_SECRET']
+
+      start_time = Time.now.getutc().strftime('%Y/%m/%d %H:%M:%S')
+      end_time = (Time.now.getutc() + (time_difference*60)).strftime('%Y/%m/%d %H:%M:%S')
+      plain_text = start_time + '#' + key + '#' + end_time
       iter = 10000
       salt = "\x00\x00\x00\x00\x00\x00\x00\x00"
       key_len = KEY_SIZE / 8
-      cipher_key = OpenSSL::PKCS5.pbkdf2_hmac_sha1(ENV['API_SECRET'], salt, iter, key_len)
+      cipher_key = OpenSSL::PKCS5.pbkdf2_hmac_sha1(secret, salt, iter, key_len)
 
       cipher = OpenSSL::Cipher.new('aes-' + KEY_SIZE.to_s + '-cbc')
       cipher.encrypt

sdk/src/login_radius/lib/login_radius/version.rb

@@ -1,3 +1,3 @@
 module LoginRadius
-  VERSION = "11.2.2"
+  VERSION = "11.3.0"
 end