amplitude-api 0.1.0 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b743d15865f804837f6f3abb9557fa35aa6a32ae360fae0edfeaab0e7905b81
-  data.tar.gz: 8c58bd5c4a21a36394cca7ce58da56b1e4135fc4ac574001e31350bda5cf3d69
+  metadata.gz: e4372cbca5a551be9721be89fbbe3ee80dc9216d8fa44fba7b0031a5e62785cd
+  data.tar.gz: ee6056b7e64c2b51f9365a8e57c90a1b4b8fc5edc406b1f7cbabf4caf831b7ad
 SHA512:
-  metadata.gz: 3bf4707b9fe9905e95fdeee4c66044dfce02a2f4bae7fe939cffc343957ff4b2eb3d0dcf41d9c9dc958048f14fc8039c5d4e5c375103b7aeec4260e5a5a5c2d5
-  data.tar.gz: 6cb4d59c569e8ccb3d8fc1f52920baba4ae6fa1da605115e6ed393a05119d1b275e58d00d18349cb840dd84b11b58416f3639e31eb95e4fb6c88eac55a378084
+  metadata.gz: f55a3e558f985bac1d78ac842532dfd5dfc69290f7ece8f9c197c71f155ae802de8a00649c5be9bcdd4a67e995e59eaf9cbcc3586808ddfedbb00aba259cf39b
+  data.tar.gz: 3e6d679080a879ccf02ab29b3f13839b29c78bfb28cd48793275345ca41b77a61d09231e82d3cc4132319d14eef0ac807e5fa589330a1e0f84486fa534f875a4

data/.gitignore

@@ -27,11 +27,12 @@ build/
 
 # for a library or gem, you might want to ignore these files since the code is
 # intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
-# .ruby-version
-# .ruby-gemset
+Gemfile.lock
+.ruby-version
+.ruby-gemset
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
 
-.idea
+.idea
+amplitude-api.iml

data/.rubocop.yml

@@ -1,8 +1,26 @@
 require: rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.4
+
 Metrics/LineLength:
   Max: 120
 
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+  SupportedStyles:
+    - single_quotes
+    - double_quotes
+
+Style/BlockDelimiters:
+  Enabled: true
+  Exclude:
+    - spec/**/*
+
 # Disable some failing rspec cops that fail from upgrading gems until we can clean things up a bit.
+Naming/FileName:
+  Exclude:
+    - lib/amplitude-api.rb
 RSpec/ExampleLength:
   Enabled: false
 Metrics/BlockLength:
@@ -14,4 +32,4 @@ RSpec/NestedGroups:
 RSpec/MessageSpies:
   Enabled: false
 RSpec/ContextWording:
-  Enabled: false
+  Enabled: false

data/.travis.yml

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

data/Changelog.md

@@ -3,6 +3,38 @@
 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.3 (2021-02-24)
+* Relaxes Faraday dependency
+
+## 0.3.2 (2021-02-23)
+* Creates new properties on initialization
+
+## 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 (**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.
+
+## 0.2.0 (2021-02-14)
+
+* Updates gem to use HTTP API V2.
+
+## 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/Gemfile

@@ -1,12 +1,3 @@
-# Generated from /Users/alex/development/amplitude-api/amplitude-api.gemspec
-source 'https://rubygems.org'
-
-gem 'typhoeus', '~> 1.1'
-
-group :development, :test do
-  gem 'pry', '~> 0.12.2'
-  gem 'rake', '>= 12.0'
-  gem 'rspec', '>= 2.99.0'
-  gem 'rubocop', '~> 0.66.0', require: false
-  gem 'rubocop-rspec'
-end
+# frozen_string_literal: true
+source "https://rubygems.org"
+gemspec

data/Rakefile

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

data/amplitude-api.gemspec

@@ -1,25 +1,27 @@
-lib = File.expand_path('lib', __dir__)
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
 $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       = '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.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 'pry', '~> 0.12.2'
-  spec.add_development_dependency 'rake', '~> 12.0', '>= 12.0'
-  spec.add_development_dependency 'rspec', '~> 2.99', '>= 2.99.0'
-  spec.add_dependency 'typhoeus', '~> 1.0'
-  spec.required_ruby_version = '~> 2.2'
+  spec.add_development_dependency "pry", "~> 0.12.2"
+  spec.add_development_dependency "rake", "~> 12.0", ">= 12.0"
+  spec.add_development_dependency "rspec", "~> 2.99", ">= 2.99.0"
+  spec.add_dependency "faraday", "~> 1.0"
+  spec.required_ruby_version = ">= 2.4"
 end

data/lib/amplitude-api.rb

@@ -1,4 +1,3 @@
-# rubocop:disable Style/FileName
-require_relative 'amplitude_api'
-# rubocop:enable Style/FileName
-# Whoops.
+# frozen_string_literal: true
+
+require_relative "amplitude_api"

data/lib/amplitude_api.rb

@@ -1,18 +1,20 @@
-require 'json'
-require 'typhoeus'
+# frozen_string_literal: true
+
+require "json"
+require "faraday"
 
 # AmplitudeAPI
 class AmplitudeAPI
-  require_relative 'amplitude_api/config'
-  require_relative 'amplitude_api/event'
-  require_relative 'amplitude_api/identification'
+  require_relative "amplitude_api/config"
+  require_relative "amplitude_api/event"
+  require_relative "amplitude_api/identification"
 
-  TRACK_URI_STRING        = 'https://api.amplitude.com/httpapi'.freeze
-  IDENTIFY_URI_STRING     = 'https://api.amplitude.com/identify'.freeze
-  SEGMENTATION_URI_STRING = 'https://amplitude.com/api/2/events/segmentation'.freeze
-  DELETION_URI_STRING     = 'https://amplitude.com/api/2/deletions/users'.freeze
+  TRACK_URI_STRING        = "https://api.amplitude.com/2/httpapi"
+  IDENTIFY_URI_STRING     = "https://api.amplitude.com/identify"
+  SEGMENTATION_URI_STRING = "https://amplitude.com/api/2/events/segmentation"
+  DELETION_URI_STRING     = "https://amplitude.com/api/2/deletions/users"
 
-  USER_WITH_NO_ACCOUNT = "user who doesn't have an account".freeze
+  USER_WITH_NO_ACCOUNT = "user who doesn't have an account"
 
   class << self
     def config
@@ -38,12 +40,12 @@ 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 ]
+    # @return [ Faraday::Response ]
     def send_event(event_name, user, device, options = {})
       event = AmplitudeAPI::Event.new(
         user_id: user,
@@ -68,10 +70,13 @@ class AmplitudeAPI
     def track_body(*events)
       event_body = events.flatten.map(&:to_hash)
 
-      {
+      body = {
         api_key: api_key,
-        event: JSON.generate(event_body)
+        events: event_body
       }
+      body[:options] = config.options if config.options
+
+      JSON.generate(body)
     end
 
     # @overload track(event)
@@ -80,11 +85,11 @@ class AmplitudeAPI
     # @overload track([events])
     #   @param [ Array<AmplitudeAPI::Event> ] Send an array of events in a single request to Amplitude
     #
-    # @return [ Typhoeus::Response ]
+    # @return [ Faraday::Response ]
     #
     # Send one or more Events to the Amplitude API
     def track(*events)
-      Typhoeus.post(TRACK_URI_STRING, body: track_body(events))
+      Faraday.post(TRACK_URI_STRING, track_body(events), "Content-Type" => "application/json")
     end
 
     # ==== Identification related methods
@@ -123,40 +128,40 @@ class AmplitudeAPI
     # @overload identify([identifications])
     #   @param [ Array<AmplitudeAPI::Identify> ] Send an array of identifications in a single request to Amplitude
     #
-    # @return [ Typhoeus::Response ]
+    # @return [ Faraday::Response ]
     #
     # Send one or more Identifications to the Amplitude Identify API
     def identify(*identifications)
-      Typhoeus.post(IDENTIFY_URI_STRING, body: identify_body(identifications))
+      Faraday.post(IDENTIFY_URI_STRING, identify_body(identifications))
     end
 
     # ==== Event Segmentation related methods
 
     # 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 ]
+    # @return [ Faraday::Response ]
     def segmentation(event, start_time, end_time, **options)
-      Typhoeus.get SEGMENTATION_URI_STRING, userpwd: "#{api_key}:#{secret_key}", params: {
+      Faraday.get SEGMENTATION_URI_STRING, userpwd: "#{api_key}:#{secret_key}", params: {
         e: event.to_json,
         m: options[:m],
-        start: start_time.strftime('%Y%m%d'),
-        end: end_time.strftime('%Y%m%d'),
+        start: start_time.strftime("%Y%m%d"),
+        end: end_time.strftime("%Y%m%d"),
         i: options[:i],
         s: (options[:s] || []).map(&:to_json),
         g: options[:g],
@@ -164,27 +169,48 @@ 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? }
+    # @param [ Boolean ] (optional) ignore any invalid user IDs(users that do no
+    # exist in the project) that were passed in
+    # @param [ Boolean ] (optional) delete from the entire org rather than just
+    # this project.
+    # @return [ Faraday::Response ]
+    def delete(user_ids: nil, amplitude_ids: nil, requester: nil, ignore_invalid_id: nil, delete_from_org: nil)
+      user_ids = Array(user_ids)
+      amplitude_ids = Array(amplitude_ids)
+
+      faraday = Faraday.new do |conn|
+        conn.basic_auth config.api_key, config.secret_key
+      end
+
+      faraday.post(
+        DELETION_URI_STRING,
+        delete_body(user_ids, amplitude_ids, requester, ignore_invalid_id, delete_from_org),
+        "Content-Type" => "application/json"
+      )
+    end
+
+    private
+
+    def delete_body(user_ids, amplitude_ids, requester, ignore_invalid_id, delete_from_org)
+      body = {
+        amplitude_ids: amplitude_ids,
+        user_ids: user_ids,
+        requester: requester
+      }.delete_if { |_, value| value.nil? || value.empty? }
+
+      body[:ignore_invalid_id] = ignore_invalid_id.to_s if ignore_invalid_id
+      body[:delete_from_org] = delete_from_org.to_s if delete_from_org
+      JSON.generate(body)
     end
   end
 end

data/lib/amplitude_api/config.rb

@@ -1,4 +1,6 @@
-require 'singleton'
+# frozen_string_literal: true
+
+require "singleton"
 
 class AmplitudeAPI
   # AmplitudeAPI::Config
@@ -6,20 +8,40 @@ 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) }
     end
 
     class << self
+      def base_properties
+        %i[event_type event_properties user_properties user_id device_id]
+      end
+
+      def revenue_properties
+        %i[revenue_type product_id revenue price quantity]
+      end
+
+      def optional_properties
+        %i[
+          time
+          ip platform country insert_id
+          groups app_version os_name os_version
+          device_brand device_manufacturer device_model
+          carrier region city dma language
+          location_lat location_lng
+          idfa idfv adid android_id
+          event_id session_id
+        ]
+      end
+
       def defaults
         {
           api_key: nil,
           secret_key: nil,
-          whitelist: %i[user_id device_id event_type time
-                        event_properties user_properties time ip platform country insert_id
-                        revenue_type price quantity product_id],
+          whitelist: base_properties + revenue_properties + optional_properties,
           time_formatter: ->(time) { time ? time.to_i * 1_000 : nil },
           event_properties_formatter: ->(props) { props || {} },
           user_properties_formatter: ->(props) { props || {} }