amplitude-api 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a052a8eba1f08e0c286851d27a6bf2ce7e93cabe
-  data.tar.gz: 420237d4d92990243c11fce24998ba314178258d
+  metadata.gz: 9fa498ab2765d7b0e14d78aacd3caf34d212abde
+  data.tar.gz: c2cf793047298e2d0679c2ec748eae6d9ae46727
 SHA512:
-  metadata.gz: 19691aa9910e89f15bab32bf9ea73a3f051a8a50d6340cee1ab7e6e0d6fef1874c7cc23f80fb838773b32b6072479b9843813655875ed77d9fb2c0d2198a72cb
-  data.tar.gz: 36882567908c18fba0cd0b1a2f4a60b389bf84a7c2c9610b89bd7622674e79437687f7c52f25bd3841659412a0e761b794e5deaddc9e2ddb22f27025e8f66d95
+  metadata.gz: b73383081f15f0bca95841663f0d58b9bcf863c5a183b18b52400a3148d406721ba21dd8fc6ffaf3ff1debfffe86475d25eee9b623766ac31052579526536416
+  data.tar.gz: 9bada553602d018841b12bbd6836f338971359316d3852fe4147e08f4b9d8f35918f221e8bfa59cedc877c673b76714c43c9dd3b98ffa9cf9adc82d60ab9fd76

data/.gitignore

@@ -33,3 +33,5 @@ build/
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
+
+.idea

data/.rubocop.yml

@@ -0,0 +1,2 @@
+Metrics/LineLength:
+  Max: 120

data/Gemfile

@@ -1,9 +1,11 @@
 # 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"
+gem 'typhoeus', '~> 0.7.1'
+
+group :development, :test do
+  gem 'pry', '~> 0.9.12.6'
+  gem 'rake', '>= 10.0'
+  gem 'rspec', '>= 2.99.0'
+  gem 'rubocop', '~> 0.37.2', require: false
 end

data/Gemfile.lock

@@ -1,16 +1,21 @@
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.2.0)
     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)
+    parser (2.3.0.6)
+      ast (~> 2.2)
+    powerpack (0.1.1)
     pry (0.9.12.6)
       coderay (~> 1.0)
       method_source (~> 0.8)
       slop (~> 3.4)
+    rainbow (2.1.0)
     rake (10.4.2)
     rspec (2.99.0)
       rspec-core (~> 2.99.0)
@@ -20,9 +25,17 @@ GEM
     rspec-expectations (2.99.2)
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.99.3)
+    rubocop (0.37.2)
+      parser (>= 2.3.0.4, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 0.3)
+    ruby-progressbar (1.7.5)
     slop (3.5.0)
     typhoeus (0.7.1)
       ethon (>= 0.7.1)
+    unicode-display_width (0.3.1)
 
 PLATFORMS
   ruby
@@ -31,4 +44,8 @@ DEPENDENCIES
   pry (~> 0.9.12.6)
   rake (>= 10.0)
   rspec (>= 2.99.0)
+  rubocop (~> 0.37.2)
   typhoeus (~> 0.7.1)
+
+BUNDLED WITH
+   1.10.6

data/Rakefile

@@ -1,10 +1,14 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
 
 begin
   require 'rspec/core/rake_task'
   RSpec::Core::RakeTask.new(:spec)
 rescue LoadError
+  puts 'Unable to load rspec. Have you run `bundle install`?'
 end
 
 task(:default).clear
-task :default => :spec
+task default: ['rubocop:auto_correct', :spec]

data/amplitude-api.gemspec

@@ -1,26 +1,26 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'amplitude-api/version'
+require 'amplitude_api/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "amplitude-api"
+  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.authors       = ['Alex Rakoczy']
+  spec.email         = ['arakoczy@gmail.com']
+  spec.summary       = 'Send events to the Amplitude API'
+  spec.description   = '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.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"
+  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'
   spec.required_ruby_version = '~> 2.0'
 end

data/lib/amplitude-api.rb

@@ -1,109 +1,4 @@
-require 'json'
-require 'bundler/setup'
-require 'typhoeus'
-require 'amplitude-api/event'
-require 'amplitude-api/identification'
-
-class AmplitudeAPI
-  TRACK_URI_STRING = "https://api.amplitude.com/httpapi"
-  IDENTIFY_URI_STRING = "https://api.amplitude.com/identify"
-
-  USER_WITH_NO_ACCOUNT = "user who doesn't have an account"
-
-  class << self
-    # @!attribute [ rw ] api_key
-    #   @return [ String ] an Amplitude API Key
-    attr_accessor :api_key
-
-    # ==== Event Tracking related methods
-
-    # Send a single event immediately to the AmplitudeAPI
-    #
-    # @param [ String ] event_name a string that describes the event, e.g. "clicked on Home"
-    # @param [ String ] user a string or integer that uniquely identifies a user.
-    # @param [ Hash ] properties a hash that is serialized to JSON, and can contain any other property to be stored on the Event
-    #
-    # @return [ Typhoeus::Response ]
-    def send_event(event_name, user, properties = {})
-      event = AmplitudeAPI::Event.new(user_id: user, event_type: event_name, event_properties: properties)
-      track(event)
-    end
-
-
-    # @overload track_body(event)
-    #   @param [ AmplitudeAPI::Event ]
-    #
-    # @overload track_body([events])
-    #   @param [ Array<AmplitudeAPI::Event> ]
-    #
-    # @return [ Hash ]
-    #
-    # Converts a series of AmplitudeAPI::Event objects into a body
-    # suitable for the Amplitude API
-    def track_body(*events)
-      event_body = events.flatten.map do |event|
-        event.to_hash
-      end
-
-      {
-        api_key: self.api_key,
-        event: JSON.generate(event_body)
-      }
-    end
-
-
-    # @overload track(event)
-    #   @param [ AmplitudeAPI::Event ] Send a single event to the Amplitude API
-    #
-    # @overload track([events])
-    #   @param [ Array<AmplitudeAPI::Event> ] Send an array of events in a single request to Amplitude
-    #
-    # @return [ Typhoeus::Response ]
-    #
-    # Send one or more Events to the Amplitude API
-    def track(*events)
-      Typhoeus.post(TRACK_URI_STRING, body: track_body(events))
-    end
-
-    # ==== Identification related methods
-
-    def send_identify(user_id, user_properties = {})
-      identification = AmplitudeAPI::Identification.new(user_id: user_id, user_properties: user_properties)
-      identify(identification)
-    end
-
-    # @overload identify_body(identification)
-    #   @param [ AmplitudeAPI::Identification ]
-    #
-    # @overload identify_body([identifications])
-    #   @param [ Array<AmplitudeAPI::Identification> ]
-    #
-    # @return [ Hash ]
-    #
-    # Converts a series of AmplitudeAPI::Identification objects into a body
-    # suitable for the Amplitude Identify API
-    def identify_body(*identifications)
-      identification_body = identifications.flatten.map do |identification|
-        identification.to_hash
-      end
-
-      {
-        api_key: self.api_key,
-        identification: JSON.generate(identification_body)
-      }
-    end
-
-    # @overload identify(identification)
-    #   @param [ AmplitudeAPI::Identify ] Send a single identify to the Amplitude API
-    #
-    # @overload identify([identifications])
-    #   @param [ Array<AmplitudeAPI::Identify> ] Send an array of identifications in a single request to Amplitude
-    #
-    # @return [ Typhoeus::Response ]
-    #
-    # Send one or more Identifications to the Amplitude Identify API
-    def identify(*identifications)
-      Typhoeus.post(IDENTIFY_URI_STRING, body: identify_body(identifications))
-    end
-  end
-end
+# rubocop:disable Style/FileName
+require_relative 'amplitude_api'
+# rubocop:enable Style/FileName
+# Whoops.

data/lib/amplitude_api.rb

@@ -0,0 +1,109 @@
+require 'json'
+require 'bundler/setup'
+require 'typhoeus'
+require_relative 'amplitude_api/event'
+require_relative 'amplitude_api/identification'
+
+# AmplitudeAPI
+class AmplitudeAPI
+  TRACK_URI_STRING = 'https://api.amplitude.com/httpapi'.freeze
+  IDENTIFY_URI_STRING = 'https://api.amplitude.com/identify'.freeze
+
+  USER_WITH_NO_ACCOUNT = "user who doesn't have an account".freeze
+
+  class << self
+    # @!attribute [ rw ] api_key
+    #   @return [ String ] an Amplitude API Key
+    attr_accessor :api_key
+
+    # ==== Event Tracking related methods
+
+    # Send a single event immediately to the AmplitudeAPI
+    #
+    # @param [ String ] event_name a string that describes the event, e.g. "clicked on Home"
+    # @param [ String ] user a string or integer that uniquely identifies a user.
+    # @param [ Hash ] properties a hash that is serialized to JSON,
+    # and can contain any other property to be stored on the Event
+    #
+    # @return [ Typhoeus::Response ]
+    def send_event(event_name, user, properties = {})
+      event = AmplitudeAPI::Event.new(
+        user_id: user,
+        event_type: event_name,
+        event_properties: properties
+      )
+      track(event)
+    end
+
+    # @overload track_body(event)
+    #   @param [ AmplitudeAPI::Event ]
+    #
+    # @overload track_body([events])
+    #   @param [ Array<AmplitudeAPI::Event> ]
+    #
+    # @return [ Hash ]
+    #
+    # Converts a series of AmplitudeAPI::Event objects into a body
+    # suitable for the Amplitude API
+    def track_body(*events)
+      event_body = events.flatten.map(&:to_hash)
+
+      {
+        api_key: api_key,
+        event: JSON.generate(event_body)
+      }
+    end
+
+    # @overload track(event)
+    #   @param [ AmplitudeAPI::Event ] Send a single event to the Amplitude API
+    #
+    # @overload track([events])
+    #   @param [ Array<AmplitudeAPI::Event> ] Send an array of events in a single request to Amplitude
+    #
+    # @return [ Typhoeus::Response ]
+    #
+    # Send one or more Events to the Amplitude API
+    def track(*events)
+      Typhoeus.post(TRACK_URI_STRING, body: track_body(events))
+    end
+
+    # ==== Identification related methods
+
+    def send_identify(user_id, user_properties = {})
+      identification = AmplitudeAPI::Identification.new(user_id: user_id, user_properties: user_properties)
+      identify(identification)
+    end
+
+    # @overload identify_body(identification)
+    #   @param [ AmplitudeAPI::Identification ]
+    #
+    # @overload identify_body([identifications])
+    #   @param [ Array<AmplitudeAPI::Identification> ]
+    #
+    # @return [ Hash ]
+    #
+    # Converts a series of AmplitudeAPI::Identification objects into a body
+    # suitable for the Amplitude Identify API
+    def identify_body(*identifications)
+      identification_body = identifications.flatten.map(&:to_hash)
+
+      {
+        api_key: api_key,
+        identification: JSON.generate(identification_body)
+      }
+    end
+
+    # @overload identify(identification)
+    #   @param [ AmplitudeAPI::Identify ] Send a single identify to the Amplitude API
+    #
+    # @overload identify([identifications])
+    #   @param [ Array<AmplitudeAPI::Identify> ] Send an array of identifications in a single request to Amplitude
+    #
+    # @return [ Typhoeus::Response ]
+    #
+    # Send one or more Identifications to the Amplitude Identify API
+    def identify(*identifications)
+      Typhoeus.post(IDENTIFY_URI_STRING, body: identify_body(identifications))
+    end
+  end
+end

data/lib/{amplitude-api → amplitude_api}/event.rb

@@ -1,4 +1,5 @@
 class AmplitudeAPI
+  # AmplitudeAPI::Event
   class Event
     # @!attribute [ rw ] user_id
     #   @return [ String ] the user_id to be sent to Amplitude
@@ -9,16 +10,21 @@ class AmplitudeAPI
     # @!attribute [ rw ] event_properties
     #   @return [ String ] the event_properties to be attached to the Amplitude Event
     attr_accessor :event_properties
+    # @!attribute [ rw ] time
+    #   @return [ Time ] Time that the event occurred (defaults to now)
+    attr_accessor :time
 
     # Create a new Event
     #
     # @param [ String ] user_id a user_id to associate with the event
     # @param [ String ] event_type a name for the event
     # @param [ Hash ] event_properties various properties to attach to the event
-    def initialize(user_id: "" , event_type: "", event_properties: {})
+    # @param [ Time ] Time that the event occurred (defaults to now)
+    def initialize(user_id: '', event_type: '', event_properties: {}, time: nil)
       self.user_id = user_id
       self.event_type = event_type
       self.event_properties = event_properties
+      self.time = time
     end
 
     def user_id=(value)
@@ -34,11 +40,12 @@ class AmplitudeAPI
     #
     # Used for serialization and comparison
     def to_hash
-      {
-        event_type: self.event_type,
-        user_id: self.user_id,
-        event_properties: self.event_properties
-      }
+      serialized_event = {}
+      serialized_event[:event_type] = event_type
+      serialized_event[:user_id] = user_id
+      serialized_event[:event_properties] = event_properties
+      serialized_event[:time] = formatted_time if time
+      serialized_event
     end
 
     # @return [ true, false ]
@@ -46,10 +53,16 @@ class AmplitudeAPI
     # Compares +to_hash+ for equality
     def ==(other)
       if other.respond_to?(:to_hash)
-        self.to_hash == other.to_hash
+        to_hash == other.to_hash
       else
         false
       end
     end
+
+    private
+
+    def formatted_time
+      time.to_i * 1_000
+    end
   end
 end

data/lib/{amplitude-api → amplitude_api}/identification.rb

@@ -1,4 +1,5 @@
 class AmplitudeAPI
+  # AmplitudeAPI::Identification
   class Identification
     # @!attribute [ rw ] user_id
     #   @return [ String ] the user_id to be sent to Amplitude
@@ -11,7 +12,7 @@ class AmplitudeAPI
     #
     # @param [ String ] user_id a user_id to associate with the identification
     # @param [ Hash ] user_properties various properties to attach to the user identification
-    def initialize(user_id: "", user_properties: {})
+    def initialize(user_id: '', user_properties: {})
       self.user_id = user_id
       self.user_properties = user_properties
     end
@@ -30,8 +31,8 @@ class AmplitudeAPI
     # Used for serialization and comparison
     def to_hash
       {
-        user_id: self.user_id,
-        user_properties: self.user_properties
+        user_id: user_id,
+        user_properties: user_properties
       }
     end
 
@@ -40,7 +41,7 @@ class AmplitudeAPI
     # Compares +to_hash+ for equality
     def ==(other)
       if other.respond_to?(:to_hash)
-        self.to_hash == other.to_hash
+        to_hash == other.to_hash
       else
         false
       end

data/lib/amplitude_api/version.rb

@@ -0,0 +1,3 @@
+class AmplitudeAPI
+  VERSION = '0.0.5'.freeze
+end

data/readme.md

@@ -18,7 +18,7 @@ AmplitudeAPI.api_key = "abcdef123456"
 
 event = AmplitudeAPI::Event.new({
   user_id: "123",
-  event_type: "clicked on Home",
+  event_type: "clicked on home",
   event_properties: {
     cause: "button",
     arbitrary: "properties"

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

@@ -3,42 +3,76 @@ require 'spec_helper'
 describe AmplitudeAPI::Event do
   User = Struct.new(:id)
 
-  context "with a user object" do
-    describe "#body" do
+  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')
+        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
+  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')
+        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')
+  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')
+    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})
+    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
+
+    it 'includes a time for the event' do
+      time = Time.parse('2016-01-01 00:00:00 -0000')
+      event = AmplitudeAPI::Event.new(
+        user_id: 123,
+        event_type: 'clicked on home',
+        time: time
+      )
+      expect(event.to_hash[:time]).to eq(1_451_606_400_000)
+    end
+
+    it 'does not include time if it is not set' do
+      event = AmplitudeAPI::Event.new(
+        user_id: 123,
+        event_type: 'clicked on home'
+      )
+      expect(event.to_hash).not_to have_key(:time)
+    end
   end
 end

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

@@ -3,8 +3,8 @@ require 'spec_helper'
 describe AmplitudeAPI::Identification do
   User = Struct.new(:id)
 
-  context "with a user object" do
-    describe "#body" do
+  context 'with a user object' do
+    describe '#body' do
       it "populates with the user's id" do
         identification = AmplitudeAPI::Identification.new(user_id: User.new(123))
         expect(identification.to_hash[:user_id]).to eq(123)
@@ -12,8 +12,8 @@ describe AmplitudeAPI::Identification do
     end
   end
 
-  context "with a user id" do
-    describe "#body" do
+  context 'with a user id' do
+    describe '#body' do
       it "populates with the user's id" do
         identification = AmplitudeAPI::Identification.new(user_id: 123)
         expect(identification.to_hash[:user_id]).to eq(123)
@@ -21,9 +21,9 @@ describe AmplitudeAPI::Identification do
     end
   end
 
-  context "without a user" do
-    describe "#body" do
-      it "populates with the unknown user" do
+  context 'without a user' do
+    describe '#body' do
+      it 'populates with the unknown user' do
         identification = AmplitudeAPI::Identification.new(user_id: nil)
         expect(identification.to_hash[:user_id]).to eq(AmplitudeAPI::USER_WITH_NO_ACCOUNT)
       end
@@ -31,13 +31,19 @@ describe AmplitudeAPI::Identification do
   end
 
   describe '#body' do
-    it "includes the user id" do
+    it 'includes the user id' do
       identification = AmplitudeAPI::Identification.new(user_id: 123)
       expect(identification.to_hash[:user_id]).to eq(123)
     end
 
-    it "includes arbitrary user properties" do
-      identification = AmplitudeAPI::Identification.new(user_id: 123, user_properties: {first_name: 'John', last_name: 'Doe'})
+    it 'includes arbitrary user properties' do
+      identification = AmplitudeAPI::Identification.new(
+        user_id: 123,
+        user_properties: {
+          first_name: 'John',
+          last_name: 'Doe'
+        }
+      )
       expect(identification.to_hash[:user_properties]).to eq(first_name: 'John', last_name: 'Doe')
     end
   end

data/spec/lib/amplitude_api_spec.rb

@@ -5,11 +5,17 @@ describe AmplitudeAPI 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])}
+  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::TRACK_URI_STRING, body: body)
 
@@ -17,11 +23,20 @@ describe AmplitudeAPI do
       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])}
+    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::TRACK_URI_STRING, body: body)
 
@@ -30,11 +45,20 @@ describe AmplitudeAPI do
     end
   end
 
-  describe ".identify" do
-    context "with a single identification" do
-      it "sends the identification to Amplitude" do
-        identification = AmplitudeAPI::Identification.new(user_id: 123, user_properties: {first_name: 'John', last_name: 'Doe'})
-        body = {api_key: AmplitudeAPI.api_key, identification: JSON.generate([identification.to_hash])}
+  describe '.identify' do
+    context 'with a single identification' do
+      it 'sends the identification to Amplitude' do
+        identification = AmplitudeAPI::Identification.new(
+          user_id: 123,
+          user_properties: {
+            first_name: 'John',
+            last_name: 'Doe'
+          }
+        )
+        body = {
+          api_key: AmplitudeAPI.api_key,
+          identification: JSON.generate([identification.to_hash])
+        }
 
         expect(Typhoeus).to receive(:post).with(AmplitudeAPI::IDENTIFY_URI_STRING, body: body)
 
@@ -42,11 +66,26 @@ describe AmplitudeAPI do
       end
     end
 
-    context "with multiple identifications" do
-      it "sends all identifications in a single request" do
-        identification = AmplitudeAPI::Identification.new(user_id: 123, user_properties: {first_name: 'Julian', last_name: 'Ponce'})
-        identification2 = AmplitudeAPI::Identification.new(user_id: 456, user_properties: {first_name: 'John', last_name: 'Doe'})
-        body = {api_key: AmplitudeAPI.api_key, identification: JSON.generate([identification.to_hash, identification2.to_hash])}
+    context 'with multiple identifications' do
+      it 'sends all identifications in a single request' do
+        identification = AmplitudeAPI::Identification.new(
+          user_id: 123,
+          user_properties: {
+            first_name: 'Julian',
+            last_name: 'Ponce'
+          }
+        )
+        identification2 = AmplitudeAPI::Identification.new(
+          user_id: 456,
+          user_properties: {
+            first_name: 'John',
+            last_name: 'Doe'
+          }
+        )
+        body = {
+          api_key: AmplitudeAPI.api_key,
+          identification: JSON.generate([identification.to_hash, identification2.to_hash])
+        }
 
         expect(Typhoeus).to receive(:post).with(AmplitudeAPI::IDENTIFY_URI_STRING, body: body)
 
@@ -55,92 +94,150 @@ describe AmplitudeAPI do
     end
   end
 
-  describe ".initializer " do
-    it "initializes event without parameter" do
-      event = AmplitudeAPI::Event.new()
-      expect(event.to_hash).to eq({
-        event_type: "",
-        user_id: "",
+  describe '.initializer ' do
+    it 'initializes event without parameter' do
+      event = AmplitudeAPI::Event.new
+      expect(event.to_hash).to eq(
+        event_type: '',
+        user_id: '',
         event_properties: {}
-      })
+      )
     end
 
-    it "initializes event with parameter" do
-      event = AmplitudeAPI::Event.new(user_id: 123, event_type: "test_event", event_properties: {test_property: 1})
-      expect(event.to_hash).to eq({
-        event_type: "test_event",
+    it 'initializes event with parameter' do
+      event = AmplitudeAPI::Event.new(
         user_id: 123,
-        event_properties: {test_property: 1}
-      })
+        event_type: 'test_event',
+        event_properties: {
+          test_property: 1
+        }
+      )
+      expect(event.to_hash).to eq(
+        event_type: 'test_event',
+        user_id: 123,
+        event_properties: { test_property: 1 }
+      )
     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})
+  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)
+      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})
+    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)
+        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})
+    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)
+        AmplitudeAPI.send_event('test_event', @user.id, test_property: 1)
       end
     end
   end
 
-  describe ".send_identify" do
-    it "sends an identify to AmplitudeAPI" do
-      identification = AmplitudeAPI::Identification.new(user_id: @user, user_properties: {first_name: 'John', last_name: 'Doe'})
+  describe '.send_identify' do
+    it 'sends an identify to AmplitudeAPI' do
+      identification = AmplitudeAPI::Identification.new(
+        user_id: @user,
+        user_properties: {
+          first_name: 'John',
+          last_name: 'Doe'
+        }
+      )
       expect(AmplitudeAPI).to receive(:identify).with(identification)
 
-      AmplitudeAPI.send_identify(@user, {first_name: 'John', last_name: 'Doe'})
+      AmplitudeAPI.send_identify(@user, first_name: 'John', last_name: 'Doe')
     end
 
-    context "the user is nil" do
-      it "sends an identify with the no account user" do
-        identification = AmplitudeAPI::Identification.new(user_id: nil, user_properties: {first_name: 'John', last_name: 'Doe'})
+    context 'the user is nil' do
+      it 'sends an identify with the no account user' do
+        identification = AmplitudeAPI::Identification.new(
+          user_id: nil,
+          user_properties: {
+            first_name: 'John',
+            last_name: 'Doe'
+          }
+        )
         expect(AmplitudeAPI).to receive(:identify).with(identification)
 
-        AmplitudeAPI.send_identify(nil, {first_name: 'John', last_name: 'Doe'})
+        AmplitudeAPI.send_identify(nil, first_name: 'John', last_name: 'Doe')
       end
     end
 
-    context "the user is a user_id" do
-      it "sends an identify to AmplitudeAPI" do
-        identification = AmplitudeAPI::Identification.new(user_id: 123, user_properties: {first_name: 'John', last_name: 'Doe'})
+    context 'the user is a user_id' do
+      it 'sends an identify to AmplitudeAPI' do
+        identification = AmplitudeAPI::Identification.new(
+          user_id: 123,
+          user_properties: {
+            first_name: 'John',
+            last_name: 'Doe'
+          }
+        )
         expect(AmplitudeAPI).to receive(:identify).with(identification)
 
-        AmplitudeAPI.send_identify(@user.id, {first_name: 'John', last_name: 'Doe'})
+        AmplitudeAPI.send_identify(@user.id, first_name: 'John', last_name: 'Doe')
       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})
+  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.track_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"})
+    it 'should create an event' do
+      event = AmplitudeAPI::Event.new(
+        user_id: 23,
+        event_type: 'test_event',
+        event_properties: {
+          foo: 'bar'
+        }
+      )
       body = AmplitudeAPI.track_body(event)
 
-      expected = JSON.generate([{event_type: "test_event", user_id: 23, event_properties: {foo: "bar"}}])
+      expected = JSON.generate(
+        [
+          {
+            event_type: 'test_event',
+            user_id: 23,
+            event_properties: {
+              foo: 'bar'
+            }
+          }
+        ]
+      )
       expect(body[:event]).to eq(expected)
     end
   end

data/spec/spec_helper.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.join('..', '..', 'lib', 'amplitude-api'), __FILE__)
+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`.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: amplitude-api
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Alex Rakoczy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-08 00:00:00.000000000 Z
+date: 2016-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -87,6 +87,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - ".yardopts"
 - Gemfile
@@ -95,9 +96,10 @@ files:
 - Rakefile
 - amplitude-api.gemspec
 - lib/amplitude-api.rb
-- lib/amplitude-api/event.rb
-- lib/amplitude-api/identification.rb
-- lib/amplitude-api/version.rb
+- lib/amplitude_api.rb
+- lib/amplitude_api/event.rb
+- lib/amplitude_api/identification.rb
+- lib/amplitude_api/version.rb
 - readme.md
 - spec/lib/amplitude-api/event_spec.rb
 - spec/lib/amplitude-api/identification_spec.rb

data/lib/amplitude-api/version.rb

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