amplitude-api 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b743d15865f804837f6f3abb9557fa35aa6a32ae360fae0edfeaab0e7905b81
-  data.tar.gz: 8c58bd5c4a21a36394cca7ce58da56b1e4135fc4ac574001e31350bda5cf3d69
+  metadata.gz: bf75d44cb2ccfb90961a3aa3875a245a8231edbb68d941325b6980ea10cf63d2
+  data.tar.gz: 7da5804bd41daa7c6dee8839119ad5640725b241ef8170f37919f5109f566855
 SHA512:
-  metadata.gz: 3bf4707b9fe9905e95fdeee4c66044dfce02a2f4bae7fe939cffc343957ff4b2eb3d0dcf41d9c9dc958048f14fc8039c5d4e5c375103b7aeec4260e5a5a5c2d5
-  data.tar.gz: 6cb4d59c569e8ccb3d8fc1f52920baba4ae6fa1da605115e6ed393a05119d1b275e58d00d18349cb840dd84b11b58416f3639e31eb95e4fb6c88eac55a378084
+  metadata.gz: 4979e1f81be283bf3324de9269ce36131ce16f3bd3dbb6bd257eb98d7f8e0e30e669bfb8cc6738eed1e29f2543eddf34b19448fb379814c63fb273ab25726863
+  data.tar.gz: 4301bb508042b66a85b4754e352bca971a3acb0cdee00b81ce6b1bb9359f1120770f70c16e59c71a9e4279d38b32ac5904108b8a4ddf2fe69767fea77ad0fd87

data/.gitignore

@@ -34,4 +34,5 @@ build/
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
 
-.idea
+.idea
+amplitude-api.iml

data/.travis.yml

@@ -1,6 +1,7 @@
 language: ruby
 cache: bundler
 rvm:
-  - 2.3.1
-  - 2.2.2
-  - 2.1.6
+  - 2.6.1
+  - 2.4.6
+  - 2.3.8
+  - 2.2.10

data/Changelog.md

@@ -3,6 +3,18 @@
 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.1.1 (2019-01-01)
+
+* Fix #41 - Delete API now correctly handles Arrays of IDs.
+
+## 0.1.0 (2019-01-01)
+
+* Update Gem dependencies (thanks @kolorahl, @itamar, @krettan)
+* Minimum ruby version is now 2.2 
+* Support Delete API (thanks @samjohn)
+* Fix bundle Inline (thanks @jonduarte)
+* Many fixes from @kolorahl
+
 ## 0.0.10 (2017-09-13)
 
 * Allow to use "Event Segmentation" via API ([#23](https://github.com/toothrot/amplitude-api/pull/23)).

data/lib/amplitude-api.rb

@@ -1,4 +1,4 @@
-# rubocop:disable Style/FileName
+# rubocop:disable Naming/FileName
 require_relative 'amplitude_api'
-# rubocop:enable Style/FileName
+# rubocop:enable Naming/FileName
 # Whoops.

data/lib/amplitude_api.rb

@@ -38,9 +38,9 @@ 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 [ String ] device a string that uniquely identifies the device.
-    # @param [ Hash ] event_properties a hash that is serialized to JSON,
+    # @option options [ 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,
+    # @option options [ Hash ] user_properties a hash that is serialized to JSON,
     # and contains user properties to be associated with the user
     #
     # @return [ Typhoeus::Response ]
@@ -134,20 +134,20 @@ class AmplitudeAPI
 
     # Get metrics for an event with segmentation.
     #
-    # @param [ Hash ] e a hash that defines event.
+    # @param [ Hash ] event a hash that defines event.
     # @param [ Time ] start_time a start time.
     # @param [ Time ] end_time a end time.
-    # @param [ String ] m a string that defines aggregate function.
+    # @option options [ String ] m a string that defines aggregate function.
     # For non-property metrics: "uniques", "totals", "pct_dau", or "average" (default: "uniques").
     # For property metrics: "histogram", "sums", or "value_avg"
     # (note: a valid "group_by" value is required in parameter e).
-    # @param [ Integer ] i an integer that defines segmentation interval.
+    # @option options [ Integer ] i an integer that defines segmentation interval.
     # Set to -300000, -3600000, 1, 7, or 30 for realtime, hourly, daily, weekly,
     # and monthly counts, respectively (default: 1). Realtime segmentation is capped at 2 days,
     # hourly segmentation is capped at 7 days, and daily at 365 days.
-    # @param [ Array ] s an array that defines segment definitions.
-    # @param [ String ] g a string that defines property to group by.
-    # @param [ Integer ] limit an integer that defines number of Group By values
+    # @option options [ Array ] s an array that defines segment definitions.
+    # @option options [ String ] g a string that defines property to group by.
+    # @option options [ Integer ] limit an integer that defines number of Group By values
     # returned (default: 100). The maximum limit is 1000.
     #
     # @return [ Typhoeus::Response ]
@@ -164,27 +164,39 @@ class AmplitudeAPI
       }.delete_if { |_, value| value.nil? }
     end
 
-    # ==== GDPR compliance methods
-
-    # Delete a user from amplitude when they request it to comply with GDPR
+    # Delete a user from amplitude
+    #
     # You must pass in either an array of user_ids or an array of amplitude_ids
     #
-    # @param [ user_ids ] (optional) the user_ids to delete
+    # @param [ Array<String> ] (optional) the user_ids to delete
     # based on your database
-    # @param [ amplitude_ids ] (optional) the amplitude_ids to delete
+    # @param [ Array<Integer> ] (optional) the amplitude_ids to delete
     # based on the amplitude database
-    # @param [ requester ] the email address of the person who
+    # @param [ String ] requester the email address of the person who
     # is requesting the deletion, optional but useful for reporting
     #
     # @return [ Typhoeus::Response ]
     def delete(user_ids: nil, amplitude_ids: nil, requester: nil)
-      Typhoeus.post DELETION_URI_STRING,
-                    userpwd: "#{api_key}:#{config.secret_key}",
-                    body: {
-                      amplitude_ids: amplitude_ids,
-                      user_ids: user_ids,
-                      requester: requester
-                    }.delete_if { |_, value| value.nil? }
+      user_ids = Array(user_ids)
+      amplitude_ids = Array(amplitude_ids)
+      Typhoeus.post(
+        DELETION_URI_STRING,
+        userpwd: "#{api_key}:#{config.secret_key}",
+        body: delete_body(user_ids, amplitude_ids, requester),
+        headers: { 'Content-Type': 'application/json' }
+      )
+    end
+
+    private
+
+    def delete_body(user_ids, amplitude_ids, requester)
+      JSON.generate(
+        {
+          amplitude_ids: amplitude_ids,
+          user_ids: user_ids,
+          requester: requester
+        }.delete_if { |_, value| value.nil? || value.empty? }
+      )
     end
   end
 end

data/lib/amplitude_api/version.rb

@@ -1,3 +1,3 @@
 class AmplitudeAPI
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.1.1'.freeze
 end

data/readme.md

@@ -31,7 +31,7 @@ event = AmplitudeAPI::Event.new({
 AmplitudeAPI.track(event)
 ```
 
-## GDPR Compliance
+## User Privacy APIs
 
 The following code snippet will delete a user from amplitude
 
@@ -43,11 +43,12 @@ AmplitudeAPI.config.api_key = "abcdef123456"
 AmplitudeAPI.config.secret_key = "secretMcSecret"
 
 AmplitudeAPI.delete(user_ids: [233],
-  requester: "privacy@mycompany.com"
+  requester: "privacy@example.com"
 )
 ```
 
-Currently, we are using this in Rails and using ActiveJob to dispatch events asynchronously. I plan on moving background/asynchronous support into this gem.
+Currently, we are using this in Rails and using ActiveJob to dispatch events asynchronously. I plan on moving 
+background/asynchronous support into this gem.
 
 ## What's Next
 

data/spec/lib/amplitude_api_spec.rb

@@ -376,6 +376,22 @@ describe AmplitudeAPI do
   end
 
   describe '.delete' do
+    context 'a single user_id' do
+      it 'correctly formats the response' do
+        body = {
+          user_ids: ['123']
+        }
+
+        expect(Typhoeus).to receive(:post).with(
+          AmplitudeAPI::DELETION_URI_STRING,
+          userpwd: "#{described_class.api_key}:#{described_class.config.secret_key}",
+          body: JSON.generate(body),
+          headers: { 'Content-Type': 'application/json' }
+        )
+        described_class.delete(user_ids: '123')
+      end
+    end
+
     context 'with user_ids' do
       it 'sends the deletion to Amplitude' do
         user_ids =  [123, 456, 555]
@@ -386,7 +402,8 @@ describe AmplitudeAPI do
         expect(Typhoeus).to receive(:post).with(
           AmplitudeAPI::DELETION_URI_STRING,
           userpwd: "#{described_class.api_key}:#{described_class.config.secret_key}",
-          body: body
+          body: JSON.generate(body),
+          headers: { 'Content-Type': 'application/json' }
         )
         described_class.delete(user_ids: user_ids)
       end
@@ -396,14 +413,15 @@ describe AmplitudeAPI do
           user_ids =  [123, 456, 555]
           amplitude_ids = [122, 456]
           body = {
-            user_ids: user_ids,
-            amplitude_ids: amplitude_ids
+            amplitude_ids: amplitude_ids,
+            user_ids: user_ids
           }
 
           expect(Typhoeus).to receive(:post).with(
             AmplitudeAPI::DELETION_URI_STRING,
             userpwd: "#{described_class.api_key}:#{described_class.config.secret_key}",
-            body: body
+            body: JSON.generate(body),
+            headers: { 'Content-Type': 'application/json' }
           )
           described_class.delete(
             amplitude_ids: amplitude_ids,
@@ -423,12 +441,29 @@ describe AmplitudeAPI do
         expect(Typhoeus).to receive(:post).with(
           AmplitudeAPI::DELETION_URI_STRING,
           userpwd: "#{described_class.api_key}:#{described_class.config.secret_key}",
-          body: body
+          body: JSON.generate(body),
+          headers: { 'Content-Type': 'application/json' }
         )
         described_class.delete(amplitude_ids: amplitude_ids)
       end
     end
 
+    context 'a single amplitude_id' do
+      it 'correctly formats the response' do
+        body = {
+          amplitude_ids: [122]
+        }
+
+        expect(Typhoeus).to receive(:post).with(
+          AmplitudeAPI::DELETION_URI_STRING,
+          userpwd: "#{described_class.api_key}:#{described_class.config.secret_key}",
+          body: JSON.generate(body),
+          headers: { 'Content-Type': 'application/json' }
+        )
+        described_class.delete(amplitude_ids: 122)
+      end
+    end
+
     context 'with requester' do
       it 'sends the deletion to Amplitude' do
         amplitude_ids = [122, 456]
@@ -439,9 +474,12 @@ describe AmplitudeAPI do
         }
         userpwd = "#{described_class.api_key}:#{described_class.config.secret_key}"
 
-        expect(Typhoeus).to receive(:post).with(AmplitudeAPI::DELETION_URI_STRING,
-                                                userpwd: userpwd,
-                                                body: body)
+        expect(Typhoeus).to receive(:post).with(
+          AmplitudeAPI::DELETION_URI_STRING,
+          userpwd: userpwd,
+          body: JSON.generate(body),
+          headers: { 'Content-Type': 'application/json' }
+        )
         described_class.delete(
           amplitude_ids: amplitude_ids,
           requester: 'privacy@gethopscotch.com'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: amplitude-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Alex Rakoczy