mrkt 0.6.2 → 1.2.0

data/lib/mrkt/concerns/crud_custom_objects.rb

@@ -1,52 +1,51 @@
 module Mrkt
   module CrudCustomObjects
-    def get_list_of_custom_objects(names=nil)
+    def get_list_of_custom_objects(names = nil)
       params = {}
-      params[:names] = names.join(',') if names
+      params[:names] = names if names
 
       get('/rest/v1/customobjects.json', params)
     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
+      }
+
+      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(',')
+        filterValues: filter_values
       }
-      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
 
@@ -33,12 +47,24 @@ module Mrkt
     end
 
     def associate_lead(id, cookie)
-      params = Faraday::Utils::ParamsHash.new
-      params[:cookie] = cookie
+      params = Mrkt::Faraday::ParamsEncoder.encode(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}")
+    end
+
+    def merge_leads(winning_lead_id, losing_lead_ids, merge_in_crm: false)
+      params = {}
+
+      params[:mergeInCRM] = merge_in_crm
+      params[:leadIds] = losing_lead_ids if losing_lead_ids
+
+      query_params = Mrkt::Faraday::ParamsEncoder.encode(params)
+
+      post_json("/rest/v1/leads/#{winning_lead_id}/merge.json?#{query_params}")
+    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_custom_objects.rb

@@ -0,0 +1,24 @@
+module Mrkt
+  module ImportCustomObjects
+    def import_custom_object(file, custom_object, format = 'csv')
+      params = {
+        format: format,
+        file: ::Faraday::UploadIO.new(file, 'text/csv')
+      }
+
+      post("/bulk/v1/customobjects/#{custom_object}/import.json", params)
+    end
+
+    def import_custom_object_status(id, custom_object)
+      get("/bulk/v1/customobjects/#{custom_object}/import/#{id}/status.json")
+    end
+
+    def import_custom_object_failures(id, custom_object)
+      get("/bulk/v1/customobjects/#{custom_object}/import/#{id}/failures.json")
+    end
+
+    def import_custom_object_warnings(id, custom_object)
+      get("/bulk/v1/customobjects/#{custom_object}/import/#{id}/warnings.json")
+    end
+  end
+end

data/lib/mrkt/concerns/import_leads.rb

@@ -3,13 +3,16 @@ module Mrkt
     def import_lead(file, format = 'csv', lookup_field: nil, list_id: nil, partition_name: nil)
       params = {
         format: format,
-        file: Faraday::UploadIO.new(file, 'text/csv')
+        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',
@@ -39,10 +40,29 @@ class Mrkt::Errors
     1011 => 'FieldNotSupported',
     1012 => 'InvalidCookieValue',
     1013 => 'ObjectNotFound',
-    1014 => 'FailedToCreateObject'
-  }
+    1014 => 'FailedToCreateObject',
+    1015 => 'LeadNotInList',
+    1016 => 'TooManyImports',
+    1017 => 'ObjectAlreadyExists',
+    1018 => 'CRMEnabled',
+    1019 => 'ImportInProgress',
+    1020 => 'TooManyCloneToProgram',
+    1021 => 'CompanyUpdateNotAllowed',
+    1022 => 'ObjectInUse',
+    1025 => 'ProgramStatusNotFound',
+    1026 => 'CustomObjectNotEnabled',
+    1027 => 'MaxActivityTypeLimitReached',
+    1028 => 'MaxFieldLimitReached',
+    1029 => 'BulkExportQuotaExceeded',
+    1035 => 'UnsupportedFilterType',
+    1036 => 'DuplicateObjectFoundInInput',
+    1042 => 'InvalidRunAtDate',
+    1048 => 'CustomObjectDiscardDraftFailed',
+    1049 => 'FailedToCreateActivity',
+    1077 => 'MergeLeadsCallFailedDueToFieldLength'
+  }.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/faraday/params_encoder.rb

@@ -0,0 +1,20 @@
+module Mrkt
+  module Faraday
+    class ParamsEncoder
+      class << self
+        def encode(hash)
+          new_hash = hash.transform_values { |v| encode_value(v) }
+          ::Faraday::NestedParamsEncoder.encode(new_hash)
+        end
+
+        def decode(string)
+          ::Faraday::NestedParamsEncoder.decode(string)
+        end
+
+        def encode_value(value)
+          value.respond_to?(:join) ? value.join(',') : value
+        end
+      end
+    end
+  end
+end

data/lib/mrkt/faraday.rb

@@ -0,0 +1,4 @@
+require 'faraday'
+
+require 'mrkt/faraday/params_encoder'
+require 'mrkt/faraday_middleware'

data/lib/mrkt/faraday_middleware/response.rb

@@ -12,8 +12,8 @@ module Mrkt
 
         data = env[:body]
 
-        fail Mrkt::Errors::EmptyResponse if data.nil?
-        fail Mrkt::Errors::Error, data[:error_description] if data.key?(:error)
+        raise Mrkt::Errors::EmptyResponse if data.nil?
+        raise Mrkt::Errors::Error, data[:error_description] if data.key?(:error)
 
         handle_errors!(data[:errors]) unless data.fetch(:success, true)
       end
@@ -21,8 +21,8 @@ module Mrkt
       def handle_errors!(errors)
         error = errors.first
 
-        fail Mrkt::Errors::Unknown if error.nil?
-        fail Mrkt::Errors.find_by_response_code(error[:code].to_i), error[:message]
+        raise Mrkt::Errors::Unknown if error.nil?
+        raise Mrkt::Errors.find_by_response_code(error[:code].to_i), error[:message]
       end
     end
   end

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.6.2'
+  VERSION = '1.2.0'.freeze
 end

data/lib/mrkt.rb

@@ -4,24 +4,34 @@ require 'mrkt/errors'
 require 'mrkt/concerns/connection'
 require 'mrkt/concerns/authentication'
 require 'mrkt/concerns/crud_helpers'
+require 'mrkt/concerns/crud_activities'
 require 'mrkt/concerns/crud_campaigns'
 require 'mrkt/concerns/crud_leads'
 require 'mrkt/concerns/crud_lists'
 require 'mrkt/concerns/import_leads'
+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_asset_static_lists'
+require 'mrkt/concerns/crud_asset_folders'
 
 module Mrkt
   class Client
     include Connection
     include Authentication
     include CrudHelpers
+    include CrudActivities
     include CrudCampaigns
     include CrudLeads
     include CrudLists
     include ImportLeads
+    include ImportCustomObjects
     include CrudCustomObjects
+    include CrudCustomActivities
     include CrudPrograms
+    include CrudAssetStaticLists
+    include CrudAssetFolders
 
     attr_accessor :debug
 
@@ -30,17 +40,33 @@ module Mrkt
 
       @client_id = options.fetch(:client_id)
       @client_secret = options.fetch(:client_secret)
+      @partner_id = options[:partner_id]
+
+      @retry_authentication = options.fetch(:retry_authentication, false)
+      @retry_authentication_count = options.fetch(:retry_authentication_count, 3).to_i
+      @retry_authentication_wait_seconds = options.fetch(:retry_authentication_wait_seconds, 0).to_i
+
+      @debug = options[:debug]
+
+      @logger = options[:logger]
+      @log_options = options[:log_options]
 
       @options = options
     end
 
-    %i(get post delete).each do |http_method|
-      define_method(http_method) do |path, payload = {}, &block|
+    def merge_params(params, optional)
+      params.merge(optional.keep_if { |_key, value| value })
+    end
+
+    %i[get post delete].each do |http_method|
+      define_method(http_method) do |path, params = {}, optional = {}, &block|
         authenticate!
 
+        payload = merge_params(params, optional)
+
         resp = connection.send(http_method, path, payload) do |req|
           add_authorization(req)
-          block.call(req) unless block.nil?
+          block&.call(req)
         end
 
         resp.body

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,18 +15,20 @@ 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_middleware', '> 0.9.0', '< 0.11.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 'bundler', '~> 2.0'
+  spec.add_development_dependency 'gem-release', '~> 2.1'
+  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 'webmock', '~> 1.21.0'
-  spec.add_development_dependency 'simplecov', '~> 0.10.0'
-  spec.add_development_dependency 'pry-byebug', '~> 3.1.0'
-  spec.add_development_dependency 'codeclimate-test-reporter', '~> 0.4.7'
-  spec.add_development_dependency 'rubocop', '~> 0.32.1'
+  spec.add_development_dependency 'rubocop', '~> 1.20.0'
+  spec.add_development_dependency 'rubocop-rake', '~> 0.6.0'
+  spec.add_development_dependency 'simplecov', '~> 0.21.2'
+  spec.add_development_dependency 'webmock', '~> 3.1'
 end

data/spec/concerns/authentication_spec.rb

@@ -22,6 +22,101 @@ describe Mrkt::Authentication do
     end
   end
 
+  describe '#authenticate!' do
+    it 'should authenticate and then be authenticated?' do
+      expect(client.authenticated?).to_not 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) }
+
+      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
+
+      let(:valid_authentication_stub) do
+        { access_token: SecureRandom.uuid, token_type: 'bearer', expires_in: 1234, scope: 'RestClient' }
+      end
+
+      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")
+          .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
+        client.authenticate!
+        expect(client.authenticated?).to be true
+      end
+
+      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
+
+          expect { client.authenticate! }.to raise_error(Mrkt::Errors::Error, 'Client not authenticated')
+        end
+      end
+    end
+  end
+
   describe '#authenticated?' do
     subject { client.authenticated? }