keen 0.7.8 → 0.8.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c3cf3ae16e58f3c518d668690727dee634e620ec
+  data.tar.gz: bb8e8adde18854b35095b90017dc468900e28201
+SHA512:
+  metadata.gz: 097d04970b5ce6c0779b96655cd29aa747d1df5eeb4506dfc4763546fae08c7bd3b6f7ed48f5b4f2dcbd3a4caeb433778fda7bfa67d5871c9f9d3c2ffa4d48e2
+  data.tar.gz: 732360e3dd2873579493eb08f407055929cc9d27a5285ef8d592dcfd94f69999d66f4d62787a0557b96b485409bdb2cb35a5233ff270b81b73e057c0e1247cdf

data/.travis.yml

@@ -6,13 +6,19 @@ rvm:
   - 1.9.3
   - 2.0.0
   - jruby-19mode
-  - rbx-19mode
+  - rbx
 
 env:
   - PATTERN=keen
-  - PATTERN=integration KEEN_MASTER_KEY=f806128f31c349fda124b62d1f4cf4b2 KEEN_WRITE_KEY=f806128f31c349fda124b62d1f4cf4b2 KEEN_READ_KEY=f806128f31c349fda124b62d1f4cf4b2 KEEN_PROJECT_ID=50e5ffa6897a2c319b000000
+  #- PATTERN=integration KEEN_MASTER_KEY=f806128f31c349fda124b62d1f4cf4b2 KEEN_WRITE_KEY=f806128f31c349fda124b62d1f4cf4b2 KEEN_READ_KEY=f806128f31c349fda124b62d1f4cf4b2 KEEN_PROJECT_ID=50e5ffa6897a2c319b000000
   - PATTERN=synchrony
 
+before_install:
+  - gem update bundler
+  - bundle --version
+  - gem update --system 2.1.11
+  - gem --version
+
 matrix:
   exclude:
     - rvm: 1.8.7

data/Guardfile

@@ -1,5 +1,5 @@
 group :unit do
-  guard 'rspec', :spec_paths => "spec/keen" do
+  guard 'rspec', :spec_paths => ["spec/keen"] do
     watch('spec/spec_helper.rb')  { "spec" }
     watch('spec/keen/spec_helper.rb')  { "spec" }
     watch(%r{^spec/keen/.+_spec\.rb$})
@@ -8,7 +8,7 @@ group :unit do
 end
 
 group :integration do
-  guard 'rspec', :spec_paths => "spec/integration" do
+  guard 'rspec', :spec_paths => ["spec/integration"] do
     watch('spec/spec_helper.rb')  { "spec" }
     watch('spec/integration/spec_helper.rb')  { "spec" }
     watch(%r{^spec/integration/.+_spec\.rb$})
@@ -16,7 +16,7 @@ group :integration do
 end
 
 group :synchrony do
-  guard 'rspec', :spec_paths => "spec/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$})

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Keen Labs
+Copyright (c) 2012-2014 Keen Labs
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -40,7 +40,7 @@ If you're using [foreman](http://ddollar.github.com/foreman/), add this to your
     KEEN_WRITE_KEY=yyyyyyyyyyyyyyy
     KEEN_READ_KEY=zzzzzzzzzzzzzzz
 
-If not, make to to export the variable into your shell or put it before the command you use to start your server.
+If not, make a script to export the variables into your shell or put it before the command you use to start your server.
 
 When you deploy, make sure your production environment variables are set. For example,
 set [config vars](https://devcenter.heroku.com/articles/config-vars) on Heroku. (We recommend this
@@ -89,7 +89,7 @@ Thread.new { EventMachine.run }
 The best place for this is in an initializer, or anywhere that runs when your app boots up.
 Here's a useful blog article that explains more about this approach - [EventMachine and Passenger](http://railstips.org/blog/archives/2011/05/04/eventmachine-and-passenger/).
 
-And here's a gist that shows an example of [Eventmachine with Unicorn](https://gist.github.com/jonkgrimes/5103321). Thanks to [jonkgrimes](https://github.com/jonkgrimes) for sharing this with us!
+And here's an example repository that shows an example of [Eventmachine with Unicorn](https://github.com/dzello/em-unicorn/blob/master/unicorn.rb), specifically the Unicorn config for starting and stopping EventMachine after forking.
 
 Now, in your code, replace `publish` with `publish_async`. Bind callbacks if you require them.
 
@@ -154,7 +154,7 @@ Keen.delete(:signups)  # => true
 
 # Or just delete an event corresponding to a particular user
 Keen.delete(:signups, filters: [{
-  property_name: 'username', operator: 'eq', property_value: "Bob"
+  :property_name => 'username', ;operator => 'eq', :property_value => "Bob"
 }])  # => true
 ```
 
@@ -207,7 +207,7 @@ If you call `publish_async` and `EM::Synchrony` is defined the method will retur
 directly. (It does not return the deferrable on which to register callbacks.) Likewise, it will raise
 exceptions 'synchronously' should they happen.
 
-#### Beacon URL's
+#### Beacon URLs
 
 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).
@@ -222,10 +222,10 @@ Keen.beacon_url("sign_ups", :recipient => "foo@foo.com")
   # => "https://api.keen.io/3.0/projects/xxxxxx/events/email_opens?api_key=yyyyyy&data=eyJyZWNpcGllbnQiOiJmb29AZm9vLmNvbSJ9"
 ```
 
-To track email opens, simply add an image to your email template that points to this URL.
+To track email opens, simply add an image to your email template that points to this URL. For further information on how to do this, see the [image beacon documentation](https://keen.io/docs/data-collection/image-beacon/).
 
-#### Redirect URL's
-Redirect URL's are just like image beacon URL's with the addition of a `redirect` query parameter. This parameter is used
+#### Redirect URLs
+Redirect URLs are just like image beacon URLs with the addition of a `redirect` query parameter. This parameter is used
 to issue a redirect to a certain URL after an event is recorded.
 
 ```
@@ -233,10 +233,48 @@ Keen.redirect_url("sign_ups", { :recipient => "foo@foo.com" }, "http://foo.com")
   # => "https://api.keen.io/3.0/projects/xxxxxx/events/email_opens?api_key=yyyyyy&data=eyJyZWNpcGllbnQiOiJmb29AZm9vLmNvbSJ9&redirect=http://foo.com"
 ```
 
-This is helpful for tracking email clickthroughs.
+This is helpful for tracking email clickthroughs. See the [redirect documentation](https://keen.io/docs/data-collection/redirect/) for further information.
+
+#### Generating scoped keys
+
+A [scoped key](https://keen.io/docs/security/#scoped-key) is a string, generated with your API Key, that represents some encrypted authentication and query options.
+Use them to control what data queries have access to.
+
+``` ruby
+# "my-api-key" should be your MASTER API key
+scoped_key = Keen::ScopedKey.new("my-api-key", { "filters" => [{
+  "property_name" => "accountId",
+  "operator" => "eq",
+  "property_value" => "123456"
+}]}).encrypt! # "4d1982fe601b359a5cab7ac7845d3bf27026936cdbf8ce0ab4ebcb6930d6cf7f139e..."
+```
+
+You can use the scoped key created in Ruby for API requests from any client. Scoped keys are commonly used in JavaScript, where credentials are visible and need to be protected.
+
+### Troubleshooting
+
+##### EventMachine
+
+If you run into `Keen::Error: Keen IO Exception: An EventMachine loop must be running to use publish_async calls` or 
+`Uncaught RuntimeError: eventmachine not initialized: evma_set_pending_connect_timeout`, this means that the EventMachine
+loop has died. This can happen for a variety of reasons, and every app is different. [Issue #22](https://github.com/keenlabs/keen-gem/issues/22) shows how to add some extra protection to avoid this situation.
+
+##### publish_async in a script or worker
+
+If you write a script that uses `publish_async`, you need to keep the script alive long enough for the call(s) to complete.
+EventMachine itself won't do this because it runs in a different thread. Here's an [example gist](https://gist.github.com/dzello/7472823) that shows how to exit the process after the event has been recorded.
 
 ### Changelog
 
+##### 0.8.0
++ **UPGRADE WARNING** Do you use spaces in collection names? Or other special characters? Read [this post](https://groups.google.com/forum/?fromgroups#!topic/keen-io-devs/VtCgPuNKrgY) from the mailing list to make sure your collection names don't change.
++ Add support for generating [scoped keys](https://keen.io/docs/security/#scoped-key).
++ Make collection name encoding more robust. Make sure collection names are encoded identically for publishing events, running queries, and performing deletes.
++ Add support for [grouping by multiple properties](https://keen.io/docs/data-analysis/group-by/#grouping-by-multiple-properties).
+
+##### 0.7.8
++ Add support for redirect URL creation.
+
 ##### 0.7.7
 + Add support for HTTP and SOCKS proxies. Set `KEEN_PROXY_URL` to the proxy URL and `KEEN_PROXY_TYPE` to 'socks5' if you need to. These
 properties can also be set on the client instances as `proxy_url` and `proxy_type`.
@@ -299,6 +337,22 @@ at [users.keen.io](http://users.keen.io). We'd love to hear your feedback and id
 keen-gem is an open source project and we welcome your contributions.
 Fire away with issues and pull requests!
 
+#### Running Tests
+
+`bundle exec rake spec` - Run unit specs. HTTP is mocked.
+
+`bundle exec rake integration` - Run integration specs with the real API. Requires env variables. See [.travis.yml](https://github.com/keenlabs/keen-gem/blob/master/.travis.yml).
+
+`bundle exec rake synchrony` - Run async publishing specs with `EM::Synchrony`.
+
+Similarly, you can use guard to listen for changes to files and run specs.
+
+`bundle exec guard -g unit`
+
+`bundle exec guard -g integration`
+
+`bundle exec guard -g synchrony`
+
 ### Community Contributors
 + [alexkwolfe](https://github.com/alexkwolfe)
 + [peteygao](https://github.com/peteygao)

data/keen.gemspec

@@ -10,24 +10,32 @@ Gem::Specification.new do |s|
   s.homepage    = "https://github.com/keenlabs/keen-gem"
   s.summary     = "Keen IO API Client"
   s.description = "Send events and build analytics features into your Ruby applications."
+  s.license     = "MIT"
+
+  s.post_install_message = "**UPGRADE WARNING** Do you use spaces in collection names? Or other special characters? Read https://groups.google.com/forum/?fromgroups#!topic/keen-io-devs/VtCgPuNKrgY from the mailing list to make sure your collection names don't change!"
 
   s.add_dependency "multi_json", "~> 1.0"
+  s.add_dependency "addressable", "~> 2.3.5"
   s.add_dependency "jruby-openssl" if defined?(JRUBY_VERSION)
 
+  s.add_dependency 'rubysl', '~> 2.0' if defined?(RUBY_ENGINE) && RUBY_ENGINE == 'rbx'
+
   # guard
-  s.add_development_dependency 'guard'
-  s.add_development_dependency 'guard-rspec'
+  unless RUBY_VERSION.start_with? '1.8'
+    s.add_development_dependency 'guard'
+    s.add_development_dependency 'guard-rspec'
 
-  # guard cross-platform listener trick
-  s.add_development_dependency 'rb-inotify'
-  s.add_development_dependency 'rb-fsevent'
-  s.add_development_dependency 'rb-fchange'
+    # guard cross-platform listener trick
+    s.add_development_dependency 'rb-inotify'
+    s.add_development_dependency 'rb-fsevent'
+    s.add_development_dependency 'rb-fchange'
 
-  # guard notifications
-  s.add_development_dependency 'ruby_gntp'
+    # guard notifications
+    s.add_development_dependency 'ruby_gntp'
 
-  # fix guard prompt
-  s.add_development_dependency 'rb-readline' # or compile ruby w/ readline
+    # fix guard prompt
+    s.add_development_dependency 'rb-readline' # or compile ruby w/ readline
+  end
 
   # debuggers
   if /\Aruby/ === RUBY_DESCRIPTION

data/lib/keen.rb

@@ -2,6 +2,7 @@ require 'logger'
 require 'forwardable'
 
 require 'keen/client'
+require 'keen/scoped_key'
 
 module Keen
   class Error < RuntimeError

data/lib/keen/aes_helper.rb

@@ -0,0 +1,43 @@
+require 'openssl'
+require 'digest'
+require 'base64'
+
+module Keen
+  module AESHelper
+
+    BLOCK_SIZE = 32
+
+    def aes256_encrypt(key, plaintext)
+      aes = OpenSSL::Cipher::AES.new(256, :CBC)
+      aes.encrypt
+      aes.key = key
+      iv = aes.random_iv
+      [aes.update(plaintext) + aes.final, iv]
+    end
+
+    def aes256_decrypt(key, iv_plus_encrypted)
+      iv = iv_plus_encrypted[0, 16]
+      encrypted = iv_plus_encrypted[16, iv_plus_encrypted.length]
+      aes = OpenSSL::Cipher::AES.new(256, :CBC)
+      aes.decrypt
+      aes.key = key
+      aes.iv = iv
+      aes.update(encrypted) + aes.final
+    end
+
+    def hexlify(msg)
+      msg.unpack('H*')[0]
+    end
+
+    def unhexlify(msg)
+      [msg].pack('H*')
+    end
+
+    def pad(msg)
+      pad_len = BLOCK_SIZE - (msg.length % BLOCK_SIZE)
+      padding = pad_len.chr * pad_len
+      padded = msg + padding
+      padded
+    end
+  end
+end

data/lib/keen/client.rb

@@ -3,11 +3,11 @@ require 'keen/version'
 require 'keen/client/publishing_methods'
 require 'keen/client/querying_methods'
 require 'keen/client/maintenance_methods'
-
 require 'openssl'
 require 'multi_json'
 require 'base64'
 require 'cgi'
+require 'addressable/uri'
 
 module Keen
   class Client
@@ -92,25 +92,15 @@ module Keen
     end
 
     def api_event_collection_resource_path(event_collection)
-      "/#{api_version}/projects/#{project_id}/events/#{CGI.escape(event_collection.to_s)}"
+        encoded_collection_name = Addressable::URI.escape(event_collection.to_s)
+        encoded_collection_name.gsub! '/', '%2F'
+        "/#{api_version}/projects/#{project_id}/events/#{encoded_collection_name}"
     end
 
     def preprocess_params(params)
-      if params.key?(:filters)
-        params[:filters] = MultiJson.encode(params[:filters])
-      end
-
-      if params.key?(:steps)
-        params[:steps] = MultiJson.encode(params[:steps])
-      end
-
-      if params.key?(:analyses)
-        params[:analyses] = MultiJson.encode(params[:analyses])
-      end
-
-      if params.key?(:timeframe) && params[:timeframe].is_a?(Hash)
-        params[:timeframe] = MultiJson.encode(params[:timeframe])
-      end
+      preprocess_encodables(params)
+      preprocess_timeframe(params)
+      preprocess_group_by(params)
 
       query_params = ""
       params.each do |param, value|
@@ -121,6 +111,28 @@ module Keen
       query_params
     end
 
+    def preprocess_encodables(params)
+      [:filters, :steps, :analyses].each do |key|
+        if params.key?(key)
+          params[key] = MultiJson.encode(params[key])
+        end
+      end
+    end
+
+    def preprocess_timeframe(params)
+      timeframe = params[:timeframe]
+      if timeframe.is_a?(Hash)
+        params[:timeframe] = MultiJson.encode(timeframe)
+      end
+    end
+
+    def preprocess_group_by(params)
+      group_by = params[:group_by]
+      if group_by.is_a?(Array)
+        params[:group_by] = MultiJson.encode(group_by)
+      end
+    end
+
     def method_missing(_method, *args, &block)
       if config = CONFIG[_method.to_sym]
         if config.is_a?(Proc)

data/lib/keen/client/publishing_methods.rb

@@ -61,8 +61,6 @@ module Keen
         ensure_write_key!
         check_event_data!(event_collection, properties)
 
-        deferrable = EventMachine::DefaultDeferrable.new
-
         http_client = Keen::HTTP::Async.new(
             self.api_url,
             {:proxy_url => self.proxy_url, :proxy_type => self.proxy_type})
@@ -73,29 +71,9 @@ module Keen
         )
 
         if defined?(EM::Synchrony)
-          if http.error
-            error = HttpError.new("HTTP em-synchrony publish_async error: #{http.error}")
-            Keen.logger.error(error)
-            raise error
-          else
-            process_response(http.response_header.status, http.response.chomp)
-          end
+          process_with_synchrony(http)
         else
-          http.callback {
-            begin
-              response = process_response(http.response_header.status, http.response.chomp)
-            rescue Exception => e
-              Keen.logger.error(e)
-              deferrable.fail(e)
-            end
-            deferrable.succeed(response) if response
-          }
-          http.errback {
-            error = Error.new("HTTP publish_async failure: #{http.error}")
-            Keen.logger.error(error)
-            deferrable.fail(error)
-          }
-          deferrable
+          process_with_callbacks(http)
         end
       end
 
@@ -131,6 +109,35 @@ module Keen
 
       private
 
+      def process_with_synchrony(http)
+        if http.error
+          error = HttpError.new("HTTP em-synchrony publish_async error: #{http.error}")
+          Keen.logger.error(error)
+          raise error
+        else
+          process_response(http.response_header.status, http.response.chomp)
+        end
+      end
+
+      def process_with_callbacks(http)
+        deferrable = EventMachine::DefaultDeferrable.new
+        http.callback {
+          begin
+            response = process_response(http.response_header.status, http.response.chomp)
+          rescue Exception => e
+            Keen.logger.error(e)
+            deferrable.fail(e)
+          end
+          deferrable.succeed(response) if response
+        }
+        http.errback {
+          error = Error.new("HTTP publish_async failure: #{http.error}")
+          Keen.logger.error(error)
+          deferrable.fail(error)
+        }
+        deferrable
+      end
+
       def publish_body(path, body, error_method)
         begin
           response = Keen::HTTP::Sync.new(

data/lib/keen/scoped_key.rb

@@ -0,0 +1,35 @@
+require 'multi_json'
+require 'keen/aes_helper'
+
+module Keen
+  class ScopedKey
+    include AESHelper
+    extend AESHelper
+
+    attr_accessor :api_key
+    attr_accessor :data
+
+    class << self
+      def decrypt!(api_key, scoped_key)
+        encrypted = unhexlify(scoped_key)
+        padded_api_key = pad(api_key)
+        decrypted = aes256_decrypt(padded_api_key, encrypted)
+        data = MultiJson.load(decrypted)
+        self.new(api_key, data)
+      end
+    end
+
+    def initialize(api_key, data)
+      self.api_key = api_key
+      self.data = data
+    end
+
+    def encrypt!
+      json_str = MultiJson.dump(self.data)
+      padded_api_key = pad(self.api_key)
+      padded_data = pad(json_str)
+      encrypted, iv = aes256_encrypt(padded_api_key, json_str)
+      hexlify(iv) + hexlify(encrypted)
+    end
+  end
+end

data/lib/keen/version.rb

@@ -1,3 +1,3 @@
 module Keen
-  VERSION = "0.7.8"
+  VERSION = "0.8.0"
 end

data/spec/integration/api_spec.rb

@@ -5,7 +5,7 @@ describe "Keen IO API" do
   let(:write_key) { ENV['KEEN_WRITE_KEY'] }
 
   describe "publishing" do
-    let(:collection) { "users" }
+    let(:collection) { "User posts.new" }
     let(:event_properties) { { "name" => "Bob" } }
     let(:api_success) { { "created" => true } }
 
@@ -116,6 +116,24 @@ describe "Keen IO API" do
     it "should return a valid count_unique" do
       Keen.count_unique(event_collection, :target_property => "price").should == 2
     end
+    
+    it "should return a valid count with group_by" do   
+      response = Keen.average(event_collection, :group_by => "username", :target_property => "price")
+      bobs_response = response.select { |result| result["username"] == "bob" }.first
+      bobs_response["result"].should == 10
+      teds_response = response.select { |result| result["username"] == "ted" }.first
+      teds_response["result"].should == 20    
+    end
+    
+    it "should return a valid count with multi-group_by" do   
+      response = Keen.average(event_collection, :group_by => ["username", "price"], :target_property => "price")
+      bobs_response = response.select { |result| result["username"] == "bob" }.first
+      bobs_response["result"].should == 10
+      bobs_response["price"].should == 10
+      teds_response = response.select { |result| result["username"] == "ted" }.first
+      teds_response["result"].should == 20
+      teds_response["price"].should == 20
+    end
 
     it "should return a valid sum" do
       Keen.sum(event_collection, :target_property => "price").should == 30
@@ -171,7 +189,7 @@ describe "Keen IO API" do
     before do
       Keen.publish(event_collection, :delete => "me")
       Keen.publish(event_collection, :delete => "you")
-      sleep(3)
+      sleep(10)
     end
 
     it "should delete the event" do

data/spec/keen/client/publishing_methods_spec.rb

@@ -4,7 +4,7 @@ describe Keen::Client::PublishingMethods do
   let(:project_id) { "12345" }
   let(:write_key) { "abcde" }
   let(:api_url) { "https://unreal.keen.io" }
-  let(:collection) { "users" }
+  let(:collection) { "some :actions_to.record" }
   let(:event_properties) { { "name" => "Bob" } }
   let(:api_success) { { "created" => true } }
   let(:client) { Keen::Client.new(
@@ -37,9 +37,9 @@ describe Keen::Client::PublishingMethods do
     end
 
     it "should url encode the event collection" do
-      stub_keen_post(api_event_collection_resource_url(api_url, "foo+bar"), 201, "")
-      client.publish("foo bar", event_properties)
-      expect_keen_post(api_event_collection_resource_url(api_url, "foo+bar"), event_properties, "sync", write_key)
+      stub_keen_post(api_event_collection_resource_url(api_url, "User%20posts.new%20)(*%26%5E%25%40!)%3A%3A%2520%2520"), 201, "")
+      client.publish("User posts.new )(*&^%@!)::%20%20", event_properties)
+      expect_keen_post(api_event_collection_resource_url(api_url, "User%20posts.new%20)(*%26%5E%25%40!)%3A%3A%2520%2520"), event_properties, "sync", write_key)
     end
 
     it "should wrap exceptions" do
@@ -138,11 +138,11 @@ describe Keen::Client::PublishingMethods do
       end
 
       it "should url encode the event collection" do
-        stub_keen_post(api_event_collection_resource_url(api_url, "foo+bar"), 201, api_success)
+        stub_keen_post(api_event_collection_resource_url(api_url, 'User%20posts.new%20)(*%26%5E%25%40!)%3A%3A%2520%2520'), 201, api_success)
         EM.run {
-          client.publish_async("foo bar", event_properties).callback {
+          client.publish_async('User posts.new )(*&^%@!)::%20%20', event_properties).callback {
             begin
-              expect_keen_post(api_event_collection_resource_url(api_url, "foo+bar"), event_properties, "async", write_key)
+              expect_keen_post(api_event_collection_resource_url(api_url, 'User%20posts.new%20)(*%26%5E%25%40!)%3A%3A%2520%2520'), event_properties, "async", write_key)
             ensure
               EM.stop
             end

data/spec/keen/client/querying_methods_spec.rb

@@ -75,6 +75,16 @@ describe Keen::Client do
         filter_str = CGI.escape(MultiJson.encode(filters))
         test_query("&filters=#{filter_str}", :filters => filters)
       end
+      
+      it "should encode a single group by property" do
+        test_query("&group_by=one%20foo", :group_by => "one foo")
+      end
+      
+      it "should encode multi-group by properly" do
+        group_by = ["one", "two"]
+        group_by_str = CGI.escape(MultiJson.encode(group_by))
+        test_query("&group_by=#{group_by_str}", :group_by => group_by)
+      end
 
       it "should encode absolute timeframes properly" do
         timeframe = {

data/spec/keen/scoped_key_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe Keen::ScopedKey do
+  let(:api_key) { "ab428324dbdbcfe744" }
+  let(:bad_api_key) { "badbadbadbad" }
+  let(:data) { {
+   "filters" => [{
+      "property_name" => "accountId",
+      "operator" => "eq",
+      "property_value" => "123456"
+    }]
+  }}
+  let(:new_scoped_key) { Keen::ScopedKey.new(api_key, data) }
+
+  describe "constructor" do
+    it "should retain the api_key" do
+      new_scoped_key.api_key.should == api_key
+    end
+
+    it "should retain the data" do
+      new_scoped_key.data.should == data
+    end
+  end
+
+  describe "encrypt! and decrypt!" do
+    it "should encrypt and hex encode the data using the api key" do
+      encrypted_str = new_scoped_key.encrypt!
+      other_api_key = Keen::ScopedKey.decrypt!(api_key, encrypted_str)
+      other_api_key.data.should == data
+    end
+
+    it "should not decrypt the scoped key with a bad api key" do
+      encrypted_str = new_scoped_key.encrypt!
+      expect {
+        other_api_key = Keen::ScopedKey.decrypt!(bad_api_key, encrypted_str)
+      }.to raise_error(OpenSSL::Cipher::CipherError)
+    end
+  end
+end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: keen
 version: !ruby/object:Gem::Version
-  version: 0.7.8
-  prerelease: 
+  version: 0.8.0
 platform: ruby
 authors:
 - Kyle Wild
@@ -11,12 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-14 00:00:00.000000000 Z
+date: 2014-01-09 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
@@ -24,137 +22,120 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: guard
+  name: addressable
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: 2.3.5
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.3.5
 - !ruby/object:Gem::Dependency
-  name: guard-rspec
+  name: guard
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rb-inotify
+  name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rb-fsevent
+  name: rb-inotify
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rb-fchange
+  name: rb-fsevent
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: ruby_gntp
+  name: rb-fchange
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rb-readline
+  name: ruby_gntp
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: debugger
+  name: rb-readline
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Send events and build analytics features into your Ruby applications.
@@ -174,11 +155,13 @@ files:
 - config/cacert.pem
 - keen.gemspec
 - lib/keen.rb
+- lib/keen/aes_helper.rb
 - lib/keen/client.rb
 - lib/keen/client/maintenance_methods.rb
 - lib/keen/client/publishing_methods.rb
 - lib/keen/client/querying_methods.rb
 - lib/keen/http.rb
+- lib/keen/scoped_key.rb
 - lib/keen/version.rb
 - spec/integration/api_spec.rb
 - spec/integration/spec_helper.rb
@@ -187,33 +170,36 @@ files:
 - spec/keen/client/querying_methods_spec.rb
 - spec/keen/client_spec.rb
 - spec/keen/keen_spec.rb
+- spec/keen/scoped_key_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: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: '**UPGRADE WARNING** Do you use spaces in collection names?
+  Or other special characters? Read https://groups.google.com/forum/?fromgroups#!topic/keen-io-devs/VtCgPuNKrgY
+  from the mailing list to make sure your collection names don''t change!'
 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.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Keen IO API Client
 test_files:
 - spec/integration/api_spec.rb
@@ -223,7 +209,9 @@ test_files:
 - spec/keen/client/querying_methods_spec.rb
 - spec/keen/client_spec.rb
 - spec/keen/keen_spec.rb
+- spec/keen/scoped_key_spec.rb
 - spec/keen/spec_helper.rb
 - spec/spec_helper.rb
 - spec/synchrony/spec_helper.rb
 - spec/synchrony/synchrony_spec.rb
+has_rdoc: