mrkt 0.6.2 → 1.2.0

data/spec/concerns/crud_activities_spec.rb

@@ -0,0 +1,279 @@
+describe Mrkt::CrudActivities do
+  include_context 'initialized client'
+
+  describe '#get_activity_types' do
+    let(:response_stub) do
+      {
+        requestId: 'c245#14cd6830ae2',
+        result: [
+          {
+            id: 1,
+            name: 'Visit Webpage',
+            description: 'User visits a web page',
+            primareAttributes: {
+              name: 'Webpage ID',
+              dataType: 'integer'
+            },
+            attributes: [
+              {
+                name: 'Query Parameters',
+                dataType: 'string'
+              },
+              {
+                name: 'Webpage URL',
+                dataType: 'string'
+              }
+            ]
+          }
+        ],
+        success: true
+      }
+    end
+    subject { client.get_activity_types }
+
+    before do
+      stub_request(:get, "https://#{host}/rest/v1/activities/types.json")
+        .to_return(json_stub(response_stub))
+    end
+
+    it { is_expected.to eq(response_stub) }
+  end
+
+  describe '#get_paging_token' do
+    let(:since_datetime) { Time.utc(2017, 1, 1, 4, 30) }
+    let(:response_stub) do
+      {
+        requestId: '12eb3#1599b371c62',
+        success: true,
+        nextPageToken: '4GAX7YNCIJKO2VAED5LH5PQIYPUM7WCVKTQWEDMP2L24AXZT54LA===='
+      }
+    end
+    subject { client.get_paging_token(since_datetime) }
+
+    before do
+      stub_request(:get, "https://#{host}/rest/v1/activities/pagingtoken.json")
+        .with(query: { sinceDatetime: '2017-01-01T04:30:00Z' })
+        .to_return(json_stub(response_stub))
+    end
+
+    it { is_expected.to eq(response_stub) }
+  end
+
+  describe '#get_activities' do
+    let(:activity_type_ids) { [1, 2] }
+    let(:lead_ids) { [100, 102] }
+    let(:token) { '4GAX7YNCIJKO2VAED5LH5PQIYPUM7WCVKTQWEDMP2L24AXZT54LA====' }
+    let(:response_stub) do
+      {
+        data: {
+          requestId: '417b#1599b3bca62',
+          result: [
+            {
+              id: 500,
+              leadId: 100,
+              activityDate: '2017-01-01T07:53:29Z',
+              activityTypeId: 1,
+              primaryAttributeValueId: 29,
+              primaryAttributeValue: 'test',
+              attributes: [
+                {
+                  name: 'Query Parameters',
+                  value: ''
+                },
+                {
+                  name: 'Webpage URL',
+                  value: '/test.html'
+                }
+              ]
+            },
+            {
+              id: 456,
+              leadId: 101,
+              activityDate: '2017-01-01T08:13:36Z',
+              activityTypeId: 12,
+              primaryAttributeValueId: 101,
+              attributes: [
+                {
+                  name: 'Form Name',
+                  value: 'Sign Up'
+                }
+              ]
+            }
+          ]
+        },
+        success: true,
+        nextPageToken: 'WQV2VQVPPCKHC6AQYVK7JDSA3I5PBAJNUNY3CR563KMVM7F43OIQ====',
+        moreResult: false
+      }
+    end
+    subject { client.get_activities(token) }
+
+    before do
+      stub_request(:get, "https://#{host}/rest/v1/activities.json")
+        .with(query: { nextPageToken: token })
+        .to_return(json_stub(response_stub))
+    end
+
+    it { is_expected.to eq(response_stub) }
+
+    context 'specifying activity type ids' do
+      let(:response_stub) do
+        {
+          data: {
+            requestId: '417b#1599b3bca62',
+            result: [
+              {
+                id: 500,
+                leadId: 100,
+                activityDate: '2017-01-01T07:53:29Z',
+                activityTypeId: 1,
+                primaryAttributeValueId: 29,
+                primaryAttributeValue: 'test',
+                attributes: [
+                  {
+                    name: 'Query Parameters',
+                    value: ''
+                  },
+                  {
+                    name: 'Webpage URL',
+                    value: '/test.html'
+                  }
+                ]
+              }
+            ]
+          },
+          success: true,
+          nextPageToken: 'WQV2VQVPPCKHC6AQYVK7JDSA3I5PBAJNUNY3CR563KMVM7F43OIQ====',
+          moreResult: false
+        }
+      end
+      subject { client.get_activities(token, activity_type_ids: activity_type_ids) }
+
+      before do
+        stub_request(:get, "https://#{host}/rest/v1/activities.json")
+          .with(query: {
+            nextPageToken: token,
+            activityTypeIds: activity_type_ids.join(',')
+          })
+          .to_return(json_stub(response_stub))
+      end
+
+      it { is_expected.to eq(response_stub) }
+    end
+
+    context 'specifying lead ids' do
+      let(:response_stub) do
+        {
+          data: {
+            requestId: '417b#1599b3bca62',
+            result: [
+              {
+                id: 500,
+                leadId: 100,
+                activityDate: '2017-01-01T07:53:29Z',
+                activityTypeId: 1,
+                primaryAttributeValueId: 29,
+                primaryAttributeValue: 'test',
+                attributes: [
+                  {
+                    name: 'Query Parameters',
+                    value: ''
+                  },
+                  {
+                    name: 'Webpage URL',
+                    value: '/test.html'
+                  }
+                ]
+              }
+            ]
+          },
+          success: true,
+          nextPageToken: 'WQV2VQVPPCKHC6AQYVK7JDSA3I5PBAJNUNY3CR563KMVM7F43OIQ====',
+          moreResult: false
+        }
+      end
+      subject { client.get_activities(token, lead_ids: lead_ids) }
+
+      before do
+        stub_request(:get, "https://#{host}/rest/v1/activities.json")
+          .with(query: { nextPageToken: token, leadIds: lead_ids.join(',') })
+          .to_return(json_stub(response_stub))
+      end
+
+      it { is_expected.to eq(response_stub) }
+    end
+
+    context 'specifying arrays values as empty strings' do
+      let(:activity_type_ids) { '' }
+      let(:lead_ids) { '' }
+      subject do
+        client.get_activities(token, activity_type_ids: activity_type_ids, lead_ids: lead_ids)
+      end
+
+      before do
+        stub_request(:get, "https://#{host}/rest/v1/activities.json")
+          .with(query: { nextPageToken: token })
+          .to_return(json_stub(response_stub))
+      end
+
+      it { is_expected.to eq(response_stub) }
+    end
+
+    context 'specifying all options' do
+      subject do
+        client.get_activities(token, activity_type_ids: activity_type_ids, lead_ids: lead_ids)
+      end
+
+      before do
+        stub_request(:get, "https://#{host}/rest/v1/activities.json")
+          .with(query: {
+            nextPageToken: token,
+            activityTypeIds: activity_type_ids.join(','),
+            leadIds: lead_ids.join(',')
+          })
+          .to_return(json_stub(response_stub))
+      end
+
+      it { is_expected.to eq(response_stub) }
+    end
+  end
+
+  describe '#get_deleted_leads' do
+    let(:token) { '4GAX7YNCIJKO2VAED5LH5PQIYPUM7WCVKTQWEDMP2L24AXZT54LA====' }
+    let(:response_stub) do
+      {
+        requestId: '8105#1650074c30c',
+        result:  [
+          {
+            id: 12_751,
+            marketoGUID: '12751',
+            leadId: 277,
+            activityDate: '2018-08-03T14:58:53Z',
+            activityTypeId: 37,
+            campaignId: 5227,
+            primaryAttributeValueId: 277,
+            primaryAttributeValue: 'Delete Me',
+            attributes:  [
+              {
+                name: 'Campaign',
+                value: 'Run Action Delete Lead 2018-08-03 04:58:50 pm'
+              }
+            ]
+          }
+        ],
+        success: true,
+        nextPageToken: 'XQH6SLHODNIM7CY6MKJ6GAOR3JYOQXIN3THAHKYZXSOYN4HOPR2Q====',
+        moreResult: false
+      }
+    end
+    subject { client.get_deleted_leads(token) }
+
+    before do
+      stub_request(:get, "https://#{host}/rest/v1/activities/deletedleads.json")
+        .with(query: { nextPageToken: token })
+        .to_return(json_stub(response_stub))
+    end
+
+    it { is_expected.to eq(response_stub) }
+  end
+end

data/spec/concerns/crud_asset_folders_spec.rb

@@ -0,0 +1,273 @@
+describe Mrkt::CrudAssetFolders do
+  include_context 'initialized client'
+
+  let(:response_folder_result) do
+    {
+      name: 'Test Folder Name',
+      description: 'Optional folder description',
+      createdAt: '2019-03-15T23:31:00Z+0000',
+      updatedAt: '2019-03-15T23:31:00Z+0000',
+      url: 'https://app-devlocal1.marketo.com/#ML0A1ZN75',
+      folderId: {
+        id: 75,
+        type: 'Folder'
+      },
+      folderType: 'Zone',
+      parent: {
+        id: 5,
+        type: 'Folder'
+      },
+      path: '/Lead Database/Default/Test Folder Name',
+      isArchive: false,
+      isSystem: false,
+      accessZoneId: 1,
+      workspace: 'Default',
+      id: 75
+    }
+  end
+
+  describe '#create_folder' do
+    subject { client.create_folder(name, parent, description: description) }
+
+    let(:name) { 'Test Folder Name' }
+    let(:parent) do
+      { id: 5, type: 'Folder' }
+    end
+    let(:description) { 'Optional folder description' }
+    let(:response_stub) do
+      {
+        requestId: 'bf7d#16983b1c7e3',
+        result: [
+          response_folder_result
+        ],
+        success: true,
+        errors: [],
+        warnings: []
+      }
+    end
+
+    let(:json_parent) { JSON.generate(parent) }
+    let(:request_body) do
+      {
+        name: name,
+        parent: json_parent,
+        description: description
+      }
+    end
+
+    before do
+      stub_request(:post, "https://#{host}/rest/asset/v1/folders.json")
+        .with(body: request_body)
+        .to_return(json_stub(response_stub))
+    end
+
+    it { is_expected.to eq(response_stub) }
+  end
+
+  describe '#get_folder_by_id' do
+    subject { client.get_folder_by_id(id, type: type) }
+
+    let(:id) { 77 }
+
+    before do
+      stub_request(:get, "https://#{host}/rest/asset/v1/folder/#{id}.json?type=#{type}")
+        .to_return(json_stub(response_stub))
+    end
+
+    context 'when a folder with the given id exists' do
+      let(:type) { 'Folder' }
+      let(:response_stub) do
+        {
+          requestId: '12756#16983bd0ee5',
+          result: [
+            response_folder_result
+          ],
+          success: true,
+          errors: [],
+          warnings: []
+        }
+      end
+
+      it { is_expected.to eq(response_stub) }
+    end
+
+    context 'when a folder with the given id does not exist' do
+      let(:type) { 'Folder' }
+      let(:response_stub) do
+        {
+          requestId: '18087#16983c04cdf',
+          success: true,
+          errors: [],
+          warnings: [
+            'No assets found for the given search criteria.'
+          ]
+        }
+      end
+
+      it { is_expected.to eq(response_stub) }
+    end
+
+    context 'when the given type is not acceptable' do
+      let(:type) { 'Unacceptable' }
+      let(:response_stub) do
+        {
+          requestId: '12776#16983c25b1d',
+          success: false,
+          warnings: [],
+          errors: [
+            {
+              code: '1001',
+              message: "Invalid value 'Unacceptable'. Required of type 'FolderVariantType'"
+            }
+          ]
+        }
+      end
+
+      it 'should raise an Error' do
+        expect { subject }.to raise_error(Mrkt::Errors::TypeMismatch)
+      end
+    end
+  end
+
+  describe '#get_folder_by_name' do
+    subject { client.get_folder_by_name(name, type: type, root: root, work_space: work_space) }
+
+    let(:name) { 'Test Folder Name' }
+    let(:type) { 'Folder' }
+    let(:root) do
+      {
+        id: 5,
+        type: 'Folder'
+      }
+    end
+    let(:work_space) { 'Default' }
+
+    let(:json_root) { JSON.generate(root) }
+    let(:request_query) { "name=#{name}&type=#{type}&root=#{json_root}&workSpace=#{work_space}" }
+
+    before do
+      stub_request(:get, "https://#{host}/rest/asset/v1/folder/byName.json?#{request_query}")
+        .to_return(json_stub(response_stub))
+    end
+
+    context 'when a folder with the given name exists' do
+      let(:response_stub) do
+        {
+          requestId: '541#16983d2f549',
+          result: [
+            response_folder_result
+          ],
+          success: true,
+          errors: [],
+          warnings: []
+        }
+      end
+
+      it { is_expected.to eq(response_stub) }
+    end
+
+    context 'when a folder with the given name does not exist' do
+      let(:response_stub) do
+        {
+          requestId: '105ad#16983d557c5',
+          success: true,
+          errors: [],
+          warnings: [
+            'No assets found for the given search criteria.'
+          ]
+        }
+      end
+
+      it { is_expected.to eq(response_stub) }
+    end
+
+    context 'when the given work_space does not exist' do
+      let(:response_stub) do
+        {
+          requestId: '17af3#16983da0349',
+          success: false,
+          warnings: [],
+          errors: [
+            {
+              code: '611',
+              message: 'Unable to get folder'
+            }
+          ]
+        }
+      end
+
+      it 'should raise an Error' do
+        expect { subject }.to raise_error(Mrkt::Errors::System)
+      end
+    end
+
+    context 'when the given type is not acceptable' do
+      let(:response_stub) do
+        {
+          requestId: '2225#16983db0b71',
+          success: false,
+          warnings: [],
+          errors: [
+            {
+              code: '1003',
+              message: 'Invalid request. Please check and try again.'
+            }
+          ]
+        }
+      end
+
+      it 'should raise an Error' do
+        expect { subject }.to raise_error(Mrkt::Errors::UnspecifiedAction)
+      end
+    end
+  end
+
+  describe '#delete_folder' do
+    subject { client.delete_folder(id) }
+
+    let(:id) { 75 }
+
+    before do
+      stub_request(:post, "https://#{host}/rest/asset/v1/folder/#{id}/delete.json")
+        .to_return(json_stub(response_stub))
+    end
+
+    context 'when a folder with the given id exists' do
+      let(:response_stub) do
+        {
+          requestId: '1a1a#16983eaa800',
+          result: [
+            {
+              id: 75
+            }
+          ],
+          success: true,
+          errors: [],
+          warnings: []
+        }
+      end
+
+      it { is_expected.to eq(response_stub) }
+    end
+
+    context 'when a folder with the given id does not exist' do
+      let(:response_stub) do
+        {
+          requestId: '102ee#16983f320fb',
+          success: false,
+          warnings: [],
+          errors: [
+            {
+              code: '702',
+              message: '75 Folder not found'
+            }
+          ]
+        }
+      end
+
+      it 'should raise an Error' do
+        expect { subject }.to raise_error(Mrkt::Errors::RecordNotFound)
+      end
+    end
+  end
+end