mrkt 0.8.0 → 1.0.0

data/spec/concerns/crud_asset_static_lists_spec.rb

@@ -0,0 +1,183 @@
+describe Mrkt::CrudAssetStaticLists do
+  include_context 'initialized client'
+
+  let(:response_static_list_result) do
+    {
+      id: 1001,
+      name: 'Test Static List Name',
+      description: 'Provided description',
+      createdAt: '2019-03-15T21:41:46Z+0000',
+      updatedAt: '2019-03-15T21:41:46Z+0000',
+      folder: {
+        id: 14,
+        type: 'Folder'
+      },
+      computedUrl: 'https://app-devlocal1.marketo.com/#ST1001A1'
+    }
+  end
+
+  describe '#create_static_list' do
+    subject { client.create_static_list(name, folder, description: description) }
+
+    let(:name) { 'Test Static List Name' }
+    let(:folder) do
+      { id: 14, type: 'Folder' }
+    end
+    let(:description) { 'Provided description' }
+    let(:response_stub) do
+      {
+        requestId: 'eba#16982091b99',
+        result: [
+          response_static_list_result
+        ],
+        success: true,
+        errors: [],
+        warnings: []
+      }
+    end
+
+    let(:json_folder) { JSON.generate(folder) }
+    let(:request_body) do
+      {
+        name: name,
+        folder: json_folder,
+        description: description
+      }
+    end
+
+    before do
+      stub_request(:post, "https://#{host}/rest/asset/v1/staticLists.json")
+        .with(body: request_body)
+        .to_return(json_stub(response_stub))
+    end
+
+    it { is_expected.to eq(response_stub) }
+  end
+
+  describe '#get_static_list_by_id' do
+    subject { client.get_static_list_by_id(id) }
+
+    let(:id) { response_static_list_result[:id] }
+    let(:response_stub) do
+      {
+        requestId: '378a#16983419fff',
+        result: [
+          response_static_list_result
+        ],
+        success: true,
+        errors: [],
+        warnings: []
+      }
+    end
+
+    before do
+      stub_request(:get, "https://#{host}/rest/asset/v1/staticList/#{id}.json")
+        .to_return(json_stub(response_stub))
+    end
+
+    context 'when a static list with the given id exists' do
+      let(:response_stub) do
+        {
+          requestId: '378a#16983419fff',
+          result: [
+            response_static_list_result
+          ],
+          success: true,
+          errors: [],
+          warnings: []
+        }
+      end
+
+      it { is_expected.to eq(response_stub) }
+    end
+
+    context 'when a static list with the given id does not exist' do
+      let(:response_stub) do
+        {
+          requestId: 'a8d#1698369857b',
+          success: false,
+          warnings: [],
+          errors: [
+            {
+              code: '702',
+              message: 'Static List not found or it has been deleted'
+            }
+          ]
+        }
+      end
+
+      it 'should raise an Error' do
+        expect { subject }.to raise_error(Mrkt::Errors::RecordNotFound)
+      end
+    end
+  end
+
+  describe '#get_static_list_by_name' do
+    subject { client.get_static_list_by_name(name) }
+
+    let(:name) { 'Test Static List Name' }
+    let(:request_query) { "name=#{name}" }
+
+    before do
+      stub_request(:get, "https://#{host}/rest/asset/v1/staticList/byName.json?#{request_query}")
+        .to_return(json_stub(response_stub))
+    end
+
+    context 'when a static list with the given name exists' do
+      let(:response_stub) do
+        {
+          requestId: '13a74#169834522b9',
+          result: [
+            response_static_list_result
+          ],
+          success: true,
+          errors: [],
+          warnings: []
+        }
+      end
+
+      it { is_expected.to eq(response_stub) }
+    end
+
+    context 'when a static list with the given name does not exist' do
+      let(:response_stub) do
+        {
+          requestId: '4ec2#1698384ae02',
+          success: true,
+          errors: [],
+          warnings: [
+            'No assets found for the given search criteria.'
+          ]
+        }
+      end
+
+      it { is_expected.to eq(response_stub) }
+    end
+  end
+
+  describe '#delete_static_list' do
+    subject { client.delete_static_list(id) }
+
+    let(:id) { 1001 }
+    let(:response_stub) do
+      {
+        requestId: '94c3#169833275df',
+        result: [
+          {
+            id: 1001
+          }
+        ],
+        success: true,
+        errors: [],
+        warnings: []
+      }
+    end
+
+    before do
+      stub_request(:post, "https://#{host}/rest/asset/v1/staticList/#{id}/delete.json")
+        .to_return(json_stub(response_stub))
+    end
+
+    it { is_expected.to eq(response_stub) }
+  end
+end

data/spec/concerns/crud_custom_activities_spec.rb

@@ -162,7 +162,9 @@ describe Mrkt::CrudCustomObjects do
         }
       end
 
-      subject { client.create_custom_activity(lead_id, activity_type_id, primary_attribute_value, attributes: attributes, date: date) }
+      subject do
+        client.create_custom_activity(lead_id, activity_type_id, primary_attribute_value, attributes: attributes, date: date)
+      end
 
       it { is_expected.to eq(response_stub) }
     end

data/spec/concerns/crud_custom_objects_spec.rb

@@ -55,7 +55,7 @@ describe Mrkt::CrudCustomObjects do
     end
 
     context 'with object names' do
-      let(:object_names) { %w(device_c manufacturer_c) }
+      let(:object_names) { %w[device_c manufacturer_c] }
 
       before do
         stub_request(:get, "https://#{host}/rest/v1/customobjects.json")

data/spec/concerns/crud_leads_spec.rb

@@ -1,9 +1,63 @@
 describe Mrkt::CrudLeads do
   include_context 'initialized client'
 
+  describe 'get_lead_by_id' do
+    subject { client.get_lead_by_id(id, fields: fields) }
+
+    let(:id) { 200 }
+
+    let(:fields_query) { fields ? "fields=#{fields.join(',')}" : nil }
+
+    before do
+      stub_request(:get, "https://#{host}/rest/v1/lead/#{id}.json?#{fields_query}")
+        .to_return(json_stub(response_stub))
+    end
+
+    context 'when no fields are given' do
+      let(:fields) { nil }
+      let(:response_stub) do
+        {
+          requestId: '1134#169a69aae86',
+          result: [
+            {
+              id: id,
+              firstName: 'John',
+              lastName: 'Snow',
+              email: 'jfrost@mrkt.com',
+              updatedAt: '2019-03-19T20:39:23Z',
+              createdAt: '2019-03-14T13:41:37Z'
+            }
+          ],
+          success: true
+        }
+      end
+
+      it { is_expected.to eq(response_stub) }
+    end
+
+    context 'when an array of fields is given' do
+      let(:fields) { %w[email dateOfBirth] }
+      let(:response_stub) do
+        {
+          requestId: '33dd#169a6b5ba65',
+          result: [
+            {
+              id: id,
+              email: 'jfrost@mrkt.com',
+              dateOfBirth: '1813-03-15'
+            }
+          ],
+          success: true
+        }
+      end
+
+      it { is_expected.to eq(response_stub) }
+    end
+  end
+
   describe '#get_leads' do
     let(:filter_type) { 'email' }
-    let(:filter_values) { %w(user@example.com) }
+    let(:filter_values) { %w[user@example.com] }
     let(:response_stub) do
       {
         requestId: 'c245#14cd6830ae2',
@@ -196,4 +250,52 @@ describe Mrkt::CrudLeads do
       end
     end
   end
+
+  describe '#describe_lead' do
+    let(:response_stub) do
+      {
+        requestId: '5c9e#169a68fa806',
+        result: [
+          {
+            id: 4,
+            displayName: 'Company Name',
+            dataType: 'string',
+            length: 255,
+            rest: {
+              name: 'company',
+              readOnly: false
+            },
+            soap: {
+              name: 'Company',
+              readOnly: false
+            }
+          },
+          {
+            id: 56,
+            displayName: 'Email Address',
+            dataType: 'email',
+            length: 255,
+            rest: {
+              name: 'email',
+              readOnly: false
+            },
+            soap: {
+              name: 'Email',
+              readOnly: false
+            }
+          }
+        ],
+        success: true
+      }
+    end
+
+    subject { client.describe_lead }
+
+    before do
+      stub_request(:get, "https://#{host}/rest/v1/leads/describe.json")
+        .to_return(json_stub(response_stub))
+    end
+
+    it { is_expected.to eq(response_stub) }
+  end
 end

data/spec/concerns/crud_lists_spec.rb

@@ -63,4 +63,37 @@ describe Mrkt::CrudLists do
 
     it { is_expected.to eq(response_stub) }
   end
+
+  describe '#remove_leads_from_list' do
+    let(:list_id) { '1001' }
+    let(:lead_ids) { ['1'] }
+    let(:request_body) do
+      {
+        input: [
+          { id: '1' }
+        ]
+      }
+    end
+    let(:response_stub) do
+      {
+        requestId: '10de4#1697e81c821',
+        result: [
+          {
+            id: 1,
+            status: 'removed'
+          }
+        ],
+        success: true
+      }
+    end
+    subject { client.remove_leads_from_list(list_id, lead_ids) }
+
+    before do
+      stub_request(:delete, "https://#{host}/rest/v1/lists/#{list_id}/leads.json")
+        .with(json_stub(request_body))
+        .to_return(json_stub(response_stub))
+    end
+
+    it { is_expected.to eq(response_stub) }
+  end
 end

data/spec/concerns/import_custom_objects_spec.rb

@@ -0,0 +1,89 @@
+require 'tempfile'
+
+describe Mrkt::ImportCustomObjects do
+  include_context 'initialized client'
+  let(:custom_object) { 'car_c' }
+
+  describe '#import_custom_object' do
+    let(:file) { StringIO.new }
+    let(:response_stub) do
+      {
+        requestId: 'c015#15a68a23418',
+        success: true,
+        result: [
+          {
+            batchId: 1,
+            status: 'Importing',
+            objectApiName: custom_object
+          }
+        ]
+      }
+    end
+    subject { client.import_custom_object(file, custom_object) }
+
+    before do
+      stub_request(:post, "https://#{host}/bulk/v1/customobjects/#{custom_object}/import.json")
+        .with(headers: { content_type: %r{multipart/form-data; boundary=\S+} })
+        .to_return(json_stub(response_stub))
+    end
+
+    it { is_expected.to eq(response_stub) }
+  end
+
+  describe '#import_custom_object_status' do
+    let(:id) { 1 }
+    let(:response_stub) do
+      {
+        requestId: '2a5#15a68dd9be1',
+        result: [
+          {
+            batchId: id,
+            operation: 'import',
+            status: 'Complete',
+            objectApiName: 'car_c',
+            numOfObjectsProcessed: 3,
+            numOfRowsFailed: 0,
+            numOfRowsWithWarning: 0,
+            importTime: '2 second(s)',
+            message: 'Import succeeded, 3 records imported (3 members)'
+          }
+        ],
+        success: true
+      }
+    end
+    subject { client.import_custom_object_status(1, custom_object) }
+
+    before do
+      stub_request(:get, "https://#{host}/bulk/v1/customobjects/#{custom_object}/import/#{id}/status.json")
+        .to_return(json_stub(response_stub))
+    end
+
+    it { is_expected.to eq(response_stub) }
+  end
+
+  describe '#import_custom_object_failures' do
+    let(:id) { 1 }
+    let(:response_stub) { '' }
+    subject { client.import_custom_object_failures(1, custom_object) }
+
+    before do
+      stub_request(:get, "https://#{host}/bulk/v1/customobjects/#{custom_object}/import/#{id}/failures.json")
+        .to_return(headers: { content_length: 0 })
+    end
+
+    it { is_expected.to eq(response_stub) }
+  end
+
+  describe '#import_custom_object_warnings' do
+    let(:id) { 1 }
+    let(:response_stub) { '' }
+    subject { client.import_custom_object_warnings(1, custom_object) }
+
+    before do
+      stub_request(:get, "https://#{host}/bulk/v1/customobjects/#{custom_object}/import/#{id}/warnings.json")
+        .to_return(headers: { content_length: 0 })
+    end
+
+    it { is_expected.to eq(response_stub) }
+  end
+end