mailersend-ruby 1.6.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51974d7d8584e99e7d3913249f949e05e5aacbc8db3732b166a16baf7b8313dd
-  data.tar.gz: 7634d9b0a6a9463961e425b1c67c8a5df2668dd202c06a2eee043201be42ec38
+  metadata.gz: 8d2a5a259ed13eecd19d5155d1f855449a03748539e621984630bf3ebc7a6777
+  data.tar.gz: ad67464ced57219f06f890506ed84bd20971bf718e50ec747c8a071982cc70b8
 SHA512:
-  metadata.gz: 2fb335aa0e07bfb4836571f956abc8d0505e1f397ca003da6792fc488a9bbfd3bd71c6578a338ceb49920bd72e4baf58b0eed70d8bca4e07c3aeb23cb216b74b
-  data.tar.gz: 16c0baec523c402acb12b54a9217d052e5e2104a975a781a803cfe392b737bd9b1e016ce807f3387eab243139bcade197e9b8a6b53ffe390162f8d004c96170f
+  metadata.gz: d5f71355c8b3e35019be782a786939f5ba17a1b5af48df4e45062e767d5c0e378d2577ee80208969feb252d7024e3568a2f7dde03dc14b748441a9f7081f7335
+  data.tar.gz: 03dab0c147d37a97bb5b61c5f02002e0e539a540f24655e1a1e4280646e42f252ccd071b0dcc54c2cab44205539b6e8268010ae4dea36b527e3c55728174b41d

data/.github/workflows/main.yml

@@ -6,11 +6,18 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
+
     - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
+      uses: actions/setup-ruby@v1
       with:
         ruby-version: 3.0
-        bundler-cache: true
+
+    - name: Install Bundler
+      run: gem install bundler -v 2.4.22
+
+    - name: Install dependencies
+      run: bundle _2.4.22_ install
+
     - name: Run the default task
       run: bundle exec rake

data/.github/workflows/publish_gem.yml

@@ -9,7 +9,18 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: 3.0
+
+      - name: Install Bundler
+        run: gem install bundler -v 2.4.22
+
+      - name: Install dependencies
+        run: bundle _2.4.22_ install
 
       - name: Release Gem
         if: contains(github.ref, 'refs/tags/v')

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Released]
 
+## [2.0.1] - 2023-01-08
+
+- Simple personalization removed
+
+## [2.0.0] - 2023-12-18
+
+- *BREAKING CHANGE* - Please check the README file, MailerSend API token is now defined inside your application.
+
 ## [1.6.0] - 2023-06-22
 
 - Sender identities by email

data/Gemfile

@@ -4,7 +4,7 @@ source 'https://rubygems.org'
 gemspec
 
 group :development do
-  gem 'bundler', '~> 2.4.10'
-  gem 'rake', '~> 13.0.6'
-  gem 'rubocop', '~> 1.52.1'
+  gem 'bundler', '~> 2.4.22'
+  gem 'rake', '~> 13.0'
+  gem 'rubocop', '~> 1.7'
 end

data/README.md

@@ -12,7 +12,6 @@ MailerSend Ruby SDK
     - [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)
@@ -126,10 +125,6 @@ gem install mailersend-ruby
 
 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 `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
 
 ### Send an email
@@ -137,8 +132,10 @@ This SDK requires that you either have `.env` file with `MAILERSEND_API_TOKEN` e
 ```ruby
 require "mailersend-ruby"
 
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
 # Intialize the email class
-ms_email = Mailersend::Email.new
+ms_email = Mailersend::Email.new(ms_client)
 
 # Add parameters
 ms_email.add_recipients("email" => "ron@parksandrec.com", "name" => "Ron")
@@ -157,8 +154,10 @@ ms_email.send
 ```ruby
 require "mailersend-ruby"
 
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
 # Intialize the email class
-ms_email = Mailersend::Email.new
+ms_email = Mailersend::Email.new(ms_client)
 
 # Add parameters
 ms_email.add_recipients("email" => "ron@parksandrec.com", "name" => "Ron")
@@ -179,8 +178,10 @@ ms_email.send
 ```ruby
 require "mailersend-ruby"
 
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
 # Intialize the email class
-ms_email = Mailersend::Email.new
+ms_email = Mailersend::Email.new(ms_client)
 
 # Add parameters
 ms_email.add_recipients("email" => "ron@parksandrec.com", "name" => "Ron")
@@ -198,8 +199,10 @@ ms_email.send
 ```ruby
 require "mailersend-ruby"
 
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
 # Intialize the email class
-ms_email = Mailersend::Email.new
+ms_email = Mailersend::Email.new(ms_client)
 
 # Add parameters
 ms_email.add_recipients("email" => "ron@parksandrec.com", "name" => "Ron")
@@ -220,43 +223,15 @@ ms_email.add_personalization(personalization)
 ms_email.send
 ```
 
-### Simple personalization
-
-```ruby
-require "mailersend-ruby"
-
-# Intialize the email class
-ms_email = Mailersend::Email.new
-
-# Add parameters
-ms_email.add_recipients("email" => "ron@parksandrec.com", "name" => "Ron")
-ms_email.add_from("email" => "april@parksandrec.com", "name" => "April")
-ms_email.add_subject("Time {$test}")
-ms_email.add_text("{$test} Time is money, money is power, power is pizza, and pizza is knowledge. Let's go.")
-ms_email.add_html("<b>{$test} Time is money, money is power, power is pizza, and pizza is knowledge. Let's go.</b>")
-
-variables = {
-  email: 'ron@parksandrec.com',
-  substitutions: [
-    {
-      var: 'test',
-      value: 'Test Value'
-    }
-  ]
-}
-
-ms_email.add_variables(variables)
-
-ms_email.send
-```
-
 ## Bulk Email
 
 ### Send bulk email
 ```ruby
 require "mailersend-ruby"
 
-ms_bulk_email = Mailersend::BulkEmail.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_bulk_email = Mailersend::BulkEmail.new(ms_client)
 
 ms_bulk_email.messages = [
     {
@@ -282,7 +257,9 @@ ms_bulk_email.send
 ```ruby
 require "mailersend-ruby"
 
-ms_bulk_email = Mailersend::BulkEmail.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_bulk_email = Mailersend::BulkEmail.new(ms_client)
 ms_bulk_email.get_bulk_status(bulk_email_id: 'yourbulkemailid')
 ```
 
@@ -292,7 +269,9 @@ ms_bulk_email.get_bulk_status(bulk_email_id: 'yourbulkemailid')
 ```ruby
 require "mailersend-ruby"
 
-ms_tokens = Mailersend::Tokens.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_tokens = Mailersend::Tokens.new(ms_client)
 ms_tokens.create(name: "Very nice token", scopes: %w[ email_full domains_read ], domain_id: "yourdomainid")
 ```
 
@@ -300,7 +279,9 @@ ms_tokens.create(name: "Very nice token", scopes: %w[ email_full domains_read ],
 ```ruby
 require "mailersend-ruby"
 
-ms_tokens = Mailersend::Tokens.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_tokens = Mailersend::Tokens.new(ms_client)
 ms_tokens.update(token_id: "d2220fx04", status: "paused")
 ```
 
@@ -308,7 +289,9 @@ ms_tokens.update(token_id: "d2220fx04", status: "paused")
 ```ruby
 require "mailersend-ruby"
 
-ms_tokens = Mailersend::Tokens.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_tokens = Mailersend::Tokens.new(ms_client)
 ms_tokens.delete(token_id: "d2220fx04")
 ```
 
@@ -317,8 +300,10 @@ ms_tokens.delete(token_id: "d2220fx04")
 ```ruby
 require "mailersend-ruby"
 
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
 # Intialize the email class
-ms_email = Mailersend::Email.new
+ms_email = Mailersend::Email.new(ms_client)
 
 # Add parameters
 ms_email.add_recipients("email" => "ron@parksandrec.com", "name" => "Ron")
@@ -344,7 +329,9 @@ ms_email.send
 ```ruby
 require "mailersend-ruby"
 
-ms_activity = Mailersend::Activity.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_activity = Mailersend::Activity.new(ms_client)
 ms_activity.get(domain_id: "xxx2241ll", page: 3, limit: 5, date_from: 1620643567, date_to: 1623321967)
 ```
 
@@ -355,7 +342,9 @@ ms_activity.get(domain_id: "xxx2241ll", page: 3, limit: 5, date_from: 1620643567
 ```ruby
 require "mailersend-ruby"
 
-ms_analytics = Mailersend::Analytics.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_analytics = Mailersend::Analytics.new(ms_client)
 ms_analytics.date(date_from: 1620643567, date_to: 1623321967, events: %w[sent queued])
 ```
 
@@ -364,7 +353,9 @@ ms_analytics.date(date_from: 1620643567, date_to: 1623321967, events: %w[sent qu
 ```ruby
 require "mailersend-ruby"
 
-ms_analytics = Mailersend::Analytics.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_analytics = Mailersend::Analytics.new(ms_client)
 ms_analytics.country(date_from: 1620643567, date_to: 1623321967)
 ```
 
@@ -373,7 +364,9 @@ ms_analytics.country(date_from: 1620643567, date_to: 1623321967)
 ```ruby
 require "mailersend-ruby"
 
-ms_analytics = Mailersend::Analytics.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_analytics = Mailersend::Analytics.new(ms_client)
 ms_analytics.ua_name(date_from: 1620643567, date_to: 1623321967)
 ```
 
@@ -382,7 +375,9 @@ ms_analytics.ua_name(date_from: 1620643567, date_to: 1623321967)
 ```ruby
 require "mailersend-ruby"
 
-ms_analytics = Mailersend::Analytics.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_analytics = Mailersend::Analytics.new(ms_client)
 ms_analytics.ua_type(date_from: 1620643567, date_to: 1623321967)
 ```
 
@@ -393,7 +388,9 @@ ms_analytics.ua_type(date_from: 1620643567, date_to: 1623321967)
 ```ruby
 require "mailersend-ruby"
 
-ms_inbound_routes = Mailersend::InboundRouting.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_inbound_routes = Mailersend::InboundRouting.new(ms_client)
 ms_inbound_routes.get_inbound_routes
 ```
 
@@ -402,7 +399,9 @@ ms_inbound_routes.get_inbound_routes
 ```ruby
 require "mailersend-ruby"
 
-ms_inbound_routes = Mailersend::InboundRouting.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_inbound_routes = Mailersend::InboundRouting.new(ms_client)
 ms_inbound_routes.get_single_route(inbound_id: 'idofroute12412')
 ```
 
@@ -411,7 +410,9 @@ ms_inbound_routes.get_single_route(inbound_id: 'idofroute12412')
 ```ruby
 require "mailersend-ruby"
 
-ms_inbound_routes = Mailersend::InboundRouting.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_inbound_routes = Mailersend::InboundRouting.new(ms_client)
 ms_inbound_routes.settings =
   {
     'domain_id' => 'yourdomainid',
@@ -428,7 +429,9 @@ puts ms_inbound_routes.add_inbound_route
 ```ruby
 require "mailersend-ruby"
 
-ms_inbound_routes = Mailersend::InboundRouting.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_inbound_routes = Mailersend::InboundRouting.new(ms_client)
 ms_inbound_routes.settings =
   {
     'domain_id' => 'yourdomainid',
@@ -445,7 +448,9 @@ puts ms_inbound_routes.update_inbound_route(inbound_id: 'idofroute12412')
 ```ruby
 require "mailersend-ruby"
 
-ms_inbound_routes = Mailersend::InboundRouting.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_inbound_routes = Mailersend::InboundRouting.new(ms_client)
 ms_inbound_routes.delete_route(inbound_id: 'idofroute12412')
 ```
 
@@ -456,7 +461,9 @@ ms_inbound_routes.delete_route(inbound_id: 'idofroute12412')
 ```ruby
 require "mailersend-ruby"
 
-ms_domains = Mailersend::Domains.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_domains = Mailersend::Domains.new(ms_client)
 ms_domains.list
 ```
 
@@ -465,7 +472,9 @@ ms_domains.list
 ```ruby
 require "mailersend-ruby"
 
-ms_domains = Mailersend::Domains.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_domains = Mailersend::Domains.new(ms_client)
 ms_domains.single(domain_id: "idofdomain12412")
 ```
 
@@ -474,7 +483,9 @@ ms_domains.single(domain_id: "idofdomain12412")
 ```ruby
 require "mailersend-ruby"
 
-ms_domains = Mailersend::Domains.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_domains = Mailersend::Domains.new(ms_client)
 ms_domains.add(name: 'yourdomain')
 ```
 
@@ -483,7 +494,9 @@ ms_domains.add(name: 'yourdomain')
 ```ruby
 require "mailersend-ruby"
 
-ms_domains = Mailersend::Domains.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_domains = Mailersend::Domains.new(ms_client)
 ms_domains.delete(domain_id: "idofdomain12412")
 ```
 
@@ -492,7 +505,9 @@ ms_domains.delete(domain_id: "idofdomain12412")
 ```ruby
 require "mailersend-ruby"
 
-ms_domains = Mailersend::Domains.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_domains = Mailersend::Domains.new(ms_client)
 ms_domains.recipients(domain_id: "idofdomain12412")
 ```
 
@@ -501,7 +516,9 @@ ms_domains.recipients(domain_id: "idofdomain12412")
 ```ruby
 require "mailersend-ruby"
 
-ms_domains = Mailersend::Domains.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_domains = Mailersend::Domains.new(ms_client)
 ms_domains.settings(domain_id: "idofdomain12412", track_clicks: true, track_unsubscribe: false)
 ```
 
@@ -510,7 +527,9 @@ ms_domains.settings(domain_id: "idofdomain12412", track_clicks: true, track_unsu
 ```ruby
 require "mailersend-ruby"
 
-ms_domains = Mailersend::Domains.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_domains = Mailersend::Domains.new(ms_client)
 ms_domains.dns(domain_id: "idofdomain12412")
 ```
 
@@ -519,7 +538,9 @@ ms_domains.dns(domain_id: "idofdomain12412")
 ```ruby
 require "mailersend-ruby"
 
-ms_domains = Mailersend::Domains.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_domains = Mailersend::Domains.new(ms_client)
 ms_domains.verify(domain_id: "idofdomain12412")
 ```
 
@@ -530,7 +551,9 @@ ms_domains.verify(domain_id: "idofdomain12412")
 ```ruby
 require "mailersend-ruby"
 
-ms_sender_identity = Mailersend::SenderIdentity.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_sender_identity = Mailersend::SenderIdentity.new(ms_client)
 ms_sender_identity.list
 ```
 
@@ -539,7 +562,9 @@ ms_sender_identity.list
 ```ruby
 require "mailersend-ruby"
 
-ms_sender_identity = Mailersend::SenderIdentity.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_sender_identity = Mailersend::SenderIdentity.new(ms_client)
 ms_sender_identity.single(identity_id: 'idofidentity123')
 ```
 
@@ -548,7 +573,9 @@ ms_sender_identity.single(identity_id: 'idofidentity123')
 ```ruby
 require "mailersend-ruby"
 
-ms_sender_identity = Mailersend::SenderIdentity.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_sender_identity = Mailersend::SenderIdentity.new(ms_client)
 ms_sender_identity.single_by_email(email: 'example@email.com')
 ```
 
@@ -557,7 +584,9 @@ ms_sender_identity.single_by_email(email: 'example@email.com')
 ```ruby
 require "mailersend-ruby"
 
-ms_sender_identity = Mailersend::SenderIdentity.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_sender_identity = Mailersend::SenderIdentity.new(ms_client)
 ms_sender_identity.add(domain_id: 'idofdomain12412', name: 'yourname', email: 'youremail')
 ```
 
@@ -566,7 +595,9 @@ ms_sender_identity.add(domain_id: 'idofdomain12412', name: 'yourname', email: 'y
 ```ruby
 require "mailersend-ruby"
 
-ms_sender_identity = Mailersend::SenderIdentity.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_sender_identity = Mailersend::SenderIdentity.new(ms_client)
 ms_sender_identity.update(identity_id: 'idofidentity123', reply_to_email: 'replyemail', reply_to_name: 'replyname')
 ```
 
@@ -575,7 +606,9 @@ ms_sender_identity.update(identity_id: 'idofidentity123', reply_to_email: 'reply
 ```ruby
 require "mailersend-ruby"
 
-ms_sender_identity = Mailersend::SenderIdentity.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_sender_identity = Mailersend::SenderIdentity.new(ms_client)
 ms_sender_identity.update_by_email(email: 'example@email.com', reply_to_email: 'replyemail', reply_to_name: 'replyname')
 ```
 
@@ -584,7 +617,9 @@ ms_sender_identity.update_by_email(email: 'example@email.com', reply_to_email: '
 ```ruby
 require "mailersend-ruby"
 
-ms_sender_identity = Mailersend::SenderIdentity.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_sender_identity = Mailersend::SenderIdentity.new(ms_client)
 ms_sender_identity.delete(identity_id: 'idofidentity123')
 ```
 
@@ -593,7 +628,9 @@ ms_sender_identity.delete(identity_id: 'idofidentity123')
 ```ruby
 require "mailersend-ruby"
 
-ms_sender_identity = Mailersend::SenderIdentity.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_sender_identity = Mailersend::SenderIdentity.new(ms_client)
 ms_sender_identity.delete_by_email(email: 'example@email.com')
 ```
 
@@ -604,7 +641,9 @@ ms_sender_identity.delete_by_email(email: 'example@email.com')
 ```ruby
 require "mailersend-ruby"
 
-ms_messages = Mailersend::Messages.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_messages = Mailersend::Messages.new(ms_client)
 ms_messages.list(page: 1, limit: 10)
 ```
 
@@ -613,7 +652,9 @@ ms_messages.list(page: 1, limit: 10)
 ```ruby
 require "mailersend-ruby"
 
-ms_messages = Mailersend::Messages.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_messages = Mailersend::Messages.new(ms_client)
 ms_messages.single(message_id: "mess11454")
 ```
 
@@ -624,7 +665,9 @@ ms_messages.single(message_id: "mess11454")
 ```ruby
 require "mailersend-ruby"
 
-ms_scheduled_messages = Mailersend::ScheduledMessages.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_scheduled_messages = Mailersend::ScheduledMessages.new(ms_client)
 ms_scheduled_messages.get_list
 ```
 
@@ -633,7 +676,9 @@ ms_scheduled_messages.get_list
 ```ruby
 require "mailersend-ruby"
 
-ms_scheduled_messages = Mailersend::ScheduledMessages.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_scheduled_messages = Mailersend::ScheduledMessages.new(ms_client)
 ms_scheduled_messages.get_signle(message_id: 'mess11454')
 ```
 
@@ -642,7 +687,9 @@ ms_scheduled_messages.get_signle(message_id: 'mess11454')
 ```ruby
 require "mailersend-ruby"
 
-ms_scheduled_messages = Mailersend::ScheduledMessages.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_scheduled_messages = Mailersend::ScheduledMessages.new(ms_client)
 ms_scheduled_messages.delete(message_id: 'mess11454')
 ```
 
@@ -653,7 +700,9 @@ ms_scheduled_messages.delete(message_id: 'mess11454')
 ```ruby
 require "mailersend-ruby"
 
-ms_recipients = Mailersend::Recipients.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_recipients = Mailersend::Recipients.new(ms_client)
 ms_recipients.list(page: 1, limit: 10)
 ```
 
@@ -662,7 +711,9 @@ ms_recipients.list(page: 1, limit: 10)
 ```ruby
 require "mailersend-ruby"
 
-ms_recipients = Mailersend::Recipients.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_recipients = Mailersend::Recipients.new(ms_client)
 ms_recipients.single(recipient_id: "id124")
 ```
 
@@ -671,7 +722,9 @@ ms_recipients.single(recipient_id: "id124")
 ```ruby
 require "mailersend-ruby"
 
-ms_recipients = Mailersend::Recipients.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_recipients = Mailersend::Recipients.new(ms_client)
 ms_recipients.delete(recipient_id: "id124")
 ```
 
@@ -682,7 +735,9 @@ ms_recipients.delete(recipient_id: "id124")
 ```ruby
 require "mailersend-ruby"
 
-ms_suppressions = Mailersend::Suppressions.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_suppressions = Mailersend::Suppressions.new(ms_client)
 
 // List from Blocklist 
 ms_suppressions.get_from_blocklist(domain_id: "xxx2241ll")
@@ -702,7 +757,9 @@ ms_suppressions.get_unsubscribes(domain_id: "xxx2241ll")
 ```ruby
 require "mailersend-ruby"
 
-ms_suppressions = Mailersend::Suppressions.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_suppressions = Mailersend::Suppressions.new(ms_client)
 
 // Add Recipient to Block List using recipients
 ms_suppressions.add_to_blocklist(domain_id: "xxx2241ll", recipients: ["blocked@client.com"])
@@ -725,7 +782,9 @@ ms_suppressions.add_to_unsubscribers(domain_id: "xxx2241ll", recipients: ["bounc
 ```ruby
 require "mailersend-ruby"
 
-ms_suppressions = Mailersend::Suppressions.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_suppressions = Mailersend::Suppressions.new(ms_client)
 
 // Delete from Block List
 ms_suppressions.delete_from_blocklist(domain_id: 'yourdomainid', ids: ["xxx2241ll"])
@@ -746,7 +805,9 @@ ms_suppressions.delete_from_unsubscribers(domain_id: 'yourdomainid', ids: ["xxx2
 ```ruby
 require "mailersend-ruby"
 
-ms_webhooks = Mailersend::Webhooks.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_webhooks = Mailersend::Webhooks.new(ms_client)
 ms_webhooks.list(domain_id: "xxx2241ll")
 ```
 
@@ -754,7 +815,9 @@ ms_webhooks.list(domain_id: "xxx2241ll")
 ```ruby
 require "mailersend-ruby"
 
-ms_webhooks = Mailersend::Webhooks.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_webhooks = Mailersend::Webhooks.new(ms_client)
 ms_webhooks.single(webhook_id: "zzz2241ll")
 ```
 
@@ -762,7 +825,9 @@ ms_webhooks.single(webhook_id: "zzz2241ll")
 ```ruby
 require "mailersend-ruby"
 
-ms_webhooks = Mailersend::Webhooks.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_webhooks = Mailersend::Webhooks.new(ms_client)
 ms_webhooks.create(domain_id: "xxx2241ll", url: "https://domain.com/hook", name: "Webhook", events: ["activity.sent", "activity.delivered"], enabled: true)
 ```
 
@@ -770,7 +835,9 @@ ms_webhooks.create(domain_id: "xxx2241ll", url: "https://domain.com/hook", name:
 ```ruby
 require "mailersend-ruby"
 
-ms_webhooks = Mailersend::Webhooks.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_webhooks = Mailersend::Webhooks.new(ms_client)
 ms_webhooks.update(webhook_id: "zzz2241ll", enabled: false)
 ```
 
@@ -778,7 +845,9 @@ ms_webhooks.update(webhook_id: "zzz2241ll", enabled: false)
 ```ruby
 require "mailersend-ruby"
 
-ms_webhooks = Mailersend::Webhooks.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_webhooks = Mailersend::Webhooks.new(ms_client)
 ms_webhooks.delete(webhook_id: "zzz2241ll")
 ```
 
@@ -789,7 +858,9 @@ ms_webhooks.delete(webhook_id: "zzz2241ll")
 ```ruby
 require "mailersend-ruby"
 
-ms_templates = Mailersend::Templates.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_templates = Mailersend::Templates.new(ms_client)
 ms_templates.list(domain_id: "aax455lll", page: 1, limit: 10)
 ```
 
@@ -798,7 +869,9 @@ ms_templates.list(domain_id: "aax455lll", page: 1, limit: 10)
 ```ruby
 require "mailersend-ruby"
 
-ms_templates = Mailersend::Templates.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_templates = Mailersend::Templates.new(ms_client)
 ms_templates.single(template_id: "id124")
 ```
 
@@ -807,7 +880,9 @@ ms_templates.single(template_id: "id124")
 ```ruby
 require "mailersend-ruby"
 
-ms_templates = Mailersend::Templates.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_templates = Mailersend::Templates.new(ms_client)
 ms_templates.delete(template_id: "id124")
 ```
 
@@ -818,7 +893,9 @@ ms_templates.delete(template_id: "id124")
 ```ruby
 require "mailersend-ruby"
 
-ms_email_verification = Mailersend::EmailVerification.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_email_verification = Mailersend::EmailVerification.new(ms_client)
 ms_email_verification.verify_an_email(email: 'example@email.com')
 ```
 
@@ -827,7 +904,9 @@ ms_email_verification.verify_an_email(email: 'example@email.com')
 ```ruby
 require "mailersend-ruby"
 
-ms_email_verification = Mailersend::EmailVerification.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_email_verification = Mailersend::EmailVerification.new(ms_client)
 ms_email_verification.list(page: 1, limit: 10)
 ```
 
@@ -836,7 +915,9 @@ ms_email_verification.list(page: 1, limit: 10)
 ```ruby
 require "mailersend-ruby"
 
-ms_email_verification = Mailersend::EmailVerification.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_email_verification = Mailersend::EmailVerification.new(ms_client)
 ms_email_verification.get_single_list(email_verification_id: 'your-email-verification-id')
 ```
 
@@ -845,7 +926,9 @@ ms_email_verification.get_single_list(email_verification_id: 'your-email-verific
 ```ruby
 require "mailersend-ruby"
 
-ms_email_verification = Mailersend::EmailVerification.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_email_verification = Mailersend::EmailVerification.new(ms_client)
 ms_email_verification.create_a_list(name: "name-your-list", emails: ["example@email.com"])
 ```
 
@@ -854,7 +937,9 @@ ms_email_verification.create_a_list(name: "name-your-list", emails: ["example@em
 ```ruby
 require "mailersend-ruby"
 
-ms_email_verification = Mailersend::EmailVerification.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_email_verification = Mailersend::EmailVerification.new(ms_client)
 ms_email_verification.verify_a_list(email_verification_id: 'your-email-verification-id')
 ```
 
@@ -863,7 +948,9 @@ ms_email_verification.verify_a_list(email_verification_id: 'your-email-verificat
 ```ruby
 require "mailersend-ruby"
 
-ms_email_verification = Mailersend::EmailVerification.new
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
+ms_email_verification = Mailersend::EmailVerification.new(ms_client)
 ms_email_verification.get_list_results(email_verification_id: 'your-email-verification-id')
 ```
 
@@ -874,8 +961,10 @@ ms_email_verification.get_list_results(email_verification_id: 'your-email-verifi
 ```ruby
 require "mailersend-ruby"
 
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
 # Intialize the SMS class
-ms_sms = Mailersend::SMS.new
+ms_sms = Mailersend::SMS.new(ms_client)
 
 # Add parameters
 ms_sms.add_from('your-number')
@@ -900,8 +989,10 @@ ms_sms.send
 ```ruby
 require "mailersend-ruby"
 
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
 # Intialize the SMS Messages class
-ms_sms_messages = Mailersend::SMSMessages.new
+ms_sms_messages = Mailersend::SMSMessages.new(ms_client)
 
 # Add parameters
 ms_sms_messages.list(page: 1, limit: 10)
@@ -912,8 +1003,10 @@ ms_sms_messages.list(page: 1, limit: 10)
 ```ruby
 require "mailersend-ruby"
 
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
 # Intialize the SMS Messages class
-ms_sms_messages = Mailersend::SMSMessages.new
+ms_sms_messages = Mailersend::SMSMessages.new(ms_client)
 
 # Add parameters
 ms_sms_messages.get_single_route(sms_message_id: 'your-sms-message-id')
@@ -926,8 +1019,10 @@ ms_sms_messages.get_single_route(sms_message_id: 'your-sms-message-id')
 ```ruby
 require "mailersend-ruby"
 
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
 # Intialize the SMS Recipient class
-ms_sms_activity = Mailersend::SMSActivity.new
+ms_sms_activity = Mailersend::SMSActivity.new(ms_client)
 
 # Add parameters
 ms_sms_activity.list(page: 1, limit: 10)
@@ -940,8 +1035,10 @@ ms_sms_activity.list(page: 1, limit: 10)
 ```ruby
 require "mailersend-ruby"
 
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
 # Intialize the SMS Recipient class
-ms_sms_number = Mailersend::SMSNumber.new
+ms_sms_number = Mailersend::SMSNumber.new(ms_client)
 
 # Add parameters
 ms_sms_number.list(page: 1, limit: 10)
@@ -952,8 +1049,10 @@ ms_sms_number.list(page: 1, limit: 10)
 ```ruby
 require "mailersend-ruby"
 
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
 # Intialize the SMS Recipient class
-ms_sms_number = Mailersend::SMSNumber.new
+ms_sms_number = Mailersend::SMSNumber.new(ms_client)
 
 # Add parameters
 ms_sms_number.get(sms_number_id: 'your-sms-number-id')
@@ -964,8 +1063,10 @@ ms_sms_number.get(sms_number_id: 'your-sms-number-id')
 ```ruby
 require "mailersend-ruby"
 
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
 # Intialize the SMS Recipient class
-ms_sms_number = Mailersend::SMSNumber.new
+ms_sms_number = Mailersend::SMSNumber.new(ms_client)
 
 # Add parameters
 ms_sms_number.update(sms_number_id: 'your-sms-number-id', paused: false)
@@ -976,8 +1077,10 @@ ms_sms_number.update(sms_number_id: 'your-sms-number-id', paused: false)
 ```ruby
 require "mailersend-ruby"
 
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
 # Intialize the SMS Recipient class
-ms_sms_number = Mailersend::SMSNumber.new
+ms_sms_number = Mailersend::SMSNumber.new(ms_client)
 
 # Add parameters
 ms_sms_number.delete(sms_number_id: 'your-sms-number-id')
@@ -990,8 +1093,10 @@ ms_sms_number.delete(sms_number_id: 'your-sms-number-id')
 ```ruby
 require "mailersend-ruby"
 
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
 # Intialize the SMS Recipient class
-ms_sms_recipient = Mailersend::SMSRecipient.new
+ms_sms_recipient = Mailersend::SMSRecipient.new(ms_client)
 
 # Add parameters
 ms_sms_recipient.list(page: 1, limit: 10)
@@ -1002,8 +1107,10 @@ ms_sms_recipient.list(page: 1, limit: 10)
 ```ruby
 require "mailersend-ruby"
 
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
 # Intialize the SMS Recipient class
-ms_sms_recipient = Mailersend::SMSRecipient.new
+ms_sms_recipient = Mailersend::SMSRecipient.new(ms_client)
 
 # Add parameters
 ms_sms_recipient.get(sms_recipient_id: 'your-sms-recipient-id')
@@ -1014,8 +1121,10 @@ ms_sms_recipient.get(sms_recipient_id: 'your-sms-recipient-id')
 ```ruby
 require "mailersend-ruby"
 
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
 # Intialize the SMS Recipient class
-ms_sms_recipient = Mailersend::SMSRecipient.new
+ms_sms_recipient = Mailersend::SMSRecipient.new(ms_client)
 
 # Add parameters
 ms_sms_recipient.update(sms_recipient_id: 'your-sms-recipient-id', status: 'opt_out')
@@ -1028,8 +1137,10 @@ ms_sms_recipient.update(sms_recipient_id: 'your-sms-recipient-id', status: 'opt_
 ```ruby
 require "mailersend-ruby"
 
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
 # Intialize the SMS Inbounds class
-ms_sms_inbounds = Mailersend::SMSInbounds.new
+ms_sms_inbounds = Mailersend::SMSInbounds.new(ms_client)
 
 ms_sms_inbounds.list
 ```
@@ -1039,8 +1150,10 @@ ms_sms_inbounds.list
 ```ruby
 require "mailersend-ruby"
 
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
 # Intialize the SMS Inbounds class
-ms_sms_inbounds = Mailersend::SMSInbounds.new
+ms_sms_inbounds = Mailersend::SMSInbounds.new(ms_client)
 
 # Add parameters
 ms_sms_inbounds.get_sms_inbound_route(sms_inbound_id: 'your-sms-inbound-id')
@@ -1051,8 +1164,10 @@ ms_sms_inbounds.get_sms_inbound_route(sms_inbound_id: 'your-sms-inbound-id')
 ```ruby
 require "mailersend-ruby"
 
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
 # Intialize the SMS Inbounds class
-ms_sms_inbounds = Mailersend::SMSInbounds.new
+ms_sms_inbounds = Mailersend::SMSInbounds.new(ms_client)
 
 # Add parameters
 ms_sms_inbounds.settings =
@@ -1070,8 +1185,10 @@ puts ms_sms_inbounds.add_sms_inbound_route
 ```ruby
 require "mailersend-ruby"
 
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
 # Intialize the SMS Inbounds class
-ms_sms_inbounds = Mailersend::SMSInbounds.new
+ms_sms_inbounds = Mailersend::SMSInbounds.new(ms_client)
 
 # Add parameters
 ms_sms_inbounds.settings =
@@ -1089,8 +1206,10 @@ puts ms_sms_inbounds.update_sms_inbound_route(sms_inbound_id: 'your-sms-inbound-
 ```ruby
 require "mailersend-ruby"
 
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
 # Intialize the SMS Inbounds class
-ms_sms_inbounds = Mailersend::SMSInbounds.new
+ms_sms_inbounds = Mailersend::SMSInbounds.new(ms_client)
 
 # Add parameters
 ms_sms_inbounds.delete_sms_inbound_route(sms_inbound_id: 'your-sms-inbound-id')
@@ -1103,8 +1222,10 @@ ms_sms_inbounds.delete_sms_inbound_route(sms_inbound_id: 'your-sms-inbound-id')
 ```ruby
 require "mailersend-ruby"
 
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
 # Intialize the SMS Webhooks class
-ms_sms_webhooks = Mailersend::SMSWebhooks.new
+ms_sms_webhooks = Mailersend::SMSWebhooks.new(ms_client)
 
 # Add parameters
 ms_sms_webhooks.list(sms_number_id: 'your-sms-number-id')
@@ -1115,8 +1236,10 @@ ms_sms_webhooks.list(sms_number_id: 'your-sms-number-id')
 ```ruby
 require "mailersend-ruby"
 
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
 # Intialize the SMS Webhooks class
-ms_sms_webhooks = Mailersend::SMSWebhooks.new
+ms_sms_webhooks = Mailersend::SMSWebhooks.new(ms_client)
 
 # Add parameters
 ms_sms_webhooks.get_sms_webhook_route(sms_webhook_id: 'your-sms-webhook-id')
@@ -1127,8 +1250,10 @@ ms_sms_webhooks.get_sms_webhook_route(sms_webhook_id: 'your-sms-webhook-id')
 ```ruby
 require "mailersend-ruby"
 
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
 # Intialize the SMS Webhooks class
-ms_sms_webhooks = Mailersend::SMSWebhooks.new
+ms_sms_webhooks = Mailersend::SMSWebhooks.new(ms_client)
 
 # Add parameters
 ms_sms_webhooks.settings =
@@ -1146,8 +1271,10 @@ puts ms_sms_webhooks.add_sms_webhook_route
 ```ruby
 require "mailersend-ruby"
 
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
 # Intialize the SMS Webhooks class
-ms_sms_webhooks = Mailersend::SMSWebhooks.new
+ms_sms_webhooks = Mailersend::SMSWebhooks.new(ms_client)
 
 # Add parameters
 ms_sms_webhooks.settings =
@@ -1165,8 +1292,10 @@ puts ms_sms_webhooks.update_sms_webhook_route(sms_webhook_id: 'your-sms-webhook-
 ```ruby
 require "mailersend-ruby"
 
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
 # Intialize the SMS Webhooks class
-ms_sms_webhooks = Mailersend::SMSWebhooks.new
+ms_sms_webhooks = Mailersend::SMSWebhooks.new(ms_client)
 
 # Add parameters
 ms_sms_webhooks.delete_sms_webhook_route(sms_webhook_id: 'your-sms-webhook-id')
@@ -1179,8 +1308,10 @@ ms_sms_webhooks.delete_sms_webhook_route(sms_webhook_id: 'your-sms-webhook-id')
 ```ruby
 require "mailersend-ruby"
 
+ms_client = Mailersend::Client.new('your_mailersend_token')
+
 # Intialize the API Quota class
-ms_api_quota = Mailersend::APIQuota.new
+ms_api_quota = Mailersend::APIQuota.new(ms_client)
 
 # Add parameters
 ms_api_quota.get_api_quota

data/lib/mailersend/client.rb

@@ -1,20 +1,19 @@
 # frozen_string_literal: true
 
 require 'http'
-require 'dotenv/load'
 
 API_URL = 'https://api.mailersend.com/v1'
 API_BASE_HOST = 'api.mailersend.com'
 
-Dotenv.require_keys('MAILERSEND_API_TOKEN')
-
 # mailersend-ruby is a gem that integrates all endpoints from MailerSend API
 module Mailersend
   attr_reader :api_token
 
   # Inits the client.
   class Client
-    def initialize(api_token = ENV['MAILERSEND_API_TOKEN'])
+    def initialize(api_token = ENV.fetch('MAILERSEND_API_TOKEN', nil))
+      raise ArgumentError, 'API token is not provided' if api_token.nil?
+
       @api_token = api_token
     end
 

data/lib/mailersend/version.rb

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

data/mailersend-ruby.gemspec

@@ -27,8 +27,7 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'dotenv', '~> 2.7'
   spec.add_dependency 'http', '~> 5.0'
   spec.add_dependency 'json', '~> 2.5'
-  spec.add_dependency 'uri', '~> 0.12.0'
+  spec.add_dependency 'uri', '~> 0.12.2'
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: mailersend-ruby
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Nikola Milojević
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-23 00:00:00.000000000 Z
+date: 2024-01-10 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: dotenv
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.7'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.12.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.12.2
 description: MailerSend's official Ruby SDK. Interacts with all endpoints at MailerSend
   API.
 email:
@@ -142,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: MailerSend's official Ruby SDK