mrkt 0.6.2 → 1.2.0

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',
@@ -148,4 +202,100 @@ describe Mrkt::CrudLeads do
       end
     end
   end
+
+  describe '#merge_leads' do
+    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
+      params[:leadIds] = losing_lead_ids.join(',') if losing_lead_ids
+
+      stub_request(:post, "https://#{host}/rest/v1/leads/#{id}/merge.json?#{params.to_query}")
+        .with(json_stub(request_stub))
+        .to_return(json_stub(response_stub))
+    end
+
+    context 'with existing leads' do
+      let(:response_stub) do
+        {
+          requestId: 'c245#14cd6830ae2',
+          success: true
+        }
+      end
+
+      it { is_expected.to eq(response_stub) }
+    end
+
+    context 'with a non-existing lead id' do
+      let(:response_stub) do
+        {
+          requestId: 'c245#14cd6830ae2',
+          success: false,
+          errors: [
+            {
+              code: '1004',
+              message: "Lead '1' not found"
+            }
+          ]
+        }
+      end
+
+      it 'should raise an Error' do
+        expect { subject }.to raise_error(Mrkt::Errors::LeadNotFound)
+      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

data/spec/concerns/import_leads_spec.rb

@@ -5,7 +5,7 @@ describe Mrkt::ImportLeads do
   include_context 'initialized client'
 
   describe '#import_lead' do
-    let(:tempfile) { Tempfile.new(['import-leads', 'csv']) }
+    let(:tempfile) { Tempfile.new(%w[import-leads csv]) }
     let(:response_stub) do
       {
         requestId: 'c245#14cd6830ae2',
@@ -22,8 +22,8 @@ describe Mrkt::ImportLeads do
 
     before do
       CSV.open(tempfile, 'wb') do |csv|
-        csv << %w(email firstName lastName)
-        csv << %w(sample@example.com John Snow)
+        csv << %w[email firstName lastName]
+        csv << %w[sample@example.com John Snow]
       end
 
       stub_request(:post, "https://#{host}/bulk/v1/leads.json")

data/spec/faraday/params_encoder_spec.rb

@@ -0,0 +1,24 @@
+describe Mrkt::Faraday::ParamsEncoder do
+  describe '.encode' do
+    let(:params) do
+      {
+        string: 'foobar',
+        number: 1,
+        boolean: true,
+        array: [1, 2, 3]
+      }
+    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) }
+
+    it { is_expected.to eq('foo' => 'foo', 'bar' => 'bar') }
+  end
+end

data/spec/spec_helper.rb

@@ -3,17 +3,14 @@ if ENV['COVERAGE']
   SimpleCov.start
 end
 
-if ENV['CODECLIMATE_REPO_TOKEN']
-  require 'codeclimate-test-reporter'
-  CodeClimate::TestReporter.start
-end
-
 require 'bundler/setup'
 Bundler.setup
 
 require 'mrkt'
 
-Dir[File.expand_path('spec/support/**/*.rb')].each { |f| require f }
+Dir[File.expand_path('spec/support/**/*.rb')].sort.each do |file|
+  require file
+end
 
 RSpec.configure do |config|
   config.default_formatter = :doc if config.files_to_run.one?

data/spec/support/initialized_client.rb

@@ -12,7 +12,7 @@ shared_context 'initialized client' do
   subject(:client) { Mrkt::Client.new(host: host, client_id: client_id, client_secret: client_secret) }
 
   before do
-    stub_request(:get, "https://#{host}/identity/oauth/token")
+    @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' })
       .to_return(json_stub(authentication_stub))
   end

data/spec/support/webmock.rb

@@ -1,16 +1,10 @@
 require 'webmock/rspec'
 
-RSpec.configure do |config|
+RSpec.configure do
   def json_stub(content_stub)
     {
       headers: { content_type: 'application/json' },
       body: JSON.generate(content_stub)
     }
   end
-
-  if ENV['CODECLIMATE_REPO_TOKEN']
-    config.after(:suite) do
-      WebMock.disable_net_connect!(allow: 'codeclimate.com')
-    end
-  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mrkt
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 1.2.0
 platform: ruby
 authors:
 - KARASZI István
@@ -9,140 +9,162 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-10 00:00:00.000000000 Z
+date: 2021-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: faraday_middleware
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: 0.9.0
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
-    - - "<"
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     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: rake
+  name: gem-release
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.7'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.21.0
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.21.0
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: '3.2'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 1.20.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 1.20.0
 - !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
+  name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.7
+        version: 0.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.7
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.32.1
+        version: 0.21.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.32.1
+        version: 0.21.2
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
 description: This gem helps you to use the Marketo REST API
 email:
 - github@spam.raszi.hu
@@ -151,38 +173,53 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - Gemfile
 - Gemfile.lock
+- LICENSE
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/mrkt.rb
 - lib/mrkt/concerns/authentication.rb
 - lib/mrkt/concerns/connection.rb
+- lib/mrkt/concerns/crud_activities.rb
+- lib/mrkt/concerns/crud_asset_folders.rb
+- lib/mrkt/concerns/crud_asset_static_lists.rb
 - lib/mrkt/concerns/crud_campaigns.rb
+- lib/mrkt/concerns/crud_custom_activities.rb
 - lib/mrkt/concerns/crud_custom_objects.rb
 - lib/mrkt/concerns/crud_helpers.rb
 - lib/mrkt/concerns/crud_leads.rb
 - lib/mrkt/concerns/crud_lists.rb
 - lib/mrkt/concerns/crud_programs.rb
+- lib/mrkt/concerns/import_custom_objects.rb
 - lib/mrkt/concerns/import_leads.rb
 - lib/mrkt/errors.rb
+- lib/mrkt/faraday.rb
+- lib/mrkt/faraday/params_encoder.rb
 - lib/mrkt/faraday_middleware.rb
 - lib/mrkt/faraday_middleware/response.rb
 - lib/mrkt/version.rb
 - mrkt.gemspec
 - spec/concerns/authentication_spec.rb
+- spec/concerns/crud_activities_spec.rb
+- spec/concerns/crud_asset_folders_spec.rb
+- spec/concerns/crud_asset_static_lists_spec.rb
 - spec/concerns/crud_campaigns_spec.rb
+- spec/concerns/crud_custom_activities_spec.rb
 - spec/concerns/crud_custom_objects_spec.rb
 - spec/concerns/crud_leads_spec.rb
 - spec/concerns/crud_lists_spec.rb
 - spec/concerns/crud_programs_spec.rb
+- spec/concerns/import_custom_objects_spec.rb
 - spec/concerns/import_leads_spec.rb
 - spec/errors_spec.rb
+- spec/faraday/params_encoder_spec.rb
 - spec/mkto_rest_spec.rb
 - spec/spec_helper.rb
 - spec/support/initialized_client.rb
@@ -197,29 +234,34 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Marketo REST API Facade
 test_files:
 - spec/concerns/authentication_spec.rb
+- spec/concerns/crud_activities_spec.rb
+- spec/concerns/crud_asset_folders_spec.rb
+- spec/concerns/crud_asset_static_lists_spec.rb
 - spec/concerns/crud_campaigns_spec.rb
+- spec/concerns/crud_custom_activities_spec.rb
 - spec/concerns/crud_custom_objects_spec.rb
 - spec/concerns/crud_leads_spec.rb
 - spec/concerns/crud_lists_spec.rb
 - spec/concerns/crud_programs_spec.rb
+- spec/concerns/import_custom_objects_spec.rb
 - spec/concerns/import_leads_spec.rb
 - spec/errors_spec.rb
+- spec/faraday/params_encoder_spec.rb
 - spec/mkto_rest_spec.rb
 - spec/spec_helper.rb
 - spec/support/initialized_client.rb

data/.travis.yml

@@ -1,8 +0,0 @@
-language: ruby
-rvm:
-  - 2.0.0
-  - 2.1.5
-  - 2.2.0
-  - 2.3.1
-addons:
-  code_climate: 45cd2174f49b570406e294ff393d456c4ae8532cf16dd6430abb06d8a0722a28