amplitude-api 0.0.9 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2613d299e9d407475b3a03eecb1633f0a5359b40
-  data.tar.gz: 7a48cebc3d4c592cb894c5d2bf9b814f0ff55a70
+  metadata.gz: 0e82b9bf2580f2da3bd76a71cb172ca89d051d3f
+  data.tar.gz: 8d437b02ece1c511b0f5256ee81f4e4b94fa8494
 SHA512:
-  metadata.gz: 14739845274080c65ef0afb13b9547a91191ded8a935fae3a99bd04ffac16eb6f632fe4f83d4e209d3ef55f0dd3cd4eedfe645f030836423f42c530ac401363c
-  data.tar.gz: 1e6933e33ec4ae42076b57e8f9c6cc72797fb6cb25ce708f76182224f5fb02f4b4657fc00811e81211dcb23de1989879dda88ec4c5ec21ce98b96de9f1300fe3
+  metadata.gz: 0df83a07615c485e264d00522359ab188e93f462e9e30d77ca6053d0dbc771a534062afc2148b60025ca221eddf1378727a8bcac46f25ec2c5f8480a5dd6ab4f
+  data.tar.gz: e9506a8d285f98d90a80ea28b7e80a337f3749597dbcf3be95f170bb7ca1a66cb5cd810fcbffcb020041ccb620cdb5ee547f6bb382cefd1644f5d10639a25264

data/lib/amplitude_api.rb

@@ -6,8 +6,9 @@ require_relative 'amplitude_api/identification'
 
 # AmplitudeAPI
 class AmplitudeAPI
-  TRACK_URI_STRING = 'https://api.amplitude.com/httpapi'.freeze
-  IDENTIFY_URI_STRING = 'https://api.amplitude.com/identify'.freeze
+  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
 
   USER_WITH_NO_ACCOUNT = "user who doesn't have an account".freeze
 
@@ -16,6 +17,10 @@ class AmplitudeAPI
     #   @return [ String ] an Amplitude API Key
     attr_accessor :api_key
 
+    # @!attribute [ rw ] secret_key
+    #   @return [ String ] an Amplitude Secret Key
+    attr_accessor :secret_key
+
     # ==== Event Tracking related methods
 
     # Send a single event immediately to the AmplitudeAPI
@@ -114,5 +119,39 @@ class AmplitudeAPI
     def identify(*identifications)
       Typhoeus.post(IDENTIFY_URI_STRING, body: identify_body(identifications))
     end
+
+    # ==== Event Segmentation related methods
+
+    # Get metrics for an event with segmentation.
+    #
+    # @param [ Hash ] e 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.
+    # 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.
+    # 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
+    # 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],
+        limit: options[:limit]
+      }.delete_if { |_, value| value.nil? }
+    end
   end
 end

data/lib/amplitude_api/version.rb

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

data/spec/lib/amplitude_api_spec.rb

@@ -369,6 +369,26 @@ describe AmplitudeAPI do
     end
   end
 
+  describe '.segmentation' do
+    let(:end_time)   { Time.now }
+    let(:start_time) { end_time - 60 * 60 * 24 } # -1 day
+
+    it 'sends request to Amplitude' 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]
+                                             })
+
+      described_class.segmentation({ event_type: 'my event' }, start_time, end_time,
+                                   s: [{ prop: 'foo', op: 'is', values: %w(bar) }]
+                                  )
+    end
+  end
+
   describe '#body' do
     it 'adds an api key' do
       event = AmplitudeAPI::Event.new(

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: amplitude-api
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
 platform: ruby
 authors:
 - Alex Rakoczy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-27 00:00:00.000000000 Z
+date: 2017-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -125,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Send events to the Amplitude API