mrkt 1.0.1 → 1.2.1

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

data/spec/faraday/params_encoder_spec.rb

@@ -1,5 +1,7 @@
 describe Mrkt::Faraday::ParamsEncoder do
   describe '.encode' do
+    subject { described_class.encode(params) }
+
     let(:params) do
       {
         string: 'foobar',
@@ -9,16 +11,14 @@ describe Mrkt::Faraday::ParamsEncoder do
       }
     end
 
-    subject { described_class.encode(params) }
-
     it { is_expected.to eq(Faraday::Utils::ParamsHash.new.merge(params.merge(array: '1,2,3')).to_query) }
   end
 
   describe '.decode' do
-    let(:value) { 'foo=foo&bar=bar' }
-
     subject { described_class.decode(value) }
 
+    let(:value) { 'foo=foo&bar=bar' }
+
     it { is_expected.to eq('foo' => 'foo', 'bar' => 'bar') }
   end
 end

data/spec/mkto_rest_spec.rb

@@ -1,5 +1,5 @@
 describe Mrkt do
-  include_context 'initialized client'
+  include_context 'with an initialized client'
 
   it { is_expected.to respond_to(:get, :post, :delete) }
 end

data/spec/support/initialized_client.rb

@@ -1,7 +1,9 @@
 require 'securerandom'
 require 'json'
 
-shared_context 'initialized client' do
+shared_context 'with an initialized client' do
+  subject(:client) { Mrkt::Client.new(host: host, client_id: client_id, client_secret: client_secret) }
+
   let(:host) { '0-KBZ-0.mktorest.com' }
   let(:client_id) { SecureRandom.uuid }
   let(:client_secret) { SecureRandom.hex }
@@ -9,8 +11,6 @@ shared_context 'initialized client' do
     { access_token: SecureRandom.uuid, token_type: 'bearer', expires_in: 2241, scope: 'RestClient' }
   end
 
-  subject(:client) { Mrkt::Client.new(host: host, client_id: client_id, client_secret: client_secret) }
-
   before do
     @authentication_request_stub = stub_request(:get, "https://#{host}/identity/oauth/token")
       .with(query: { client_id: client_id, client_secret: client_secret, grant_type: 'client_credentials' })

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mrkt
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.1
 platform: ruby
 authors:
 - KARASZI István
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-08 00:00:00.000000000 Z
+date: 2021-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -45,14 +45,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: gem-release
   requirement: !ruby/object:Gem::Requirement
@@ -87,14 +87,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -115,28 +115,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.87.1
+        version: 1.23.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.87.1
+        version: 1.23.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.1
+        version: 0.21.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.1
+        version: 0.21.2
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -159,10 +187,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -181,6 +210,7 @@ files:
 - lib/mrkt/concerns/crud_helpers.rb
 - lib/mrkt/concerns/crud_leads.rb
 - lib/mrkt/concerns/crud_lists.rb
+- lib/mrkt/concerns/crud_program_members.rb
 - lib/mrkt/concerns/crud_programs.rb
 - lib/mrkt/concerns/import_custom_objects.rb
 - lib/mrkt/concerns/import_leads.rb
@@ -200,6 +230,7 @@ files:
 - spec/concerns/crud_custom_objects_spec.rb
 - spec/concerns/crud_leads_spec.rb
 - spec/concerns/crud_lists_spec.rb
+- spec/concerns/crud_program_members_spec.rb
 - spec/concerns/crud_programs_spec.rb
 - spec/concerns/import_custom_objects_spec.rb
 - spec/concerns/import_leads_spec.rb
@@ -212,14 +243,15 @@ files:
 homepage: https://github.com/raszi/mrkt
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
       version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
@@ -228,7 +260,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Marketo REST API Facade
@@ -242,6 +274,7 @@ test_files:
 - spec/concerns/crud_custom_objects_spec.rb
 - spec/concerns/crud_leads_spec.rb
 - spec/concerns/crud_lists_spec.rb
+- spec/concerns/crud_program_members_spec.rb
 - spec/concerns/crud_programs_spec.rb
 - spec/concerns/import_custom_objects_spec.rb
 - spec/concerns/import_leads_spec.rb

data/.travis.yml

@@ -1,21 +0,0 @@
-env:
-  global:
-    - CC_TEST_REPORTER_ID=45cd2174f49b570406e294ff393d456c4ae8532cf16dd6430abb06d8a0722a28
-    - COVERAGE=on
-language: ruby
-rvm:
-  - 2.5
-  - 2.6
-  - 2.7
-before_install:
-  - gem update --system
-  - bundle update --bundler
-before_script:
-  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-  - chmod +x ./cc-test-reporter
-  - ./cc-test-reporter before-build
-script:
-  - bundle exec rspec
-  - bundle exec rubocop
-after_script:
-  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT