keen 0.3.0 → 0.4.1

data/lib/keen/http.rb

@@ -0,0 +1,40 @@
+module Keen
+  module HTTP
+    class Sync
+      def initialize(host, port, options={})
+        require 'net/https'
+        @http = Net::HTTP.new(host, port)
+        options.each_pair { |key, value| @http.send "#{key}=", value }
+      end
+
+      def post(options)
+        path, headers, body = options.values_at(
+          :path, :headers, :body)
+        @http.post(path, body, headers)
+      end
+    end
+
+    class Async
+      def initialize(host, port, options={})
+        if defined?(EventMachine) && EventMachine.reactor_running?
+          require 'em-http-request'
+        else
+          raise Error, "An EventMachine loop must be running to use publish_async calls"
+        end
+
+        @host, @port, @http_options = host, port, options
+      end
+
+      def post(options)
+        path, headers, body = options.values_at(
+          :path, :headers, :body)
+        uri = "https://#{@host}:#{@port}#{path}"
+        http_client = EventMachine::HttpRequest.new(uri, @http_options)
+        http_client.post(
+          :body => body,
+          :head => headers
+        )
+      end
+    end
+  end
+end

data/lib/keen/version.rb

@@ -1,19 +1,3 @@
-require 'keen'
-require 'yaml'
-
-# parse VERSION.yml
-yaml_path = File.join(File.expand_path(File.dirname(__FILE__)), '..', '..', 'VERSION.yml')
-version_info = File.open( yaml_path ) { |file| YAML::load( file ) }
-
-# build the version string
-version_string = ""
-version_string += "#{version_info[:major]}"
-version_string += "#{version_info[:minor]}"
-version_string += "#{version_info[:patch]}"
-
-if version_info[:build]
-  version_string += "#{version_info[:build]}"
+module Keen
+  VERSION = "0.4.1"
 end
-
-# set the constant
-Keen::VERSION = version_string

data/spec/integration/api_spec.rb

@@ -0,0 +1,63 @@
+require File.expand_path("../spec_helper", __FILE__)
+
+describe "Keen IO API" do
+  let(:project_id) { ENV['KEEN_PROJECT_ID'] }
+  let(:api_key) { ENV['KEEN_API_KEY'] }
+
+  let(:collection) { "users" }
+  let(:event_properties) { { "name" => "Bob" } }
+  let(:api_success) { { "created" => true } }
+
+  describe "success" do
+
+    it "should return a created status for a valid post" do
+      Keen.publish(collection, event_properties).should == api_success
+    end
+  end
+
+  describe "failure" do
+    it "should raise a not found error if an invalid project id" do
+      client = Keen::Client.new(
+        :api_key => api_key, :project_id => "riker")
+      expect {
+        client.publish(collection, event_properties)
+      }.to raise_error(Keen::NotFoundError)
+    end
+
+    it "should raise authentication error if invalid API Key" do
+      client = Keen::Client.new(
+        :api_key => "wrong", :project_id => project_id)
+      expect {
+        client.publish(collection, event_properties)
+      }.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)
+    end
+  end
+
+  describe "async" do
+    # no TLS support in EventMachine on jRuby
+    unless defined?(JRUBY_VERSION)
+
+      it "should publish the event and trigger callbacks" do
+        EM.run {
+          Keen.publish_async(collection, event_properties).callback { |response|
+            response.should == api_success
+            EM.stop
+          }
+        }
+      end
+
+    end
+  end
+end

data/spec/integration/spec_helper.rb

@@ -0,0 +1,8 @@
+require File.expand_path("../../spec_helper", __FILE__)
+
+RSpec.configure do |config|
+  unless ENV['KEEN_PROJECT_ID'] && ENV['KEEN_API_KEY']
+    raise "Please set a KEEN_PROJECT_ID and KEEN_API_KEY on the environment
+           before running the integration specs."
+  end
+end

data/spec/keen/client_spec.rb

@@ -0,0 +1,191 @@
+require File.expand_path("../spec_helper", __FILE__)
+
+describe Keen::Client do
+  let(:project_id) { "12345" }
+  let(:api_key) { "abcde" }
+  let(:collection) { "users" }
+  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
+        client = Keen::Client.new(project_id, api_key)
+        client.api_key.should == api_key
+        client.project_id.should == project_id
+      end
+    end
+
+    it "should initialize with options" do
+      client = Keen::Client.new(
+        :project_id => project_id,
+        :api_key => api_key)
+      client.api_key.should == api_key
+      client.project_id.should == project_id
+    end
+  end
+
+  describe "with a unconfigured client" do
+    [:publish, :publish_async].each do |_method|
+      describe "##{_method}" do
+        it "should raise an exception if no project_id" do
+          expect {
+            Keen::Client.new(:api_key => api_key).
+              send(_method, collection, event_properties)
+          }.to raise_error(Keen::ConfigurationError)
+        end
+
+        it "should raise an exception if no api_key" do
+          expect {
+            Keen::Client.new(:project_id => project_id).
+              send(_method, collection, event_properties)
+          }.to raise_error(Keen::ConfigurationError)
+        end
+      end
+    end
+  end
+
+  describe "with a configured client" do
+    before do
+      @client = Keen::Client.new(
+        :project_id => project_id,
+        :api_key => api_key)
+    end
+
+    describe "#publish" 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)
+      end
+
+      it "should return the proper response" do
+        api_response = { "created" => true }
+        stub_api(api_url(collection), 201, api_response)
+        @client.publish(collection, event_properties).should == api_response
+      end
+
+      it "should wrap exceptions" do
+        stub_request(:post, api_url(collection)).to_timeout
+        e = nil
+        begin
+          @client.publish(collection, event_properties)
+        rescue Exception => exception
+          e = exception
+        end
+
+        e.class.should == Keen::HttpError
+        e.original_error.class.should == Timeout::Error
+        e.message.should == "Couldn't connect to Keen IO: execution expired"
+      end
+    end
+
+    describe "#publish_async" do
+
+      # no TLS support in EventMachine on jRuby
+      unless defined?(JRUBY_VERSION)
+        it "should require a running event loop" do
+          expect {
+            @client.publish_async(collection, event_properties)
+          }.to raise_error(Keen::Error)
+        end
+
+        it "should post the event data" 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
+            }
+          }
+        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
+              }
+            }
+          end
+
+          it "should trigger errbacks" 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
+              }
+            }
+          end
+        end
+      end
+
+    end
+
+    describe "response handling" do
+      def stub_status_and_publish(code, api_response=nil)
+        stub_api(api_url(collection), code, api_response)
+        @client.publish(collection, event_properties)
+      end
+
+      it "should return the json body for a 200-201" do
+        api_response = { "created" => "true" }
+        stub_status_and_publish(200, api_response).should == api_response
+        stub_status_and_publish(201, api_response).should == api_response
+      end
+
+      it "should raise a bad request error for a 400" do
+        expect {
+          stub_status_and_publish(400)
+        }.to raise_error(Keen::BadRequestError)
+      end
+
+      it "should raise a authentication error for a 401" do
+        expect {
+          stub_status_and_publish(401)
+        }.to raise_error(Keen::AuthenticationError)
+      end
+
+      it "should raise a not found error for a 404" do
+        expect {
+          stub_status_and_publish(404)
+        }.to raise_error(Keen::NotFoundError)
+      end
+
+      it "should raise an http error otherwise" do
+        expect {
+          stub_status_and_publish(420)
+        }.to raise_error(Keen::HttpError)
+      end
+    end
+
+    describe "#add_event" do
+      it "should alias to publish" do
+        @client.should_receive(:publish).with("users", {:a => 1}, {:b => 2})
+        @client.add_event("users", {:a => 1}, {:b => 2})
+      end
+    end
+  end
+end

data/spec/keen/keen_spec.rb

@@ -0,0 +1,61 @@
+require File.expand_path("../spec_helper", __FILE__)
+
+describe Keen do
+  describe "default client" do
+    describe "configuring from the environment" do
+      before do
+        ENV["KEEN_PROJECT_ID"] = "12345"
+        ENV["KEEN_API_KEY"] = "abcde"
+      end
+
+      let(:client) { Keen.send(:default_client) }
+
+      it "should set a project id from the environment" do
+        client.project_id.should == "12345"
+      end
+
+      it "should set a project id 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
+
+  describe "forwardable" do
+    before do
+      @default_client = double("client")
+      Keen.stub(:default_client).and_return(@default_client)
+    end
+
+    [:project_id, :api_key].each do |_method|
+      it "should forward the #{_method} method" do
+        @default_client.should_receive(_method)
+        Keen.send(_method)
+      end
+    end
+
+    [:project_id=, :api_key=].each do |_method|
+      it "should forward the #{_method} method" do
+        @default_client.should_receive(_method).with("12345")
+        Keen.send(_method, "12345")
+      end
+    end
+
+    [:publish, :publish_async].each do |_method|
+      it "should forward the #{_method} method" do
+        @default_client.should_receive(_method).with("users", {})
+        Keen.send(_method, "users", {})
+      end
+    end
+  end
+
+  describe "logger" do
+    it "should be set to info" do
+      Keen.logger.level.should == Logger::INFO
+    end
+  end
+end

data/spec/keen/spec_helper.rb

@@ -0,0 +1,10 @@
+require File.expand_path("../../spec_helper", __FILE__)
+
+require 'webmock/rspec'
+
+RSpec.configure do |config|
+  config.before(:each) do
+    WebMock.disable_net_connect!
+    WebMock.reset!
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'Use of Bundler is recommended'
+end
+
+require 'rspec'
+require 'net/https'
+require 'em-http'
+
+require File.expand_path("../../lib/keen", __FILE__)
+
+RSpec.configure do |config|
+  config.before(:all) do
+  end
+end

metadata

@@ -1,153 +1,87 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: keen
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.4.1
   prerelease: 
-  version: 0.3.0
 platform: ruby
-authors: 
-- dorkitude
+authors:
+- Kyle Wild
+- Josh Dzielak
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-11-26 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: json
-  requirement: &id001 !ruby/object:Gem::Requirement 
+date: 2013-01-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.6.5
-  type: :runtime
-  prerelease: false
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: shoulda
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-  type: :development
-  prerelease: false
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rdoc
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "3.12"
-  type: :development
-  prerelease: false
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: bundler
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.1.4
-  type: :development
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
   prerelease: false
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: jeweler
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: 1.8.3
-  type: :development
-  prerelease: false
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: rspec
-  requirement: &id006 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 2.9.0
-  type: :development
-  prerelease: false
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  name: cucumber
-  requirement: &id007 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.2.1
-  type: :development
-  prerelease: false
-  version_requirements: *id007
-description: See the github repo or examples.rb for usage information.
-email: kyle@keen.io
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Batch and send events to the Keen IO API. Supports asychronous requests.
+email: josh@keen.io
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- LICENSE.txt
-- README.md
-files: 
-- .rvmrc
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
-- LICENSE.txt
+- Guardfile
+- LICENSE
 - README.md
 - Rakefile
-- VERSION.yml
-- conf/cacert.pem
-- examples.rb
-- features/add_event.feature
-- features/step_definitions/keen_steps.rb
-- features/support/before_and_after.rb
-- features/support/env.rb
+- config/cacert.pem
 - keen.gemspec
-- keen.gemspec.old
 - lib/keen.rb
 - lib/keen/client.rb
-- lib/keen/event.rb
-- lib/keen/keys.rb
-- lib/keen/utils.rb
+- lib/keen/http.rb
 - lib/keen/version.rb
-homepage: http://github.com/dorkitude/keen
-licenses: 
-- MIT
+- spec/integration/api_spec.rb
+- spec/integration/spec_helper.rb
+- spec/keen/client_spec.rb
+- spec/keen/keen_spec.rb
+- spec/keen/spec_helper.rb
+- spec/spec_helper.rb
+homepage: https://github.com/keenlabs/keen-gem
+licenses: []
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: -1792663848985586478
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.19
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: A library for batching and sending arbitrary events to the Keen API at http://keen.io
-test_files: []
-
+summary: Keen IO API Client
+test_files:
+- spec/integration/api_spec.rb
+- spec/integration/spec_helper.rb
+- spec/keen/client_spec.rb
+- spec/keen/keen_spec.rb
+- spec/keen/spec_helper.rb
+- spec/spec_helper.rb