keen 0.7.2 → 0.7.3

data/Gemfile

@@ -8,6 +8,8 @@ group :development, :test do
   gem 'em-http-request'
   gem 'em-synchrony', :require => false
   gem 'webmock'
+  # ensure a reasonable json so multi_json doesn't complain
+  gem 'json', '~> 1.7.7'
 end
 
 group :development do

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    keen (0.7.1)
+    keen (0.7.3)
       multi_json (~> 1.0)
 
 GEM
@@ -42,6 +42,7 @@ GEM
       guard (>= 1.8)
       rspec (~> 2.13)
     http_parser.rb (0.5.3)
+    json (1.7.7)
     linecache (0.46)
       rbx-require-relative (> 0.0.4)
     listen (1.0.3)
@@ -50,7 +51,7 @@ GEM
       rb-kqueue (>= 0.2)
     lumberjack (1.0.3)
     method_source (0.8.1)
-    multi_json (1.7.2)
+    multi_json (1.7.3)
     pry (0.9.12.1)
       coderay (~> 1.0.5)
       method_source (~> 0.8)
@@ -94,6 +95,7 @@ DEPENDENCIES
   em-synchrony
   guard
   guard-rspec
+  json (~> 1.7.7)
   keen!
   rake
   rb-fchange

data/README.md

@@ -133,6 +133,26 @@ Detailed information on available parameters for each API resource can be found
 
 ### Other code examples
 
+#### Batch publishing
+
+The keen-gem supports publishing events in batches via the `publish_batch` method. Here's an example usage:
+
+```ruby
+Keen.publish_batch(
+  :signups => [
+    { :name => "Bob" },
+    { :name => "Mary" }
+  ],
+  :purchases => [
+    { :price => 10 },
+    { :price => 20 }
+  ]
+)
+```
+
+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.
+
 #### Authentication
 
 To configure keen-gem in code, do as follows:
@@ -177,6 +197,10 @@ To track email opens, simply add an image to your email template that points to
 
 ### Changelog
 
+##### 0.7.3
++ Add batch publishing support
++ Allow event collection names for querying methods to be symbols. Thanks to [cbartlett](https://github.com/cbartlett).
+
 ##### 0.7.2
 + Fix support for non-https API URL testing
 
@@ -223,5 +247,6 @@ Fire away with issues and pull requests!
 + [alexkwolfe](https://github.com/alexkwolfe)
 + [peteygao](https://github.com/peteygao)
 + [obieq](https://github.com/obieq)
- 
++ [cbartlett](https://github.com/cbartlett)
+
 Thanks everyone, you rock!

data/lib/keen/client/publishing_methods.rb

@@ -25,17 +25,27 @@ module Keen
         ensure_project_id!
         ensure_write_key!
         check_event_data!(event_collection, properties)
+        publish_body(
+          api_event_collection_resource_path(event_collection),
+          MultiJson.encode(properties),
+          "publish")
+      end
 
-        begin
-          response = Keen::HTTP::Sync.new(
-            self.api_url).post(
-              :path => api_event_resource_path(event_collection),
-              :headers => api_headers(self.write_key, "sync"),
-              :body => MultiJson.encode(properties))
-        rescue Exception => http_error
-          raise HttpError.new("HTTP publish failure: #{http_error.message}", http_error)
-        end
-        process_response(response.code, response.body.chomp)
+      # Publishes a batch of events
+      # See detailed documentation here
+      # https://keen.io/docs/api/reference/#post-request-body-example-of-batch-event-posting
+      #
+      # @param events - a hash where the keys are event collection names
+      # and the values are arrays of hashes (event properties)
+      #
+      # @return the JSON response from the API
+      def publish_batch(events)
+        ensure_project_id!
+        ensure_write_key!
+        publish_body(
+          api_events_resource_path,
+          MultiJson.encode(events),
+          "publish")
       end
 
       # Publishes an asynchronous event
@@ -55,7 +65,7 @@ module Keen
 
         http_client = Keen::HTTP::Async.new(self.api_url)
         http = http_client.post(
-          :path => api_event_resource_path(event_collection),
+          :path => api_event_collection_resource_path(event_collection),
           :headers => api_headers(self.write_key, "async"),
           :body => MultiJson.encode(properties)
         )
@@ -98,15 +108,32 @@ module Keen
       def beacon_url(event_collection, properties)
         json = MultiJson.encode(properties)
         data = [json].pack("m0").tr("+/", "-_").gsub("\n", "")
-        "#{self.api_url}#{api_event_resource_path(event_collection)}?api_key=#{self.write_key}&data=#{data}"
+        "#{self.api_url}#{api_event_collection_resource_path(event_collection)}?api_key=#{self.write_key}&data=#{data}"
       end
 
       private
 
-      def api_event_resource_path(event_collection)
+      def publish_body(path, body, error_method)
+        begin
+          response = Keen::HTTP::Sync.new(
+            self.api_url).post(
+              :path => path,
+              :headers => api_headers(self.write_key, "sync"),
+              :body => body)
+        rescue Exception => http_error
+          raise HttpError.new("HTTP #{error_method} failure: #{http_error.message}", http_error)
+        end
+        process_response(response.code, response.body.chomp)
+      end
+
+      def api_event_collection_resource_path(event_collection)
         "/#{api_version}/projects/#{project_id}/events/#{URI.escape(event_collection)}"
       end
 
+      def api_events_resource_path
+        "/#{api_version}/projects/#{project_id}/events"
+      end
+
       def check_event_data!(event_collection, properties)
         raise ArgumentError, "Event collection can not be nil" unless event_collection
         raise ArgumentError, "Event properties can not be nil" unless properties

data/lib/keen/client/querying_methods.rb

@@ -165,7 +165,7 @@ module Keen
         ensure_read_key!
 
         if event_collection
-          params[:event_collection] = event_collection
+          params[:event_collection] = event_collection.to_s
         end
 
         query_params = preprocess_params(params)

data/lib/keen/version.rb

@@ -1,3 +1,3 @@
 module Keen
-  VERSION = "0.7.2"
+  VERSION = "0.7.3"
 end

data/lib/keen.rb

@@ -25,19 +25,20 @@ module Keen
   class << self
     extend Forwardable
 
-    def_delegators :default_client, 
-                   :project_id, :project_id=, 
-                   :write_key, :write_key=, 
-                   :read_key, :read_key=, 
+    def_delegators :default_client,
+                   :project_id, :project_id=,
+                   :write_key, :write_key=,
+                   :read_key, :read_key=,
                    :api_url, :api_url=
 
     def_delegators :default_client,
-                   :publish, :publish_async,
+                   :publish, :publish_async, :publish_batch,
                    :beacon_url
 
     def_delegators :default_client,
                    :count, :count_unique, :minimum, :maximum,
-                   :sum, :average, :select_unique, :funnel, :extraction
+                   :sum, :average, :select_unique, :funnel, :extraction,
+                   :multi_analysis
 
     attr_writer :logger
 

data/spec/integration/api_spec.rb

@@ -60,6 +60,29 @@ describe "Keen IO API" do
         end
       end
     end
+
+    describe "batch" do
+      it "should publish a batch of events" do
+        Keen.publish_batch(
+          :batch_signups => [
+            { :name => "bob" },
+            { :name => "ted" }
+          ],
+          :batch_purchases => [
+            { :price => 30 },
+            { :price => 40 }
+          ]
+        ).should == {
+          "batch_purchases" => [
+            { "success" => true },
+            { "success" => true }
+          ],
+          "batch_signups" => [
+            { "success" => true },
+            { "success"=>true }
+          ]}
+      end
+    end
   end
 
   describe "queries" do

data/spec/keen/client/publishing_methods_spec.rb

@@ -13,14 +13,14 @@ describe Keen::Client::PublishingMethods do
 
   describe "publish" do
     it "should post using the collection and properties" do
-      stub_keen_post(api_event_resource_url(api_url, collection), 201, "")
+      stub_keen_post(api_event_collection_resource_url(api_url, collection), 201, "")
       client.publish(collection, event_properties)
-      expect_keen_post(api_event_resource_url(api_url, collection), event_properties, "sync", write_key)
+      expect_keen_post(api_event_collection_resource_url(api_url, collection), event_properties, "sync", write_key)
     end
 
     it "should return the proper response" do
       api_response = { "created" => true }
-      stub_keen_post(api_event_resource_url(api_url, collection), 201, api_response)
+      stub_keen_post(api_event_collection_resource_url(api_url, collection), 201, api_response)
       client.publish(collection, event_properties).should == api_response
     end
 
@@ -37,13 +37,13 @@ describe Keen::Client::PublishingMethods do
     end
 
     it "should url encode the event collection" do
-      stub_keen_post(api_event_resource_url(api_url, "foo%20bar"), 201, "")
+      stub_keen_post(api_event_collection_resource_url(api_url, "foo%20bar"), 201, "")
       client.publish("foo bar", event_properties)
-      expect_keen_post(api_event_resource_url(api_url, "foo%20bar"), event_properties, "sync", write_key)
+      expect_keen_post(api_event_collection_resource_url(api_url, "foo%20bar"), event_properties, "sync", write_key)
     end
 
     it "should wrap exceptions" do
-      stub_request(:post, api_event_resource_url(api_url, collection)).to_timeout
+      stub_request(:post, api_event_collection_resource_url(api_url, collection)).to_timeout
       e = nil
       begin
         client.publish(collection, event_properties)
@@ -73,6 +73,45 @@ describe Keen::Client::PublishingMethods do
     end
   end
 
+  describe "publish_batch" do
+    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(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(events)
+      }.to raise_error(Keen::ConfigurationError, "Keen IO Exception: Write Key must be set for sending events")
+    end
+
+    it "should publish a batch of events" do
+      stub_keen_post(api_event_resource_url(api_url), 201, "")
+      client.publish_batch(events)
+      expect_keen_post(
+        api_event_resource_url(api_url),
+                       events, "sync", write_key)
+    end
+  end
+
   describe "publish_async" do
     # no TLS support in EventMachine on jRuby
     unless defined?(JRUBY_VERSION)
@@ -83,11 +122,11 @@ describe Keen::Client::PublishingMethods do
       end
 
       it "should post the event data" do
-        stub_keen_post(api_event_resource_url(api_url, collection), 201, api_success)
+        stub_keen_post(api_event_collection_resource_url(api_url, collection), 201, api_success)
         EM.run {
           client.publish_async(collection, event_properties).callback {
             begin
-              expect_keen_post(api_event_resource_url(api_url, collection), event_properties, "async", write_key)
+              expect_keen_post(api_event_collection_resource_url(api_url, collection), event_properties, "async", write_key)
             ensure
               EM.stop
             end
@@ -99,11 +138,11 @@ describe Keen::Client::PublishingMethods do
       end
 
       it "should uri encode the event collection" do
-        stub_keen_post(api_event_resource_url(api_url, "foo%20bar"), 201, api_success)
+        stub_keen_post(api_event_collection_resource_url(api_url, "foo%20bar"), 201, api_success)
         EM.run {
           client.publish_async("foo bar", event_properties).callback {
             begin
-              expect_keen_post(api_event_resource_url(api_url, "foo%20bar"), event_properties, "async", write_key)
+              expect_keen_post(api_event_collection_resource_url(api_url, "foo%20bar"), event_properties, "async", write_key)
             ensure
               EM.stop
             end
@@ -128,7 +167,7 @@ describe Keen::Client::PublishingMethods do
 
       describe "deferrable callbacks" do
         it "should trigger callbacks" do
-          stub_keen_post(api_event_resource_url(api_url, collection), 201, api_success)
+          stub_keen_post(api_event_collection_resource_url(api_url, collection), 201, api_success)
           EM.run {
             client.publish_async(collection, event_properties).callback { |response|
               begin
@@ -141,7 +180,7 @@ describe Keen::Client::PublishingMethods do
         end
 
         it "should trigger errbacks" do
-          stub_request(:post, api_event_resource_url(api_url, collection)).to_timeout
+          stub_request(:post, api_event_collection_resource_url(api_url, collection)).to_timeout
           EM.run {
             client.publish_async(collection, event_properties).errback { |error|
               begin
@@ -155,7 +194,7 @@ describe Keen::Client::PublishingMethods do
         end
 
         it "should not trap exceptions in the client callback" do
-          stub_keen_post(api_event_resource_url(api_url, "foo%20bar"), 201, api_success)
+          stub_keen_post(api_event_collection_resource_url(api_url, "foo%20bar"), 201, api_success)
           expect {
             EM.run {
               client.publish_async("foo bar", event_properties).callback {

data/spec/keen/client/querying_methods_spec.rb

@@ -113,13 +113,23 @@ describe Keen::Client do
   end
 
   describe "#count" do
-    it "should not require params" do
-      query_params = "?event_collection=#{event_collection}"
-      url = query_url("count", query_params)
+    let(:query_params) { "?event_collection=#{event_collection}" }
+    let(:url) { query_url("count", query_params) }
+    before do
       stub_keen_get(url, 200, :result => 10)
+    end
+
+    it "should not require params" do
       client.count(event_collection).should == 10
       expect_keen_get(url, "sync", read_key)
     end
+
+    context "with event collection as symbol" do
+      let(:event_collection) { :users }
+      it "should not require a string" do
+        client.count(event_collection).should == 10
+      end
+    end
   end
 
   describe "#extraction" do

data/spec/keen/keen_spec.rb

@@ -62,12 +62,21 @@ describe Keen do
       end
     end
 
-    [:publish, :publish_async].each do |_method|
+    [:publish, :publish_async, :publish_batch].each do |_method|
       it "should forward the #{_method} method" do
         @default_client.should_receive(_method).with("users", {})
         Keen.send(_method, "users", {})
       end
     end
+
+    # pull the query methods list at runtime in order to ensure
+    # any new methods have a corresponding delegator
+    Keen::Client::QueryingMethods.instance_methods.each do |_method|
+      it "should forward the #{_method} query method" do
+        @default_client.should_receive(_method).with("users", {})
+        Keen.send(_method, "users", {})
+      end
+    end
   end
 
   describe "logger" do

data/spec/spec_helper.rb

@@ -48,9 +48,13 @@ module Keen::SpecHelpers
     expect_keen_request(:post, url, MultiJson.encode(event_properties), sync_or_async_ua, write_key)
   end
 
-  def api_event_resource_url(base_url, collection)
+  def api_event_collection_resource_url(base_url, collection)
     "#{base_url}/3.0/projects/#{project_id}/events/#{collection}"
   end
+
+  def api_event_resource_url(base_url)
+    "#{base_url}/3.0/projects/#{project_id}/events"
+  end
 end
 
 RSpec.configure do |config|

data/spec/synchrony/synchrony_spec.rb

@@ -17,16 +17,16 @@ describe Keen::HTTP::Async do
 
     describe "success" do
       it "should post the event data" do
-        stub_keen_post(api_event_resource_url(api_url, collection), 201, api_success)
+        stub_keen_post(api_event_collection_resource_url(api_url, collection), 201, api_success)
         EM.synchrony {
           @client.publish_async(collection, event_properties)
-          expect_keen_post(api_event_resource_url(api_url, collection), event_properties, "async", write_key)
+          expect_keen_post(api_event_collection_resource_url(api_url, collection), event_properties, "async", write_key)
           EM.stop
         }
       end
 
       it "should recieve the right response 'synchronously'" do
-        stub_keen_post(api_event_resource_url(api_url, collection), 201, api_success)
+        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
           EM.stop
@@ -36,7 +36,7 @@ describe Keen::HTTP::Async do
 
     describe "failure" do
       it "should raise an exception" do
-        stub_request(:post, api_event_resource_url(api_url, collection)).to_timeout
+        stub_request(:post, api_event_collection_resource_url(api_url, collection)).to_timeout
         e = nil
         EM.synchrony {
           begin

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: keen
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.7.3
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-02 00:00:00.000000000 Z
+date: 2013-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json