keen 0.7.6 → 0.7.7

data/.gitignore

@@ -3,3 +3,4 @@ tmp
 .env
 log
 *.gem
+Gemfile.lock

data/Gemfile

@@ -1,6 +1,4 @@
-source "http://rubygems.org"
-
-gemspec
+source "https://rubygems.org"
 
 group :development, :test do
   gem 'rake'
@@ -8,28 +6,6 @@ group :development, :test do
   gem 'em-http-request'
   gem 'em-synchrony', :require => false
   gem 'webmock'
-  # ensure a reasonable json so multi_json doesn't complain
-  gem 'json', '~> 1.7.7'
-end
-
-group :development do
-  # guard cross-platform listener trick
-  gem 'rb-inotify', :require => false
-  gem 'rb-fsevent', :require => false
-  gem 'rb-fchange', :require => false
-
-  # guard notifications
-  gem 'ruby_gntp'
-
-  # fix guard prompt
-  gem 'rb-readline' # or compile ruby w/ readline
-
-  # guard
-  gem 'guard'
-  gem 'guard-rspec'
-
-  # debuggers
-  gem 'ruby-debug', :platforms => :mri_18
-  gem 'debugger', :platforms => :mri_19
 end
 
+gemspec

data/README.md

@@ -226,6 +226,12 @@ To track email opens, simply add an image to your email template that points to
 
 ### Changelog
 
+##### 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`.
+
++ Delegate the `master_key` fields from the Keen object.
+
 ##### 0.7.6
 + Explicitly require `CGI`.
 

data/keen.gemspec

@@ -5,7 +5,6 @@ require "keen/version"
 Gem::Specification.new do |s|
   s.name        = "keen"
   s.version     = Keen::VERSION
-  s.platform    = Gem::Platform::RUBY
   s.authors     = ["Kyle Wild", "Josh Dzielak", "Daniel Kador"]
   s.email       = "josh@keen.io"
   s.homepage    = "https://github.com/keenlabs/keen-gem"
@@ -15,6 +14,27 @@ Gem::Specification.new do |s|
   s.add_dependency "multi_json", "~> 1.0"
   s.add_dependency "jruby-openssl" if defined?(JRUBY_VERSION)
 
+  # guard
+  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 notifications
+  s.add_development_dependency 'ruby_gntp'
+
+  # fix guard prompt
+  s.add_development_dependency 'rb-readline' # or compile ruby w/ readline
+
+  # debuggers
+  if /\Aruby/ === RUBY_DESCRIPTION
+    s.add_development_dependency 'ruby-debug' if RUBY_VERSION.start_with? '1.8'
+    s.add_development_dependency 'debugger'   if RUBY_VERSION.start_with? '1.9'
+  end
+
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }

data/lib/keen.rb

@@ -29,8 +29,13 @@ module Keen
                    :project_id, :project_id=,
                    :write_key, :write_key=,
                    :read_key, :read_key=,
+                   :master_key, :master_key=,
                    :api_url, :api_url=
 
+    def_delegators :default_client,
+                   :proxy_url, :proxy_url=,
+                   :proxy_type, :proxy_type=
+
     def_delegators :default_client,
                    :publish, :publish_async, :publish_batch,
                    :beacon_url
@@ -61,7 +66,9 @@ module Keen
         :write_key => ENV['KEEN_WRITE_KEY'],
         :read_key => ENV['KEEN_READ_KEY'],
         :master_key => ENV['KEEN_MASTER_KEY'],
-        :api_url => ENV['KEEN_API_URL']
+        :api_url => ENV['KEEN_API_URL'],
+        :proxy_url => ENV['KEEN_PROXY_URL'],
+        :proxy_type => ENV['KEEN_PROXY_TYPE']
       )
     end
   end

data/lib/keen/client.rb

@@ -15,7 +15,7 @@ module Keen
     include Keen::Client::QueryingMethods
     include Keen::Client::MaintenanceMethods
 
-    attr_accessor :project_id, :write_key, :read_key, :master_key, :api_url
+    attr_accessor :project_id, :write_key, :read_key, :master_key, :api_url, :proxy_url, :proxy_type
 
     CONFIG = {
       :api_url => "https://api.keen.io",
@@ -47,6 +47,8 @@ module Keen
         :project_id, :write_key, :read_key, :master_key)
 
       self.api_url = options[:api_url] || CONFIG[:api_url]
+
+      self.proxy_url, self.proxy_type = options.values_at(:proxy_url, :proxy_type)
     end
 
     private

data/lib/keen/client/maintenance_methods.rb

@@ -16,7 +16,7 @@ module Keen
         query_params = preprocess_params(params) if params != {}
 
         begin
-          response = Keen::HTTP::Sync.new(self.api_url).delete(
+          response = Keen::HTTP::Sync.new(self.api_url, self.proxy_url).delete(
               :path => [api_event_collection_resource_path(event_collection), query_params].compact.join('?'),
               :headers => api_headers(self.master_key, "sync"))
         rescue Exception => http_error

data/lib/keen/client/publishing_methods.rb

@@ -63,7 +63,9 @@ module Keen
 
         deferrable = EventMachine::DefaultDeferrable.new
 
-        http_client = Keen::HTTP::Async.new(self.api_url)
+        http_client = Keen::HTTP::Async.new(
+            self.api_url,
+            {:proxy_url => self.proxy_url, :proxy_type => self.proxy_type})
         http = http_client.post(
           :path => api_event_collection_resource_path(event_collection),
           :headers => api_headers(self.write_key, "async"),
@@ -116,7 +118,7 @@ module Keen
       def publish_body(path, body, error_method)
         begin
           response = Keen::HTTP::Sync.new(
-            self.api_url).post(
+            self.api_url, self.proxy_url).post(
               :path => path,
               :headers => api_headers(self.write_key, "sync"),
               :body => body)

data/lib/keen/client/querying_methods.rb

@@ -171,7 +171,7 @@ module Keen
         query_params = preprocess_params(params)
 
         begin
-          response = Keen::HTTP::Sync.new(self.api_url).get(
+          response = Keen::HTTP::Sync.new(self.api_url, self.proxy_url).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,12 +1,21 @@
 module Keen
   module HTTP
     class Sync
-      def initialize(base_url)
+      def initialize(base_url, proxy_url=nil)
         require 'uri'
         require 'net/http'
 
         uri = URI.parse(base_url)
-        @http = Net::HTTP.new(uri.host, uri.port)
+        if proxy_url
+          proxy_uri = URI.parse(proxy_url)
+          @http = Net::HTTP::Proxy(
+              proxy_uri.host,
+              proxy_uri.port,
+              proxy_uri.user,
+              proxy_uri.password).new(uri.host, uri.port)
+        else
+          @http = Net::HTTP.new(uri.host, uri.port)
+        end
 
         if uri.scheme == "https"
           require 'net/https'
@@ -37,7 +46,7 @@ module Keen
     end
 
     class Async
-      def initialize(base_url)
+      def initialize(base_url, options={})
         if defined?(EventMachine) && EventMachine.reactor_running?
           require 'em-http-request'
         else
@@ -45,17 +54,29 @@ module Keen
         end
 
         @base_url = base_url
+        @proxy_url, @proxy_type = options.values_at(:proxy_url, :proxy_type)
       end
 
       def post(options)
         path, headers, body = options.values_at(
           :path, :headers, :body)
         uri = "#{@base_url}#{path}"
-        http_client = EventMachine::HttpRequest.new(uri)
+        if @proxy_url
+          proxy_uri = URI.parse(@proxy_url)
+          connection_options = {:proxy =>
+                                    {:host => proxy_uri.host,
+                                     :port => proxy_uri.port,
+                                     :authorization => [proxy_uri.user, proxy_uri.password],
+                                     :type => @proxy_type || "http"}}
+          http_client = EventMachine::HttpRequest.new(uri, connection_options)
+        else
+          http_client = EventMachine::HttpRequest.new(uri)
+        end
         http_client.post(
           :body => body,
           :head => headers
         )
+
       end
     end
   end

data/lib/keen/version.rb

@@ -1,3 +1,3 @@
 module Keen
-  VERSION = "0.7.6"
+  VERSION = "0.7.7"
 end

data/spec/keen/keen_spec.rb

@@ -8,7 +8,10 @@ describe Keen do
         ENV["KEEN_PROJECT_ID"] = "12345"
         ENV["KEEN_WRITE_KEY"] = "abcdewrite"
         ENV["KEEN_READ_KEY"] = "abcderead"
+        ENV["KEEN_MASTER_KEY"] = "lalalala"
         ENV["KEEN_API_URL"] = "http://fake.keen.io:fakeport"
+        ENV["KEEN_PROXY_URL"] = "http://proxy.keen.io:proxyport"
+        ENV["KEEN_PROXY_TYPE"] = "http"
       end
 
       let(:client) { Keen.send(:default_client) }
@@ -25,9 +28,21 @@ describe Keen do
         client.read_key.should == "abcderead"
       end
 
+      it "should set a master key from the environment" do
+        client.master_key.should == "lalalala"
+      end
+
       it "should set an api host from the environment" do
         client.api_url.should == "http://fake.keen.io:fakeport"
       end
+
+      it "should set an proxy host from the environment" do
+        client.proxy_url.should == "http://proxy.keen.io:proxyport"
+      end
+
+      it "should set an proxy type from the environment" do
+        client.proxy_type.should == "http"
+      end
     end
   end
 
@@ -48,14 +63,21 @@ describe Keen do
       Keen.stub(:default_client).and_return(@default_client)
     end
 
-    [:project_id, :write_key, :read_key, :api_url].each do |_method|
+    [:project_id, :write_key, :read_key, :api_url, :proxy_url, :proxy_type].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, :master_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=, :api_url=].each do |_method|
+    [:project_id=, :write_key=, :read_key=, :master_key=, :api_url=].each do |_method|
       it "should forward the #{_method} method" do
         @default_client.should_receive(_method).with("12345")
         Keen.send(_method, "12345")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: keen
 version: !ruby/object:Gem::Version
-  version: 0.7.6
+  version: 0.7.7
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-02 00:00:00.000000000 Z
+date: 2013-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -29,6 +29,134 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  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: 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-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-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: 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: 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: 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'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  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.
 email: josh@keen.io
 executables: []
@@ -39,7 +167,6 @@ files:
 - .rspec
 - .travis.yml
 - Gemfile
-- Gemfile.lock
 - Guardfile
 - LICENSE
 - README.md

data/Gemfile.lock

@@ -1,108 +0,0 @@
-PATH
-  remote: .
-  specs:
-    keen (0.7.5)
-      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)
-    json (1.7.7)
-    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.4)
-    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
-  json (~> 1.7.7)
-  keen!
-  rake
-  rb-fchange
-  rb-fsevent
-  rb-inotify
-  rb-readline
-  rspec
-  ruby-debug
-  ruby_gntp
-  webmock