amplitude-api 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a9ac7cdd479dd7fc5397ab04697d01c1a018db1d
-  data.tar.gz: 07d0b31956d6c0d5fabf80460733bc2501dd29b8
+  metadata.gz: 233332597b10167395db959e0066e1f8b2adf1ad
+  data.tar.gz: 574f6162547e34a3e2003abf0410146064de2279
 SHA512:
-  metadata.gz: e5ba9200d8fc3415f8a6ee3d0450bb0a2849482d8cd8cb7fc5b2caf1cfa5175ee0e1c2f7074cebbf85c0410649ee1044b385c6acece36516f01c713bc2688ea0
-  data.tar.gz: b81df95283f2c5c2da128ec00b2ffb40e8b4e76b7ee34b990fd26e0834ac892e7d76a855e0b6b08a265b42c82fd71be725d12df09c112eaa9d84de14b81c6359
+  metadata.gz: 860998aada7dc9516f451d1e83d1c92abc1247eab787eb67ed186efa63c30e650f94e6e31afe422119a1f55da6c058d606df6a5b3529ad669f32781f3bb33b11
+  data.tar.gz: 22b4a53df0df781db7f2efeac562481546b8551bee4e31b2be1918189a8b5cb145cb14e2eb70b366965dd56b27310ef95832d73125bdcb7ffa157818382a1ba6

data/Gemfile

@@ -1,7 +1,7 @@
 # Generated from /Users/alex/development/amplitude-api/amplitude-api.gemspec
 source 'https://rubygems.org'
 
-gem 'typhoeus', '~> 0.7.1'
+gem 'typhoeus', '~> 1.0.2'
 
 group :development, :test do
   gem 'pry', '~> 0.9.12.6'

data/Gemfile.lock

@@ -4,9 +4,9 @@ GEM
     ast (2.2.0)
     coderay (1.1.1)
     diff-lcs (1.2.5)
-    ethon (0.8.1)
+    ethon (0.9.0)
       ffi (>= 1.3.0)
-    ffi (1.9.10)
+    ffi (1.9.14)
     method_source (0.8.2)
     parser (2.3.0.6)
       ast (~> 2.2)
@@ -39,8 +39,8 @@ GEM
     rubocop-rspec (1.4.0)
     ruby-progressbar (1.7.5)
     slop (3.6.0)
-    typhoeus (0.7.3)
-      ethon (>= 0.7.4)
+    typhoeus (1.0.2)
+      ethon (>= 0.9.0)
     unicode-display_width (0.3.1)
 
 PLATFORMS
@@ -52,7 +52,7 @@ DEPENDENCIES
   rspec (>= 2.99.0)
   rubocop (~> 0.37.2)
   rubocop-rspec
-  typhoeus (~> 0.7.1)
+  typhoeus (~> 1.0.2)
 
 BUNDLED WITH
    1.10.6

data/amplitude-api.gemspec

@@ -21,6 +21,6 @@ Gem::Specification.new do |spec|
   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', '~> 0.7.1'
+  spec.add_dependency 'typhoeus', '~> 1.0.2'
   spec.required_ruby_version = '~> 2.0'
 end

data/lib/amplitude_api.rb

@@ -28,12 +28,12 @@ class AmplitudeAPI
     # and contains user properties to be associated with the user
     #
     # @return [ Typhoeus::Response ]
-    def send_event(event_name, user, event_properties: {}, user_properties: {})
+    def send_event(event_name, user, options = {})
       event = AmplitudeAPI::Event.new(
         user_id: user,
         event_type: event_name,
-        event_properties: event_properties,
-        user_properties: user_properties
+        event_properties: options.fetch(:event_properties, {}),
+        user_properties: options.fetch(:user_properties, {})
       )
       track(event)
     end

data/lib/amplitude_api/event.rb

@@ -16,6 +16,9 @@ class AmplitudeAPI
     # @!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
 
     # Create a new Event
     #
@@ -23,12 +26,14 @@ class AmplitudeAPI
     # @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)
-    def initialize(user_id: '', event_type: '', event_properties: {}, user_properties: {}, time: nil)
-      self.user_id = user_id
-      self.event_type = event_type
-      self.event_properties = event_properties
-      self.user_properties = user_properties
-      self.time = time
+    # @param [ String ] IP address of the user
+    def initialize(options = {})
+      self.user_id = options.fetch(:user_id, '')
+      self.event_type = options.fetch(:event_type, '')
+      self.event_properties = options.fetch(:event_properties, {})
+      self.user_properties = options.fetch(:user_properties, {})
+      self.time = options[:time]
+      self.ip = options.fetch(:ip, '')
     end
 
     def user_id=(value)
@@ -50,6 +55,7 @@ class AmplitudeAPI
       serialized_event[:event_properties] = event_properties
       serialized_event[:user_properties] = user_properties
       serialized_event[:time] = formatted_time if time
+      serialized_event[:ip] = ip if ip
       serialized_event
     end
 

data/lib/amplitude_api/version.rb

@@ -1,3 +1,3 @@
 class AmplitudeAPI
-  VERSION = '0.0.6'.freeze
+  VERSION = '0.0.7'.freeze
 end

data/readme.md

@@ -11,7 +11,7 @@ gem install amplitude-api
 
 ## Basic Usage
 
-The following code snippet will immediately track an event to the Amplitude API. The time on the event will automatically be the time of the request.
+The following code snippet will immediately track an event to the Amplitude API.
 
 ```ruby
 # Configure your Amplitude API key
@@ -20,6 +20,7 @@ AmplitudeAPI.api_key = "abcdef123456"
 event = AmplitudeAPI::Event.new({
   user_id: "123",
   event_type: "clicked on home",
+  time: Time.now,
   event_properties: {
     cause: "button",
     arbitrary: "properties"

data/spec/lib/amplitude_api_spec.rb

@@ -99,7 +99,8 @@ describe AmplitudeAPI do
         event_type: '',
         user_id: '',
         event_properties: {},
-        user_properties: {}
+        user_properties: {},
+        ip: ''
       )
     end
 
@@ -109,13 +110,15 @@ describe AmplitudeAPI do
         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: {}
+        user_properties: {},
+        ip: '8.8.8.8'
       )
     end
   end
@@ -243,7 +246,8 @@ describe AmplitudeAPI do
         },
         user_properties: {
           abc: '123'
-        }
+        },
+        ip: '8.8.8.8'
       )
       body = described_class.track_body(event)
 
@@ -257,7 +261,8 @@ describe AmplitudeAPI do
             },
             user_properties: {
               abc: '123'
-            }
+            },
+            ip: '8.8.8.8'
           }
         ]
       )

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: amplitude-api
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Alex Rakoczy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-25 00:00:00.000000000 Z
+date: 2016-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -70,14 +70,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: 1.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: 1.0.2
 description: Provides an integration for sending events to Amplitude
 email:
 - arakoczy@gmail.com
@@ -125,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Send events to the Amplitude API