keen 0.4.2 → 0.4.3

data/.gitignore

@@ -3,3 +3,4 @@ Gemfile.lock
 tmp
 .env
 log
+*.gem

data/.travis.yml

@@ -8,10 +8,16 @@ rvm:
   - rbx-19mode
 
 env:
-  global:
-    - KEEN_API_KEY=f806128f31c349fda124b62d1f4cf4b2
-    - KEEN_PROJECT_ID=50e5ffa6897a2c319b000000
+  - PATTERN=keen
+  - PATTERN=integration KEEN_API_KEY=f806128f31c349fda124b62d1f4cf4b2 KEEN_PROJECT_ID=50e5ffa6897a2c319b000000
+  - PATTERN=synchrony
+
+matrix:
+  exclude:
+    - rvm: 1.8.7
+      env: PATTERN=synchrony
+    - rvm: jruby-19mode
+      env: PATTERN=synchrony
 
 script:
-  - bundle exec rake spec
-  - bundle exec rake integration
+  - bundle exec rake pattern

data/Gemfile

@@ -6,6 +6,7 @@ group :development, :test do
   gem 'rake'
   gem 'rspec'
   gem 'em-http-request'
+  gem 'em-synchrony', :require => false
   gem 'webmock'
 end
 

data/Guardfile

@@ -14,3 +14,11 @@ group :integration do
     watch(%r{^spec/integration/.+_spec\.rb$})
   end
 end
+
+group :synchrony do
+  guard 'rspec', :spec_paths => "spec/synchrony" do
+    watch('spec/spec_helper.rb')  { "spec" }
+    watch('spec/synchrony/spec_helper.rb')  { "spec" }
+    watch(%r{^spec/synchrony/.+_spec\.rb$})
+  end
+end

data/README.md

@@ -23,7 +23,7 @@ keen is tested with Ruby 1.8 and 1.9 on:
 
 ### Usage
 
-Before making any API calls, you must supply the keen gem with a Project ID and an API Key.
+Before making any API calls, you must supply keen-gem with a Project ID and an API Key.
 (If you need a Keen IO account, [sign up here](https://keen.io/) - it's free.)
 
 The recommended way to do this is to set `KEEN_PROJECT_ID` and `KEEN_API_KEY` in your
@@ -80,22 +80,40 @@ to resume processing immediately.
 
 ### Other code examples
 
-##### Authentication
+#### Authentication
 
-To configure the keen gem credentials in code, do as follows:
+To configure keen-gem credentials in code, do as follows:
 
     Keen.project_id = 'your-project-id'
     Keen.api_key = 'your-api-key'
 
 You can also configure individual client instances as follows:
 
-    keen = new 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')
 
-##### On keen.io
+#### em-synchrony
+keen-gem can be used with [em-synchrony](https://github.com/igrigorik/em-synchrony).
+If you call `publish_async` and `EM::Synchrony` is defined the method will return the response
+directly. (It does not return the deferrable on which to register callbacks.) Likewise, it will raise
+exceptions 'synchronously' should they happen.
 
-For more information and examples visit the
-Keen IO [Ruby Usage Guide](https://keen.io/docs/clients/ruby/usage-guide/).
+#### Beacon URL's
+
+It's possible to publish events to your Keen IO project using the HTTP GET method.
+This is useful for situations like tracking email opens using [image beacons](http://en.wikipedia.org/wiki/Web_bug).
+
+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.beacon_url("sign_ups", :recipient => "foo@foo.com")
+    # => "https://api.keen.io/3.0/projects/50e5ffa6897a2c319b000000/events/ \
+          email_opens?api_key=f806128f31c349fda124b62d1f4cf4b2&data=eyJyZWNpcGllbnQiOiJmb29AZm9vLmNvbSJ9"
+
+To track email opens, simply add an image to your email template that points to this URL.
 
 ### Questions & Support
 
@@ -103,3 +121,6 @@ If you have any questions, bugs, or suggestions, please
 report them via Github Issues. Or, come chat with us anytime
 at [users.keen.io](http://users.keen.io). We'd love to hear your feedback and ideas!
 
+### Contributing
+keen-gem is an open source project and we welcome your contributions.
+Fire away with issues and pull requests!

data/Rakefile

@@ -11,5 +11,15 @@ RSpec::Core::RakeTask.new(:integration) do |t|
   t.pattern = "spec/integration/**/*_spec.rb"
 end
 
+desc "Run Rspec synchrony tests"
+RSpec::Core::RakeTask.new(:synchrony) do |t|
+  t.pattern = "spec/synchrony/**/*_spec.rb"
+end
+
+desc "Run Rspec pattern"
+RSpec::Core::RakeTask.new(:pattern) do |t|
+  t.pattern = "spec/#{ENV['PATTERN']}/**/*_spec.rb"
+end
+
 task :default => :spec
 task :test => [:spec]

data/lib/keen.rb

@@ -1,6 +1,5 @@
 require 'logger'
 require 'forwardable'
-require 'multi_json'
 
 require 'keen/client'
 
@@ -23,7 +22,8 @@ module Keen
     extend Forwardable
 
     def_delegators :default_client, :project_id, :api_key,
-                   :project_id=, :api_key=, :publish, :publish_async
+                   :project_id=, :api_key=, :publish, :publish_async,
+                   :beacon_url
 
     attr_writer :logger
 

data/lib/keen/client.rb

@@ -1,5 +1,8 @@
-require 'keen/version'
 require 'keen/http'
+require 'keen/version'
+require 'openssl'
+require 'multi_json'
+require 'base64'
 
 module Keen
   class Client
@@ -8,6 +11,7 @@ module Keen
     CONFIG = {
       :api_host => "api.keen.io",
       :api_port => 443,
+      :api_version => "3.0",
       :api_sync_http_options => {
         :use_ssl => true,
         :verify_mode => OpenSSL::SSL::VERIFY_PEER,
@@ -20,6 +24,12 @@ module Keen
       }
     }
 
+    def beacon_url(event_name, 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}"
+    end
+
     def initialize(*args)
       options = args[0]
       unless options.is_a?(Hash)
@@ -59,20 +69,29 @@ module Keen
         :headers => api_headers_with_auth,
         :body => MultiJson.encode(properties)
       })
-      http.callback {
-        begin
-          response = process_response(http.response_header.status, http.response.chomp)
-          deferrable.succeed(response)
-        rescue Exception => e
-          deferrable.fail(e)
-        end
-      }
-      http.errback {
-        Keen.logger.warn("Couldn't connect to Keen IO: #{http.error}")
-        deferrable.fail(Error.new("Couldn't connect to Keen IO: #{http.error}"))
-      }
 
-      deferrable
+      if defined?(EM::Synchrony)
+        if http.error
+          Keen.logger.warn("Couldn't connect to Keen IO: #{http.error}")
+          raise HttpError.new("Couldn't connect to Keen IO: #{http.error}")
+        else
+          process_response(http.response_header.status, http.response.chomp)
+        end
+      else
+        http.callback {
+          begin
+            response = process_response(http.response_header.status, http.response.chomp)
+            deferrable.succeed(response)
+          rescue Exception => e
+            deferrable.fail(e)
+          end
+        }
+        http.errback {
+          Keen.logger.warn("Couldn't connect to Keen IO: #{http.error}")
+          deferrable.fail(Error.new("Couldn't connect to Keen IO: #{http.error}"))
+        }
+        deferrable
+      end
     end
 
     # deprecated
@@ -99,7 +118,7 @@ module Keen
     end
 
     def api_path(collection)
-      "/3.0/projects/#{project_id}/events/#{collection}"
+      "/#{api_version}/projects/#{project_id}/events/#{collection}"
     end
 
     def api_headers_with_auth

data/lib/keen/version.rb

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

data/spec/keen/client_spec.rb

@@ -7,24 +7,6 @@ describe Keen::Client do
   let(:event_properties) { { "name" => "Bob" } }
   let(:api_success) { { "created" => true } }
 
-  def stub_api(url, status, json_body)
-    stub_request(:post, url).to_return(
-      :status => status,
-      :body => MultiJson.encode(json_body))
-  end
-
-  def expect_post(url, event_properties, api_key)
-    WebMock.should have_requested(:post, url).with(
-      :body => MultiJson.encode(event_properties),
-      :headers => { "Content-Type" => "application/json",
-                    "User-Agent" => "keen-gem v#{Keen::VERSION}",
-                    "Authorization" => api_key })
-  end
-
-  def api_url(collection)
-    "https://api.keen.io/3.0/projects/#{project_id}/events/#{collection}"
-  end
-
   describe "#initialize" do
     context "deprecated" do
       it "should allow created via project_id and api_key args" do
@@ -188,4 +170,12 @@ describe Keen::Client do
       end
     end
   end
+
+  describe "beacon_url" do
+    it "should return a url with a base-64 encoded json param" do
+      client = Keen::Client.new(project_id, api_key)
+      client.beacon_url("sign_ups", { :name => "Bob" }).should ==
+        "https://api.keen.io/3.0/projects/12345/events/sign_ups?api_key=abcde&data=eyJuYW1lIjoiQm9iIn0="
+    end
+  end
 end

data/spec/keen/keen_spec.rb

@@ -4,6 +4,7 @@ describe Keen do
   describe "default client" do
     describe "configuring from the environment" do
       before do
+        Keen.instance_variable_set(:@default_client, nil)
         ENV["KEEN_PROJECT_ID"] = "12345"
         ENV["KEEN_API_KEY"] = "abcde"
       end
@@ -17,11 +18,6 @@ describe Keen do
       it "should set an api key from the environment" do
         client.api_key.should == "abcde"
       end
-
-      after do
-        ENV["KEEN_PROJECT_ID"] = nil
-        ENV["KEEN_API_KEY"] = nil
-      end
     end
   end
 

data/spec/spec_helper.rb

@@ -10,7 +10,27 @@ require 'em-http'
 
 require File.expand_path("../../lib/keen", __FILE__)
 
-RSpec.configure do |config|
-  config.before(:all) do
+module Keen::SpecHelpers
+  def stub_api(url, status, json_body)
+    stub_request(:post, url).to_return(
+      :status => status,
+      :body => MultiJson.encode(json_body))
+  end
+
+  def expect_post(url, event_properties, api_key)
+    WebMock.should have_requested(:post, url).with(
+      :body => MultiJson.encode(event_properties),
+      :headers => { "Content-Type" => "application/json",
+                    "User-Agent" => "keen-gem v#{Keen::VERSION}",
+                    "Authorization" => api_key })
+  end
+
+  def api_url(collection)
+    "https://api.keen.io/3.0/projects/#{project_id}/events/#{collection}"
   end
 end
+
+RSpec.configure do |config|
+  config.include(Keen::SpecHelpers)
+end
+

data/spec/synchrony/spec_helper.rb

@@ -0,0 +1,7 @@
+require File.expand_path("../../spec_helper", __FILE__)
+
+require 'em-synchrony'
+require 'em-synchrony/em-http'
+
+require 'webmock/rspec'
+

data/spec/synchrony/synchrony_spec.rb

@@ -0,0 +1,53 @@
+require File.expand_path("../spec_helper", __FILE__)
+
+describe Keen::HTTP::Async do
+  let(:project_id) { "12345" }
+  let(:api_key) { "abcde" }
+  let(:collection) { "users" }
+  let(:event_properties) { { "name" => "Bob" } }
+  let(:api_success) { { "created" => true } }
+
+  describe "synchrony" do
+    before do
+      @client = Keen::Client.new(
+        :project_id => project_id,
+        :api_key => api_key)
+    end
+
+    describe "success" do
+      it "should post the event data" 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)
+          EM.stop
+        }
+      end
+
+      it "should recieve the right response 'synchronously'" do
+        stub_api(api_url(collection), 201, api_success)
+        EM.synchrony {
+          @client.publish_async(collection, event_properties).should == api_success
+          EM.stop
+        }
+      end
+    end
+
+    describe "failure" do
+      it "should raise an exception" do
+        stub_request(:post, api_url(collection)).to_timeout
+        e = nil
+        EM.synchrony {
+          begin
+            @client.publish_async(collection, event_properties).should == api_success
+          rescue Exception => exception
+            e = exception
+          end
+          e.class.should == Keen::HttpError
+          e.message.should == "Couldn't connect to Keen IO: 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.4.2
+  version: 0.4.3
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-16 00:00:00.000000000 Z
+date: 2013-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -54,6 +54,8 @@ files:
 - spec/keen/keen_spec.rb
 - spec/keen/spec_helper.rb
 - spec/spec_helper.rb
+- spec/synchrony/spec_helper.rb
+- spec/synchrony/synchrony_spec.rb
 homepage: https://github.com/keenlabs/keen-gem
 licenses: []
 post_install_message: 
@@ -85,3 +87,5 @@ test_files:
 - spec/keen/keen_spec.rb
 - spec/keen/spec_helper.rb
 - spec/spec_helper.rb
+- spec/synchrony/spec_helper.rb
+- spec/synchrony/synchrony_spec.rb