gatepass 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6adfbc31cccc12d1786457c468667bcba579db0db4639aae68a01bb61a570e64
-  data.tar.gz: 5e456e23ddcda822bc391601c88fb0286184abc9f164de6ad2cf35e1765b912d
+  metadata.gz: 6e7aeabfb6de154ecf1aa96f4e9009137eb8e9c674c3a8be94f4eddce9880945
+  data.tar.gz: ca35a4b1f36f2f943b4dcbebfcbfce21c698a7f173bce1f991038e48d273958d
 SHA512:
-  metadata.gz: 10d45f2705514fbd230e72a336f13935e88d571b55d76431c1acedb942f47c34b84cb352c55c442842fe1df00d08641b21ac02444ded243149aba3a77f20e0c9
-  data.tar.gz: 200c1bf025039c8e889951d30afe355dc8b010087c8e66526d854ff38438887b6cb329ccefdb00f063baf4e3f5d4017346b45ba564160890ffc2b3e78a954304
+  metadata.gz: 877b3867d4b2e5d565d2ea57ccc367ba368c62a17afd6aa98db3fa5aedbf91d3879c3bacd220da4af11feeae82ae1212cc27ad521984d17ee38f6f6ab2785e86
+  data.tar.gz: 754407cd8631ac1f502d766a1939d6fbba4e387817c8335584740b196f8572cdfe13f0c0af456d3ccf9a9d8785f6e2ba559d5740da01c835b3b9d021967dad1a

data/README.md

@@ -2,7 +2,7 @@
 Short description and motivation.
 
 ## Usage
-How to use my plugin.
+See the Installation section below.
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -21,6 +21,12 @@ Or install it yourself as:
 $ gem install gatepass
 ```
 
+Mount the engine with the following line in `config/routes.rb` :
+```
+mount Gatepass::Engine => '/gatepass'
+```
+Ensure you also have the root configured (Eg. `root 'home#index''`) for your Rails application.
+
 Modify the application controller to include the Gatepass module and add the authentication check:
 ```
 class ApplicationController < ActionController::Base
@@ -29,7 +35,19 @@ class ApplicationController < ActionController::Base
 end
 ```
 
-TODO - Configuration parameters
+In `config/application.rb` , define the following configuration parameters:
+```
+config.ldap_server_hostname = 'myldap.com'
+config.ldap_server_port = 636
+config.ldap_ca_cert = '/etc/path/ca.cert'
+config.ldap_base = 'DN=myldap,DN=com'
+```
+
+Run the migrations with:
+```
+rails gatepass:install:migrations
+rails db:migrate
+```
 
 Create an initial user account with:
 ```
@@ -52,7 +70,7 @@ auth_type is `local` or `activedirectory`.
 Use a dummy password for activedirectory users.
 
 ## Contributing
-Contribution directions go here.
+Create a pull request on GitHub.
 
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/controllers/gatepass/authentication_controller.rb

@@ -1,13 +1,17 @@
 module Gatepass
+  # Provides the login/logout functionality
   class AuthenticationController < ApplicationController
+    # Display the login form
     def login
     end
 
+    # Remove the user from the session and redirect to the login form
     def logout
       session.delete :user
       redirect_to  :action => :login
     end
 
+    # Process the POST from the login form
     def authenticate
       username = params[:username]
       password = params[:password]
@@ -25,7 +29,7 @@ module Gatepass
       elsif user.auth_type == 'activedirectory' # 'ldap'
         require 'net/ldap'
 
-        server_address = Rails.application.config.ldap_server_hostname  # 'ad.nitinkatkam.mdbrecruit.net'
+        server_address = Rails.application.config.ldap_server_hostname
         server_port = Rails.application.config.ldap_server_port
         ca_certificate = Rails.application.config.ldap_ca_cert
 
@@ -34,7 +38,7 @@ module Gatepass
                              :encryption => {
                                method: :simple_tls,
                                tls_options: {
-                                 ca_file: ca_certificate  # '/Users/nitin.katkam/Downloads/nitinkatkam-ad-ca.cer',
+                                 ca_file: ca_certificate
                                  # verify_mode: OpenSSL::SSL::VERIFY_NONE
                                }
                              },
@@ -45,18 +49,16 @@ module Gatepass
                              }
 
         filter = Net::LDAP::Filter.eq("distinguishedname", user.username_mapping)
-        treebase = Rails.application.config.ldap_base  # "dc=nitinkatkam, dc=mdbrecruit, dc=net"
+        treebase = Rails.application.config.ldap_base
 
         search_result_count = 0
         ldap.search(:base => treebase, :filter => filter) do |entry|
           search_result_count += 1
-          # puts "DN: #{entry.dn}" # CN=bindUser1,CN=Users,DC=nitinkatkam,DC=mdbrecruit,DC=net
-          # puts "memberOf: #{entry.memberof}" #["CN=peopleOfNitinKatkam,CN=Users,DC=nitinkatkam,DC=mdbrecruit,DC=net", "CN=Administrators,CN=Builtin,DC=nitinkatkam,DC=mdbrecruit,DC=net"]
 
           if ldap.get_operation_result.code == 49 or search_result_count == 0
             redirect_to({ controller: 'gatepass/authentication', action: 'login' })
           elsif search_result_count == 1
-            session[:user] = user # entry  # user_obj
+            session[:user] = user # entry
             redirect_to main_app.root_url
           else
             redirect_to({ controller: 'gatepass/authentication', action: 'login' })

data/lib/gatepass/version.rb

@@ -1,3 +1,3 @@
 module Gatepass
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/gatepass.rb

@@ -2,9 +2,10 @@ require "gatepass/version"
 require "gatepass/engine"
 
 module Gatepass
+  # Check if the user is defined in the session; if not, redirects to the login page
   def check_authenticated
     if session[:user].nil?
-      redirect_to user_auth.authentication_login_path ({ :controller => 'gatepass/authentication', :action => :login })
+      redirect_to gatepass.authentication_login_path ({ :controller => 'gatepass/authentication', :action => :login })
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gatepass
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Nitin Reddy
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-26 00:00:00.000000000 Z
+date: 2023-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.1.19
+- !ruby/object:Gem::Dependency
+  name: net-ldap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.18.0
 description: This Rails plugin enables you to authenticate users against the local
   database as well as against an ActiveDirectory server
 email:
@@ -77,9 +91,11 @@ files:
 - lib/gatepass/engine.rb
 - lib/gatepass/version.rb
 - lib/tasks/gatepass_tasks.rake
-homepage:
+homepage: https://github.com/pockettheories/gatepass
 licenses: []
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/pockettheories/gatepass
+  source_code_uri: https://github.com/pockettheories/gatepass
 post_install_message:
 rdoc_options: []
 require_paths: