amplitude-api 0.0.10 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0e82b9bf2580f2da3bd76a71cb172ca89d051d3f
-  data.tar.gz: 8d437b02ece1c511b0f5256ee81f4e4b94fa8494
+SHA256:
+  metadata.gz: 8b743d15865f804837f6f3abb9557fa35aa6a32ae360fae0edfeaab0e7905b81
+  data.tar.gz: 8c58bd5c4a21a36394cca7ce58da56b1e4135fc4ac574001e31350bda5cf3d69
 SHA512:
-  metadata.gz: 0df83a07615c485e264d00522359ab188e93f462e9e30d77ca6053d0dbc771a534062afc2148b60025ca221eddf1378727a8bcac46f25ec2c5f8480a5dd6ab4f
-  data.tar.gz: e9506a8d285f98d90a80ea28b7e80a337f3749597dbcf3be95f170bb7ca1a66cb5cd810fcbffcb020041ccb620cdb5ee547f6bb382cefd1644f5d10639a25264
+  metadata.gz: 3bf4707b9fe9905e95fdeee4c66044dfce02a2f4bae7fe939cffc343957ff4b2eb3d0dcf41d9c9dc958048f14fc8039c5d4e5c375103b7aeec4260e5a5a5c2d5
+  data.tar.gz: 6cb4d59c569e8ccb3d8fc1f52920baba4ae6fa1da605115e6ed393a05119d1b275e58d00d18349cb840dd84b11b58416f3639e31eb95e4fb6c88eac55a378084

data/.rubocop.yml

@@ -1,3 +1,17 @@
 require: rubocop-rspec
 Metrics/LineLength:
   Max: 120
+
+# Disable some failing rspec cops that fail from upgrading gems until we can clean things up a bit.
+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/Changelog.md

@@ -0,0 +1,12 @@
+# 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.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,12 @@
 # Generated from /Users/alex/development/amplitude-api/amplitude-api.gemspec
 source 'https://rubygems.org'
 
-gem 'typhoeus', '~> 1.0.2'
+gem 'typhoeus', '~> 1.1'
 
 group :development, :test do
-  gem 'pry', '~> 0.9.12.6'
-  gem 'rake', '>= 10.0'
+  gem 'pry', '~> 0.12.2'
+  gem 'rake', '>= 12.0'
   gem 'rspec', '>= 2.99.0'
-  gem 'rubocop', '~> 0.37.2', require: false
+  gem 'rubocop', '~> 0.66.0', require: false
   gem 'rubocop-rspec'
 end

data/Gemfile.lock

@@ -1,58 +1,61 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.2.0)
-    coderay (1.1.1)
-    diff-lcs (1.2.5)
-    ethon (0.9.0)
+    ast (2.4.0)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    ethon (0.12.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)
+    ffi (1.10.0)
+    jaro_winkler (1.5.2)
+    method_source (0.9.2)
+    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.2)
+    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)
+      unicode-display_width (>= 1.4.0, < 1.6)
+    rubocop-rspec (1.32.0)
+      rubocop (>= 0.60.0)
+    ruby-progressbar (1.10.0)
+    typhoeus (1.3.1)
       ethon (>= 0.9.0)
-    unicode-display_width (0.3.1)
+    unicode-display_width (1.5.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  pry (~> 0.9.12.6)
-  rake (>= 10.0)
+  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)
+  typhoeus (~> 1.1)
 
 BUNDLED WITH
-   1.10.6
+   1.17.2

data/amplitude-api.gemspec

@@ -1,5 +1,4 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'amplitude_api/version'
 
@@ -18,9 +17,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   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_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_dependency 'typhoeus', '~> 1.0'
+  spec.required_ruby_version = '~> 2.2'
 end

data/lib/amplitude_api.rb

@@ -1,25 +1,35 @@
 require 'json'
-require 'bundler/setup'
 require 'typhoeus'
-require_relative 'amplitude_api/event'
-require_relative 'amplitude_api/identification'
 
 # AmplitudeAPI
 class AmplitudeAPI
+  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
 
   USER_WITH_NO_ACCOUNT = "user who doesn't have an account".freeze
 
   class << self
-    # @!attribute [ rw ] api_key
-    #   @return [ String ] an Amplitude API Key
-    attr_accessor :api_key
+    def config
+      Config.instance
+    end
+
+    def configure
+      yield config
+    end
 
-    # @!attribute [ rw ] secret_key
-    #   @return [ String ] an Amplitude Secret Key
-    attr_accessor :secret_key
+    def api_key
+      config.api_key
+    end
+
+    def secret_key
+      config.secret_key
+    end
 
     # ==== Event Tracking related methods
 
@@ -141,17 +151,40 @@ class AmplitudeAPI
     # returned (default: 100). The maximum limit is 1000.
     #
     # @return [ Typhoeus::Response ]
-    def segmentation(e, start_time, end_time, **options)
+    def segmentation(event, start_time, end_time, **options)
       Typhoeus.get SEGMENTATION_URI_STRING, userpwd: "#{api_key}:#{secret_key}", params: {
-        e:     e.to_json,
-        m:     options[:m],
+        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],
+        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
+
+    # ==== GDPR compliance methods
+
+    # Delete a user from amplitude when they request it to comply with GDPR
+    # 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
+    # based on your database
+    # @param [ amplitude_ids ] (optional) the amplitude_ids to delete
+    # based on the amplitude database
+    # @param [ 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? }
+    end
   end
 end

data/lib/amplitude_api/config.rb

@@ -0,0 +1,30 @@
+require 'singleton'
+
+class AmplitudeAPI
+  # AmplitudeAPI::Config
+  class Config
+    include Singleton
+
+    attr_accessor :api_key, :secret_key, :whitelist, :time_formatter,
+                  :event_properties_formatter, :user_properties_formatter
+
+    def initialize
+      self.class.defaults.each { |k, v| send("#{k}=", v) }
+    end
+
+    class << self
+      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],
+          time_formatter: ->(time) { time ? time.to_i * 1_000 : nil },
+          event_properties_formatter: ->(props) { props || {} },
+          user_properties_formatter: ->(props) { props || {} }
+        }
+      end
+    end
+  end
+end

data/lib/amplitude_api/event.rb

@@ -1,71 +1,19 @@
 class AmplitudeAPI
   # AmplitudeAPI::Event
   class Event
-    # @!attribute [ rw ] user_id
-    #   @return [ String ] the user_id to be sent to Amplitude
-    attr_accessor :user_id
-    # @!attribute [ rw ] device_id
-    #   @return [ String ] the device_id to be sent to Amplitude
-    attr_accessor :device_id
-    # @!attribute [ rw ] event_type
-    #   @return [ String ] the event_type to be sent to Amplitude
-    attr_accessor :event_type
-    # @!attribute [ rw ] event_properties
-    #   @return [ String ] the event_properties to be attached to the Amplitude Event
-    attr_accessor :event_properties
-    # @!attribute [ rw ] user_properties
-    #   @return [ String ] the user_properties to be passed for the user
-    attr_accessor :user_properties
-    # @!attribute [ rw ] time
-    #   @return [ Time ] Time that the event occurred (defaults to now)
-    attr_accessor :time
-    # @!attribute [ rw ] ip
-    #   @return [ String ] IP address of the user
-    attr_accessor :ip
-
-    # @!attribute [ rw ] insert_id
-    #   @return [ String ] the unique identifier to be sent to Amplitude
-    attr_accessor :insert_id
-
-    # @!attribute [ rw ] price
-    #   @return [ String ] (required for revenue data) price of the item purchased
-    attr_accessor :price
-
-    # @!attribute [ rw ] quantity
-    #   @return [ String ] (required for revenue data, defaults to 1 if not specified) quantity of the item purchased
-    attr_accessor :quantity
-
-    # @!attribute [ rw ] product_id
-    #   @return [ String ] an identifier for the product. (Note: you must send a price and quantity with this field)
-    attr_accessor :product_id
-
-    # @!attribute [ rw ] revenue_type
-    #   @return [ String ] type of revenue. (Note: you must send a price and quantity with this field)
-    attr_accessor :revenue_type
+    AmplitudeAPI::Config.instance.whitelist.each do |attribute|
+      instance_eval("attr_accessor :#{attribute}", __FILE__, __LINE__)
+    end
 
     # Create a new Event
     #
-    # @param [ String ] user_id a user_id to associate with the event
-    # @param [ String ] device_id a device_id to associate with the event
-    # @param [ String ] event_type a name for the event
-    # @param [ Hash ] event_properties various properties to attach to the event
-    # @param [ Time ] Time that the event occurred (defaults to now)
-    # @param [ Double ] price (optional, but required for revenue data) price of the item purchased
-    # @param [ Integer ] quantity (optional, but required for revenue data) quantity of the item purchased
-    # @param [ String ] product_id (optional) an identifier for the product.
-    # @param [ String ] revenue_type (optional) type of revenue
-    # @param [ String ] IP address of the user
-    # @param [ String ] insert_id a unique identifier for the event
+    # See (Amplitude HTTP API Documentation)[https://amplitude.zendesk.com/hc/en-us/articles/204771828-HTTP-API]
+    # for a list of valid parameters and their types.
     def initialize(attributes = {})
-      self.user_id = getopt(attributes, :user_id, '')
-      self.device_id = getopt(attributes, :device_id, nil)
-      self.event_type = getopt(attributes, :event_type, '')
-      self.event_properties = getopt(attributes, :event_properties, {})
-      self.user_properties = getopt(attributes, :user_properties, {})
-      self.time = getopt(attributes, :time)
-      self.ip = getopt(attributes, :ip, '')
-      self.insert_id = getopt(attributes, :insert_id)
-      validate_revenue_arguments(attributes)
+      attributes.each do |k, v|
+        send("#{k}=", v) if respond_to?("#{k}=")
+      end
+      validate_arguments
     end
 
     def user_id=(value)
@@ -81,47 +29,73 @@ class AmplitudeAPI
     #
     # Used for serialization and comparison
     def to_hash
-      serialized_event = {}
-      serialized_event[:event_type] = event_type
-      serialized_event[:user_id] = user_id
-      serialized_event[:event_properties] = event_properties
-      serialized_event[:user_properties] = user_properties
-      serialized_event = add_optional_properties(serialized_event)
-      serialized_event.merge(revenue_hash)
+      event = {
+        event_type: event_type,
+        event_properties: formatted_event_properties,
+        user_properties: formatted_user_properties
+      }
+      event[:user_id] = user_id if user_id
+      event[:device_id] = device_id if device_id
+      event.merge(optional_properties).merge(revenue_hash)
+    end
+    alias to_h to_hash
+
+    # @return [ Hash ] Optional properties
+    def optional_properties
+      %i[device_id time ip platform country insert_id].map do |prop|
+        val = prop == :time ? formatted_time : send(prop)
+        val ? [prop, val] : nil
+      end.compact.to_h
     end
 
-    # @return [ Hash ] A serialized Event with optional properties
-    def add_optional_properties(serialized_event)
-      serialized_event[:device_id] = device_id if device_id
-      serialized_event[:time] = formatted_time if time
-      serialized_event[:ip] = ip if ip
-      serialized_event[:insert_id] = insert_id if insert_id
-      serialized_event
+    # @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)
     end
 
     # @return [ true, false ]
     #
     # Compares +to_hash+ for equality
     def ==(other)
-      if other.respond_to?(:to_hash)
-        to_hash == other.to_hash
-      else
-        false
-      end
+      return false unless other.respond_to?(:to_h)
+
+      to_h == other.to_h
     end
 
     private
 
     def formatted_time
-      time.to_i * 1_000
+      Config.instance.time_formatter.call(time)
+    end
+
+    def formatted_event_properties
+      Config.instance.event_properties_formatter.call(event_properties)
+    end
+
+    def formatted_user_properties
+      Config.instance.user_properties_formatter.call(user_properties)
+    end
+
+    def validate_arguments
+      validate_required_arguments
+      validate_revenue_arguments
+    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)
     end
 
-    def validate_revenue_arguments(options)
-      self.price = getopt(options, :price)
-      self.quantity = getopt(options, :quantity, 1) if price
-      self.product_id = getopt(options, :product_id)
-      self.revenue_type = getopt(options, :revenue_type)
-      return if price
+    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
     end

data/lib/amplitude_api/identification.rb

@@ -3,7 +3,7 @@ class AmplitudeAPI
   class Identification
     # @!attribute [ rw ] user_id
     #   @return [ String ] the user_id to be sent to Amplitude
-    attr_accessor :user_id
+    attr_reader :user_id
     # @!attribute [ rw ] device_id
     #   @return [ String ] the device_id to be sent to Amplitude
     attr_accessor :device_id

data/lib/amplitude_api/version.rb

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

data/readme.md

@@ -15,7 +15,8 @@ The following code snippet will immediately track an event to the Amplitude API.
 
 ```ruby
 # Configure your Amplitude API key
-AmplitudeAPI.api_key = "abcdef123456"
+AmplitudeAPI.config.api_key = "abcdef123456"
+
 
 event = AmplitudeAPI::Event.new({
   user_id: "123",
@@ -30,6 +31,22 @@ event = AmplitudeAPI::Event.new({
 AmplitudeAPI.track(event)
 ```
 
+## GDPR Compliance
+
+The following code snippet will delete a user from amplitude
+
+```ruby
+# Configure your Amplitude API key
+AmplitudeAPI.config.api_key = "abcdef123456"
+
+# Configure your Amplitude Secret Key
+AmplitudeAPI.config.secret_key = "secretMcSecret"
+
+AmplitudeAPI.delete(user_ids: [233],
+  requester: "privacy@mycompany.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.
 
 ## What's Next

data/spec/lib/amplitude_api/event_spec.rb

@@ -42,7 +42,7 @@ describe AmplitudeAPI::Event do
   describe 'init' do
     context 'attributes' do
       it 'accepts string attributes' do
-        time = Time.parse('2016-01-01 00:00:00 -0000')
+        time = Time.at(1_451_606_400_000 / 1_000)
         event = described_class.new(
           'user_id' => 123,
           'device_id' => 'abcd',
@@ -51,6 +51,8 @@ describe AmplitudeAPI::Event do
           'user_properties' => { 'c' => 'd' },
           'time' => time,
           'ip' => '127.0.0.1',
+          'platform' => 'Web',
+          'country' => 'United States',
           'insert_id' => 'bestId'
         )
 
@@ -61,11 +63,13 @@ describe AmplitudeAPI::Event do
                                     user_properties: { 'c' => 'd' },
                                     time: 1_451_606_400_000,
                                     ip: '127.0.0.1',
+                                    platform: 'Web',
+                                    country: 'United States',
                                     insert_id: 'bestId')
       end
 
       it 'accepts symbol attributes' do
-        time = Time.parse('2016-01-01 00:00:00 -0000')
+        time = Time.at(1_451_606_400_000 / 1_000)
         event = described_class.new(
           user_id: 123,
           device_id: 'abcd',
@@ -74,6 +78,8 @@ describe AmplitudeAPI::Event do
           user_properties: { 'c' => 'd' },
           time: time,
           ip: '127.0.0.1',
+          platform: 'Web',
+          country: 'United States',
           insert_id: 'bestId'
         )
 
@@ -84,6 +90,8 @@ describe AmplitudeAPI::Event do
                                     user_properties: { 'c' => 'd' },
                                     time: 1_451_606_400_000,
                                     ip: '127.0.0.1',
+                                    platform: 'Web',
+                                    country: 'United States',
                                     insert_id: 'bestId')
       end
     end
@@ -131,7 +139,7 @@ describe AmplitudeAPI::Event do
 
     describe 'time' do
       it 'includes a time for the event' do
-        time = Time.parse('2016-01-01 00:00:00 -0000')
+        time = Time.at(1_451_606_400_000 / 1_000)
         event = described_class.new(
           user_id: 123,
           event_type: 'clicked on home',
@@ -168,6 +176,44 @@ describe AmplitudeAPI::Event do
       end
     end
 
+    describe 'platform' do
+      it 'includes the platform for the event' do
+        event = described_class.new(
+          user_id: 123,
+          event_type: 'clicked on home',
+          platform: 'Web'
+        )
+        expect(event.to_hash[:platform]).to eq('Web')
+      end
+
+      it 'does not include the platform if it is not set' do
+        event = described_class.new(
+          user_id: 123,
+          event_type: 'clicked on home'
+        )
+        expect(event.to_hash).not_to have_key(:platform)
+      end
+    end
+
+    describe 'country' do
+      it 'includes the country for the event' do
+        event = described_class.new(
+          user_id: 123,
+          event_type: 'clicked on home',
+          country: 'United States'
+        )
+        expect(event.to_hash[:country]).to eq('United States')
+      end
+
+      it 'does not include the country if it is not set' do
+        event = described_class.new(
+          user_id: 123,
+          event_type: 'clicked on home'
+        )
+        expect(event.to_hash).not_to have_key(:country)
+      end
+    end
+
     describe 'revenue params' do
       it 'includes the price if it is set' do
         price = 100_000.99

data/spec/lib/amplitude_api_spec.rb

@@ -22,6 +22,7 @@ describe AmplitudeAPI do
           described_class.track(event)
         end
       end
+
       context 'with only device_id' do
         it 'sends the event to Amplitude' do
           event = AmplitudeAPI::Event.new(
@@ -38,6 +39,7 @@ describe AmplitudeAPI do
           described_class.track(event)
         end
       end
+
       context 'with both user_id and device_id' do
         it 'sends the event to Amplitude' do
           event = AmplitudeAPI::Event.new(
@@ -100,6 +102,7 @@ describe AmplitudeAPI do
           described_class.identify(identification)
         end
       end
+
       context 'with only device_id' do
         it 'sends the identification to Amplitude' do
           identification = AmplitudeAPI::Identification.new(
@@ -119,6 +122,7 @@ describe AmplitudeAPI do
           described_class.identify(identification)
         end
       end
+
       context 'with both user_id and device_id' do
         it 'sends the identification to Amplitude' do
           identification = AmplitudeAPI::Identification.new(
@@ -169,53 +173,34 @@ describe AmplitudeAPI do
     end
   end
 
-  describe '.initializer ' do
-    it 'initializes event without parameter' do
-      event = AmplitudeAPI::Event.new
-      expect(event.to_hash).to eq(
-        event_type: '',
-        user_id: '',
-        event_properties: {},
-        user_properties: {},
-        ip: ''
-      )
-    end
-
-    it 'initializes event with parameter' do
-      event = AmplitudeAPI::Event.new(
+  describe '.initializer' do
+    let(:attributes) do
+      {
         user_id: 123,
         event_type: 'test_event',
         event_properties: {
           test_property: 1
         },
-        ip: '8.8.8.8'
-      )
-      expect(event.to_hash).to eq(
-        event_type: 'test_event',
-        user_id: 123,
-        event_properties: { test_property: 1 },
         user_properties: {},
         ip: '8.8.8.8'
-      )
+      }
     end
-    it 'initializes event with parameter including device_id' do
-      event = AmplitudeAPI::Event.new(
-        user_id: 123,
-        device_id: 'abc',
-        event_type: 'test_event',
-        event_properties: {
-          test_property: 1
-        },
-        ip: '8.8.8.8'
-      )
-      expect(event.to_hash).to eq(
-        event_type: 'test_event',
-        user_id: 123,
-        device_id: 'abc',
-        event_properties: { test_property: 1 },
-        user_properties: {},
-        ip: '8.8.8.8'
-      )
+
+    it 'requires event type' do
+      attributes.delete(:event_type)
+      expect { AmplitudeAPI::Event.new(attributes) }.to raise_error(ArgumentError)
+    end
+
+    it 'requires user id or device id' do
+      expect(AmplitudeAPI::Event.new(attributes).to_h).to eq(attributes)
+      attributes.merge!(device_id: 'abc').delete(:user_id)
+      expect(AmplitudeAPI::Event.new(attributes).to_h).to eq(attributes)
+      attributes.delete(:device_id)
+      expect { AmplitudeAPI::Event.new(attributes) }.to raise_error(ArgumentError)
+    end
+
+    it 'initializes event with parameter' do
+      expect(AmplitudeAPI::Event.new(attributes)).to eq(attributes)
     end
   end
 
@@ -276,6 +261,7 @@ describe AmplitudeAPI do
         end
       end
     end
+
     context 'with device_id' do
       context 'the user is not nil' do
         it 'sends an event to AmplitudeAPI' do
@@ -352,6 +338,7 @@ describe AmplitudeAPI do
         end
       end
     end
+
     context 'with a device_id' do
       it 'sends an identify to AmplitudeAPI' do
         identification = AmplitudeAPI::Identification.new(
@@ -377,15 +364,89 @@ describe AmplitudeAPI do
       expect(Typhoeus).to receive(:get).with(AmplitudeAPI::SEGMENTATION_URI_STRING,
                                              userpwd: "#{described_class.api_key}:#{described_class.secret_key}",
                                              params: {
-                                               e:      { event_type: 'my event' }.to_json,
-                                               start:  start_time.strftime('%Y%m%d'),
-                                               end:    end_time.strftime('%Y%m%d'),
-                                               s:      [{ prop: 'foo', op: 'is', values: %w(bar) }.to_json]
+                                               e: { event_type: 'my event' }.to_json,
+                                               start: start_time.strftime('%Y%m%d'),
+                                               end: end_time.strftime('%Y%m%d'),
+                                               s: [{ prop: 'foo', op: 'is', values: %w[bar] }.to_json]
                                              })
 
       described_class.segmentation({ event_type: 'my event' }, start_time, end_time,
-                                   s: [{ prop: 'foo', op: 'is', values: %w(bar) }]
-                                  )
+                                   s: [{ prop: 'foo', op: 'is', values: %w[bar] }])
+    end
+  end
+
+  describe '.delete' do
+    context 'with user_ids' do
+      it 'sends the deletion to Amplitude' do
+        user_ids =  [123, 456, 555]
+        body = {
+          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
+        )
+        described_class.delete(user_ids: user_ids)
+      end
+
+      context 'with amplitude_ids' do
+        it 'sends the deletion to Amplitude' do
+          user_ids =  [123, 456, 555]
+          amplitude_ids = [122, 456]
+          body = {
+            user_ids: user_ids,
+            amplitude_ids: amplitude_ids
+          }
+
+          expect(Typhoeus).to receive(:post).with(
+            AmplitudeAPI::DELETION_URI_STRING,
+            userpwd: "#{described_class.api_key}:#{described_class.config.secret_key}",
+            body: body
+          )
+          described_class.delete(
+            amplitude_ids: amplitude_ids,
+            user_ids: user_ids
+          )
+        end
+      end
+    end
+
+    context 'with amplitude_ids' do
+      it 'sends the deletion to Amplitude' do
+        amplitude_ids = [122, 456]
+        body = {
+          amplitude_ids: amplitude_ids
+        }
+
+        expect(Typhoeus).to receive(:post).with(
+          AmplitudeAPI::DELETION_URI_STRING,
+          userpwd: "#{described_class.api_key}:#{described_class.config.secret_key}",
+          body: body
+        )
+        described_class.delete(amplitude_ids: amplitude_ids)
+      end
+    end
+
+    context 'with requester' do
+      it 'sends the deletion to Amplitude' do
+        amplitude_ids = [122, 456]
+
+        body = {
+          amplitude_ids: amplitude_ids,
+          requester: 'privacy@gethopscotch.com'
+        }
+        userpwd = "#{described_class.api_key}:#{described_class.config.secret_key}"
+
+        expect(Typhoeus).to receive(:post).with(AmplitudeAPI::DELETION_URI_STRING,
+                                                userpwd: userpwd,
+                                                body: body)
+        described_class.delete(
+          amplitude_ids: amplitude_ids,
+          requester: 'privacy@gethopscotch.com'
+        )
+      end
     end
   end
 
@@ -416,22 +477,20 @@ describe AmplitudeAPI do
       )
       body = described_class.track_body(event)
 
-      expected = JSON.generate(
-        [
-          {
-            event_type: 'test_event',
-            user_id: 23,
-            event_properties: {
-              foo: 'bar'
-            },
-            user_properties: {
-              abc: '123'
-            },
-            ip: '8.8.8.8'
-          }
-        ]
-      )
-      expect(body[:event]).to eq(expected)
+      expected = [
+        {
+          event_type: 'test_event',
+          user_id: 23,
+          event_properties: {
+            foo: 'bar'
+          },
+          user_properties: {
+            abc: '123'
+          },
+          ip: '8.8.8.8'
+        }
+      ]
+      expect(JSON.parse(body[:event], symbolize_names: true)).to eq(expected)
     end
   end
 end

data/spec/spec_helper.rb

@@ -17,6 +17,7 @@ RSpec.configure do |config|
   config.order = 'random'
 
   config.before(:suite) do
-    AmplitudeAPI.api_key = 'stub api key'
+    AmplitudeAPI.config.api_key = 'stub api key'
+    AmplitudeAPI.config.secret_key = 'stub secret key'
   end
 end

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: amplitude-api
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.1.0
 platform: ruby
 authors:
 - Alex Rakoczy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-14 00:00:00.000000000 Z
+date: 2019-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.99'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.99.0
+        version: 0.12.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.99'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.99.0
+        version: 0.12.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.99.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.12.6
+        version: '2.99'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.99.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.12.6
+        version: '2.99'
 - !ruby/object:Gem::Dependency
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.2
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.2
+        version: '1.0'
 description: Provides an integration for sending events to Amplitude
 email:
 - arakoczy@gmail.com
@@ -90,6 +90,7 @@ files:
 - ".rubocop.yml"
 - ".travis.yml"
 - ".yardopts"
+- Changelog.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -97,6 +98,7 @@ files:
 - amplitude-api.gemspec
 - lib/amplitude-api.rb
 - lib/amplitude_api.rb
+- lib/amplitude_api/config.rb
 - lib/amplitude_api/event.rb
 - lib/amplitude_api/identification.rb
 - lib/amplitude_api/version.rb
@@ -117,15 +119,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Send events to the Amplitude API