amplitude-api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 481d091552b42dfbe151aa5e58e50dedf2436d38
+  data.tar.gz: 8b391658f981b64f12d0fd683f1cc996a215dd36
+SHA512:
+  metadata.gz: 6418d071d74f61e23b996c32a04929f70efe45a9df7ffd194f956214a855ab4a3033f90a43dd1726096b382833abf8bea45c4d319dca20fea6da621ebd0e24a4
+  data.tar.gz: 8b1324f82be861baf1e40e90e3e5ed861fffc5fbeac7fecc1b515849a7f240cdac8fc3491bf7159e660f9c9b5ae1ecbfb846236e96eeb0c1a2eee4b812dbf43e

data/.gitignore

@@ -0,0 +1,35 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.2.2
+  - 2.1.6

data/Gemfile

@@ -0,0 +1,9 @@
+# Generated from /Users/alex/development/amplitude-api/amplitude-api.gemspec
+source 'https://rubygems.org'
+gem "typhoeus", "~> 0.7.1"
+
+group :development do
+  gem "rspec", ">= 2.99.0"
+  gem "rake", ">= 10.0"
+  gem "pry", "~> 0.9.12.6"
+end

data/Gemfile.lock

@@ -0,0 +1,34 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    ethon (0.7.3)
+      ffi (>= 1.3.0)
+    ffi (1.9.8)
+    method_source (0.8.2)
+    pry (0.9.12.6)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rake (10.4.2)
+    rspec (2.99.0)
+      rspec-core (~> 2.99.0)
+      rspec-expectations (~> 2.99.0)
+      rspec-mocks (~> 2.99.0)
+    rspec-core (2.99.2)
+    rspec-expectations (2.99.2)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.99.3)
+    slop (3.5.0)
+    typhoeus (0.7.1)
+      ethon (>= 0.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pry (~> 0.9.12.6)
+  rake (>= 10.0)
+  rspec (>= 2.99.0)
+  typhoeus (~> 0.7.1)

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 alexander rakoczy
+
+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/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end
+
+task(:default).clear
+task :default => :spec

data/amplitude-api.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'amplitude-api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "amplitude-api"
+  spec.version       = AmplitudeAPI::VERSION
+  spec.authors       = ["Alex Rakoczy"]
+  spec.email         = ["arakoczy@gmail.com"]
+  spec.summary       = %q{Send events to the Amplitude API}
+  spec.description   = %q{Provides an integration for sending events to Amplitude}
+  spec.homepage      = "https://github.com/toothrot/amplitude-api"
+  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 "rspec", "~> 2.99", '>= 2.99.0'
+  spec.add_development_dependency "rake", "~> 10.0", '>= 10.0' 
+  spec.add_development_dependency "pry", "~> 0.9.12.6" 
+  spec.add_dependency "typhoeus", "~> 0.7.1"
+end

data/lib/amplitude-api.rb

@@ -0,0 +1,33 @@
+require 'json'
+require 'bundler/setup'
+Bundler.require(:default)
+require 'amplitude-api/event'
+
+class AmplitudeAPI
+  URI_STRING = "https://api.amplitude.com/httpapi"
+
+  USER_WITH_NO_ACCOUNT = "user who doesn't have an account"
+
+  class << self
+    attr_accessor :api_key
+
+    def send_event(event_name, user, properties = {})
+      event = AmplitudeAPI::Event.new(user_id: user, event_type: event_name, event_properties: properties)
+      track(event)
+    end
+
+    def body(*events)
+      event_body = events.flatten.map do |event|
+        event.to_hash
+      end
+      post_body = {
+        api_key: self.api_key,
+        event: JSON.generate(event_body)
+      }
+    end
+
+    def track(*events)
+      Typhoeus.post(URI_STRING, body: body(events))
+    end
+  end
+end

data/lib/amplitude-api/event.rb

@@ -0,0 +1,36 @@
+class AmplitudeAPI
+  class Event
+    attr_accessor :user_id, :event_type, :event_properties
+
+    def initialize(user_id: , event_type: , event_properties: {})
+      self.user_id = user_id
+      self.event_type = event_type
+      self.event_properties = event_properties
+    end
+
+    def user_id=(value)
+      @user_id = 
+        if value.respond_to?(:id)
+          value.id
+        else
+          value || AmplitudeAPI::USER_WITH_NO_ACCOUNT
+        end
+    end
+
+    def to_hash
+      {
+        event_type: self.event_type,
+        user_id: self.user_id,
+        event_properties: self.event_properties
+      }
+    end
+
+    def ==(other)
+      if other.respond_to?(:to_hash)
+        self.to_hash == other.to_hash
+      else
+        false
+      end
+    end
+  end
+end

data/lib/amplitude-api/version.rb

@@ -0,0 +1,3 @@
+class AmplitudeAPI
+  VERSION = '0.0.1'
+end

data/readme.md

@@ -0,0 +1,2 @@
+# Amplitude API
+[![Build Status](https://travis-ci.org/toothrot/amplitude-api.svg?branch=master)](https://travis-ci.org/toothrot/amplitude-api)

data/spec/lib/amplitude-api/event_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe AmplitudeAPI::Event do
+  User = Struct.new(:id)
+
+  context "with a user object" do
+    describe "#body" do
+      it "populates with the user's id" do
+        event = AmplitudeAPI::Event.new(user_id: User.new(123), event_type: 'clicked on home')
+        expect(event.to_hash[:user_id]).to eq(123)
+      end
+    end
+  end
+
+  context "with a user id" do
+    describe "#body" do
+      it "populates with the user's id" do
+        event = AmplitudeAPI::Event.new(user_id: 123, event_type: 'clicked on home')
+        expect(event.to_hash[:user_id]).to eq(123)
+      end
+    end
+  end
+
+  context "without a user" do
+    describe "#body" do
+      it "populates with the unknown user" do
+        event = AmplitudeAPI::Event.new(user_id: nil, event_type: 'clicked on home')
+        expect(event.to_hash[:user_id]).to eq(AmplitudeAPI::USER_WITH_NO_ACCOUNT)
+      end
+    end
+  end
+
+  describe '#body' do
+    it "includes the event type" do
+      event = AmplitudeAPI::Event.new(user_id: 123, event_type: 'clicked on home')
+      expect(event.to_hash[:event_type]).to eq('clicked on home')
+    end
+
+    it "includes arbitrary properties" do
+      event = AmplitudeAPI::Event.new(user_id: 123, event_type: 'clicked on home', event_properties: {abc: :def})
+      expect(event.to_hash[:event_properties]).to eq(abc: :def)
+    end
+  end
+end

data/spec/lib/amplitude_api_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+describe AmplitudeAPI do
+  before do
+    @user = Struct.new(:id).new(123)
+  end
+
+  describe ".track" do
+    context "with a single event" do
+      it "sends the event to Amplitude" do
+        event = AmplitudeAPI::Event.new(user_id: 123, event_type: 'clicked on sign up')
+        body = {api_key: AmplitudeAPI.api_key, event: JSON.generate([event.to_hash])}
+
+        expect(Typhoeus).to receive(:post).with(AmplitudeAPI::URI_STRING, body: body)
+
+        AmplitudeAPI.track(event)
+      end
+    end
+
+    context "with multiple events" do
+      it "sends all events in a single request" do
+        event = AmplitudeAPI::Event.new(user_id: 123, event_type: 'clicked on sign up')
+        event2 = AmplitudeAPI::Event.new(user_id: 456, event_type: 'liked a widget')
+        body = {api_key: AmplitudeAPI.api_key, event: JSON.generate([event.to_hash, event2.to_hash])}
+
+        expect(Typhoeus).to receive(:post).with(AmplitudeAPI::URI_STRING, body: body)
+
+        AmplitudeAPI.track([event, event2])
+      end
+    end
+  end
+
+  describe ".send_event" do
+    it "sends an event to AmplitudeAPI" do
+      event = AmplitudeAPI::Event.new(user_id: @user, event_type: "test_event", event_properties: {test_property: 1})
+      expect(AmplitudeAPI).to receive(:track).with(event)
+
+      AmplitudeAPI.send_event("test_event", @user, test_property: 1)
+    end
+
+    context "the user is nil" do
+      it "sends an event with the no account user" do
+        event = AmplitudeAPI::Event.new(user_id: nil, event_type: "test_event", event_properties: {test_property: 1})
+        expect(AmplitudeAPI).to receive(:track).with(event)
+
+        AmplitudeAPI.send_event("test_event", nil, test_property: 1)
+      end
+    end
+
+    context "the user is a user_id" do
+      it "sends an event to AmplitudeAPI" do
+        event = AmplitudeAPI::Event.new(user_id: 123, event_type: "test_event", event_properties: {test_property: 1})
+        expect(AmplitudeAPI).to receive(:track).with(event)
+
+        AmplitudeAPI.send_event("test_event", @user.id, test_property: 1)
+      end
+    end
+  end
+
+  describe "#body" do
+    it "should add an api key" do
+      event = AmplitudeAPI::Event.new(user_id: @user, event_type: "test_event", event_properties: {test_property: 1})
+      body = AmplitudeAPI.body(event)
+      expect(body[:api_key]).to eq('stub api key')
+    end
+
+    it "should create an event" do
+      event = AmplitudeAPI::Event.new(user_id: 23, event_type: "test_event", event_properties: {foo: "bar"})
+      body = AmplitudeAPI.body(event)
+
+      expected = JSON.generate([{event_type: "test_event", user_id: 23, event_properties: {foo: "bar"}}])
+      expect(body[:event]).to eq(expected)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+require File.expand_path(File.join('..', '..', 'lib', 'amplitude-api'), __FILE__)
+require 'pry'
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+
+  config.before(:suite) do
+    AmplitudeAPI.api_key = 'stub api key'
+  end
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: amplitude-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alex Rakoczy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.99'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.99.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.99'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.99.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.12.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.12.6
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+description: Provides an integration for sending events to Amplitude
+email:
+- arakoczy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- Rakefile
+- amplitude-api.gemspec
+- lib/amplitude-api.rb
+- lib/amplitude-api/event.rb
+- lib/amplitude-api/version.rb
+- readme.md
+- spec/lib/amplitude-api/event_spec.rb
+- spec/lib/amplitude_api_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/toothrot/amplitude-api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Send events to the Amplitude API
+test_files:
+- spec/lib/amplitude-api/event_spec.rb
+- spec/lib/amplitude_api_spec.rb
+- spec/spec_helper.rb