amplitude-api 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59e87e342af629c6e87369ef210a272186236ec4e4ef9f9a101a2a590da59204
-  data.tar.gz: 7e207b30db0550982c4280aa0da2d3c225b1598cfd2bcba1971e8a75238e142e
+  metadata.gz: ccae25c2fa30d5c9f6172ed99c802f47022495d32e444a101ccfc230352111f4
+  data.tar.gz: '08392b43958061be04edb9b5df142f930d096be402c8a2f0e31697690df6c584'
 SHA512:
-  metadata.gz: 42aa5d35506dcaebb8a9db1e973081f38d0259eacc1da1eeeae6d530fc92055dfc70f749e4b19a4e28e3b726e92abae52e575207f1fadfa483bd2b6d6abba771
-  data.tar.gz: 7e97e56ac203bee46e1740e937c0869cb310d8c4edbc88ce6c2603446c5ad0989e52ffbf327be61680813ff2e92808a9ae91e09d0de9e4de5f4cedae590c2415
+  metadata.gz: 701706508efb89ff8adb3ea18e063500c1e3bf83fa89c07f1fe571177d16c7856a3d5dfdc7b4f4927b22fc811a94d7b8a02c318cfac3f7b040a62eb61a5effdf
+  data.tar.gz: 1b24d8ab6ffda5757549867550ade78e9f5c1cfcdf2aaf149041e2a4e1822a6e84aa06afd2b22ee006f668d54c09d8b8f600c72f5adccf627d1c4a1111e7eb44

data/Changelog.md

@@ -3,9 +3,13 @@
 We would like to think our many [contributors](https://github.com/toothrot/amplitude-api/graphs/contributors) for
 suggestions, ideas and improvements to Amplitude API.
 
+## 0.3.1 (2021-02-23)
+* Allows sending options to Amplitude
+* Solves an error when accessing event properties not been created yet
+
 ## 0.3.0 (2021-02-22)
 
-* Changes Typhoeus to Faraday to launch requests
+* Changes Typhoeus to Faraday to launch requests (**breaking change**)
 * Adds new API fields to Event
 * Event can now include arbitrary properties, so it could be used if the API adds new ones.
 

data/lib/amplitude_api.rb

@@ -70,10 +70,13 @@ class AmplitudeAPI
     def track_body(*events)
       event_body = events.flatten.map(&:to_hash)
 
-      JSON.generate(
+      body = {
         api_key: api_key,
         events: event_body
-      )
+      }
+      body[:options] = config.options if config.options
+
+      JSON.generate(body)
     end
 
     # @overload track(event)

data/lib/amplitude_api/config.rb

@@ -8,7 +8,8 @@ class AmplitudeAPI
     include Singleton
 
     attr_accessor :api_key, :secret_key, :whitelist, :time_formatter,
-                  :event_properties_formatter, :user_properties_formatter
+                  :event_properties_formatter, :user_properties_formatter,
+                  :options
 
     def initialize
       self.class.defaults.each { |k, v| send("#{k}=", v) }

data/lib/amplitude_api/event.rb

@@ -25,6 +25,7 @@ class AmplitudeAPI
 
     def method_missing(method_name, *args)
       super if block_given?
+      super unless method_name.to_s.end_with? "="
 
       property_name = method_name.to_s.delete_suffix("=")
 

data/lib/amplitude_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class AmplitudeAPI
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/readme.md

@@ -31,6 +31,37 @@ event = AmplitudeAPI::Event.new({
 AmplitudeAPI.track(event)
 ```
 
+You can track multiple events with a single call, with the only limit of the payload
+size imposed by Amplitude:
+
+```ruby
+event_1 = AmplitudeAPI::Event.new(...)
+event_2 = AmplitudeAPI::Event.new(...)
+
+AmplitudeAPI.track(event_1, event_2)
+```
+
+```ruby
+events = [event_1, event_2]
+AmplitudeAPI.track(*events)
+```
+
+In case you use an integer as the time, it is expected to be in seconds. Values in
+the time field will be converted to milliseconds using `->(time) { time ? time.to_i * 1_000 : nil }`
+You can change this behaviour and use your custom formatter. For example, in case
+you wanted to use milliseconds instead of seconds you could do this:
+```ruby
+AmplitudeAPI.config.time_formatter = ->(time) { time ? time.to_i : nil },
+```
+
+You can speficy track options in the config. The options will be applied to all subsequent requests:
+
+```ruby
+AmplitudeAPI.config.options = { min_id_length: 10 }
+AmplitudeAPI.track(event)
+```
+
+
 ## User Privacy APIs
 
 The following code snippet will delete a user from amplitude

data/spec/lib/amplitude_api/event_spec.rb

@@ -347,6 +347,12 @@ describe AmplitudeAPI::Event do
       expect(event.respond_to?(:arbitrary_property=)).to be true
     end
 
+    it "does not define property until assigned" do
+      expect {
+        event.undefined_property
+      }.to raise_error NoMethodError, /undefined_property/
+    end
+
     it "do not accepts blocks when assigning values to create properties" do
       expect do
         event.arbitrary_property { puts "whatever" }

data/spec/lib/amplitude_api_spec.rb

@@ -7,7 +7,32 @@ describe AmplitudeAPI do
   let(:device_id) { "abcdef" }
 
   describe ".track" do
+    before do
+      described_class.config.options = nil
+    end
+
     context "with a single event" do
+      it "can send options" do
+        event = AmplitudeAPI::Event.new(
+          user_id: 123,
+          event_type: "clicked on sign up"
+        )
+        options = { min_id_length: 456 }
+        described_class.config.options = options
+
+        allow(Faraday).to receive(:post)
+
+        described_class.track(event)
+
+        headers = { "Content-Type" => "application/json" }
+        body = JSON.generate(
+          api_key: described_class.api_key,
+          events: [event.to_hash],
+          options: options
+        )
+        expect(Faraday).to have_received(:post).with(AmplitudeAPI::TRACK_URI_STRING, body, headers)
+      end
+
       context "with only user_id" do
         it "sends the event to Amplitude" do
           event = AmplitudeAPI::Event.new(
@@ -65,6 +90,31 @@ describe AmplitudeAPI do
     end
 
     context "with multiple events" do
+      it "can send options" 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"
+        )
+        options = { min_id_length: 456 }
+        described_class.config.options = options
+
+        allow(Faraday).to receive(:post)
+
+        described_class.track([event, event2])
+
+        headers = { "Content-Type" => "application/json" }
+        body = JSON.generate(
+          api_key: described_class.api_key,
+          events: [event.to_hash, event2.to_hash],
+          options: options
+        )
+        expect(Faraday).to have_received(:post).with(AmplitudeAPI::TRACK_URI_STRING, body, headers)
+      end
+
       it "sends all events in a single request" do
         event = AmplitudeAPI::Event.new(
           user_id: 123,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: amplitude-api
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Alex Rakoczy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-22 00:00:00.000000000 Z
+date: 2021-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry