mailerlite-ruby 1.0.2

data/fixtures/webhooks/create.yml

@@ -0,0 +1,58 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://connect.mailerlite.com/api/webhooks
+    body:
+      encoding: UTF-8
+      string: '{"events":["subscriber.created"],"url":"http://foobar.hook","name":"test_webhook"}'
+    headers:
+      Authorization:
+      - "<AUTH>"
+      User-Agent:
+      - MailerLite-client-ruby/0.1.1
+      Accept:
+      - application/json
+      Content-Type:
+      - application/json
+      Connection:
+      - close
+      Host:
+      - connect.mailerlite.com
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      Date:
+      - Fri, 23 Dec 2022 21:51:54 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - close
+      Cache-Control:
+      - no-cache, private
+      X-Locale:
+      - en
+      X-Ratelimit-Limit:
+      - '120'
+      X-Ratelimit-Remaining:
+      - '117'
+      Access-Control-Allow-Origin:
+      - "*"
+      Strict-Transport-Security:
+      - max-age=15724800; includeSubDomains
+      Cf-Cache-Status:
+      - DYNAMIC
+      Server:
+      - cloudflare
+      Cf-Ray:
+      - 77e45238dbecde53-MCT
+    body:
+      encoding: UTF-8
+      string: '{"data":{"id":"75321640600209302","name":"test_webhook","url":"http:\/\/foobar.hook","events":["subscriber.created"],"enabled":true,"secret":"HigkdhMVbp","created_at":"2022-12-23
+        21:51:54","updated_at":"2022-12-23 21:51:54"}}'
+  recorded_at: Fri, 23 Dec 2022 21:51:53 GMT
+recorded_with: VCR 6.1.0

data/fixtures/webhooks/delete.yml

@@ -0,0 +1,53 @@
+---
+http_interactions:
+- request:
+    method: delete
+    uri: https://connect.mailerlite.com/api/webhooks/75321640600209302
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      Authorization:
+      - "<AUTH>"
+      User-Agent:
+      - MailerLite-client-ruby/0.1.1
+      Accept:
+      - application/json
+      Content-Type:
+      - application/json
+      Connection:
+      - close
+      Host:
+      - connect.mailerlite.com
+  response:
+    status:
+      code: 204
+      message: No Content
+    headers:
+      Date:
+      - Fri, 23 Dec 2022 21:52:46 GMT
+      Connection:
+      - close
+      Cache-Control:
+      - no-cache, private
+      X-Locale:
+      - en
+      X-Ratelimit-Limit:
+      - '120'
+      X-Ratelimit-Remaining:
+      - '119'
+      Access-Control-Allow-Origin:
+      - "*"
+      Strict-Transport-Security:
+      - max-age=15724800; includeSubDomains
+      Cf-Cache-Status:
+      - DYNAMIC
+      Server:
+      - cloudflare
+      Cf-Ray:
+      - 77e453821df6de47-MCT
+    body:
+      encoding: ASCII-8BIT
+      string: ''
+  recorded_at: Fri, 23 Dec 2022 21:52:45 GMT
+recorded_with: VCR 6.1.0

data/fixtures/webhooks/get.yml

@@ -0,0 +1,58 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://connect.mailerlite.com/api/webhooks/75321551702984317
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      Authorization:
+      - "<AUTH>"
+      User-Agent:
+      - MailerLite-client-ruby/0.1.1
+      Accept:
+      - application/json
+      Content-Type:
+      - application/json
+      Connection:
+      - close
+      Host:
+      - connect.mailerlite.com
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Fri, 23 Dec 2022 21:51:22 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - close
+      Cache-Control:
+      - no-cache, private
+      X-Locale:
+      - en
+      X-Ratelimit-Limit:
+      - '120'
+      X-Ratelimit-Remaining:
+      - '119'
+      Access-Control-Allow-Origin:
+      - "*"
+      Strict-Transport-Security:
+      - max-age=15724800; includeSubDomains
+      Cf-Cache-Status:
+      - DYNAMIC
+      Server:
+      - cloudflare
+      Cf-Ray:
+      - 77e45174ed1fd1f0-MCT
+    body:
+      encoding: UTF-8
+      string: '{"data":{"id":"75321551702984317","name":"test_webhook","url":"http:\/\/foobar.hook","events":["subscriber.created"],"enabled":true,"secret":"pv04URxAE4","created_at":"2022-12-23
+        21:50:29","updated_at":"2022-12-23 21:50:29"}}'
+  recorded_at: Fri, 23 Dec 2022 21:51:21 GMT
+recorded_with: VCR 6.1.0

data/fixtures/webhooks/list.yml

@@ -0,0 +1,61 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://connect.mailerlite.com/api/webhooks
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      Authorization:
+      - "<AUTH>"
+      User-Agent:
+      - MailerLite-client-ruby/0.1.1
+      Accept:
+      - application/json
+      Content-Type:
+      - application/json
+      Connection:
+      - close
+      Host:
+      - connect.mailerlite.com
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Fri, 23 Dec 2022 21:52:21 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - close
+      Cache-Control:
+      - no-cache, private
+      X-Locale:
+      - en
+      X-Ratelimit-Limit:
+      - '120'
+      X-Ratelimit-Remaining:
+      - '116'
+      Access-Control-Allow-Origin:
+      - "*"
+      Strict-Transport-Security:
+      - max-age=15724800; includeSubDomains
+      Cf-Cache-Status:
+      - DYNAMIC
+      Server:
+      - cloudflare
+      Cf-Ray:
+      - 77e452e6ae74de4f-MCT
+    body:
+      encoding: UTF-8
+      string: '{"data":[{"id":"75321640600209302","name":"test_webhook","url":"http:\/\/foobar.hook","events":["subscriber.created"],"enabled":true,"secret":"HigkdhMVbp","created_at":"2022-12-23
+        21:51:54","updated_at":"2022-12-23 21:51:54"},{"id":"75321551702984317","name":"test_webhook","url":"http:\/\/foobar.hook","events":["subscriber.created"],"enabled":true,"secret":"pv04URxAE4","created_at":"2022-12-23
+        21:50:29","updated_at":"2022-12-23 21:50:29"}],"links":{"first":"https:\/\/connect.mailerlite.com\/api\/webhooks?page=1","last":"https:\/\/connect.mailerlite.com\/api\/webhooks?page=1","prev":null,"next":null},"meta":{"current_page":1,"from":1,"last_page":1,"links":[{"url":null,"label":"&laquo;
+        Previous","active":false},{"url":"https:\/\/connect.mailerlite.com\/api\/webhooks?page=1","label":"1","active":true},{"url":null,"label":"Next
+        &raquo;","active":false}],"path":"https:\/\/connect.mailerlite.com\/api\/webhooks","per_page":50,"to":2,"total":2}}'
+  recorded_at: Fri, 23 Dec 2022 21:52:20 GMT
+recorded_with: VCR 6.1.0

data/fixtures/webhooks/update.yml

@@ -0,0 +1,58 @@
+---
+http_interactions:
+- request:
+    method: put
+    uri: https://connect.mailerlite.com/api/webhooks/75233700096247795
+    body:
+      encoding: UTF-8
+      string: '{"name":"test_webhook2"}'
+    headers:
+      Authorization:
+      - "<AUTH>"
+      User-Agent:
+      - MailerLite-client-ruby/0.1.1
+      Accept:
+      - application/json
+      Content-Type:
+      - application/json
+      Connection:
+      - close
+      Host:
+      - connect.mailerlite.com
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Thu, 22 Dec 2022 22:35:04 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - close
+      Cache-Control:
+      - no-cache, private
+      X-Locale:
+      - en
+      X-Ratelimit-Limit:
+      - '120'
+      X-Ratelimit-Remaining:
+      - '117'
+      Access-Control-Allow-Origin:
+      - "*"
+      Strict-Transport-Security:
+      - max-age=15724800; includeSubDomains
+      Cf-Cache-Status:
+      - DYNAMIC
+      Server:
+      - cloudflare
+      Cf-Ray:
+      - 77dc54153eb8d1d8-MCT
+    body:
+      encoding: UTF-8
+      string: '{"data":{"id":"75233700096247795","name":"test_webhook2","url":"http:\/\/foobar.hook","events":["subscriber.created"],"enabled":true,"secret":"Hym6hUN1bO","created_at":"2022-12-22
+        22:34:07","updated_at":"2022-12-22 22:35:04"}}'
+  recorded_at: Thu, 22 Dec 2022 22:35:03 GMT
+recorded_with: VCR 6.1.0

data/lib/mailerlite/automations/automations.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module MailerLite
+  # This is a class for manipulating the Automation from MailerLite API.
+  class Automations
+    attr_reader :client
+
+    # Inits the `Automations` class with the specified `client`.
+    #
+    # @param client [MailerLite::Client] the `Client` instance to use
+    def initialize(client: MailerLite::Client.new)
+      @client = client
+    end
+
+    # Returns a list of Automations that match the specified filter criteria.
+    #
+    # @param filter[:status,:name,:group] [Array] filters for automation
+    # @param limit [Integer] the maximum number of Automations to return
+    # @param page [Integer] the page number of the results to return
+    # @return [HTTP::Response] the response from the API
+    def get(limit: nil, page: nil, filter: {})
+      params = {}
+      params['filter[status]'] = filter[:status] if filter.key?(:status)
+      params['filter[name]'] = filter[:name] if filter.key?(:name)
+      params['filter[group]'] = filter[:group] if filter.key?(:group)
+      params['limit'] = limit if limit
+      params['page'] = page if page
+      uri = URI("#{API_URL}/automations")
+      uri.query = URI.encode_www_form(params.compact)
+      client.http.get(uri)
+    end
+
+    # fetch the specified Automation
+    #
+    # @param automation_id [String] the ID of the Automation to fetch
+    # @return [HTTP::Response] the response from the API
+    def fetch(automation_id)
+      client.http.get("#{API_URL}/automations/#{automation_id}")
+    end
+
+    # get_subscriber_activity the subscriber activity for specified Automation
+    #
+    # @param automation_id [Integer] the ID of the Automation to get_subscriber_activity
+    # @param filter[:status,:date_from,:date_to,:scheduled_from,:scheduled_to,:keyword] [Array] Must be one of the following: completed, active, canceled, failed
+    # @param limit [Integer] the maximum number of Automations to return
+    # @param page [Integer] the page number of the results to return
+    # @return [HTTP::Response] the response from the API
+    def get_subscriber_activity(automation_id:, filter: {}, page: nil, limit: nil)
+      params = { 'filter[status]' => filter[:status] }
+      params['filter[date_from]'] = filter[:date_from] if filter.key?(:date_from)
+      params['filter[date_to]'] = filter[:date_to] if filter.key?(:date_to)
+      params['filter[scheduled_from]'] = filter[:scheduled_from] if filter.key?(:scheduled_from)
+      params['filter[scheduled_to]'] = filter[:scheduled_to] if filter.key?(:scheduled_to)
+      params['filter[keyword]'] = filter[:keyword] if filter.key?(:keyword)
+      params['page'] = page if page
+      params['limit'] = limit if limit
+      uri = URI("#{API_URL}/automations/#{automation_id}/activity")
+      uri.query = URI.encode_www_form(params.compact)
+      client.http.get(uri)
+    end
+  end
+end

data/lib/mailerlite/batch/batch.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module MailerLite
+  # This is a class for manipulating the Batch from MailerLite API.
+  class Batch
+    attr_reader :client
+
+    # Inits the `Batch` class with the specified `client`.
+    #
+    # @param client [MailerLite::Client] the `Client` instance to use
+    def initialize(client: MailerLite::Client.new)
+      @client = client
+    end
+
+    # Create a Batch Request
+    #
+    # @param requests [Array] Array of objects containing required method and path properties and optional body
+    # @return [HTTP::Response] the response from the API
+    def request(requests:)
+      params = { requests: requests }
+      client.http.post("#{API_URL}/batch", body: params.to_json)
+    end
+  end
+end

data/lib/mailerlite/campaigns/campaigns.rb

@@ -0,0 +1,216 @@
+# frozen_string_literal: true
+
+module MailerLite
+  # This is a class for manipulating the Campaigns from MailerLite API.
+  class Campaigns
+    attr_reader :client
+
+    # Inits the `Campaigns` class with the specified `client`.
+    #
+    # @param client [MailerLite::Client] the `Client` instance to use
+    def initialize(client: MailerLite::Client.new)
+      @client = client
+    end
+
+    # Returns a list of Campaigns that match the specified filter criteria.
+    #
+    # @param filter[:status,:type] [String] the status of the Campaigns to include in the results, must be one of [sent, draft, ready], Defaults to ready.
+    # The filter type of the Campaigns to include in the results, must be one of [regular, ab, resend, rss], Defaults to all
+    # @param limit [Integer] the maximum number of Campaigns to return
+    # @param page [Integer] the page number of the results to return
+    # @return [HTTP::Response] the response from the API
+    def get(filter:, limit: nil, page: nil)
+      params = { 'filter[status]' => filter[:status] }
+      params['filter[type]'] = filter[:type] if filter.key?(:type)
+      params['limit'] = limit if limit
+      params['page'] = page if page
+      uri = URI("#{API_URL}/campaigns")
+      uri.query = URI.encode_www_form(params.compact)
+      client.http.get(uri)
+    end
+
+    # Creates a new campaign with the specified details.
+    #
+    # @param name [String] Maximum string length of 255 characters
+    # @param language_id [integer] Used to define the language in the unsubscribe template. Must be a valid language id. Defaults to english
+    # @param type [String] Must be one of the following: regular, ab, resend. Type resend is only available for accounts on growing or advanced plans
+    # @param emails [Array] Must contain 1 email object item
+    # @param groups [Array] Must contain valid group ids belonging to the account
+    # @param segments [Array] Must contain valid segment ids belonging to the account. If both groups and segments are provided, only segments are used
+    # @param ab_settings [Array<Array>] only if type is ab -  All items of the array are required
+    # @param resend_settings [:test_type,:select_winner_by,:b_value] https://developers.mailerlite.com/docs/campaigns.html#create-a-campaign
+    # @return [HTTP::Response] the response from the API
+    def create(name:, type:, emails:, language_id: nil, groups: nil, segments: nil, ab_settings: nil, resend_settings: nil)
+      params = { 'name' => name }
+      params['type'] = type
+      params['emails'] = emails
+      params['language_id'] = language_id if language_id
+      params['groups'] = groups if groups
+      params['segments'] = segments if segments
+      case type
+      when 'ab'
+        params['ab_settings'] = {
+          test_type: ab_settings[:test_type],
+          select_winner_by: ab_settings[:select_winner_by],
+          after_time_amount: ab_settings[:after_time_amount],
+          after_time_unit: ab_settings[:after_time_unit],
+          test_split: ab_settings[:test_split]
+        }
+        case ab_settings[:test_type]
+        when 'subject'
+          params['ab_settings']['b_value'] = {
+            subject: ab_settings[:b_value][:subject]
+          }
+
+        when 'sender'
+          params['ab_settings']['b_value'] = {
+            from_name: ab_settings[:b_value][:from_name],
+            from: ab_settings[:b_value][:from]
+          }
+        end
+      when 'resend'
+        params['resend_settings'] = {
+          test_type: resend_settings[:test_type],
+          select_winner_by: resend_settings[:select_winner_by],
+          b_value: {
+            subject: resend_settings[:b_value][:subject]
+          }
+        }
+      end
+
+      client.http.post("#{API_URL}/campaigns", body: params.compact.to_json)
+    end
+
+    # Update a new campaign with the specified details.
+    #
+    # @param campaign_id [Integer] the ID of the campaign to update
+    # @param name [String] Maximum string length of 255 characters
+    # @param language_id [integer] Used to define the language in the unsubscribe template. Must be a valid language id. Defaults to english
+    # @param type [String] Must be one of the following: regular, ab, resend. Type resend is only available for accounts on growing or advanced plans
+    # @param emails [Array<Array>] Must contain 1 email object item
+    # @param groups [Array] Must contain valid group ids belonging to the account
+    # @param segments [Array] Must contain valid segment ids belonging to the account. If both groups and segments are provided, only segments are used
+    # @param ab_settings [Array<Array>] only if type is ab -  All items of the array are required
+    # @param resend_settings [:test_type,:select_winner_by,:b_value] https://developers.mailerlite.com/docs/campaigns.html#update-campaign
+    # @return [HTTP::Response] the response from the API
+    def update(campaign_id:, name:, type:, emails:, language_id: nil, groups: nil, segments: nil, ab_settings: nil, resend_settings: nil)
+      params = { 'name' => name }
+      params['emails'] = emails
+      params['language_id'] = language_id if language_id
+      params['groups'] = groups if groups
+      params['segments'] = segments if segments
+      case type
+      when 'ab'
+        params['ab_settings'] = {
+          test_type: ab_settings[:test_type],
+          select_winner_by: ab_settings[:select_winner_by],
+          after_time_amount: ab_settings[:after_time_amount],
+          after_time_unit: ab_settings[:after_time_unit],
+          test_split: ab_settings[:test_split]
+        }
+        case ab_settings[:test_type]
+        when 'subject'
+          params['ab_settings']['b_value'] = {
+            subject: ab_settings[:b_value][:subject]
+          }
+
+        when 'sender'
+          params['ab_settings']['b_value'] = {
+            from_name: ab_settings[:b_value][:from_name],
+            from: ab_settings[:b_value][:from]
+          }
+
+        end
+      when 'resend'
+        params['resend_settings'] = {
+          test_type: resend_settings[:test_type],
+          select_winner_by: resend_settings[:select_winner_by],
+          b_value: {
+            subject: resend_settings[:b_value][:subject]
+          }
+        }
+
+      end
+
+      client.http.put("#{API_URL}/campaigns/#{campaign_id}", body: params.compact.to_json)
+    end
+
+    # Schedules the specified campaign.
+    #
+    # @param campaign_id [Integer] the ID of the campaign to schedule
+    # @param delivery	[String]	yes unless campaign type is rss	Must be one of the following: instant, scheduled, timezone_based
+    # @param schedule[:date,:hours,:minutes,:timezone_id]	[Array]	campaign schedule
+    # @param resend[:delivery,:date,:hours,:minutes,:timezone_id]	[String]	resend settings
+    #        https://developers.mailerlite.com/docs/campaigns.html#schedule-a-campaign
+    # @return [HTTP::Response] the response from the API
+    def schedule(campaign_id:, delivery:, schedule: nil, resend: nil)
+      params = {}
+      params['delivery'] = delivery if delivery
+      if %w[scheduled timezone_based].include?(delivery) && schedule
+        params['schedule'] = {}
+        params['schedule']['date'] = schedule[:date] if (delivery == 'scheduled') && schedule.key?(:date)
+        params['schedule']['hours'] = schedule[:hours] if schedule.key?(:hours)
+        params['schedule']['minutes'] = schedule[:minutes] if schedule.key?(:minutes)
+        params['schedule']['timezone_id'] = schedule[:timezone_id] if schedule.key?(:timezone_id)
+      end
+      params['resend'] = {} if resend
+      params['resend']['delivery'] = resend[:delivery] if resend&.key?(:delivery)
+      params['resend']['date'] = resend[:date] if resend&.key?(:date)
+      params['resend']['hours'] = resend[:hours] if resend&.key?(:hours)
+      params['resend']['minutes'] = resend[:minutes] if resend&.key?(:minutes)
+      params['resend']['timezone_id'] = resend[:timezone_id] if resend&.key?(:timezone_id)
+
+      client.http.post("#{API_URL}/campaigns/#{campaign_id}/schedule", body: params.compact.to_json)
+    end
+
+    # Returns the details of the specified Campaigns
+    #
+    # @param campaign_id [String] the ID of the campaign to fetch
+    # @return [HTTP::Response] the response from the API
+    def fetch(campaign_id)
+      client.http.get("#{API_URL}/campaigns/#{campaign_id}")
+    end
+
+    # Cancels the specified campaign.
+    #
+    # @param campaign_id [String] the ID of the campaign to delete
+    # @return [HTTP::Response] the response from the API
+    def cancel(campaign_id)
+      client.http.post("#{API_URL}/campaigns/#{campaign_id}/cancel")
+    end
+
+    # Deletes the specified campaign.
+    #
+    # @param campaign_id [String] the ID of the campaign to delete
+    # @return [HTTP::Response] the response from the API
+    def delete(campaign_id)
+      client.http.delete("#{API_URL}/campaigns/#{campaign_id}")
+    end
+
+    # activity the subscriber activity for specified campaign
+    #
+    # @param campaign_id [Integer] the ID of the campaign to activity
+    # @param filter[:type,:search] [String] specify filters
+    # @param limit [Integer] the maximum number of campaigns to return
+    # @param page [Integer] the page number of the results to return
+    #        https://developers.mailerlite.com/docs/campaigns.html#get-subscribers-activity-of-a-sent-campaign
+    # @return [HTTP::Response] the response from the API
+    def activity(campaign_id:, filter: nil, page: nil, limit: nil, sort: nil)
+      params = {}
+      params['filter'] = {} if filter
+      params['filter']['type'] = filter[:type] if filter.key?(:type)
+      params['filter']['search'] = filter[:search] if filter.key?(:search)
+      params['page'] = page if page
+      params['limit'] = limit if limit
+      params['sort'] = sort if sort
+      client.http.post("#{API_URL}/campaigns/#{campaign_id}/reports/subscriber-activity", body: params.compact.to_json)
+    end
+
+    # Get a list of all campaign languages available
+    #
+    # @return [HTTP::Response] the response from the API
+    def languages
+      client.http.get("#{API_URL}/campaigns/languages")
+    end
+  end
+end

data/lib/mailerlite/client.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'http'
+require 'dotenv/load'
+
+API_URL = 'https://connect.mailerlite.com/api'
+
+Dotenv.require_keys('MAILERLITE_API_TOKEN')
+
+# mailerlite-ruby is a gem that integrates all endpoints from MailerLite API
+module MailerLite
+  attr_reader :api_token
+
+  # Inits the client.
+  class Client
+    def initialize(api_token = ENV.fetch('MAILERLITE_API_TOKEN', nil))
+      @api_token = api_token
+    end
+
+    def headers
+      {
+        'User-Agent' => "MailerLite-client-ruby/#{MailerLite::VERSION}",
+        'Accept' => 'application/json',
+        'Content-type' => 'application/json'
+      }
+    end
+
+    def http
+      HTTP
+        .timeout(connect: 15, read: 30)
+        .auth("Bearer #{@api_token}")
+        .headers(headers)
+    end
+  end
+end