event_hub_client 0.0.1

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+bundler/
+*.swp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in event_hub_client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Cheng-Tao Chu
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,47 @@
+# EventHubClient
+
+The EventHubClient gem is a simple wrapper of EventHub HTTP APIs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'event_hub_client'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install event_hub_client
+
+## Usage
+
+By the nature of the gem is supposed be used from the backend, The gem only supports two apis, track and alias. More details of about EventHub can be found at https://github.com/Codecademy/EventHub/
+
+```ruby
+event_hub_client = EventHubClient::EventHubClient.new(host, port, EventHubClient::Worker.new)
+event_hub_client.track(event_type, user_id, event_properties)
+event_hub_client.alias(from_id, to_id)
+```
+
+If the throughput from EventHubClient::EventHubClient is not good enough, consider using EventHubClient::BatchEventHubClient which batch send the requests. Please notice that you need to explicitly flush the BatchEventHubClient when your service is shutting down or there might be events buffered in the queue and those events might not get sent to the event hub server.
+
+```ruby
+base_event_hub_client = EventHubClient::EventHubClient.new(host, port, EventHubClient::Worker.new)
+queue = []
+batch_size = 10
+batch_event_hub_client = EventHubClient::BatchEventHubClient.new(base_event_hub_client, queue, batch_size)
+event_hub_client.track(event_type, user_id, event_properties)
+event_hub_client.alias(from_id, to_id)
+event_hub_client.flush
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/Codecademy/EventHubClient/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/event_hub_client.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'event_hub_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "event_hub_client"
+  spec.version       = EventHubClient::VERSION
+  spec.authors       = ["Cheng-Tao Chu"]
+  spec.email         = ["chengtao@codecademy.com"]
+  spec.summary       = %q{Client for EventHub.}
+  spec.description   = %q{More details of EventHub available at http://github.com/Codecademy/EventHub.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "typhoeus"
+end

data/lib/event_hub_client/version.rb

@@ -0,0 +1,3 @@
+module EventHubClient
+  VERSION = "0.0.1"
+end

data/lib/event_hub_client.rb

@@ -0,0 +1,78 @@
+require "event_hub_client/version"
+require "net/http"
+require "typhoeus"
+require 'json'
+
+module EventHubClient
+  class Worker
+    def perform(url, body)
+      Typhoeus::Request.post(url, body: body)
+    end
+  end
+
+  class BatchEventHubClient
+    attr_reader :client, :queue, :batch_size
+
+    def initialize(client, queue, batch_size)
+      @client = client
+      @queue = queue
+      @batch_size = batch_size
+    end
+
+    def track(event_type, user_id, event_properties)
+      params = {}.merge(event_properties).merge({
+        "event_type" => event_type,
+        "external_user_id" => user_id,
+      })
+      queue.push(params)
+      if queue.size % batch_size == 0
+        client.send_request("events/batch_track", { "events" => queue.to_json })
+        @queue = []
+      end
+    end
+
+    def flush
+      client.send_request("events/batch_track", { "events" => queue.to_json })
+      @queue = []
+    end
+
+    def alias(from_id, to_id)
+      client.alias(from_id, to_id)
+    end
+  end
+
+  class EventHubClient
+    attr_reader :host, :port, :worker
+
+    def initialize(host, port, worker)
+      @host = host
+      @port = port
+      @worker = worker
+    end
+
+    def track(event_type, user_id, event_properties)
+      path = "events/track"
+
+      params = {}.merge(event_properties).merge({
+        "event_type" => event_type,
+        "external_user_id" => user_id,
+      })
+
+      send_request(path, params)
+    end
+
+    def alias(from_id, to_id)
+      path = "users/alias"
+      params = {
+        "from_external_user_id" => from_id,
+        "to_external_user_id" => to_id
+      }
+
+      send_request(path, params)
+    end
+
+    def send_request(path, body)
+      worker.perform("http://#{@host}:#{@port}/#{path}", body)
+    end
+  end
+end

data/spec/event_hub_client_spec.rb

@@ -0,0 +1,112 @@
+require "spec_helper"
+
+describe EventHubClient do
+  let(:host) { "localhost" }
+  let(:port) { 3000 }
+
+  context "for BatchEventHubClient" do
+    let(:queue) { Array.new }
+    let(:batch_size) { 2 }
+    let(:event_hub_client) {
+      EventHubClient::BatchEventHubClient.new(
+        EventHubClient::EventHubClient.new(host, port, EventHubClient::Worker.new), queue, batch_size)
+    }
+
+    it "send direct http request when alias" do
+      from_id = "hello"
+      to_id = "bar"
+
+      expect(Typhoeus::Request).to receive(:post).with("http://#{host}:#{port}/users/alias", { 
+        :body => { 
+          "from_external_user_id" => from_id,
+          "to_external_user_id" => to_id
+      }}).once
+      event_hub_client.alias(from_id, to_id)
+    end
+
+    it "batch track requests" do
+      event_types = [ "TYPE1", "TYPE2", "TYPE3", "TYPE4", "TYPE5" ]
+      user_ids = [ "foo1", "foo2", "foo3", "foo4", "foo5" ]
+      event_properties = [
+        { "foo1" => "bar1" },
+        { "foo2" => "bar2" },
+        { "foo3" => "bar3" },
+        { "foo4" => "bar4" },
+        { "foo5" => "bar5" },
+      ]
+  
+      expect(Typhoeus::Request).to receive(:post).with("http://#{host}:#{port}/events/batch_track", { 
+        :body => { 
+          "events" => [
+              {
+                "foo1" => "bar1",
+                "event_type" => event_types[0],
+                "external_user_id" => user_ids[0],
+              }, {
+                "foo2" => "bar2",
+                "event_type" => event_types[1],
+                "external_user_id" => user_ids[1],
+              }].to_json
+      }}).once
+      expect(Typhoeus::Request).to receive(:post).with("http://#{host}:#{port}/events/batch_track", { 
+        :body => { 
+          "events" => [
+              {
+                "foo3" => "bar3",
+                "event_type" => event_types[2],
+                "external_user_id" => user_ids[2],
+              }, {
+                "foo4" => "bar4",
+                "event_type" => event_types[3],
+                "external_user_id" => user_ids[3],
+              }].to_json
+      }}).once
+      expect(Typhoeus::Request).to receive(:post).with("http://#{host}:#{port}/events/batch_track", { 
+        :body => { 
+          "events" => [
+              {
+                "foo5" => "bar5",
+                "event_type" => event_types[4],
+                "external_user_id" => user_ids[4],
+              }].to_json
+      }}).once
+
+      (0..4).each do |i|
+        event_hub_client.track(event_types[i], user_ids[i], event_properties[i])
+      end
+      event_hub_client.flush
+    end
+  end
+
+  context "for EventHubClient" do
+    let(:event_hub_client) {
+      EventHubClient::EventHubClient.new(host, port, EventHubClient::Worker.new)
+    }
+
+    it "send direct http request when alias" do
+      from_id = "hello"
+      to_id = "bar"
+
+      expect(Typhoeus::Request).to receive(:post).with("http://#{host}:#{port}/users/alias", { 
+        :body => { 
+          "from_external_user_id" => from_id,
+          "to_external_user_id" => to_id
+      }}).once
+      event_hub_client.alias(from_id, to_id)
+    end
+
+    it "send direct http request when track" do
+      event_type = "TYPE"
+      user_id = "chengtao@codeecademy.com"
+      event_properties = { "foo" => "bar" }
+  
+      expect(Typhoeus::Request).to receive(:post).with("http://#{host}:#{port}/events/track", { 
+        :body => { 
+          "event_type" => event_type,
+          "external_user_id" => user_id,
+          "foo" => "bar"
+      }}).once
+      event_hub_client.track(event_type, user_id, event_properties)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'event_hub_client'
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: event_hub_client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Cheng-Tao Chu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: 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: typhoeus
+  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: More details of EventHub available at http://github.com/Codecademy/EventHub.
+email:
+- chengtao@codecademy.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- event_hub_client.gemspec
+- lib/event_hub_client.rb
+- lib/event_hub_client/version.rb
+- spec/event_hub_client_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3766524776493520849
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3766524776493520849
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Client for EventHub.
+test_files:
+- spec/event_hub_client_spec.rb
+- spec/spec_helper.rb