keen 0.4.4 → 0.5.0

checksums.yaml

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

data/Gemfile

@@ -1,4 +1,4 @@
-source :rubygems
+source "http://rubygems.org"
 
 gemspec
 

data/README.md

@@ -23,18 +23,17 @@ keen is tested with Ruby 1.8 and 1.9 on:
 
 ### Usage
 
-Before making any API calls, you must supply keen-gem with a Project ID and an API Key.
+Before making any API calls, you must supply keen-gem with a Project ID.
 (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
+The recommended way to do this is to set `KEEN_PROJECT_ID` in your
 environment. If you're using [foreman](http://ddollar.github.com/foreman/), add this to your `.env` file:
 
     KEEN_PROJECT_ID=your-project-id
-    KEEN_API_KEY=your-api-key
 
 When you deploy, make sure your production environment variables are also set. For example,
 set [config vars](https://devcenter.heroku.com/articles/config-vars) on Heroku. (We recommend this
-environment-based approach because it keeps sensitive credentials out of the codebase. If you can't do this, see the alternatives below.)
+environment-based approach because it keeps sensitive information out of the codebase. If you can't do this, see the alternatives below.)
 
 If your environment is set up property, `Keen` is ready go immediately. Publish an event like this:
 
@@ -82,14 +81,13 @@ to resume processing immediately.
 
 #### Authentication
 
-To configure keen-gem credentials in code, do as follows:
+To configure keen-gem 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 = Keen::Client.new(:project_id => 'your-project-id', :api_key => 'your-api-key')
+    keen = Keen::Client.new(:project_id => 'your-project-id')
 
 #### em-synchrony
 keen-gem can be used with [em-synchrony](https://github.com/igrigorik/em-synchrony).
@@ -105,15 +103,20 @@ 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')
 
     keen.beacon_url("sign_ups", :recipient => "foo@foo.com")
-    # => "https://api.keen.io/3.0/projects/12345/events/email_opens?api_key=abcde&data=eyJyZWNpcGllbnQiOiJmb29AZm9vLmNvbSJ9"
+    # => "https://api.keen.io/3.0/projects/12345/events/email_opens?data=eyJyZWNpcGllbnQiOiJmb29AZm9vLmNvbSJ9"
 
 To track email opens, simply add an image to your email template that points to this URL.
 
 ### Changelog
 
+##### 0.5.0
++ Removed API Key as a required field on Keen::Client. Only the Project ID is required to publish events.
++ You can continue to provide the API Key. Future features planned for this gem will require it. But for now,
+  there is no keen-gem functionality that uses it.
+
 ##### 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.

data/lib/keen/client.rb

@@ -33,7 +33,7 @@ module Keen
     def beacon_url(event_collection, properties)
       json = MultiJson.encode(properties)
       data = [json].pack("m0").tr("+/", "-_").gsub("\n", "")
-      "https://#{api_host}#{api_path(event_collection)}?api_key=#{@api_key}&data=#{data}"
+      "https://#{api_host}#{api_path(event_collection)}?data=#{data}"
     end
 
     def initialize(*args)
@@ -131,12 +131,11 @@ module Keen
     end
 
     def api_headers_with_auth(sync_or_async)
-      api_headers(sync_or_async).merge("Authorization" => api_key)
+      api_headers(sync_or_async)
     end
 
     def check_configuration!
       raise ConfigurationError, "Project ID must be set" unless project_id
-      raise ConfigurationError, "API Key must be set" unless api_key
     end
 
     def check_event_data!(event_collection, properties)

data/lib/keen/version.rb

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

data/spec/integration/api_spec.rb

@@ -2,7 +2,6 @@ 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" } }
@@ -17,21 +16,12 @@ describe "Keen IO API" do
 
   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")
+      client = Keen::Client.new(: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 success if a non-url-safe event collection is specified" do
       Keen.publish("infinite possibilities", event_properties).should == api_success
     end

data/spec/integration/spec_helper.rb

@@ -1,8 +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
+  unless ENV['KEEN_PROJECT_ID']
+    raise "Please set a KEEN_PROJECT_ID on the environment
            before running the integration specs."
   end
 end

data/spec/keen/client_spec.rb

@@ -34,29 +34,20 @@ describe Keen::Client do
               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)
+      @client = Keen::Client.new(:project_id => project_id)
     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, "sync")
+        expect_post(api_url(collection), event_properties, "sync")
       end
 
       it "should return the proper response" do
@@ -80,7 +71,7 @@ describe Keen::Client do
       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")
+        expect_post(api_url("foo%20bar"), event_properties, "sync")
       end
 
       it "should wrap exceptions" do
@@ -113,7 +104,7 @@ describe Keen::Client do
           EM.run {
             @client.publish_async(collection, event_properties).callback {
               begin
-                expect_post(api_url(collection), event_properties, api_key, "async")
+                expect_post(api_url(collection), event_properties, "async")
               ensure
                 EM.stop
               end
@@ -126,7 +117,7 @@ describe Keen::Client do
           EM.run {
             @client.publish_async("foo bar", event_properties).callback {
               begin
-                expect_post(api_url("foo%20bar"), event_properties, api_key, "async")
+                expect_post(api_url("foo%20bar"), event_properties, "async")
               ensure
                 EM.stop
               end
@@ -225,9 +216,9 @@ describe Keen::Client do
 
   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 = Keen::Client.new(project_id)
       client.beacon_url("sign_ups", { :name => "Bob" }).should ==
-        "https://api.keen.io/3.0/projects/12345/events/sign_ups?api_key=abcde&data=eyJuYW1lIjoiQm9iIn0="
+        "https://api.keen.io/3.0/projects/12345/events/sign_ups?data=eyJuYW1lIjoiQm9iIn0="
     end
   end
 end

data/spec/spec_helper.rb

@@ -17,7 +17,7 @@ module Keen::SpecHelpers
       :body => MultiJson.encode(json_body))
   end
 
-  def expect_post(url, event_properties, api_key, sync_or_async_ua)
+  def expect_post(url, event_properties, 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)
@@ -27,8 +27,7 @@ module Keen::SpecHelpers
     WebMock.should have_requested(:post, url).with(
       :body => MultiJson.encode(event_properties),
       :headers => { "Content-Type" => "application/json",
-                    "User-Agent" => user_agent,
-                    "Authorization" => api_key })
+                    "User-Agent" => user_agent })
   end
 
   def api_url(collection)

data/spec/synchrony/synchrony_spec.rb

@@ -2,16 +2,13 @@ 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)
+      @client = Keen::Client.new(:project_id => project_id)
     end
 
     describe "success" do
@@ -19,7 +16,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, "async")
+          expect_post(api_url(collection), event_properties, "async")
           EM.stop
         }
       end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: keen
 version: !ruby/object:Gem::Version
-  version: 0.4.4
-  prerelease: 
+  version: 0.5.0
 platform: ruby
 authors:
 - Kyle Wild
@@ -10,12 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-25 00:00:00.000000000 Z
+date: 2013-02-24 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
@@ -23,7 +21,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -58,27 +55,26 @@ 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: 1.8.23
+rubygems_version: 2.0.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Keen IO API Client
 test_files:
 - spec/integration/api_spec.rb