maropost-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6c8b9f2f1503cbd2b23c828357d4098e86c97cb5
+  data.tar.gz: feba6fc5c7543817116193751fce70161e3450ef
+SHA512:
+  metadata.gz: 79feafdbae51a52c30f3ab2aa7768480238c5ba5e82bac7d4aecc121b1970d4636a6657dee5f47ca7f4ca6ba021ade3b8c10c88d2bf39cad307715def930004a
+  data.tar.gz: f2fa7ff178b79dff8658fe36603874ef60a57f6989e25581eaf4914d661a12e2aa669f7f34cb7c7cf0d940d0a72f936a358f6808049477affb2502aa09bc8219

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.0
+before_install: gem install bundler -v 1.17.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in maropost_api.gemspec
+gemspec

data/README.md

@@ -0,0 +1 @@
+# marketing-ruby

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "maropost_api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/maropost-api.rb

@@ -0,0 +1,78 @@
+require "maropost_api/version"
+require 'uri'
+require "maropost_api/campaigns"
+require "maropost_api/contacts"
+require "maropost_api/journeys"
+require "maropost_api/products_and_revenue"
+require "maropost_api/custom_types/operation_result"
+require "maropost_api/ab_test_campaigns"
+require "maropost_api/reports"
+require "maropost_api/relational_tables"
+require "maropost_api/transactional_campaigns"
+require "httparty"
+
+##
+# This package provides programmatic access to several Maropost services. It consists of eight services within the MaropostApi
+# namespace. Each service consists of one or more functions that perform an operation against your Maropost account. These methods
+# return a result object indicating success/failure, any Exceptions thrown, and the resulting data. The detailed documentation of the
+# api can be found in http://api.maropost.com/api
+#
+module MaropostApi
+  include HTTParty
+  # debug_output $stdout
+  include URI
+  format :json
+  base_uri 'https://api.maropost.com'
+  
+  attr_accessor :api_key
+  attr_accessor :account
+  
+  class Error < StandardError; end
+  
+  def self.get_result(path, options)
+    full_path = path << ".#{format.to_s}"
+    result = get(full_path, options)
+    
+    OperationResult.new(result)
+  end
+  
+  def self.post_result(path, form_body)
+    raise ArgumentError "path and form_body cannot be nil" if path.nil? || form_body.nil?
+    full_path = path << ".#{format.to_s}"
+    # set auth_token manually due to 400 error when sent via parameters
+    full_path = full_path << "?auth_token=#{@api_key}"
+    result = post(full_path, :body => form_body.to_json, :headers => {"Content-Type" => 'application/json'})
+    
+    OperationResult.new(result)
+  end
+  
+  def self.put_result(path, form_body = {}, query_params = {})
+    raise ArgumentError "path and form_body cannot be nil" if path.nil? || form_body.nil?
+    full_path = path << ".#{format.to_s}"
+    query_params = set_query_params if query_params.empty?
+    result = put(full_path, :body => form_body.to_json, :headers => {"Content-Type" => 'application/json', 'Accept' => 'application/json'}, :query => query_params[:query])
+    
+    OperationResult.new(result)
+  end
+  
+  def self.delete_result(path, query_params, body={})
+    raise ArgumentError "path and query_params cannot be nil" if path.nil? || query_params.nil?
+    full_path = path << ".#{format.to_s}"
+    result = delete(full_path, :headers => {"Content-Type" => 'application/json'}, :query => query_params[:query], :body => body.to_json)
+    
+    OperationResult.new(result)
+  end
+  
+  def self.set_query_params(query_params = {})
+    return nil if query_params.class != Hash
+    @query_params ||= {
+      query: {auth_token: @api_key}
+    }
+    additional_params = { query: query_params }
+    
+    @query_params.merge(additional_params) do |key, qp_val, ap_val|
+      qp_val.merge ap_val
+    end
+  end
+  
+end

data/lib/maropost_api/ab_test_campaigns.rb

@@ -0,0 +1,48 @@
+module MaropostApi
+  
+  class AbTestCampaigns
+    
+    def initialize(account = ENV["ACCOUNT"], api_key = ENV["API_KEY"])
+      MaropostApi.instance_variable_set(:@api_key, api_key)
+      MaropostApi.instance_variable_set(:@account, account)
+    end
+    
+    def create_ab_test(
+      name:,
+      from_email:,
+      address:,
+      language:,
+      campaign_groups_attributes:,
+      commit:,
+      sendAt:,
+      brand_id: nil,
+      suppressed_list_ids: [],
+      suppressed_journey_ids: [],
+      suppressed_segment_ids: [],
+      email_preview_link: nil,
+      decided_by: nil,
+      lists: [],
+      ctags: [],
+      segments: []
+    )
+      args = method(__method__).parameters
+      body = {:ab_test => {}}
+      args.each do |arg|
+        k = arg[1].to_s
+        v = eval(k)
+        body[:ab_test][k] = v unless v.nil?
+      end
+      
+      full_path = full_resource_path('/ab_test')
+
+      MaropostApi.post_result(full_path, :body => {campaign: body[:ab_test]})
+    end
+  
+    private
+    
+      def full_resource_path(specifics = '', root_resource = "campaigns")
+        account = MaropostApi.instance_variable_get(:@account)
+        "/accounts/#{account}/#{root_resource}" << specifics
+      end
+  end
+end

data/lib/maropost_api/campaigns.rb

@@ -0,0 +1,148 @@
+module MaropostApi
+  
+  ##
+  # Contains methods that get various Campaign Reports based on provided parameters.
+  # The method names themselves reveal the type of reports they are getting.
+  class Campaigns
+    ##
+    # Creates a new instance of Reports class.
+    # @param account [Integer] is authentic user account id (Integer) provided by maropost.com
+    # @param api_key [String] is the auth token (String) that is validated on the server to authenticate the user
+    def initialize(account = ENV["ACCOUNT"], api_key = ENV["API_KEY"])
+      MaropostApi.instance_variable_set(:@api_key, api_key)
+      MaropostApi.instance_variable_set(:@account, account)
+    end
+    
+    ##
+    # gets all the campaigns grouped by 
+    # @param page (Integer) number that determines which page of the result to retrieve
+    def get(page)
+      full_path = full_resource_path('')
+      query_params = MaropostApi.set_query_params({page: page})
+      
+      MaropostApi.get_result(full_path, query_params)
+    end
+    
+    ##
+    # gets a campaign determined by the provided
+    # @param campaign_id [Integer] Unique identifier of campaigns
+    def get_campaign(campaign_id)
+      full_path = full_resource_path("/#{campaign_id}")
+      query_params = MaropostApi.set_query_params()
+
+      MaropostApi.get_result(full_path, query_params)
+    end
+    
+    ##
+    # gets bounce reports for the provided
+    # @param campaign_id [Integer] Unique id of campaign
+    # @param page [Integer] number that decides which page of result to get
+    def get_bounce_reports(campaign_id, page)
+      full_path = full_resource_path("/#{campaign_id}/bounce_report")
+      query_params = MaropostApi.set_query_params({page:page})
+      
+      MaropostApi.get_result(full_path, query_params)
+    end
+    
+    ##
+    # gets click reports for the provided
+    # @param campaign_id [Integer] Unique id of campaign
+    # @param page [Integer] number that decides which page of result to get
+    # @param unique [Boolean] decides whether to retrive unique reports or not
+    def get_click_reports(campaign_id, page, unique = nil)
+      full_path = full_resource_path("/#{campaign_id}/click_report")
+      query_params = MaropostApi.set_query_params({page: page})
+      query_params[:query][:unique] = unique unless unique.nil?
+      
+      MaropostApi.get_result(full_path, query_params)
+    end
+    
+    ##
+    # gets complaint reports for the provided
+    # @param campaign_id [Integer] Unique id of campaign
+    # param page [Integer] number that decides which page of result to get
+    def get_complaint_reports(campaign_id, page)
+      full_path = full_resource_path("/#{campaign_id}/complaint_report")
+      query_params = MaropostApi.set_query_params({page: page})
+      
+      MaropostApi.get_result(full_path, query_params)
+    end
+    
+    ##
+    # gets delivered reports for the provided
+    # @param campaign_id [Integer] Unique id of campaign
+    # param page [Integer] number that decides which page of result to get
+    def get_delivered_reports(campaign_id, page)
+      full_path = full_resource_path("/#{campaign_id}/delivered_report")
+      query_params = MaropostApi.set_query_params({page: page})
+      
+      MaropostApi.get_result(full_path, query_params)
+    end
+    
+    ##
+    # gets hard bounce reports for the provided
+    # @param campaign_id [Integer] Unique id of campaign
+    # param page [Integer] number that decides which page of result to get
+    def get_hard_bounce_reports(campaign_id, page)
+      full_path = full_resource_path("/#{campaign_id}/hard_bounce_report")
+      query_params = MaropostApi.set_query_params({page: page})
+      
+      MaropostApi.get_result(full_path, query_params)
+    end
+    
+    ##
+    # gets soft bounce reports for the provided
+    # @param campaign_id [Integer] Unique id of campaign
+    # param page [Integer] number that decides which page of result to get
+    def get_soft_bounce_reports(campaign_id, page)
+      full_path = full_resource_path("/#{campaign_id}/soft_bounce_report")
+      query_params = MaropostApi.set_query_params({page: page})
+      
+      MaropostApi.get_result(full_path, query_params)
+    end
+    
+    ##
+    # gets open reports for the provided
+    # @param campaign_id [Integer] Unique id of campaign
+    # param page [Integer] number that decides which page of result to get
+    # @param unique [Boolean] decides whether to retrive unique reports or not
+    def get_open_reports(campaign_id, page, unique = nil)
+      full_path = full_resource_path("/#{campaign_id}/open_report")
+      query_params = MaropostApi.set_query_params({page: page})
+      query_params[:query][:unique] = unique unless unique.nil?
+      
+      MaropostApi.get_result(full_path, query_params)
+    end
+    
+    ##
+    # gets unsubscribe reports for the provided
+    # @param campaign_id [Integer] Unique id of campaign
+    # param page [Integer] number that decides which page of result to get
+    def get_unsubscribe_reports(campaign_id, page)
+      full_path = full_resource_path("/#{campaign_id}/unsubscribe_report")
+      query_params = MaropostApi.set_query_params({page: page})
+      
+      MaropostApi.get_result(full_path, query_params)
+    end
+    
+    ##
+    # gets link reports for the provided
+    # @param campaign_id [Integer] Unique id of campaign
+    # param page [Integer] number that decides which page of result to get
+    def get_link_reports(campaign_id, page, unique = nil)
+      full_path = full_resource_path("/#{campaign_id}/link_report")
+      query_params = MaropostApi.set_query_params({page: page})
+      query_params[:query][:unique] = unique unless unique.nil?
+      
+      MaropostApi.get_result(full_path, query_params)
+    end
+    
+      private
+      
+      def full_resource_path(specifics = '')
+        account = MaropostApi.instance_variable_get(:@account)
+        "/accounts/#{account}/campaigns" << specifics
+      end
+  end
+  
+end

data/lib/maropost_api/contacts.rb

@@ -0,0 +1,312 @@
+module MaropostApi
+  ##
+  # Contains methods that get Contacts based on provided parameters.
+  # The method names themselves reveal the type of reports they are getting.
+  class Contacts
+    ##
+    # Creates a new instance of Reports class.
+    # @param account [Integer] is authentic user account id (Integer) provided by maropost.com
+    # @param api_key [String] is the auth token (String) that is validated on the server to authenticate the user
+    def initialize(account = ENV["ACCOUNT"], api_key = ENV["API_KEY"])
+      MaropostApi.instance_variable_set(:@api_key, api_key)
+      MaropostApi.instance_variable_set(:@account, account)
+    end
+    
+    ##
+    # gets contact for the provided
+    # @param email [String] must be an email
+    def get_for_email(email)
+      full_path = full_resource_path("/email")
+      query_params = MaropostApi.set_query_params({"contact[email]" => email})
+      
+      MaropostApi.get_result(full_path, query_params)
+    end
+    
+    ##
+    # gets opens for the provided
+    # @param contact_id [Integer] unique id of the contact
+    # @param page [Integer] number that decides which page or result to retrieve
+    def get_opens(contact_id, page)
+      full_path = full_resource_path("/#{contact_id}/open_report")
+      query_params = MaropostApi.set_query_params({page: page})
+      
+      MaropostApi.get_result(full_path, query_params)
+    end
+    
+    ##
+    # gets clicks for the provided
+    # @param contact_id [Integer] unique id of the contact
+    # @param page [Integer] number that decides which page or result to retrieve
+    def get_clicks(contact_id, page)
+      full_path = full_resource_path("/#{contact_id}/click_report")
+      query_params = MaropostApi.set_query_params({page: page})
+      
+      MaropostApi.get_result(full_path, query_params)
+    end
+    
+    ##
+    # gets contacts for the provided
+    # @param list_id [Integer] unique id of the list
+    # @param page [Integer] number that decides which page or result to retrieve
+    def get_for_list(list_id, page)
+      full_path = full_resource_path("/#{list_id}/contacts", 'lists')
+      query_params = MaropostApi.set_query_params({page: page})
+      
+      MaropostApi.get_result(full_path, query_params)
+    end
+    
+    ##
+    # gets contacts for the provided
+    # @param list_id [Integer] unique id of the list
+    # @param contact_id [Integer] unique contact id
+    def get_contact_for_list(list_id, contact_id)
+      full_path = full_resource_path("/#{list_id}/contacts/#{contact_id}", 'lists')
+      query_params = MaropostApi.set_query_params
+      
+      MaropostApi.get_result(full_path, query_params)
+    end
+    
+    ##
+    # creates a contact
+    # @param email [String] must be an email
+    # @param first_name [String] Contact First Name
+    # @param last_name [String] Contact Last Name
+    # @param phone [String] Contact's phone number
+    # @param fax [String] Contacts' fax number
+    # @param uid [String] Unique identifier
+    # @param custom_field [Hash] list of custom_fields addable for the new contact
+    # @param add_tags [Array] list of tags to be added to the contact
+    # @param remove_tags [Array] list of tags to be removed from the contact
+    # @param remove_from_dnm [Boolean] decides whether to remove contact from dnm or not
+    # @param options [Hash] Key value pairs containing other different properties for the new contact
+    def create_contact(
+        email,
+        first_name,
+        last_name,
+        phone,
+        fax,
+        uid = nil,
+        custom_field = {},
+        add_tags = [],
+        remove_tags = [],
+        remove_from_dnm = false,
+        **options
+      )
+      args = method(__method__).parameters
+      body = {contact: {}}
+      args.each do |arg|
+        k = arg[1].to_s
+        v = eval(k)
+        body[:contact][k] = v unless v.nil?
+      end
+      # p body
+      path = full_resource_path()
+      
+      MaropostApi.post_result(path, body)
+    end
+    
+    ##
+    # creates a contact
+    # @param list_id [Integer] id of the list for which to update/create contact
+    # @param email [String] must be an email
+    # @param first_name [String] Contact First Name
+    # @param last_name [String] Contact Last Name
+    # @param phone [String] Contact's phone number
+    # @param fax [String] Contacts' fax number
+    # @param uid [String] Unique identifier
+    # @param custom_field [Hash] list of custom_fields addable for the new contact
+    # @param add_tags [Array] list of tags to be added to the contact
+    # @param remove_tags [Array] list of tags to be removed from the contact
+    # @param remove_from_dnm [Boolean] decides whether to remove contact from dnm or not
+    # @param subscribe [Boolean] Flags the new contact as subscribed
+    def create_or_update_for_list(
+        list_id, 
+        email, 
+        first_name, 
+        last_name, 
+        phone, 
+        fax, 
+        uid = nil,
+        custom_field = {},
+        add_tags = [], 
+        remove_tags = [], 
+        remove_from_dnm = true, 
+        subscribe = true
+      )
+      args = method(__method__).parameters
+      body = {contact: {}}
+      args.each do |arg|
+        k = arg[1].to_s
+        next if k == "list_id"
+        v = eval(k)
+        body[:contact][k] = v unless v.nil?
+      end
+      
+      email_existence = get_for_email(email)
+      if email_existence.success
+        contact_id = email_existence.data["id"]
+        full_path = full_resource_path("/#{list_id}/contacts/#{contact_id}", "lists")
+        
+        MaropostApi.put_result(full_path, body)
+      else
+        full_path = full_resource_path("/#{list_id}/contacts", "lists")
+        
+        MaropostApi.post_result(full_path, body)
+      end
+      
+    end
+    
+    ##
+    # creates a contact
+    # @param email [String] must be an email
+    # @param first_name [String] Contact First Name
+    # @param last_name [String] Contact Last Name
+    # @param phone [String] Contact's phone number
+    # @param fax [String] Contacts' fax number
+    # @param uid [String] Unique identifier
+    # @param custom_field [Hash] list of custom_fields addable for the new contact
+    # @param add_tags [Array] list of tags to be added to the contact
+    # @param remove_tags [Array] list of tags to be removed from the contact
+    # @param remove_from_dnm [Boolean] decides whether to remove contact from dnm or not
+    # @param options [Hash] Key value pairs containing other different properties for the new contact
+    def create_or_update_for_lists_and_workflows( 
+        email,
+        first_name,
+        last_name,
+        phone,
+        fax,
+        uid = nil,
+        custom_field = {},
+        add_tags = [],
+        remove_tags = [],
+        remove_from_dnm = true,
+        **options
+      )
+      args = method(__method__).parameters
+      body = {contact: {}}
+      args.each do |arg|
+        k = arg[1].to_s
+        v = eval(k)
+        body[:contact][k] = v unless v.nil?
+      end
+      
+      email_existence = get_for_email email
+      if email_existence.success
+        contact_id = email_existence.data["id"]
+        full_path = full_resource_path("/#{contact_id}")
+        body[:contact].delete("options")
+        body[:contact]["subscribe"] = options[:subscribe] if options.has_key? :subscribe
+        
+        MaropostApi.put_result(full_path, body)
+      else
+        full_path = full_resource_path
+
+        MaropostApi.post_result(full_path, body)
+      end
+      
+    end
+    
+    ##
+    # creates a contact
+    # @param list_id [Integer] id of the list for which to update/create contact
+    # @param email [String] must be an email
+    # @param first_name [String] Contact First Name
+    # @param last_name [String] Contact Last Name
+    # @param phone [String] Contact's phone number
+    # @param fax [String] Contacts' fax number
+    # @param uid [String] Unique identifier
+    # @param custom_field [Hash] list of custom_fields addable for the new contact
+    # @param add_tags [Array] list of tags to be added to the contact
+    # @param remove_tags [Array] list of tags to be removed from the contact
+    # @param remove_from_dnm [Boolean] decides whether to remove contact from dnm or not
+    # @param subscribe [Boolean] Flags the new contact as subscribed
+    def update_for_list_and_contact(
+        list_id,
+        contact_id,
+        email,
+        first_name,
+        last_name,
+        phone,
+        fax,
+        uid = nil,
+        custom_field = {},
+        add_tags = [],
+        remove_tags = [],
+        remove_from_dnm = true,
+        subscribe = true
+      )
+      args = method(__method__).parameters
+      body = {contact: {}}
+      args.each do |arg|
+        k = arg[1].to_s
+        next if ["list_id", "contact_id"].include? k
+        v = eval(k)
+        body[:contact][k] = v unless v.nil?
+      end
+      
+      full_path = full_resource_path("/#{list_id}/contacts/#{contact_id}", "lists")
+      
+      MaropostApi.put_result(full_path, body)
+    end
+    
+    ##
+    # unsubscribes all those contacts matching
+    # @param contact_field_value [String|Integer] the value of the contact field name
+    # @param contact_field_name [String|Integer] the name of the field to query the contact for
+    def unsubscribe_all(contact_field_value, contact_field_name)
+      full_path = full_resource_path('/unsubscribe_all')
+      query_params = MaropostApi.set_query_params({"contact[#{contact_field_name}]" => contact_field_value})
+      
+      MaropostApi.put_result(full_path, {}, query_params)
+    end
+    
+    ##
+    # deletes contact from all the lists
+    # @param email [String] gets deleted if matches the value provided
+    def delete_from_all_lists(email)
+      full_path = full_resource_path('/delete_all')
+      query_params = MaropostApi.set_query_params({"contact[email]" => email})
+      
+      MaropostApi.delete_result(full_path, query_params)
+    end
+    
+    ##
+    # deletes contact from list
+    # @param contact_id [Integer] Contact id to delete
+    # @param list_to_delete_from [Integer] List id
+    def delete_from_lists(contact_id, lists_to_delete_from)
+      full_path = full_resource_path("/#{contact_id}")
+      query_params = MaropostApi.set_query_params({'list_ids' => lists_to_delete_from.join(',')})
+      
+      MaropostApi.delete_result(full_path, query_params)
+    end
+    
+    ##
+    # deletes contact for uid
+    # @param uid [String] unique identifier
+    def delete_contact_for_uid(uid)
+      full_path = full_resource_path("/delete_all")
+      query_params = MaropostApi.set_query_params({"uid" => uid})
+      
+      MaropostApi.delete_result(full_path, query_params)
+    end
+    
+    ##
+    # deletes list for the given contact
+    # @param list_id [Integer] List ID
+    # @param contact_id [Integer] Contact ID
+    def delete_list_contact(list_id, contact_id)
+      full_path = full_resource_path("/#{list_id}/contacts/#{contact_id}", "lists")
+      query_params = MaropostApi.set_query_params
+      
+      MaropostApi.delete_result(full_path, query_params)
+    end
+      
+      private
+      
+      def full_resource_path(specifics = '', root_resource = 'contacts')
+        account = MaropostApi.instance_variable_get(:@account)
+        "/accounts/#{account}/#{root_resource}" << specifics
+      end
+  end
+end

data/lib/maropost_api/custom_types/operation_result.rb

@@ -0,0 +1,17 @@
+class OperationResult
+  attr_accessor :errors, :success, :data
+  def initialize(result)
+    if (200..206).to_a.include? result.code
+      @success = true
+      @errors = nil
+      @data = JSON.parse([result.body].to_json).first
+      @data = JSON.parse(@data) if @data.kind_of? String and @data.start_with?("{", "[")
+      @data = nil if @data == ""
+    else
+      @success = false
+      @errors = JSON.parse(JSON.parse([result.body].to_json).first) if result.code != 404
+      @errors = nil if @errors == ""
+      @errors['message'] = 'Page not found!' if result.code == 404
+    end
+  end
+end