mrkt 0.9.0 → 0.10.0

data/lib/mrkt/concerns/crud_custom_activities.rb

@@ -19,8 +19,9 @@ module Mrkt
         primaryAttributeValue: primary_attribute_value,
         attributes: converted_attributes
       }]
-      post('/rest/v1/activities/external.json') do |req|
-        json_payload(req, input: input)
+
+      post_json('/rest/v1/activities/external.json') do
+        { input: input }
       end
     end
 

data/lib/mrkt/concerns/crud_custom_objects.rb

@@ -8,45 +8,44 @@ module Mrkt
     end
 
     def describe_custom_object(name)
-      fail Mrkt::Errors::Unknown unless name
+      raise Mrkt::Errors::Unknown unless name
 
       get("/rest/v1/customobjects/#{name}/describe.json")
     end
 
     def createupdate_custom_objects(name, input, action: 'createOrUpdate', dedupe_by: 'dedupeFields')
-      post("/rest/v1/customobjects/#{name}.json") do |req|
-        params = {
+      post_json("/rest/v1/customobjects/#{name}.json") do
+        {
           input: input,
           action: action,
           dedupeBy: dedupe_by
         }
-        json_payload(req, params)
       end
     end
 
     def delete_custom_objects(name, input, delete_by: 'dedupeFields')
-      post("/rest/v1/customobjects/#{name}/delete.json") do |req|
-        params = {
+      post_json("/rest/v1/customobjects/#{name}/delete.json") do
+        {
           input: input,
           deleteBy: delete_by
         }
-
-        json_payload(req, params)
       end
     end
 
     def get_custom_objects(name, input, filter_type: 'dedupeFields', fields: nil, next_page_token: nil, batch_size: nil)
-      post("/rest/v1/customobjects/#{name}.json?_method=GET") do |req|
+      post_json("/rest/v1/customobjects/#{name}.json?_method=GET") do
         params = {
           input: input,
           filterType: filter_type
         }
 
-        params[:fields] = fields if fields
-        params[:nextPageToken] = next_page_token if next_page_token
-        params[:batchSize] = batch_size if batch_size
+        optional = {
+          fields: fields,
+          nextPageToken: next_page_token,
+          batchSize: batch_size
+        }
 
-        json_payload(req, params)
+        merge_params(params, optional)
       end
     end
   end

data/lib/mrkt/concerns/crud_helpers.rb

@@ -4,6 +4,13 @@ module Mrkt
       lead_ids.map { |id| { id: id } }
     end
 
+    def post_json(url)
+      post(url) do |req|
+        payload = block_given? ? yield(req) : {}
+        json_payload(req, payload)
+      end
+    end
+
     def json_payload(req, payload)
       req.headers[:content_type] = 'application/json'
       req.body = JSON.generate(payload)

data/lib/mrkt/concerns/crud_leads.rb

@@ -1,28 +1,42 @@
 module Mrkt
   module CrudLeads
+    def get_lead_by_id(id, fields: nil)
+      optional = {
+        fields: fields&.join(',')
+      }
+
+      get("/rest/v1/lead/#{id}.json", {}, optional)
+    end
+
     def get_leads(filter_type, filter_values, fields: nil, batch_size: nil, next_page_token: nil)
       params = {
         filterType: filter_type,
         filterValues: filter_values.join(',')
       }
-      params[:fields] = fields if fields
-      params[:batchSize] = batch_size if batch_size
-      params[:nextPageToken] = next_page_token if next_page_token
 
-      get('/rest/v1/leads.json', params)
+      optional = {
+        fields: fields,
+        batchSize: batch_size,
+        nextPageToken: next_page_token
+      }
+
+      get('/rest/v1/leads.json', params, optional)
     end
 
     def createupdate_leads(leads, action: 'createOrUpdate', lookup_field: nil, partition_name: nil, async_processing: nil)
-      post('/rest/v1/leads.json') do |req|
+      post_json('/rest/v1/leads.json') do
         params = {
           action: action,
           input: leads
         }
-        params[:lookupField] = lookup_field if lookup_field
-        params[:partitionName] = partition_name if partition_name
-        params[:asyncProcessing] = async_processing if async_processing
 
-        json_payload(req, params)
+        optional = {
+          lookupField: lookup_field,
+          partitionName: partition_name,
+          asyncProcessing: async_processing
+        }
+
+        merge_params(params, optional)
       end
     end
 
@@ -36,9 +50,7 @@ module Mrkt
       params = Faraday::Utils::ParamsHash.new
       params[:cookie] = cookie
 
-      post("/rest/v1/leads/#{id}/associate.json?#{params.to_query}") do |req|
-        json_payload(req, {})
-      end
+      post_json("/rest/v1/leads/#{id}/associate.json?#{params.to_query}")
     end
 
     def merge_leads(winning_lead_id, losing_lead_ids, merge_in_crm: false)
@@ -46,10 +58,11 @@ module Mrkt
       params[:mergeInCRM] = merge_in_crm
       params[:leadIds] = losing_lead_ids.join(',') if losing_lead_ids
 
-      post("/rest/v1/leads/#{winning_lead_id}/merge.json?#{params.to_query}") do |req|
-        json_payload(req,{})
-      end
+      post_json("/rest/v1/leads/#{winning_lead_id}/merge.json?#{params.to_query}")
     end
 
+    def describe_lead
+      get('/rest/v1/leads/describe.json')
+    end
   end
 end

data/lib/mrkt/concerns/crud_lists.rb

@@ -1,21 +1,24 @@
 module Mrkt
   module CrudLists
     def get_leads_by_list(list_id, fields: nil, batch_size: nil, next_page_token: nil)
-      params = {}
-      params[:fields] = fields if fields
-      params[:batchSize] = batch_size if batch_size
-      params[:nextPageToken] = next_page_token if next_page_token
+      optional = {
+        fields: fields,
+        batchSize: batch_size,
+        nextPageToken: next_page_token
+      }
 
-      get("/rest/v1/list/#{list_id}/leads.json", params)
+      get("/rest/v1/list/#{list_id}/leads.json", {}, optional)
     end
 
     def add_leads_to_list(list_id, lead_ids)
-      post("/rest/v1/lists/#{list_id}/leads.json") do |req|
-        params = {
-          input: map_lead_ids(lead_ids)
-        }
+      post_json("/rest/v1/lists/#{list_id}/leads.json") do
+        { input: map_lead_ids(lead_ids) }
+      end
+    end
 
-        json_payload(req, params)
+    def remove_leads_from_list(list_id, lead_ids)
+      delete("/rest/v1/lists/#{list_id}/leads.json") do |req|
+        json_payload(req, input: map_lead_ids(lead_ids))
       end
     end
   end

data/lib/mrkt/concerns/crud_programs.rb

@@ -1,12 +1,13 @@
 module Mrkt
   module CrudPrograms
     def browse_programs(offset: nil, max_return: nil, status: nil)
-      params = {}
-      params[:offset] = offset if offset
-      params[:maxReturn] = max_return if max_return
-      params[:status] = status if status
+      optional = {
+        offset: offset,
+        maxReturn: max_return,
+        status: status
+      }
 
-      get('/rest/asset/v1/programs.json', params)
+      get('/rest/asset/v1/programs.json', {}, optional)
     end
 
     def get_program_by_id(id)

data/lib/mrkt/concerns/import_leads.rb

@@ -5,11 +5,14 @@ module Mrkt
         format: format,
         file: Faraday::UploadIO.new(file, 'text/csv')
       }
-      params[:lookupField] = lookup_field if lookup_field
-      params[:listId] = list_id if list_id
-      params[:partitionName] = partition_name if partition_name
 
-      post('/bulk/v1/leads.json', params)
+      optional = {
+        lookupField: lookup_field,
+        listId: list_id,
+        partitionName: partition_name
+      }
+
+      post('/bulk/v1/leads.json', params, optional)
     end
 
     def import_lead_status(id)

data/lib/mrkt/errors.rb

@@ -25,6 +25,7 @@ class Mrkt::Errors
     610  => 'RequestedResourceNotFound',
     611  => 'System',
     612  => 'InvalidContentType',
+    702  => 'RecordNotFound',
     703  => 'DisabledFeature',
     1001 => 'TypeMismatch',
     1002 => 'MissingParamater',
@@ -40,9 +41,9 @@ class Mrkt::Errors
     1012 => 'InvalidCookieValue',
     1013 => 'ObjectNotFound',
     1014 => 'FailedToCreateObject'
-  }
+  }.freeze
 
-  RESPONSE_CODE_TO_ERROR.values.each do |class_name|
+  RESPONSE_CODE_TO_ERROR.each_value do |class_name|
     const_set(class_name, create_class)
   end
 

data/lib/mrkt/version.rb

@@ -1,3 +1,3 @@
 module Mrkt
-  VERSION = '0.9.0'
+  VERSION = '0.10.0'.freeze
 end

data/mrkt.gemspec

@@ -1,5 +1,4 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'mrkt/version'
 
@@ -16,19 +15,18 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files`.split($RS)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = %w(lib)
+  spec.require_paths = %w[lib]
 
-  spec.required_ruby_version = '~> 2.0'
+  spec.required_ruby_version = '~> 2.3'
 
-  spec.add_dependency 'faraday', '> 0.9.0', '< 0.14.0'
-  spec.add_dependency 'faraday_middleware', '> 0.9.0', '< 0.13.0'
+  spec.add_dependency 'faraday', '> 0.9.0', '< 0.16.0'
+  spec.add_dependency 'faraday_middleware', '> 0.9.0', '< 0.16.0'
 
   spec.add_development_dependency 'bundler', '~> 1.3'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'codeclimate-test-reporter', '~> 1.0'
+  spec.add_development_dependency 'pry-byebug', '~> 3.7'
+  spec.add_development_dependency 'rake', '~> 12.3'
   spec.add_development_dependency 'rspec', '~> 3.2'
-  spec.add_development_dependency 'webmock', '~> 1.21.0'
-  spec.add_development_dependency 'simplecov', '~> 0.14.1'
-  spec.add_development_dependency 'pry-byebug', '~> 3.4.0'
-  spec.add_development_dependency 'codeclimate-test-reporter', '~> 1.0.0'
-  spec.add_development_dependency 'rubocop', '~> 0.45.0'
+  spec.add_development_dependency 'rubocop', '~> 0.66.0'
+  spec.add_development_dependency 'webmock', '~> 3.1'
 end

data/spec/concerns/authentication_spec.rb

@@ -32,6 +32,8 @@ describe Mrkt::Authentication do
     context 'when the token has expired and @retry_authentication = true' do
       before { remove_request_stub(@authentication_request_stub) }
 
+      let(:retry_count) { 3 }
+
       let(:expired_authentication_stub) do
         { access_token: SecureRandom.uuid, token_type: 'bearer', expires_in: 0, scope: 'RestClient' }
       end
@@ -40,7 +42,17 @@ describe Mrkt::Authentication do
         { access_token: SecureRandom.uuid, token_type: 'bearer', expires_in: 1234, scope: 'RestClient' }
       end
 
-      subject(:client) { Mrkt::Client.new(host: host, client_id: client_id, client_secret: client_secret, retry_authentication: true) }
+      let(:client_options) do
+        {
+          host: host,
+          client_id: client_id,
+          client_secret: client_secret,
+          retry_authentication: true,
+          retry_authentication_count: retry_count
+        }
+      end
+
+      subject(:client) { Mrkt::Client.new(client_options) }
 
       before do
         stub_request(:get, "https://#{host}/identity/oauth/token")
@@ -55,12 +67,14 @@ describe Mrkt::Authentication do
         expect(client.authenticated?).to be true
       end
 
-      it 'should stop retrying after @retry_authentication_count tries and then raise an error' do
-        client = Mrkt::Client.new(host: host, client_id: client_id, client_secret: client_secret, retry_authentication: true, retry_authentication_count: 2)
+      context 'when retry_authentication_count is low' do
+        let(:retry_count) { 2 }
 
-        expect(client.authenticated?).to_not be true
+        it 'should stop retrying after @retry_authentication_count tries and then raise an error' do
+          expect(client.authenticated?).to_not be true
 
-        expect { client.authenticate! }.to raise_error(Mrkt::Errors::Error, 'Client not authenticated')
+          expect { client.authenticate! }.to raise_error(Mrkt::Errors::Error, 'Client not authenticated')
+        end
       end
     end
   end

data/spec/concerns/crud_activities_spec.rb

@@ -110,7 +110,7 @@ describe Mrkt::CrudActivities do
 
     before do
       stub_request(:get, "https://#{host}/rest/v1/activities.json")
-        .with(query: { nextPageToken: URI.encode(token) })
+        .with(query: { nextPageToken: token })
         .to_return(json_stub(response_stub))
     end
 
@@ -152,7 +152,7 @@ describe Mrkt::CrudActivities do
       before do
         stub_request(:get, "https://#{host}/rest/v1/activities.json")
           .with(query: {
-            nextPageToken: URI.encode(token),
+            nextPageToken: token,
             activityTypeIds: activity_type_ids.join(',')
           })
           .to_return(json_stub(response_stub))
@@ -196,7 +196,7 @@ describe Mrkt::CrudActivities do
 
       before do
         stub_request(:get, "https://#{host}/rest/v1/activities.json")
-          .with(query: { nextPageToken: URI.encode(token), leadIds: lead_ids.join(',') })
+          .with(query: { nextPageToken: token, leadIds: lead_ids.join(',') })
           .to_return(json_stub(response_stub))
       end
 
@@ -204,15 +204,15 @@ describe Mrkt::CrudActivities do
     end
 
     context 'specifying arrays values as empty strings' do
-      let(:activity_type_ids) { "" }
-      let(:lead_ids) { "" }
+      let(:activity_type_ids) { '' }
+      let(:lead_ids) { '' }
       subject do
         client.get_activities(token, activity_type_ids: activity_type_ids, lead_ids: lead_ids)
       end
 
       before do
         stub_request(:get, "https://#{host}/rest/v1/activities.json")
-          .with(query: { nextPageToken: URI.encode(token) })
+          .with(query: { nextPageToken: token })
           .to_return(json_stub(response_stub))
       end
 
@@ -227,7 +227,7 @@ describe Mrkt::CrudActivities do
       before do
         stub_request(:get, "https://#{host}/rest/v1/activities.json")
           .with(query: {
-            nextPageToken: URI.encode(token),
+            nextPageToken: token,
             activityTypeIds: activity_type_ids.join(','),
             leadIds: lead_ids.join(',')
           })
@@ -237,4 +237,43 @@ describe Mrkt::CrudActivities do
       it { is_expected.to eq(response_stub) }
     end
   end
+
+  describe '#get_deleted_leads' do
+    let(:token) { '4GAX7YNCIJKO2VAED5LH5PQIYPUM7WCVKTQWEDMP2L24AXZT54LA====' }
+    let(:response_stub) do
+      {
+        requestId: '8105#1650074c30c',
+        result:  [
+          {
+            id: 12_751,
+            marketoGUID: '12751',
+            leadId: 277,
+            activityDate: '2018-08-03T14:58:53Z',
+            activityTypeId: 37,
+            campaignId: 5227,
+            primaryAttributeValueId: 277,
+            primaryAttributeValue: 'Delete Me',
+            attributes:  [
+              {
+                name: 'Campaign',
+                value: 'Run Action Delete Lead 2018-08-03 04:58:50 pm'
+              }
+            ]
+          }
+        ],
+        success: true,
+        nextPageToken: 'XQH6SLHODNIM7CY6MKJ6GAOR3JYOQXIN3THAHKYZXSOYN4HOPR2Q====',
+        moreResult: false
+      }
+    end
+    subject { client.get_deleted_leads(token) }
+
+    before do
+      stub_request(:get, "https://#{host}/rest/v1/activities/deletedleads.json")
+        .with(query: { nextPageToken: token })
+        .to_return(json_stub(response_stub))
+    end
+
+    it { is_expected.to eq(response_stub) }
+  end
 end

data/spec/concerns/crud_asset_folders_spec.rb

@@ -0,0 +1,273 @@
+describe Mrkt::CrudAssetFolders do
+  include_context 'initialized client'
+
+  let(:response_folder_result) do
+    {
+      name: 'Test Folder Name',
+      description: 'Optional folder description',
+      createdAt: '2019-03-15T23:31:00Z+0000',
+      updatedAt: '2019-03-15T23:31:00Z+0000',
+      url: 'https://app-devlocal1.marketo.com/#ML0A1ZN75',
+      folderId: {
+        id: 75,
+        type: 'Folder'
+      },
+      folderType: 'Zone',
+      parent: {
+        id: 5,
+        type: 'Folder'
+      },
+      path: '/Lead Database/Default/Test Folder Name',
+      isArchive: false,
+      isSystem: false,
+      accessZoneId: 1,
+      workspace: 'Default',
+      id: 75
+    }
+  end
+
+  describe '#create_folder' do
+    subject { client.create_folder(name, parent, description: description) }
+
+    let(:name) { 'Test Folder Name' }
+    let(:parent) do
+      { id: 5, type: 'Folder' }
+    end
+    let(:description) { 'Optional folder description' }
+    let(:response_stub) do
+      {
+        requestId: 'bf7d#16983b1c7e3',
+        result: [
+          response_folder_result
+        ],
+        success: true,
+        errors: [],
+        warnings: []
+      }
+    end
+
+    let(:json_parent) { JSON.generate(parent) }
+    let(:request_body) do
+      {
+        name: name,
+        parent: json_parent,
+        description: description
+      }
+    end
+
+    before do
+      stub_request(:post, "https://#{host}/rest/asset/v1/folders.json")
+        .with(body: request_body)
+        .to_return(json_stub(response_stub))
+    end
+
+    it { is_expected.to eq(response_stub) }
+  end
+
+  describe '#get_folder_by_id' do
+    subject { client.get_folder_by_id(id, type: type) }
+
+    let(:id) { 77 }
+
+    before do
+      stub_request(:get, "https://#{host}/rest/asset/v1/folder/#{id}.json?type=#{type}")
+        .to_return(json_stub(response_stub))
+    end
+
+    context 'when a folder with the given id exists' do
+      let(:type) { 'Folder' }
+      let(:response_stub) do
+        {
+          requestId: '12756#16983bd0ee5',
+          result: [
+            response_folder_result
+          ],
+          success: true,
+          errors: [],
+          warnings: []
+        }
+      end
+
+      it { is_expected.to eq(response_stub) }
+    end
+
+    context 'when a folder with the given id does not exist' do
+      let(:type) { 'Folder' }
+      let(:response_stub) do
+        {
+          requestId: '18087#16983c04cdf',
+          success: true,
+          errors: [],
+          warnings: [
+            'No assets found for the given search criteria.'
+          ]
+        }
+      end
+
+      it { is_expected.to eq(response_stub) }
+    end
+
+    context 'when the given type is not acceptable' do
+      let(:type) { 'Unacceptable' }
+      let(:response_stub) do
+        {
+          requestId: '12776#16983c25b1d',
+          success: false,
+          warnings: [],
+          errors: [
+            {
+              code: '1001',
+              message: "Invalid value 'Unacceptable'. Required of type 'FolderVariantType'"
+            }
+          ]
+        }
+      end
+
+      it 'should raise an Error' do
+        expect { subject }.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) }
+
+    let(:name) { 'Test Folder Name' }
+    let(:type) { 'Folder' }
+    let(:root) do
+      {
+        id: 5,
+        type: 'Folder'
+      }
+    end
+    let(:work_space) { 'Default' }
+
+    let(:json_root) { JSON.generate(root) }
+    let(:request_query) { "name=#{name}&type=#{type}&root=#{json_root}&workSpace=#{work_space}" }
+
+    before do
+      stub_request(:get, "https://#{host}/rest/asset/v1/folder/byName.json?#{request_query}")
+        .to_return(json_stub(response_stub))
+    end
+
+    context 'when a folder with the given name exists' do
+      let(:response_stub) do
+        {
+          requestId: '541#16983d2f549',
+          result: [
+            response_folder_result
+          ],
+          success: true,
+          errors: [],
+          warnings: []
+        }
+      end
+
+      it { is_expected.to eq(response_stub) }
+    end
+
+    context 'when a folder with the given name does not exist' do
+      let(:response_stub) do
+        {
+          requestId: '105ad#16983d557c5',
+          success: true,
+          errors: [],
+          warnings: [
+            'No assets found for the given search criteria.'
+          ]
+        }
+      end
+
+      it { is_expected.to eq(response_stub) }
+    end
+
+    context 'when the given work_space does not exist' do
+      let(:response_stub) do
+        {
+          requestId: '17af3#16983da0349',
+          success: false,
+          warnings: [],
+          errors: [
+            {
+              code: '611',
+              message: 'Unable to get folder'
+            }
+          ]
+        }
+      end
+
+      it 'should raise an Error' do
+        expect { subject }.to raise_error(Mrkt::Errors::System)
+      end
+    end
+
+    context 'when the given type is not acceptable' do
+      let(:response_stub) do
+        {
+          requestId: '2225#16983db0b71',
+          success: false,
+          warnings: [],
+          errors: [
+            {
+              code: '1003',
+              message: 'Invalid request. Please check and try again.'
+            }
+          ]
+        }
+      end
+
+      it 'should raise an Error' do
+        expect { subject }.to raise_error(Mrkt::Errors::UnspecifiedAction)
+      end
+    end
+  end
+
+  describe '#delete_folder' do
+    subject { client.delete_folder(id) }
+
+    let(:id) { 75 }
+
+    before do
+      stub_request(:post, "https://#{host}/rest/asset/v1/folder/#{id}/delete.json")
+        .to_return(json_stub(response_stub))
+    end
+
+    context 'when a folder with the given id exists' do
+      let(:response_stub) do
+        {
+          requestId: '1a1a#16983eaa800',
+          result: [
+            {
+              id: 75
+            }
+          ],
+          success: true,
+          errors: [],
+          warnings: []
+        }
+      end
+
+      it { is_expected.to eq(response_stub) }
+    end
+
+    context 'when a folder with the given id does not exist' do
+      let(:response_stub) do
+        {
+          requestId: '102ee#16983f320fb',
+          success: false,
+          warnings: [],
+          errors: [
+            {
+              code: '702',
+              message: '75 Folder not found'
+            }
+          ]
+        }
+      end
+
+      it 'should raise an Error' do
+        expect { subject }.to raise_error(Mrkt::Errors::RecordNotFound)
+      end
+    end
+  end
+end