mrkt 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41d861185c2759674a5688a61bd06294e6ca18460bd1ff868df05bc3932018d5
-  data.tar.gz: e52dac6cb6ebbba08e079634c7ca72545c358e23305feffb254e243b3b741786
+  metadata.gz: 850ac5a692b131df87d8bc0a86d0bbd0c82fb38b382a41cc201e427caaba18f6
+  data.tar.gz: 4eb5399bad28b69658a2a7699d87e691a6d18c273061985aa4b558001e79d37a
 SHA512:
-  metadata.gz: 5de0d92b43516840e7e71a83253414e157e5812ba00b6bb4bdada5b665c80a06cc24e6a89aec6e01b19515e72032cc6428075adf17acf56d12b48d7caee38545
-  data.tar.gz: 010fbf3fb5baa8f5a904c1858c938f6fd4d3f344c324b782aa1080a08343b6c7a8fd5f7f1a8c93a4c666cb361a7a2d2c9fd773a18f3bfe2ad6f39e7ce7f056c5
+  metadata.gz: 6cc5334a1161bf7fe032e5b5919e9a7b0721124965a1a2e2b6cefed6d9305550eedd0a8370f401d85d884a6b08f5fcb1c3eadb60d4ba3bba05be457f09c4e8cc
+  data.tar.gz: b325752b6d9cec194cc9cab4cea09744a63d9a48ebe80c774aca9d3233b8e6c07f60d644fe41d49fb0059ebf9bd625cdf2a191353c390d970ddb1e0311412533

data/.github/dependabot.yml

@@ -4,8 +4,16 @@ updates:
     directory: "/"
     schedule:
       interval: "weekly"
+    commit-message:
+      prefix: "chore"
+      include: "scope"
+    rebase-strategy: "disabled"
 
   - package-ecosystem: "github-actions"
     directory: "/"
     schedule:
       interval: "daily"
+    commit-message:
+      prefix: "chore"
+      include: "scope"
+    rebase-strategy: "disabled"

data/.github/workflows/ruby.yml

@@ -15,7 +15,7 @@ jobs:
         ruby: [2.5, 2.6, 2.7, 3.0]
 
     steps:
-      - uses: actions/checkout@v2.3.4
+      - uses: actions/checkout@v2.4.0
 
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
@@ -33,7 +33,7 @@ jobs:
         run: bundle install
 
       - name: Run tests and publish coverage
-        uses: paambaati/codeclimate-action@v2.7.5
+        uses: paambaati/codeclimate-action@v3.0.0
         env:
           COVERAGE: on
           CC_TEST_REPORTER_ID: 45cd2174f49b570406e294ff393d456c4ae8532cf16dd6430abb06d8a0722a28

data/.rubocop.yml

@@ -1,4 +1,6 @@
-require: rubocop-rake
+require:
+  - rubocop-rake
+  - rubocop-rspec
 
 AllCops:
   TargetRubyVersion: 2.5
@@ -24,6 +26,7 @@ Metrics/AbcSize:
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/*'
+    - '**/*.gemspec'
 Metrics/MethodLength:
   Max: 20
 Metrics/ParameterLists:
@@ -32,6 +35,16 @@ Metrics/ParameterLists:
 Naming/AccessorMethodName:
   Enabled: false
 
+RSpec/FilePath:
+  Enabled: false
+RSpec/NestedGroups:
+  Enabled: false
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+RSpec/MultipleExpectations:
+  Exclude:
+    - 'spec/concerns/authentication_spec.rb'
+
 Style/ClassAndModuleChildren:
   Enabled: false
 Style/Documentation:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mrkt (1.2.0)
+    mrkt (1.2.1)
       faraday (~> 1.0)
       faraday_middleware (~> 1.0)
 
@@ -16,8 +16,8 @@ GEM
     crack (0.4.5)
       rexml
     diff-lcs (1.4.4)
-    docile (1.3.5)
-    faraday (1.7.1)
+    docile (1.4.0)
+    faraday (1.8.0)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
       faraday-excon (~> 1.1)
@@ -36,14 +36,14 @@ GEM
     faraday-net_http_persistent (1.2.0)
     faraday-patron (1.0.0)
     faraday-rack (1.0.0)
-    faraday_middleware (1.1.0)
+    faraday_middleware (1.2.0)
       faraday (~> 1.0)
     gem-release (2.2.2)
     hashdiff (1.0.1)
     method_source (1.0.0)
     multipart-post (2.1.1)
-    parallel (1.20.1)
-    parser (3.0.2.0)
+    parallel (1.21.0)
+    parser (3.0.3.2)
       ast (~> 2.4.1)
     pry (0.13.1)
       coderay (~> 1.1)
@@ -54,7 +54,7 @@ GEM
     public_suffix (4.0.6)
     rainbow (3.0.0)
     rake (13.0.6)
-    regexp_parser (2.1.1)
+    regexp_parser (2.2.0)
     rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
@@ -68,20 +68,22 @@ GEM
     rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    rubocop (1.20.0)
+    rspec-support (3.10.3)
+    rubocop (1.23.0)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.9.1, < 2.0)
+      rubocop-ast (>= 1.12.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.11.0)
+    rubocop-ast (1.15.0)
       parser (>= 3.0.1.1)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
+    rubocop-rspec (2.6.0)
+      rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
     simplecov (0.21.2)
@@ -90,7 +92,7 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.3)
-    unicode-display_width (2.0.0)
+    unicode-display_width (2.1.0)
     webmock (3.14.0)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
@@ -106,8 +108,9 @@ DEPENDENCIES
   pry-byebug (~> 3.7)
   rake (~> 13.0)
   rspec (~> 3.2)
-  rubocop (~> 1.20.0)
+  rubocop (~> 1.23.0)
   rubocop-rake (~> 0.6.0)
+  rubocop-rspec (~> 2.6)
   simplecov (~> 0.21.2)
   webmock (~> 3.1)
 

data/lib/mrkt/concerns/crud_program_members.rb

@@ -0,0 +1,31 @@
+module Mrkt
+  module CrudProgramMembers
+    def describe_program_members
+      get('/rest/v1/programs/members/describe.json')
+    end
+
+    def createupdate_program_members(program_id, lead_ids, status)
+      post_json("/rest/v1/programs/#{program_id}/members/status.json") do
+        {
+          statusName: status,
+          input: lead_ids.map { |lead_id| { leadId: lead_id } }
+        }
+      end
+    end
+
+    def get_program_members(program_id, filter_type, filter_values, fields: nil, batch_size: nil, next_page_token: nil)
+      params = {
+        filterType: filter_type,
+        filterValues: filter_values
+      }
+
+      optional = {
+        fields: fields,
+        batchSize: batch_size,
+        nextPageToken: next_page_token
+      }
+
+      get("/rest/v1/programs/#{program_id}/members.json", params, optional)
+    end
+  end
+end

data/lib/mrkt/version.rb

@@ -1,3 +1,3 @@
 module Mrkt
-  VERSION = '1.2.0'.freeze
+  VERSION = '1.2.1'.freeze
 end

data/lib/mrkt.rb

@@ -13,6 +13,7 @@ require 'mrkt/concerns/import_custom_objects'
 require 'mrkt/concerns/crud_custom_objects'
 require 'mrkt/concerns/crud_custom_activities'
 require 'mrkt/concerns/crud_programs'
+require 'mrkt/concerns/crud_program_members'
 require 'mrkt/concerns/crud_asset_static_lists'
 require 'mrkt/concerns/crud_asset_folders'
 
@@ -30,6 +31,7 @@ module Mrkt
     include CrudCustomObjects
     include CrudCustomActivities
     include CrudPrograms
+    include CrudProgramMembers
     include CrudAssetStaticLists
     include CrudAssetFolders
 

data/mrkt.gemspec

@@ -17,6 +17,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = %w[lib]
 
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
   spec.required_ruby_version = '>= 2.5'
 
   spec.add_dependency 'faraday', '~> 1.0'
@@ -27,8 +29,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pry-byebug', '~> 3.7'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.2'
-  spec.add_development_dependency 'rubocop', '~> 1.20.0'
+  spec.add_development_dependency 'rubocop', '~> 1.23.0'
   spec.add_development_dependency 'rubocop-rake', '~> 0.6.0'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.6'
   spec.add_development_dependency 'simplecov', '~> 0.21.2'
   spec.add_development_dependency 'webmock', '~> 3.1'
 end

data/spec/concerns/authentication_spec.rb

@@ -1,10 +1,10 @@
 describe Mrkt::Authentication do
-  include_context 'initialized client'
+  include_context 'with an initialized client'
 
   describe '#authenticate' do
-    subject { client.authenticate }
+    subject(:action) { client.authenticate }
 
-    context 'on a successful response' do
+    context 'with on a successful response' do
       it { is_expected.to be_success }
     end
 
@@ -16,21 +16,28 @@ describe Mrkt::Authentication do
         }
       end
 
-      it 'should raise an Error' do
-        expect { subject }.to raise_error(Mrkt::Errors::Error, 'Bad client credentials')
+      it 'raises an Error' do
+        expect { action }.to raise_error(Mrkt::Errors::Error, 'Bad client credentials')
       end
     end
   end
 
   describe '#authenticate!' do
-    it 'should authenticate and then be authenticated?' do
-      expect(client.authenticated?).to_not be true
+    it 'authenticates the client' do
+      expect(client.authenticated?).not_to be true
+
       client.authenticate!
       expect(client.authenticated?).to be true
     end
 
     context 'with optional partner_id client option' do
-      before { remove_request_stub(@authentication_request_stub) }
+      subject(:client) { Mrkt::Client.new(client_options) }
+
+      before do
+        stub_request(:get, "https://#{host}/identity/oauth/token")
+          .with(query: query)
+          .to_return(json_stub(authentication_stub))
+      end
 
       let(:partner_id) { SecureRandom.uuid }
 
@@ -52,23 +59,22 @@ describe Mrkt::Authentication do
         }
       end
 
-      subject(:client) { Mrkt::Client.new(client_options) }
-
-      before do
-        stub_request(:get, "https://#{host}/identity/oauth/token")
-          .with(query: query)
-          .to_return(json_stub(authentication_stub))
-      end
-
-      it 'should authenticate and then be authenticated?' do
-        expect(client.authenticated?).to_not be true
+      it 'authenticates the client' do
+        expect(client.authenticated?).not_to be true
         client.authenticate!
         expect(client.authenticated?).to be true
       end
     end
 
     context 'when the token has expired and @retry_authentication = true' do
-      before { remove_request_stub(@authentication_request_stub) }
+      subject(:client) { Mrkt::Client.new(client_options) }
+
+      before do
+        stub_request(:get, "https://#{host}/identity/oauth/token")
+          .with(query: { client_id: client_id, client_secret: client_secret, grant_type: 'client_credentials' })
+          .to_return(json_stub(expired_authentication_stub)).times(3).then
+          .to_return(json_stub(valid_authentication_stub))
+      end
 
       let(:retry_count) { 3 }
 
@@ -90,17 +96,8 @@ describe Mrkt::Authentication do
         }
       end
 
-      subject(:client) { Mrkt::Client.new(client_options) }
-
-      before do
-        stub_request(:get, "https://#{host}/identity/oauth/token")
-          .with(query: { client_id: client_id, client_secret: client_secret, grant_type: 'client_credentials' })
-          .to_return(json_stub(expired_authentication_stub)).times(3).then
-          .to_return(json_stub(valid_authentication_stub))
-      end
-
-      it 'should retry until getting valid token and then be authenticated?' do
-        expect(client.authenticated?).to_not be true
+      it 'retries until it gets a valid token' do
+        expect(client.authenticated?).not_to be true
         client.authenticate!
         expect(client.authenticated?).to be true
       end
@@ -108,8 +105,8 @@ describe Mrkt::Authentication do
       context 'when retry_authentication_count is low' do
         let(:retry_count) { 2 }
 
-        it 'should stop retrying after @retry_authentication_count tries and then raise an error' do
-          expect(client.authenticated?).to_not be true
+        it 'stops retrying after a while' do
+          expect(client.authenticated?).not_to be true
 
           expect { client.authenticate! }.to raise_error(Mrkt::Errors::Error, 'Client not authenticated')
         end
@@ -120,11 +117,11 @@ describe Mrkt::Authentication do
   describe '#authenticated?' do
     subject { client.authenticated? }
 
-    context 'before authentication' do
+    context 'when authentication has not been done' do
       it { is_expected.to be_falsey }
     end
 
-    context 'after authentication' do
+    context 'when authentication has been done' do
       before { client.authenticate }
 
       it { is_expected.to be_truthy }

data/spec/concerns/crud_activities_spec.rb

@@ -1,7 +1,9 @@
 describe Mrkt::CrudActivities do
-  include_context 'initialized client'
+  include_context 'with an initialized client'
 
   describe '#get_activity_types' do
+    subject { client.get_activity_types }
+
     let(:response_stub) do
       {
         requestId: 'c245#14cd6830ae2',
@@ -29,7 +31,6 @@ describe Mrkt::CrudActivities do
         success: true
       }
     end
-    subject { client.get_activity_types }
 
     before do
       stub_request(:get, "https://#{host}/rest/v1/activities/types.json")
@@ -40,6 +41,8 @@ describe Mrkt::CrudActivities do
   end
 
   describe '#get_paging_token' do
+    subject { client.get_paging_token(since_datetime) }
+
     let(:since_datetime) { Time.utc(2017, 1, 1, 4, 30) }
     let(:response_stub) do
       {
@@ -48,7 +51,6 @@ describe Mrkt::CrudActivities do
         nextPageToken: '4GAX7YNCIJKO2VAED5LH5PQIYPUM7WCVKTQWEDMP2L24AXZT54LA===='
       }
     end
-    subject { client.get_paging_token(since_datetime) }
 
     before do
       stub_request(:get, "https://#{host}/rest/v1/activities/pagingtoken.json")
@@ -60,6 +62,8 @@ describe Mrkt::CrudActivities do
   end
 
   describe '#get_activities' do
+    subject { client.get_activities(token) }
+
     let(:activity_type_ids) { [1, 2] }
     let(:lead_ids) { [100, 102] }
     let(:token) { '4GAX7YNCIJKO2VAED5LH5PQIYPUM7WCVKTQWEDMP2L24AXZT54LA====' }
@@ -106,7 +110,6 @@ describe Mrkt::CrudActivities do
         moreResult: false
       }
     end
-    subject { client.get_activities(token) }
 
     before do
       stub_request(:get, "https://#{host}/rest/v1/activities.json")
@@ -116,7 +119,9 @@ describe Mrkt::CrudActivities do
 
     it { is_expected.to eq(response_stub) }
 
-    context 'specifying activity type ids' do
+    context 'when specifying activity type ids' do
+      subject { client.get_activities(token, activity_type_ids: activity_type_ids) }
+
       let(:response_stub) do
         {
           data: {
@@ -147,7 +152,6 @@ describe Mrkt::CrudActivities do
           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")
@@ -161,7 +165,9 @@ describe Mrkt::CrudActivities do
       it { is_expected.to eq(response_stub) }
     end
 
-    context 'specifying lead ids' do
+    context 'when specifying lead ids' do
+      subject { client.get_activities(token, lead_ids: lead_ids) }
+
       let(:response_stub) do
         {
           data: {
@@ -192,7 +198,6 @@ describe Mrkt::CrudActivities do
           moreResult: false
         }
       end
-      subject { client.get_activities(token, lead_ids: lead_ids) }
 
       before do
         stub_request(:get, "https://#{host}/rest/v1/activities.json")
@@ -203,13 +208,14 @@ describe Mrkt::CrudActivities do
       it { is_expected.to eq(response_stub) }
     end
 
-    context 'specifying arrays values as empty strings' do
-      let(:activity_type_ids) { '' }
-      let(:lead_ids) { '' }
+    context 'when specifying arrays values as empty strings' do
       subject do
         client.get_activities(token, activity_type_ids: activity_type_ids, lead_ids: lead_ids)
       end
 
+      let(:activity_type_ids) { '' }
+      let(:lead_ids) { '' }
+
       before do
         stub_request(:get, "https://#{host}/rest/v1/activities.json")
           .with(query: { nextPageToken: token })
@@ -219,7 +225,7 @@ describe Mrkt::CrudActivities do
       it { is_expected.to eq(response_stub) }
     end
 
-    context 'specifying all options' do
+    context 'when specifying all options' do
       subject do
         client.get_activities(token, activity_type_ids: activity_type_ids, lead_ids: lead_ids)
       end
@@ -239,6 +245,8 @@ describe Mrkt::CrudActivities do
   end
 
   describe '#get_deleted_leads' do
+    subject { client.get_deleted_leads(token) }
+
     let(:token) { '4GAX7YNCIJKO2VAED5LH5PQIYPUM7WCVKTQWEDMP2L24AXZT54LA====' }
     let(:response_stub) do
       {
@@ -266,7 +274,6 @@ describe Mrkt::CrudActivities do
         moreResult: false
       }
     end
-    subject { client.get_deleted_leads(token) }
 
     before do
       stub_request(:get, "https://#{host}/rest/v1/activities/deletedleads.json")

data/spec/concerns/crud_asset_folders_spec.rb

@@ -1,5 +1,5 @@
 describe Mrkt::CrudAssetFolders do
-  include_context 'initialized client'
+  include_context 'with an initialized client'
 
   let(:response_folder_result) do
     {
@@ -65,7 +65,7 @@ describe Mrkt::CrudAssetFolders do
   end
 
   describe '#get_folder_by_id' do
-    subject { client.get_folder_by_id(id, type: type) }
+    subject(:action) { client.get_folder_by_id(id, type: type) }
 
     let(:id) { 77 }
 
@@ -123,14 +123,14 @@ describe Mrkt::CrudAssetFolders do
         }
       end
 
-      it 'should raise an Error' do
-        expect { subject }.to raise_error(Mrkt::Errors::TypeMismatch)
+      it 'raises an Error' do
+        expect { action }.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) }
+    subject(:action) { client.get_folder_by_name(name, type: type, root: root, work_space: work_space) }
 
     let(:name) { 'Test Folder Name' }
     let(:type) { 'Folder' }
@@ -196,8 +196,8 @@ describe Mrkt::CrudAssetFolders do
         }
       end
 
-      it 'should raise an Error' do
-        expect { subject }.to raise_error(Mrkt::Errors::System)
+      it 'raises an Error' do
+        expect { action }.to raise_error(Mrkt::Errors::System)
       end
     end
 
@@ -216,14 +216,14 @@ describe Mrkt::CrudAssetFolders do
         }
       end
 
-      it 'should raise an Error' do
-        expect { subject }.to raise_error(Mrkt::Errors::UnspecifiedAction)
+      it 'raises an Error' do
+        expect { action }.to raise_error(Mrkt::Errors::UnspecifiedAction)
       end
     end
   end
 
   describe '#delete_folder' do
-    subject { client.delete_folder(id) }
+    subject(:action) { client.delete_folder(id) }
 
     let(:id) { 75 }
 
@@ -265,8 +265,8 @@ describe Mrkt::CrudAssetFolders do
         }
       end
 
-      it 'should raise an Error' do
-        expect { subject }.to raise_error(Mrkt::Errors::RecordNotFound)
+      it 'raises an Error' do
+        expect { action }.to raise_error(Mrkt::Errors::RecordNotFound)
       end
     end
   end

data/spec/concerns/crud_asset_static_lists_spec.rb

@@ -1,5 +1,5 @@
 describe Mrkt::CrudAssetStaticLists do
-  include_context 'initialized client'
+  include_context 'with an initialized client'
 
   let(:response_static_list_result) do
     {
@@ -55,7 +55,7 @@ describe Mrkt::CrudAssetStaticLists do
   end
 
   describe '#get_static_list_by_id' do
-    subject { client.get_static_list_by_id(id) }
+    subject(:action) { client.get_static_list_by_id(id) }
 
     let(:id) { response_static_list_result[:id] }
     let(:response_stub) do
@@ -106,8 +106,8 @@ describe Mrkt::CrudAssetStaticLists do
         }
       end
 
-      it 'should raise an Error' do
-        expect { subject }.to raise_error(Mrkt::Errors::RecordNotFound)
+      it 'raises an Error' do
+        expect { action }.to raise_error(Mrkt::Errors::RecordNotFound)
       end
     end
   end

data/spec/concerns/crud_campaigns_spec.rb

@@ -1,7 +1,9 @@
 describe Mrkt::CrudCampaigns do
-  include_context 'initialized client'
+  include_context 'with an initialized client'
 
   describe '#request_campaign' do
+    subject(:action) { client.request_campaign(id, lead_ids, tokens) }
+
     let(:id) { 42 }
     let(:lead_ids) { [1234, 5678] }
     let(:tokens) do
@@ -13,7 +15,6 @@ describe Mrkt::CrudCampaigns do
          value: 'Value for other token'
        }]
     end
-    subject { client.request_campaign(id, lead_ids, tokens) }
 
     before do
       stub_request(:post, "https://#{host}/rest/v1/campaigns/#{id}/trigger.json")
@@ -25,16 +26,16 @@ describe Mrkt::CrudCampaigns do
       let(:response_stub) do
         {
           requestId: 'a9b#14eb6771358',
-          success:   false,
-          errors:    [{
-                        code:    '1013',
-                        message: 'Campaign not found'
-                      }]
+          success: false,
+          errors: [{
+            code:    '1013',
+            message: 'Campaign not found'
+          }]
         }
       end
 
-      it 'should raise an Error' do
-        expect { subject }.to raise_error(Mrkt::Errors::ObjectNotFound)
+      it 'raises an Error' do
+        expect { action }.to raise_error(Mrkt::Errors::ObjectNotFound)
       end
     end
 
@@ -43,20 +44,20 @@ describe Mrkt::CrudCampaigns do
         let(:response_stub) do
           {
             requestId: '7cdc#14eb6ae8a86',
-            success:   false,
-            errors:    [{
-                          code:    '1004',
-                          message: 'Lead [1234] not found'
-                        }]
+            success: false,
+            errors: [{
+              code:    '1004',
+              message: 'Lead [1234] not found'
+            }]
           }
         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
 
-      context 'for valid lead ids' do
+      context 'with valid lead ids' do
         let(:response_stub) do
           {
             requestId: 'e42b#14272d07d78',