clever_tap 0.3.0

data/spec/units/event_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+require 'shared/entity'
+
+RSpec.describe CleverTap::Event do
+  describe '.upload_limit' do
+    subject { described_class.upload_limit }
+    it { is_expected.to eq 1000 }
+  end
+
+  describe '#to_h' do
+    subject { described_class.new(**params).to_h }
+
+    describe 'choosing `identity`' do
+      it_behaves_like 'choosing identity for', 'event'
+    end
+
+    describe 'choosing timestamp' do
+      it_behaves_like 'choosing timestamp'
+    end
+
+    describe 'event name' do
+      let(:data) { { 'FBID' => '1414', 'Name' => 'John' } }
+      let(:params) { { data: data, identity: 'FBID' } }
+
+      context 'when `name` is not provided' do
+        it { expect { subject }.to raise_error(CleverTap::MissingEventNameError) }
+      end
+
+      context 'when `name` is provided' do
+        let!(:params_ext) { params.merge!(name: 'Web Event') }
+        it { is_expected.to include 'evtName' => 'Web Event' }
+      end
+    end
+
+    describe 'type' do
+      it_behaves_like 'proper type'
+    end
+
+    describe 'data' do
+      it_behaves_like 'constructing data for', 'event'
+    end
+  end
+end

data/spec/units/failed_response_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe CleverTap::FailedResponse do
+  let(:records) { [{ 'id' => 1 }, { 'id' => 2 }] }
+  let(:message) { 'LOL an error' }
+  let(:code) { 401 }
+
+  subject { described_class.new(records: records, message: message, code: code) }
+
+  describe '#status' do
+    it { expect(subject.status).to eq 'fail' }
+  end
+
+  describe '#success' do
+    it { expect(subject.success).to be false }
+  end
+
+  describe '#errors' do
+    it do
+      error = { 'status' => 'fail', 'code' => code, 'error' => message }
+
+      expect(subject.errors).to match_array(
+        records.map { |r| error.merge('record' => r) }
+      )
+    end
+  end
+
+  describe '#message' do
+    it { expect(subject.message).to eq message }
+  end
+end

data/spec/units/profile_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+require 'shared/entity'
+
+RSpec.describe CleverTap::Profile do
+  describe '.upload_limit' do
+    subject { described_class.upload_limit }
+    it { is_expected.to eq 100 }
+  end
+
+  describe '#to_h' do
+    subject { described_class.new(**params).to_h }
+
+    describe 'choosing `identity`' do
+      it_behaves_like 'choosing identity for', 'profile'
+    end
+
+    describe 'choosing timestamp' do
+      it_behaves_like 'choosing timestamp'
+    end
+
+    describe 'type' do
+      it_behaves_like 'proper type'
+    end
+
+    describe 'data' do
+      it_behaves_like 'constructing data for', 'profile'
+    end
+  end
+end

data/spec/units/response_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe CleverTap::Response do
+  let(:success) do
+    { 'status' => 'success', 'processed' => 1, 'unprocessed' => [] }
+  end
+
+  let(:partial) do
+    {
+      'status' => 'success',
+      'processed' => 1,
+      'unprocessed' => [{ '{ "ID" => "5", "Name": "John"}' => 'Some error' }]
+    }
+  end
+
+  let(:failure) do
+    {
+      'status' => 'fail',
+      'error' => 'Account Id not valid',
+      'code' => 401
+    }
+  end
+
+  describe '#new' do
+    subject { described_class.new(response) }
+
+    context 'when successful request' do
+      let(:response) { OpenStruct.new(body: success.to_json) }
+
+      it { expect(subject.success).to be true }
+      it { expect(subject.failures).to eq [] }
+    end
+
+    context 'when partially successful request' do
+      let(:response) { OpenStruct.new(body: partial.to_json) }
+
+      it { expect(subject.success).to be false }
+      it { expect(subject.failures).to eq partial['unprocessed'] }
+    end
+
+    context 'when failed request' do
+      let(:response) { OpenStruct.new(body: failure.to_json) }
+
+      it { expect(subject.success).to be false }
+      it { expect(subject.failures).to eq [failure] }
+    end
+  end
+end

data/spec/units/successful_response_spec.rb

@@ -0,0 +1,112 @@
+require 'spec_helper'
+
+describe CleverTap::SuccessfulResponse do
+  shared_context 'successful state' do
+    let(:raw_response) do
+      { 'status' => 'success', 'processed' => 2, 'unprocessed' => [] }
+    end
+  end
+
+  shared_context 'partial state' do
+    let(:records) { [{ 'id' => 1 }] }
+    let(:raw_response) do
+      {
+        'status' => 'fail',
+        'processed' => 1,
+        'unprocessed' => records.map { |r| { 'record' => r.to_json } }
+      }
+    end
+  end
+
+  shared_context 'fail state' do
+    let(:records) { [{ 'id' => 1 }, { 'id' => 2 }] }
+    let(:raw_response) do
+      {
+        'status' => 'fail',
+        'processed' => 0,
+        'unprocessed' => records.map { |r| { 'record' => r.to_json } }
+      }
+    end
+  end
+
+  subject { described_class.new(raw_response) }
+
+  describe '#status' do
+    context 'with successful status' do
+      include_context 'successful state'
+
+      it { expect(subject.status).to eq 'success' }
+    end
+
+    context 'with partial status' do
+      include_context 'partial state'
+
+      it { expect(subject.status).to eq 'partial' }
+    end
+
+    context 'with fail status' do
+      include_context 'fail state'
+
+      it { expect(subject.status).to eq 'fail' }
+    end
+  end
+
+  describe '#success' do
+    context 'with successful status' do
+      include_context 'successful state'
+
+      it { expect(subject.success).to be true }
+    end
+
+    context 'with partial status' do
+      include_context 'partial state'
+
+      it { expect(subject.success).to be false }
+    end
+
+    context 'with fail status' do
+      include_context 'fail state'
+
+      it { expect(subject.success).to be false }
+    end
+  end
+
+  describe '#errors' do
+    context 'with successful status' do
+      include_context 'successful state'
+
+      it { expect(subject.errors).to be_empty }
+    end
+
+    context 'with partial status' do
+      include_context 'partial state'
+      it { expect(subject.errors).to all(include('record')) }
+    end
+
+    context 'with fail status' do
+      include_context 'fail state'
+
+      it { expect(subject.errors).to all(include('record')) }
+    end
+  end
+
+  describe '#message' do
+    context 'with successful status' do
+      include_context 'successful state'
+
+      it { expect(subject.message).to eq '' }
+    end
+
+    context 'with partial status' do
+      include_context 'partial state'
+
+      it { expect(subject.message).to eq '' }
+    end
+
+    context 'with fail status' do
+      include_context 'fail state'
+
+      it { expect(subject.message).to eq '' }
+    end
+  end
+end

data/spec/units/uploader_spec.rb

@@ -0,0 +1,129 @@
+require 'spec_helper'
+
+shared_examples_for 'validation failure' do |expected_code|
+  it 'failed to upload the profiles' do
+    result = subject.call(client)
+    body = JSON.parse(result.body)
+
+    aggregate_failures 'failed response' do
+      expect(result.success?).to be_truthy
+      expect(result.status).to eq(200)
+      expect(body).to include('processed' => 0,
+                              'status' => 'fail',
+                              'unprocessed' => contain_exactly(
+                                a_hash_including('code' => expected_code),
+                                a_hash_including('code' => expected_code)
+                              ))
+    end
+  end
+end
+
+describe CleverTap::Uploader, vcr: true do
+  describe '#call' do
+    let(:profile_properties) { %i[id created_at full_name last_name bta] }
+    let(:client) { CleverTap::Client.new(AUTH_ACCOUNT_ID, AUTH_PASSCODE) }
+
+    context 'with valid data' do
+      let(:profiles) { [Profile.build_valid, Profile.build_valid] }
+
+      subject { described_class.new(profiles, identity_field: 'identity') }
+
+      it 'makes successful upload' do
+        result = subject.call(client)
+        body = JSON.parse(result.body)
+
+        aggregate_failures 'success response' do
+          expect(result.success?).to be_truthy
+          expect(result.status).to eq(200)
+          expect(body).to include('processed' => 2, 'unprocessed' => [], 'status' => 'success')
+        end
+      end
+    end
+
+    context 'when email is invalid' do
+      let(:profiles) { [Profile.build_valid('Email' => '1234'), Profile.build_valid('Email' => '1234')] }
+
+      subject { described_class.new(profiles, identity_field: 'identity') }
+
+      it_behaves_like 'validation failure', 515
+    end
+
+    context 'when phone is invalid' do
+      let(:profiles) { [Profile.build_valid('Phone' => '223'), Profile.build_valid('Phone' => '123')] }
+
+      subject { described_class.new(profiles, identity_field: 'identity') }
+
+      it_behaves_like 'validation failure', 516
+    end
+
+    context 'when employment status is invalid' do
+      let(:profiles) { [Profile.build_valid('Employed' => '223'), Profile.build_valid('Employed' => '123')] }
+
+      subject { described_class.new(profiles, identity_field: 'identity') }
+
+      it_behaves_like 'validation failure', 517
+    end
+
+    context 'when education status is invalid' do
+      let(:profiles) { [Profile.build_valid('Education' => '223'), Profile.build_valid('Education' => '123')] }
+
+      subject { described_class.new(profiles, identity_field: 'identity') }
+
+      it_behaves_like 'validation failure', 518
+    end
+
+    context 'when marital status is invalid' do
+      let(:profiles) { [Profile.build_valid('Married' => '223'), Profile.build_valid('Married' => '123')] }
+
+      subject { described_class.new(profiles, identity_field: 'identity') }
+
+      it_behaves_like 'validation failure', 519
+    end
+
+    context 'when age is invalid' do
+      let(:profiles) { [Profile.build_valid('Age' => 'aa'), Profile.build_valid('Age' => 'aa')] }
+
+      subject { described_class.new(profiles, identity_field: 'identity') }
+
+      it_behaves_like 'validation failure', 520
+    end
+
+    context 'when the identity field is missing' do
+      let(:profiles) { [Profile.build_valid, Profile.build_valid] }
+
+      subject { described_class.new(profiles, identity_field: 'fake_id') }
+
+      it do
+        expect { subject.call(client) }.to raise_error(RuntimeError, /missing identity field/i)
+      end
+    end
+
+    context 'when the creation date field is missing' do
+      let(:profiles) { [Profile.build_valid, Profile.build_valid] }
+
+      subject do
+        described_class.new(profiles, identity_field: 'identity', date_field: 'fake_created_at')
+      end
+
+      it_behaves_like 'validation failure', 525
+    end
+
+    context 'with invalid credentials' do
+      let(:client) { CleverTap::Client.new('fake-id', 'fake-pass') }
+      subject { described_class.new([Profile.build_valid], identity_field: 'identity') }
+
+      it 'failed to upload the profiles' do
+        result = subject.call(client)
+        body = JSON.parse(result.body)
+
+        aggregate_failures 'failed response' do
+          expect(result.success?).to be_falsy
+          expect(result.status).to eq(401)
+          expect(body).to include('code' => 401,
+                                  'status' => 'fail',
+                                  'error' => matching(/account id/i))
+        end
+      end
+    end
+  end
+end

data/spec/vcr_cassettes/CleverTap/uploading_a_many_profiles/when_only_some_are_valid/partially_succeds.yml

@@ -0,0 +1,42 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.clevertap.com/1/upload
+    body:
+      encoding: UTF-8
+      string: '{"d":[{"identity":"3","ts":1521649274,"type":"profile","profileData":{"identity":3,"created_at":"2018-03-21
+        18:21:14 +0200","Name":"John Rush","Email":"example@gmail.com","Gender":"M","Phone":"+35922333232","Employed":"Y","Education":"Graduate","Married":"Y","Age":"18"}},{"identity":"4","ts":1521649274,"type":"profile","profileData":{"identity":4,"created_at":"2018-03-21
+        18:21:14 +0200","Name":"John Rush","Email":"$$$$$","Gender":"M","Phone":"+35922333232","Employed":"Y","Education":"Graduate","Married":"Y","Age":"18"}}]}'
+    headers:
+      Content-Type:
+      - application/json
+      X-CleverTap-Account-Id:
+      - fake_account_id
+      X-CleverTap-Passcode:
+      - fake_passcode
+      User-Agent:
+      - Faraday v0.14.0
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      content-type:
+      - application/json;charset=utf-8
+      content-length:
+      - '505'
+      connection:
+      - Close
+    body:
+      encoding: UTF-8
+      string: '{ "status" : "partial" , "processed" : 1 , "unprocessed" : [ { "status"
+        : "fail" , "code" : 515 , "error" : "Profile data is incorrect. Email is not
+        valid.Skipped record number : 2" , "record" : { "identity" : "4" , "ts" :
+        1521649274 , "type" : "profile" , "profileData" : { "identity" : 4 , "created_at"
+        : "2018-03-21 18:21:14 +0200" , "Name" : "John Rush" , "Email" : "$$$$$" ,
+        "Gender" : "M" , "Phone" : "+35922333232" , "Employed" : "Y" , "Education"
+        : "Graduate" , "Married" : "Y" , "Age" : "18"}}}]}'
+    http_version: 
+  recorded_at: Wed, 21 Mar 2018 16:21:15 GMT
+recorded_with: VCR 4.0.0

data/spec/vcr_cassettes/CleverTap/uploading_a_profile/when_is_invalid/fails.yml

@@ -0,0 +1,41 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.clevertap.com/1/upload
+    body:
+      encoding: UTF-8
+      string: '{"d":[{"identity":"2","ts":1521649274,"type":"profile","profileData":{"identity":2,"created_at":"2018-03-21
+        18:21:14 +0200","Name":"John Rush","Email":"$$$$$","Gender":"M","Phone":"+35922333232","Employed":"Y","Education":"Graduate","Married":"Y","Age":"18"}}]}'
+    headers:
+      Content-Type:
+      - application/json
+      X-CleverTap-Account-Id:
+      - fake_account_id
+      X-CleverTap-Passcode:
+      - fake_passcode
+      User-Agent:
+      - Faraday v0.14.0
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      content-type:
+      - application/json;charset=utf-8
+      content-length:
+      - '502'
+      connection:
+      - Close
+    body:
+      encoding: UTF-8
+      string: '{ "status" : "fail" , "processed" : 0 , "unprocessed" : [ { "status"
+        : "fail" , "code" : 515 , "error" : "Profile data is incorrect. Email is not
+        valid.Skipped record number : 1" , "record" : { "identity" : "2" , "ts" :
+        1521649274 , "type" : "profile" , "profileData" : { "identity" : 2 , "created_at"
+        : "2018-03-21 18:21:14 +0200" , "Name" : "John Rush" , "Email" : "$$$$$" ,
+        "Gender" : "M" , "Phone" : "+35922333232" , "Employed" : "Y" , "Education"
+        : "Graduate" , "Married" : "Y" , "Age" : "18"}}}]}'
+    http_version: 
+  recorded_at: Wed, 21 Mar 2018 16:21:14 GMT
+recorded_with: VCR 4.0.0