mrkt 0.9.0 → 1.0.1

data/lib/mrkt/faraday_middleware.rb

@@ -1,11 +1,7 @@
-require 'faraday'
+require 'mrkt/faraday_middleware/response'
 
 module Mrkt
-  module FaradayMiddleware
-    autoload :Response, 'mrkt/faraday_middleware/response'
-  end
-
-  if Faraday::Middleware.respond_to? :register_middleware
-    Faraday::Response.register_middleware mkto: -> { Mrkt::FaradayMiddleware::Response }
+  if ::Faraday::Middleware.respond_to?(:register_middleware)
+    ::Faraday::Response.register_middleware(mkto: Mrkt::FaradayMiddleware::Response)
   end
 end

data/lib/mrkt/version.rb

@@ -1,3 +1,3 @@
 module Mrkt
-  VERSION = '0.9.0'
+  VERSION = '1.0.1'.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,19 @@ 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.5'
 
-  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', '~> 1.0'
+  spec.add_dependency 'faraday_middleware', '~> 1.0'
 
   spec.add_development_dependency 'bundler', '~> 1.3'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'gem-release', '~> 2.1'
+  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.87.1'
+  spec.add_development_dependency 'simplecov', '~> 0.17.1'
+  spec.add_development_dependency 'webmock', '~> 3.1'
 end

data/spec/concerns/authentication_spec.rb

@@ -29,9 +29,49 @@ describe Mrkt::Authentication do
       expect(client.authenticated?).to be true
     end
 
+    context 'with optional partner_id client option' do
+      before { remove_request_stub(@authentication_request_stub) }
+
+      let(:partner_id) { SecureRandom.uuid }
+
+      let(:client_options) do
+        {
+          host: host,
+          client_id: client_id,
+          client_secret: client_secret,
+          partner_id: partner_id
+        }
+      end
+
+      let(:query) do
+        {
+          client_id: client_id,
+          client_secret: client_secret,
+          partner_id: partner_id,
+          grant_type: 'client_credentials'
+        }
+      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
+        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) }
 
+      let(:retry_count) { 3 }
+
       let(:expired_authentication_stub) do
         { access_token: SecureRandom.uuid, token_type: 'bearer', expires_in: 0, scope: 'RestClient' }
       end
@@ -40,7 +80,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 +105,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