mailgun-ruby 1.2.6 → 1.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9dd7b99f66b317ffcbf86172b1534cdcb0ccf4b0b25a7b2e58599f20ef021f11
-  data.tar.gz: 8b130d3344fe905d20d4230cb8b178d29b092ffa6d21c3dbb085376aa53b50a0
+  metadata.gz: b6f8edf9d12225755a4ddaba5a1974b8ccc30f4b150d9880a5dc174d0612c619
+  data.tar.gz: c676969ade04f6b2e8d2322ff68922d5065e5ca1720eeb821aa429849fddc7b5
 SHA512:
-  metadata.gz: 34729e98ab4eb8cbfd04bdb5b7a090a30cb4a1961de9ef38e0adcab2d452e5873477d9b45de9703a6c5885b272a3d62429ece40ff6029bff2bbb0d8585a89410
-  data.tar.gz: 235e7aed52a937315019498bbb710e90b97128d9fdfad86bfb0995daf9d25f8185683769fd84b32e4eda4c64774b49a708a57da90ccd473e7d69f0e967eed581
+  metadata.gz: dac9ef370272bed2a8bd78080dbc8e322aae34fe4fa9639d5c35c1de008d088ab8845355c96bac3efd331f43803cf9834047e7843620cc8602efd380aa6b8ae4
+  data.tar.gz: 1cc92c4983c7f3e2b94e0ae577caf8b0010e5e08d6e453adba658acce942186c3b443dbca4930feeeea4bfdaab16a5cfb2bc245ffdd42571de323f4abbbc9c52

data/README.md

@@ -19,7 +19,7 @@ gem install mailgun-ruby
 Gemfile:
 
 ```ruby
-gem 'mailgun-ruby', '~>1.2.6'
+gem 'mailgun-ruby', '~>1.2.7'
 ```
 
 Usage
@@ -188,6 +188,7 @@ This SDK includes the following components:
 - [Webhooks](docs/Webhooks.md)
 - [Events](docs/Events.md)
 - [Suppressions](docs/Suppressions.md)
+- [Templates](docs/Templates.md)
 
 Message Builder allows you to quickly create the array of parameters, required
 to send a message, by calling a methods for each parameter.

data/docs/railgun/Templates.md

@@ -0,0 +1,92 @@
+Mailgun - Templates
+====================
+
+This is the Mailgun Ruby *Templates* utilities.
+
+The below assumes you've already installed the Mailgun Ruby SDK in to your
+project. If not, go back to the master README for instructions.
+
+Usage - Templates
+-----------------------
+
+**Build a message with a template:**
+
+```ruby
+mb_obj = Mailgun::MessageBuilder.new
+
+mb_obj.from("sender@example.com")
+mb_obj.add_recipient("to", "recipient@example.com")
+mb_obj.subject ("This is the subject!")
+message.template('example.template.name')
+message.template_version('example.tag')
+
+mg_client.send_message "sending_domain.com", mb_obj
+```
+
+**Rails Example. Build a message with a template:**
+
+```ruby
+class UserMailer < ApplicationMailer
+  def welcome_email
+    message = mail(
+    	from: "sender@example.com",
+    	to: "recipient@example.com",
+    	subject: "This is the subject!",
+    	template: 'example.template.name'
+    ) do |format|
+      format.text { render plain: "Test!" }
+    end
+    message.tap do |message|
+      message.mailgun_template_variables ||= {
+       'version' => 'example.tag'
+      }
+    end
+  end
+end
+```
+
+Template Handlebars
+-------------------------
+
+```
+{{#if english}}
+<p>This text is in the English language.</p>
+{{else if spanish}}
+<p>Este texto está en idioma español.</p>
+{{else if french}}
+<p>Ce texte est en langue française.</p>
+{{/if}}
+```
+
+In order to send the spanish version, for example:
+
+```ruby
+message.variable('spanish', 'true')
+```
+
+Also, Rails example:
+
+```ruby
+class UserMailer < ApplicationMailer
+  def welcome_email
+    message = mail(
+    	from: "sender@example.com",
+    	to: "recipient@example.com",
+    	subject: "This is the subject!",
+    	template: 'example.template.name'
+    ) do |format|
+      format.text { render plain: "Test!" }
+    end
+    message.tap do |message|
+      message.mailgun_variables ||= {
+       'spanish' => 'true'
+      }
+    end
+  end
+end
+```
+
+More Documentation
+------------------
+See the official [Mailgun Templates Docs](https://documentation.mailgun.com/en/latest/api-templates.html)
+for more information

data/lib/mailgun/client.rb

@@ -11,12 +11,12 @@ module Mailgun
   class Client
 
     def initialize(api_key = Mailgun.api_key,
-                   api_host = 'api.mailgun.net',
-                   api_version = 'v3',
+                   api_host = Mailgun.api_host || 'api.mailgun.net',
+                   api_version = Mailgun.api_version  || 'v3',
                    ssl = true,
                    test_mode = false,
                    timeout = nil,
-                   proxy_url = nil)
+                   proxy_url = Mailgun.proxy_url)
 
       rest_client_params = {
         user: 'api',
@@ -45,6 +45,11 @@ module Mailgun
       @test_mode = false
     end
 
+    # Change API key
+    def set_api_key(api_key)
+      @http_client.options[:password] = api_key
+    end
+
     # Client is in test mode?
     #
     # @return [Boolean] Is the client set in test mode?

data/lib/mailgun/suppressions.rb

@@ -45,11 +45,11 @@ module Mailgun
     end
 
     def get_bounce(address)
-      @client.get("#{@domain}/bounces/#{address}", nil)
+      @client.get("#{@domain}/bounces/#{escape_address(address)}", nil)
     end
 
     def create_bounce(params = {})
-      @client.post("#{@domain/bounces}", params)
+      @client.post("#{@domain}/bounces", params)
     end
 
     # Creates multiple bounces on the Mailgun API.
@@ -100,7 +100,7 @@ module Mailgun
     end
 
     def delete_bounce(address)
-      @client.delete("#{@domain}/bounces/#{address}")
+      @client.delete("#{@domain}/bounces/#{escape_address(address)}")
     end
 
     def delete_all_bounces
@@ -118,7 +118,7 @@ module Mailgun
     end
 
     def get_unsubscribe(address)
-      @client.get("#{@domain}/unsubscribes/#{address}")
+      @client.get("#{@domain}/unsubscribes/#{escape_address(address)}")
     end
 
     def create_unsubscribe(params = {})
@@ -173,7 +173,7 @@ module Mailgun
     end
 
     def delete_unsubscribe(address, params = {})
-      @client.delete("#{@domain}/unsubscribes/#{address}")
+      @client.delete("#{@domain}/unsubscribes/#{escape_address(address)}")
     end
 
     ####
@@ -187,7 +187,7 @@ module Mailgun
     end
 
     def get_complaint(address)
-      @client.get("#{@domain}/complaints/#{address}", nil)
+      @client.get("#{@domain}/complaints/#{escape_address(address)}", nil)
     end
 
     def create_complaint(params = {})
@@ -239,11 +239,15 @@ module Mailgun
     end
 
     def delete_complaint(address)
-      @client.delete("#{@domain}/complaints/#{address}")
+      @client.delete("#{@domain}/complaints/#{escape_address(address)}")
     end
 
     private
 
+    def escape_address(address)
+      CGI.escape address
+    end
+
     def get_from_paging(uri, params = {})
       @client.get(uri, params)
     end

data/lib/mailgun/version.rb

@@ -1,4 +1,4 @@
 # It's the version. Yeay!
 module Mailgun
-  VERSION = '1.2.6'
+  VERSION = '1.2.7'
 end

data/lib/railgun/mailer.rb

@@ -48,7 +48,10 @@ module Railgun
 
     def deliver!(mail)
       @mg_domain = set_mg_domain(mail)
+      @mg_client.set_api_key(mail[:api_key].value) if mail[:api_key].present?
+
       mail[:domain] = nil if mail[:domain].present?
+      mail[:api_key] = nil if mail[:api_key].present?
 
       mg_message = Railgun.transform_for_mailgun(mail)
       response = @mg_client.send_message(@mg_domain, mg_message)

data/spec/integration/bounces_spec.rb

@@ -7,7 +7,7 @@ describe 'For the Bounces endpoint', order: :defined, vcr: vcr_opts do
   before(:all) do
     @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
     @domain = TESTDOMAIN
-    @email = "integration-test-email@#{TESTDOMAIN}"
+    @email = "integration-test+email@#{TESTDOMAIN}"
   end
 
   it 'creates a bounce' do
@@ -22,7 +22,7 @@ describe 'For the Bounces endpoint', order: :defined, vcr: vcr_opts do
   end
 
   it 'get a bounce.' do
-    result = @mg_obj.get("#{@domain}/bounces/#{@email}")
+    result = @mg_obj.get("#{@domain}/bounces/#{CGI.escape(@email)}")
 
     result.to_h!
     expect(result.body["code"]).to eq("550")
@@ -38,7 +38,7 @@ describe 'For the Bounces endpoint', order: :defined, vcr: vcr_opts do
   end
 
   it 'deletes a bounce' do
-    @mg_obj.delete("#{@domain}/bounces/#{@email}")
+    @mg_obj.delete("#{@domain}/bounces/#{CGI.escape(@email)}")
   end
 
 end

data/vcr_cassettes/bounces.yml

@@ -5,7 +5,7 @@ http_interactions:
     uri: https://api:<APIKEY>@api.mailgun.net/v3/DOMAIN.TEST/bounces
     body:
       encoding: US-ASCII
-      string: address=integration-test-email%40DOMAIN.TEST&code=550&error=Integration%20Test
+      string: address=integration-test%2Bemail%40DOMAIN.TEST&code=550&error=Integration%20Test
     headers:
       Accept:
       - "*/*; q=0.5, application/xml"
@@ -42,13 +42,13 @@ http_interactions:
       - Content-Type, x-requested-with
     body:
       encoding: UTF-8
-      string: '{"address":"integration-test-email@DOMAIN.TEST","message":"Address
+      string: '{"address":"integration-test+email@DOMAIN.TEST","message":"Address
         has been added to the bounces table"}'
-    http_version: 
+    http_version:
   recorded_at: Fri, 08 Jan 2016 20:33:29 GMT
 - request:
     method: get
-    uri: https://api:<APIKEY>@api.mailgun.net/v3/DOMAIN.TEST/bounces/integration-test-email@DOMAIN.TEST
+    uri: https://api:<APIKEY>@api.mailgun.net/v3/DOMAIN.TEST/bounces/integration-test+email@DOMAIN.TEST
     body:
       encoding: US-ASCII
       string: ''
@@ -84,9 +84,9 @@ http_interactions:
       - Content-Type, x-requested-with
     body:
       encoding: UTF-8
-      string: '{"address":"integration-test-email@DOMAIN.TEST","code":"550","error":"Integration
+      string: '{"address":"integration-test+email@DOMAIN.TEST","code":"550","error":"Integration
         Test","created_at":"Fri, 08 Jan 2016 20:33:28 UTC"}'
-    http_version: 
+    http_version:
   recorded_at: Fri, 08 Jan 2016 20:33:29 GMT
 - request:
     method: get
@@ -126,13 +126,13 @@ http_interactions:
       - Content-Type, x-requested-with
     body:
       encoding: UTF-8
-      string: '{"items":[{"address":"integration-test-email@DOMAIN.TEST","code":"550","error":"Integration
-        Test","created_at":"Fri, 08 Jan 2016 20:33:28 UTC"}],"paging":{"first":"https://api.mailgun.net/v3/DOMAIN.TEST/bounces?limit=100","last":"https://api.mailgun.net/v3/DOMAIN.TEST/bounces?page=last\u0026limit=100","next":"https://api.mailgun.net/v3/DOMAIN.TEST/bounces?page=next\u0026address=integration-test-email%40DOMAIN.TEST\u0026limit=100","previous":"https://api.mailgun.net/v3/DOMAIN.TEST/bounces?page=previous\u0026address=integration-test-email%40DOMAIN.TEST\u0026limit=100"}}'
-    http_version: 
+      string: '{"items":[{"address":"integration-test+email@DOMAIN.TEST","code":"550","error":"Integration
+        Test","created_at":"Fri, 08 Jan 2016 20:33:28 UTC"}],"paging":{"first":"https://api.mailgun.net/v3/DOMAIN.TEST/bounces?limit=100","last":"https://api.mailgun.net/v3/DOMAIN.TEST/bounces?page=last\u0026limit=100","next":"https://api.mailgun.net/v3/DOMAIN.TEST/bounces?page=next\u0026address=integration-test%2Bemaill%40DOMAIN.TEST\u0026limit=100","previous":"https://api.mailgun.net/v3/DOMAIN.TEST/bounces?page=previous\u0026address=integration-test%2Bemail%40DOMAIN.TEST\u0026limit=100"}}'
+    http_version:
   recorded_at: Fri, 08 Jan 2016 20:33:29 GMT
 - request:
     method: delete
-    uri: https://api:<APIKEY>@api.mailgun.net/v3/DOMAIN.TEST/bounces/integration-test-email@DOMAIN.TEST
+    uri: https://api:<APIKEY>@api.mailgun.net/v3/DOMAIN.TEST/bounces/integration-test+email@DOMAIN.TEST
     body:
       encoding: US-ASCII
       string: ''
@@ -168,8 +168,8 @@ http_interactions:
       - Content-Type, x-requested-with
     body:
       encoding: UTF-8
-      string: '{"address":"integration-test-email@DOMAIN.TEST","message":"Bounced
+      string: '{"address":"integration-test+email@DOMAIN.TEST","message":"Bounced
         address has been removed"}'
-    http_version: 
+    http_version:
   recorded_at: Fri, 08 Jan 2016 20:33:30 GMT
 recorded_with: VCR 3.0.1

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mailgun-ruby
 version: !ruby/object:Gem::Version
-  version: 1.2.6
+  version: 1.2.7
 platform: ruby
 authors:
 - Mailgun
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-20 00:00:00.000000000 Z
+date: 2023-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -162,6 +162,7 @@ files:
 - docs/Webhooks.md
 - docs/railgun/Overview.md
 - docs/railgun/Parameters.md
+- docs/railgun/Templates.md
 - lib/mailgun-ruby.rb
 - lib/mailgun.rb
 - lib/mailgun/address.rb