Merge pull request #47 from sarco3t/templates-api

Add EmailTemplate API functionality

Author: i7an

.github/workflows/main.yml

@@ -1,6 +1,6 @@
 name: Ruby
 
-on: push
+on: [push, pull_request]
 
 jobs:
   build:

.rubocop.yml

@@ -15,6 +15,15 @@ AllCops:
 Layout/LineLength:
   Max: 120
 
+Metrics/AbcSize:
+  Max: 25
+
+Metrics/ClassLength:
+  Max: 200
+
+Metrics/MethodLength:
+  Max: 20
+
 Naming/MethodParameterName:
   MinNameLength: 2
 
@@ -27,6 +36,9 @@ RSpec/MultipleExpectations:
 RSpec/NestedGroups:
   Max: 4
 
+RSpec/ExampleLength:
+  Enabled: false
+
 Style/Documentation:
   Enabled: false
 

Gemfile

@@ -5,13 +5,16 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'appraisal'
+gem 'irb'
 gem 'mail'
 gem 'net-smtp'
 gem 'rake', '~> 13.0'
+gem 'rdoc', '~> 6.13.0'
 gem 'rspec', '~> 3.0'
 gem 'rspec-its'
 gem 'rubocop', '~> 1.21'
 gem 'rubocop-rake', require: false
 gem 'rubocop-rspec', require: false
 gem 'vcr'
 gem 'webmock'
+gem 'yard', '~> 0.9'

Gemfile.lock

@@ -2,6 +2,7 @@ PATH
   remote: .
   specs:
     mailtrap (2.3.0)
+      base64
 
 GEM
   remote: https://rubygems.org/
@@ -13,13 +14,19 @@ GEM
       rake
       thor (>= 0.14.0)
     ast (2.4.2)
+    base64 (0.3.0)
     bigdecimal (3.1.8)
     crack (1.0.0)
       bigdecimal
       rexml
     date (3.4.1)
     diff-lcs (1.5.1)
     hashdiff (1.1.0)
+    io-console (0.8.0)
+    irb (1.15.2)
+      pp (>= 0.6.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
     json (2.7.2)
     language_server-protocol (3.17.0.3)
     mail (2.8.1)
@@ -41,11 +48,21 @@ GEM
     parser (3.3.3.0)
       ast (~> 2.4.1)
       racc
+    pp (0.6.2)
+      prettyprint
+    prettyprint (0.2.0)
+    psych (5.2.6)
+      date
+      stringio
     public_suffix (5.1.1)
     racc (1.8.0)
     rainbow (3.1.1)
     rake (13.2.1)
+    rdoc (6.13.1)
+      psych (>= 4.0.0)
     regexp_parser (2.9.2)
+    reline (0.6.1)
+      io-console (~> 0.5)
     rexml (3.3.9)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
@@ -81,6 +98,7 @@ GEM
     rubocop-rspec (3.0.2)
       rubocop (~> 1.61)
     ruby-progressbar (1.13.0)
+    stringio (3.1.7)
     thor (1.3.1)
     timeout (0.4.3)
     unicode-display_width (2.5.0)
@@ -89,23 +107,27 @@ GEM
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
+    yard (0.9.37)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   appraisal
+  irb
   mail
   mailtrap!
   net-smtp
   rake (~> 13.0)
+  rdoc (~> 6.13.0)
   rspec (~> 3.0)
   rspec-its
   rubocop (~> 1.21)
   rubocop-rake
   rubocop-rspec
   vcr
   webmock
+  yard (~> 0.9)
 
 BUNDLED WITH
    2.6.5

README.md

@@ -62,11 +62,29 @@ client = Mailtrap::Client.new(api_key: 'your-api-key')
 client.send(mail)
 ```
 
-Refer to the [`examples`](examples) folder for more examples.
+### Email Templates API
+
+```ruby
+require 'mailtrap'
+
+client = Mailtrap::Client.new(api_key: 'your-api-key')
+templates = Mailtrap::EmailTemplatesAPI.new 3229, client
+
+templates.create(
+  name: 'Welcome Email',
+  subject: 'Welcome to Mailtrap!',
+  body_html: '<h1>Hello</h1>',
+  body_text: 'Hello',
+  category: 'welcome'
+)
+```
+
+Refer to the [`examples`](examples) folder for more examples:
 
 - [Full](examples/full.rb)
 - [Email template](examples/email_template.rb)
 - [ActionMailer](examples/action_mailer.rb)
+- [Email Templates API](examples/email_templates_api.rb)
 
 ### Content-Transfer-Encoding
 
@@ -77,7 +95,7 @@ sending. For example, `/api/send` endpoint ignores `Content-Transfer-Encoding`
 Meaning your recipients will receive emails only in the default encoding which
 is `quoted-printable`, if you send with Mailtrap API.
 
-For those who does need to use `7bit` or any other encoding, SMTP provides
+For those who need to use `7bit` or any other encoding, SMTP provides
 better flexibility in that regard. Go to your _Mailtrap account_ → _Email Sending_
 → _Sending Domains_ → _Your domain_ → _SMTP/API Settings_ to find the SMTP
 configuration example.

examples/email_templates_api.rb

@@ -0,0 +1,31 @@
+require 'mailtrap'
+
+client = Mailtrap::Client.new(api_key: 'your-api-key')
+templates = Mailtrap::EmailTemplatesAPI.new 3229, client
+
+# Set your API credentials as environment variables
+# export MAILTRAP_API_KEY='your-api-key'
+# export MAILTRAP_ACCOUNT_ID=your-account-id
+#
+# templates = Mailtrap::EmailTemplatesAPI.new
+
+# Get all email templates
+templates.list
+
+# Create a new email template
+email_template = templates.create(
+  name: 'Welcome Email',
+  subject: 'Welcome to Mailtrap!',
+  body_html: '<h1>Hello</h1>',
+  body_text: 'Hello',
+  category: 'welcome'
+)
+
+# Get an email template
+email_template = templates.get(email_template.id)
+
+# Update an email template
+email_template = templates.update(email_template.id, name: 'Welcome Updated')
+
+# Delete an email template
+templates.delete(email_template.id)

examples/full.rb

@@ -18,7 +18,7 @@
   category: 'Integration Test',
   attachments: [
     {
-      content: Base64.encode64('Attachment content'), # base64 encoded content or IO string
+      content: Base64.strict_encode64('Attachment content'), # base64 encoded content or IO string
       filename: 'attachment.txt'
     }
   ],
@@ -37,6 +37,11 @@
 
 client = Mailtrap::Client.new(api_key: 'your-api-key')
 
+# Set your API credentials as environment variables
+# export MAILTRAP_API_KEY='your-api-key'
+#
+# client = Mailtrap::Client.new
+
 # Custom host / port
 # client = Mailtrap::Client.new(api_key: 'your-api-key', api_host: 'alternative.host.mailtrap.io', api_port: 8080)
 

lib/mailtrap.rb

@@ -4,5 +4,12 @@
 require_relative 'mailtrap/mail'
 require_relative 'mailtrap/errors'
 require_relative 'mailtrap/version'
+require_relative 'mailtrap/email_templates_api'
 
-module Mailtrap; end
+module Mailtrap
+  # @!macro api_errors
+  #   @raise [Mailtrap::Error] If the API request fails with a client or server error
+  #   @raise [Mailtrap::AuthorizationError] If the API key is invalid
+  #   @raise [Mailtrap::RejectionError] If the server refuses to process the request
+  #   @raise [Mailtrap::RateLimitError] If too many requests are made
+end