mailersend-ruby 0.2.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1130525f8f2ea4df2038ccb1908e3265acb93a7538482cd4b9b9b78ad90a4a3
-  data.tar.gz: e024cab7481bd43dd8af528d582d20dad811e2df7c101b95fc4873cbc97889ce
+  metadata.gz: 42f9a5e46d23e87c1624883d5bdff3c8979885245ee2efb9a6d60b2d51f2598b
+  data.tar.gz: 47db5c300727257e6c3a96e1a65bd4bd8e285948e01c83e74d02439310343b83
 SHA512:
-  metadata.gz: 275e9f001aab7aa838b1f3bc159887c3d80b83f250dcbc23e564a4b1334f1583aa4f4db7d8841b1335af5e24d10d8b0b768ad19dba7da21e4d2cc52b192b91b1
-  data.tar.gz: a1b30ef5befce3517a49cf62891dd46adfacd7c711f1b98815525cc70cd658cfda71150531a441a910c471c9996b5de42bd22b0b6a142422166c4a2ba8f9bf46
+  metadata.gz: 7a82321fba8995153b7288d3cde80c1b420c4f4fb5a3eab0fbd6ec341272b406fe7b198961bf3292db9b7b41a23486487db308f596a27c3dad4b4b15801044ae
+  data.tar.gz: 82ae19286af3357b4102c05afeabed5efb8b99127ad5443d09c8ce43f20b245268856ccc55b59e896e23d9e2f377a731b7b1c605a8cfd200b5ab8976feeb0beb

data/.env.example

@@ -1 +1 @@
-API_TOKEN="superlongkey"
+MAILERSEND_API_TOKEN="superlongkey"

data/.github/workflows/publish_gem.yml

@@ -0,0 +1,21 @@
+name: Publish Gem
+
+on:
+  push:
+    tags:
+      - v*
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Release Gem
+        if: contains(github.ref, 'refs/tags/v')
+        uses: cadwallion/publish-rubygems-action@master
+        env:
+          GITHUB_TOKEN: ${{secrets.GITHUBTOKEN}}
+          RUBYGEMS_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}
+          RELEASE_COMMAND: rake release
+          

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 ## [Released]
 
+## [1.0.0] - 2022-02-15
+
+- BREAKING CHANGE: Renamed `API_TOKEN` variable to `MAILERSEND_API_TOKEN`
+
+## [0.2.4] - 2021-12-13
+
+- Added bulk email endpoint
+
+# [0.2.3] - 2021-11-11
+
+- Fixed typo for reply_to (thanks @JohnGoodman)
+
 ## [0.2.2] - 2021-08-04
 
 - Removed leftover debugging stuff
@@ -24,6 +36,7 @@
 
 - Added required parameter for token creation
 -
+
 ## [0.1.6] - 2021-06-15
 
 - Fixed small issues in Domains

data/README.md

@@ -11,12 +11,15 @@ MailerSend Ruby SDK
     - [Send an email](#send-an-email)
     - [Add CC, BCC recipients](#add-cc-bcc-recipients)
     - [Send a template-based email](#send-a-template-based-email)
+    - [Advanced personalization](#advanced-personalization)
+    - [Simple personalization](#simple-personalization)
+  - [Bulk Email](#bulk-email)
+    - [Send bulk email](#send-bulk-email)
+    - [Get bulk email status](#get-bulk-email-status)
   - [Tokens](#tokens)
     - [Create a token](#create-a-token)
     - [Update a token](#update-a-token)
     - [Delete a token](#delete-a-token)
-    - [Advanced personalization](#advanced-personalization)
-    - [Simple personalization](#simple-personalization)
     - [Send email with attachment](#send-email-with-attachment)
   - [Activity](#activity)
     - [Get a list of activities](#get-a-list-of-activities)
@@ -29,6 +32,7 @@ MailerSend Ruby SDK
     - [Get a list of domains](#get-a-list-of-domains)
     - [Get a single domain](#get-a-single-domain)
     - [Delete a domain](#delete-a-domain)
+    - [Get recipients for a domain](#get-recipients-for-a-domain)
     - [Update domain settings](#update-domain-settings)
   - [Messages](#messages)
     - [Get a list of messages](#get-a-list-of-messages)
@@ -37,6 +41,10 @@ MailerSend Ruby SDK
     - [Get recipients](#get-recipients)
     - [Get a single recipient](#get-a-single-recipient)
     - [Delete a recipient](#delete-a-recipient)
+  - [Suppressions](#suppressions)
+    - [Get recipients from a suppression list](#get-recipients-from-a-suppression-list)
+    - [Add recipients to a suppression list](#add-recipients-to-a-suppression-list)
+    - [Delete recipients from a suppression list](#delete-recipients-from-a-suppression-list)
   - [Webhooks](#webhooks)
     - [List webhooks](#list-webhooks)
     - [Get a webhook](#get-a-webhook)
@@ -62,7 +70,7 @@ You will have to initalize it in your Ruby file with `require "mailersend-ruby"`
 
 # Usage
 
-This SDK requires that you either have `.env` file with `API_TOKEN` env variable or that your variable is enabled system wide (useful for Docker/Kubernetes). The example of how `API_TOKEN` should look like is in `.env.example`.
+This SDK requires that you either have `.env` file with `MAILERSEND_API_TOKEN` env variable or that your variable is enabled system wide (useful for Docker/Kubernetes). The example of how `MAILERSEND_API_TOKEN` should look like is in `.env.example`.
 
 ## Email
 
@@ -127,32 +135,6 @@ ms_email.add_template_id(12415125)
 ms_email.send
 ```
 
-## Tokens
-
-### Create a token
-```ruby
-require "mailersend-ruby"
-
-ms_tokens = Mailersend::Tokens.new
-ms_tokens.create(name: "Very nice token", scopes: %w[ email_full domains_read ], domain_id: "yourdomainid")
-```
-
-### Update a token
-```ruby
-require "mailersend-ruby"
-
-ms_tokens = Mailersend::Tokens.new
-ms_tokens.update(token_id: "d2220fx04", status: "paused")
-```
-
-### Delete a token
-```ruby
-require "mailersend-ruby"
-
-ms_tokens = Mailersend::Tokens.new
-ms_tokens.delete(token_id: "d2220fx04")
-```
-
 ### Advanced personalization
 
 ```ruby
@@ -210,6 +192,68 @@ ms_email.add_variables(variables)
 ms_email.send
 ```
 
+## Bulk Email
+
+### Send bulk email
+```ruby
+require "mailersend-ruby"
+
+ms_bulk_email = Mailersend::BulkEmail.new
+
+ms_bulk_email.messages = [
+    {
+        'from' => {"email" => "april@parksandrec.com", "name" => "April"},
+        'to' => [{"email" => "ron@parksandrec.com", "name" => "Ron"}],
+        'subject' => "Time",
+        'text' => "Time is money, money is power, power is pizza, and pizza is knowledge. Let's go.",
+        'html' => "<b>Time is money, money is power, power is pizza, and pizza is knowledge. Let's go.</b>",
+      },
+      {
+        'from' => {"email" => "april@parksandrec.com", "name" => "April"},
+        'to' => [{"email" => "leslie@parksandrec.com", "name" => "Leslie"}],
+        'subject' => "Lorem Ipsum",
+        'text' => "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
+        'html' => "<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit.</p>",
+      }
+]
+
+ms_bulk_email.send
+```
+
+### Get bulk email status
+```ruby
+require "mailersend-ruby"
+
+ms_bulk_email = Mailersend::BulkEmail.new
+ms_bulk_email.get_bulk_status(bulk_email_id: 'yourbulkemailid')
+```
+
+## Tokens
+
+### Create a token
+```ruby
+require "mailersend-ruby"
+
+ms_tokens = Mailersend::Tokens.new
+ms_tokens.create(name: "Very nice token", scopes: %w[ email_full domains_read ], domain_id: "yourdomainid")
+```
+
+### Update a token
+```ruby
+require "mailersend-ruby"
+
+ms_tokens = Mailersend::Tokens.new
+ms_tokens.update(token_id: "d2220fx04", status: "paused")
+```
+
+### Delete a token
+```ruby
+require "mailersend-ruby"
+
+ms_tokens = Mailersend::Tokens.new
+ms_tokens.delete(token_id: "d2220fx04")
+```
+
 ### Send email with attachment
 
 ```ruby
@@ -313,6 +357,15 @@ ms_domains = Mailersend::Domains.new
 ms_domains.delete(domain_id: "idofdomain12412")
 ```
 
+### Get recipients for a domain
+
+```ruby
+require "mailersend-ruby"
+
+ms_domains = Mailersend::Domains.new
+ms_domains.recipients(domain_id: "idofdomain12412")
+```
+
 ### Update domain settings
 
 ```ruby
@@ -371,6 +424,71 @@ ms_recipients = Mailersend::Recipients.new
 ms_recipients.delete(recipient_id: "id124")
 ```
 
+## Suppressions
+
+### Get recipients from a suppression list
+
+```ruby
+require "mailersend-ruby"
+
+ms_suppressions = Mailersend::Suppressions.new
+
+// List from Blocklist 
+ms_suppressions.get_from_blocklist(domain_id: "xxx2241ll")
+
+// List from Hard Bounces
+ms_suppressions.get_hard_bounces(domain_id: "xxx2241ll")
+
+// List from Spam Complaints
+ms_suppressions.get_spam_complaints(domain_id: "xxx2241ll")
+
+// List from Unsubscribers
+ms_suppressions.get_unsubscribes(domain_id: "xxx2241ll")
+```
+
+### Add recipients to a suppression list
+
+```ruby
+require "mailersend-ruby"
+
+ms_suppressions = Mailersend::Suppressions.new
+
+// Add Recipient to Block List using recipients
+ms_suppressions.add_to_blocklist(domain_id: "xxx2241ll", recipients: ["blocked@client.com"])
+
+// Add Recipient to Block List using patterns
+ms_suppressions.add_to_blocklist(domain_id: "xxx2241ll", patterns: ["*@client.com"])
+
+// Add Recipient to Hard Bounces
+ms_suppressions.add_to_hard_bounces(domain_id: "xxx2241ll", recipients: ["bounced@client.com"])
+
+// Add Recipient to Spam Complaints
+ms_suppressions.add_to_spam_complaints(domain_id: "xxx2241ll", recipients: ["bounced@client.com"])
+
+// Add Recipient to Unsubscribes
+ms_suppressions.add_to_unsubscribers(domain_id: "xxx2241ll", recipients: ["bounced@client.com"])
+```
+
+### Delete recipients from a suppression list
+
+```ruby
+require "mailersend-ruby"
+
+ms_suppressions = Mailersend::Suppressions.new
+
+// Delete from Block List
+ms_suppressions.delete_from_blocklist(domain_id: 'yourdomainid', ids: ["xxx2241ll"])
+
+// Delete from Hard Bounces
+ms_suppressions.delete_from_hard_bounces(domain_id: 'yourdomainid', ids: ["xxx2241ll"])
+
+// Delete from Spam Complaints
+ms_suppressions.delete_from_spam_complaints(domain_id: 'yourdomainid', ids: ["xxx2241ll"])
+
+// Delete from Unsubscribes
+ms_suppressions.delete_from_unsubscribers(domain_id: 'yourdomainid', ids: ["xxx2241ll"])
+```
+
 ## Webhooks
 
 ### List webhooks

data/lib/mailersend/bulk_email/bulk_email.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'base64'
+
+module Mailersend
+  # Send an email through MailerSend API
+  class BulkEmail
+    attr_accessor :client,
+                  :messages
+
+    def initialize(client = Mailersend::Client.new)
+      @client = client
+      @messages = []
+    end
+
+    def add_attachment(content:, filename:)
+      data = File.read(content.to_s)
+      encoded = Base64.strict_encode64(data)
+      @attachments << {
+        'content' => encoded,
+        'filename' => filename
+      }
+    end
+
+    def send
+      response = client.http.post("#{API_URL}/bulk-email", json: @messages)
+      puts response
+      puts response.status.code
+    end
+
+    def get_bulk_status(bulk_email_id:)
+      response = client.http.get(URI::HTTPS.build(host: API_BASE_HOST, path: "/v1/bulk-email/#{bulk_email_id}"))
+      puts response
+    end
+  end
+end

data/lib/mailersend/client.rb

@@ -6,7 +6,7 @@ require 'dotenv/load'
 API_URL = 'https://api.mailersend.com/v1'
 API_BASE_HOST = 'api.mailersend.com'
 
-Dotenv.require_keys('API_TOKEN')
+Dotenv.require_keys('MAILERSEND_API_TOKEN')
 
 # mailersend-ruby is a gem that integrates all endpoints from MailerSend API
 module Mailersend
@@ -14,7 +14,7 @@ module Mailersend
 
   # Inits the client.
   class Client
-    def initialize(api_token = ENV['API_TOKEN'])
+    def initialize(api_token = ENV['MAILERSEND_API_TOKEN'])
       @api_token = api_token
     end
 

data/lib/mailersend/email/email.rb

@@ -52,8 +52,8 @@ module Mailersend
       @bcc << bcc
     end
 
-    def add_reply_to(_reply_to)
-      @reply_to = reply to
+    def add_reply_to(reply_to)
+      @reply_to = reply_to
     end
 
     def add_subject(subject)
@@ -85,7 +85,7 @@ module Mailersend
     end
 
     def add_attachment(content:, filename:)
-      data = File.open(content.to_s).read
+      data = File.read(content.to_s)
       encoded = Base64.strict_encode64(data)
       @attachments << {
         'content' => encoded,

data/lib/mailersend/suppressions/suppressions.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+module Mailersend
+  # Suppressions endpoint from MailerSend API.
+  class Suppressions
+    attr_accessor :client,
+                  :page,
+                  :limit,
+                  :recipient_id
+
+    def initialize(client = Mailersend::Client.new)
+      @client = client
+      @page = page
+      @limit = limit
+      @recipient_id = recipient_id
+    end
+
+    def get_from_blocklist(*)
+      response = client.http.get("#{API_URL}/suppressions/blocklist")
+      puts response
+    end
+
+    def get_hard_bounces(*)
+      response = client.http.get("#{API_URL}/suppressions/hard-bounces")
+      puts response
+    end
+
+    def get_spam_complaints(*)
+      response = client.http.get("#{API_URL}/suppressions/spam-complaints")
+      puts response
+    end
+
+    def get_unsubscribes(*)
+      response = client.http.get("#{API_URL}/suppressions/unsubscribes")
+      puts response
+    end
+
+    def add_to_blocklist(recipients: nil, patterns: nil)
+      hash = {
+        'recipients' => recipients,
+        'patterns' => patterns
+      }
+      response = client.http.post("#{API_URL}/suppressions/blocklist", json: hash.compact)
+      puts response
+    end
+
+    def delete_from_blocklist(domain_id: nil, ids: nil, all: nil)
+      hash = {
+        'domain_id' => domain_id,
+        'ids' => ids,
+        'all' => all
+      }
+      response = client.http.delete("#{API_URL}/suppressions/blocklist", json: hash.compact)
+      puts response
+    end
+
+    def add_to_hard_bounces(domain_id: nil, recipients: nil)
+      hash = {
+        'domain_id' => domain_id,
+        'recipients' => recipients
+      }
+      response = client.http.post("#{API_URL}/suppressions/hard-bounces", json: hash.compact)
+      puts response
+    end
+
+    def delete_from_hard_bounces(domain_id: nil, ids: nil, all: nil)
+      hash = {
+        'domain_id' => domain_id,
+        'ids' => ids,
+        'all' => all
+      }
+      response = client.http.delete("#{API_URL}/suppressions/hard-bounces", json: hash.compact)
+      puts response
+    end
+
+    def add_to_spam_complaints(domain_id: nil, recipients: nil)
+      hash = {
+        'domain_id' => domain_id,
+        'recipients' => recipients
+      }
+      response = client.http.post("#{API_URL}/suppressions/spam-complaints", json: hash.compact)
+      puts response
+    end
+
+    def delete_from_spam_complaints(domain_id: nil, ids: nil, all: nil)
+      hash = {
+        'domain_id' => domain_id,
+        'ids' => ids,
+        'all' => all
+      }
+      response = client.http.delete("#{API_URL}/suppressions/spam-complaints", json: hash.compact)
+      puts response
+    end
+
+    def add_to_unsubscribers(domain_id: nil, recipients: nil)
+      hash = {
+        'domain_id' => domain_id,
+        'recipients' => recipients
+      }
+      response = client.http.post("#{API_URL}/suppressions/unsubscribes", json: hash.compact)
+      puts response
+    end
+
+    def delete_from_unsubscribers(domain_id: nil, ids: nil, all: nil)
+      hash = {
+        'domain_id' => domain_id,
+        'ids' => ids,
+        'all' => all
+      }
+      response = client.http.delete("#{API_URL}/suppressions/unsubscribes", json: hash.compact)
+      puts response
+    end
+  end
+end

data/lib/mailersend/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Mailersend
-  VERSION = '0.2.2'
+  VERSION = '1.0.0'
 end

data/lib/mailersend.rb

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
-require 'mailersend/client'
-require 'mailersend/activity/activity'
-require 'mailersend/analytics/analytics'
-require 'mailersend/domains/domains'
-require 'mailersend/email/email'
-require 'mailersend/messages/messages'
-require 'mailersend/recipients/recipients'
-require 'mailersend/templates/templates'
-require 'mailersend/tokens/tokens'
-require 'mailersend/webhooks/webhooks'
+require_relative 'mailersend/client'
+require_relative 'mailersend/activity/activity'
+require_relative 'mailersend/analytics/analytics'
+require_relative 'mailersend/bulk_email/bulk_email'
+require_relative 'mailersend/domains/domains'
+require_relative 'mailersend/email/email'
+require_relative 'mailersend/messages/messages'
+require_relative 'mailersend/recipients/recipients'
+require_relative 'mailersend/suppressions/suppressions'
+require_relative 'mailersend/templates/templates'
+require_relative 'mailersend/tokens/tokens'
+require_relative 'mailersend/webhooks/webhooks'

data/mailersend-ruby.gemspec

@@ -21,12 +21,13 @@ Gem::Specification.new do |spec|
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/mailersend/mailersend-ruby'
   spec.metadata['changelog_uri'] = 'https://github.com/mailersend/mailersend-ruby/blob/main/CHANGELOG.md'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 
   spec.files = `git ls-files -z`.split("\x0")
   spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 2.2.15'
+  spec.add_development_dependency 'bundler', '~> 2.3.4'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rubocop', '~> 1.7'
   spec.add_dependency 'dotenv', '~> 2.7'

data/renovate.json

@@ -0,0 +1,5 @@
+{
+  "extends": [
+    "config:base"
+  ]
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailersend-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Nikola Milojević
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-04 00:00:00.000000000 Z
+date: 2022-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.15
+        version: 2.3.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.15
+        version: 2.3.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -120,6 +120,7 @@ extra_rdoc_files: []
 files:
 - ".env.example"
 - ".github/workflows/main.yml"
+- ".github/workflows/publish_gem.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - CHANGELOG.md
@@ -133,16 +134,19 @@ files:
 - lib/mailersend.rb
 - lib/mailersend/activity/activity.rb
 - lib/mailersend/analytics/analytics.rb
+- lib/mailersend/bulk_email/bulk_email.rb
 - lib/mailersend/client.rb
 - lib/mailersend/domains/domains.rb
 - lib/mailersend/email/email.rb
 - lib/mailersend/messages/messages.rb
 - lib/mailersend/recipients/recipients.rb
+- lib/mailersend/suppressions/suppressions.rb
 - lib/mailersend/templates/templates.rb
 - lib/mailersend/tokens/tokens.rb
 - lib/mailersend/version.rb
 - lib/mailersend/webhooks/webhooks.rb
 - mailersend-ruby.gemspec
+- renovate.json
 homepage: https://www.mailersend.com
 licenses:
 - MIT
@@ -151,7 +155,8 @@ metadata:
   homepage_uri: https://www.mailersend.com
   source_code_uri: https://github.com/mailersend/mailersend-ruby
   changelog_uri: https://github.com/mailersend/mailersend-ruby/blob/main/CHANGELOG.md
-post_install_message:
+  rubygems_mfa_required: 'true'
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -166,8 +171,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
-signing_key:
+rubygems_version: 3.3.3
+signing_key: 
 specification_version: 4
 summary: MailerSend's official Ruby SDK
 test_files: []