mrkt 0.9.0 → 1.0.1

data/lib/mrkt/concerns/crud_activities.rb

@@ -1,29 +1,32 @@
 module Mrkt
   module CrudActivities
     def get_activity_types
-      get("/rest/v1/activities/types.json")
+      get('/rest/v1/activities/types.json')
     end
 
     def get_paging_token(since_datetime)
-      params = {
-        sinceDatetime: since_datetime.iso8601
-      }
-      get("/rest/v1/activities/pagingtoken.json", params)
+      get('/rest/v1/activities/pagingtoken.json', sinceDatetime: since_datetime.iso8601)
     end
 
     def get_activities(next_page_token, activity_type_ids: [], lead_ids: [])
       params = {
         nextPageToken: next_page_token
       }
-      params[:activityTypeIds] = activity_type_ids.join(',') unless blank?(activity_type_ids)
-      params[:leadIds] = lead_ids.join(',') unless blank?(lead_ids)
-      get("/rest/v1/activities.json", params)
+
+      params[:activityTypeIds] = activity_type_ids unless blank?(activity_type_ids)
+      params[:leadIds] = lead_ids unless blank?(lead_ids)
+
+      get('/rest/v1/activities.json', params)
+    end
+
+    def get_deleted_leads(next_page_token)
+      get('/rest/v1/activities/deletedleads.json', nextPageToken: next_page_token)
     end
 
     private
 
     def blank?(value)
-      !value || value == "" || value.empty?
+      !value || value == '' || value.empty?
     end
   end
 end

data/lib/mrkt/concerns/crud_asset_folders.rb

@@ -0,0 +1,43 @@
+module Mrkt
+  module CrudAssetFolders
+    def create_folder(name, parent, description: nil)
+      post('/rest/asset/v1/folders.json') do |req|
+        params = {
+          name: name,
+          parent: JSON.generate(parent)
+        }
+
+        optional = {
+          description: description
+        }
+
+        req.body = merge_params(params, optional)
+      end
+    end
+
+    def get_folder_by_id(id, type: nil)
+      params = {}
+      params[:type] = type if type
+
+      get("/rest/asset/v1/folder/#{id}.json", params)
+    end
+
+    def get_folder_by_name(name, type: nil, root: nil, work_space: nil)
+      params = {
+        name: name
+      }
+
+      optional = {
+        root: root&.to_json,
+        type: type,
+        workSpace: work_space
+      }
+
+      get('/rest/asset/v1/folder/byName.json', params, optional)
+    end
+
+    def delete_folder(id)
+      post("/rest/asset/v1/folder/#{id}/delete.json")
+    end
+  end
+end

data/lib/mrkt/concerns/crud_asset_static_lists.rb

@@ -0,0 +1,30 @@
+module Mrkt
+  module CrudAssetStaticLists
+    def create_static_list(name, folder, description: nil)
+      post('/rest/asset/v1/staticLists.json') do |req|
+        params = {
+          name: name,
+          folder: JSON.generate(folder)
+        }
+
+        optional = {
+          description: description
+        }
+
+        req.body = merge_params(params, optional)
+      end
+    end
+
+    def get_static_list_by_id(id)
+      get("/rest/asset/v1/staticList/#{id}.json")
+    end
+
+    def get_static_list_by_name(name)
+      get('/rest/asset/v1/staticList/byName.json', name: name)
+    end
+
+    def delete_static_list(id)
+      post("/rest/asset/v1/staticList/#{id}/delete.json")
+    end
+  end
+end

data/lib/mrkt/concerns/crud_campaigns.rb

@@ -1,15 +1,13 @@
 module Mrkt
   module CrudCampaigns
     def request_campaign(id, lead_ids, tokens = {})
-      post("/rest/v1/campaigns/#{id}/trigger.json") do |req|
-        params = {
+      post_json("/rest/v1/campaigns/#{id}/trigger.json") do
+        {
           input: {
             leads: map_lead_ids(lead_ids),
             tokens: tokens
           }
         }
-
-        json_payload(req, params)
       end
     end
   end

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

@@ -2,51 +2,50 @@ module Mrkt
   module CrudCustomObjects
     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,23 +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 = Faraday::Utils::ParamsHash.new
+      params = {}
+
       params[:mergeInCRM] = merge_in_crm
-      params[:leadIds] = losing_lead_ids.join(',') if losing_lead_ids
+      params[:leadIds] = losing_lead_ids if losing_lead_ids
 
-      post("/rest/v1/leads/#{winning_lead_id}/merge.json?#{params.to_query}") do |req|
-        json_payload(req,{})
-      end
+      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

@@ -3,7 +3,7 @@ module Mrkt
     def import_custom_object(file, custom_object, format = 'csv')
       params = {
         format: format,
-        file: Faraday::UploadIO.new(file, 'text/csv')
+        file: ::Faraday::UploadIO.new(file, 'text/csv')
       }
 
       post("/bulk/v1/customobjects/#{custom_object}/import.json", params)

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',
@@ -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/faraday.rb

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

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