castle_devise 0.2.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7cc0ef1100f1ceb942fa1be6553b6b7ca862656e3c7a6b9b57459285a69a46a7
-  data.tar.gz: 9222268f8c6e22fb367bbc0cc9a0ce52b5dc8854f8eefa0f2f34e2afaa4a92eb
+  metadata.gz: '08bc5ac82986fd553c2c64a8c10a04748220a997b1c3430d1dc2bde82c18623d'
+  data.tar.gz: 367ba90a6e2e6e6b32a2dd87a9ad7e375fc6567d64dc069816d85f0bf1d5a014
 SHA512:
-  metadata.gz: b6a11b460114c2133776991e4cde4f11a9030e5b019ea0162712b070a72b9adbd50cfad1f866cf90a92b05f505464ded6d9727a474c22edd5f65a9ed6f4fb0d6
-  data.tar.gz: 292fe6b7dff6f11135c8e63b53ee4484cc8c1dd93dab449d58ef765b29935a8f4bbb925896bf4b4d06b21f1e44cc7ce748af8226287c832b9e8409026bc81c23
+  metadata.gz: c3b603e7ad9f16909b546bb2604cff29d9939ea5e43b187764a0f114f9ee43a9746616bf05e1699a4bb914053781df0a190d7281ed5c9e2c1e0e34739bd34945
+  data.tar.gz: 47abcfb52b021885ce447ca68199cea7142f9e574e5b4bdb5653e60c6c4c373b67d1225c06baf61df24cca590b1dd35756cb3914c2de6348aea72c70ce110ac8

data/.github/workflows/lint.yml

@@ -9,10 +9,13 @@ jobs:
     steps:
       - name: Check out code
         uses: actions/checkout@v1
+      - name: Give permissions
+        run: |
+          sudo chown -R root:root $GITHUB_WORKSPACE
       - name: standardrb
         uses: SennaLabs/action-standardrb@v0.0.3
         with:
           github_token: ${{ secrets.github_token }}
           reporter: github-pr-review # Default is github-pr-check
-          rubocop_version: 1.1.1 # note: this actually refers to standardb version, not Rubocop
+          rubocop_version: 1.1.6 # note: this actually refers to standardb version, not Rubocop
           rubocop_flags: --format progress

data/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 ## [Unreleased][main]
 
+## [0.4.1] - 2022-12-13
+- Introduced new configuration options for `castle_sdk_facade_class` and `castle_client`
+
+## [0.4.0] - 2022-05-17
+-  Send $login $failed events to /v1/filter
+
+## [0.3.0] - 2021-08-30
+
+- Switch c.js to 2.0 version, Update c.js related helpers
+
 ## [0.2.0] - 2021-08-12
 
 - Add Log action for $profile_update event with $succeeded and $failed statuses during reset password process
@@ -13,6 +23,8 @@
 
 - Initial release
 
-[main]: https://github.com/castle/castle_devise/compare/v0.2.0...HEAD
+[main]: https://github.com/castle/castle_devise/compare/v0.4.0...HEAD
+[0.4.0]: https://github.com/castle/castle_devise/compare/v0.3.0...v0.4.0
+[0.3.0]: https://github.com/castle/castle_devise/compare/v0.2.0...v0.3.0
 [0.2.0]: https://github.com/castle/castle_devise/compare/v0.1.0...v0.2.0
 [0.1.0]: https://github.com/castle/castle_devise/releases/tag/v0.1.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    castle_devise (0.2.0)
+    castle_devise (0.4.1)
       activesupport (>= 5.0)
       castle-rb (>= 7.0, < 8.0)
       devise (>= 4.3.0, < 5.0)
@@ -171,6 +171,7 @@ GEM
 PLATFORMS
   x86_64-darwin-18
   x86_64-darwin-19
+  x86_64-darwin-20
 
 DEPENDENCIES
   actionmailer

data/README.md

@@ -2,11 +2,11 @@
 
 **Disclaimer:** CastleDevise is currently in beta. There might be some upcoming breaking changes to the gem before we stabilize the API.
 
---- 
+---
 
-# CastleDevice
+# CastleDevise
 
-CastleDevise is a [Devise](https://github.com/heartcombo/devise) plugin that integrates [Castle](https://castle.io). 
+CastleDevise is a [Devise](https://github.com/heartcombo/devise) plugin that integrates [Castle](https://castle.io).
 
 It currently provides the following features:
 - preventing bots from registration attacks using Castle's [Filter API](https://docs.castle.io/v1/reference/api-reference/#filter)
@@ -26,11 +26,11 @@ gem 'castle_devise'
 
 Create `config/initializers/castle_devise.rb` and fill in your API secret and APP_ID from the [Castle Dashboard](https://dashboard.castle.io/settings/general)
 
-```ruby 
+```ruby
 CastleDevise.configure do |config|
   config.api_secret = ENV.fetch('CASTLE_API_SECRET')
   config.app_id = ENV.fetch('CASTLE_APP_ID')
-  
+
   # When monitoring mode is enabled, CastleDevise sends
   # requests to Castle but it doesn't act on the "deny" verdicts.
   #
@@ -45,10 +45,10 @@ end
 
 Add `:castle_protectable` Devise module to your User model:
 
-```ruby 
+```ruby
 class User < ApplicationRecord
   devise :database_authenticatable, :registerable,
-         :recoverable, :rememberable, :validatable, 
+         :recoverable, :rememberable, :validatable,
          :castle_protectable # <--- add this
 end
 ```
@@ -75,9 +75,7 @@ Include Castle's c.js script in the head section of your layout:
 Add the following tag to the the `<form>` tag in both `devise/registrations/new.html.erb` and `devise/sessions/new.html.erb` (if you haven't generated them yet, run `rails generate devise:views`):
 
 ```ruby
-<%= form_for @user do |f| %>
-  …
-  <%= castle_request_token %>
+<%= form_for @user,  html: { onsubmit: castle_on_form_submit } do |f| %>
   …
 <% end %>
 ```
@@ -87,20 +85,21 @@ You're set! Now verify that everything works by logging in to your application a
 
 #### Further steps if you're using Webpacker
 
-Add `castle.js` to your package.json file:
+Add `@castleio/castle-js` to your package.json file:
 
 ```
-yarn add castle.js
+yarn add @castleio/castle-js
 ```
 
-Require castle.js in your application pack:
+configure castle in your application pack:
 
 ```javascript
-require("castle.js");
+import * as Castle from '@castleio/castle-js'
 
-_castle("setAppId", YOUR_APPLICATION_ID);
+Castle.configure(YOUR_APPLICATION_ID);
 ```
 
+for advanced configuration follow [the readme](https://www.npmjs.com/package/@castleio/castle-js#configuration)
 
 ## How-Tos
 

data/lib/castle_devise/configuration.rb

@@ -39,6 +39,14 @@ module CastleDevise
     #   @return [Array<Proc>] Array of procs that will get called after a request to the Castle API
     config_accessor(:after_request_hooks) { [] }
 
+    # @!attribute castle_sdk_facade_class
+    #   @return [Class] Castle API implementation
+    config_accessor(:castle_sdk_facade_class) { ::CastleDevise::SdkFacade }
+
+    # @!attribute castle_client
+    #   @return [Class] Castle SDK client
+    config_accessor(:castle_client) { ::Castle::Client.new }
+
     # Adds a new before_request hook
     # @param blk [Proc]
     def before_request(&blk)

data/lib/castle_devise/helpers/castle_helper.rb

@@ -23,7 +23,7 @@ module CastleDevise
       #   <!-- the rest of your layout -->
       def castle_javascript_tag
         javascript_include_tag(
-          "https://d2t77mnxyo7adj.cloudfront.net/v1/c.js?#{CastleDevise.configuration.app_id}"
+          "https://cdn.castle.io/v2/castle.js?#{CastleDevise.configuration.app_id}"
         )
       end
 
@@ -31,52 +31,14 @@ module CastleDevise
       # within the current form.
       #
       # @example
-      #   <%= form_for(resource, as: resource_name, url: sessions_path(resource_name)) do |f| %>
-      #     <%= castle_request_token %>
+      #   <%= form_for(resource, as: resource_name, url: sessions_path(resource_name), html: { onsubmit: castle_on_form_submit }) do |f| %>
       #     <%= f.email_field :email %>
       #     <%= f.password_field :password, autocomplete: 'off' %>
       #   <% end %>
       #
       # @return [String]
-      def castle_request_token
-        tag = <<~HEREDOC
-          <script>
-          // The current script tag is the last one at the time of load
-          var el = document.getElementsByTagName('script');
-          el = el[el.length - 1];
-
-          // Traverse up until we find a form
-          while (el  && el !== document) {
-            if (el.tagName === 'FORM') break;
-            el = el.parentNode;
-          }
-
-          // Intercept the form submit
-          if (el.tagName === 'FORM') {
-            el.onsubmit = function(e) {
-              e.preventDefault();
-
-              _castle('createRequestToken').then(function(requestToken) {
-                // Populate a hidden field called `castle_request_token` with the
-                // request token
-                var hiddenInput = document.createElement('input');
-                hiddenInput.setAttribute('type', 'hidden');
-                hiddenInput.setAttribute('name', 'castle_request_token');
-                hiddenInput.setAttribute('value', requestToken);
-
-                // Add the hidden field to the form so it gets sent to the server
-                // before submitting the form
-                el.appendChild(hiddenInput);
-
-                el.submit();
-              });
-            };
-          } else {
-            console.log('[Castle] The script helper needs to be within a <form> tag')
-          }
-          </script>
-        HEREDOC
-        tag.html_safe
+      def castle_on_form_submit
+        "typeof(_castle)=='undefined'?event.preventDefault():_castle('onFormSubmit', event)"
       end
     end
   end

data/lib/castle_devise/hooks/castle_protectable.rb

@@ -52,12 +52,12 @@ Warden::Manager.before_failure do |env, opts|
   context = CastleDevise::Context.from_rack_env(env, opts[:scope])
 
   begin
-    CastleDevise.sdk_facade.log(
+    CastleDevise.sdk_facade.filter(
       event: "$login",
       status: "$failed",
       context: context
     )
   rescue Castle::Error => e
-    CastleDevise.logger.error("[CastleDevise] log($login, $failed): #{e}")
+    CastleDevise.logger.error("[CastleDevise] filter($login, $failed): #{e}")
   end
 end

data/lib/castle_devise/sdk_facade.rb

@@ -20,9 +20,10 @@ module CastleDevise
     # @param context [CastleDevise::Context]
     # @return [Hash] Raw API response
     # @see https://docs.castle.io/v1/reference/api-reference/#v1filter
-    def filter(event:, context:)
+    def filter(event:, context:, status: "$attempted")
       payload = {
         event: event,
+        status: status,
         user: {
           email: context.email
         },

data/lib/castle_devise/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CastleDevise
-  VERSION = "0.2.0"
+  VERSION = "0.4.1"
 end

data/lib/castle_devise.rb

@@ -25,6 +25,8 @@ module CastleDevise
 
     # @yieldparam [CastleDevise::Configuration] configuration object
     def configure
+      @sdk_facade = @castle = nil
+
       yield configuration
 
       Castle.api_secret = configuration.api_secret
@@ -38,7 +40,7 @@ module CastleDevise
 
     # @return [CastleDevise::SdkFacade]
     def sdk_facade
-      @sdk_facade ||= CastleDevise::SdkFacade.new(
+      @sdk_facade ||= configuration.castle_sdk_facade_class.new(
         castle,
         configuration.before_request_hooks,
         configuration.after_request_hooks
@@ -47,15 +49,15 @@ module CastleDevise
 
     # @return [Castle::Client]
     def castle
-      @castle ||= Castle::Client.new
+      @castle ||= configuration.castle_client
     end
   end
 end
 
+require_relative "castle_devise/sdk_facade"
 require_relative "castle_devise/configuration"
 require_relative "castle_devise/context"
 require_relative "castle_devise/patches"
-require_relative "castle_devise/sdk_facade"
 require_relative "castle_devise/controllers/helpers"
 require_relative "castle_devise/helpers/castle_helper"
 require_relative "castle_devise/hooks/castle_protectable"

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: castle_devise
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Kacper Madej
 - Dawid Libiszewski
 - Johan Brissmyr
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-12 00:00:00.000000000 Z
+date: 2022-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -125,7 +125,7 @@ metadata:
   homepage_uri: https://github.com/castle/castle_devise
   source_code_uri: https://github.com/castle/castle_devise
   changelog_uri: https://github.com/castle/castle_devise/CHANGELOG.md
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -140,8 +140,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key:
+rubygems_version: 3.1.4
+signing_key: 
 specification_version: 4
 summary: Integrates Castle with Devise
 test_files: []