keen 0.4.3 → 0.4.4

data/README.md

@@ -89,8 +89,7 @@ To configure keen-gem credentials in code, do as follows:
 
 You can also configure individual client instances as follows:
 
-    keen = Keen::Client.new(:project_id => 'your-project-id',
-                            :api_key => 'your-api-key')
+    keen = Keen::Client.new(:project_id => 'your-project-id', :api_key => 'your-api-key')
 
 #### em-synchrony
 keen-gem can be used with [em-synchrony](https://github.com/igrigorik/em-synchrony).
@@ -106,15 +105,24 @@ This is useful for situations like tracking email opens using [image beacons](ht
 In this situation, the JSON event data is passed by encoding it base-64 and adding it as a request parameter called `data`.
 The `beacon_url` method found on the `Keen::Client` does this for you. Here's an example:
 
-    keen = Keen::Client.new(:project_id => '12345',
-                            :api_key => 'abcde')
+    keen = Keen::Client.new(:project_id => '12345', :api_key => 'abcde')
 
     keen.beacon_url("sign_ups", :recipient => "foo@foo.com")
-    # => "https://api.keen.io/3.0/projects/50e5ffa6897a2c319b000000/events/ \
-          email_opens?api_key=f806128f31c349fda124b62d1f4cf4b2&data=eyJyZWNpcGllbnQiOiJmb29AZm9vLmNvbSJ9"
+    # => "https://api.keen.io/3.0/projects/12345/events/email_opens?api_key=abcde&data=eyJyZWNpcGllbnQiOiJmb29AZm9vLmNvbSJ9"
 
 To track email opens, simply add an image to your email template that points to this URL.
 
+### Changelog
+
+##### 0.4.4
++ Event collections are URI escaped to account for spaces.
++ User agent of API calls made more granular to aid in support cases.
++ Throw arguments error for nil event_collection and properties arguments.
+
+##### 0.4.3
++ Added beacon_url support
++ Add support for using em-synchrony with asynchronous calls
+
 ### Questions & Support
 
 If you have any questions, bugs, or suggestions, please

data/keen.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.email       = "josh@keen.io"
   s.homepage    = "https://github.com/keenlabs/keen-gem"
   s.summary     = "Keen IO API Client"
-  s.description = "Batch and send events to the Keen IO API. Supports asychronous requests."
+  s.description = "Send events and build analytics features into your Ruby applications."
 
   s.add_dependency "multi_json", "~> 1.0"
   s.add_dependency "jruby-openssl" if defined?(JRUBY_VERSION)

data/lib/keen/client.rb

@@ -3,6 +3,7 @@ require 'keen/version'
 require 'openssl'
 require 'multi_json'
 require 'base64'
+require 'uri'
 
 module Keen
   class Client
@@ -18,16 +19,21 @@ module Keen
         :verify_depth => 5,
         :ca_file => File.expand_path("../../../config/cacert.pem", __FILE__) },
       :api_async_http_options => {},
-      :api_headers => {
-        "Content-Type" => "application/json",
-        "User-Agent" => "keen-gem v#{Keen::VERSION}"
+      :api_headers => lambda { |sync_or_async|
+        user_agent = "keen-gem, v#{Keen::VERSION}, #{sync_or_async}"
+        user_agent += ", #{RUBY_VERSION}, #{RUBY_PLATFORM}, #{RUBY_PATCHLEVEL}"
+        if defined?(RUBY_ENGINE)
+          user_agent += ", #{RUBY_ENGINE}"
+        end
+        { "Content-Type" => "application/json",
+          "User-Agent" => user_agent }
       }
     }
 
-    def beacon_url(event_name, properties)
+    def beacon_url(event_collection, properties)
       json = MultiJson.encode(properties)
       data = [json].pack("m0").tr("+/", "-_").gsub("\n", "")
-      "https://#{api_host}/#{api_version}/projects/#{@project_id}/events/#{event_name}?api_key=#{@api_key}&data=#{data}"
+      "https://#{api_host}#{api_path(event_collection)}?api_key=#{@api_key}&data=#{data}"
     end
 
     def initialize(*args)
@@ -44,13 +50,15 @@ module Keen
         :project_id, :api_key)
     end
 
-    def publish(event_name, properties)
+    def publish(event_collection, properties)
       check_configuration!
+      check_event_data!(event_collection, properties)
+
       begin
         response = Keen::HTTP::Sync.new(
           api_host, api_port, api_sync_http_options).post(
-            :path => api_path(event_name),
-            :headers => api_headers_with_auth,
+            :path => api_path(event_collection),
+            :headers => api_headers_with_auth("sync"),
             :body => MultiJson.encode(properties))
       rescue Exception => http_error
         raise HttpError.new("Couldn't connect to Keen IO: #{http_error.message}", http_error)
@@ -58,15 +66,16 @@ module Keen
       process_response(response.code, response.body.chomp)
     end
 
-    def publish_async(event_name, properties)
+    def publish_async(event_collection, properties)
       check_configuration!
+      check_event_data!(event_collection, properties)
 
       deferrable = EventMachine::DefaultDeferrable.new
 
       http_client = Keen::HTTP::Async.new(api_host, api_port, api_async_http_options)
       http = http_client.post({
-        :path => api_path(event_name),
-        :headers => api_headers_with_auth,
+        :path => api_path(event_collection),
+        :headers => api_headers_with_auth("async"),
         :body => MultiJson.encode(properties)
       })
 
@@ -95,8 +104,8 @@ module Keen
     end
 
     # deprecated
-    def add_event(event_name, properties, options={})
-      self.publish(event_name, properties, options)
+    def add_event(event_collection, properties, options={})
+      self.publish(event_collection, properties, options)
     end
 
     private
@@ -117,12 +126,12 @@ module Keen
       end
     end
 
-    def api_path(collection)
-      "/#{api_version}/projects/#{project_id}/events/#{collection}"
+    def api_path(event_collection)
+      "/#{api_version}/projects/#{project_id}/events/#{URI.escape(event_collection)}"
     end
 
-    def api_headers_with_auth
-      api_headers.merge("Authorization" => api_key)
+    def api_headers_with_auth(sync_or_async)
+      api_headers(sync_or_async).merge("Authorization" => api_key)
     end
 
     def check_configuration!
@@ -130,8 +139,21 @@ module Keen
       raise ConfigurationError, "API Key must be set" unless api_key
     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
+    end
+
     def method_missing(_method, *args, &block)
-      CONFIG[_method.to_sym] || super
+      if config = CONFIG[_method.to_sym]
+        if config.is_a?(Proc)
+          config.call(*args)
+        else
+          config
+        end
+      else
+        super
+      end
     end
   end
 end

data/lib/keen/version.rb

@@ -1,3 +1,3 @@
 module Keen
-  VERSION = "0.4.3"
+  VERSION = "0.4.4"
 end

data/spec/integration/api_spec.rb

@@ -32,16 +32,8 @@ describe "Keen IO API" do
       }.to raise_error(Keen::AuthenticationError)
     end
 
-    it "should raise bad request if no JSON is supplied" do
-      expect {
-        Keen.publish(collection, nil)
-      }.to raise_error(Keen::BadRequestError)
-    end
-
-    it "should return not found for an invalid collection name" do
-      expect {
-        Keen.publish(nil, event_properties)
-      }.to raise_error(Keen::NotFoundError)
+    it "should success if a non-url-safe event collection is specified" do
+      Keen.publish("infinite possibilities", event_properties).should == api_success
     end
   end
 
@@ -58,6 +50,14 @@ describe "Keen IO API" do
         }
       end
 
+      it "should publish to non-url-safe collections" do
+        EM.run {
+          Keen.publish_async("foo bar", event_properties).callback { |response|
+            response.should == api_success
+            EM.stop
+          }
+        }
+      end
     end
   end
 end

data/spec/keen/client_spec.rb

@@ -56,7 +56,7 @@ describe Keen::Client do
       it "should post using the collection and properties" do
         stub_api(api_url(collection), 201, "")
         @client.publish(collection, event_properties)
-        expect_post(api_url(collection), event_properties, api_key)
+        expect_post(api_url(collection), event_properties, api_key, "sync")
       end
 
       it "should return the proper response" do
@@ -65,6 +65,24 @@ describe Keen::Client do
         @client.publish(collection, event_properties).should == api_response
       end
 
+      it "should raise an argument error if no event collection is specified" do
+        expect {
+          @client.publish(nil, {})
+        }.to raise_error(ArgumentError)
+      end
+
+      it "should raise an argument error if no properties are specified" do
+        expect {
+          @client.publish(collection, nil)
+        }.to raise_error(ArgumentError)
+      end
+
+      it "should url encode the event collection" do
+        stub_api(api_url("foo%20bar"), 201, "")
+        @client.publish("foo bar", event_properties)
+        expect_post(api_url("foo%20bar"), event_properties, api_key, "sync")
+      end
+
       it "should wrap exceptions" do
         stub_request(:post, api_url(collection)).to_timeout
         e = nil
@@ -94,19 +112,50 @@ describe Keen::Client do
           stub_api(api_url(collection), 201, api_success)
           EM.run {
             @client.publish_async(collection, event_properties).callback {
-              expect_post(api_url(collection), event_properties, api_key)
-              EM.stop
+              begin
+                expect_post(api_url(collection), event_properties, api_key, "async")
+              ensure
+                EM.stop
+              end
             }
           }
         end
 
+        it "should uri encode the event collection" do
+          stub_api(api_url("foo%20bar"), 201, api_success)
+          EM.run {
+            @client.publish_async("foo bar", event_properties).callback {
+              begin
+                expect_post(api_url("foo%20bar"), event_properties, api_key, "async")
+              ensure
+                EM.stop
+              end
+            }
+          }
+        end
+
+        it "should raise an argument error if no event collection is specified" do
+          expect {
+            @client.publish_async(nil, {})
+          }.to raise_error(ArgumentError)
+        end
+
+        it "should raise an argument error if no properties are specified" do
+          expect {
+            @client.publish_async(collection, nil)
+          }.to raise_error(ArgumentError)
+        end
+
         describe "deferrable callbacks" do
           it "should trigger callbacks" do
             stub_api(api_url(collection), 201, api_success)
             EM.run {
               @client.publish_async(collection, event_properties).callback { |response|
-                response.should == api_success
-                EM.stop
+                begin
+                  response.should == api_success
+                ensure
+                  EM.stop
+                end
               }
             }
           end
@@ -115,9 +164,12 @@ describe Keen::Client do
             stub_request(:post, api_url(collection)).to_timeout
             EM.run {
               @client.publish_async(collection, event_properties).errback { |error|
-                error.should_not be_nil
-                error.message.should == "Couldn't connect to Keen IO: WebMock timeout error"
-                EM.stop
+                begin
+                  error.should_not be_nil
+                  error.message.should == "Couldn't connect to Keen IO: WebMock timeout error"
+                ensure
+                  EM.stop
+                end
               }
             }
           end

data/spec/spec_helper.rb

@@ -17,11 +17,17 @@ module Keen::SpecHelpers
       :body => MultiJson.encode(json_body))
   end
 
-  def expect_post(url, event_properties, api_key)
+  def expect_post(url, event_properties, api_key, sync_or_async_ua)
+    user_agent = "keen-gem, v#{Keen::VERSION}, #{sync_or_async_ua}"
+    user_agent += ", #{RUBY_VERSION}, #{RUBY_PLATFORM}, #{RUBY_PATCHLEVEL}"
+    if defined?(RUBY_ENGINE)
+      user_agent += ", #{RUBY_ENGINE}"
+    end
+
     WebMock.should have_requested(:post, url).with(
       :body => MultiJson.encode(event_properties),
       :headers => { "Content-Type" => "application/json",
-                    "User-Agent" => "keen-gem v#{Keen::VERSION}",
+                    "User-Agent" => user_agent,
                     "Authorization" => api_key })
   end
 

data/spec/synchrony/synchrony_spec.rb

@@ -19,7 +19,7 @@ describe Keen::HTTP::Async do
         stub_api(api_url(collection), 201, api_success)
         EM.synchrony {
           @client.publish_async(collection, event_properties)
-          expect_post(api_url(collection), event_properties, api_key)
+          expect_post(api_url(collection), event_properties, api_key, "async")
           EM.stop
         }
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: keen
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.4
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-23 00:00:00.000000000 Z
+date: 2013-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -28,7 +28,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
-description: Batch and send events to the Keen IO API. Supports asychronous requests.
+description: Send events and build analytics features into your Ruby applications.
 email: josh@keen.io
 executables: []
 extensions: []