mrkt 0.6.2 → 1.2.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

@@ -0,0 +1,172 @@
+describe Mrkt::CrudCustomObjects do
+  include_context 'initialized client'
+
+  describe '#get_list_of_custom_activity_types' do
+    let(:response_stub) do
+      {
+        requestId: '14ff3#1579a716c12',
+        result: [
+          {
+            id: 1,
+            name: 'Visit Webpage',
+            description: 'User visits a web page',
+            primaryAttribute: {
+              name: 'Webpage ID',
+              dataType: 'integer'
+            },
+            attributes: [
+              {
+                name: 'Client IP Address',
+                dataType: 'string'
+              },
+              {
+                name: 'Query Parameters',
+                dataType: 'string'
+              }
+            ]
+          },
+          {
+            id: 1,
+            name: 'Visit Webpage',
+            description: 'User visits a web page',
+            primaryAttribute: {
+              name: 'Webpage ID',
+              dataType: 'integer'
+            },
+            attributes: [
+              {
+                name: 'Client IP Address',
+                dataType: 'string'
+              },
+              {
+                name: 'Query Parameters',
+                dataType: 'string'
+              }
+            ]
+          }
+        ],
+        success: true
+      }
+    end
+
+    context 'all activities' do
+      before do
+        stub_request(:get, "https://#{host}/rest/v1/activities/types.json")
+          .to_return(json_stub(response_stub))
+      end
+
+      subject { client.get_list_of_custom_activity_types }
+
+      it { is_expected.to eq(response_stub) }
+    end
+  end
+
+  describe '#create_custom_activity' do
+    let(:response_stub) do
+      {
+        requestId: 'c245#14cd6830ae2',
+        result: [
+          {
+            activityDate: 'string',
+            activityTypeId: 0,
+            apiName: 'string',
+            attributes: [
+              {
+                apiName: 'string',
+                name: 'string',
+                value: {}
+              }
+            ],
+            id: 0,
+            leadId: 0,
+            primaryAttributeValue: 'string',
+            status: 'created'
+          }
+        ],
+        success: true
+      }
+    end
+
+    let(:lead_id) do
+      1
+    end
+
+    let(:activity_type_id) do
+      100_000
+    end
+
+    let(:primary_attribute_value) do
+      'Friday'
+    end
+
+    let(:date) do
+      Time.now
+    end
+
+    context 'with no additional attributes' do
+      let(:request_body) do
+        {
+          input: [{
+            leadId: lead_id,
+            activityDate: date.utc.iso8601,
+            activityTypeId: activity_type_id,
+            primaryAttributeValue: primary_attribute_value,
+            attributes: []
+          }]
+        }
+      end
+
+      before do
+        stub_request(:post, "https://#{host}/rest/v1/activities/external.json")
+          .with(json_stub(request_body))
+          .to_return(json_stub(response_stub))
+      end
+
+      subject { client.create_custom_activity(lead_id, activity_type_id, primary_attribute_value, date: date) }
+
+      it { is_expected.to eq(response_stub) }
+    end
+
+    context 'with additional attributes' do
+      let(:request_body) do
+        {
+          input: [{
+            leadId: lead_id,
+            activityDate: date.utc.iso8601,
+            activityTypeId: activity_type_id,
+            primaryAttributeValue: primary_attribute_value,
+            attributes: [
+              {
+                name: 'percent',
+                value: '0.20'
+              },
+              {
+                name: 'resourceId',
+                value: '_Hy8Sfk9938005SSF'
+              }
+            ]
+          }]
+        }
+      end
+
+      before do
+        stub_request(:post, "https://#{host}/rest/v1/activities/external.json")
+          .with(json_stub(request_body))
+          .to_return(json_stub(response_stub))
+      end
+
+      let(:attributes) do
+        {
+          percent: '0.20',
+          resourceId: '_Hy8Sfk9938005SSF'
+        }
+      end
+
+      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
+  end
+end

data/spec/concerns/crud_custom_objects_spec.rb

@@ -5,35 +5,40 @@ describe Mrkt::CrudCustomObjects do
     let(:response_stub) do
       {
         requestId: 'c245#14cd6830ae2',
-        result: [{
-          name: 'device_c',
-          displayName: 'Device',
-          description: 'this is a device object',
-          createdAt: '2016-01-23T00:51:18Z',
-          updatedAt: '2016-01-23T00:51:18Z',
-          idField: 'marketoGUID',
-          dedupeFields: ['serialNumber'],
-          searchableFields: [['serialNumber'], ['marketoGUID']],
-          relationships: [{
-              field: 'email',
-              type: 'child',
-              relatedTo: { name: 'Lead', field: 'email' }
-          }],
-        },
-        {
-          name: 'manufacturer_c',
-          displayName: 'Manufacturer',
-          createdAt: '2016-01-23T00:55:18Z',
-          updatedAt: '2016-01-23T00:55:18Z',
-          idField: 'marketoGUID',
-          dedupeFields: ['name'],
-          searchableFields: [['name'], ['marketoGUID']],
-          relationships: [{
-            field: 'email',
-            type: 'child',
-            relatedTo: { name: 'Lead', field: 'email' }
-          }]
-        }],
+        result: [
+          {
+            name: 'device_c',
+            displayName: 'Device',
+            description: 'this is a device object',
+            createdAt: '2016-01-23T00:51:18Z',
+            updatedAt: '2016-01-23T00:51:18Z',
+            idField: 'marketoGUID',
+            dedupeFields: ['serialNumber'],
+            searchableFields: [['serialNumber'], ['marketoGUID']],
+            relationships: [
+              {
+                field: 'email',
+                type: 'child',
+                relatedTo: { name: 'Lead', field: 'email' }
+              }
+            ]
+          }, {
+            name: 'manufacturer_c',
+            displayName: 'Manufacturer',
+            createdAt: '2016-01-23T00:55:18Z',
+            updatedAt: '2016-01-23T00:55:18Z',
+            idField: 'marketoGUID',
+            dedupeFields: ['name'],
+            searchableFields: [['name'], ['marketoGUID']],
+            relationships: [
+              {
+                field: 'email',
+                type: 'child',
+                relatedTo: { name: 'Lead', field: 'email' }
+              }
+            ]
+          }
+        ],
         success: true
       }
     end
@@ -50,11 +55,11 @@ 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")
-          .with(query: {names: object_names.join(',')})
+          .with(query: { names: object_names.join(',') })
           .to_return(json_stub(response_stub))
       end
 
@@ -67,50 +72,56 @@ describe Mrkt::CrudCustomObjects do
   describe '#describe_custom_object' do
     let(:response_stub) do
       {
-        requestId: "eeef#152858b17d2",
-        result: [{
-          name: "device_c",
-          displayName: "Device",
-          description: "this is a device object",
-          createdAt: "2016-01-23T00:51:18Z",
-          updatedAt: "2016-01-23T00:51:18Z",
-          idField: "marketoGUID",
-          dedupeFields: ["serialNumber"],
-          searchableFields: [["serialNumber"], ["marketoGUID"]],
-          relationships: [{
-            field: "serialNumber",
-            type: "child",
-            relatedTo: {
-              name: "Lead",
-              field: "serialNumber"
-            }
-          }],
-          fields: [{
-            name: "createdAt",
-            displayName: "Created At",
-            dataType: "datetime",
-            updateable: false
-            },
-            { name: "marketoGUID",
-              displayName: "Marketo GUID",
-              dataType: "string",
-              length:36,
-              updateable: false
-            },
-            { name: "updatedAt",
-              displayName: "Updated At",
-              dataType: "datetime",
-              updateable: false
-            },
-            { name: "serialNumber",
-              displayName: "serial number",
-              dataType: "string",
-              length: 255,
-              updateable: true
-            }]
-          }],
-          success: true
-        }
+        requestId: 'eeef#152858b17d2',
+        result: [
+          {
+            name: 'device_c',
+            displayName: 'Device',
+            description: 'this is a device object',
+            createdAt: '2016-01-23T00:51:18Z',
+            updatedAt: '2016-01-23T00:51:18Z',
+            idField: 'marketoGUID',
+            dedupeFields: ['serialNumber'],
+            searchableFields: [['serialNumber'], ['marketoGUID']],
+            relationships: [
+              {
+                field: 'serialNumber',
+                type: 'child',
+                relatedTo: {
+                  name: 'Lead',
+                  field: 'serialNumber'
+                }
+              }
+            ],
+            fields: [
+              {
+                name: 'createdAt',
+                displayName: 'Created At',
+                dataType: 'datetime',
+                updateable: false
+              }, {
+                name: 'marketoGUID',
+                displayName: 'Marketo GUID',
+                dataType: 'string',
+                length: 36,
+                updateable: false
+              }, {
+                name: 'updatedAt',
+                displayName: 'Updated At',
+                dataType: 'datetime',
+                updateable: false
+              }, {
+                name: 'serialNumber',
+                displayName: 'serial number',
+                dataType: 'string',
+                length: 255,
+                updateable: true
+              }
+            ]
+          }
+        ],
+        success: true
+      }
     end
 
     before do
@@ -120,23 +131,22 @@ describe Mrkt::CrudCustomObjects do
 
     subject { client.describe_custom_object(object_name) }
 
-    context "when the object name is valid" do
+    context 'when the object name is valid' do
       let(:object_name) { :device_c }
 
       it { is_expected.to eq(response_stub) }
     end
 
-    context "when the object name is invalid" do
+    context 'when the object name is invalid' do
       let(:object_name) { nil }
 
       it 'should raise an Error' do
-        object_name = []
         expect { subject }.to raise_error(Mrkt::Errors::Unknown)
       end
     end
   end
 
-  describe "#createupdate_custom_objects" do
+  describe '#createupdate_custom_objects' do
     let(:object_name) { 'device' }
 
     let(:devices) do
@@ -179,7 +189,7 @@ describe Mrkt::CrudCustomObjects do
     it { is_expected.to eq(response_stub) }
   end
 
-  describe "#delete_custom_objects" do
+  describe '#delete_custom_objects' do
     let(:object_name) { 'device' }
 
     let(:search_fields) do
@@ -199,8 +209,8 @@ describe Mrkt::CrudCustomObjects do
         success: true,
         result: [{
           seq: 0,
-          status: "deleted",
-          marketoGUID: "1fc49d4fcb86"
+          status: 'deleted',
+          marketoGUID: '1fc49d4fcb86'
         }]
       }
     end
@@ -216,8 +226,8 @@ describe Mrkt::CrudCustomObjects do
     it { is_expected.to eq(response_stub) }
   end
 
-  describe "#get_custom_objects" do
-    let(:object_name) { 'device'}
+  describe '#get_custom_objects' do
+    let(:object_name) { 'device' }
 
     let(:filter_values) do
       [{
@@ -234,13 +244,13 @@ describe Mrkt::CrudCustomObjects do
 
     let(:response_stub) do
       {
-        requestId: "1490d#1528af5232",
+        requestId: '1490d#1528af5232',
         result: [{
           seq: 0,
-          marketoGUID: "163b231LPr23200e570",
-          serialNumber: "serial_number_1",
-          createdAt: "2016-01-23T05:01:01Z",
-          updatedAt: "2016-01-29T00:26:00Z"
+          marketoGUID: '163b231LPr23200e570',
+          serialNumber: 'serial_number_1',
+          createdAt: '2016-01-23T05:01:01Z',
+          updatedAt: '2016-01-29T00:26:00Z'
         }],
         success: true
       }