keen 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c3cf3ae16e58f3c518d668690727dee634e620ec
-  data.tar.gz: bb8e8adde18854b35095b90017dc468900e28201
+  metadata.gz: bfa6893d4994089e26e547221cd8471568335ec6
+  data.tar.gz: c353a3635a5656b6b9e0a4840d1bd88de8beac21
 SHA512:
-  metadata.gz: 097d04970b5ce6c0779b96655cd29aa747d1df5eeb4506dfc4763546fae08c7bd3b6f7ed48f5b4f2dcbd3a4caeb433778fda7bfa67d5871c9f9d3c2ffa4d48e2
-  data.tar.gz: 732360e3dd2873579493eb08f407055929cc9d27a5285ef8d592dcfd94f69999d66f4d62787a0557b96b485409bdb2cb35a5233ff270b81b73e057c0e1247cdf
+  metadata.gz: 75adf0c282766b84c1d7be3fc5dab6567951b36f0d63456c12406a7845ccc401f1fb258b93de6e6e150c4fea2c5349bf50eee4719e8f7eeab40979a7b9cd86db
+  data.tar.gz: d9ed4ec4656056f296bdacab25b8ab980164330f62477c0333a1a3d4c7a0874665cde88e0c9e172cae11c0e1d4b0df323b0a9a5626f657e92681a7577320af70

data/README.md

@@ -154,7 +154,7 @@ Keen.delete(:signups)  # => true
 
 # Or just delete an event corresponding to a particular user
 Keen.delete(:signups, filters: [{
-  :property_name => 'username', ;operator => 'eq', :property_value => "Bob"
+  :property_name => 'username', :operator => 'eq', :property_value => "Bob"
 }])  # => true
 ```
 
@@ -180,6 +180,23 @@ Keen.publish_batch(
 This call would publish 2 `signups` events and 2 `purchases` events - all in just one API call.
 Batch publishing is ideal for loading historical events into Keen IO.
 
+#### Asynchronous batch publishing 
+
+Ensuring the above guidance is followed for asynchronous publishing, batch publishing logic can used asynchronously with `publish_batch_async`:
+
+```ruby
+Keen.publish_batch_async(
+  :signups => [
+    { :name => "Bob" },
+    { :name => "Mary" }
+  ],
+  :purchases => [
+    { :price => 10 },
+    { :price => 20 }
+  ]
+)
+```
+
 #### Configurable and per-client authentication
 
 To configure keen-gem in code, do as follows:
@@ -266,6 +283,9 @@ EventMachine itself won't do this because it runs in a different thread. Here's
 
 ### Changelog
 
+##### 0.8.1
++ Add support for asynchronous batch publishing
+
 ##### 0.8.0
 + **UPGRADE WARNING** Do you use spaces in collection names? Or other special characters? Read [this post](https://groups.google.com/forum/?fromgroups#!topic/keen-io-devs/VtCgPuNKrgY) from the mailing list to make sure your collection names don't change.
 + Add support for generating [scoped keys](https://keen.io/docs/security/#scoped-key).

data/keen.gemspec

@@ -12,9 +12,7 @@ Gem::Specification.new do |s|
   s.description = "Send events and build analytics features into your Ruby applications."
   s.license     = "MIT"
 
-  s.post_install_message = "**UPGRADE WARNING** Do you use spaces in collection names? Or other special characters? Read https://groups.google.com/forum/?fromgroups#!topic/keen-io-devs/VtCgPuNKrgY from the mailing list to make sure your collection names don't change!"
-
-  s.add_dependency "multi_json", "~> 1.0"
+  s.add_dependency "multi_json", "~> 1.3"
   s.add_dependency "addressable", "~> 2.3.5"
   s.add_dependency "jruby-openssl" if defined?(JRUBY_VERSION)
 

data/lib/keen.rb

@@ -39,7 +39,7 @@ module Keen
 
     def_delegators :default_client,
                    :publish, :publish_async, :publish_batch,
-                   :beacon_url, :redirect_url
+                   :publish_batch_async, :beacon_url, :redirect_url
 
     def_delegators :default_client,
                    :count, :count_unique, :minimum, :maximum,

data/lib/keen/client/publishing_methods.rb

@@ -77,6 +77,26 @@ module Keen
         end
       end
 
+      def publish_batch_async(events)
+        ensure_project_id!
+        ensure_write_key!
+
+        http_client = Keen::HTTP::Async.new(
+            self.api_url,
+            {:proxy_url => self.proxy_url, :proxy_type => self.proxy_type})
+
+        http = http_client.post(
+          :path => api_events_resource_path,
+          :headers => api_headers(self.write_key, "async"),
+          :body => MultiJson.encode(events)
+        )
+        if defined?(EM::Synchrony)
+          process_with_synchrony(http)
+        else
+          process_with_callbacks(http)
+        end
+      end
+
       # Returns an encoded URL that will record an event. Useful in email situations.
       # See detailed documentation here
       # https://keen.io/docs/api/reference/#event-collection-resource

data/lib/keen/version.rb

@@ -1,3 +1,3 @@
 module Keen
-  VERSION = "0.8.0"
+  VERSION = "0.8.1"
 end

data/spec/integration/api_spec.rb

@@ -4,6 +4,15 @@ describe "Keen IO API" do
   let(:project_id) { ENV['KEEN_PROJECT_ID'] }
   let(:write_key) { ENV['KEEN_WRITE_KEY'] }
 
+  def wait_for_count(event_collection, count)
+    attempts = 0
+    while attempts < 30
+      break if Keen.count(event_collection) == count
+      attempts += 1
+      sleep(1)
+    end
+  end
+
   describe "publishing" do
     let(:collection) { "User posts.new" }
     let(:event_properties) { { "name" => "Bob" } }
@@ -85,6 +94,35 @@ describe "Keen IO API" do
     end
   end
 
+  describe "batch_async" do
+      # no TLS support in EventMachine on jRuby
+      unless defined?(JRUBY_VERSION)
+        let(:api_success) { {"batch_purchases"=>[{"success"=>true}, {"success"=>true}], "batch_signups"=>[{"success"=>true}, {"success"=>true}]} }
+        it "should publish the event and trigger callbacks" do
+          EM.run {
+            Keen.publish_batch_async(
+              :batch_signups => [
+                { :name => "bob" },
+                { :name => "ted" }
+              ],
+              :batch_purchases => [
+                { :price => 30 },
+                { :price => 40 }
+              ]).callback { |response|
+              begin
+                response.should == api_success
+              ensure
+                EM.stop
+              end
+            }.errback { |error|
+              EM.stop
+              fail error
+            }
+          }
+        end
+      end
+    end
+
   describe "queries" do
     let(:read_key) { ENV['KEEN_READ_KEY'] }
     let(:event_collection) { @event_collection }
@@ -106,26 +144,25 @@ describe "Keen IO API" do
         :username => "bob",
         :price => 30
       })
-      sleep(5)
-    end
 
-    it "should return a valid count" do
-      Keen.count(event_collection).should == 2
+      # poll the count to know when to continue
+      wait_for_count(@event_collection, 2)
+      wait_for_count(@returns_event_collection, 1)
     end
 
     it "should return a valid count_unique" do
       Keen.count_unique(event_collection, :target_property => "price").should == 2
     end
-    
-    it "should return a valid count with group_by" do   
+
+    it "should return a valid count with group_by" do
       response = Keen.average(event_collection, :group_by => "username", :target_property => "price")
       bobs_response = response.select { |result| result["username"] == "bob" }.first
       bobs_response["result"].should == 10
       teds_response = response.select { |result| result["username"] == "ted" }.first
-      teds_response["result"].should == 20    
+      teds_response["result"].should == 20
     end
-    
-    it "should return a valid count with multi-group_by" do   
+
+    it "should return a valid count with multi-group_by" do
       response = Keen.average(event_collection, :group_by => ["username", "price"], :target_property => "price")
       bobs_response = response.select { |result| result["username"] == "bob" }.first
       bobs_response["result"].should == 10
@@ -189,15 +226,14 @@ describe "Keen IO API" do
     before do
       Keen.publish(event_collection, :delete => "me")
       Keen.publish(event_collection, :delete => "you")
-      sleep(10)
+      wait_for_count(event_collection, 2)
     end
 
     it "should delete the event" do
-      Keen.count(event_collection).should == 2
       Keen.delete(event_collection, :filters => [
         { :property_name => "delete", :operator => "eq", :property_value => "me" }
       ])
-      sleep(3)
+      wait_for_count(event_collection, 1)
       results = Keen.extraction(event_collection)
       results.length.should == 1
       results.first["delete"].should == "you"

data/spec/keen/client/publishing_methods_spec.rb

@@ -130,7 +130,7 @@ describe Keen::Client::PublishingMethods do
             ensure
               EM.stop
             end
-          }.errback { 
+          }.errback {
             EM.stop
             fail
           }
@@ -211,6 +211,84 @@ describe Keen::Client::PublishingMethods do
     end
   end
 
+  describe "publish_batch_async" do
+    unless defined?(JRUBY_VERSION)
+      let(:multi) { EventMachine::MultiRequest.new }
+      let(:events) {
+        {
+          :purchases => [
+            { :price => 10 },
+            { :price => 11 }
+          ],
+          :signups => [
+            { :name => "bob" },
+            { :name => "bill" }
+          ]
+        }
+      }
+
+      it "should raise an exception if client has no project_id" do
+        expect {
+          Keen::Client.new(
+            :write_key => "abcde"
+          ).publish_batch_async(events)
+        }.to raise_error(Keen::ConfigurationError, "Keen IO Exception: Project ID must be set")
+      end
+
+      it "should raise an exception if client has no write_key" do
+        expect {
+          Keen::Client.new(
+            :project_id => "12345"
+          ).publish_batch_async(events)
+        }.to raise_error(Keen::ConfigurationError, "Keen IO Exception: Write Key must be set for sending events")
+      end
+
+      describe "deferrable callbacks" do
+        it "should trigger callbacks" do
+          stub_keen_post(api_event_resource_url(api_url), 201, api_success)
+          EM.run {
+            client.publish_batch_async(events).callback { |response|
+              begin
+                response.should == api_success
+              ensure
+                EM.stop
+              end
+            }
+          }
+        end
+
+        it "should trigger errbacks" do
+          stub_request(:post, api_event_resource_url(api_url)).to_timeout
+          EM.run {
+            client.publish_batch_async(events).errback { |error|
+              begin
+                error.should_not be_nil
+                error.message.should == "Keen IO Exception: HTTP publish_async failure: WebMock timeout error"
+              ensure
+                EM.stop
+              end
+            }
+          }
+        end
+
+        it "should not trap exceptions in the client callback" do
+          stub_keen_post(api_event_resource_url(api_url), 201, api_success)
+          expect {
+            EM.run {
+              client.publish_batch_async(events).callback {
+                begin
+                  blowup
+                ensure
+                  EM.stop
+                end
+              }
+            }
+          }.to raise_error
+        end
+      end
+    end
+  end
+
   it "should raise an exception if client has no project_id" do
     expect {
       Keen::Client.new.publish_async(collection, event_properties)
@@ -237,4 +315,5 @@ describe Keen::Client::PublishingMethods do
         "#{api_url}/3.0/projects/12345/events/sign_ups?api_key=#{write_key}&data=eyJuYW1lIjoiQm9iIn0=&redirect=http://keen.io/?foo=bar&bar=baz"
     end
   end
+
 end

data/spec/keen/keen_spec.rb

@@ -84,7 +84,7 @@ describe Keen do
       end
     end
 
-    [:publish, :publish_async, :publish_batch].each do |_method|
+    [:publish, :publish_async, :publish_batch, :publish_batch_async].each do |_method|
       it "should forward the #{_method} method" do
         @default_client.should_receive(_method).with("users", {})
         Keen.send(_method, "users", {})

data/spec/synchrony/synchrony_spec.rb

@@ -7,6 +7,19 @@ describe Keen::HTTP::Async do
   let(:api_url) { "https://fake.keen.io" }
   let(:event_properties) { { "name" => "Bob" } }
   let(:api_success) { { "created" => true } }
+  let(:batch_api_success) { { "created" => true } }
+  let(:events) {
+        {
+          :purchases => [
+            { :price => 10 },
+            { :price => 11 }
+          ],
+          :signups => [
+            { :name => "bob" },
+            { :name => "bill" }
+          ]
+        }
+      }
 
   describe "synchrony" do
     before do
@@ -25,7 +38,7 @@ describe Keen::HTTP::Async do
         }
       end
 
-      it "should recieve the right response 'synchronously'" do
+      it "should receive the right response 'synchronously'" do
         stub_keen_post(api_event_collection_resource_url(api_url, collection), 201, api_success)
         EM.synchrony {
           @client.publish_async(collection, event_properties).should == api_success
@@ -34,6 +47,25 @@ describe Keen::HTTP::Async do
       end
     end
 
+    describe "batch success" do
+      it "should post the event data" do
+        stub_keen_post(api_event_resource_url(api_url), 201, api_success)
+        EM.synchrony {
+          @client.publish_batch_async(events)
+          expect_keen_post(api_event_resource_url(api_url), events, "async", write_key)
+          EM.stop
+        }
+      end
+
+      it "should receive the right response 'synchronously'" do
+        stub_keen_post(api_event_resource_url(api_url), 201, api_success)
+        EM.synchrony {
+          @client.publish_batch_async(events).should == api_success
+          EM.stop
+        }
+      end
+    end
+
     describe "failure" do
       it "should raise an exception" do
         stub_request(:post, api_event_collection_resource_url(api_url, collection)).to_timeout
@@ -50,5 +82,22 @@ describe Keen::HTTP::Async do
         }
       end
     end
+
+    describe "batch failure" do
+      it "should raise an exception" do
+        stub_request(:post, api_event_resource_url(api_url)).to_timeout
+        e = nil
+        EM.synchrony {
+          begin
+            @client.publish_batch_async(events).should == api_success
+          rescue Exception => exception
+            e = exception
+          end
+          e.class.should == Keen::HttpError
+          e.message.should == "Keen IO Exception: HTTP em-synchrony publish_async error: WebMock timeout error"
+          EM.stop
+        }
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: keen
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Kyle Wild
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-09 00:00:00.000000000 Z
+date: 2014-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -18,14 +18,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
@@ -179,9 +179,7 @@ homepage: https://github.com/keenlabs/keen-gem
 licenses:
 - MIT
 metadata: {}
-post_install_message: '**UPGRADE WARNING** Do you use spaces in collection names?
-  Or other special characters? Read https://groups.google.com/forum/?fromgroups#!topic/keen-io-devs/VtCgPuNKrgY
-  from the mailing list to make sure your collection names don''t change!'
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib