leanplum_api 1.3.6 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ce4fe4f8ab0087d81620500bfbb5b8772fc5fce0
-  data.tar.gz: e9b7b9754428c7e7271dc02ad6902400d1ad06f8
+  metadata.gz: 0619bb8636e6cd600ef0f1256b668b7370eb2b47
+  data.tar.gz: 1aaee928b8b46c2618c06f7e03ea6af46054754e
 SHA512:
-  metadata.gz: db56dbc6b349e76245c5ff6f02442088dd4d0f0e84b4018bbb49e05921a6590d3e8a3d3a75b88d2b33f2091f6918552716e860c411328350f3340f01122e6d99
-  data.tar.gz: 4287a74432cce7921da7e0a8c601ad649d855aab79fcb89bdbfe78f93cb34fcbbeec5b981f1d4e0e58eb1eac74e42ec796096e369c3911fa5eb7da01ed96e68f
+  metadata.gz: 695bd8b8fef4735fdda61caf33a878407c2f41faf7e1ef873238ef29a208757bbd47215e6c8cc3d3c223219367b3720ec7f5f1a05428f3bc028462576d48f80a
+  data.tar.gz: 0ebb4861712ec2afe496a506036dd72f60635b3a5d914fb9274ea9cbc7bfdbe978e6c68b80d032e2a8abf0f195cab214d0c95593cbe04169cee3ef3a1681840d

data/README.md

@@ -57,19 +57,19 @@ attribute_hash = {
   first_name: 'Mike',
   last_name: 'Jones',
   gender: 'm',
-  birthday: Date.today, # Dates and times in user attributes will be formatted as strings; Leanplum doesn't support date or time types
+  birthday: Date.today, # Dates/times only sort of supported in user attributes
   email: 'still_tippin@test.com'
 }
 api.set_user_attributes(attribute_hash)
 
-# You must also provide the :event property for event tracking
+# You must also provide the :event property for event tracking.
+# You can optionally provide a :time property; if it is not set Leanplum will timestamp the event "now".
+# All other key/values besides :user_id, :device_id, :event, and :time will be sent as event params/properties.
 event = {
   user_id: 12345,
   event: 'purchase',
   time: Time.now.utc, # Event timestamps will be converted to epoch seconds by the gem.
-  params: {
-    'some_event_property' => 'boss_hog_on_candy'
-  }
+  some_event_property: 'boss_hog_on_candy'
 }
 api.track_events(event)
 
@@ -83,19 +83,21 @@ api.reset_anomalous_users([12345, 23456])
 api.track_events(event, force_anomalous_override: true)
 ```
 
-Data export:
+API based data export:
 ```ruby
 api = LeanplumApi::API.new
 job_id = api.export_data(start_time, end_time)
 response = wait_for_job(job_id)
 ```
 
+Note well that Leanplum officially recommends use of the automated S3 export instead of API based export.  According to a Leanplum engineer these two data export methodologies are completely independent data paths and in our experience we have found API based data export to be missing 10-15% of the data that is eventually returned by the automated export.
+
 ## Specs
 
-To run specs, you must set the LEANPLUM_PRODUCTION_KEY, LEANPLUM_APP_ID, LEANPLUM_CONTENT_READ_ONLY_KEY, LEANPLUM_DEVELOPMENT_KEY, and LEANPLUM_DATA_EXPORT_KEY environment variables (preferably to some development only keys) to something and then run rspec.
+To run specs, you must set the `LEANPLUM_PRODUCTION_KEY`, `LEANPLUM_APP_ID`, `LEANPLUM_CONTENT_READ_ONLY_KEY`, `LEANPLUM_DEVELOPMENT_KEY`, and `LEANPLUM_DATA_EXPORT_KEY` environment variables (preferably to some development only keys) to something and then run rspec.
 Because of the nature of VCR/Webmock, you can set them to anything (including invalid keys) as long as you are not changing anything substantive or writing new specs.  If you want to make substantive changes/add new specs, VCR will need to be able to generate fixture data so you will need to use a real set of Leanplum keys.
 
-> BE AWARE THAT IF YOU WRITE A NEW SPEC OR DELETE A VCR FILE, IT'S POSSIBLE THAT REAL DATA WILL BE WRITTEN TO THE LEANPLUM_APP_ID YOU CONFIGURE!  Certainly a real request will be made to rebuild the VCR file, and while specs run with ```devMode=true```, it's usually a good idea to create a fake app for testing/running specs against.
+> BE AWARE THAT IF YOU WRITE A NEW SPEC OR DELETE A VCR FILE, IT'S POSSIBLE THAT REAL DATA WILL BE WRITTEN TO THE `LEANPLUM_APP_ID` YOU CONFIGURE!  Certainly a real request will be made to rebuild the VCR file, and while specs run with ```devMode=true```, it's usually a good idea to create a fake app for testing/running specs against.
 
 ```bash
 export LEANPLUM_PRODUCTION_KEY=dev_somethingsomeg123456
@@ -117,4 +119,4 @@ export LEANPLUM_API_DEBUG=true
 bundle exec rails whatever
 ```
 
-You can also configure "developer mode".  This will use the "devMode=true" parameter on all requests, which sends them to a separate queue (and probably means actions logged as development tests don't count towards your bill).
+You can also configure "developer mode".  This will use the "devMode=true" parameter on some requests, which seems to sends them to a separate queue which might not count towards Leanplum's usage billing.

data/lib/leanplum_api/api.rb

@@ -39,12 +39,12 @@ module LeanplumApi
             # user_ids_to_reset << request_data[i]['userId']
 
             # This is what it has to be:
-            user_ids_to_reset = events.map { |e| e[:user_id] }
+            user_ids_to_reset = events.map { |e| e[:user_id] }.uniq
           end
         end
 
         unless user_ids_to_reset.empty?
-          LeanplumApi.configuration.logger.info("Resetting anomalous user ids: #{user_ids_to_reset}")
+          LeanplumApi.configuration.logger.debug("Resetting anomalous user ids: #{user_ids_to_reset}")
           reset_anomalous_users(user_ids_to_reset)
         end
       end
@@ -143,8 +143,8 @@ module LeanplumApi
       @http.get(action: 'getVars', userId: user_id).body['response'].first['vars']
     end
 
-    # If you pass old events OR users with old date attributes (i.e. create_date for an old users), leanplum will mark them 'anomalous'
-    # and exclude them from your data set.
+    # If you pass old events OR users with old date attributes (i.e. create_date for an old users), leanplum will mark
+    # them 'anomalous' and exclude them from your data set.
     # Calling this method after you pass old events will fix that for all events for the specified user_id
     # For some reason this API feature requires the developer key
     def reset_anomalous_users(user_ids)
@@ -169,9 +169,10 @@ module LeanplumApi
       @development ||= LeanplumApi::Development.new
     end
 
-    def extract_user_id_or_device_id_hash(hash)
-      user_id = hash['user_id'] || hash[:user_id]
-      device_id = hash['device_id'] || hash[:device_id]
+    # Deletes the user_id and device_id key/value pairs from the hash parameter.
+    def extract_user_id_or_device_id_hash!(hash)
+      user_id = hash.delete(:user_id)
+      device_id = hash.delete(:device_id)
       fail "No device_id or user_id in hash #{hash}" unless user_id || device_id
 
       user_id ? { 'userId' => user_id } : { 'deviceId' => device_id }
@@ -180,44 +181,27 @@ module LeanplumApi
     # Action can be any command that takes a userAttributes param.  "start" (a session) is the other command that most
     # obviously takes userAttributes.
     def build_user_attributes_hash(user_hash, action = 'setUserAttributes')
-      extract_user_id_or_device_id_hash(user_hash).merge(
-        'action' => action,
-        'userAttributes' => turn_date_and_time_values_to_strings(user_hash).reject { |k,v| k.to_s =~ /^(user_id|device_id)$/ }
-      )
+      user_hash = HashWithIndifferentAccess.new(user_hash)
+
+      # As of 2015-10 Leanplum supports ISO8601 date strings as user attributes. Support for times is as yet unavailable.
+      user_hash.each do |k,v|
+        user_hash[k] = v.iso8601 if v.is_a?(Date) || v.is_a?(Time) || v.is_a?(DateTime)
+      end
+
+      extract_user_id_or_device_id_hash!(user_hash).merge('action' => action, 'userAttributes' => user_hash)
     end
 
     # Events have a :user_id or :device id, a name (:event) and an optional time (:time)
     def build_event_attributes_hash(event_hash)
-      fail "No event name provided in #{event_hash}" unless event_hash[:event] || event_hash['event']
-
-      time = event_hash[:time] || event_hash['time']
-      time_hash = time ? { 'time' => time.strftime('%s') } : {}
-
-      event = extract_user_id_or_device_id_hash(event_hash).merge(time_hash).merge(
-        'action' => 'track',
-        'event' => event_hash[:event] || event_hash['event']
-      )
-      event_params = event_hash.reject { |k,v| k.to_s =~ /^(user_id|device_id|event|time)$/ }
-      if event_params.keys.size > 0
-        event.merge('params' => event_params )
-      else
-        event
-      end
-    end
+      event_hash = HashWithIndifferentAccess.new(event_hash)
+      event_name = event_hash.delete(:event)
+      fail "Event name or timestamp not provided in #{event_hash}" unless event_name
 
-    # Leanplum does not support dates and times as of 2015-08-11
-    def turn_date_and_time_values_to_strings(hash)
-      new_hash = {}
-      hash.each do |k,v|
-        if v.is_a?(Time) || v.is_a?(DateTime)
-          new_hash[k] = v.strftime('%Y-%m-%d %H:%M:%S')
-        elsif v.is_a?(Date)
-          new_hash[k] = v.strftime('%Y-%m-%d')
-        else
-          new_hash[k] = v
-        end
-      end
-      new_hash
+      event = { 'action' => 'track', 'event' => event_name }.merge(extract_user_id_or_device_id_hash!(event_hash))
+      time = event_hash.delete(:time)
+      event.merge!('time' => time.strftime('%s')) if time
+
+      event_hash.keys.size > 0 ? event.merge('params' => event_hash ) : event
     end
   end
 end

data/lib/leanplum_api/version.rb

@@ -1,3 +1,3 @@
 module LeanplumApi
-  VERSION = '1.3.6'
+  VERSION = '1.4.0'
 end

data/spec/api_spec.rb

@@ -19,13 +19,13 @@ describe LeanplumApi::API do
       expect(api.send(:build_user_attributes_hash, users.first)).to eq({
         'userId' => 123456,
         'action' => 'setUserAttributes',
-        'userAttributes' => {
+        'userAttributes' => HashWithIndifferentAccess.new(
           first_name: 'Mike',
           last_name: 'Jones',
           gender: 'm',
           email: 'still_tippin@test.com',
           create_date: '2010-01-01'
-        }
+        )
       })
     end
 
@@ -78,32 +78,37 @@ describe LeanplumApi::API do
   end
 
   context 'events' do
+    let(:timestamp) { '2015-05-01 01:02:03' }
     let(:events) do
       [
         {
           user_id: 12345,
           event: 'purchase',
           time: Time.now.utc,
-          params: {
-            'some_timestamp' => '2015-05-01 01:02:03'
-          }
+          some_timestamp: timestamp
         },
         {
           user_id: 54321,
           event: 'purchase_page_view',
-          time: Time.now.utc - 10.minutes,
+          time: Time.now.utc - 10.minutes
         }
       ]
     end
 
-    it 'build_event_attributes_hash' do
-      expect(api.send(:build_event_attributes_hash, events.first)).to eq({
-        'userId' => 12345,
-        'time' => Time.now.utc.strftime('%s'),
-        'action' => 'track',
-        'event' => 'purchase',
-        'params' => { params: { 'some_timestamp'=>'2015-05-01 01:02:03' } }
-      })
+    context '#build_event_attributes_hash' do
+      let(:event_hash) do
+        {
+          'userId' => 12345,
+          'time' => Time.now.utc.strftime('%s'),
+          'action' => 'track',
+          'event' => 'purchase',
+          'params' => { 'some_timestamp' => timestamp }
+        }
+      end
+
+      it 'builds the events format' do
+        expect(api.send(:build_event_attributes_hash, events.first)).to eq(event_hash)
+      end
     end
 
     context 'without user attributes' do

data/spec/fixtures/vcr/track_events.yml

@@ -5,8 +5,8 @@ http_interactions:
     uri: https://www.leanplum.com/api?action=multi&apiVersion=1.0.6&appId=<LEANPLUM_APP_ID>&clientKey=<LEANPLUM_PRODUCTION_KEY>&devMode=false&time=1439337600
     body:
       encoding: UTF-8
-      string: '{"data":[{"userId":12345,"time":"1439337600","action":"track","event":"purchase","params":{"params":{"some_timestamp":"2015-05-01
-        01:02:03"}}},{"userId":54321,"time":"1439337000","action":"track","event":"purchase_page_view"}]}'
+      string: '{"data":[{"action":"track","event":"purchase","userId":12345,"time":"1439337600","params":{"some_timestamp":"2015-05-01
+        01:02:03"}},{"action":"track","event":"purchase_page_view","userId":54321,"time":"1439337000"}]}'
     headers:
       User-Agent:
       - Faraday v0.9.2
@@ -40,6 +40,6 @@ http_interactions:
       string: '{"response":[{"isOffline":true,"success":true,"warning":{"message":"Anomaly
         detected: time skew. User will be excluded from analytics."}},{"success":true,"warning":{"message":"Anomaly
         detected: time skew. User will be excluded from analytics."}}]}'
-    http_version: 
+    http_version:
   recorded_at: Wed, 12 Aug 2015 00:00:00 GMT
 recorded_with: VCR 2.9.3

data/spec/fixtures/vcr/track_events_and_attributes.yml

@@ -5,8 +5,8 @@ http_interactions:
     uri: https://www.leanplum.com/api?action=multi&apiVersion=1.0.6&appId=<LEANPLUM_APP_ID>&clientKey=<LEANPLUM_PRODUCTION_KEY>&devMode=false&time=1439337600
     body:
       encoding: UTF-8
-      string: '{"data":[{"userId":123456,"action":"setUserAttributes","userAttributes":{"first_name":"Mike","last_name":"Jones","gender":"m","email":"still_tippin@test.com","create_date":"2010-01-01"}},{"userId":12345,"time":"1439337600","action":"track","event":"purchase","params":{"params":{"some_timestamp":"2015-05-01
-        01:02:03"}}},{"userId":54321,"time":"1439337000","action":"track","event":"purchase_page_view"}]}'
+      string: '{"data":[{"userId":123456,"action":"setUserAttributes","userAttributes":{"first_name":"Mike","last_name":"Jones","gender":"m","email":"still_tippin@test.com","create_date":"2010-01-01"}},{"action":"track","event":"purchase","userId":12345,"time":"1439337600","params":{"some_timestamp":"2015-05-01
+        01:02:03"}},{"action":"track","event":"purchase_page_view","userId":54321,"time":"1439337000"}]}'
     headers:
       User-Agent:
       - Faraday v0.9.2
@@ -41,6 +41,6 @@ http_interactions:
         detected: time skew. User will be excluded from analytics."}},{"success":true,"warning":{"message":"Anomaly
         detected: time skew. User will be excluded from analytics."}},{"success":true,"warning":{"message":"Anomaly
         detected: time skew. User will be excluded from analytics."}}]}'
-    http_version: 
+    http_version:
   recorded_at: Wed, 12 Aug 2015 00:00:00 GMT
 recorded_with: VCR 2.9.3

data/spec/fixtures/vcr/track_events_anomaly_overrider.yml

@@ -5,8 +5,8 @@ http_interactions:
     uri: https://www.leanplum.com/api?action=multi&apiVersion=1.0.6&appId=<LEANPLUM_APP_ID>&clientKey=<LEANPLUM_PRODUCTION_KEY>&devMode=false&time=1439337600
     body:
       encoding: UTF-8
-      string: '{"data":[{"userId":12345,"time":"1439337600","action":"track","event":"purchase","params":{"params":{"some_timestamp":"2015-05-01
-        01:02:03"}}},{"userId":54321,"time":"1439337000","action":"track","event":"purchase_page_view"}]}'
+      string: '{"data":[{"action":"track","event":"purchase","userId":12345,"time":"1439337600","params":{"some_timestamp":"2015-05-01
+        01:02:03"}},{"action":"track","event":"purchase_page_view","userId":54321,"time":"1439337000"}]}'
     headers:
       User-Agent:
       - Faraday v0.9.2
@@ -40,7 +40,7 @@ http_interactions:
       string: '{"response":[{"isOffline":true,"success":true,"warning":{"message":"Anomaly
         detected: time skew. User will be excluded from analytics."}},{"success":true,"warning":{"message":"Anomaly
         detected: time skew. User will be excluded from analytics."}}]}'
-    http_version: 
+    http_version:
   recorded_at: Wed, 12 Aug 2015 00:00:00 GMT
 - request:
     method: post
@@ -81,6 +81,6 @@ http_interactions:
       string: '{"response":[{"success":true,"warning":{"message":"Anomaly detected:
         time skew. User will be excluded from analytics."}},{"success":true,"warning":{"message":"Anomaly
         detected: time skew. User will be excluded from analytics."}}]}'
-    http_version: 
+    http_version:
   recorded_at: Wed, 12 Aug 2015 00:00:00 GMT
 recorded_with: VCR 2.9.3

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: leanplum_api
 version: !ruby/object:Gem::Version
-  version: 1.3.6
+  version: 1.4.0
 platform: ruby
 authors:
 - Lumos Labs, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-04 00:00:00.000000000 Z
+date: 2016-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport