castle-rb 3.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '071206458817ceae46b074a971138d80734439d0'
-  data.tar.gz: 7ae3185a784deb1ea4995cdc0ac732c6cca371e0
+  metadata.gz: 40fd82599b83e0b0393c41de08d2be555909b5f3
+  data.tar.gz: b9bcfae0cf9eed03bb33ab81c0f1f3ca4a149c0c
 SHA512:
-  metadata.gz: 965277364777fe9830a5e5ec65bc6e34ac8f4ff77ba5221622ef3186f3dd85c8766777ed1fa2443ec811d6b7d77df9f4975bb8b0ed6e7f17105fa84d0fd113e7
-  data.tar.gz: d71bc4bb0dc0dd779536ae2fb8078051a002b7c3aef68c8a648beab98907f187feb9934d4c9b11ebddcb6adfdc0899a31c1b56094c0192812be32aabd776a78b
+  metadata.gz: '07275877fa6fdf40f2451955444869f1f3c98f6ca7332edd1ee51b09d4f14da1f3c10cd53f06da70c4e0b65f646df33afcbe352f64720a52e26f677fe17318f1'
+  data.tar.gz: d3847b889ede27f92b4a06651e4c085f0f1ba7bab38012966ede3c5304b8b036beb41b7c8626e2bc4a68340f774140c55e7ac118d00c639796dbe291b39f871d

data/README.md

@@ -29,7 +29,7 @@ A Castle client instance will be made available as `castle` in your
 
 * Sinatra app when you add `require 'castle/support/sinatra'` (and additionally explicitly add `register Sinatra::Castle` to your `Sinatra::Base` class if you have a modular application)
 
-```
+```ruby
 require 'castle/support/sinatra'
 
 class ApplicationController < Sinatra::Base
@@ -39,7 +39,7 @@ end
 
 * Hanami when you add `require 'castle/support/hanami'` and include `Castle::Hanami` to your Hanami application
 
-```
+```ruby
 require 'castle/support/hanami'
 
 module Web
@@ -100,3 +100,37 @@ end
 ## Signature
 
 `Castle::SecureMode.signature(user_id)` will create a signed user_id.
+
+## Async tracking
+
+By default Castle sends requests synchronously. To eg. use Sidekiq to send requests in a background worker you can pass data to the worker:
+
+#### castle_tracking_worker.rb
+
+```ruby
+class CastleTrackingWorker
+  include Sidekiq::Worker
+
+  def perform(context, track_options = {})
+    client = ::Castle::Client.new(context)
+    client.track(track_options)
+  end
+end
+```
+
+#### tracking_controller.rb
+
+```ruby
+request_context = ::Castle::Client.to_context(request)
+track_options = {
+  event: '$login.succeeded',
+  user_id: user.id,
+  properties: {
+    key: 'value'
+  },
+  traits: {
+    key: 'value'
+  }
+}
+CastleTrackingWorker.perform_async(request_context, track_options)
+```

data/lib/castle/client.rb

@@ -2,11 +2,22 @@
 
 module Castle
   class Client
+    class << self
+      def from_request(request, options = {})
+        new(to_context(request, options), options[:do_not_track])
+      end
+
+      def to_context(request, options = {})
+        default_context = Castle::DefaultContext.new(request, options[:cookies]).call
+        Castle::ContextMerger.new(default_context).call(options[:context] || {})
+      end
+    end
+
     attr_accessor :api
 
-    def initialize(request, options = {})
-      @do_not_track = default_tracking(options)
-      @context = setup_context(request, options[:cookies], options[:context])
+    def initialize(context, do_not_track = false)
+      @do_not_track = do_not_track
+      @context = context
       @api = API.new
     end
 
@@ -66,9 +77,5 @@ module Castle
       return failover_response.generate unless Castle.config.failover_strategy == :throw
       raise error
     end
-
-    def default_tracking(options)
-      options.key?(:do_not_track) ? options[:do_not_track] : false
-    end
   end
 end

data/lib/castle/support/hanami.rb

@@ -4,7 +4,7 @@ module Castle
   module Hanami
     module Action
       def castle
-        @castle ||= ::Castle::Client.new(request, cookies: (cookies if defined? cookies))
+        @castle ||= ::Castle::Client.from_request(request, cookies: (cookies if defined? cookies))
       end
     end
 

data/lib/castle/support/padrino.rb

@@ -5,7 +5,7 @@ module Padrino
     module Castle
       module Helpers
         def castle
-          @castle ||= ::Castle::Client.new(request)
+          @castle ||= ::Castle::Client.from_request(request)
         end
       end
 

data/lib/castle/support/rails.rb

@@ -3,7 +3,7 @@
 module Castle
   module CastleClient
     def castle
-      @castle ||= request.env['castle'] || Castle::Client.new(request)
+      @castle ||= request.env['castle'] || Castle::Client.from_request(request)
     end
   end
 

data/lib/castle/support/sinatra.rb

@@ -6,7 +6,7 @@ module Sinatra
   module Castle
     module Helpers
       def castle
-        @castle ||= ::Castle::Client.new(request)
+        @castle ||= ::Castle::Client.from_request(request)
       end
     end
 

data/lib/castle/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Castle
-  VERSION = '3.0.1'
+  VERSION = '3.1.0'
 end

data/spec/lib/castle/client_spec.rb

@@ -11,7 +11,7 @@ describe Castle::Client do
     )
   end
   let(:request) { Rack::Request.new(env) }
-  let(:client) { described_class.new(request) }
+  let(:client) { described_class.from_request(request) }
   let(:headers) { { 'X-Forwarded-For' => ip.to_s } }
   let(:context) do
     {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: castle-rb
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.1.0
 platform: ruby
 authors:
 - Johan Brissmyr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-20 00:00:00.000000000 Z
+date: 2017-12-12 00:00:00.000000000 Z
 dependencies: []
 description: Castle protects your users from account compromise
 email: johan@castle.io
@@ -92,32 +92,32 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Castle
 test_files:
-- spec/lib/castle/api_spec.rb
+- spec/spec_helper.rb
+- spec/lib/castle_spec.rb
+- spec/lib/castle/review_spec.rb
 - spec/lib/castle/client_spec.rb
-- spec/lib/castle/command_spec.rb
-- spec/lib/castle/commands/authenticate_spec.rb
-- spec/lib/castle/commands/identify_spec.rb
-- spec/lib/castle/commands/review_spec.rb
-- spec/lib/castle/commands/track_spec.rb
+- spec/lib/castle/api_spec.rb
 - spec/lib/castle/configuration_spec.rb
-- spec/lib/castle/context_merger_spec.rb
+- spec/lib/castle/version_spec.rb
 - spec/lib/castle/default_context_spec.rb
-- spec/lib/castle/extractors/client_id_spec.rb
-- spec/lib/castle/extractors/headers_spec.rb
-- spec/lib/castle/extractors/ip_spec.rb
 - spec/lib/castle/header_formatter_spec.rb
-- spec/lib/castle/request_spec.rb
-- spec/lib/castle/response_spec.rb
-- spec/lib/castle/review_spec.rb
-- spec/lib/castle/secure_mode_spec.rb
 - spec/lib/castle/utils/cloner_spec.rb
 - spec/lib/castle/utils/merger_spec.rb
+- spec/lib/castle/command_spec.rb
+- spec/lib/castle/request_spec.rb
+- spec/lib/castle/response_spec.rb
+- spec/lib/castle/commands/review_spec.rb
+- spec/lib/castle/commands/authenticate_spec.rb
+- spec/lib/castle/commands/track_spec.rb
+- spec/lib/castle/commands/identify_spec.rb
+- spec/lib/castle/context_merger_spec.rb
+- spec/lib/castle/extractors/ip_spec.rb
+- spec/lib/castle/extractors/headers_spec.rb
+- spec/lib/castle/extractors/client_id_spec.rb
 - spec/lib/castle/utils_spec.rb
-- spec/lib/castle/version_spec.rb
-- spec/lib/castle_spec.rb
-- spec/spec_helper.rb
+- spec/lib/castle/secure_mode_spec.rb