castle-rb 3.4.0 → 3.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70b2d5182f8c36fca5ab6db47879bd9173451451d8e226561aa03d5f4d13f2d4
-  data.tar.gz: 821adef78792ecb690d29d220d09cda4aae770a240c5258e818acd88aa07b494
+  metadata.gz: 688cb3645a056cf00e31610ad8a89b8a0e8183775ba6bf71bbadf7334d73b0d8
+  data.tar.gz: 9624e2f4feb4a78ef5f4eb8376688c1c839dae357d220fb9f9ddca76d277b3b7
 SHA512:
-  metadata.gz: 58eb9e46cfcae41a04c1c3f41eb8a32b86cfc58ad254f62530040253a08ae4910333a8150304a9000c46e1257043c08942b31ac942417b0cc6a1e995497f7b77
-  data.tar.gz: 9aa9a512116fadd5ad079bc65c95c7b9bbb638574ce9cf8c0491a76a38b88b825beb54f4491cd06ed13f00191c981202ab3bb24654970880b43efe90b1110779
+  metadata.gz: 7b9343297d9d09ace02b9ed5f40f6836023ceb86329163c2e9eb5d957dc249a40a7b3af63a0c201ca759f29b7eb7deec0f37f2dedd3c3879ab7a77781e30e66a
+  data.tar.gz: e040d6020f980521f0f4f5771bd07ac9b504db9e58e3baa8b22aa51f46e620f308ee1b8d716566cd657fccc2fdc4ebe79d2a59bb21097fe6d6909ae11d97ba7c

data/README.md

@@ -5,7 +5,7 @@
 [![Gem Version](https://badge.fury.io/rb/castle-rb.svg)](https://badge.fury.io/rb/castle-rb)
 [![Dependency Status](https://gemnasium.com/badges/github.com/castle/castle-ruby.svg)](https://gemnasium.com/github.com/castle/castle-ruby)
 
-**[Castle](https://castle.io) adds real-time monitoring of your authentication stack, instantly notifying you and your users on potential account hijacks.**
+**[Castle](https://castle.io) analyzes device, location, and interaction patterns in your web and mobile apps and lets you stop account takeover attacks in real-time..**
 
 ## Installation
 
@@ -15,6 +15,10 @@ Add the `castle-rb` gem to your `Gemfile`
 gem 'castle-rb'
 ```
 
+## Configuration
+
+### Framework configuration
+
 Load and configure the library with your Castle API secret in an initializer or similar.
 
 ```ruby
@@ -49,28 +53,7 @@ module Web
 end
 ```
 
-The client will automatically configure the [request context](https://api.castle.io/docs#request-context) for each request.
-
-## Documentation
-
-[Official Castle docs](https://castle.io/docs)
-
-## Exceptions
-
-`Castle::Error` will be thrown if the Castle API returns a 400 or a 500 level HTTP response. You can also choose to catch a more [finegrained error](https://github.com/castle/castle-ruby/blob/master/lib/castle/errors.rb).
-
-```ruby
-begin
-  castle.track(
-    event: '$login.succeeded',
-    user_id: user.id
-  )
-rescue Castle::Error => e
-  puts e.message
-end
-```
-
-## Configuration
+### Client configuration
 
 ```ruby
 Castle.configure do |config|
@@ -80,7 +63,7 @@ Castle.configure do |config|
   # For authenticate method you can set failover strategies: allow(default), deny, challenge, throw
   config.failover_strategy = :deny
 
-  # Castle::RequestError is raised when timing out in seconds (default: 500 milliseconds)
+  # Castle::RequestError is raised when timing out in milliseconds (default: 500 milliseconds)
   config.request_timeout = 2000
 
   # Whitelisted and Blacklisted headers are case insensitive and allow to use _ and - as a separator, http prefixes are removed
@@ -96,6 +79,23 @@ Castle.configure do |config|
 end
 ```
 
+The client will automatically configure the context for each request.
+
+## Tracking
+
+Here is a simple example of a track event.
+
+
+```ruby
+begin
+  castle.track(
+    event: '$login.succeeded',
+    user_id: user.id
+  )
+rescue Castle::Error => e
+  puts e.message
+end
+```
 
 ## Signature
 
@@ -134,3 +134,15 @@ track_options = ::Castle::Client.to_options({
 })
 CastleTrackingWorker.perform_async(request_context, track_options)
 ```
+
+## Impersonation mode
+
+https://castle.io/docs/impersonation
+
+## Exceptions
+
+`Castle::Error` will be thrown if the Castle API returns a 400 or a 500 level HTTP response. You can also choose to catch a more [finegrained error](https://github.com/castle/castle-ruby/blob/master/lib/castle/errors.rb).
+
+## Documentation
+
+[Official Castle docs](https://castle.io/docs)

data/lib/castle.rb

@@ -12,9 +12,11 @@ require 'castle/utils'
 require 'castle/utils/merger'
 require 'castle/utils/cloner'
 require 'castle/utils/timestamp'
-require 'castle/context_merger'
-require 'castle/context_sanitizer'
-require 'castle/default_context'
+require 'castle/validators/present'
+require 'castle/validators/not_supported'
+require 'castle/context/merger'
+require 'castle/context/sanitizer'
+require 'castle/context/default'
 require 'castle/commands/identify'
 require 'castle/commands/authenticate'
 require 'castle/commands/track'

data/lib/castle/client.rb

@@ -11,20 +11,25 @@ module Castle
       end
 
       def to_context(request, options = {})
-        default_context = Castle::DefaultContext.new(request, options[:cookies]).call
-        Castle::ContextMerger.call(default_context, options[:context])
+        default_context = Castle::Context::Default.new(request, options[:cookies]).call
+        Castle::Context::Merger.call(default_context, options[:context])
       end
 
       def to_options(options = {})
         options[:timestamp] ||= Castle::Utils::Timestamp.call
         options
       end
+
+      def failover_response_or_raise(failover_response, error)
+        return failover_response.generate unless Castle.config.failover_strategy == :throw
+        raise error
+      end
     end
 
     attr_accessor :api
 
     def initialize(context, options = {})
-      @do_not_track = options[:do_not_track]
+      @do_not_track = options.fetch(:do_not_track, false)
       @timestamp = options[:timestamp]
       @context = context
       @api = API.new
@@ -34,15 +39,20 @@ module Castle
       options = Castle::Utils.deep_symbolize_keys(options || {})
 
       if tracked?
-        options[:timestamp] ||= @timestamp if @timestamp
+        add_timestamp_if_necessary(options)
         command = Castle::Commands::Authenticate.new(@context).build(options)
         begin
           @api.request(command).merge(failover: false, failover_reason: nil)
         rescue Castle::RequestError, Castle::InternalServerError => error
-          failover_response_or_raise(FailoverAuthResponse.new(options[:user_id], reason: error.to_s), error)
+          self.class.failover_response_or_raise(
+            FailoverAuthResponse.new(options[:user_id], reason: error.to_s), error
+          )
         end
       else
-        FailoverAuthResponse.new(options[:user_id], strategy: :allow, reason: 'Castle set to do not track.').generate
+        FailoverAuthResponse.new(
+          options[:user_id],
+          strategy: :allow, reason: 'Castle set to do not track.'
+        ).generate
       end
     end
 
@@ -50,7 +60,7 @@ module Castle
       options = Castle::Utils.deep_symbolize_keys(options || {})
 
       return unless tracked?
-      options[:timestamp] ||= @timestamp if @timestamp
+      add_timestamp_if_necessary(options)
 
       command = Castle::Commands::Identify.new(@context).build(options)
       @api.request(command)
@@ -60,7 +70,7 @@ module Castle
       options = Castle::Utils.deep_symbolize_keys(options || {})
 
       return unless tracked?
-      options[:timestamp] ||= @timestamp if @timestamp
+      add_timestamp_if_necessary(options)
 
       command = Castle::Commands::Track.new(@context).build(options)
       @api.request(command)
@@ -68,8 +78,7 @@ module Castle
 
     def impersonate(options = {})
       options = Castle::Utils.deep_symbolize_keys(options || {})
-
-      return unless tracked?
+      add_timestamp_if_necessary(options)
       command = Castle::Commands::Impersonate.new(@context).build(options)
       @api.request(command)
     end
@@ -88,14 +97,8 @@ module Castle
 
     private
 
-    def setup_context(request, cookies, additional_context)
-      default_context = Castle::DefaultContext.new(request, cookies).call
-      Castle::ContextMerger.call(default_context, additional_context)
-    end
-
-    def failover_response_or_raise(failover_response, error)
-      return failover_response.generate unless Castle.config.failover_strategy == :throw
-      raise error
+    def add_timestamp_if_necessary(options)
+      options[:timestamp] ||= @timestamp if @timestamp
     end
   end
 end

data/lib/castle/commands/authenticate.rb

@@ -8,23 +8,15 @@ module Castle
       end
 
       def build(options = {})
-        validate!(options)
-        context = ContextMerger.call(@context, options[:context])
-        context = ContextSanitizer.call(context)
+        Castle::Validators::Present.call(options, %i[event user_id])
+        context = Castle::Context::Merger.call(@context, options[:context])
+        context = Castle::Context::Sanitizer.call(context)
 
-        Castle::Command.new('authenticate',
-                            options.merge(context: context,
-                                          sent_at: Castle::Utils::Timestamp.call),
-                            :post)
-      end
-
-      private
-
-      def validate!(options)
-        %i[event user_id].each do |key|
-          next unless options[key].to_s.empty?
-          raise Castle::InvalidParametersError, "#{key} is missing or empty"
-        end
+        Castle::Command.new(
+          'authenticate',
+          options.merge(context: context, sent_at: Castle::Utils::Timestamp.call),
+          :post
+        )
       end
     end
   end

data/lib/castle/commands/identify.rb

@@ -8,28 +8,16 @@ module Castle
       end
 
       def build(options = {})
-        validate!(options)
-        context = ContextMerger.call(@context, options[:context])
-        context = ContextSanitizer.call(context)
+        Castle::Validators::Present.call(options, %i[user_id])
+        Castle::Validators::NotSupported.call(options, %i[properties])
+        context = Castle::Context::Merger.call(@context, options[:context])
+        context = Castle::Context::Sanitizer.call(context)
 
-        Castle::Command.new('identify',
-                            options.merge(context: context,
-                                          sent_at: Castle::Utils::Timestamp.call),
-                            :post)
-      end
-
-      private
-
-      def validate!(options)
-        %i[user_id].each do |key|
-          next unless options[key].to_s.empty?
-          raise Castle::InvalidParametersError, "#{key} is missing or empty"
-        end
-
-        if options[:properties]
-          raise Castle::InvalidParametersError,
-                'properties are not supported in identify calls'
-        end
+        Castle::Command.new(
+          'identify',
+          options.merge(context: context, sent_at: Castle::Utils::Timestamp.call),
+          :post
+        )
       end
     end
   end

data/lib/castle/commands/impersonate.rb

@@ -9,31 +9,17 @@ module Castle
       end
 
       def build(options = {})
-        validate!(options)
-        context = ContextMerger.call(@context, options[:context])
-        context = ContextSanitizer.call(context)
+        Castle::Validators::Present.call(options, %i[user_id])
+        context = Castle::Context::Merger.call(@context, options[:context])
+        context = Castle::Context::Sanitizer.call(context)
 
-        validate_context!(context)
+        Castle::Validators::Present.call(context, %i[user_agent ip])
 
-        Castle::Command.new('impersonate',
-                            options.merge(context: context),
-                            :post)
-      end
-
-      private
-
-      def validate!(options)
-        %i[user_id].each do |key|
-          next unless options[key].to_s.empty?
-          raise Castle::InvalidParametersError, "#{key} is missing or empty"
-        end
-      end
-
-      def validate_context!(context)
-        %i[user_agent ip].each do |key|
-          next unless context[key].to_s.empty?
-          raise Castle::InvalidParametersError, "#{key} is missing or empty"
-        end
+        Castle::Command.new(
+          'impersonate',
+          options.merge(context: context, sent_at: Castle::Utils::Timestamp.call),
+          :post
+        )
       end
     end
   end

data/lib/castle/commands/review.rb

@@ -3,10 +3,11 @@
 module Castle
   module Commands
     class Review
-      def build(review_id)
-        raise Castle::InvalidParametersError if review_id.nil? || review_id.to_s.empty?
-
-        Castle::Command.new("reviews/#{review_id}", nil, :get)
+      class << self
+        def build(review_id)
+          Castle::Validators::Present.call({ review_id: review_id }, %i[review_id])
+          Castle::Command.new("reviews/#{review_id}", nil, :get)
+        end
       end
     end
   end

data/lib/castle/commands/track.rb

@@ -8,23 +8,15 @@ module Castle
       end
 
       def build(options = {})
-        validate!(options)
-        context = ContextMerger.call(@context, options[:context])
-        context = ContextSanitizer.call(context)
+        Castle::Validators::Present.call(options, %i[event])
+        context = Castle::Context::Merger.call(@context, options[:context])
+        context = Castle::Context::Sanitizer.call(context)
 
-        Castle::Command.new('track',
-                            options.merge(context: context,
-                                          sent_at: Castle::Utils::Timestamp.call),
-                            :post)
-      end
-
-      private
-
-      def validate!(options)
-        %i[event].each do |key|
-          next unless options[key].to_s.empty?
-          raise Castle::InvalidParametersError, "#{key} is missing or empty"
-        end
+        Castle::Command.new(
+          'track',
+          options.merge(context: context, sent_at: Castle::Utils::Timestamp.call),
+          :post
+        )
       end
     end
   end

data/lib/castle/configuration.rb

@@ -24,7 +24,7 @@ module Castle
     BLACKLISTED = ['HTTP_COOKIE'].freeze
 
     attr_accessor :host, :port, :request_timeout, :url_prefix
-    attr_reader :api_secret, :host, :port, :whitelisted, :blacklisted, :failover_strategy
+    attr_reader :api_secret, :whitelisted, :blacklisted, :failover_strategy
 
     def initialize
       @formatter = Castle::HeaderFormatter.new
@@ -57,7 +57,6 @@ module Castle
     def failover_strategy=(value)
       @failover_strategy = FAILOVER_STRATEGIES.detect { |strategy| strategy == value.to_sym }
       raise Castle::ConfigurationError, 'unrecognized failover strategy' if @failover_strategy.nil?
-      @failover_strategy
     end
 
     private

data/lib/castle/context/default.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Castle
+  module Context
+    class Default
+      def initialize(request, cookies = nil)
+        @client_id = Extractors::ClientId.new(request, cookies || request.cookies).call('__cid')
+        @headers = Extractors::Headers.new(request).call
+        @request_ip = Extractors::IP.new(request).call
+      end
+
+      def call
+        defaults.merge!(additional_defaults)
+      end
+
+      private
+
+      def defaults
+        {
+          client_id: @client_id,
+          active: true,
+          origin: 'web',
+          headers: @headers,
+          ip: @request_ip,
+          library: {
+            name: 'castle-rb',
+            version: Castle::VERSION
+          }
+        }
+      end
+
+      def additional_defaults
+        {}.tap do |result|
+          result[:locale] = @headers['Accept-Language'] if @headers['Accept-Language']
+          result[:user_agent] = @headers['User-Agent'] if @headers['User-Agent']
+        end
+      end
+    end
+  end
+end

data/lib/castle/context/merger.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Castle
+  module Context
+    class Merger
+      class << self
+        def call(initial_context, request_context)
+          main_context = Castle::Utils::Cloner.call(initial_context)
+          Castle::Utils::Merger.call(main_context, request_context || {})
+        end
+      end
+    end
+  end
+end