amplitude-api 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 233332597b10167395db959e0066e1f8b2adf1ad
-  data.tar.gz: 574f6162547e34a3e2003abf0410146064de2279
+  metadata.gz: 67727755b54bfef1fc3ffa5889e11c7931420a13
+  data.tar.gz: 52feec8f51522d7f2c17b0db39d4e033f76efe2b
 SHA512:
-  metadata.gz: 860998aada7dc9516f451d1e83d1c92abc1247eab787eb67ed186efa63c30e650f94e6e31afe422119a1f55da6c058d606df6a5b3529ad669f32781f3bb33b11
-  data.tar.gz: 22b4a53df0df781db7f2efeac562481546b8551bee4e31b2be1918189a8b5cb145cb14e2eb70b366965dd56b27310ef95832d73125bdcb7ffa157818382a1ba6
+  metadata.gz: f3b3bf19725cda0082c7cf0acb7ca40614430a63ff5d929e803c3074955d9b35e5674987745a5fb17d2cc0e030fb7319a5903e012d40c98f5e171efea8f3b0f6
+  data.tar.gz: 09b6ca4ddb4ec2bdbed9980a41356b6f0096feace6819209c98ce37eb2a83722f509ca60762ccd7731a10308693bdce1eddf88f9e5cb27338fdf92be84dffd74

data/.travis.yml

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

data/lib/amplitude_api/event.rb

@@ -20,13 +20,38 @@ class AmplitudeAPI
     #   @return [ String ] IP address of the user
     attr_accessor :ip
 
+    # @!attribute [ rw ] insert_id
+    #   @return [ String ] the unique identifier to be sent to Amplitude
+    attr_accessor :insert_id
+
+    # @!attribute [ rw ] price
+    #   @return [ String ] (required for revenue data) price of the item purchased
+    attr_accessor :price
+
+    # @!attribute [ rw ] quantity
+    #   @return [ String ] (required for revenue data, defaults to 1 if not specified) quantity of the item purchased
+    attr_accessor :quantity
+
+    # @!attribute [ rw ] product_id
+    #   @return [ String ] an identifier for the product. (Note: you must send a price and quantity with this field)
+    attr_accessor :product_id
+
+    # @!attribute [ rw ] revenue_type
+    #   @return [ String ] type of revenue. (Note: you must send a price and quantity with this field)
+    attr_accessor :revenue_type
+
     # 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
     # @param [ Time ] Time that the event occurred (defaults to now)
+    # @param [ Double ] price (optional, but required for revenue data) price of the item purchased
+    # @param [ Integer ] quantity (optional, but required for revenue data) quantity of the item purchased
+    # @param [ String ] product_id (optional) an identifier for the product.
+    # @param [ String ] revenue_type (optional) type of revenue
     # @param [ String ] IP address of the user
+    # @param [ String ] insert_id a unique identifier for the event
     def initialize(options = {})
       self.user_id = options.fetch(:user_id, '')
       self.event_type = options.fetch(:event_type, '')
@@ -34,6 +59,8 @@ class AmplitudeAPI
       self.user_properties = options.fetch(:user_properties, {})
       self.time = options[:time]
       self.ip = options.fetch(:ip, '')
+      self.insert_id = options[:insert_id]
+      validate_revenue_arguments(options)
     end
 
     def user_id=(value)
@@ -56,7 +83,9 @@ class AmplitudeAPI
       serialized_event[:user_properties] = user_properties
       serialized_event[:time] = formatted_time if time
       serialized_event[:ip] = ip if ip
-      serialized_event
+      serialized_event[:insert_id] = insert_id if insert_id
+
+      serialized_event.merge(revenue_hash)
     end
 
     # @return [ true, false ]
@@ -75,5 +104,24 @@ class AmplitudeAPI
     def formatted_time
       time.to_i * 1_000
     end
+
+    def validate_revenue_arguments(options)
+      self.price = options[:price]
+      self.quantity = options[:quantity] || 1 if price
+      self.product_id = options[:product_id]
+      self.revenue_type = options[:revenue_type]
+      return if price
+      raise ArgumentError, 'You must provide a price in order to use the product_id' if product_id
+      raise ArgumentError, 'You must provide a price in order to use the revenue_type' if revenue_type
+    end
+
+    def revenue_hash
+      revenue_hash = {}
+      revenue_hash[:productId] = product_id if product_id
+      revenue_hash[:revenueType] = revenue_type if revenue_type
+      revenue_hash[:quantity] = quantity if quantity
+      revenue_hash[:price] = price if price
+      revenue_hash
+    end
   end
 end

data/lib/amplitude_api/version.rb

@@ -1,3 +1,3 @@
 class AmplitudeAPI
-  VERSION = '0.0.7'.freeze
+  VERSION = '0.0.8'.freeze
 end

data/readme.md

@@ -21,6 +21,7 @@ event = AmplitudeAPI::Event.new({
   user_id: "123",
   event_type: "clicked on home",
   time: Time.now,
+  insert_id: 'f47ac10b-58cc-4372-a567-0e02b2c3d479',
   event_properties: {
     cause: "button",
     arbitrary: "properties"
@@ -40,7 +41,7 @@ Currently, we are using this in Rails and using ActiveJob to dispatch events asy
 ## Other useful resources
 * [Amplitude HTTP Api Documentation](https://amplitude.zendesk.com/hc/en-us/articles/204771828)
 * [Segment.io Amplitude integration](https://segment.com/docs/integrations/amplitude/)
- 
+
 ## Contributing
 
 I'd love to hear how you're using this. Please check out the [issues](https://github.com/toothrot/amplitude-api/issues).

data/spec/lib/amplitude_api/event_spec.rb

@@ -39,6 +39,30 @@ describe AmplitudeAPI::Event do
     end
   end
 
+  describe 'init' do
+    context 'the user does not send in a price' do
+      it 'raises an error if the user sends in a product_id' do
+        expect do
+          described_class.new(
+            user_id: 123,
+            event_type: 'bad event',
+            product_id: 'hopscotch.4lyfe'
+          )
+        end.to raise_error(ArgumentError)
+      end
+
+      it 'raises an error if the user sends in a revenue_type' do
+        expect do
+          described_class.new(
+            user_id: 123,
+            event_type: 'bad event',
+            revenue_type: 'tax return'
+          )
+        end.to raise_error(ArgumentError)
+      end
+    end
+  end
+
   describe '#body' do
     it 'includes the event type' do
       event = described_class.new(
@@ -57,22 +81,109 @@ describe AmplitudeAPI::Event do
       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 = described_class.new(
-        user_id: 123,
-        event_type: 'clicked on home',
-        time: time
-      )
-      expect(event.to_hash[:time]).to eq(1_451_606_400_000)
+    describe 'time' do
+      it 'includes a time for the event' do
+        time = Time.parse('2016-01-01 00:00:00 -0000')
+        event = described_class.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 = described_class.new(
+          user_id: 123,
+          event_type: 'clicked on home'
+        )
+        expect(event.to_hash).not_to have_key(:time)
+      end
     end
 
-    it 'does not include time if it is not set' do
-      event = described_class.new(
-        user_id: 123,
-        event_type: 'clicked on home'
-      )
-      expect(event.to_hash).not_to have_key(:time)
+    describe 'insert_id' do
+      it 'includes an insert_id for the event' do
+        event = described_class.new(
+          user_id: 123,
+          event_type: 'clicked on home',
+          insert_id: 'foo-bar'
+        )
+        expect(event.to_hash[:insert_id]).to eq('foo-bar')
+      end
+
+      it 'does not include insert_id if it is not set' do
+        event = described_class.new(
+          user_id: 123,
+          event_type: 'clicked on home'
+        )
+        expect(event.to_hash).not_to have_key(:insert_id)
+      end
+    end
+
+    describe 'revenue params' do
+      it 'includes the price if it is set' do
+        price = 100_000.99
+        event = described_class.new(
+          user_id: 123,
+          event_type: 'clicked on home',
+          price: price
+        )
+        expect(event.to_hash[:price]).to eq(price)
+      end
+
+      it 'sets the quantity to 1 if the price is set and the quantity is not' do
+        price = 100_000.99
+        event = described_class.new(
+          user_id: 123,
+          event_type: 'clicked on home',
+          price: price
+        )
+        expect(event.to_hash[:quantity]).to eq(1)
+      end
+
+      it 'includes the quantity if it is set' do
+        quantity = 100
+        event = described_class.new(
+          user_id: 123,
+          event_type: 'clicked on home',
+          quantity: quantity,
+          price: 10.99
+        )
+        expect(event.to_hash[:quantity]).to eq(quantity)
+      end
+
+      it 'includes the productID if set' do
+        product_id = 'hopscotch.subscriptions.rule'
+        event = described_class.new(
+          user_id: 123,
+          event_type: 'clicked on home',
+          price: 199.99,
+          product_id: product_id
+        )
+        expect(event.to_hash[:productId]).to eq(product_id)
+      end
+
+      it 'includes the revenueType if set' do
+        revenue_type = 'income'
+        event = described_class.new(
+          user_id: 123,
+          event_type: 'clicked on home',
+          price: 199.99,
+          revenue_type: revenue_type
+        )
+        expect(event.to_hash[:revenueType]).to eq(revenue_type)
+      end
+
+      it 'does not include revenue params if they are not set' do
+        event = described_class.new(
+          user_id: 123,
+          event_type: 'clicked on home'
+        )
+        expect(event.to_hash).not_to have_key(:quantity)
+        expect(event.to_hash).not_to have_key(:revenueType)
+        expect(event.to_hash).not_to have_key(:productId)
+        expect(event.to_hash).not_to have_key(:price)
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: amplitude-api
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Alex Rakoczy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-01 00:00:00.000000000 Z
+date: 2016-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec