keen 0.7.0 → 0.7.1

data/.gitignore

@@ -1,5 +1,4 @@
 *.bundle
-Gemfile.lock
 tmp
 .env
 log

data/Gemfile.lock

@@ -0,0 +1,106 @@
+PATH
+  remote: .
+  specs:
+    keen (0.7.1)
+      multi_json (~> 1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.4)
+    coderay (1.0.9)
+    columnize (0.3.6)
+    cookiejar (0.3.0)
+    crack (0.3.2)
+    debugger (1.5.0)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.2.0)
+      debugger-ruby_core_source (~> 1.2.0)
+    debugger-linecache (1.2.0)
+    debugger-ruby_core_source (1.2.0)
+    diff-lcs (1.2.4)
+    em-http-request (1.0.3)
+      addressable (>= 2.2.3)
+      cookiejar
+      em-socksify
+      eventmachine (>= 1.0.0.beta.4)
+      http_parser.rb (>= 0.5.3)
+    em-socksify (0.2.1)
+      eventmachine (>= 1.0.0.beta.4)
+    em-synchrony (1.0.3)
+      eventmachine (>= 1.0.0.beta.1)
+    eventmachine (1.0.3)
+    ffi (1.8.1)
+    formatador (0.2.4)
+    guard (1.8.0)
+      formatador (>= 0.2.4)
+      listen (>= 1.0.0)
+      lumberjack (>= 1.0.2)
+      pry (>= 0.9.10)
+      thor (>= 0.14.6)
+    guard-rspec (2.6.0)
+      guard (>= 1.8)
+      rspec (~> 2.13)
+    http_parser.rb (0.5.3)
+    linecache (0.46)
+      rbx-require-relative (> 0.0.4)
+    listen (1.0.3)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+      rb-kqueue (>= 0.2)
+    lumberjack (1.0.3)
+    method_source (0.8.1)
+    multi_json (1.7.2)
+    pry (0.9.12.1)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rake (10.0.4)
+    rb-fchange (0.0.6)
+      ffi
+    rb-fsevent (0.9.3)
+    rb-inotify (0.9.0)
+      ffi (>= 0.5.0)
+    rb-kqueue (0.2.0)
+      ffi (>= 0.5.0)
+    rb-readline (0.5.0)
+    rbx-require-relative (0.0.9)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+    ruby-debug (0.10.4)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.4.0)
+    ruby-debug-base (0.10.4)
+      linecache (>= 0.3)
+    ruby_gntp (0.3.4)
+    slop (3.4.4)
+    thor (0.18.1)
+    webmock (1.11.0)
+      addressable (>= 2.2.7)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  debugger
+  em-http-request
+  em-synchrony
+  guard
+  guard-rspec
+  keen!
+  rake
+  rb-fchange
+  rb-fsevent
+  rb-inotify
+  rb-readline
+  rspec
+  ruby-debug
+  ruby_gntp
+  webmock

data/README.md

@@ -177,6 +177,9 @@ To track email opens, simply add an image to your email template that points to
 
 ### Changelog
 
+##### 0.7.1
++ Allow configuration of the base API URL via the KEEN_API_URL environment variable. Useful for local testing and proxies.
+
 ##### 0.7.0
 + BREAKING CHANGE! Added support for read and write scoped keys to reflect the new Keen IO security architecture.
 The advantage of scoped keys is finer grained permission control. Public clients that

data/lib/keen.rb

@@ -25,9 +25,18 @@ module Keen
   class << self
     extend Forwardable
 
-    def_delegators :default_client, :project_id, :write_key, :read_key,
-                   :project_id=, :write_key=, :read_key=, :publish, :publish_async,
-                   :beacon_url, :count, :count_unique, :minimum, :maximum,
+    def_delegators :default_client, 
+                   :project_id, :project_id=, 
+                   :write_key, :write_key=, 
+                   :read_key, :read_key=, 
+                   :api_url, :api_url=
+
+    def_delegators :default_client,
+                   :publish, :publish_async,
+                   :beacon_url
+
+    def_delegators :default_client,
+                   :count, :count_unique, :minimum, :maximum,
                    :sum, :average, :select_unique, :funnel, :extraction
 
     attr_writer :logger
@@ -46,7 +55,8 @@ module Keen
       @default_client ||= Keen::Client.new(
         :project_id => ENV['KEEN_PROJECT_ID'],
         :write_key => ENV['KEEN_WRITE_KEY'],
-        :read_key => ENV['KEEN_READ_KEY']
+        :read_key => ENV['KEEN_READ_KEY'],
+        :api_url => ENV['KEEN_API_URL']
       )
     end
   end

data/lib/keen/client.rb

@@ -6,18 +6,16 @@ require 'keen/client/querying_methods'
 require 'openssl'
 require 'multi_json'
 require 'base64'
-require 'uri'
 
 module Keen
   class Client
     include Keen::Client::PublishingMethods
     include Keen::Client::QueryingMethods
 
-    attr_accessor :project_id, :write_key, :read_key
+    attr_accessor :project_id, :write_key, :read_key, :api_url
 
     CONFIG = {
-      :api_host => "api.keen.io",
-      :api_port => 443,
+      :api_url => "https://api.keen.io",
       :api_version => "3.0",
       :api_sync_http_options => {
         :use_ssl => true,
@@ -48,8 +46,10 @@ module Keen
         }.merge(args[3] || {})
       end
 
-      @project_id, @write_key, @read_key = options.values_at(
+      self.project_id, self.write_key, self.read_key = options.values_at(
         :project_id, :write_key, :read_key)
+
+      self.api_url = options[:api_url] || CONFIG[:api_url]
     end
 
     private

data/lib/keen/client/publishing_methods.rb

@@ -28,7 +28,7 @@ module Keen
 
         begin
           response = Keen::HTTP::Sync.new(
-            api_host, api_port, api_sync_http_options).post(
+            self.api_url, api_sync_http_options).post(
               :path => api_event_resource_path(event_collection),
               :headers => api_headers(self.write_key, "sync"),
               :body => MultiJson.encode(properties))
@@ -53,7 +53,7 @@ module Keen
 
         deferrable = EventMachine::DefaultDeferrable.new
 
-        http_client = Keen::HTTP::Async.new(api_host, api_port, api_async_http_options)
+        http_client = Keen::HTTP::Async.new(self.api_url, api_async_http_options)
         http = http_client.post(
           :path => api_event_resource_path(event_collection),
           :headers => api_headers(self.write_key, "async"),
@@ -98,7 +98,7 @@ module Keen
       def beacon_url(event_collection, properties)
         json = MultiJson.encode(properties)
         data = [json].pack("m0").tr("+/", "-_").gsub("\n", "")
-        "https://#{api_host}#{api_event_resource_path(event_collection)}?api_key=#{self.write_key}&data=#{data}"
+        "#{self.api_url}#{api_event_resource_path(event_collection)}?api_key=#{self.write_key}&data=#{data}"
       end
 
       private

data/lib/keen/client/querying_methods.rb

@@ -172,7 +172,7 @@ module Keen
 
         begin
           response = Keen::HTTP::Sync.new(
-            api_host, api_port, api_sync_http_options).get(
+            self.api_url, api_sync_http_options).get(
               :path => "#{api_query_resource_path(query_name)}?#{query_params}",
               :headers => api_headers(self.read_key, "sync"))
         rescue Exception => http_error

data/lib/keen/http.rb

@@ -1,9 +1,12 @@
 module Keen
   module HTTP
     class Sync
-      def initialize(host, port, options={})
+      def initialize(base_url, options={})
+        require 'uri'
         require 'net/https'
-        @http = Net::HTTP.new(host, port)
+
+        uri = URI.parse(base_url)
+        @http = Net::HTTP.new(uri.host, uri.port)
         options.each_pair { |key, value| @http.send "#{key}=", value }
       end
 
@@ -21,20 +24,20 @@ module Keen
     end
 
     class Async
-      def initialize(host, port, options={})
+      def initialize(base_url, 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
+        @base_url, @http_options = base_url, options
       end
 
       def post(options)
         path, headers, body = options.values_at(
           :path, :headers, :body)
-        uri = "https://#{@host}:#{@port}#{path}"
+        uri = "#{@base_url}#{path}"
         http_client = EventMachine::HttpRequest.new(uri, @http_options)
         http_client.post(
           :body => body,

data/lib/keen/version.rb

@@ -1,3 +1,3 @@
 module Keen
-  VERSION = "0.7.0"
+  VERSION = "0.7.1"
 end

data/spec/integration/api_spec.rb

@@ -35,8 +35,14 @@ describe "Keen IO API" do
         it "should publish the event and trigger callbacks" do
           EM.run {
             Keen.publish_async(collection, event_properties).callback { |response|
-              response.should == api_success
+              begin
+                response.should == api_success
+              ensure
+                EM.stop
+              end
+            }.errback { |error|
               EM.stop
+              fail error
             }
           }
         end
@@ -44,8 +50,11 @@ describe "Keen IO API" do
         it "should publish to non-url-safe collections" do
           EM.run {
             Keen.publish_async("foo bar", event_properties).callback { |response|
-              response.should == api_success
-              EM.stop
+              begin
+                response.should == api_success
+              ensure
+                EM.stop
+              end
             }
           }
         end
@@ -55,19 +64,22 @@ describe "Keen IO API" do
 
   describe "queries" do
     let(:read_key) { ENV['KEEN_READ_KEY'] }
-    let(:event_collection) { "purchases_" + rand(100000).to_s }
-    let(:returns_event_collection) { "returns_" + rand(100000).to_s }
+    let(:event_collection) { @event_collection }
+    let(:returns_event_collection) { @returns_event_collection }
 
     before(:all) do
-      Keen.publish(event_collection, {
+      @event_collection = "purchases_" + rand(100000).to_s
+      @returns_event_collection = "returns_" + rand(100000).to_s
+
+      Keen.publish(@event_collection, {
         :username => "bob",
         :price => 10
       })
-      Keen.publish(event_collection, {
+      Keen.publish(@event_collection, {
         :username => "ted",
         :price => 20
       })
-      Keen.publish(returns_event_collection, {
+      Keen.publish(@returns_event_collection, {
         :username => "bob",
         :price => 30
       })
@@ -114,7 +126,7 @@ describe "Keen IO API" do
         :event_collection => event_collection,
         :actor_property => "username"
       }, {
-        :event_collection => returns_event_collection,
+        :event_collection => @returns_event_collection,
         :actor_property => "username"
       }]
       results = Keen.funnel(:steps => steps)

data/spec/keen/client/publishing_methods_spec.rb

@@ -3,22 +3,24 @@ require File.expand_path("../../spec_helper", __FILE__)
 describe Keen::Client::PublishingMethods do
   let(:project_id) { "12345" }
   let(:write_key) { "abcde" }
-  let(:api_host) { "api.keen.io" }
+  let(:api_url) { "https://unreal.keen.io" }
   let(:collection) { "users" }
   let(:event_properties) { { "name" => "Bob" } }
   let(:api_success) { { "created" => true } }
-  let(:client) { Keen::Client.new(:project_id => project_id, :write_key => write_key) }
+  let(:client) { Keen::Client.new(
+    :project_id => project_id, :write_key => write_key,
+    :api_url => api_url) }
 
   describe "publish" do
     it "should post using the collection and properties" do
-      stub_keen_post(api_event_resource_url(collection), 201, "")
+      stub_keen_post(api_event_resource_url(api_url, collection), 201, "")
       client.publish(collection, event_properties)
-      expect_keen_post(api_event_resource_url(collection), event_properties, "sync", write_key)
+      expect_keen_post(api_event_resource_url(api_url, collection), event_properties, "sync", write_key)
     end
 
     it "should return the proper response" do
       api_response = { "created" => true }
-      stub_keen_post(api_event_resource_url(collection), 201, api_response)
+      stub_keen_post(api_event_resource_url(api_url, collection), 201, api_response)
       client.publish(collection, event_properties).should == api_response
     end
 
@@ -35,13 +37,13 @@ describe Keen::Client::PublishingMethods do
     end
 
     it "should url encode the event collection" do
-      stub_keen_post(api_event_resource_url("foo%20bar"), 201, "")
+      stub_keen_post(api_event_resource_url(api_url, "foo%20bar"), 201, "")
       client.publish("foo bar", event_properties)
-      expect_keen_post(api_event_resource_url("foo%20bar"), event_properties, "sync", write_key)
+      expect_keen_post(api_event_resource_url(api_url, "foo%20bar"), event_properties, "sync", write_key)
     end
 
     it "should wrap exceptions" do
-      stub_request(:post, api_event_resource_url(collection)).to_timeout
+      stub_request(:post, api_event_resource_url(api_url, collection)).to_timeout
       e = nil
       begin
         client.publish(collection, event_properties)
@@ -81,27 +83,33 @@ describe Keen::Client::PublishingMethods do
       end
 
       it "should post the event data" do
-        stub_keen_post(api_event_resource_url(collection), 201, api_success)
+        stub_keen_post(api_event_resource_url(api_url, collection), 201, api_success)
         EM.run {
           client.publish_async(collection, event_properties).callback {
             begin
-              expect_keen_post(api_event_resource_url(collection), event_properties, "async", write_key)
+              expect_keen_post(api_event_resource_url(api_url, collection), event_properties, "async", write_key)
             ensure
               EM.stop
             end
+          }.errback { 
+            EM.stop
+            fail
           }
         }
       end
 
       it "should uri encode the event collection" do
-        stub_keen_post(api_event_resource_url("foo%20bar"), 201, api_success)
+        stub_keen_post(api_event_resource_url(api_url, "foo%20bar"), 201, api_success)
         EM.run {
           client.publish_async("foo bar", event_properties).callback {
             begin
-              expect_keen_post(api_event_resource_url("foo%20bar"), event_properties, "async", write_key)
+              expect_keen_post(api_event_resource_url(api_url, "foo%20bar"), event_properties, "async", write_key)
             ensure
               EM.stop
             end
+          }.errback {
+            EM.stop
+            fail
           }
         }
       end
@@ -120,7 +128,7 @@ describe Keen::Client::PublishingMethods do
 
       describe "deferrable callbacks" do
         it "should trigger callbacks" do
-          stub_keen_post(api_event_resource_url(collection), 201, api_success)
+          stub_keen_post(api_event_resource_url(api_url, collection), 201, api_success)
           EM.run {
             client.publish_async(collection, event_properties).callback { |response|
               begin
@@ -133,7 +141,7 @@ describe Keen::Client::PublishingMethods do
         end
 
         it "should trigger errbacks" do
-          stub_request(:post, api_event_resource_url(collection)).to_timeout
+          stub_request(:post, api_event_resource_url(api_url, collection)).to_timeout
           EM.run {
             client.publish_async(collection, event_properties).errback { |error|
               begin
@@ -147,7 +155,7 @@ describe Keen::Client::PublishingMethods do
         end
 
         it "should not trap exceptions in the client callback" do
-          stub_keen_post(api_event_resource_url("foo%20bar"), 201, api_success)
+          stub_keen_post(api_event_resource_url(api_url, "foo%20bar"), 201, api_success)
           expect {
             EM.run {
               client.publish_async("foo bar", event_properties).callback {
@@ -179,9 +187,8 @@ describe Keen::Client::PublishingMethods do
 
   describe "beacon_url" do
     it "should return a url with a base-64 encoded json param" do
-      client = Keen::Client.new(:project_id => project_id, :write_key => write_key)
       client.beacon_url("sign_ups", { :name => "Bob" }).should ==
-        "https://api.keen.io/3.0/projects/12345/events/sign_ups?api_key=#{write_key}&data=eyJuYW1lIjoiQm9iIn0="
+        "#{api_url}/3.0/projects/12345/events/sign_ups?api_key=#{write_key}&data=eyJuYW1lIjoiQm9iIn0="
     end
   end
 end

data/spec/keen/client/querying_methods_spec.rb

@@ -3,13 +3,15 @@ require File.expand_path("../../spec_helper", __FILE__)
 describe Keen::Client do
   let(:project_id) { "12345" }
   let(:read_key) { "abcde" }
-  let(:api_host) { "api.keen.io" }
+  let(:api_url) { "https://notreal.keen.io" }
   let(:api_version) { "3.0" }
   let(:event_collection) { "users" }
-  let(:client) { Keen::Client.new(:project_id => project_id, :read_key => read_key) }
+  let(:client) { Keen::Client.new(
+    :project_id => project_id, :read_key => read_key,
+    :api_url => api_url ) }
 
   def query_url(query_name, query_params)
-    "https://#{api_host}/#{api_version}/projects/#{project_id}/queries/#{query_name}#{query_params}"
+    "#{api_url}/#{api_version}/projects/#{project_id}/queries/#{query_name}#{query_params}"
   end
 
   describe "querying names" do

data/spec/keen/client_spec.rb

@@ -4,8 +4,16 @@ describe Keen::Client do
   let(:project_id) { "12345" }
   let(:write_key) { "abcdewrite" }
   let(:read_key) { "abcderead" }
+  let(:api_url) { "http://fake.keen.io:fakeport" }
   let(:client) { Keen::Client.new(:project_id => project_id) }
 
+  before do
+    ENV["KEEN_PROJECT_ID"] = nil
+    ENV["KEEN_WRITE_KEY"] = nil
+    ENV["KEEN_READ_KEY"] = nil
+    ENV["KEEN_API_URL"] = nil
+  end
+
   describe "#initialize" do
     context "deprecated" do
       it "should allow created via project_id and key args" do
@@ -20,10 +28,16 @@ describe Keen::Client do
       client = Keen::Client.new(
         :project_id => project_id,
         :write_key => write_key,
-        :read_key => read_key)
+        :read_key => read_key,
+        :api_url => api_url)
       client.write_key.should == write_key
       client.read_key.should == read_key
       client.project_id.should == project_id
+      client.api_url.should == api_url
+    end
+
+    it "should set a default api_url" do
+      Keen::Client.new.api_url.should == "https://api.keen.io"
     end
   end
 

data/spec/keen/keen_spec.rb

@@ -8,6 +8,7 @@ describe Keen do
         ENV["KEEN_PROJECT_ID"] = "12345"
         ENV["KEEN_WRITE_KEY"] = "abcdewrite"
         ENV["KEEN_READ_KEY"] = "abcderead"
+        ENV["KEEN_API_URL"] = "http://fake.keen.io:fakeport"
       end
 
       let(:client) { Keen.send(:default_client) }
@@ -23,6 +24,10 @@ describe Keen do
       it "should set a read key from the environment" do
         client.read_key.should == "abcderead"
       end
+
+      it "should set an api host from the environment" do
+        client.api_url.should == "http://fake.keen.io:fakeport"
+      end
     end
   end
 
@@ -43,14 +48,14 @@ describe Keen do
       Keen.stub(:default_client).and_return(@default_client)
     end
 
-    [:project_id, :write_key, :read_key].each do |_method|
+    [:project_id, :write_key, :read_key, :api_url].each do |_method|
       it "should forward the #{_method} method" do
         @default_client.should_receive(_method)
         Keen.send(_method)
       end
     end
 
-    [:project_id=, :write_key=, :read_key=].each do |_method|
+    [:project_id=, :write_key=, :read_key=, :api_url=].each do |_method|
       it "should forward the #{_method} method" do
         @default_client.should_receive(_method).with("12345")
         Keen.send(_method, "12345")

data/spec/spec_helper.rb

@@ -48,8 +48,8 @@ module Keen::SpecHelpers
     expect_keen_request(:post, url, MultiJson.encode(event_properties), sync_or_async_ua, write_key)
   end
 
-  def api_event_resource_url(collection)
-    "https://api.keen.io/3.0/projects/#{project_id}/events/#{collection}"
+  def api_event_resource_url(base_url, collection)
+    "#{base_url}/3.0/projects/#{project_id}/events/#{collection}"
   end
 end
 

data/spec/synchrony/synchrony_spec.rb

@@ -4,26 +4,29 @@ describe Keen::HTTP::Async do
   let(:project_id) { "12345" }
   let(:write_key) { "abcdewrite" }
   let(:collection) { "users" }
+  let(:api_url) { "https://fake.keen.io" }
   let(:event_properties) { { "name" => "Bob" } }
   let(:api_success) { { "created" => true } }
 
   describe "synchrony" do
     before do
-      @client = Keen::Client.new(:project_id => project_id, :write_key => write_key)
+      @client = Keen::Client.new(
+        :project_id => project_id, :write_key => write_key,
+        :api_url => api_url)
     end
 
     describe "success" do
       it "should post the event data" do
-        stub_keen_post(api_event_resource_url(collection), 201, api_success)
+        stub_keen_post(api_event_resource_url(api_url, collection), 201, api_success)
         EM.synchrony {
           @client.publish_async(collection, event_properties)
-          expect_keen_post(api_event_resource_url(collection), event_properties, "async", write_key)
+          expect_keen_post(api_event_resource_url(api_url, collection), event_properties, "async", write_key)
           EM.stop
         }
       end
 
       it "should recieve the right response 'synchronously'" do
-        stub_keen_post(api_event_resource_url(collection), 201, api_success)
+        stub_keen_post(api_event_resource_url(api_url, collection), 201, api_success)
         EM.synchrony {
           @client.publish_async(collection, event_properties).should == api_success
           EM.stop
@@ -33,7 +36,7 @@ describe Keen::HTTP::Async do
 
     describe "failure" do
       it "should raise an exception" do
-        stub_request(:post, api_event_resource_url(collection)).to_timeout
+        stub_request(:post, api_event_resource_url(api_url, collection)).to_timeout
         e = nil
         EM.synchrony {
           begin

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: keen
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
   prerelease: 
 platform: ruby
 authors:
@@ -39,6 +39,7 @@ files:
 - .rspec
 - .travis.yml
 - Gemfile
+- Gemfile.lock
 - Guardfile
 - LICENSE
 - README.md