Merge pull request #97 from castle/created_at

add auto-generated timestamp and sent_at (ruby-sdk)

CHANGELOG.md

@@ -2,6 +2,16 @@
 
 ## master
 
+## 3.3.0 (2017-12-15)
+
+**BREAKING CHANGES:**
+
+- [#97](github.com/castle/castle-ruby/pull/97) when data is sent in batches you may want to wrap data options with to_options method before you send it to the worker (see README) to include proper timestamp in the query
+
+**Features:**
+
+- [#97](github.com/castle/castle-ruby/pull/97) `Castle::Client` has additional option `timestamp`, `timestamp` and `sent_at` time values are automatically added to the requests, added `Castle::Client.to_options` method which adds properly formatted timestamp param to the options
+
 ## 3.2.0 (2017-12-15)
 
 **BREAKING CHANGES:**

Gemfile

@@ -15,5 +15,6 @@ group :test do
   gem 'coveralls_reborn'
   gem 'rspec'
   gem 'simplecov'
+  gem 'timecop'
   gem 'webmock'
 end

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    castle-rb (3.2.0)
+    castle-rb (3.3.0)
 
 GEM
   remote: https://rubygems.org/
@@ -46,6 +46,7 @@ GEM
     term-ansicolor (1.6.0)
       tins (~> 1.0)
     thor (0.20.0)
+    timecop (0.9.1)
     tins (1.16.3)
     webmock (3.2.1)
       addressable (>= 2.3.6)
@@ -63,6 +64,7 @@ DEPENDENCIES
   rake
   rspec
   simplecov
+  timecop
   webmock
 
 BUNDLED WITH

README.md

@@ -122,7 +122,7 @@ end
 
 ```ruby
 request_context = ::Castle::Client.to_context(request)
-track_options = {
+track_options = ::Castle::Client.to_options({
   event: '$login.succeeded',
   user_id: user.id,
   properties: {
@@ -131,6 +131,6 @@ track_options = {
   traits: {
     key: 'value'
   }
-}
+})
 CastleTrackingWorker.perform_async(request_context, track_options)
 ```

lib/castle.rb

@@ -3,16 +3,18 @@
 require 'openssl'
 require 'net/http'
 require 'json'
+require 'time'
 
 require 'castle/version'
 require 'castle/errors'
 require 'castle/command'
 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/commands/with_context'
 require 'castle/commands/identify'
 require 'castle/commands/authenticate'
 require 'castle/commands/track'

lib/castle/client.rb

@@ -4,19 +4,28 @@ module Castle
   class Client
     class << self
       def from_request(request, options = {})
-        new(to_context(request, options), options[:do_not_track])
+        new(
+          to_context(request, options),
+          to_options(options)
+        )
       end
 
       def to_context(request, options = {})
         default_context = Castle::DefaultContext.new(request, options[:cookies]).call
-        Castle::ContextMerger.new(default_context).call(options[:context] || {})
+        Castle::ContextMerger.call(default_context, options[:context])
+      end
+
+      def to_options(options = {})
+        options[:timestamp] ||= Castle::Utils::Timestamp.call
+        options
       end
     end
 
     attr_accessor :api
 
-    def initialize(context, do_not_track = false)
-      @do_not_track = do_not_track
+    def initialize(context, options = {})
+      @do_not_track = options[:do_not_track]
+      @timestamp = options[:timestamp]
       @context = context
       @api = API.new
     end
@@ -25,6 +34,7 @@ def authenticate(options = {})
       options = Castle::Utils.deep_symbolize_keys(options || {})
 
       if tracked?
+        options[:timestamp] ||= @timestamp if @timestamp
         command = Castle::Commands::Authenticate.new(@context).build(options)
         begin
           @api.request(command).merge(failover: false, failover_reason: nil)
@@ -40,6 +50,7 @@ def identify(options = {})
       options = Castle::Utils.deep_symbolize_keys(options || {})
 
       return unless tracked?
+      options[:timestamp] ||= @timestamp if @timestamp
 
       command = Castle::Commands::Identify.new(@context).build(options)
       @api.request(command)
@@ -49,6 +60,7 @@ def track(options = {})
       options = Castle::Utils.deep_symbolize_keys(options || {})
 
       return unless tracked?
+      options[:timestamp] ||= @timestamp if @timestamp
 
       command = Castle::Commands::Track.new(@context).build(options)
       @api.request(command)
@@ -70,7 +82,7 @@ def tracked?
 
     def setup_context(request, cookies, additional_context)
       default_context = Castle::DefaultContext.new(request, cookies).call
-      Castle::ContextMerger.new(default_context).call(additional_context || {})
+      Castle::ContextMerger.call(default_context, additional_context)
     end
 
     def failover_response_or_raise(failover_response, error)

lib/castle/commands/authenticate.rb

@@ -3,13 +3,19 @@
 module Castle
   module Commands
     class Authenticate
-      include WithContext
+      def initialize(context)
+        @context = context
+      end
 
       def build(options = {})
         validate!(options)
-        build_context!(options)
+        context = ContextMerger.call(@context, options[:context])
+        context = ContextSanitizer.call(context)
 
-        Castle::Command.new('authenticate', options, :post)
+        Castle::Command.new('authenticate',
+                            options.merge(context: context,
+                                          sent_at: Castle::Utils::Timestamp.call),
+                            :post)
       end
 
       private

lib/castle/commands/identify.rb

@@ -3,13 +3,19 @@
 module Castle
   module Commands
     class Identify
-      include WithContext
+      def initialize(context)
+        @context = context
+      end
 
       def build(options = {})
         validate!(options)
-        build_context!(options)
+        context = ContextMerger.call(@context, options[:context])
+        context = ContextSanitizer.call(context)
 
-        Castle::Command.new('identify', options, :post)
+        Castle::Command.new('identify',
+                            options.merge(context: context,
+                                          sent_at: Castle::Utils::Timestamp.call),
+                            :post)
       end
 
       private

lib/castle/commands/track.rb

@@ -3,13 +3,19 @@
 module Castle
   module Commands
     class Track
-      include WithContext
+      def initialize(context)
+        @context = context
+      end
 
       def build(options = {})
         validate!(options)
-        build_context!(options)
+        context = ContextMerger.call(@context, options[:context])
+        context = ContextSanitizer.call(context)
 
-        Castle::Command.new('track', options, :post)
+        Castle::Command.new('track',
+                            options.merge(context: context,
+                                          sent_at: Castle::Utils::Timestamp.call),
+                            :post)
       end
 
       private

lib/castle/context_merger.rb

@@ -2,12 +2,11 @@
 
 module Castle
   class ContextMerger
-    def initialize(context)
-      @main_context = Castle::Utils::Cloner.call(context)
-    end
-
-    def call(request_context)
-      Castle::Utils::Merger.call(@main_context, request_context)
+    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

lib/castle/context_sanitizer.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Castle
+  # removes not proper active flag values
+  class ContextSanitizer
+    class << self
+      def call(context)
+        sanitized_active_mode(context) || {}
+      end
+
+      private
+
+      def sanitized_active_mode(context)
+        return context unless context && context.key?(:active)
+        return context if [true, false].include?(context[:active])
+        context.reject { |key| key == :active }
+      end
+    end
+  end
+end

lib/castle/utils/merger.rb

@@ -4,19 +4,19 @@ module Castle
   module Utils
     class Merger
       def self.call(first, second)
-        Castle::Utils.deep_symbolize_keys!(first)
-        Castle::Utils.deep_symbolize_keys!(second)
+        first_s = Castle::Utils.deep_symbolize_keys(first)
+        second_s = Castle::Utils.deep_symbolize_keys(second)
 
-        second.each do |name, value|
+        second_s.each do |name, value|
           if value.nil?
-            first.delete(name)
-          elsif value.is_a?(Hash) && first[name].is_a?(Hash)
-            call(first[name], value)
+            first_s.delete(name)
+          elsif value.is_a?(Hash) && first_s[name].is_a?(Hash)
+            first_s[name] = call(first_s[name], value)
           else
-            first[name] = value
+            first_s[name] = value
           end
         end
-        first
+        first_s
       end
     end
   end

lib/castle/utils/timestamp.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Castle
+  module Utils
+    # generates proper timestamp
+    class Timestamp
+      def self.call
+        Time.now.utc.iso8601(3)
+      end
+    end
+  end
+end

lib/castle/version.rb

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