castle_devise 0.3.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2e9fa31620b96fd293ede84541d8073f264f227f84422339fa8d100c1e89ddc
-  data.tar.gz: 8dcbfacef3a3050bceb218d571d34a12e447b10c0b54acc93b559224aebf5f5f
+  metadata.gz: '08bc5ac82986fd553c2c64a8c10a04748220a997b1c3430d1dc2bde82c18623d'
+  data.tar.gz: 367ba90a6e2e6e6b32a2dd87a9ad7e375fc6567d64dc069816d85f0bf1d5a014
 SHA512:
-  metadata.gz: b4bb3619aac0e96a1d2e00dbad37371b2c13855cb646b47819f80c333151e8072316ba7381587ed5b43867e6aa1841c4798cda18b7605bf4e382fad49cddf005
-  data.tar.gz: 8026202271990edbaeb18451bf25d5661c40c573728b781cf5a2268ab7e8900aa799be9da333f0beef44e3e65de8f6fb95ce49083314a68a665cbb1761543659
+  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,12 @@
 
 ## [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
@@ -17,7 +23,8 @@
 
 - Initial release
 
-[main]: https://github.com/castle/castle_devise/compare/v0.3.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.3.0)
+    castle_devise (0.4.1)
       activesupport (>= 5.0)
       castle-rb (>= 7.0, < 8.0)
       devise (>= 4.3.0, < 5.0)

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
 ```

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/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.3.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.3.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Kacper Madej
 - Dawid Libiszewski
 - Johan Brissmyr
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-30 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.2.23
-signing_key:
+rubygems_version: 3.1.4
+signing_key: 
 specification_version: 4
 summary: Integrates Castle with Devise
 test_files: []