Skip to content

Commit d362543

Browse files
committed
Rename EventTracker to EventHub.
1 parent bbddc47 commit d362543

File tree

9 files changed

+51
-49
lines changed

9 files changed

+51
-49
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,5 @@ tmp
2020
*.o
2121
*.a
2222
mkmf.log
23+
bundler/
24+
*.swp

Gemfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
source 'https://rubygems.org'
22

3-
# Specify your gem's dependencies in event_tracker_client.gemspec
3+
# Specify your gem's dependencies in event_hub_client.gemspec
44
gemspec

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,46 @@
1-
# EventTrackerClient
1+
# EventHubClient
22

3-
The EventTrackerClient gem is a simple wrapper of EventTracker HTTP APIs.
3+
The EventHubClient gem is a simple wrapper of EventHub HTTP APIs.
44

55
## Installation
66

77
Add this line to your application's Gemfile:
88

9-
gem 'event_tracker_client'
9+
gem 'event_hub_client'
1010

1111
And then execute:
1212

1313
$ bundle
1414

1515
Or install it yourself as:
1616

17-
$ gem install event_tracker_client
17+
$ gem install event_hub_client
1818

1919
## Usage
2020

21-
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 EventTracker can be found at https://github.com/Codecademy/EventTracker/
21+
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/
2222

2323
```ruby
24-
event_tracker_client = EventTrackerClient::EventTrackerClient.new(host, port, EventTrackerClient::Worker.new)
25-
event_tracker_client.track(event_type, user_id, event_properties)
26-
event_tracker_client.alias(from_id, to_id)
24+
event_hub_client = EventHubClient::EventHubClient.new(host, port, EventHubClient::Worker.new)
25+
event_hub_client.track(event_type, user_id, event_properties)
26+
event_hub_client.alias(from_id, to_id)
2727
```
2828

29-
If the throughput from EventTrackerClient::EventTrackerClient is not good enough, consider using EventTrackerClient::BatchEventTrackerClient which batch send the requests. Please notice that you need to explicitly flush the BatchEventTrackerClient 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 tracker server.
29+
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.
3030

3131
```ruby
32-
base_event_tracker_client = EventTrackerClient::EventTrackerClient.new(host, port, EventTrackerClient::Worker.new)
32+
base_event_hub_client = EventHubClient::EventHubClient.new(host, port, EventHubClient::Worker.new)
3333
queue = []
3434
batch_size = 10
35-
batch_event_tracker_client = EventTrackerClient::BatchEventTrackerClient.new(base_event_tracker_client, queue, batch_size)
36-
event_tracker_client.track(event_type, user_id, event_properties)
37-
event_tracker_client.alias(from_id, to_id)
38-
event_tracker_client.flush
35+
batch_event_hub_client = EventHubClient::BatchEventHubClient.new(base_event_hub_client, queue, batch_size)
36+
event_hub_client.track(event_type, user_id, event_properties)
37+
event_hub_client.alias(from_id, to_id)
38+
event_hub_client.flush
3939
```
4040

4141
## Contributing
4242

43-
1. Fork it ( https://github.com/Codecademy/event_tracker_client/fork )
43+
1. Fork it ( https://github.com/Codecademy/EventHubClient/fork )
4444
2. Create your feature branch (`git checkout -b my-new-feature`)
4545
3. Commit your changes (`git commit -am 'Add some feature'`)
4646
4. Push to the branch (`git push origin my-new-feature`)

event_tracker_client.gemspec renamed to event_hub_client.gemspec

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
# coding: utf-8
22
lib = File.expand_path('../lib', __FILE__)
33
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4-
require 'event_tracker_client/version'
4+
require 'event_hub_client/version'
55

66
Gem::Specification.new do |spec|
7-
spec.name = "event_tracker_client"
8-
spec.version = EventTrackerClient::VERSION
7+
spec.name = "event_hub_client"
8+
spec.version = EventHubClient::VERSION
99
spec.authors = ["Cheng-Tao Chu"]
1010
spec.email = ["chengtao@codecademy.com"]
11-
spec.summary = %q{Client for EventTracker.}
12-
spec.description = %q{More details of EventTracker available at http://github.com/Codecademy/EventTracker.}
11+
spec.summary = %q{Client for EventHub.}
12+
spec.description = %q{More details of EventHub available at http://github.com/Codecademy/EventHub.}
1313
spec.homepage = ""
1414
spec.license = "MIT"
1515

lib/event_tracker_client.rb renamed to lib/event_hub_client.rb

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
require "event_tracker_client/version"
1+
require "event_hub_client/version"
22
require "net/http"
33
require "typhoeus"
44
require 'json'
55

6-
module EventTrackerClient
6+
module EventHubClient
77
class Worker
88
def perform(url, body)
99
Typhoeus::Request.post(url, body: body)
1010
end
1111
end
1212

13-
class BatchEventTrackerClient
13+
class BatchEventHubClient
1414
attr_reader :client, :queue, :batch_size
1515

1616
def initialize(client, queue, batch_size)
@@ -30,7 +30,7 @@ def track(event_type, user_id, event_properties)
3030
@queue = []
3131
end
3232
end
33-
33+
3434
def flush
3535
client.send_request("events/batch_track", { "events" => queue.to_json })
3636
@queue = []
@@ -41,36 +41,36 @@ def alias(from_id, to_id)
4141
end
4242
end
4343

44-
class EventTrackerClient
44+
class EventHubClient
4545
attr_reader :host, :port, :worker
4646

4747
def initialize(host, port, worker)
4848
@host = host
4949
@port = port
5050
@worker = worker
5151
end
52-
52+
5353
def track(event_type, user_id, event_properties)
5454
path = "events/track"
55-
55+
5656
params = {}.merge(event_properties).merge({
5757
"event_type" => event_type,
5858
"external_user_id" => user_id,
5959
})
60-
60+
6161
send_request(path, params)
6262
end
63-
63+
6464
def alias(from_id, to_id)
6565
path = "users/alias"
6666
params = {
6767
"from_external_user_id" => from_id,
6868
"to_external_user_id" => to_id
6969
}
70-
70+
7171
send_request(path, params)
7272
end
73-
73+
7474
def send_request(path, body)
7575
worker.perform("http://#{@host}:#{@port}/#{path}", body)
7676
end

lib/event_hub_client/version.rb

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
module EventHubClient
2+
VERSION = "0.0.1"
3+
end

lib/event_tracker_client/version.rb

Lines changed: 0 additions & 3 deletions
This file was deleted.

spec/event_tracker_client_spec.rb renamed to spec/event_hub_client_spec.rb

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
require "spec_helper"
22

3-
describe EventTrackerClient do
3+
describe EventHubClient do
44
let(:host) { "localhost" }
55
let(:port) { 3000 }
66

7-
context "for BatchEventTrackerClient" do
7+
context "for BatchEventHubClient" do
88
let(:queue) { Array.new }
99
let(:batch_size) { 2 }
10-
let(:event_tracker_client) {
11-
EventTrackerClient::BatchEventTrackerClient.new(
12-
EventTrackerClient::EventTrackerClient.new(host, port, EventTrackerClient::Worker.new), queue, batch_size)
10+
let(:event_hub_client) {
11+
EventHubClient::BatchEventHubClient.new(
12+
EventHubClient::EventHubClient.new(host, port, EventHubClient::Worker.new), queue, batch_size)
1313
}
1414

1515
it "send direct http request when alias" do
@@ -21,7 +21,7 @@
2121
"from_external_user_id" => from_id,
2222
"to_external_user_id" => to_id
2323
}}).once
24-
event_tracker_client.alias(from_id, to_id)
24+
event_hub_client.alias(from_id, to_id)
2525
end
2626

2727
it "batch track requests" do
@@ -72,15 +72,15 @@
7272
}}).once
7373

7474
(0..4).each do |i|
75-
event_tracker_client.track(event_types[i], user_ids[i], event_properties[i])
75+
event_hub_client.track(event_types[i], user_ids[i], event_properties[i])
7676
end
77-
event_tracker_client.flush
77+
event_hub_client.flush
7878
end
7979
end
8080

81-
context "for EventTrackerClient" do
82-
let(:event_tracker_client) {
83-
EventTrackerClient::EventTrackerClient.new(host, port, EventTrackerClient::Worker.new)
81+
context "for EventHubClient" do
82+
let(:event_hub_client) {
83+
EventHubClient::EventHubClient.new(host, port, EventHubClient::Worker.new)
8484
}
8585

8686
it "send direct http request when alias" do
@@ -92,7 +92,7 @@
9292
"from_external_user_id" => from_id,
9393
"to_external_user_id" => to_id
9494
}}).once
95-
event_tracker_client.alias(from_id, to_id)
95+
event_hub_client.alias(from_id, to_id)
9696
end
9797

9898
it "send direct http request when track" do
@@ -106,7 +106,7 @@
106106
"external_user_id" => user_id,
107107
"foo" => "bar"
108108
}}).once
109-
event_tracker_client.track(event_type, user_id, event_properties)
109+
event_hub_client.track(event_type, user_id, event_properties)
110110
end
111111
end
112112
end

spec/spec_helper.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
require 'bundler/setup'
22
Bundler.setup
33

4-
require 'event_tracker_client'
4+
require 'event_hub_client'
55

66
RSpec.configure do |config|
77
end

0 commit comments

Comments
 (0)