bpluser 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: abdb48f9fc552414be7298fdc2b0cb6d4e2517bc87ef5f44ac2ef3e4a869ea2f
-  data.tar.gz: 8a7ec2a43bd1badfc2ddf33ad767c7262fe39847c2cca5e7a1b18da452468ace
+  metadata.gz: cd649e2a92743c6ccfba60658937a9f8875e852fdb0d69ab4e492b3847c0da0c
+  data.tar.gz: cb75d8272d9c0a349420742b3387b6a0c9c34a4543dc506da9ce15cf6b3a97cb
 SHA512:
-  metadata.gz: 1a22bd759304d114c0583c83b8ea2485b016cdccfbaad5061c5883de47c772b7a7f91efa92b0e3671915f4b322ebba7338e81ecde75222754c837aa940b42341
-  data.tar.gz: 483c799849eeee668ccc22f6346e7e3cb20af481fc1a768eed79f1d5e8c6a7f5ea004111b774d415c92766f0bc20901b29e18928384b39dbe862286f81b40926
+  metadata.gz: e0f409d0f76f047bd5183e70efdea64a82b13a8c3f34cf5bf70531985fc8794a3fe0fce0c663e7aa6f9b03af759c356ba0d218f9c68b1fe9f6269ca4af318fd8
+  data.tar.gz: fe4199c4dcb0a8f152697d878924237968004e96490dcc47df0d793f00b97686aa02adb4c44040b03b134c095cd35fa2acbbe6a6fe0a0d79b757244d22ae064b

data/README.md

@@ -8,13 +8,13 @@ Rails engine for providing Devise-based user models and functionality for digita
 This includes bookmarks (Blacklight default), custom folders, and saved searches.
 
 # Requirements
-- `ruby >= 2.6.10`
-- `rails ~> 6.0.6`
+- `ruby >= 3.1, < 3.2`
+- `rails ~> 6.1.7`
 - `postgres v12 or higher`
 
 To install, add the following to your Gemfile:
 ```ruby
-gem 'bpluser', '~> 0.1.0'
+gem 'bpluser', '~> 0.5.0'
 # OR
 gem 'bpluser', git: 'https://github.com/boston-library/bpluser'
 ```
@@ -31,3 +31,42 @@ rails bpluser:install:update_migrations
 ```
 
 (Note that the installer will ask to overwrite your local `config/locales/devise.en.yml`).
+
+### Local development
+
+In one console, start Solr from project root:
+```
+$ solr_wrapper --config .solr_wrapper.yml 
+```
+In a second console, index the sample Solr documents (run from `./spec/dummy`):
+```
+# Solr must be running
+$ bundle exec rake bpluser:test_index:seed
+```
+Run the migrations and start the app (in second console, run from `./spec/dummy`):
+```
+bundle exec rake db:create
+bundle exec rake db:migrate
+rails s
+# app should be accessible at 127.0.0.1:3000
+```
+
+### Running tests
+
+Start Solr from project root:
+```
+$ solr_wrapper --config .solr_wrapper_test.yml 
+```
+Index the sample Solr documents (run from `./spec/dummy`):
+```
+# Solr must be running
+$ RAILS_ENV=test bundle exec rake bpluser:test_index:seed
+```
+Run specs
+```
+# run all tests
+$ bundle exec rake spec
+
+# run a single spec
+$ bundle exec rake spec SPEC=./spec/models/some_model_spec.rb
+```

data/app/controllers/bookmarks_controller.rb

@@ -22,7 +22,7 @@ class BookmarksController < CatalogController
 
     if request.xhr?
       # success ? render(json: { bookmarks: { count: current_or_guest_user.bookmarks.count }}) : render(:text => "", :status => "500")
-      success ? render(:update) : render(plain: '', status: '500')
+      success ? render(:update) : render(plain: '', status: :internal_server_error)
     else
       if @bookmarks.any? && success
         flash[:notice] = I18n.t('blacklight.bookmarks.add.success', count: @bookmarks.count)

data/app/controllers/concerns/bpluser/registrations.rb

@@ -10,14 +10,30 @@ module Bpluser
     end
 
     module InstanceMethods
-      # POST /resource
+      # override #create from Devise::RegistrationsController to add verify_captcha and logic for error handling
+      # this is the best way to preserve and re-render any submitted params when verify_recaptcha fails
       def create
-        if User.exists?(email: sign_up_params[:email])
-          flash[:error] = "An account with that email (#{sign_up_params[:email]}) already exists. Please sign in or click the \"Forgot your password?\" link below."
-          redirect_to new_user_session_path and return
-        end
+        build_resource(sign_up_params)
+
+        resource.save if verify_recaptcha
 
-        super
+        yield resource if block_given?
+        if resource.persisted?
+          if resource.active_for_authentication?
+            set_flash_message! :notice, :signed_up
+            sign_up(resource_name, resource)
+            respond_with resource, location: after_sign_up_path_for(resource)
+          else
+            set_flash_message! :notice, :"signed_up_but_#{resource.inactive_message}"
+            expire_data_after_sign_in!
+            respond_with resource, location: after_inactive_sign_up_path_for(resource)
+          end
+        else
+          resource.errors.add(:errors, message: t('devise.registrations.recaptcha_error')) unless verify_recaptcha
+          clean_up_passwords resource
+          set_minimum_password_length
+          respond_with resource
+        end
       end
 
       protected

data/app/views/devise/registrations/new.html.erb

@@ -34,6 +34,11 @@
           <%= f.password_field :password_confirmation, autocomplete: 'off', class: 'form-control' %>
         </div>
       </div>
+      <div class="form-group row">
+        <div class="offset-sm-2 col-sm-4">
+          <%= recaptcha_tags(id: 'registrations_recaptcha') %>
+        </div>
+      </div>
       <div class="form-group row">
         <div class="offset-sm-2 col-sm-4">
           <%= f.submit 'Sign up', class: 'btn btn-primary' %>

data/app/views/folders/show.html.erb

@@ -1,4 +1,4 @@
-<% @page_title = "{@folder.title}-#{application_name}" %>
+<% @page_title = "#{@folder.title} - #{application_name}" %>
 
 <%= javascript_include_tag 'bpluser/folder_tools' %>
 

data/config/locales/bpluser.en.yml

@@ -127,3 +127,7 @@ en:
 
     users:
       account_heading: 'My Account'
+
+  devise:
+    registrations:
+      recaptcha_error: ' - Please click the "I am not a robot" verification.'

data/lib/bpluser/engine.rb

@@ -1,5 +1,11 @@
 # frozen_string_literal: true
 
+begin
+  require 'recaptcha'
+rescue LoadError => e
+  puts "A Gem Dependency is Missing....#{e.message}"
+end
+
 module Bpluser
   class Engine < ::Rails::Engine
     isolate_namespace Bpluser

data/lib/bpluser/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Bpluser
-  VERSION = '0.3.0'
+  VERSION = '0.5.0'
 end

data/lib/generators/bpluser/install_generator.rb

@@ -53,6 +53,10 @@ module Bpluser
       generate 'bpluser:controller'
     end
 
+    def add_initializers
+      template 'config/initializers/recaptcha.rb'
+    end
+
     def bundle_install
       Bundler.with_clean_env do
         run 'bundle install'

data/lib/generators/bpluser/templates/config/initializers/recaptcha.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+Recaptcha.configure do |config|
+  config.site_key = ENV.fetch('RECAPTCHA_SITE_KEY') { Rails.application.credentials[:recaptcha_site_key] }
+  config.secret_key = ENV.fetch('RECAPTCHA_SECRET_KEY') { Rails.application.credentials[:recaptcha_secret_key] }
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bpluser
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Boston Public Library Repository Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-22 00:00:00.000000000 Z
+date: 2024-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: blacklight
@@ -108,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 6.1.7.4
+- !ruby/object:Gem::Dependency
+  name: recaptcha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.12'
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
@@ -266,6 +280,7 @@ files:
 - lib/generators/bpluser/devise_generator.rb
 - lib/generators/bpluser/install_generator.rb
 - lib/generators/bpluser/templates/config/initializers/devise.rb.bak
+- lib/generators/bpluser/templates/config/initializers/recaptcha.rb
 - lib/generators/bpluser/templates/config/locales/devise.en.yml
 - lib/generators/bpluser/templates/config/omniauth-polaris.yml
 - lib/generators/bpluser/templates/models/user.rb
@@ -283,17 +298,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.6
+      version: '3.1'
   - - "<"
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.3.27
 signing_key: 
 specification_version: 4
 summary: Shared user access gem for public front ends