keen 0.5.0 → 0.6.0

data/spec/keen/client_spec.rb

@@ -3,9 +3,7 @@ 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 } }
+  let(:client) { Keen::Client.new(:project_id => project_id) }
 
   describe "#initialize" do
     context "deprecated" do
@@ -25,200 +23,36 @@ describe Keen::Client do
     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
-      end
-    end
-  end
+  describe "process_response" do
+    let (:body) { "{ \"wazzup\": 1 }" }
+    let (:process_response) { client.method(:process_response) }
 
-  describe "with a configured client" do
-    before do
-      @client = Keen::Client.new(:project_id => project_id)
+    it "should raise a bad request error for a 400" do
+      process_response.call(200, body).should == { "wazzup" => 1 }
     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, "sync")
-      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 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, "sync")
-      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
+    it "should raise a bad request error for a 400" do
+      expect {
+        process_response.call(400, body)
+      }.to raise_error(Keen::BadRequestError)
     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 {
-              begin
-                expect_post(api_url(collection), event_properties, "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, "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|
-                begin
-                  response.should == api_success
-                ensure
-                  EM.stop
-                end
-              }
-            }
-          end
-
-          it "should trigger errbacks" do
-            stub_request(:post, api_url(collection)).to_timeout
-            EM.run {
-              @client.publish_async(collection, event_properties).errback { |error|
-                begin
-                  error.should_not be_nil
-                  error.message.should == "Couldn't connect to Keen IO: WebMock timeout error"
-                ensure
-                  EM.stop
-                end
-              }
-            }
-          end
-        end
-      end
-
+    it "should raise a authentication error for a 401" do
+      expect {
+        process_response.call(401, body)
+      }.to raise_error(Keen::AuthenticationError)
     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
+    it "should raise a not found error for a 404" do
+      expect {
+        process_response.call(404, body)
+      }.to raise_error(Keen::NotFoundError)
     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
-
-  describe "beacon_url" do
-    it "should return a url with a base-64 encoded json param" do
-      client = Keen::Client.new(project_id)
-      client.beacon_url("sign_ups", { :name => "Bob" }).should ==
-        "https://api.keen.io/3.0/projects/12345/events/sign_ups?data=eyJuYW1lIjoiQm9iIn0="
+    it "should raise an http error otherwise" do
+      expect {
+        process_response.call(420, body)
+      }.to raise_error(Keen::HttpError)
     end
   end
 end

data/spec/spec_helper.rb

@@ -11,26 +11,41 @@ require 'em-http'
 require File.expand_path("../../lib/keen", __FILE__)
 
 module Keen::SpecHelpers
-  def stub_api(url, status, json_body)
-    stub_request(:post, url).to_return(
-      :status => status,
-      :body => MultiJson.encode(json_body))
+  def stub_keen_request(method, url, status, response_body)
+    stub_request(method, url).to_return(:status => status, :body => response_body)
   end
 
-  def expect_post(url, event_properties, sync_or_async_ua)
+  def stub_keen_post(url, status, response_body)
+    stub_keen_request(:post, url, status, MultiJson.encode(response_body))
+  end
+
+  def stub_keen_get(url, status, response_body)
+    stub_keen_request(:get, url, status, MultiJson.encode(response_body))
+  end
+
+  def expect_keen_request(method, url, body, 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),
+    WebMock.should have_requested(method, url).with(
+      :body => body,
       :headers => { "Content-Type" => "application/json",
                     "User-Agent" => user_agent })
+
+  end
+
+  def expect_keen_get(url, sync_or_async_ua)
+    expect_keen_request(:get, url, "", sync_or_async_ua)
+  end
+
+  def expect_keen_post(url, event_properties, sync_or_async_ua)
+    expect_keen_request(:post, url, MultiJson.encode(event_properties), sync_or_async_ua)
   end
 
-  def api_url(collection)
+  def api_event_resource_url(collection)
     "https://api.keen.io/3.0/projects/#{project_id}/events/#{collection}"
   end
 end

data/spec/synchrony/synchrony_spec.rb

@@ -13,16 +13,16 @@ describe Keen::HTTP::Async do
 
     describe "success" do
       it "should post the event data" do
-        stub_api(api_url(collection), 201, api_success)
+        stub_keen_post(api_event_resource_url(collection), 201, api_success)
         EM.synchrony {
           @client.publish_async(collection, event_properties)
-          expect_post(api_url(collection), event_properties, "async")
+          expect_keen_post(api_event_resource_url(collection), event_properties, "async")
           EM.stop
         }
       end
 
       it "should recieve the right response 'synchronously'" do
-        stub_api(api_url(collection), 201, api_success)
+        stub_keen_post(api_event_resource_url(collection), 201, api_success)
         EM.synchrony {
           @client.publish_async(collection, event_properties).should == api_success
           EM.stop
@@ -32,7 +32,7 @@ describe Keen::HTTP::Async do
 
     describe "failure" do
       it "should raise an exception" do
-        stub_request(:post, api_url(collection)).to_timeout
+        stub_request(:post, api_event_resource_url(collection)).to_timeout
         e = nil
         EM.synchrony {
           begin

metadata

@@ -1,7 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: keen
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
+  prerelease: 
 platform: ruby
 authors:
 - Kyle Wild
@@ -9,11 +10,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-24 00:00:00.000000000 Z
+date: 2013-04-05 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
@@ -21,6 +23,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -43,10 +46,14 @@ files:
 - keen.gemspec
 - lib/keen.rb
 - lib/keen/client.rb
+- lib/keen/client/publishing_methods.rb
+- lib/keen/client/querying_methods.rb
 - lib/keen/http.rb
 - lib/keen/version.rb
 - spec/integration/api_spec.rb
 - spec/integration/spec_helper.rb
+- spec/keen/client/publishing_methods_spec.rb
+- spec/keen/client/querying_methods_spec.rb
 - spec/keen/client_spec.rb
 - spec/keen/keen_spec.rb
 - spec/keen/spec_helper.rb
@@ -55,30 +62,33 @@ files:
 - spec/synchrony/synchrony_spec.rb
 homepage: https://github.com/keenlabs/keen-gem
 licenses: []
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 1.8.23
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Keen IO API Client
 test_files:
 - spec/integration/api_spec.rb
 - spec/integration/spec_helper.rb
+- spec/keen/client/publishing_methods_spec.rb
+- spec/keen/client/querying_methods_spec.rb
 - spec/keen/client_spec.rb
 - spec/keen/keen_spec.rb
 - spec/keen/spec_helper.rb

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: b5661cff5eaa3017d59716166dc7b265519b95c9
-  data.tar.gz: 4644e32d886566a16b91bf3693bee6de1ba46c65
-SHA512:
-  metadata.gz: 7eeb6df1b69794c412f914a770da11addb9cbbddef4dfc17cab0cf96a27b44a9856c9eec5d654464c8f43d2c697510ba6386d16e203e954abb24bc81d0fc2f6f
-  data.tar.gz: 14e3bbf44cdc20227605e4452de88e4097f7d9081ab262ecd5fc5a2ce5c2d3072ead63ed1f25994953736eb0f74b0911f3076529ee46c1260223b0e7bdd962f9