user_management_rails 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5d1909d8b0e260c2b033ead5e6ca86299ba18712
-  data.tar.gz: f00e5625bed7d4e27458438c28adf2a220d0f89d
+SHA256:
+  metadata.gz: 9bad4e0973506e6ab846fc6265f84d4cd9e76aff3c762522d8b536cbf7cbfcbb
+  data.tar.gz: f56c50c9812b39249953dfe0aa06f0f84331f170cdea83d99ad44a5758029117
 SHA512:
-  metadata.gz: d7364f85e3a62bb90d6316f47093c2b6fff0da0866a389674cf3fbaf991ae653df39cf62bf9c0b9dd078162035a3c284585a8ce9e8eda80c0fade915dd9a8bdd
-  data.tar.gz: a7548e2026aae1f650a1c41dd676b196f644f589dab6413a70888d8934fdddd15a399335b8680bf0db4a90d14e94dc1e07d8edc1f255b34f18611d84adbf82a0
+  metadata.gz: 18a6994d399b64f54e727019b15297d44791c49639a098efffc6102be6c93c7072baa352cde9b30ddd6da792bb4fbe0ab4f198171cd74c922b58ef9b4b0733a7
+  data.tar.gz: 9735957dffd941cd5baf1e3f910de71a521b4e4691a9069d4564facb2e2771065c966e58c5a1949afd724bfc209769521cb4dc02437ea534ed3cd779a835285e

data/README.md

@@ -34,14 +34,29 @@ And then execute:
 $ bundle
 ```
 
-Or install it yourself as:
+Next, you need to run the generator:
 ```bash
-$ gem install user_management_rails
+$ rails generate user_management_rails:install --ringcaptcha-key=RINGCAPTCHA_APP_KEY --um-key=UM_KEY [--mode=OTP|PASSWORD]
+```
+
+This will add the necessary controller, view, and routes.
+You can update the files according to your needs.
+
+Default routes installed:
+```bash
+$ rake routes
+Prefix Verb URI Pattern      Controller#Action
+user_management_rails      /                UserManagementRails::Engine
+                 home GET  /home(.:format)  user_management#loggedin
+                login GET  /login(.:format) user_management#login
+                 root GET  /                user_management#signup
+
+Routes for UserManagementRails::Engine:
+logins POST /logins(.:format) user_management_rails/logins#create
 ```
 
 ## Requirements 
-To use gem you should provide environment variable with UM public key called 'JWT_PUBLIC_KEY'.
-Also, in your routes.rb file you should specify where `/login` endpoint will be mount.
+In your routes.rb file you should specify where `/login` endpoint will be mount.
 Example: 
 ```ruby
  mount UserManagementRails::Engine, at: '/'  
@@ -53,6 +68,8 @@ If you already have a '/login' endpoint you can isolate it by
 ```   
 Then gems `/login` endpoint will be mounted on `domain.com/some_path/logins`
 
+* rails generator adds this route by default as stated above.
+
 ## Adding new version of gem to rubygems repository
 After you made changes and increment version of gem in(/lib/user_management_rails/version.rb)
 you need to build and push new gem file to rubygems.org: 

data/lib/generators/templates/README

@@ -0,0 +1,19 @@
+===============================================================================
+
+Installation done!
+
+  1. You can now visit '/login' for your signin page.
+
+       If you would like to check default routes:
+
+         rake routes
+
+  2. If you like to change your keys, check out:
+
+         config/initializers/user_management.rb
+
+  3. You can customize views on your app according to your needs:
+
+       app/views/user_management/*.html.erb
+
+===============================================================================

data/lib/generators/templates/controllers/user_management_controller.rb

@@ -0,0 +1,28 @@
+class UserManagementController < ApplicationController
+  include UserManagementRails::Concerns::UserResource
+
+  def signup
+    if current_user_hash
+       redirect_to action: 'loggedin'
+    else
+      render 'signup'
+    end
+  end
+
+  def login
+    if current_user_hash
+      redirect_to action: 'loggedin'
+    else
+      render 'login'
+    end
+  end
+
+  def loggedin
+    if current_user_hash
+      @userinfo = current_user_hash.values_at("phone","email")
+    else
+      redirect_to action: 'login'
+    end
+  end
+
+end

data/lib/generators/templates/user_management_initializer.rb

@@ -0,0 +1,5 @@
+UserManagementRails.configure do |config|
+  config.um_key = "<%= options['um_key'] %>"
+  config.ringcaptcha_key = "<%= options['ringcaptcha_key'] %>"
+  config.jwt_public_key = "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAvvoSdfTthi+8Q18teTftAyyXq2WbnUjc62tIPRRJmWnd2YoP6d245EzMtXL8WnNq1khEiIFevpLLnV+fHY/QmlayP0dUqR+P0yGgMCxzpIPONZC/X5ndUpjbkjk/LF6NOrQXJcY6HfFY6TwoPr6DbCb49WUxkIHTaaaW8wJAartAI/fVmd0mnihacap85cCsfWH4lm+c9f/a/+gx5F6ndgL+zvm8uda7I5qlK9myczsj8CGT3QtH30GSGZ1kXUH3v61tYoBsCm+BM5DGZrPxsACb8vpoP3WDKq+BSNUa7QWUklA/pRF1dpDqhUChF0FocsFNfvTI+3k1s2gjsjc6rwIDAQAB\n-----END PUBLIC KEY-----"
+end

data/lib/generators/templates/views/loggedin.html.erb

@@ -0,0 +1,9 @@
+<!DOCTYPE html>
+<html>
+  <head>
+  </head>
+  <body>
+    <h3>"You Are Logged In as"</h3>
+    <h4><%%= @userinfo %></h4>
+  </body>
+</html>

data/lib/generators/templates/views/login.html.erb

@@ -0,0 +1,66 @@
+<!DOCTYPE html>
+<html>
+
+  <head>
+  </head>
+
+  <body>
+    <div id='widget-point'>
+    </div>
+
+    <script type='text/javascript' src="//code.jquery.com/jquery-3.1.1.min.js"></script>
+
+    <script type='text/javascript' src="//cdn.rawgit.com/oauth-io/oauth-js/c5af4519/dist/oauth.js"></script>
+
+    <script type='text/javascript' src="https://s3.amazonaws.com/ringcaptcha-test/widget/jwt-20180328/bundle.js"></script>
+
+
+    <script type='text/javascript'>
+      $(document).ready(function() {
+        $('#widget-point').append(
+          '<div id="xyz" data-widget data-locale="en" data-mode="login" data-type="dual"></div>'
+        );
+
+        $('#xyz').each(function() {
+          // var appKey = "3i8i2ihu7e9u6orapyga";
+          // var userManagementId = '0bb071d01611abdf8e76c3';
+          var appKey = "<%%= UserManagementRails.configuration.ringcaptcha_key %>";
+          var userManagementId = "<%%= UserManagementRails.configuration.um_key %>";
+          var oauthioKey = 'HwAr2OtSxRgEEnO2-JnYjsuA3tc';
+          var settings = $(this).data();
+          // Initialize the SDK
+          //OAuth.initialize(oauthioKey)
+          settings.app = appKey;
+          settings.events = {
+            login: function(event, formValues) {
+              console.log("Login: event:", event);
+              console.log("Login: formValues:", formValues);
+              const dataString = localStorage.getItem('ringcaptcha.widget.' + appKey);
+              const data = dataString ? JSON.parse(dataString) : null;
+              console.log("Login: data:", data);
+              console.log("Login success for:", formValues.login);
+              $.post('/logins',{jwt:formValues['jwt']});
+              window.location.replace('./home');
+            }
+          };
+          settings.form = [
+            {
+              id: 'email',
+              type: 'text',
+              placeholder: 'Email',
+            },
+            {
+              id: 'pin',
+              type: 'pin'
+            }
+          ];
+          settings.userManagement = true;
+          settings.phoneLogin = true;
+          settings.userManagementAppId = userManagementId;
+
+          new RingCaptcha.Widget(this, settings.app, settings);
+        });
+      });
+    </script>
+  </body>
+</html>

data/lib/generators/templates/views/signup.html.erb

@@ -0,0 +1,79 @@
+<!DOCTYPE html>
+<html>
+
+  <head>
+  </head>
+
+  <body>
+    <div id='widget-point'>
+    </div>
+
+    <script type='text/javascript' src="//code.jquery.com/jquery-3.1.1.min.js"></script>
+
+    <script type='text/javascript' src="//cdn.rawgit.com/oauth-io/oauth-js/c5af4519/dist/oauth.js"></script>
+
+    <script type='text/javascript' src="https://s3.amazonaws.com/ringcaptcha-test/widget/jwt-20180328/bundle.js"></script>
+
+    <script>
+    $(document).ready(function() {
+        $('#widget-point').append(
+          '<div id="xyz" data-widget data-locale="en" data-mode="signup" data-type="dual"></div>'
+        );
+          $('#xyz').each(function() {
+            // var appKey = "3i8i2ihu7e9u6orapyga";
+            // var userManagementId = '0bb071d01611abdf8e76c3';
+            var appKey = "<%%= UserManagementRails.configuration.ringcaptcha_key %>";
+            var userManagementId = "<%%= UserManagementRails.configuration.um_key %>";
+            var oauthioKey = "HwAr2OtSxRgEEnO2-JnYjsuA3tc";
+            var settings = $(this).data();
+            // Initialize the SDK
+            OAuth.initialize(oauthioKey)
+            settings.app = appKey;
+            settings.events = {
+              signup: function(event, formValues) {
+                console.log("Signup: event:", event);
+                console.log("Signup: formValues:", formValues);
+                const dataString = localStorage.getItem('ringcaptcha.widget.' + appKey);
+                const data = dataString ? JSON.parse(dataString) : null;
+                console.log("Signup: data:", data);
+                User.signup({
+                  email: formValues.email,
+                  password: "Freef0rall!",
+                  firstname: "Fname",
+                  lastname: "Lname",
+                  phone: formValues.phone
+                  }).done(function(user) {
+                   console.log("User.signup success for:", formValues.email);
+                   $.post('/logins',{jwt:formValues['jwt']});
+                   window.location.replace('/home');
+                 });
+              }
+            };
+          settings.form = [
+            {
+              id: 'email',
+              type: 'email',
+              placeholder: 'Email',
+              validations: {
+                presence: 'Email should be present',
+                format: { message: 'Invalid email' }
+              }
+            },
+            {
+              id: 'phone',
+              type: 'phone',
+              validations: {
+                length: { min: 5, max: 15, message: 'Invalid phone' }
+              }
+            }
+          ];
+          settings.userManagement = true;
+          settings.phoneLogin = true;
+          settings.userManagementAppId = userManagementId;
+
+          new RingCaptcha.Widget(this, settings.app, settings);
+        });
+      });
+    </script>
+  </body>
+</html>

data/lib/generators/user_management_rails/install_generator.rb

@@ -0,0 +1,66 @@
+module UserManagementRails
+  class InstallGenerator < Rails::Generators::Base
+
+    desc <<-DESC.strip_heredoc
+        Create UserManagementRails boilerplate (controller and view) in your app folder.
+
+        Required Flags:
+
+        Use -r to specify your RingCaptcha app key.
+        Use -u to specify your UM key (for login mode only).
+
+        Optional Flags:
+
+        Use -m to specify login mode (options: password, otp).
+
+        If you do no specify a mode, password mode will be created by default.
+        For example:
+
+          rails generate user_management_rails:install users -m=password -r=XXXXXX -u=XXXXX
+
+        This will create a controller class at app/controllers/user_management_controller.rb like this:
+
+          class UserManagementController < ApplicationController
+            content...
+          end
+    DESC
+
+    source_root File.expand_path("../../templates", __FILE__)
+    class_option :ringcaptcha_key, required: true, aliases: "-r", type: :string,
+        desc: "Specify the RingCaptcha app key."
+    class_option :um_key, required: true, aliases: "-u", type: :string,
+        desc: "Specify the User Management key."
+    class_option :mode, aliases: "-m", type: :string, default: 'otp',
+        desc: "Specify the King Authr mode. Possible values: [otp|password]"
+
+    def add_initializer
+      template "user_management_initializer.rb", "config/initializers/user_management.rb"
+    end
+
+    def create_controller
+      template "controllers/user_management_controller.rb",
+                   "app/controllers/user_management_controller.rb"
+    end
+
+    def create_view
+      template "views/signup.html.erb",
+                   "app/views/user_management/signup.html.erb"
+      template "views/login.html.erb",
+                   "app/views/user_management/login.html.erb"
+      template "views/loggedin.html.erb",
+                   "app/views/user_management/loggedin.html.erb"
+    end
+
+    def add_routes
+      route "root 'user_management#signup'"
+      route "get '/login', to: 'user_management#login'"
+      route "get '/home', to: 'user_management#loggedin'"
+      route "mount UserManagementRails::Engine, at: '/'"
+    end
+
+    def show_readme
+      readme "README" if behavior == :invoke
+    end
+
+  end
+end

data/lib/user_management_rails.rb

@@ -4,12 +4,14 @@ require 'dotenv-rails'
 
 module UserManagementRails
   def self.decode_user(jwt)
-    pub_key = OpenSSL::PKey::RSA.new(ENV['JWT_PUBLIC_KEY'])
+    # pub_key = OpenSSL::PKey::RSA.new(ENV['JWT_PUBLIC_KEY'])
+    pub_key = OpenSSL::PKey::RSA.new(self.configuration.jwt_public_key)
     JWT.decode(jwt, pub_key, true, algorithm: 'RS256')[0]
   end
 
   def self.valid_jwt?(jwt)
-    pub_key = OpenSSL::PKey::RSA.new(ENV['JWT_PUBLIC_KEY'])
+    # pub_key = OpenSSL::PKey::RSA.new(ENV['JWT_PUBLIC_KEY'])
+    pub_key = OpenSSL::PKey::RSA.new(self.configuration.jwt_public_key)
     begin
       JWT.decode(jwt, pub_key, true, algorithm: 'RS256')[0]
     rescue JWT::DecodeError
@@ -18,4 +20,24 @@ module UserManagementRails
     true
   end
 
+  # initializers
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :um_key, :ringcaptcha_key, :jwt_public_key
+
+    def initialize
+      @um_key = nil
+      @ringcaptcha_key = nil
+      @jwt_public_key = nil
+    end
+  end
+
 end

data/lib/user_management_rails/version.rb

@@ -1,3 +1,3 @@
 module UserManagementRails
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: user_management_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - RingCaptcha
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-27 00:00:00.000000000 Z
+date: 2018-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -205,6 +205,13 @@ files:
 - app/views/layouts/user_management_rails/application.html.erb
 - app/views/user_managemet_rails/logins/index.html.erb
 - config/routes.rb
+- lib/generators/templates/README
+- lib/generators/templates/controllers/user_management_controller.rb
+- lib/generators/templates/user_management_initializer.rb
+- lib/generators/templates/views/loggedin.html.erb
+- lib/generators/templates/views/login.html.erb
+- lib/generators/templates/views/signup.html.erb
+- lib/generators/user_management_rails/install_generator.rb
 - lib/tasks/user_management_rails_tasks.rake
 - lib/user_management_rails.rb
 - lib/user_management_rails/engine.rb
@@ -229,7 +236,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: RingCaptcha widget RoR helper.