action_mailer_kafka 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b7345d1145d840492978828091a1a9ebe4b3c08b
+  data.tar.gz: ffdb7a81954a33a0e03bad1f3e5757403af7743a
+SHA512:
+  metadata.gz: a4db5bd4229ff0091911ac61c188f33029c4c0f67bda9b147fd6a91267b1fc435087e63b5c2e75aa875771cbeb2e65a0ee1461625583b6c7d5f5de6a3c5b8f40
+  data.tar.gz: dfd02e92da664c07175beb643cff16cdfa572df8c5be70eb90bfbf1cb9ce620e9ce07728df08b5ed271092f40b62c0ade9b1fc78c6cf23f178142d1b026f2076

data/.circleci/config.yml

@@ -0,0 +1,158 @@
+version: 2
+jobs:
+  rubycritic:
+    docker:
+      - image: circleci/ruby:2.3
+        environment:
+          LOG_LEVEL: DEBUG
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            - v1-dependencies-{{ checksum "eh-mailer.gemspec" }}
+            # fallback to using the latest cache if no exact match is found
+            - v1-dependencies-
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "eh-mailer.gemspec" }}
+      - run: bundle exec rubycritic -s 90 --no-browser -f console --suppress-ratings lib/
+
+  rubocop:
+    docker:
+      - image: circleci/ruby:2.3
+        environment:
+          LOG_LEVEL: DEBUG
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            - v1-dependencies-{{ checksum "eh-mailer.gemspec" }}
+            # fallback to using the latest cache if no exact match is found
+            - v1-dependencies-
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "eh-mailer.gemspec" }}
+      - run: bundle exec rubocop
+
+  unit:
+    docker:
+      - image: circleci/ruby:2.3
+        environment:
+          LOG_LEVEL: DEBUG
+    working_directory: ~/app
+    steps:
+      - checkout
+
+      # download and cache dependencies
+      - restore_cache:
+          keys:
+            - v1-dependencies-{{ checksum "eh-mailer.gemspec" }}
+            # fallback to using the latest cache if no exact match is found
+            - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+            bundle exec appraisal install
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "eh-mailer.gemspec" }}
+
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            mkdir /tmp/test-results
+            TEST_FILES="$(circleci tests glob "spec/units/**/*_spec.rb" | \
+              circleci tests split --split-by=timings)"
+
+            COVERAGE=true bundle exec appraisal rspec \
+              --format progress \
+              --color \
+              $TEST_FILES
+
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results
+
+  integration_rails_4:
+    docker:
+      - image: circleci/ruby:2.3
+        environment:
+          LOG_LEVEL: DEBUG
+          INTEGRATION_TEST: true
+      - image: wurstmeister/zookeeper
+      - image: wurstmeister/kafka:0.11.0.1
+        environment:
+          KAFKA_ADVERTISED_HOST_NAME: localhost
+          KAFKA_ADVERTISED_PORT: 9092
+          KAFKA_PORT: 9092
+          KAFKA_ZOOKEEPER_CONNECT: localhost:2181
+          KAFKA_DELETE_TOPIC_ENABLE: true
+
+    working_directory: ~/app
+    steps:
+      - checkout
+      - run:
+          name: install dependencies
+          command: |
+            BUNDLE_GEMFILE=./gemfiles/rails_4.gemfile bundle install --path ~/app/vendor/bundle
+      - run:
+          name: run integration tests
+          command: |
+            bundle exec rspec spec/integrations/rails_integration_spec.rb
+
+  integration_rails_5:
+    docker:
+      - image: circleci/ruby:2.3
+        environment:
+          LOG_LEVEL: DEBUG
+          INTEGRATION_TEST: true
+      - image: wurstmeister/zookeeper
+      - image: wurstmeister/kafka:0.11.0.1
+        environment:
+          KAFKA_ADVERTISED_HOST_NAME: localhost
+          KAFKA_ADVERTISED_PORT: 9092
+          KAFKA_PORT: 9092
+          KAFKA_ZOOKEEPER_CONNECT: localhost:2181
+          KAFKA_DELETE_TOPIC_ENABLE: true
+
+    working_directory: ~/app
+    steps:
+      - checkout
+      - run:
+          name: install dependencies
+          command: |
+            BUNDLE_GEMFILE=./gemfiles/rails_5.gemfile bundle install --path ~/app/vendor/bundle
+      - run:
+          name: run integration tests
+          command: |
+             bundle exec rspec spec/integrations/rails_integration_spec.rb
+
+workflows:
+  version: 2
+  test:
+    jobs:
+      - unit
+      - integration_rails_4
+      - integration_rails_5
+      - rubycritic
+      - rubocop

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+tags
+.byebug_history
+Gemfile.lock
+gemfiles/*.gemfile.lock
+coverage
+tmp
+vendor

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,64 @@
+require: rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.3
+  Exclude:
+    - 'vendor/**/*'
+    - 'Rakefile'
+    - 'scripts/**/*'
+    - 'bin/*'
+    - 'example/**/*'
+    - 'gemfiles/*'
+    - 'Appraisals'
+    - 'tmp/**/*'
+
+Style/GuardClause:
+  Enabled: no
+
+Style/Documentation:
+  Enabled: no
+
+Style/HashSyntax:
+  Enabled: no
+
+Style/IfUnlessModifier:
+  Enabled: no
+
+RSpec/NestedGroups:
+  Max: 4
+
+RSpec/ExampleLength:
+  Enabled: no
+
+RSpec/MultipleExpectations:
+  Enabled: no
+
+RSpec/EmptyExampleGroup:
+  Enabled: no
+
+RSpec/DescribeClass:
+  Enabled: no
+
+Metrics/BlockLength:
+  Enabled: no
+
+Metrics/MethodLength:
+  Enabled: no
+
+Metrics/AbcSize:
+  Enabled: no
+
+Metrics/ClassLength:
+  Enabled: no
+
+Metrics/ParameterLists:
+  Enabled: no
+
+Lint/UnusedMethodArgument:
+  Enabled: no
+
+Style/FrozenStringLiteralComment:
+  Enabled: no
+
+Metrics/LineLength:
+  Max: 120

data/Appraisals

@@ -0,0 +1,21 @@
+if ENV['INTEGRATION_TEST']
+  appraise "rails-4" do
+    gem "rails", "~> 4.0"
+  end
+
+  appraise "rails-5" do
+    gem "rails", "~> 5.0"
+  end
+else
+  appraise "mail-2-5" do
+    gem "mail", "~> 2.5.2"
+  end
+
+  appraise "mail-2-6" do
+    gem "mail", "~> 2.6.0"
+  end
+
+  appraise "mail-2-7" do
+    gem "mail", "~> 2.7.0"
+  end
+end

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+Changes and additions to the library will be listed here.
+
+## 0.1.0
+- Open source the gem. 
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in action_mailer_kafka.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,23 @@
+Copyright (c) 2019 Luong Vo
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/README.md

@@ -0,0 +1,138 @@
+# ActionMailerKafka
+[![CircleCI](https://circleci.com/gh/luong-komorebi/action-mailer-kafka/tree/master.svg?style=svg)](https://circleci.com/gh/luong-komorebi/action-mailer-kafka/tree/master)
+
+
+<p align="center">
+  <img src="./logo.png">
+</p>
+
+This gem is a unified interface to send emails to Kafka message queue. It takes care of the transport layer by defining a delivery method for `action-mailer`. 
+
+To see the gem in action, go to example folder and start the example rails app.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'action_mailer_kafka'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install action_mailer_kafka
+
+## Usage
+
+### Rails
+
+This Gem is tested with Rails version 4. and 5.
+
+To use the gem, change action mailer's delivery method to `action_mailer_kafka`
+
+```ruby
+# for example, in config/environments/production.rb
+config.action_mailer.delivery_method = :action_mailer_kafka
+```
+
+#### Kafa settings
+The gem accepts 2 kinds of kafka setting params:
+
+1. Your Kafka publish proc
+
+
+With this option, you should config as below:
+
+```ruby
+config.action_mailer.action_mailer_kafka_settings = {
+  kafka_mail_topic: 'YourKafkaTopic',
+  kafka_publish_proc: proc do |message_data, default_message_topic|
+                          YourKafkaClientInstance.publish(message_data, default_message_topic)
+                        end
+}
+```
+
+and the data would go through your publish process.
+
+
+2. Your kafka client info
+
+With this option, the library will generate a kafka instance for you:
+
+```ruby
+config.action_mailer.action_mailer_kafka_settings = {
+  kafka_mail_topic: 'YourKafkaTopic',
+  kafka_client_info: {
+    seed_brokers: ['localhost:9090'],
+    logger: logger,
+    ssl_ca_cert: File.read('/path/to/cert')
+    # For more option on what to pass here, see https://github.com/zendesk/ruby-kafka/blob/master/lib/kafka/client.rb#L20
+  }
+}
+```
+
+Other settings params:
+- `raise_on_delivery_error` : a boolean value that decides if this library should raise error.
+- `logger` : pass your own logger instance.
+- `fallback`: fallback method in case Kafka fails due to message being too big or other errors.
+  + `fallback_delivery_method`
+  + `fallback_delivery_method_settings`
+
+Example of smtp as a fallback method:
+```ruby
+  config.action_mailer.action_mailer_kafka_settings = {
+    kafka_mail_topic: 'Mail.Mails.Send.Staging',
+    kafka_client_info: {
+    # .....
+    },
+    fallback: {
+      fallback_delivery_method: :smtp,
+      fallback_delivery_method_settings: {
+        address: 'smtp.sendgrid.net',
+        port: (ENV['SENDGRID_SMTP_PORT'] || 587).to_i,
+        authentication: :plain,
+        user_name: ENV['SENDGRID_USERNAME'],
+        password: ENV['SENDGRID_PASSWORD']
+      }
+    }
+  }
+```
+
+#### Service name
+
+Because the email is sent to Kafka may come from a microservice in your system, an additional field to specify that would be useful. By default, if there is no service name added, the gem will ignore the service name. If provided, the serice name would become a value to the `author` field to the kafka message
+
+```ruby
+config.action_mailer.action_mailer_kafka_settings = {
+  sevice_name: 'local app'
+}
+```
+
+### Other frameworks
+
+Not tested. But this gem is not tight coupled with Rails. It just needs action-mailer.
+
+### Custom headers
+
+The gem would only accepts custom headers for emails which follow [RFC822](tools.ietf.org/html/rfc822) (which means that a custom header should begin with 'X-'). Other custom headers would not be parsed and sent to Kafka to be consumed.
+
+
+## Gem Development
+
+### Testing
+- To run the test, do ` bundle exec rspec `.
+  - To run just the unit tests: ` bundle exec rspec spec/units `
+  - To run just the integration tests: ` bundle exec rspec spec/integrations `
+- To see the coverage of your codes, run ` COVERAGE=true bundle exec rspec `. If coverage drops below 80%, CI will fail
+- To see quality reporter, run ` bundle exec rubycritic -s 90 --suppress-ratings app/ `. If quality score drops below 90, CI will fail
+- On CI, the test is run with multiple versions of `mail` and `rails` gems to ensure compatability. If you want to run such tests on your local machine:
+  - To run unit tests:
+    - First of all, install all dependencies with: ` bundle exec appraisal install `
+    - To run the unit tests, run ` bundle exec appraisal rspec spec/units `
+  - To run integration tests:
+    - First of all, install all dependencies with: ` INTEGRATION_TEST='true' bundle exec appraisal install `
+    - To run the unit tests, run ` bundle exec appraisal rspec spec/integrations `