mrkt 1.2.0 → 1.2.1

data/spec/concerns/crud_custom_activities_spec.rb

@@ -1,5 +1,5 @@
 describe Mrkt::CrudCustomObjects do
-  include_context 'initialized client'
+  include_context 'with an initialized client'
 
   describe '#get_list_of_custom_activity_types' do
     let(:response_stub) do
@@ -49,14 +49,14 @@ describe Mrkt::CrudCustomObjects do
       }
     end
 
-    context 'all activities' do
+    context 'with all activities' do
+      subject { client.get_list_of_custom_activity_types }
+
       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
@@ -104,6 +104,8 @@ describe Mrkt::CrudCustomObjects do
     end
 
     context 'with no additional attributes' do
+      subject { client.create_custom_activity(lead_id, activity_type_id, primary_attribute_value, date: date) }
+
       let(:request_body) do
         {
           input: [{
@@ -122,12 +124,14 @@ describe Mrkt::CrudCustomObjects do
           .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
+      subject do
+        client.create_custom_activity(lead_id, activity_type_id, primary_attribute_value, attributes: attributes, date: date)
+      end
+
       let(:request_body) do
         {
           input: [{
@@ -148,13 +152,6 @@ describe Mrkt::CrudCustomObjects do
           }]
         }
       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',
@@ -162,8 +159,10 @@ describe Mrkt::CrudCustomObjects do
         }
       end
 
-      subject do
-        client.create_custom_activity(lead_id, activity_type_id, primary_attribute_value, attributes: attributes, date: date)
+      before do
+        stub_request(:post, "https://#{host}/rest/v1/activities/external.json")
+          .with(json_stub(request_body))
+          .to_return(json_stub(response_stub))
       end
 
       it { is_expected.to eq(response_stub) }

data/spec/concerns/crud_custom_objects_spec.rb

@@ -1,5 +1,5 @@
 describe Mrkt::CrudCustomObjects do
-  include_context 'initialized client'
+  include_context 'with an initialized client'
 
   describe '#get_list_of_custom_objects' do
     let(:response_stub) do
@@ -44,17 +44,19 @@ describe Mrkt::CrudCustomObjects do
     end
 
     context 'with no object names' do
+      subject { client.get_list_of_custom_objects }
+
       before do
         stub_request(:get, "https://#{host}/rest/v1/customobjects.json")
           .to_return(json_stub(response_stub))
       end
 
-      subject { client.get_list_of_custom_objects }
-
       it { is_expected.to eq(response_stub) }
     end
 
     context 'with object names' do
+      subject { client.get_list_of_custom_objects(object_names) }
+
       let(:object_names) { %w[device_c manufacturer_c] }
 
       before do
@@ -63,13 +65,13 @@ describe Mrkt::CrudCustomObjects do
           .to_return(json_stub(response_stub))
       end
 
-      subject { client.get_list_of_custom_objects(object_names) }
-
       it { is_expected.to eq(response_stub) }
     end
   end
 
   describe '#describe_custom_object' do
+    subject(:action) { client.describe_custom_object(object_name) }
+
     let(:response_stub) do
       {
         requestId: 'eeef#152858b17d2',
@@ -129,8 +131,6 @@ describe Mrkt::CrudCustomObjects do
         .to_return(json_stub(response_stub))
     end
 
-    subject { client.describe_custom_object(object_name) }
-
     context 'when the object name is valid' do
       let(:object_name) { :device_c }
 
@@ -140,13 +140,15 @@ describe Mrkt::CrudCustomObjects do
     context 'when the object name is invalid' do
       let(:object_name) { nil }
 
-      it 'should raise an Error' do
-        expect { subject }.to raise_error(Mrkt::Errors::Unknown)
+      it 'raises an Error' do
+        expect { action }.to raise_error(Mrkt::Errors::Unknown)
       end
     end
   end
 
   describe '#createupdate_custom_objects' do
+    subject { client.createupdate_custom_objects(object_name, devices) }
+
     let(:object_name) { 'device' }
 
     let(:devices) do
@@ -178,8 +180,6 @@ describe Mrkt::CrudCustomObjects do
       }
     end
 
-    subject { client.createupdate_custom_objects(object_name, devices) }
-
     before do
       stub_request(:post, "https://#{host}/rest/v1/customobjects/#{object_name}.json")
         .with(json_stub(request_body))
@@ -190,6 +190,8 @@ describe Mrkt::CrudCustomObjects do
   end
 
   describe '#delete_custom_objects' do
+    subject { client.delete_custom_objects(object_name, search_fields) }
+
     let(:object_name) { 'device' }
 
     let(:search_fields) do
@@ -215,8 +217,6 @@ describe Mrkt::CrudCustomObjects do
       }
     end
 
-    subject { client.delete_custom_objects(object_name, search_fields) }
-
     before do
       stub_request(:post, "https://#{host}/rest/v1/customobjects/#{object_name}/delete.json")
         .with(json_stub(request_body))
@@ -227,6 +227,8 @@ describe Mrkt::CrudCustomObjects do
   end
 
   describe '#get_custom_objects' do
+    subject { client.get_custom_objects(object_name, filter_values) }
+
     let(:object_name) { 'device' }
 
     let(:filter_values) do
@@ -256,8 +258,6 @@ describe Mrkt::CrudCustomObjects do
       }
     end
 
-    subject { client.get_custom_objects(object_name, filter_values) }
-
     before do
       stub_request(:post, "https://#{host}/rest/v1/customobjects/#{object_name}.json?_method=GET")
         .with(json_stub(request_body))

data/spec/concerns/crud_leads_spec.rb

@@ -1,5 +1,5 @@
 describe Mrkt::CrudLeads do
-  include_context 'initialized client'
+  include_context 'with an initialized client'
 
   describe 'get_lead_by_id' do
     subject { client.get_lead_by_id(id, fields: fields) }
@@ -56,6 +56,8 @@ describe Mrkt::CrudLeads do
   end
 
   describe '#get_leads' do
+    subject { client.get_leads(filter_type, filter_values) }
+
     let(:filter_type) { 'email' }
     let(:filter_values) { %w[user@example.com] }
     let(:response_stub) do
@@ -74,7 +76,6 @@ describe Mrkt::CrudLeads do
         success: true
       }
     end
-    subject { client.get_leads(filter_type, filter_values) }
 
     before do
       stub_request(:get, "https://#{host}/rest/v1/leads.json")
@@ -86,6 +87,8 @@ describe Mrkt::CrudLeads do
   end
 
   describe '#createupdate_leads' do
+    subject { client.createupdate_leads(leads, lookup_field: :email) }
+
     let(:leads) do
       [
         firstName: 'John',
@@ -118,7 +121,6 @@ describe Mrkt::CrudLeads do
         ]
       }
     end
-    subject { client.createupdate_leads(leads, lookup_field: :email) }
 
     before do
       stub_request(:post, "https://#{host}/rest/v1/leads.json")
@@ -130,6 +132,8 @@ describe Mrkt::CrudLeads do
   end
 
   describe '#delete_leads' do
+    subject { client.delete_leads(leads) }
+
     let(:leads) { [1] }
     let(:request_body) do
       {
@@ -147,7 +151,6 @@ describe Mrkt::CrudLeads do
         success: true
       }
     end
-    subject { client.delete_leads(leads) }
 
     before do
       stub_request(:delete, "https://#{host}/rest/v1/leads.json")
@@ -159,12 +162,12 @@ describe Mrkt::CrudLeads do
   end
 
   describe '#associate_lead' do
+    subject(:action) { client.associate_lead(id, cookie) }
+
     let(:id) { 1 }
     let(:cookie) { 'id:561-HYG-937&token:_mch-marketo.com-1427205775289-40768' }
     let(:request_stub) { {} }
 
-    subject { client.associate_lead(id, cookie) }
-
     before do
       stub_request(:post, "https://#{host}/rest/v1/leads/#{id}/associate.json?#{URI.encode_www_form(cookie: cookie)}")
         .with(json_stub(request_stub))
@@ -197,19 +200,19 @@ describe Mrkt::CrudLeads do
         }
       end
 
-      it 'should raise an Error' do
-        expect { subject }.to raise_error(Mrkt::Errors::LeadNotFound)
+      it 'raises an Error' do
+        expect { action }.to raise_error(Mrkt::Errors::LeadNotFound)
       end
     end
   end
 
   describe '#merge_leads' do
+    subject(:action) { client.merge_leads(id, losing_lead_ids) }
+
     let(:id) { 1 }
     let(:losing_lead_ids) { [2, 3, 4] }
     let(:request_stub) { {} }
 
-    subject { client.merge_leads(id, losing_lead_ids) }
-
     before do
       params = ::Faraday::Utils::ParamsHash.new
       params[:mergeInCRM] = false
@@ -245,13 +248,15 @@ describe Mrkt::CrudLeads do
         }
       end
 
-      it 'should raise an Error' do
-        expect { subject }.to raise_error(Mrkt::Errors::LeadNotFound)
+      it 'raises an Error' do
+        expect { action }.to raise_error(Mrkt::Errors::LeadNotFound)
       end
     end
   end
 
   describe '#describe_lead' do
+    subject { client.describe_lead }
+
     let(:response_stub) do
       {
         requestId: '5c9e#169a68fa806',
@@ -289,8 +294,6 @@ describe Mrkt::CrudLeads do
       }
     end
 
-    subject { client.describe_lead }
-
     before do
       stub_request(:get, "https://#{host}/rest/v1/leads/describe.json")
         .to_return(json_stub(response_stub))

data/spec/concerns/crud_lists_spec.rb

@@ -1,7 +1,9 @@
 describe Mrkt::CrudLists do
-  include_context 'initialized client'
+  include_context 'with an initialized client'
 
   describe '#get_leads_by_list' do
+    subject { client.get_leads_by_list(list_id) }
+
     let(:list_id) { '1001' }
     let(:response_stub) do
       {
@@ -20,8 +22,6 @@ describe Mrkt::CrudLists do
       }
     end
 
-    subject { client.get_leads_by_list(list_id) }
-
     before do
       stub_request(:get, "https://#{host}/rest/v1/list/#{list_id}/leads.json")
         .with(query: {})
@@ -32,6 +32,8 @@ describe Mrkt::CrudLists do
   end
 
   describe '#add_leads_to_list' do
+    subject { client.add_leads_to_list(list_id, lead_ids) }
+
     let(:list_id) { '1001' }
     let(:lead_ids) { ['1'] }
     let(:request_body) do
@@ -53,7 +55,6 @@ describe Mrkt::CrudLists do
         success: true
       }
     end
-    subject { client.add_leads_to_list(list_id, lead_ids) }
 
     before do
       stub_request(:post, "https://#{host}/rest/v1/lists/#{list_id}/leads.json")
@@ -65,6 +66,8 @@ describe Mrkt::CrudLists do
   end
 
   describe '#remove_leads_from_list' do
+    subject { client.remove_leads_from_list(list_id, lead_ids) }
+
     let(:list_id) { '1001' }
     let(:lead_ids) { ['1'] }
     let(:request_body) do
@@ -86,7 +89,6 @@ describe Mrkt::CrudLists do
         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")

data/spec/concerns/crud_program_members_spec.rb

@@ -0,0 +1,141 @@
+describe Mrkt::CrudProgramMembers do
+  include_context 'with an initialized client'
+
+  describe '#describe_program_members' do
+    subject { client.describe_program_members }
+
+    let(:response_stub) do
+      {
+        requestId: 'c245#14cd6830ae2',
+        result: [
+          {
+            name: 'API Program Membership',
+            description: 'Map for API program membership fields',
+            dedupeFields: %w[
+              leadId
+              programId
+            ],
+            searchableFields: [
+              ['leadId'],
+              ['livestormregistrationurl']
+            ],
+            fields: [
+              {
+                name: 'acquiredBy',
+                displayName: 'acquiredBy',
+                dataType: 'boolean',
+                updateable: false,
+                crmManaged: false
+              },
+              {
+                name: 'attendanceLikelihood',
+                displayName: 'attendanceLikelihood',
+                dataType: 'integer',
+                updateable: false,
+                crmManaged: false
+              }
+            ]
+          }
+        ],
+        success: true
+      }
+    end
+
+    before do
+      stub_request(:get, "https://#{host}/rest/v1/programs/members/describe.json")
+        .to_return(json_stub(response_stub))
+    end
+
+    it { is_expected.to eq(response_stub) }
+  end
+
+  describe '#createupdate_program_members' do
+    subject { client.createupdate_program_members(program_id, lead_ids, status) }
+
+    let(:program_id) { 123 }
+    let(:lead_ids) { [1, 2, 3] }
+    let(:status) { 'Registered' }
+    let(:request_body) do
+      {
+        statusName: 'Registered',
+        input: [
+          { leadId: 1 },
+          { leadId: 2 },
+          { leadId: 3 }
+        ]
+      }
+    end
+    let(:response_stub) do
+      {
+          requestId: 'c00c#17d7bf40f15',
+          result: [
+            {
+                seq: 0,
+                status: 'created',
+                leadId: 1
+            },
+            {
+                seq: 1,
+                status: 'created',
+                leadId: 2
+            },
+            {
+                seq: 2,
+                status: 'created',
+                leadId: 3
+            }
+          ],
+          success: true
+      }
+    end
+
+    before do
+      stub_request(:post, "https://#{host}/rest/v1/programs/#{program_id}/members/status.json")
+        .with(json_stub(request_body))
+        .to_return(json_stub(response_stub))
+    end
+
+    it { is_expected.to eq(response_stub) }
+  end
+
+  describe '#get_program_members' do
+    subject { client.get_program_members(program_id, filter_type, filter_values) }
+
+    let(:filter_type) { 'leadId' }
+    let(:filter_values) { [1, 2] }
+    let(:program_id) { 1014 }
+    let(:response_stub) do
+      {
+        requestId: '4b6d#17d7c0530de',
+        result: [
+          {
+              seq: 0,
+              leadId: 1,
+              reachedSuccess: true,
+              programId: 1014,
+              acquiredBy: false,
+              membershipDate: '2021-12-02T16:22:12Z'
+          },
+          {
+              seq: 1,
+              leadId: 2,
+              reachedSuccess: true,
+              programId: 1014,
+              acquiredBy: false,
+              membershipDate: '2021-12-02T16:22:12Z'
+          }
+        ],
+        success: true,
+        moreResult: false
+    }
+    end
+
+    before do
+      stub_request(:get, "https://#{host}/rest/v1/programs/#{program_id}/members.json")
+        .with(query: { filterType: filter_type, filterValues: filter_values.join(',') })
+        .to_return(json_stub(response_stub))
+    end
+
+    it { is_expected.to eq(response_stub) }
+  end
+end

data/spec/concerns/crud_programs_spec.rb

@@ -1,7 +1,9 @@
 describe Mrkt::CrudPrograms do
-  include_context 'initialized client'
+  include_context 'with an initialized client'
 
   describe '#browse_programs' do
+    subject { client.browse_programs }
+
     let(:response_stub) do
       {
         success: true,
@@ -30,8 +32,6 @@ describe Mrkt::CrudPrograms do
       }
     end
 
-    subject { client.browse_programs }
-
     before do
       stub_request(:get, "https://#{host}/rest/asset/v1/programs.json")
         .to_return(json_stub(response_stub))
@@ -41,6 +41,8 @@ describe Mrkt::CrudPrograms do
   end
 
   describe '#get_program_by_id' do
+    subject { client.get_program_by_id(1107) }
+
     let(:response_stub) do
       {
         success: true,
@@ -76,8 +78,6 @@ describe Mrkt::CrudPrograms do
       }
     end
 
-    subject { client.get_program_by_id(1107) }
-
     before do
       stub_request(:get, "https://#{host}/rest/asset/v1/program/1107.json")
         .to_return(json_stub(response_stub))

data/spec/concerns/import_custom_objects_spec.rb

@@ -1,10 +1,12 @@
 require 'tempfile'
 
 describe Mrkt::ImportCustomObjects do
-  include_context 'initialized client'
+  include_context 'with an initialized client'
   let(:custom_object) { 'car_c' }
 
   describe '#import_custom_object' do
+    subject { client.import_custom_object(file, custom_object) }
+
     let(:file) { StringIO.new }
     let(:response_stub) do
       {
@@ -19,7 +21,6 @@ describe Mrkt::ImportCustomObjects do
         ]
       }
     end
-    subject { client.import_custom_object(file, custom_object) }
 
     before do
       stub_request(:post, "https://#{host}/bulk/v1/customobjects/#{custom_object}/import.json")
@@ -31,6 +32,8 @@ describe Mrkt::ImportCustomObjects do
   end
 
   describe '#import_custom_object_status' do
+    subject { client.import_custom_object_status(1, custom_object) }
+
     let(:id) { 1 }
     let(:response_stub) do
       {
@@ -51,7 +54,6 @@ describe Mrkt::ImportCustomObjects do
         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")
@@ -62,9 +64,10 @@ describe Mrkt::ImportCustomObjects do
   end
 
   describe '#import_custom_object_failures' do
+    subject { client.import_custom_object_failures(1, custom_object) }
+
     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")
@@ -75,9 +78,10 @@ describe Mrkt::ImportCustomObjects do
   end
 
   describe '#import_custom_object_warnings' do
+    subject { client.import_custom_object_warnings(1, custom_object) }
+
     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")

data/spec/concerns/import_leads_spec.rb

@@ -2,9 +2,11 @@ require 'csv'
 require 'tempfile'
 
 describe Mrkt::ImportLeads do
-  include_context 'initialized client'
+  include_context 'with an initialized client'
 
   describe '#import_lead' do
+    subject { client.import_lead(tempfile) }
+
     let(:tempfile) { Tempfile.new(%w[import-leads csv]) }
     let(:response_stub) do
       {
@@ -18,7 +20,6 @@ describe Mrkt::ImportLeads do
         ]
       }
     end
-    subject { client.import_lead(tempfile) }
 
     before do
       CSV.open(tempfile, 'wb') do |csv|
@@ -39,6 +40,8 @@ describe Mrkt::ImportLeads do
   end
 
   describe '#import_lead_status' do
+    subject { client.import_lead_status(1) }
+
     let(:id) { 1 }
     let(:response_stub) do
       {
@@ -56,7 +59,6 @@ describe Mrkt::ImportLeads do
         success: true
       }
     end
-    subject { client.import_lead_status(1) }
 
     before do
       stub_request(:get, "https://#{host}/bulk/v1/leads/batch/#{id}.json")
@@ -67,9 +69,10 @@ describe Mrkt::ImportLeads do
   end
 
   describe '#import_lead_failures' do
+    subject { client.import_lead_failures(1) }
+
     let(:id) { 1 }
     let(:response_stub) { '' }
-    subject { client.import_lead_failures(1) }
 
     before do
       stub_request(:get, "https://#{host}/bulk/v1/leads/batch/#{id}/failures.json")
@@ -80,9 +83,10 @@ describe Mrkt::ImportLeads do
   end
 
   describe '#import_lead_warnings' do
+    subject { client.import_lead_warnings(1) }
+
     let(:id) { 1 }
     let(:response_stub) { '' }
-    subject { client.import_lead_warnings(1) }
 
     before do
       stub_request(:get, "https://#{host}/bulk/v1/leads/batch/#{id}/warnings.json")

data/spec/errors_spec.rb

@@ -1,21 +1,19 @@
 describe Mrkt::Errors do
   describe '.find_by_response_code' do
-    subject { described_class.find_by_response_code(code) }
+    subject(:actual) { described_class.find_by_response_code(code) }
 
-    context 'when the code is' do
-      context 'known' do
-        let(:code) { 413 }
+    context 'when the code is known' do
+      let(:code) { 413 }
 
-        it 'should return the mapped error class' do
-          is_expected.to eq(Mrkt::Errors::RequestEntityTooLarge)
-        end
+      it 'returns the mapped error class' do
+        expect(actual).to eq(Mrkt::Errors::RequestEntityTooLarge)
       end
+    end
 
-      context 'unknown' do
-        let(:code) { 7331 }
+    context 'when the code is unknown' do
+      let(:code) { 7331 }
 
-        it { is_expected.to eq(Mrkt::Errors::Error) }
-      end
+      it { is_expected.to eq(Mrkt::Errors::Error) }
     end
   end
 end