amplitude-api 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9fa498ab2765d7b0e14d78aacd3caf34d212abde
-  data.tar.gz: c2cf793047298e2d0679c2ec748eae6d9ae46727
+  metadata.gz: a9ac7cdd479dd7fc5397ab04697d01c1a018db1d
+  data.tar.gz: 07d0b31956d6c0d5fabf80460733bc2501dd29b8
 SHA512:
-  metadata.gz: b73383081f15f0bca95841663f0d58b9bcf863c5a183b18b52400a3148d406721ba21dd8fc6ffaf3ff1debfffe86475d25eee9b623766ac31052579526536416
-  data.tar.gz: 9bada553602d018841b12bbd6836f338971359316d3852fe4147e08f4b9d8f35918f221e8bfa59cedc877c673b76714c43c9dd3b98ffa9cf9adc82d60ab9fd76
+  metadata.gz: e5ba9200d8fc3415f8a6ee3d0450bb0a2849482d8cd8cb7fc5b2caf1cfa5175ee0e1c2f7074cebbf85c0410649ee1044b385c6acece36516f01c713bc2688ea0
+  data.tar.gz: b81df95283f2c5c2da128ec00b2ffb40e8b4e76b7ee34b990fd26e0834ac892e7d76a855e0b6b08a265b42c82fd71be725d12df09c112eaa9d84de14b81c6359

data/.rubocop.yml

@@ -1,2 +1,3 @@
+require: rubocop-rspec
 Metrics/LineLength:
   Max: 120

data/Gemfile

@@ -8,4 +8,5 @@ group :development, :test do
   gem 'rake', '>= 10.0'
   gem 'rspec', '>= 2.99.0'
   gem 'rubocop', '~> 0.37.2', require: false
+  gem 'rubocop-rspec'
 end

data/Gemfile.lock

@@ -2,11 +2,11 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.2.0)
-    coderay (1.1.0)
+    coderay (1.1.1)
     diff-lcs (1.2.5)
-    ethon (0.7.3)
+    ethon (0.8.1)
       ffi (>= 1.3.0)
-    ffi (1.9.8)
+    ffi (1.9.10)
     method_source (0.8.2)
     parser (2.3.0.6)
       ast (~> 2.2)
@@ -16,25 +16,31 @@ GEM
       method_source (~> 0.8)
       slop (~> 3.4)
     rainbow (2.1.0)
-    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)
+    rake (10.5.0)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.3)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
     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)
+    rubocop-rspec (1.4.0)
     ruby-progressbar (1.7.5)
-    slop (3.5.0)
-    typhoeus (0.7.1)
-      ethon (>= 0.7.1)
+    slop (3.6.0)
+    typhoeus (0.7.3)
+      ethon (>= 0.7.4)
     unicode-display_width (0.3.1)
 
 PLATFORMS
@@ -45,6 +51,7 @@ DEPENDENCIES
   rake (>= 10.0)
   rspec (>= 2.99.0)
   rubocop (~> 0.37.2)
+  rubocop-rspec
   typhoeus (~> 0.7.1)
 
 BUNDLED WITH

data/lib/amplitude_api.rb

@@ -22,15 +22,18 @@ class 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,
+    # @param [ Hash ] event_properties a hash that is serialized to JSON,
     # and can contain any other property to be stored on the Event
+    # @param [ Hash ] user_properties a hash that is serialized to JSON,
+    # and contains user properties to be associated with the user
     #
     # @return [ Typhoeus::Response ]
-    def send_event(event_name, user, properties = {})
+    def send_event(event_name, user, event_properties: {}, user_properties: {})
       event = AmplitudeAPI::Event.new(
         user_id: user,
         event_type: event_name,
-        event_properties: properties
+        event_properties: event_properties,
+        user_properties: user_properties
       )
       track(event)
     end

data/lib/amplitude_api/event.rb

@@ -10,6 +10,9 @@ class AmplitudeAPI
     # @!attribute [ rw ] event_properties
     #   @return [ String ] the event_properties to be attached to the Amplitude Event
     attr_accessor :event_properties
+    # @!attribute [ rw ] user_properties
+    #   @return [ String ] the user_properties to be passed for the user
+    attr_accessor :user_properties
     # @!attribute [ rw ] time
     #   @return [ Time ] Time that the event occurred (defaults to now)
     attr_accessor :time
@@ -20,10 +23,11 @@ class AmplitudeAPI
     # @param [ String ] event_type a name for the event
     # @param [ Hash ] event_properties various properties to attach to the event
     # @param [ Time ] Time that the event occurred (defaults to now)
-    def initialize(user_id: '', event_type: '', event_properties: {}, time: nil)
+    def initialize(user_id: '', event_type: '', event_properties: {}, user_properties: {}, time: nil)
       self.user_id = user_id
       self.event_type = event_type
       self.event_properties = event_properties
+      self.user_properties = user_properties
       self.time = time
     end
 
@@ -44,6 +48,7 @@ class AmplitudeAPI
       serialized_event[:event_type] = event_type
       serialized_event[:user_id] = user_id
       serialized_event[:event_properties] = event_properties
+      serialized_event[:user_properties] = user_properties
       serialized_event[:time] = formatted_time if time
       serialized_event
     end

data/lib/amplitude_api/version.rb

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

data/readme.md

@@ -1,5 +1,6 @@
 # Amplitude API
 [![Build Status](https://travis-ci.org/toothrot/amplitude-api.svg?branch=master)](https://travis-ci.org/toothrot/amplitude-api)
+[![Code Climate](https://codeclimate.com/github/toothrot/amplitude-api/badges/gpa.svg)](https://codeclimate.com/github/toothrot/amplitude-api)
 [![Gem Version](https://badge.fury.io/rb/amplitude-api.svg)](http://badge.fury.io/rb/amplitude-api)
 
 ## Installation

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

@@ -1,13 +1,13 @@
 require 'spec_helper'
 
 describe AmplitudeAPI::Event do
-  User = Struct.new(:id)
+  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 = described_class.new(
+          user_id: user.new(123),
           event_type: 'clicked on home'
         )
         expect(event.to_hash[:user_id]).to eq(123)
@@ -18,7 +18,7 @@ describe AmplitudeAPI::Event do
   context 'with a user id' do
     describe '#body' do
       it "populates with the user's id" do
-        event = AmplitudeAPI::Event.new(
+        event = described_class.new(
           user_id: 123,
           event_type: 'clicked on home'
         )
@@ -30,7 +30,7 @@ describe AmplitudeAPI::Event do
   context 'without a user' do
     describe '#body' do
       it 'populates with the unknown user' do
-        event = AmplitudeAPI::Event.new(
+        event = described_class.new(
           user_id: nil,
           event_type: 'clicked on home'
         )
@@ -41,7 +41,7 @@ describe AmplitudeAPI::Event do
 
   describe '#body' do
     it 'includes the event type' do
-      event = AmplitudeAPI::Event.new(
+      event = described_class.new(
         user_id: 123,
         event_type: 'clicked on home'
       )
@@ -49,7 +49,7 @@ describe AmplitudeAPI::Event do
     end
 
     it 'includes arbitrary properties' do
-      event = AmplitudeAPI::Event.new(
+      event = described_class.new(
         user_id: 123,
         event_type: 'clicked on home',
         event_properties: { abc: :def }
@@ -59,7 +59,7 @@ describe AmplitudeAPI::Event do
 
     it 'includes a time for the event' do
       time = Time.parse('2016-01-01 00:00:00 -0000')
-      event = AmplitudeAPI::Event.new(
+      event = described_class.new(
         user_id: 123,
         event_type: 'clicked on home',
         time: time
@@ -68,7 +68,7 @@ describe AmplitudeAPI::Event do
     end
 
     it 'does not include time if it is not set' do
-      event = AmplitudeAPI::Event.new(
+      event = described_class.new(
         user_id: 123,
         event_type: 'clicked on home'
       )

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

@@ -1,12 +1,12 @@
 require 'spec_helper'
 
 describe AmplitudeAPI::Identification do
-  User = Struct.new(:id)
+  user = Struct.new(:id)
 
   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))
+        identification = described_class.new(user_id: user.new(123))
         expect(identification.to_hash[:user_id]).to eq(123)
       end
     end
@@ -15,7 +15,7 @@ describe AmplitudeAPI::Identification 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)
+        identification = described_class.new(user_id: 123)
         expect(identification.to_hash[:user_id]).to eq(123)
       end
     end
@@ -24,7 +24,7 @@ describe AmplitudeAPI::Identification do
   context 'without a user' do
     describe '#body' do
       it 'populates with the unknown user' do
-        identification = AmplitudeAPI::Identification.new(user_id: nil)
+        identification = described_class.new(user_id: nil)
         expect(identification.to_hash[:user_id]).to eq(AmplitudeAPI::USER_WITH_NO_ACCOUNT)
       end
     end
@@ -32,12 +32,12 @@ describe AmplitudeAPI::Identification do
 
   describe '#body' do
     it 'includes the user id' do
-      identification = AmplitudeAPI::Identification.new(user_id: 123)
+      identification = described_class.new(user_id: 123)
       expect(identification.to_hash[:user_id]).to eq(123)
     end
 
     it 'includes arbitrary user properties' do
-      identification = AmplitudeAPI::Identification.new(
+      identification = described_class.new(
         user_id: 123,
         user_properties: {
           first_name: 'John',

data/spec/lib/amplitude_api_spec.rb

@@ -1,9 +1,7 @@
 require 'spec_helper'
 
 describe AmplitudeAPI do
-  before do
-    @user = Struct.new(:id).new(123)
-  end
+  let(:user) { Struct.new(:id).new(123) }
 
   describe '.track' do
     context 'with a single event' do
@@ -13,13 +11,13 @@ describe AmplitudeAPI do
           event_type: 'clicked on sign up'
         )
         body = {
-          api_key: AmplitudeAPI.api_key,
+          api_key: described_class.api_key,
           event: JSON.generate([event.to_hash])
         }
 
         expect(Typhoeus).to receive(:post).with(AmplitudeAPI::TRACK_URI_STRING, body: body)
 
-        AmplitudeAPI.track(event)
+        described_class.track(event)
       end
     end
 
@@ -34,13 +32,13 @@ describe AmplitudeAPI do
           event_type: 'liked a widget'
         )
         body = {
-          api_key: AmplitudeAPI.api_key,
+          api_key: described_class.api_key,
           event: JSON.generate([event.to_hash, event2.to_hash])
         }
 
         expect(Typhoeus).to receive(:post).with(AmplitudeAPI::TRACK_URI_STRING, body: body)
 
-        AmplitudeAPI.track([event, event2])
+        described_class.track([event, event2])
       end
     end
   end
@@ -56,13 +54,13 @@ describe AmplitudeAPI do
           }
         )
         body = {
-          api_key: AmplitudeAPI.api_key,
+          api_key: described_class.api_key,
           identification: JSON.generate([identification.to_hash])
         }
 
         expect(Typhoeus).to receive(:post).with(AmplitudeAPI::IDENTIFY_URI_STRING, body: body)
 
-        AmplitudeAPI.identify(identification)
+        described_class.identify(identification)
       end
     end
 
@@ -83,13 +81,13 @@ describe AmplitudeAPI do
           }
         )
         body = {
-          api_key: AmplitudeAPI.api_key,
+          api_key: described_class.api_key,
           identification: JSON.generate([identification.to_hash, identification2.to_hash])
         }
 
         expect(Typhoeus).to receive(:post).with(AmplitudeAPI::IDENTIFY_URI_STRING, body: body)
 
-        AmplitudeAPI.identify([identification, identification2])
+        described_class.identify([identification, identification2])
       end
     end
   end
@@ -100,7 +98,8 @@ describe AmplitudeAPI do
       expect(event.to_hash).to eq(
         event_type: '',
         user_id: '',
-        event_properties: {}
+        event_properties: {},
+        user_properties: {}
       )
     end
 
@@ -115,7 +114,8 @@ describe AmplitudeAPI do
       expect(event.to_hash).to eq(
         event_type: 'test_event',
         user_id: 123,
-        event_properties: { test_property: 1 }
+        event_properties: { test_property: 1 },
+        user_properties: {}
       )
     end
   end
@@ -123,13 +123,13 @@ describe AmplitudeAPI do
   describe '.send_event' do
     it 'sends an event to AmplitudeAPI' do
       event = AmplitudeAPI::Event.new(
-        user_id: @user,
+        user_id: user,
         event_type: 'test_event',
         event_properties: { test_property: 1 }
       )
-      expect(AmplitudeAPI).to receive(:track).with(event)
+      expect(described_class).to receive(:track).with(event)
 
-      AmplitudeAPI.send_event('test_event', @user, test_property: 1)
+      described_class.send_event('test_event', user, event_properties: { test_property: 1 })
     end
 
     context 'the user is nil' do
@@ -139,9 +139,9 @@ describe AmplitudeAPI do
           event_type: 'test_event',
           event_properties: { test_property: 1 }
         )
-        expect(AmplitudeAPI).to receive(:track).with(event)
+        expect(described_class).to receive(:track).with(event)
 
-        AmplitudeAPI.send_event('test_event', nil, test_property: 1)
+        described_class.send_event('test_event', nil, event_properties: { test_property: 1 })
       end
     end
 
@@ -152,9 +152,26 @@ describe AmplitudeAPI do
           event_type: 'test_event',
           event_properties: { test_property: 1 }
         )
-        expect(AmplitudeAPI).to receive(:track).with(event)
+        expect(described_class).to receive(:track).with(event)
 
-        AmplitudeAPI.send_event('test_event', @user.id, test_property: 1)
+        described_class.send_event('test_event', user.id, event_properties: { test_property: 1 })
+      end
+
+      it 'sends arbitrary user_properties to AmplitudeAPI' do
+        event = AmplitudeAPI::Event.new(
+          user_id: 123,
+          event_type: 'test_event',
+          event_properties: { test_property: 1 },
+          user_properties: { test_user_property: 'abc' }
+        )
+        expect(described_class).to receive(:track).with(event)
+
+        described_class.send_event(
+          'test_event',
+          user.id,
+          event_properties: { test_property: 1 },
+          user_properties: { test_user_property: 'abc' }
+        )
       end
     end
   end
@@ -162,15 +179,15 @@ describe AmplitudeAPI do
   describe '.send_identify' do
     it 'sends an identify to AmplitudeAPI' do
       identification = AmplitudeAPI::Identification.new(
-        user_id: @user,
+        user_id: user,
         user_properties: {
           first_name: 'John',
           last_name: 'Doe'
         }
       )
-      expect(AmplitudeAPI).to receive(:identify).with(identification)
+      expect(described_class).to receive(:identify).with(identification)
 
-      AmplitudeAPI.send_identify(@user, first_name: 'John', last_name: 'Doe')
+      described_class.send_identify(user, first_name: 'John', last_name: 'Doe')
     end
 
     context 'the user is nil' do
@@ -182,9 +199,9 @@ describe AmplitudeAPI do
             last_name: 'Doe'
           }
         )
-        expect(AmplitudeAPI).to receive(:identify).with(identification)
+        expect(described_class).to receive(:identify).with(identification)
 
-        AmplitudeAPI.send_identify(nil, first_name: 'John', last_name: 'Doe')
+        described_class.send_identify(nil, first_name: 'John', last_name: 'Doe')
       end
     end
 
@@ -197,35 +214,38 @@ describe AmplitudeAPI do
             last_name: 'Doe'
           }
         )
-        expect(AmplitudeAPI).to receive(:identify).with(identification)
+        expect(described_class).to receive(:identify).with(identification)
 
-        AmplitudeAPI.send_identify(@user.id, first_name: 'John', last_name: 'Doe')
+        described_class.send_identify(user.id, first_name: 'John', last_name: 'Doe')
       end
     end
   end
 
   describe '#body' do
-    it 'should add an api key' do
+    it 'adds an api key' do
       event = AmplitudeAPI::Event.new(
-        user_id: @user,
+        user_id: user,
         event_type: 'test_event',
         event_properties: {
           test_property: 1
         }
       )
-      body = AmplitudeAPI.track_body(event)
+      body = described_class.track_body(event)
       expect(body[:api_key]).to eq('stub api key')
     end
 
-    it 'should create an event' do
+    it 'creates an event' do
       event = AmplitudeAPI::Event.new(
         user_id: 23,
         event_type: 'test_event',
         event_properties: {
           foo: 'bar'
+        },
+        user_properties: {
+          abc: '123'
         }
       )
-      body = AmplitudeAPI.track_body(event)
+      body = described_class.track_body(event)
 
       expected = JSON.generate(
         [
@@ -234,6 +254,9 @@ describe AmplitudeAPI do
             user_id: 23,
             event_properties: {
               foo: 'bar'
+            },
+            user_properties: {
+              abc: '123'
             }
           }
         ]

data/spec/spec_helper.rb

@@ -7,7 +7,6 @@ require 'pry'
 #
 # 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
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: amplitude-api
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Alex Rakoczy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-21 00:00:00.000000000 Z
+date: 2016-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -101,8 +101,8 @@ files:
 - 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
+- spec/lib/amplitude_api/event_spec.rb
+- spec/lib/amplitude_api/identification_spec.rb
 - spec/lib/amplitude_api_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/toothrot/amplitude-api
@@ -130,7 +130,7 @@ 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/identification_spec.rb
+- spec/lib/amplitude_api/event_spec.rb
+- spec/lib/amplitude_api/identification_spec.rb
 - spec/lib/amplitude_api_spec.rb
 - spec/spec_helper.rb