replay_api 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dabf42fd3f06393835e7a03d3b9be1b762e802c7
-  data.tar.gz: 21184818aca27ea627132bcc761b92ee5dc161d2
+  metadata.gz: 5eb0597cd56bcc5bf50df1247ae3b7b053096103
+  data.tar.gz: 2e6cc14f21dd67133ba86076d246d1bdc13744fa
 SHA512:
-  metadata.gz: 4d2a0096dbf2ab8507019b66d9cceed9189b823f0a3cbd0ec4cc66ae358083a9887b70ea94a75be3ff2669f02795cfb01a21f56bee342cb3214343c8e43423b9
-  data.tar.gz: 2744e9eb161280b6aa859a8cd20e07593a83d7f4e8c4dd7ba14378b7cd3e986737686f767abb2ddb23246b68a255d646cab935fd6023aeab38366a2c08cc1718
+  metadata.gz: 7a9464458585d09249ab5b19132453a113fbda3e5ea1c731cf6f6b0bd91b0fbafdf090041b6ec3414515c4b68e050a62df64bb937f3fe99397331240d432ec6d
+  data.tar.gz: 4cdbdae7dcd9b072ccd8c8d2f798c25fe4d5fa921ef6636d2acd402fba182ab45ba108d80836e2f442afdc19cd5107993b431e909264b2b32bdf0d66fe6e941c

data/lib/replay_api.rb

@@ -8,6 +8,7 @@ require 'replay_api/configuration'
 require 'replay_api/event'
 require 'replay_api/trait'
 require 'replay_api/client'
+require 'replay_api/request_deliverer'
 
 module ReplayApi
 end

data/lib/replay_api/client.rb

@@ -6,37 +6,25 @@ require 'typhoeus/adapters/faraday'
 module ReplayApi
   class Client
     attr_reader :configuration
-    attr_writer :connection
+    attr_accessor :deliverer
 
-    def initialize(configuration=ReplayApi.configuration)
+    def initialize(configuration=ReplayApi.configuration, deliverer=ReplayApi::RequestDeliverer.instance)
       @configuration ||= configuration
+      @deliverer ||= deliverer
     end
 
     def event(event=Event.new)
       yield event if block_given?
-      connection.post '/events', payload(event.compact_attributes)
+      deliverer.post(uri: '/events', payload: payload(event.compact_attributes))
     end
 
     def trait(trait=Trait.new)
       yield trait if block_given?
-      connection.post '/traits', payload(trait.compact_attributes)
+      deliverer.post(uri: '/traits', payload: payload(trait.compact_attributes))
     end
 
     private
 
-    def connection
-      @connection ||= Faraday.new(url: "#{protocol}://#{configuration.replay_server}") do |conn|
-        conn.request  :json
-        conn.response :json
-        conn.adapter  :typhoeus
-      end
-    end
-
-    def protocol
-      return 'http' unless configuration.ssl?
-      'https'
-    end
-
     def payload(data)
       { replay_key: configuration.replay_key }.merge data
     end

data/lib/replay_api/configuration.rb

@@ -12,10 +12,14 @@ module ReplayApi
     attr_accessor :replay_key
     attr_accessor :replay_server
     attr_accessor :ssl
+    attr_accessor :max_request_batch_size
+    attr_accessor :max_request_batch_delay
 
     def initialize
       @replay_server = 'api.replay.io'
       @ssl = true
+      @max_request_batch_size = 100
+      @max_request_batch_delay = 1
     end
 
     alias_method :ssl?, :ssl

data/lib/replay_api/event_properties.rb

@@ -20,14 +20,6 @@ module ReplayApi
     attribute :page_name, String
     attribute :page_url, String
     attribute :past_event, Integer, default: 0
-    attribute :timestamp, Integer, default: -> (_, _) { clock.now.to_i }
-
-    def self.clock=(val)
-      @clock = val
-    end
-
-    def self.clock
-      @clock ||= Time
-    end
+    
   end
 end

data/lib/replay_api/request_deliverer.rb

@@ -0,0 +1,76 @@
+module ReplayApi
+  class RequestDeliverer
+    include Singleton
+
+    attr_accessor :configuration
+    attr_accessor :connection
+    attr_reader :request_buffer
+    attr_reader :time_last_write
+    attr_reader :delivery_thread
+
+    def initialize(configuration=ReplayApi.configuration)
+      @configuration ||= configuration
+      @time_last_write = Time.now
+      @request_buffer = Queue.new
+
+      start_delivery_thread
+    end
+
+    def post(request)
+      @request_buffer.push(request)
+    end
+
+    private
+
+    def start_delivery_thread
+      return if @delivery_thread
+
+      @delivery_thread = Thread.new do
+        loop do
+          sendRequests(inboundRequests)
+          @time_last_write = Time.now
+        end
+      end
+    end
+
+    def inboundRequests
+      requests = [request_buffer.pop]
+      requests << request_buffer.pop until (request_buffer.empty? or batch_full?(requests) or max_delay_exceeded?)
+      requests
+    end
+
+    def sendRequests(requests)
+      connection.in_parallel do
+        requests.each do |request|
+          connection.post request[:uri], request[:payload]
+        end
+      end
+    end
+
+    def batch_full?(requests)
+      requests.size >= configuration.max_request_batch_size
+    end
+
+    def max_delay_exceeded?
+      time_since_last_write > configuration.max_request_batch_delay
+    end
+
+
+    def time_since_last_write
+      Time.now - time_last_write
+    end
+
+    def connection
+      @connection ||= Faraday.new(url: "#{protocol}://#{configuration.replay_server}") do |conn|
+        conn.request  :json
+        conn.response :json
+        conn.adapter  :typhoeus
+      end
+    end
+
+    def protocol
+      return 'http' unless configuration.ssl?
+      'https'
+    end
+  end
+end

data/lib/replay_api/trait_properties.rb

@@ -21,16 +21,8 @@ module ReplayApi
     attribute :page_url, String
     attribute :past_event, Integer, default: 0
     attribute :phone, String
-    attribute :timestamp, Integer, default: -> (_, _) { clock.now }
     attribute :title, String
     attribute :username, String
 
-    def self.clock=(val)
-      @clock = val
-    end
-
-    def self.clock
-      @clock ||= Time
-    end
   end
 end

data/lib/replay_api/version.rb

@@ -1,3 +1,3 @@
 module ReplayApi
-  VERSION = '0.0.3'
+  VERSION = '0.0.5'
 end

data/replay_api.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['support@replay.io']
   spec.summary       = %q{Ruby SDK for Replay.io API}
   spec.description   = %q{Ruby SDK for Replay.io API}
-  spec.homepage      = 'https://github.com/Originate/replay-gem'
+  spec.homepage      = 'https://github.com/Originate/replay-ruby'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")

data/spec/replay_api/client_spec.rb

@@ -2,12 +2,9 @@ require 'spec_helper'
 
 module ReplayApi
   describe Client do
-    subject(:client) { Client.new(configuration) }
-    let(:connection) { double :connection, post: nil }
+    subject(:client) { Client.new(configuration, deliverer) }
+    let(:deliverer) { double :deliverer, post: nil }
     let(:configuration) { Configuration.new.tap { |c| c.replay_key = 'my_key' } }
-    before do
-      client.connection = connection
-    end
 
     describe '#event' do
       let(:event) { Event.new }
@@ -19,7 +16,7 @@ module ReplayApi
 
       it 'posts the event' do
         client.event(event)
-        expect(connection).to have_received(:post).with('/events', payload)
+        expect(deliverer).to have_received(:post).with(uri: '/events', payload: payload)
       end
     end
 
@@ -33,7 +30,7 @@ module ReplayApi
 
       it 'posts the trait' do
         client.trait(trait)
-        expect(connection).to have_received(:post).with('/traits', payload)
+        expect(deliverer).to have_received(:post).with(uri: '/traits', payload: payload)
       end
     end
   end

data/spec/replay_api/compact_attributes_spec.rb

@@ -19,7 +19,7 @@ module ReplayApi
         { attribute1: :value1, attribute2: { attribute3: :value3 } } => { attribute1: :value1, attribute2: { attribute3: :value3 } },
         { attribute1: :value1, attribute2: { attribute3: nil } } => { attribute1: :value1 },
         { attribute1: :value1, attribute2: { attribute3: :value3, attribute4: nil } } => { attribute1: :value1, attribute2: { attribute3: :value3 } },
-        { attribute1: :value1, attribute2: Event.new(event_name: 'Test Event', properties: { timestamp: 12345 }) } => { attribute1: :value1, attribute2: { event_name: 'Test Event', properties: { event_category: 'general', past_event: 0, timestamp: 12345 } } },
+        { attribute1: :value1, attribute2: Event.new(event_name: 'Test Event', properties: { }) } => { attribute1: :value1, attribute2: { event_name: 'Test Event', properties: { event_category: 'general', past_event: 0 } } },
       }
 
       test_cases.each do |input, output|

data/spec/replay_api/event_properties_spec.rb

@@ -3,9 +3,6 @@ require 'spec_helper'
 module ReplayApi
   describe EventProperties do
     subject(:properties) { EventProperties.new }
-    let(:clock) { double :clock, now: Time.now }
-    before { EventProperties.clock = clock }
-    after { EventProperties.clock = nil }
 
     describe '#event_category' do
       specify { expect(properties.event_category).to eq 'general' }
@@ -14,9 +11,5 @@ module ReplayApi
     describe '#past_event' do
       specify { expect(properties.past_event).to eq 0 }
     end
-
-    describe '#timestamp' do
-      specify { expect(properties.timestamp).to eq clock.now.to_i }
-    end
   end
 end

data/spec/replay_api/request_deliverer_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+module ReplayApi
+  describe RequestDeliverer do
+    subject(:request_deliverer) { RequestDeliverer.instance }
+    let(:connection) { double :connection, post: nil }
+    let(:configuration) { Configuration.new.tap { |c| c.replay_key = 'my_key' } }
+
+    before do
+      allow(connection).to receive(:in_parallel).and_yield
+      request_deliverer.configuration = configuration
+      request_deliverer.connection = connection
+    end
+
+    describe '#post' do
+      let(:event) { Event.new }
+      let(:payload) { { replay_key: 'my_key' }.merge event.compact_attributes }
+
+      it 'sends the request' do
+        request_deliverer.post(uri:  '/events', payload: payload)
+        {} until request_deliverer.delivery_thread.status == "sleep"
+        expect(connection).to have_received(:post).with('/events', payload)
+      end
+    end
+  end
+end

data/spec/replay_api/trait_properties_spec.rb

@@ -3,10 +3,7 @@ require 'spec_helper'
 module ReplayApi
   describe TraitProperties do
     subject(:properties) { TraitProperties.new }
-    let(:clock) { double :clock, now: Time.now }
-    before { TraitProperties.clock = clock }
-    after { TraitProperties.clock = nil }
-
+    
     describe '#address' do
       specify { expect(properties.address).to be_a(ReplayApi::Address) }
     end
@@ -14,9 +11,5 @@ module ReplayApi
     describe '#past_event' do
       specify { expect(properties.past_event).to eq 0 }
     end
-
-    describe '#timestamp' do
-      specify { expect(properties.timestamp).to eq clock.now.to_i }
-    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: replay_api
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Originate
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-26 00:00:00.000000000 Z
+date: 2015-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -131,21 +131,22 @@ files:
 - lib/replay_api/event_properties.rb
 - lib/replay_api/event_properties_extensions.rb
 - lib/replay_api/model.rb
+- lib/replay_api/request_deliverer.rb
 - lib/replay_api/trait.rb
 - lib/replay_api/trait_properties.rb
 - lib/replay_api/trait_properties_extensions.rb
 - lib/replay_api/version.rb
 - replay_api.gemspec
-- spec/feature/client_spec.rb
 - spec/replay_api/client_spec.rb
 - spec/replay_api/compact_attributes_spec.rb
 - spec/replay_api/configuration_spec.rb
 - spec/replay_api/event_properties_spec.rb
 - spec/replay_api/event_spec.rb
+- spec/replay_api/request_deliverer_spec.rb
 - spec/replay_api/trait_properties_spec.rb
 - spec/replay_api/trait_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/Originate/replay-gem
+homepage: https://github.com/Originate/replay-ruby
 licenses:
 - MIT
 metadata: {}
@@ -165,17 +166,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: Ruby SDK for Replay.io API
 test_files:
-- spec/feature/client_spec.rb
 - spec/replay_api/client_spec.rb
 - spec/replay_api/compact_attributes_spec.rb
 - spec/replay_api/configuration_spec.rb
 - spec/replay_api/event_properties_spec.rb
 - spec/replay_api/event_spec.rb
+- spec/replay_api/request_deliverer_spec.rb
 - spec/replay_api/trait_properties_spec.rb
 - spec/replay_api/trait_spec.rb
 - spec/spec_helper.rb

data/spec/feature/client_spec.rb

@@ -1,16 +0,0 @@
-require 'spec_helper'
-
-ReplayApi.configure do |config|
-  config.replay_key = 'bogus-key'
-  config.ssl = false
-end
-
-describe 'Posting Events' do
-  let(:client) { ReplayApi::Client.new }
-
-  it 'can post an event' do
-    client.event do |event|
-      event.event_name = 'Test Event'
-    end
-  end
-end