amplitude-api 0.0.10 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0e82b9bf2580f2da3bd76a71cb172ca89d051d3f
-  data.tar.gz: 8d437b02ece1c511b0f5256ee81f4e4b94fa8494
+SHA256:
+  metadata.gz: 275373a4c26fc2028070205735f535ab9411dad8c98986c1dae0793e44098106
+  data.tar.gz: 5d79d4ff3ebc1218f5ce1ddff49fc5c323b250862db1e4c4e5136f76c3eb6f1e
 SHA512:
-  metadata.gz: 0df83a07615c485e264d00522359ab188e93f462e9e30d77ca6053d0dbc771a534062afc2148b60025ca221eddf1378727a8bcac46f25ec2c5f8480a5dd6ab4f
-  data.tar.gz: e9506a8d285f98d90a80ea28b7e80a337f3749597dbcf3be95f170bb7ca1a66cb5cd810fcbffcb020041ccb620cdb5ee547f6bb382cefd1644f5d10639a25264
+  metadata.gz: af5c1085ae807de968a2737ec4eab0da585baca1596ac38caed7960b457d854d7e83e4a0fa0fbf9826164239891d047fbc0e3e1801104696e5323fd05f0e3b7c
+  data.tar.gz: 12817cbd4e8929d02cea2b2499bbe309d459fcc1388e9b70003503e6d3df00e974185342bfae02e9d61cdf5d8b4af296616af1dc720db42f91a456b56f70452c

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/.rubocop.yml

@@ -1,3 +1,35 @@
 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:
+  Enabled: false
+RSpec/MultipleExpectations:
+  Enabled: false
+RSpec/NestedGroups:
+  Enabled: false
+RSpec/MessageSpies:
+  Enabled: false
+RSpec/ContextWording:
+  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

@@ -0,0 +1,41 @@
+# Amplitude API Changelog
+
+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.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)).
+
+## Older releases
+
+Please see the v0.0.9 tag.

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.0.2'
+gem "faraday", "~> 1.3"
 
 group :development, :test do
-  gem 'pry', '~> 0.9.12.6'
-  gem 'rake', '>= 10.0'
-  gem 'rspec', '>= 2.99.0'
-  gem 'rubocop', '~> 0.37.2', 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

@@ -1,58 +1,63 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.2.0)
-    coderay (1.1.1)
-    diff-lcs (1.2.5)
-    ethon (0.9.0)
-      ffi (>= 1.3.0)
-    ffi (1.9.14)
-    method_source (0.8.2)
-    parser (2.3.0.6)
-      ast (~> 2.2)
-    powerpack (0.1.1)
-    pry (0.9.12.6)
-      coderay (~> 1.0)
-      method_source (~> 0.8)
-      slop (~> 3.4)
-    rainbow (2.1.0)
-    rake (10.5.0)
-    rspec (3.4.0)
-      rspec-core (~> 3.4.0)
-      rspec-expectations (~> 3.4.0)
-      rspec-mocks (~> 3.4.0)
-    rspec-core (3.4.3)
-      rspec-support (~> 3.4.0)
-    rspec-expectations (3.4.0)
+    ast (2.4.0)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    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)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    psych (3.1.0)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-mocks (3.4.1)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-support (3.4.1)
-    rubocop (0.37.2)
-      parser (>= 2.3.0.4, < 3.0)
-      powerpack (~> 0.1)
-      rainbow (>= 1.99.1, < 3.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.66.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      psych (>= 3.1.0)
+      rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 0.3)
-    rubocop-rspec (1.4.0)
-    ruby-progressbar (1.7.5)
-    slop (3.6.0)
-    typhoeus (1.0.2)
-      ethon (>= 0.9.0)
-    unicode-display_width (0.3.1)
+      unicode-display_width (>= 1.4.0, < 1.6)
+    rubocop-rspec (1.32.0)
+      rubocop (>= 0.60.0)
+    ruby-progressbar (1.10.0)
+    ruby2_keywords (0.0.4)
+    unicode-display_width (1.5.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  pry (~> 0.9.12.6)
-  rake (>= 10.0)
+  faraday (~> 1.3)
+  pry (~> 0.12.2)
+  rake (>= 12.0)
   rspec (>= 2.99.0)
-  rubocop (~> 0.37.2)
+  rubocop (~> 0.66.0)
   rubocop-rspec
-  typhoeus (~> 1.0.2)
 
 BUNDLED WITH
-   1.10.6
+   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,26 +1,27 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# 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 'rspec', '~> 2.99', '>= 2.99.0'
-  spec.add_development_dependency 'rake', '~> 10.0', '>= 10.0'
-  spec.add_development_dependency 'pry', '~> 0.9.12.6'
-  spec.add_dependency 'typhoeus', '~> 1.0.2'
-  spec.required_ruby_version = '~> 2.0'
+  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 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,25 +1,37 @@
-require 'json'
-require 'bundler/setup'
-require 'typhoeus'
-require_relative 'amplitude_api/event'
-require_relative 'amplitude_api/identification'
+# frozen_string_literal: true
+
+require "json"
+require "faraday"
 
 # AmplitudeAPI
 class AmplitudeAPI
-  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
+  require_relative "amplitude_api/config"
+  require_relative "amplitude_api/event"
+  require_relative "amplitude_api/identification"
+
+  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
-    # @!attribute [ rw ] api_key
-    #   @return [ String ] an Amplitude API Key
-    attr_accessor :api_key
+    def config
+      Config.instance
+    end
 
-    # @!attribute [ rw ] secret_key
-    #   @return [ String ] an Amplitude Secret Key
-    attr_accessor :secret_key
+    def configure
+      yield config
+    end
+
+    def api_key
+      config.api_key
+    end
+
+    def secret_key
+      config.secret_key
+    end
 
     # ==== Event Tracking related methods
 
@@ -28,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,
@@ -58,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)
@@ -70,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
@@ -113,45 +128,89 @@ 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 ]
-    def segmentation(e, start_time, end_time, **options)
-      Typhoeus.get SEGMENTATION_URI_STRING, userpwd: "#{api_key}:#{secret_key}", params: {
-        e:     e.to_json,
-        m:     options[:m],
-        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],
+    # @return [ Faraday::Response ]
+    def segmentation(event, start_time, end_time, **options)
+      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"),
+        i: options[:i],
+        s: (options[:s] || []).map(&:to_json),
+        g: options[:g],
         limit: options[:limit]
       }.delete_if { |_, value| value.nil? }
     end
+
+    # Delete a user from amplitude
+    #
+    # You must pass in either an array of user_ids or an array of amplitude_ids
+    #
+    # @param [ Array<String> ] (optional) the user_ids to delete
+    # based on your database
+    # @param [ Array<Integer> ] (optional) the amplitude_ids to delete
+    # based on the amplitude database
+    # @param [ String ] requester the email address of the person who
+    # is requesting the deletion, optional but useful for reporting
+    # @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