t-mailer 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b2fc41c057851b98263832287904972730bbc50c8fbbccc6e8c0b809a9b60a8
-  data.tar.gz: 89d5028cbbc58761d441967ee73bc5c3ca76f0554e94722e7be27ba90d767e04
+  metadata.gz: 94d951afcaf5e7063342df78a3ffa4518db83868fbd030ee836d614a55e10a8c
+  data.tar.gz: 68c9c354b3f07563429427da04692e9adb59350976ff00582a069454a8e54525
 SHA512:
-  metadata.gz: 608cfd88506f40969518e79dec35354a55e37872ff608bde1dd333543923a00ddc085f33472686765f1ba494144f45feb345161dccca0922084e30cb80a83d43
-  data.tar.gz: 81db1670342b34322de45e50f6b57739f54b12329e189e3b7fce1d65a4aabc53aa55d2fb7e190b421d903de5501a1e394593c35c18fb49df0530a65591bb3a30
+  metadata.gz: 9ec15a39899a7a3d6a73858e7c14eda9e9a5f6794528215b62849ed51dcab8152fc0b2719fbb3be217ce2f8371d3f2a31e6bd8efbe4b4ac7863766a6103c3d06
+  data.tar.gz: 0f3c6beba852aa5962d930a349ba9c8a48cab888ff5020dd4839e877e6a18e18e594300e9603905eae2ab47cff670df307089ccfae0cb2ea97664eb15d975000

data/README.md

@@ -1,6 +1,7 @@
 # T-mailer
 
 [![Build Status](https://travis-ci.com/100Starlings/t-mailer.svg?branch=master)](https://travis-ci.com/100Starlings/t-mailer)
+[![Gem Version](https://badge.fury.io/rb/t-mailer.svg)](https://badge.fury.io/rb/t-mailer)
 
 **T-mailer** helps you to use **ActionMailer** with different providers' **API**. It sends emails using **raw/rfc822** message type. Which means it converts the mail object to string and sends it completely. There is no any intermediate changes, so what you send is what you get. It supports more APIs (see below) and you can decide which one would like to use. It allows you to send different emails with different APIs. It can help to move between providers, load balacing or cost management.
 

data/lib/t/mailer.rb

@@ -66,7 +66,7 @@ module T
       # credentials automatically (no need config/initializers/t-mailer.rb file).
       # If environment variable does not exist then it will leave it blank.
       #
-      # @param [String] credential/API key variable name
+      # @param [String] variable_name the credential/API key variable name
       def set_credential(variable_name)
         if ENV[variable_name].nil?
           public_send("#{variable_name.downcase}=", "")

data/lib/t/mailer/api/aws_ses.rb

@@ -11,7 +11,7 @@ module T
         # Set settings and check if the required credentials are exist. If the
         # credentials are missing then it will raise error.
         #
-        # @param [Hash] with the credentials
+        # @param [Hash] options with the credentials
         def initialize(options)
           @settings = options
 
@@ -89,7 +89,7 @@ module T
         #
         # @overload send_raw_email(params = {})
         #
-        # @param [Hash] with the details of the email
+        # @param [Hash] params with the details of the email
         #
         # @return [Object]
         #   #<struct Aws::SES::Types::SendRawEmailResponse message_id="an_id">

data/lib/t/mailer/api/spark_post.rb

@@ -12,7 +12,7 @@ module T
           # Set settings and check if the required credential exists. If the
           # credential is missing then it will raise error.
           #
-          # @param [Hash] with the credentials
+          # @param [Hash] options with the credentials
           def initialize(options)
             @settings = options
 
@@ -63,7 +63,7 @@ module T
           #   }
           # }
           #
-          # @param [Hash] with the details of the email
+          # @param [Hash] attrs with the details of the email
           #
           # @return [Hash] with the server response
           def create(attrs)

data/lib/t/mailer/delivery_method.rb

@@ -10,7 +10,7 @@ module T
       # with the default. If credentials has been added then it will override
       # the default credentials.
       #
-      # @param [Hash] with the credentials
+      # @param [Hash] options with the credentials
       def initialize(options = {})
         @settings = {
           aws_access_key_id:     T::Mailer.configuration.aws_access_key_id,

data/lib/t/mailer/delivery_system/aws_ses.rb

@@ -9,7 +9,7 @@ module T
         # Set settings with the required credentials for the API, but allow to
         # call this delivery system without it.
         #
-        # @param [Hash] with the credentials
+        # @param [Hash] options with the credentials
         def initialize(options = {})
           @settings = options
         end

data/lib/t/mailer/delivery_system/spark_post.rb

@@ -9,7 +9,7 @@ module T
         # Set settings with the required credentials for the API, but allow to
         # call this delivery system without it.
         #
-        # @param [Hash] with the credentials
+        # @param [Hash] options with the credentials
         def initialize(options = {})
           @settings = options
         end

data/lib/t/mailer/helper.rb

@@ -3,7 +3,7 @@ module T
     module Helper
       # Check gem is installed or not. If not it will raise error.
       #
-      # @param [String] a API's class name
+      # @param [String] klass the API's class name
       def check_api_defined(klass)
         unless T::Mailer.const_defined?(klass)
           fail Error::DeliverySystemNotDefined,
@@ -14,7 +14,7 @@ module T
       # Check API credentials were given.
       # If one is missing or empty it will raise error.
       #
-      # @param [List] comma separated values/symbols
+      # @param [List] required_values a comma separated values/symbols
       def check_settings(*required_values)
         has_all_settings =
           settings.values_at(*required_values).all? do |setting|
@@ -29,8 +29,8 @@ module T
 
       # Check the version of a gem.
       #
-      # @param [String] the name of the gem
-      # @param [String] the satisfied version of the gem
+      # @param [String] gem_name the name of the gem
+      # @param [String] version the satisfied version of the gem
       #
       # @return [Boolean] true/false
       def check_version_of(gem_name, version)
@@ -55,7 +55,7 @@ module T
 
       # Gets uparsed value of the mail message fields.
       #
-      # @param [Mail::Field]
+      # @param [Mail::Field] message_field
       #
       # @return [String/Hash] with the field unparsed value
       def get_value_from(message_field)
@@ -66,9 +66,9 @@ module T
 
       # Which gem using an API class.
       #
-      # @param [String] class name
+      # @param [String] klass the class name
       #
-      # @retrun [String] the gem name which should use
+      # @return [String] the gem name which should use
       def using_gem(klass)
         case klass
         when "Api::AwsSes"

data/lib/t/mailer/version.rb

@@ -1,5 +1,5 @@
 module T
   module Mailer
-    VERSION = "0.1.1".freeze
+    VERSION = "0.1.2".freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: t-mailer
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Norbert Szivós