mailgun-ruby 1.2.0 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68010cfb6e35b2a015974c634c156f502a7fe76e75e571ad394761d8e6a50d97
-  data.tar.gz: 14f7dc96ffbb2d5bf1e499a336efe276235e0b260c580b40171236b3ea5f77fd
+  metadata.gz: 4fec3197ad0202b588d430e3bbbc96e822961e0213a9b45882e5f6490bd9b5bf
+  data.tar.gz: 8db91a5a020812f436900efb0d181baede311ed6a6d8390a28fa907a32099897
 SHA512:
-  metadata.gz: 39d8397545a5c30c703cde0c32558c595d4479faa91595299232b113b23d60d0e0ad88f197616fc6a8d2cde2c1952cc3c9effe5fced19a208f5f290cca45f658
-  data.tar.gz: 2eed77f10d1090339987b0a9b120a65017267ced80e694a7710b5058fd14145bab6a2c091c39fa6495c52242648b9524fc88c0a35c782b6dd7057aa57691c16e
+  metadata.gz: 164c3e148cd16078ad96c2f60620720e754a412dc8ae69bb0248b1e0dc599e5f570314e5b668a356ff90e3e12e1e72879276c9ccf91901c9502ad98cf56a7781
+  data.tar.gz: be6d57fca9b0224ddc99a17831bef724e05a6e63dfef177c9d478bec8efefe943bf3f07886902da015474d0e5c2a33ddf797cf7ba11db1c7ce2eda8648b0ea35

data/README.md

@@ -19,7 +19,7 @@ gem install mailgun-ruby
 Gemfile:
 
 ```ruby
-gem 'mailgun-ruby', '~>1.1.6'
+gem 'mailgun-ruby', '~>1.2.3'
 ```
 
 Usage
@@ -56,6 +56,12 @@ domain = 'example.com'
 result = mg_client.get("#{domain}/events", {:event => 'delivered'})
 ```
 
+If you're using the EU domains, make sure you specify it when creating the client:
+
+```
+mg_client = Mailgun::Client.new 'your-api-key', 'api.eu.mailgun.net'
+```
+
 Rails
 -----
 
@@ -74,6 +80,7 @@ and replace `api-myapikey` and `mydomain.com` with your secret API key and domai
   config.action_mailer.mailgun_settings = {
     api_key: 'api-myapikey',
     domain: 'mydomain.com',
+    # api_host: 'api.eu.mailgun.net'  # Uncomment this line for EU region domains
   }
 ```
 

data/lib/mailgun/client.rb

@@ -17,12 +17,15 @@ module Mailgun
                    test_mode = false,
                    timeout = nil)
 
+      rest_client_params = {
+        user: 'api',
+        password: api_key,
+        user_agent: "mailgun-sdk-ruby/#{Mailgun::VERSION}"
+      }
+      rest_client_params[:timeout] = timeout if timeout
+
       endpoint = endpoint_generator(api_host, api_version, ssl)
-      @http_client = RestClient::Resource.new(endpoint,
-                                              user: 'api',
-                                              password: api_key,
-                                              user_agent: "mailgun-sdk-ruby/#{Mailgun::VERSION}",
-                                              timeout: timeout)
+      @http_client = RestClient::Resource.new(endpoint, rest_client_params)
       @test_mode = test_mode
     end
 

data/lib/mailgun/messages/batch_message.rb

@@ -111,6 +111,7 @@ module Mailgun
     # This method resets the message object to prepare for the next batch
     # of recipients.
     def reset_message
+      @recipient_variables = {}
       @message.delete('recipient-variables')
       @message.delete(:to)
       @message.delete(:cc)

data/lib/mailgun/messages/message_builder.rb

@@ -1,3 +1,4 @@
+require 'mime/types'
 require 'time'
 
 module Mailgun
@@ -197,7 +198,7 @@ module Mailgun
     # @param [Boolean] tracking Boolean true or false.
     # @return [void]
     def track_opens(mode)
-      set_multi_simple('o:tracking-opens', bool_lookup(mode))
+      set_single('o:tracking-opens', bool_lookup(mode))
     end
 
     # Deprecated: 'set_open_tracking' is deprecated. Please use 'track_opens' instead.
@@ -211,7 +212,7 @@ module Mailgun
     # @param [String] mode True, False, or HTML (for HTML only tracking)
     # @return [void]
     def track_clicks(mode)
-      set_multi_simple('o:tracking-clicks', bool_lookup(mode))
+      set_single('o:tracking-clicks', bool_lookup(mode))
     end
 
     # Depreciated: 'set_click_tracking. is deprecated. Please use 'track_clicks' instead.
@@ -389,7 +390,7 @@ module Mailgun
         full_name = "#{vars['first']} #{vars['last']}".strip
       end 
 
-      return "'#{full_name}' <#{address}>" if defined?(full_name)
+      return "'#{full_name}' <#{address}>" if full_name
       address
     end
 
@@ -409,6 +410,12 @@ module Mailgun
         'Unable to access attachment file object.'
       ) unless attachment.respond_to?(:read)
 
+      if attachment.respond_to?(:path) && !attachment.respond_to?(:content_type)
+        mime_types = MIME::Types.type_for(attachment.path)
+        content_type = mime_types.empty? ? 'application/octet-stream' : mime_types[0].content_type
+        attachment.instance_eval "def content_type; '#{content_type}'; end"
+      end
+
       unless filename.nil?
         attachment.instance_variable_set :@original_filename, filename
         attachment.instance_eval 'def original_filename; @original_filename; end'

data/lib/mailgun/suppressions.rb

@@ -157,7 +157,10 @@ module Mailgun
 
         unsubscribe.each do |k, v|
           # Hash values MUST be strings.
-          if not v.is_a? String then
+          # However, unsubscribes contain an array of tags
+          if v.is_a? Array
+            unsubscribe[k] = v.map(&:to_s)
+          elsif !v.is_a? String
             unsubscribe[k] = v.to_s
           end
         end

data/lib/mailgun/version.rb

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

data/lib/railgun/mailer.rb

@@ -32,6 +32,8 @@ module Railgun
         config[:api_host] || 'api.mailgun.net',
         config[:api_version] || 'v3',
         config[:api_ssl].nil? ? true : config[:api_ssl],
+        false,
+        config[:timeout],
       )
       @domain = @config[:domain]
 
@@ -83,7 +85,7 @@ module Railgun
 
     # o:* attributes (options)
     mail.mailgun_options.try(:each) do |k, v|
-      message["o:#{k}"] = v
+      message["o:#{k}"] = v.dup
     end
 
     # support for using ActionMailer's `headers()` inside of the mailer

data/mailgun.gemspec

@@ -32,6 +32,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'vcr', '~> 3.0.3'
   spec.add_development_dependency 'simplecov', '~> 0.16.1'
   spec.add_development_dependency 'rails'
-  spec.add_dependency 'rest-client', '~> 2.0.2'
+  spec.add_dependency 'rest-client', '>= 2.0.2'
 
 end

data/spec/integration/suppressions_spec.rb

@@ -52,7 +52,7 @@ describe 'For the suppressions handling class', order: :defined, vcr: vcr_opts d
     end
   end
 
-  it 'can batch-add unsubscribes' do
+  it 'can batch-add unsubscribes with tags as string' do
     unsubscribes = []
     @addresses.each do |addr|
       unsubscribes.push({
@@ -69,6 +69,23 @@ describe 'For the suppressions handling class', order: :defined, vcr: vcr_opts d
     expect(nested.length).to eq(0)
   end
 
+  it 'can batch-add unsubscribes with tags as array' do
+    unsubscribes = []
+    @addresses.each do |addr|
+      unsubscribes.push({
+        :address => addr,
+        :tags => ['integration'],
+      })
+    end
+
+    response, nested = @suppress.create_unsubscribes unsubscribes
+    response.to_h!
+
+    expect(response.code).to eq(200)
+    expect(response.body['message']).to eq('4 addresses have been added to the unsubscribes table')
+    expect(nested.length).to eq(0)
+  end
+
   it 'raises ParameterError if no unsubscribe[:address] is present' do
     unsubscribes = []
     unsubscribes.push({
@@ -123,4 +140,3 @@ describe 'For the suppressions handling class', order: :defined, vcr: vcr_opts d
 
   # TODO: Add tests for pagination support.
 end
-

data/spec/unit/messages/batch_message_spec.rb

@@ -95,6 +95,7 @@ describe 'The method add_recipient' do
     expect(@mb_obj.counters[:recipients][recipient_type]).to eq(1000)
     @mb_obj.finalize
 
+    expect(@mb_obj.recipient_variables).to eq({})
     expect(@mb_obj.message['recipient-variables'].length).to eq(0)
     expect(@mb_obj.message[:to].length).to eq(0)
     expect(@mb_obj.counters[:recipients][recipient_type]).to eq(0)

data/spec/unit/messages/message_builder_spec.rb

@@ -50,6 +50,16 @@ describe 'The method add_recipient' do
     expect(@mb_obj.counters[:recipients][recipient_type]).to eq(1)
   end
 
+  context 'when variables is empty and recepeint type - "to"' do
+    it 'adds email address as "to" recipient type and increments counter' do
+      recipient_type = :to
+      @mb_obj.add_recipient(recipient_type, @address, {})
+
+      expect(@mb_obj.message[recipient_type][0]).to eq("#{@address}")
+      expect(@mb_obj.counters[:recipients][recipient_type]).to eq(1)
+    end
+  end
+
   it 'adds a "cc" recipient type to the message body and counter is incremented' do
     recipient_type = :cc
     @mb_obj.add_recipient(recipient_type, @address, @variables)
@@ -246,6 +256,16 @@ describe 'The method add_attachment' do
     expect(@mb_obj.message[:attachment].length).to eq(1)
     expect(@mb_obj.message[:attachment].first.original_filename).to eq 'mailgun_icon.png'
   end
+
+  context 'when attachment has unknown type' do
+    it 'sets content type application/octet-stream for attachment' do
+      file = File.dirname(__FILE__) + "/sample_data/unknown.type"
+
+      @mb_obj.add_attachment(file)
+
+      expect(@mb_obj.message[:attachment][0].content_type).to eq('application/octet-stream')
+    end
+  end
 end
 
 describe 'The method add_inline_image' do
@@ -440,19 +460,19 @@ describe 'The method track_opens' do
   it 'enables/disables open tracking on a per message basis.' do
     @mb_obj.track_opens('Yes')
 
-    expect(@mb_obj.message["o:tracking-opens"][0]).to eq("yes")
+    expect(@mb_obj.message["o:tracking-opens"]).to eq("yes")
 
     @mb_obj.track_opens('No')
 
-    expect(@mb_obj.message["o:tracking-opens"][0]).to eq("no")
+    expect(@mb_obj.message["o:tracking-opens"]).to eq("no")
 
     @mb_obj.track_opens(true)
 
-    expect(@mb_obj.message["o:tracking-opens"][0]).to eq("yes")
+    expect(@mb_obj.message["o:tracking-opens"]).to eq("yes")
 
     @mb_obj.track_opens(false)
 
-    expect(@mb_obj.message["o:tracking-opens"][0]).to eq("no")
+    expect(@mb_obj.message["o:tracking-opens"]).to eq("no")
   end
 end
 
@@ -471,23 +491,23 @@ describe 'The method track_clicks' do
   it 'enables/disables click tracking on a per message basis.' do
     @mb_obj.track_clicks('Yes')
 
-    expect(@mb_obj.message["o:tracking-clicks"][0]).to eq("yes")
+    expect(@mb_obj.message["o:tracking-clicks"]).to eq("yes")
 
     @mb_obj.track_clicks('No')
 
-    expect(@mb_obj.message["o:tracking-clicks"][0]).to eq("no")
+    expect(@mb_obj.message["o:tracking-clicks"]).to eq("no")
 
     @mb_obj.track_clicks(true)
 
-    expect(@mb_obj.message["o:tracking-clicks"][0]).to eq("yes")
+    expect(@mb_obj.message["o:tracking-clicks"]).to eq("yes")
 
     @mb_obj.track_clicks(false)
 
-    expect(@mb_obj.message["o:tracking-clicks"][0]).to eq("no")
+    expect(@mb_obj.message["o:tracking-clicks"]).to eq("no")
 
     @mb_obj.track_clicks('html')
 
-    expect(@mb_obj.message["o:tracking-clicks"][0]).to eq("html")
+    expect(@mb_obj.message["o:tracking-clicks"]).to eq("html")
   end
 end
 

data/spec/unit/railgun/mailer_spec.rb

@@ -72,6 +72,18 @@ describe 'Railgun::Mailer' do
     expect(body['o:tracking-opens']).to eq('true')
   end
 
+  it 'accepts frozen options to message body' do
+    message = UnitTestMailer.plain_message('test@example.org', '', {})
+    message.mailgun_options ||= {
+      'tags' => ['some-tag']
+    }
+
+    body = Railgun.transform_for_mailgun(message)
+
+    expect(body).to include('o:tags')
+    expect(body['o:tags']).to eq(['some-tag'])
+  end
+
   it 'adds variables to message body' do
     message = UnitTestMailer.plain_message('test@example.org', '', {})
     message.mailgun_variables ||= {

data/vcr_cassettes/suppressions.yml

@@ -49,7 +49,7 @@ http_interactions:
     body:
       encoding: UTF-8
       string: '{"message":"4 addresses have been added to the bounces table"}'
-    http_version: 
+    http_version:
   recorded_at: Wed, 30 Nov 2016 20:53:49 GMT
 - request:
     method: delete
@@ -93,7 +93,7 @@ http_interactions:
       encoding: UTF-8
       string: '{"address":"test1@example.com","message":"Bounced address has been
         removed"}'
-    http_version: 
+    http_version:
   recorded_at: Wed, 30 Nov 2016 20:53:49 GMT
 - request:
     method: delete
@@ -137,7 +137,7 @@ http_interactions:
       encoding: UTF-8
       string: '{"address":"test2@example.org","message":"Bounced address has been
         removed"}'
-    http_version: 
+    http_version:
   recorded_at: Wed, 30 Nov 2016 20:53:50 GMT
 - request:
     method: delete
@@ -181,7 +181,7 @@ http_interactions:
       encoding: UTF-8
       string: '{"address":"test3@example.net","message":"Bounced address has been
         removed"}'
-    http_version: 
+    http_version:
   recorded_at: Wed, 30 Nov 2016 20:53:50 GMT
 - request:
     method: delete
@@ -225,7 +225,7 @@ http_interactions:
       encoding: UTF-8
       string: '{"address":"test4@example.info","message":"Bounced address has been
         removed"}'
-    http_version: 
+    http_version:
   recorded_at: Wed, 30 Nov 2016 20:53:50 GMT
 - request:
     method: post
@@ -274,7 +274,7 @@ http_interactions:
     body:
       encoding: UTF-8
       string: '{"message":"4 addresses have been added to the unsubscribes table"}'
-    http_version: 
+    http_version:
   recorded_at: Wed, 30 Nov 2016 20:53:51 GMT
 - request:
     method: delete
@@ -318,7 +318,7 @@ http_interactions:
       encoding: UTF-8
       string: '{"address":"test1@example.com","message":"Unsubscribe event has been
         removed"}'
-    http_version: 
+    http_version:
   recorded_at: Wed, 30 Nov 2016 20:53:51 GMT
 - request:
     method: delete
@@ -362,7 +362,7 @@ http_interactions:
       encoding: UTF-8
       string: '{"address":"test2@example.org","message":"Unsubscribe event has been
         removed"}'
-    http_version: 
+    http_version:
   recorded_at: Wed, 30 Nov 2016 20:53:51 GMT
 - request:
     method: delete
@@ -406,7 +406,7 @@ http_interactions:
       encoding: UTF-8
       string: '{"address":"test3@example.net","message":"Unsubscribe event has been
         removed"}'
-    http_version: 
+    http_version:
   recorded_at: Wed, 30 Nov 2016 20:53:51 GMT
 - request:
     method: delete
@@ -450,7 +450,7 @@ http_interactions:
       encoding: UTF-8
       string: '{"address":"test4@example.info","message":"Unsubscribe event has been
         removed"}'
-    http_version: 
+    http_version:
   recorded_at: Wed, 30 Nov 2016 20:53:52 GMT
 - request:
     method: post
@@ -498,7 +498,7 @@ http_interactions:
       encoding: UTF-8
       string: '{"message":"4 complaint addresses have been added to the complaints
         table"}'
-    http_version: 
+    http_version:
   recorded_at: Wed, 30 Nov 2016 20:53:52 GMT
 - request:
     method: delete
@@ -541,7 +541,7 @@ http_interactions:
     body:
       encoding: UTF-8
       string: '{"address":"test1@example.com","message":"Spam complaint has been removed"}'
-    http_version: 
+    http_version:
   recorded_at: Wed, 30 Nov 2016 20:53:52 GMT
 - request:
     method: delete
@@ -584,7 +584,7 @@ http_interactions:
     body:
       encoding: UTF-8
       string: '{"address":"test2@example.org","message":"Spam complaint has been removed"}'
-    http_version: 
+    http_version:
   recorded_at: Wed, 30 Nov 2016 20:53:52 GMT
 - request:
     method: delete
@@ -627,7 +627,7 @@ http_interactions:
     body:
       encoding: UTF-8
       string: '{"address":"test3@example.net","message":"Spam complaint has been removed"}'
-    http_version: 
+    http_version:
   recorded_at: Wed, 30 Nov 2016 20:53:53 GMT
 - request:
     method: delete
@@ -671,6 +671,57 @@ http_interactions:
       encoding: UTF-8
       string: '{"address":"test4@example.info","message":"Spam complaint has been
         removed"}'
-    http_version: 
+    http_version:
   recorded_at: Wed, 30 Nov 2016 20:53:53 GMT
+- request:
+    method: post
+    uri: https://api:<APIKEY>@api.mailgun.net/v3/DOMAIN.TEST/unsubscribes
+    body:
+      encoding: UTF-8
+      string: '[{"address":"test4@example.info","tag":"integration"},{"address":"test3@example.net","tag":"integration"},{"address":"test2@example.org","tag":"integration"},{"address":"test1@example.com","tag":"integration"}]'
+    headers:
+      Accept:
+      - "*/*"
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - rest-client/2.0.2 (darwin18.7.0 x86_64) ruby/2.5.7p206
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '210'
+      Host:
+      - api.mailgun.net
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Headers:
+      - Content-Type, x-requested-with
+      Access-Control-Allow-Methods:
+      - GET, POST, PUT, DELETE, OPTIONS
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Max-Age:
+      - '600'
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Tue, 04 Feb 2020 15:16:07 GMT
+      Server:
+      - nginx
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains
+      Content-Length:
+      - '68'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"message":"4 addresses have been added to the unsubscribes table"}
+
+        '
+    http_version:
+  recorded_at: Tue, 04 Feb 2020 15:16:07 GMT
 recorded_with: VCR 3.0.3

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: mailgun-ruby
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.3
 platform: ruby
 authors:
 - Mailgun
 - Travis Swientek
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-08-12 00:00:00.000000000 Z
+date: 2021-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -127,14 +127,14 @@ dependencies:
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.2
 description: Mailgun's Official Ruby SDK for interacting with the Mailgun API.
@@ -209,6 +209,7 @@ files:
 - spec/unit/messages/sample_data/mailgun_icon.png
 - spec/unit/messages/sample_data/mime.txt
 - spec/unit/messages/sample_data/rackspace_logo.jpg
+- spec/unit/messages/sample_data/unknown.type
 - spec/unit/railgun/content_type_spec.rb
 - spec/unit/railgun/mailer_spec.rb
 - vcr_cassettes/bounces.yml
@@ -231,7 +232,7 @@ homepage: http://www.mailgun.com
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -246,9 +247,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
-signing_key: 
+rubygems_version: 3.0.9
+signing_key:
 specification_version: 4
 summary: Mailgun's Official Ruby SDK
 test_files:
@@ -277,5 +277,6 @@ test_files:
 - spec/unit/messages/sample_data/mailgun_icon.png
 - spec/unit/messages/sample_data/mime.txt
 - spec/unit/messages/sample_data/rackspace_logo.jpg
+- spec/unit/messages/sample_data/unknown.type
 - spec/unit/railgun/content_type_spec.rb
 - spec/unit/railgun/mailer_spec.rb