analytics-ruby 0.1.4 → 0.2.0

data/History.md

@@ -1,3 +1,7 @@
+0.2.0 / 2013-3-21
+===========
+* Adding flush method
+
 0.1.4 / 2013-3-19
 ===========
 * Adding ClassMethods for more extensibility by [arronmabrey](https://github.com/arronmabrey)

data/lib/analytics-ruby.rb

@@ -17,6 +17,11 @@ module AnalyticsRuby
       return false unless @client
       @client.identify(options)
     end
+
+    def flush
+      return false unless @client
+      @client.flush
+    end
   end
   extend ClassMethods
 end

data/lib/analytics-ruby/client.rb

@@ -15,7 +15,7 @@ module AnalyticsRuby
     #           :secret         - String of your project's secret
     #           :max_queue_size - Fixnum of the max calls to remain queued (optional)
     #           :on_error       - Proc which handles error calls from the API
-    def initialize (options = {})
+    def initialize(options = {})
 
       @queue = Queue.new
       @secret = options[:secret]
@@ -24,7 +24,17 @@ module AnalyticsRuby
       check_secret
 
       @consumer = AnalyticsRuby::Consumer.new(@queue, @secret, options)
-      Thread.new { @consumer.run }
+      @thread = Thread.new { @consumer.run }
+    end
+
+    # public: Synchronously waits until the consumer has flushed the queue.
+    #         Use only for scripts which are not long-running, and will
+    #         specifically exit
+    #
+    def flush
+      while !@queue.empty? || @consumer.is_requesting?
+        sleep(0.1)
+      end
     end
 
     # public: Tracks an event

data/lib/analytics-ruby/consumer.rb

@@ -24,6 +24,8 @@ module AnalyticsRuby
       @on_error = options[:on_error] || Proc.new { |status, error| }
 
       @current_batch = []
+
+      @mutex = Mutex.new
     end
 
     # public: Continuously runs the loop to check for new events
@@ -37,18 +39,33 @@ module AnalyticsRuby
     # public: Flush some events from our queue
     #
     def flush
-
       # Block until we have something to send
-      @current_batch << @queue.pop()
+      item = @queue.pop()
 
-      until @current_batch.length >= @batch_size || @queue.empty?
-        @current_batch << @queue.pop()
-      end
+      # Synchronize on additions to the current batch
+      @mutex.synchronize {
+        @current_batch << item
+        until @current_batch.length >= @batch_size || @queue.empty?
+          @current_batch << @queue.pop()
+        end
+      }
 
       req = AnalyticsRuby::Request.new
       res = req.post(@secret, @current_batch)
       @on_error.call(res.status, res.error) unless res.status == 200
-      @current_batch = []
+      @mutex.synchronize {
+        @current_batch = []
+      }
+    end
+
+    # public: Check whether we have outstanding requests.
+    #
+    def is_requesting?
+      requesting = nil
+      @mutex.synchronize {
+        requesting = !@current_batch.empty?
+      }
+      requesting
     end
 
   end

data/lib/analytics-ruby/version.rb

@@ -1,3 +1,3 @@
 module AnalyticsRuby
-  VERSION = '0.1.4'
+  VERSION = '0.2.0'
 end

data/spec/client_spec.rb

@@ -13,7 +13,6 @@ describe Analytics::Client do
     it 'should not error if a secret is supplied' do
       Analytics::Client.new secret: AnalyticsHelpers::SECRET
     end
-
   end
 
   describe '#track' do
@@ -33,7 +32,6 @@ describe Analytics::Client do
     it 'should not error with the required options' do
       @client.track AnalyticsHelpers::Queued::TRACK
     end
-
   end
 
 
@@ -50,9 +48,20 @@ describe Analytics::Client do
     it 'should not error with the required options' do
       @client.identify AnalyticsHelpers::Queued::IDENTIFY
     end
-
   end
 
+  describe '#flush' do
+    before(:all) do
+      @client = Analytics::Client.new secret: AnalyticsHelpers::SECRET
+    end
+
+    it 'should wait for the queue to finish on a flush' do
+      @client.identify AnalyticsHelpers::Queued::IDENTIFY
+      @client.track AnalyticsHelpers::Queued::TRACK
+      @client.flush
+      @client.queued_messages.should == 0
+    end
+  end
 end
 
 

data/spec/consumer_spec.rb

@@ -58,4 +58,31 @@ describe Analytics::Consumer do
       queue.should be_empty
     end
   end
+
+  describe '#is_requesting?' do
+
+    it 'should not return true if there isn\'t a current batch' do
+
+      queue = Queue.new
+      consumer = Analytics::Consumer.new(queue, 'testsecret')
+
+      consumer.is_requesting?.should == false
+    end
+
+    it 'should return true if there is a current batch' do
+
+      queue = Queue.new
+      queue << AnalyticsHelpers::Requested::TRACK
+      consumer = Analytics::Consumer.new(queue, 'testsecret')
+
+      Thread.new {
+        consumer.flush
+        consumer.is_requesting?.should == false
+      }
+
+      # sleep barely long enough to let thread flush the queue.
+      sleep(0.001)
+      consumer.is_requesting?.should == true
+    end
+  end
 end

data/spec/module_spec.rb

@@ -55,4 +55,12 @@ describe Analytics do
       sleep(1)
     end
   end
+
+  describe '#flush' do
+
+    it 'should flush without error' do
+      Analytics.identify AnalyticsHelpers::Queued::IDENTIFY
+      Analytics.flush
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: analytics-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-19 00:00:00.000000000 Z
+date: 2013-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &10550500 !ruby/object:Gem::Requirement
+  requirement: &10049160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -24,10 +24,10 @@ dependencies:
         version: '0.10'
   type: :runtime
   prerelease: false
-  version_requirements: *10550500
+  version_requirements: *10049160
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
-  requirement: &13478460 !ruby/object:Gem::Requirement
+  requirement: &10048220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -38,10 +38,10 @@ dependencies:
         version: '0.10'
   type: :runtime
   prerelease: false
-  version_requirements: *13478460
+  version_requirements: *10048220
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &13477720 !ruby/object:Gem::Requirement
+  requirement: &10047320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -49,10 +49,10 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *13477720
+  version_requirements: *10047320
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &13477340 !ruby/object:Gem::Requirement
+  requirement: &10046680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -60,10 +60,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *13477340
+  version_requirements: *10046680
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &13476880 !ruby/object:Gem::Requirement
+  requirement: &10044520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -71,7 +71,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *13476880
+  version_requirements: *10044520
 description: The Segment.io ruby analytics library
 email: friends@segment.io
 executables: []
@@ -88,6 +88,7 @@ files:
 - lib/analytics-ruby/version.rb
 - lib/analytics-ruby/json.rb
 - lib/analytics-ruby/client.rb
+- analytics-ruby-0.1.4.gem
 - History.md
 - analytics-ruby.gemspec
 - Rakefile