amplitude-api 0.1.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf75d44cb2ccfb90961a3aa3875a245a8231edbb68d941325b6980ea10cf63d2
-  data.tar.gz: 7da5804bd41daa7c6dee8839119ad5640725b241ef8170f37919f5109f566855
+  metadata.gz: 59e87e342af629c6e87369ef210a272186236ec4e4ef9f9a101a2a590da59204
+  data.tar.gz: 7e207b30db0550982c4280aa0da2d3c225b1598cfd2bcba1971e8a75238e142e
 SHA512:
-  metadata.gz: 4979e1f81be283bf3324de9269ce36131ce16f3bd3dbb6bd257eb98d7f8e0e30e669bfb8cc6738eed1e29f2543eddf34b19448fb379814c63fb273ab25726863
-  data.tar.gz: 4301bb508042b66a85b4754e352bca971a3acb0cdee00b81ce6b1bb9359f1120770f70c16e59c71a9e4279d38b32ac5904108b8a4ddf2fe69767fea77ad0fd87
+  metadata.gz: 42aa5d35506dcaebb8a9db1e973081f38d0259eacc1da1eeeae6d530fc92055dfc70f749e4b19a4e28e3b726e92abae52e575207f1fadfa483bd2b6d6abba771
+  data.tar.gz: 7e97e56ac203bee46e1740e937c0869cb310d8c4edbc88ce6c2603446c5ad0989e52ffbf327be61680813ff2e92808a9ae91e09d0de9e4de5f4cedae590c2415

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,7 +1,5 @@
 language: ruby
 cache: bundler
 rvm:
-  - 2.6.1
-  - 2.4.6
-  - 2.3.8
-  - 2.2.10
+  - 2.6
+  - 2.4

data/Changelog.md

@@ -3,6 +3,16 @@
 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.0 (2021-02-22)
+
+* Changes Typhoeus to Faraday to launch requests
+* 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.
@@ -10,7 +20,7 @@ suggestions, ideas and improvements to Amplitude API.
 ## 0.1.0 (2019-01-01)
 
 * Update Gem dependencies (thanks @kolorahl, @itamar, @krettan)
-* Minimum ruby version is now 2.2 
+* Minimum ruby version is now 2.2
 * Support Delete API (thanks @samjohn)
 * Fix bundle Inline (thanks @jonduarte)
 * Many fixes from @kolorahl

data/Gemfile

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 # Generated from /Users/alex/development/amplitude-api/amplitude-api.gemspec
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-gem 'typhoeus', '~> 1.1'
+gem "faraday", "~> 1.3"
 
 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'
+  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

data/Gemfile.lock

@@ -4,11 +4,14 @@ GEM
     ast (2.4.0)
     coderay (1.1.2)
     diff-lcs (1.3)
-    ethon (0.12.0)
-      ffi (>= 1.3.0)
-    ffi (1.10.0)
+    faraday (1.3.0)
+      faraday-net_http (~> 1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords
+    faraday-net_http (1.0.1)
     jaro_winkler (1.5.2)
     method_source (0.9.2)
+    multipart-post (2.1.1)
     parallel (1.17.0)
     parser (2.6.2.0)
       ast (~> 2.4.0)
@@ -17,7 +20,7 @@ GEM
       method_source (~> 0.9.0)
     psych (3.1.0)
     rainbow (3.0.0)
-    rake (12.3.2)
+    rake (12.3.3)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -42,20 +45,19 @@ GEM
     rubocop-rspec (1.32.0)
       rubocop (>= 0.60.0)
     ruby-progressbar (1.10.0)
-    typhoeus (1.3.1)
-      ethon (>= 0.9.0)
+    ruby2_keywords (0.0.4)
     unicode-display_width (1.5.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  faraday (~> 1.3)
   pry (~> 0.12.2)
   rake (>= 12.0)
   rspec (>= 2.99.0)
   rubocop (~> 0.66.0)
   rubocop-rspec
-  typhoeus (~> 1.1)
 
 BUNDLED WITH
-   1.17.2
+   1.17.3

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.3"
+  spec.required_ruby_version = ">= 2.4"
 end

data/lib/amplitude-api.rb

@@ -1,4 +1,3 @@
-# rubocop:disable Naming/FileName
-require_relative 'amplitude_api'
-# rubocop:enable Naming/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
@@ -43,7 +45,7 @@ class AmplitudeAPI
     # @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,10 @@ class AmplitudeAPI
     def track_body(*events)
       event_body = events.flatten.map(&:to_hash)
 
-      {
+      JSON.generate(
         api_key: api_key,
-        event: JSON.generate(event_body)
-      }
+        events: event_body
+      )
     end
 
     # @overload track(event)
@@ -80,11 +82,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,11 +125,11 @@ 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
@@ -150,13 +152,13 @@ class AmplitudeAPI
     # @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],
@@ -174,29 +176,38 @@ class AmplitudeAPI
     # based on the amplitude database
     # @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)
+    # @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)
-      Typhoeus.post(
+
+      faraday = Faraday.new do |conn|
+        conn.basic_auth config.api_key, config.secret_key
+      end
+
+      faraday.post(
         DELETION_URI_STRING,
-        userpwd: "#{api_key}:#{config.secret_key}",
-        body: delete_body(user_ids, amplitude_ids, requester),
-        headers: { 'Content-Type': 'application/json' }
+        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)
-      JSON.generate(
-        {
-          amplitude_ids: amplitude_ids,
-          user_ids: user_ids,
-          requester: requester
-        }.delete_if { |_, value| value.nil? || value.empty? }
-      )
+    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
@@ -13,13 +15,32 @@ class AmplitudeAPI
     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 || {} }

data/lib/amplitude_api/event.rb

@@ -1,3 +1,9 @@
+# frozen_string_literal: true
+
+# This class is 115 lines long. It's on the limit, it should be refactored before
+# including more code.
+#
+# rubocop:disable Metrics/ClassLength
 class AmplitudeAPI
   # AmplitudeAPI::Event
   class Event
@@ -7,13 +13,43 @@ class AmplitudeAPI
 
     # Create a new Event
     #
-    # See (Amplitude HTTP API Documentation)[https://amplitude.zendesk.com/hc/en-us/articles/204771828-HTTP-API]
+    # See (Amplitude HTTP API Documentation)[https://developers.amplitude.com/docs/http-api-v2]
     # for a list of valid parameters and their types.
     def initialize(attributes = {})
       attributes.each do |k, v|
         send("#{k}=", v) if respond_to?("#{k}=")
       end
       validate_arguments
+      @extra_properties = []
+    end
+
+    def method_missing(method_name, *args)
+      super if block_given?
+
+      property_name = method_name.to_s.delete_suffix("=")
+
+      @extra_properties << property_name
+
+      create_setter property_name
+      create_getter property_name
+
+      send("#{property_name}=".to_sym, *args)
+    end
+
+    def create_setter(attribute_name)
+      self.class.send(:define_method, "#{attribute_name}=".to_sym) do |value|
+        instance_variable_set("@" + attribute_name.to_s, value)
+      end
+    end
+
+    def create_getter(attribute_name)
+      self.class.send(:define_method, attribute_name.to_sym) do
+        instance_variable_get("@" + attribute_name.to_s)
+      end
+    end
+
+    def respond_to_missing?(method_name, *args)
+      @extra_properties.include?(method_name) || @extra_properties.include?("#{method_name}=") || super
     end
 
     def user_id=(value)
@@ -36,28 +72,42 @@ class AmplitudeAPI
       }
       event[:user_id] = user_id if user_id
       event[:device_id] = device_id if device_id
-      event.merge(optional_properties).merge(revenue_hash)
+      event.merge(optional_properties).merge(revenue_hash).merge(extra_properties)
     end
     alias to_h to_hash
 
     # @return [ Hash ] Optional properties
+    #
+    # Returns optional properties (belong to the API but are optional)
     def optional_properties
-      %i[device_id time ip platform country insert_id].map do |prop|
+      AmplitudeAPI::Config.optional_properties.map do |prop|
         val = prop == :time ? formatted_time : send(prop)
         val ? [prop, val] : nil
       end.compact.to_h
     end
 
+    # @return [ Hash ] Extra properties
+    #
+    # Returns optional properties (not belong to the API, are assigned by the user)
+    # This way, if the API is updated with new properties, the gem will be able
+    # to work with the new specification until the code is modified
+    def extra_properties
+      @extra_properties.map do |prop|
+        val = send(prop)
+        val ? [prop.to_sym, val] : nil
+      end.compact.to_h
+    end
+
     # @return [ true, false ]
     #
     # Returns true if the event type matches one reserved by Amplitude API.
     def reserved_event?(type)
-      ['[Amplitude] Start Session',
-       '[Amplitude] End Session',
-       '[Amplitude] Revenue',
-       '[Amplitude] Revenue (Verified)',
-       '[Amplitude] Revenue (Unverified)',
-       '[Amplitude] Merged User'].include?(type)
+      ["[Amplitude] Start Session",
+       "[Amplitude] End Session",
+       "[Amplitude] Revenue",
+       "[Amplitude] Revenue (Verified)",
+       "[Amplitude] Revenue (Unverified)",
+       "[Amplitude] Merged User"].include?(type)
     end
 
     # @return [ true, false ]
@@ -89,15 +139,23 @@ class AmplitudeAPI
     end
 
     def validate_required_arguments
-      raise ArgumentError, 'You must provide user_id or device_id (or both)' unless user_id || device_id
-      raise ArgumentError, 'You must provide event_type' unless event_type
-      raise ArgumentError, 'Invalid event_type - cannot match a reserved event name' if reserved_event?(event_type)
+      raise ArgumentError, "You must provide user_id or device_id (or both)" unless user_id || device_id
+      raise ArgumentError, "You must provide event_type" unless event_type
+      raise ArgumentError, "Invalid event_type - cannot match a reserved event name" if reserved_event?(event_type)
     end
 
     def validate_revenue_arguments
-      return self.quantity ||= 1 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
+      return true if !revenue_type && !product_id
+      return true if revenue || price
+
+      raise ArgumentError, revenue_error_message
+    end
+
+    def revenue_error_message
+      error_field = "product_id" if product_id
+      error_field = "revenue_type" if revenue_type
+
+      "You must provide a price or a revenue in order to use the field #{error_field}"
     end
 
     def revenue_hash
@@ -106,6 +164,7 @@ class AmplitudeAPI
       revenue_hash[:revenueType] = revenue_type if revenue_type
       revenue_hash[:quantity] = quantity if quantity
       revenue_hash[:price] = price if price
+      revenue_hash[:revenue] = revenue if revenue
       revenue_hash
     end
 
@@ -114,3 +173,4 @@ class AmplitudeAPI
     end
   end
 end
+# rubocop:enable Metrics/ClassLength