keen 0.8.8 → 0.8.9

data/README.md

@@ -113,6 +113,7 @@ Running queries requires that `KEEN_READ_KEY` is set.
 Here are some examples of querying with keen-gem. Let's assume you've added some events to the "purchases" collection.
 
 ```ruby
+# Various analysis types
 Keen.count("purchases") # => 100
 Keen.sum("purchases", :target_property => "price")  # => 10000
 Keen.minimum("purchases", :target_property => "price")  # => 20
@@ -120,23 +121,35 @@ Keen.maximum("purchases", :target_property => "price")  # => 100
 Keen.average("purchases", :target_property => "price")  # => 60
 Keen.median("purchases", :target_property => "price")  # => 60
 Keen.percentile("purchases", :target_property => "price", :percentile => 90)  # => 100
+Keen.count_unique("purchases", :target_property => "username")  # => 3
+Keen.select_unique("purchases", :target_property => "username")  # => ["Bob", "Linda", "Travis"]
 
+# Group by's and filters
 Keen.sum("purchases", :target_property => "price", :group_by => "item.id")  # => [{ "item.id": 123, "result": 240 }]
 Keen.count("purchases", :timeframe => "today", :filters => [{
     "property_name" => "referred_by",
     "operator" => "eq",
     "property_value" => "harry"
   }]) # => 2
+  
+# Relative timeframes
+Keen.count("purchases", :timeframe => "today") # => 10
 
-Keen.count_unique("purchases", :target_property => "username")  # => 3
-Keen.select_unique("purchases", :target_property => "username")  # => ["Bob", "Linda", "Travis"]
+# Absolute timeframes
+Keen.count("purchases", :timeframe => { 
+  :start => "2015-01-01T00:00:00Z", 
+  :end => "2015-31-01T00:00:00Z" 
+}) # => 5
 
+# Extractions
 Keen.extraction("purchases")  # => [{ "keen" => { "timestamp" => "2014-01-01T00:00:00Z" }, "price" => 20 }]
 
+# Funnels
 Keen.funnel(:steps => [{ 
   :actor_property => "username", :event_collection => "purchases" }, {
   :actor_property => "username", :event_collection => "referrals" }]) # => [20, 15]
 
+# Multi-analysis
 Keen.multi_analysis("purchases", analyses: {
   :gross =>      { :analysis_type => "sum", :target_property => "price" },
   :customers =>  { :analysis_type => "count_unique", :target_property => "username" } },
@@ -270,7 +283,6 @@ Keen.project_id = 'xxxxxxxxxxxxxxx'
 Keen.write_key = 'yyyyyyyyyyyyyyy'
 Keen.read_key = 'zzzzzzzzzzzzzzz'
 Keen.master_key = 'aaaaaaaaaaaaaaa'
-Keen.read_timeoout = 60
 ```
 
 You can also configure unique client instances as follows:
@@ -279,8 +291,7 @@ You can also configure unique client instances as follows:
 keen = Keen::Client.new(:project_id => 'xxxxxxxxxxxxxxx',
                         :write_key  => 'yyyyyyyyyyyyyyy',
                         :read_key   => 'zzzzzzzzzzzzzzz',
-                        :master_key => 'aaaaaaaaaaaaaaa',
-                        :read_timeout => 60)
+                        :master_key => 'aaaaaaaaaaaaaaa')
 ```
 
 #### em-synchrony
@@ -340,14 +351,17 @@ You can use the scoped key created in Ruby for API requests from any client. Sco
 
 The default `Net:HTTP` timeout is 60 seconds. That's usually enough, but if you're querying over a large collection you may need to increase it. The timeout on the API side is 300 seconds, so that's as far as you'd want to go. You can configure a read timeout (in seconds) by setting a `KEEN_READ_TIMEOUT` environment variable, or by passing in a `read_timeout` option to the client constructor as follows:
 
-```
+``` ruby
 keen = Keen::Client.new(:read_timeout => 300)
 ```
 
 ##### HTTP Proxy
 
-You can set the `KEEN_PROXY_TYPE` and `KEEN_PROXY_URL` environment variables to enable HTTP proxying. `KEEN_PROXY_TYPE` should most likely be set to `socks5`. You can also configure this on client instances by passing in `proxy_type` and `proxy_url` keys.
+You can set the `KEEN_PROXY_TYPE` and `KEEN_PROXY_URL` environment variables to enable HTTP proxying. `KEEN_PROXY_TYPE` should be set to `socks5`. You can also configure this on client instances by passing in `proxy_type` and `proxy_url` keys.
 
+``` ruby
+keen = Keen::Client.new(:proxy_type => 'socks5', :proxy_url => 'http://localhost:8888')
+```
 
 ### Troubleshooting
 
@@ -364,6 +378,9 @@ EventMachine itself won't do this because it runs in a different thread. Here's
 
 ### Changelog
 
+##### 0.8.9
++ Fix proxy support for sync client. Thanks [@nvieirafelipe](https://github.com/nvieirafelipe)!
+
 ##### 0.8.8
 + Add support for a configurable read timeout
 

data/lib/keen/http.rb

@@ -22,7 +22,7 @@ module Keen
       end
 
       def proxy_arguments_for(uri)
-        proxy_uri = URI.parse(proxy_url)
+        proxy_uri = URI.parse(uri)
         [proxy_uri.host, proxy_uri.port, proxy_uri.user, proxy_uri.password]
       end
 

data/lib/keen/scoped_key.rb

@@ -27,9 +27,8 @@ module Keen
     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
+end

data/lib/keen/version.rb

@@ -1,3 +1,3 @@
 module Keen
-  VERSION = "0.8.8"
+  VERSION = "0.8.9"
 end

data/spec/keen/client/publishing_methods_spec.rb

@@ -71,6 +71,22 @@ describe Keen::Client::PublishingMethods do
         ).publish(collection, event_properties)
       }.to raise_error(Keen::ConfigurationError, "Keen IO Exception: Write Key must be set for this operation")
     end
+
+    context "when using proxy" do
+      let(:client) do
+        Keen::Client.new(:project_id => project_id,
+                         :write_key => write_key,
+                         :api_url => api_url,
+                         :proxy_url => "http://localhost:8888",
+                         :proxy_type => "socks5")
+      end
+
+      it "should return the proper response" do
+        api_response = { "created" => true }
+        stub_keen_post(api_event_collection_resource_url(api_url, collection), 201, api_response)
+        client.publish(collection, event_properties).should == api_response
+      end
+    end
   end
 
   describe "publish_batch" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: keen
 version: !ruby/object:Gem::Version
-  version: 0.8.8
+  version: 0.8.9
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-19 00:00:00.000000000 Z
+date: 2015-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json