leanplum_api 3.1.0 → 4.0.0

data/spec/configuration_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 describe LeanplumApi do
   context 'configuration' do
     after(:each) do
@@ -14,10 +12,12 @@ describe LeanplumApi do
       LeanplumApi.configure do |config|
         config.production_key = 'new_client_key'
         config.app_id = 'new_app_id'
+        config.validate_response = false
       end
 
       expect(LeanplumApi.configuration.production_key).to eq('new_client_key')
       expect(LeanplumApi.configuration.app_id).to eq('new_app_id')
+      expect(LeanplumApi.configuration.validate_response).to be false
       expect(LeanplumApi.configuration.api_version).to eq(LeanplumApi::Configuration::DEFAULT_LEANPLUM_API_VERSION)
     end
   end

data/spec/data_export_api_spec.rb

@@ -0,0 +1,57 @@
+describe LeanplumApi::DataExportAPI do
+  let(:api) { described_class.new }
+
+  around(:all) do |example|
+    LeanplumApi.configure { |c| c.developer_mode = false }
+    example.run
+    LeanplumApi.configure { |c| c.developer_mode = true }
+  end
+
+  context 'data export methods' do
+    context 'export_data' do
+      context 'regular export' do
+        it 'should request a data export job with a starttime' do
+          VCR.use_cassette('export_data') do
+            expect { api.export_data(Time.at(1438660800).utc) }.to raise_error LeanplumApi::BadResponseError
+          end
+        end
+
+        it 'should request a data export job with start and end dates' do
+          VCR.use_cassette('export_data_dates') do
+            expect { api.export_data(Date.new(2017, 8, 5), Date.new(2017, 8, 6)) }.to_not raise_error
+          end
+        end
+      end
+
+      context 's3 export' do
+        let(:s3_bucket_name) { 'bucket' }
+        let(:s3_access_key) { 's3_access_key' }
+        let(:s3_access_id) { 's3_access_id' }
+
+        it 'should request an S3 export'
+      end
+    end
+
+    context 'get_export_results' do
+      it 'should get a status for a data export job' do
+        VCR.use_cassette('get_export_results') do
+          expect(api.get_export_results('export_4727756026281984_2904941266315269120')).to eq({
+            files: ['https://leanplum_export.storage.googleapis.com/export-4727756026281984-d5969d55-f242-48a6-85a3-165af08e2306-output-0'],
+            number_of_bytes: 36590,
+            number_of_sessions: 101,
+            state: LeanplumApi::API::EXPORT_FINISHED,
+            s3_copy_status: nil
+          })
+        end
+      end
+    end
+
+    context '#export_users' do
+      it 'should export users' do
+        VCR.use_cassette('export_users') do
+          expect(api.export_users).to match(/export_users_\d+_\d+/)
+        end
+      end
+    end
+  end
+end

data/spec/fixtures/vcr/delete_user.yml

@@ -0,0 +1,129 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://www.leanplum.com/api?action=multi&apiVersion=1.0.6&appId=<LEANPLUM_APP_ID>&clientKey=<LEANPLUM_PRODUCTION_KEY>&devMode=false&time=1505372950
+    body:
+      encoding: UTF-8
+      string: '{"data":[{"userId":"delete_yourself_123","action":"setUserAttributes","userAttributes":{"first_name":"Mike","last_name":"Jones","gender":"m","email":"still_tippin@test.com","create_date":"2010-01-01","is_tipping":true}}]}'
+    headers:
+      User-Agent:
+      - Faraday v0.13.1
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Origin:
+      - "*"
+      Content-Type:
+      - application/json;charset=utf-8
+      X-Cloud-Trace-Context:
+      - 7b7c5c1e85a47687ae5903a74cb97673
+      Set-Cookie:
+      - GOOGAPPUID=xCgoIAxBzIN3q6M0F; expires=Tue, 03-Nov-2020 03:53:01 GMT; path=/
+      Date:
+      - Thu, 14 Sep 2017 07:53:01 GMT
+      Server:
+      - Google Frontend
+      Content-Length:
+      - '31'
+      Expires:
+      - Thu, 14 Sep 2017 07:53:01 GMT
+      Cache-Control:
+      - private
+    body:
+      encoding: UTF-8
+      string: '{"response":[{"success":true}]}'
+    http_version: 
+  recorded_at: Thu, 14 Sep 2017 07:09:10 GMT
+- request:
+    method: get
+    uri: https://www.leanplum.com/api?action=deleteUser&apiVersion=1.0.6&appId=<LEANPLUM_APP_ID>&clientKey=<LEANPLUM_DEVELOPMENT_KEY>&devMode=false&userId=delete_yourself_123
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.13.1
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Origin:
+      - "*"
+      Content-Type:
+      - application/json;charset=utf-8
+      X-Cloud-Trace-Context:
+      - 82997ba6dfc943f60f7d1e4fd27c0eeb
+      Set-Cookie:
+      - GOOGAPPUID=xCgoIAxAbIN3q6M0F; expires=Tue, 03-Nov-2020 03:53:01 GMT; path=/
+      Date:
+      - Thu, 14 Sep 2017 07:53:01 GMT
+      Server:
+      - Google Frontend
+      Content-Length:
+      - '31'
+      Expires:
+      - Thu, 14 Sep 2017 07:53:01 GMT
+      Cache-Control:
+      - private
+    body:
+      encoding: UTF-8
+      string: '{"response":[{"success":true}]}'
+    http_version: 
+  recorded_at: Thu, 14 Sep 2017 07:09:10 GMT
+- request:
+    method: get
+    uri: https://www.leanplum.com/api?action=exportUser&apiVersion=1.0.6&appId=<LEANPLUM_APP_ID>&clientKey=<LEANPLUM_DATA_EXPORT_KEY>&devMode=false&userId=delete_yourself_123
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.13.1
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Origin:
+      - "*"
+      Content-Type:
+      - application/json;charset=utf-8
+      X-Cloud-Trace-Context:
+      - 971a5ce9e92e4002614131733a2057e6
+      Set-Cookie:
+      - GOOGAPPUID=xCgsIAxD-BiDe6ujNBQ; expires=Tue, 03-Nov-2020 03:53:02 GMT; path=/
+      Date:
+      - Thu, 14 Sep 2017 07:53:02 GMT
+      Server:
+      - Google Frontend
+      Content-Length:
+      - '88'
+      Expires:
+      - Thu, 14 Sep 2017 07:53:02 GMT
+      Cache-Control:
+      - private
+    body:
+      encoding: UTF-8
+      string: '{"response":[{"success":true,"warning":{"message":"User not found;
+        request skipped."}}]}'
+    http_version: 
+  recorded_at: Thu, 14 Sep 2017 07:09:10 GMT
+recorded_with: VCR 3.0.3

data/spec/fixtures/vcr/export_data.yml

@@ -23,17 +23,17 @@ http_interactions:
       Content-Type:
       - application/json;charset=utf-8
       X-Cloud-Trace-Context:
-      - 482abfeaf55310728664574b5d8f8ffa
+      - 87d63e3fd2bf3b5744576a1bc636b7f8
       Set-Cookie:
-      - GOOGAPPUID=xCgsIAxDWBiDjl-HNBQ; expires=Sun, 01-Nov-2020 17:04:35 GMT; path=/
+      - GOOGAPPUID=xCgsIAxDAByCb1-jNBQ; expires=Tue, 03-Nov-2020 03:11:23 GMT; path=/
       Date:
-      - Tue, 12 Sep 2017 21:04:35 GMT
+      - Thu, 14 Sep 2017 07:11:23 GMT
       Server:
       - Google Frontend
       Content-Length:
       - '96'
       Expires:
-      - Tue, 12 Sep 2017 21:04:35 GMT
+      - Thu, 14 Sep 2017 07:11:23 GMT
       Cache-Control:
       - private
     body:
@@ -41,5 +41,5 @@ http_interactions:
       string: '{"response":[{"success":false,"error":{"message":"You cannot export
         data older than 60 days"}}]}'
     http_version: 
-  recorded_at: Tue, 12 Sep 2017 04:00:00 GMT
+  recorded_at: Thu, 14 Sep 2017 07:09:10 GMT
 recorded_with: VCR 3.0.3

data/spec/fixtures/vcr/export_data_dates.yml

@@ -23,22 +23,22 @@ http_interactions:
       Content-Type:
       - application/json;charset=utf-8
       X-Cloud-Trace-Context:
-      - 5f52126aafee5383ee9c42dcbc363208
+      - a2afa156055ea0473f5bc37bf6678ccb
       Set-Cookie:
-      - GOOGAPPUID=xCgsIAxDFBSDkl-HNBQ; expires=Sun, 01-Nov-2020 17:04:36 GMT; path=/
+      - GOOGAPPUID=xCgsIAxCKAiCb1-jNBQ; expires=Tue, 03-Nov-2020 03:11:24 GMT; path=/
       Date:
-      - Tue, 12 Sep 2017 21:04:36 GMT
+      - Thu, 14 Sep 2017 07:11:24 GMT
       Server:
       - Google Frontend
       Content-Length:
       - '85'
       Expires:
-      - Tue, 12 Sep 2017 21:04:36 GMT
+      - Thu, 14 Sep 2017 07:11:24 GMT
       Cache-Control:
       - private
     body:
       encoding: UTF-8
-      string: '{"response":[{"jobId":"export_4727756026281984_6485639014313861120","success":true}]}'
+      string: '{"response":[{"jobId":"export_4727756026281984_7697342875813400576","success":true}]}'
     http_version: 
-  recorded_at: Tue, 12 Sep 2017 04:00:00 GMT
+  recorded_at: Thu, 14 Sep 2017 07:09:10 GMT
 recorded_with: VCR 3.0.3

data/spec/fixtures/vcr/export_user.yml

@@ -23,22 +23,22 @@ http_interactions:
       Content-Type:
       - application/json;charset=utf-8
       X-Cloud-Trace-Context:
-      - 70e27b29a0e132e9b020b3c58861a123
+      - 4a45807783f206b776fd3fb9a544860d
       Set-Cookie:
-      - GOOGAPPUID=xCgoIAxBmIN-X4c0F; expires=Sun, 01-Nov-2020 17:04:31 GMT; path=/
+      - GOOGAPPUID=xCgsIAxCYByCX1-jNBQ; expires=Tue, 03-Nov-2020 03:11:19 GMT; path=/
       Date:
-      - Tue, 12 Sep 2017 21:04:31 GMT
+      - Thu, 14 Sep 2017 07:11:19 GMT
       Server:
       - Google Frontend
       Content-Length:
-      - '526'
+      - '598'
       Expires:
-      - Tue, 12 Sep 2017 21:04:31 GMT
+      - Thu, 14 Sep 2017 07:11:19 GMT
       Cache-Control:
       - private
     body:
       encoding: UTF-8
-      string: '{"response":[{"totalSessions":0,"timeSpentInApp":0.0,"userAttributes":{"is_tipping":"True","gender":"m","last_name":"Jones","create_date":"2010-01-01","first_name":"Mike","email":"still_tippin@test.com"},"lastActive":1.446709787966E9,"devices":[],"success":true,"created":1.43935302887E9,"unsubscribeChannels":[],"userId":"123456","events":{"purchase":{"firstTime":1.460514593026E9,"lastTime":1.505189741992E9,"count":70},"eventName1":{"firstTime":1.4735664E9,"lastTime":1.5051888E9,"count":1}},"userBucket":358,"states":{}}]}'
+      string: '{"response":[{"totalSessions":0,"timeSpentInApp":0.0,"userAttributes":{"is_tipping":"True","gender":"m","last_name":"Jones","create_date":"2010-01-01","first_name":"Mike","email":"still_tippin@test.com"},"lastActive":1.446709787966E9,"devices":[{"deviceId":null},{"deviceId":null},{"deviceId":null},{"deviceId":null}],"success":true,"created":1.43935302887E9,"unsubscribeChannels":[],"userId":"123456","events":{"purchase":{"firstTime":1.460514593026E9,"lastTime":1.505288764337E9,"count":91},"eventName1":{"firstTime":1.4735664E9,"lastTime":1.50537295E9,"count":1}},"userBucket":358,"states":{}}]}'
     http_version: 
-  recorded_at: Tue, 12 Sep 2017 04:00:00 GMT
+  recorded_at: Thu, 14 Sep 2017 07:09:10 GMT
 recorded_with: VCR 3.0.3

data/spec/fixtures/vcr/export_users.yml

@@ -0,0 +1,44 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://www.leanplum.com/api?ab_test_id&action=exportUsers&apiVersion=1.0.6&appId=<LEANPLUM_APP_ID>&clientKey=<LEANPLUM_DATA_EXPORT_KEY>&devMode=false&segment
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.13.1
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Origin:
+      - "*"
+      Content-Type:
+      - application/json;charset=utf-8
+      X-Cloud-Trace-Context:
+      - df14ae5ccab73158a1947c3245bcb7ae
+      Set-Cookie:
+      - GOOGAPPUID=xCgoIAxAXIJzX6M0F; expires=Tue, 03-Nov-2020 03:11:25 GMT; path=/
+      Date:
+      - Thu, 14 Sep 2017 07:11:25 GMT
+      Server:
+      - Google Frontend
+      Content-Length:
+      - '90'
+      Expires:
+      - Thu, 14 Sep 2017 07:11:25 GMT
+      Cache-Control:
+      - private
+    body:
+      encoding: UTF-8
+      string: '{"response":[{"jobId":"export_users_4727756026281984_463727504458688512","success":true}]}'
+    http_version: 
+  recorded_at: Thu, 14 Sep 2017 07:09:10 GMT
+recorded_with: VCR 3.0.3

data/spec/fixtures/vcr/get_ab_test.yml

@@ -23,22 +23,22 @@ http_interactions:
       Content-Type:
       - application/json;charset=utf-8
       X-Cloud-Trace-Context:
-      - 77c3cb5a37e7e738ab1e734b86c04d01
+      - 5f639aa393cfced405c1853c39d57f3b
       Set-Cookie:
-      - GOOGAPPUID=xCgsIAxCtAyDnl-HNBQ; expires=Sun, 01-Nov-2020 17:04:39 GMT; path=/
+      - GOOGAPPUID=xCgsIAxDyASCa1-jNBQ; expires=Tue, 03-Nov-2020 03:11:23 GMT; path=/
       Date:
-      - Tue, 12 Sep 2017 21:04:39 GMT
+      - Thu, 14 Sep 2017 07:11:23 GMT
       Server:
       - Google Frontend
       Content-Length:
       - '44'
       Expires:
-      - Tue, 12 Sep 2017 21:04:39 GMT
+      - Thu, 14 Sep 2017 07:11:23 GMT
       Cache-Control:
       - private
     body:
       encoding: UTF-8
       string: '{"response":[{"success":true,"abTests":[]}]}'
     http_version: 
-  recorded_at: Tue, 12 Sep 2017 04:00:00 GMT
+  recorded_at: Thu, 14 Sep 2017 07:09:10 GMT
 recorded_with: VCR 3.0.3

data/spec/fixtures/vcr/get_ab_tests.yml

@@ -23,22 +23,22 @@ http_interactions:
       Content-Type:
       - application/json;charset=utf-8
       X-Cloud-Trace-Context:
-      - 37ed4e82db5ccf5c93ec2c0cb02b88f8
+      - f3345c6634ba954b9320a0c8a9691cc4
       Set-Cookie:
-      - GOOGAPPUID=xCgoIAxBnIOaX4c0F; expires=Sun, 01-Nov-2020 17:04:39 GMT; path=/
+      - GOOGAPPUID=xCgsIAxDaBCCa1-jNBQ; expires=Tue, 03-Nov-2020 03:11:22 GMT; path=/
       Date:
-      - Tue, 12 Sep 2017 21:04:39 GMT
+      - Thu, 14 Sep 2017 07:11:22 GMT
       Server:
       - Google Frontend
       Content-Length:
       - '44'
       Expires:
-      - Tue, 12 Sep 2017 21:04:39 GMT
+      - Thu, 14 Sep 2017 07:11:22 GMT
       Cache-Control:
       - private
     body:
       encoding: UTF-8
       string: '{"response":[{"success":true,"abTests":[]}]}'
     http_version: 
-  recorded_at: Tue, 12 Sep 2017 04:00:00 GMT
+  recorded_at: Thu, 14 Sep 2017 07:09:10 GMT
 recorded_with: VCR 3.0.3

data/spec/fixtures/vcr/get_export_results.yml

@@ -23,22 +23,22 @@ http_interactions:
       Content-Type:
       - application/json;charset=utf-8
       X-Cloud-Trace-Context:
-      - a0201485c5fa5fd2db265a7c401717de
+      - 57c5f652893bfe7228c29e843cfca431
       Set-Cookie:
-      - GOOGAPPUID=xCgsIAxDZBiDll-HNBQ; expires=Sun, 01-Nov-2020 17:04:37 GMT; path=/
+      - GOOGAPPUID=xCgsIAxDOASCc1-jNBQ; expires=Tue, 03-Nov-2020 03:11:24 GMT; path=/
       Date:
-      - Tue, 12 Sep 2017 21:04:37 GMT
+      - Thu, 14 Sep 2017 07:11:24 GMT
       Server:
       - Google Frontend
       Content-Length:
       - '268'
       Expires:
-      - Tue, 12 Sep 2017 21:04:37 GMT
+      - Thu, 14 Sep 2017 07:11:24 GMT
       Cache-Control:
       - private
     body:
       encoding: UTF-8
       string: '{"response":[{"numBytes":36590,"jobId":"export_4727756026281984_2904941266315269120","numSessions":101,"success":true,"files":["https://leanplum_export.storage.googleapis.com/export-4727756026281984-d5969d55-f242-48a6-85a3-165af08e2306-output-0"],"state":"FINISHED"}]}'
     http_version: 
-  recorded_at: Tue, 12 Sep 2017 04:00:00 GMT
+  recorded_at: Thu, 14 Sep 2017 07:09:10 GMT
 recorded_with: VCR 3.0.3

data/spec/fixtures/vcr/get_messages.yml

@@ -23,17 +23,17 @@ http_interactions:
       Content-Type:
       - application/json;charset=utf-8
       X-Cloud-Trace-Context:
-      - e786087f6475468460337c3b45cb9805
+      - 414ab5c763ea4c1c170af2b76d79b0c3
       Set-Cookie:
-      - GOOGAPPUID=xCgsIAxDdBCDol-HNBQ; expires=Sun, 01-Nov-2020 17:04:40 GMT; path=/
+      - GOOGAPPUID=xCgsIAxDHBiCb1-jNBQ; expires=Tue, 03-Nov-2020 03:11:23 GMT; path=/
       Date:
-      - Tue, 12 Sep 2017 21:04:40 GMT
+      - Thu, 14 Sep 2017 07:11:23 GMT
       Server:
       - Google Frontend
       Content-Length:
       - '165'
       Expires:
-      - Tue, 12 Sep 2017 21:04:40 GMT
+      - Thu, 14 Sep 2017 07:11:23 GMT
       Cache-Control:
       - private
     body:
@@ -41,5 +41,5 @@ http_interactions:
       string: '{"response":[{"success":true,"messages":[{"messageType":"Push Notification","created":1.440091595799E9,"name":"New
         Message","active":false,"id":5670583287676928}]}]}'
     http_version: 
-  recorded_at: Tue, 12 Sep 2017 04:00:00 GMT
+  recorded_at: Thu, 14 Sep 2017 07:09:10 GMT
 recorded_with: VCR 3.0.3