courier_rails 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ad674601255f7e729de16b884fd64550516ff2930e9c8388345ede8500df9a2e
+  data.tar.gz: ab171f926c7467b79f9406e657986d26cc852346225a542b82e7b1d9c0a9663a
+SHA512:
+  metadata.gz: 0045eca096853ee403d58eaba3cef7e738a99cf0027b758af717bbbe25b81789d16d5286180a1ab049adfe762ecb643c27160f822cb9ad95ec00547c64a742c5
+  data.tar.gz: 3e81c4cc98fa208a4474780522d2454dc4dcf54624b3e8a284890c695b53e6892a036145cbeca3be94d055be9d8aa9431d2b38a33f8281f9ea22807b6eaebb43

data/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,17 @@
+## Expected Behavior
+
+
+## Actual Behavior
+
+
+## Steps to Reproduce the Problem
+
+  1.
+  1.
+  1.
+
+## Specifications
+
+  - Version:
+  - Platform:
+  - Subsystem:

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,27 @@
+## Description of the change
+
+> Description here
+
+## Type of change
+- [ ] Bug fix (non-breaking change that fixes an issue)
+- [ ] New feature (non-breaking change that adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+
+## Related issues
+
+> Fix [#1]() 
+
+## Checklists
+
+### Development
+
+- [ ] Lint rules pass locally
+- [ ] The code changed/added as part of this pull request has been covered with tests
+- [ ] All tests related to the changed code pass in development
+
+### Code review 
+
+- [ ]  This pull request has a descriptive title and information useful to a reviewer. There may be a screenshot or screencast attached
+- [ ] "Ready for review" label attached to the PR and reviewers mentioned in a comment
+- [ ] Changes have been reviewed by at least one other engineer
+- [ ] Issue from task tracker has a link to this pull request 

data/.github/workflows/gem-push.yml

@@ -0,0 +1,33 @@
+name: Ruby Gem
+
+on:
+  push:
+    branches: [main]
+    tags:
+      - v*
+  pull_request:
+    branches: [main]
+
+jobs:
+  build:
+    name: Build + Publish
+    if: startsWith(github.ref, 'refs/tags/v')
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby 2.6
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: 2.6.x
+
+      - name: Publish to RubyGems
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push *.gem
+        env:
+          GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,10 @@
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased][unreleased]
+
+Initial release.
+
+[unreleased]: https://github.com/trycourier/courier-ruby-rails/compare/HEAD...HEAD

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at aydrian@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in courier_rails.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 0.80"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Aydrian Howard
+
+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,108 @@
+# Courier Rails
+
+This gem provides seamless integration of Courier with ActionMailer. It provides a `delivery_method` based upon the [Courier API](https://docs.courier.com/reference), and makes getting setup and sending notifications in a Rails app using Courier easier.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'courier_rails'
+```
+
+And then execute:
+
+    $ bundle install
+
+## Configuration
+
+Retrieve your [Courier Authentication Token](https://app.courier.com/settings/api-keys). By default, the gem will look for your token in your environment, with the key `COURIER_AUTH_TOKEN`. You can override this key by setting it manually in the file `config/initializers/courier_rails.rb`:
+
+```ruby
+CourierRails.configure do |c|
+  c.api_key = 'your-auth-token'
+end
+```
+
+Then, edit `config/application.rb` or `config/environments/$ENVIRONMENT.rb` and add/change the following to the ActionMailer configuration:
+
+```ruby
+config.action_mailer.delivery_method = :courier
+```
+
+## Usage
+
+Normal ActionMailer usage will now send notifications from the Courier template designer, using the Courier API:
+
+```ruby
+data = {
+    event: "EVENT_ID",
+    recipient: "RECIPIENT_ID",
+    data: {
+        hello: "Rails!"
+    }
+}
+
+mail(to: "jane@doe.com", body: "not used", courier_data: data)
+```
+
+The "body" parameter is required for ActionMailer, even though the email body is already described by the notification designer. You can also add `default body: not used` to the top of your mailer instead of this parameter.
+
+The elements of "courier_data" are described below:
+
+### event (required)
+
+The unique identification key of a notification template to be sent. If the notification is mapped to an event key, use the event key here instead.
+
+### recipient (optional)
+
+The unique identification key attached to a recipient and their profile. If empty, the code will auto-generate a unique key.
+
+### profile (optional)
+
+An object that includes the profile data attached to this message. For example,
+
+```ruby
+c_data={
+    event: "your.event.key"
+    profile:{
+        phone_number: "555-123-4567",
+        name: "Jane Doe"
+        email: "jane@doe.com"
+        ...
+    }
+}
+mail(body: "not used", courier_data: c_data)
+```
+
+As shown above, the recipient's email can be set inside of the profile instead of using the ActionMailer `to:"email"` parameter. When both are used, however, the "to" parameter overrides the profile email.
+
+### data (optional)
+
+An object that includes any data you want to pass to a Courier template. The data will populate the corresponding template variables.
+
+When calling the `deliver!` method on the mail object returned from your mailer. `CourierRails` provides the response data directly back from Courier in a `Courier::SendResponse` object.
+
+```ruby
+result = MyMailer.welcome_message(user).deliver!
+puts result.code // Status Code
+puts result.message_id // Message ID
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/trycourier/courier_rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/trycourier/courier_rails/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the CourierRails project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/trycourier/courier_rails/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "courier_rails"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/courier_rails.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "lib/courier_rails/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "courier_rails"
+  spec.version       = CourierRails::VERSION
+  spec.authors       = ["Aydrian Howard"]
+  spec.email         = ["aydrian@trycourier.com"]
+
+  spec.summary       = "Courier for Rails"
+  spec.description   = "Delivery Method for Rails ActionMailer to send notifications using the Courier API"
+  spec.homepage      = "https://github.com/trycourier/courier-ruby-rails"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/trycourier/courier-ruby-rails"
+  spec.metadata["changelog_uri"] = "https://github.com/trycourier/courier-ruby-rails/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+  # spec.add_dependency "rails", ">= 4.0", "< 6.1"
+  spec.add_dependency "rails", "~> 6.1.0"
+  spec.add_dependency "trycourier"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/courier_rails.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+require_relative "courier_rails/data_options"
+require_relative "courier_rails/delivery_method"
+require_relative "courier_rails/railtie"
+require_relative "courier_rails/version"
+
+module CourierRails
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :api_key
+
+    def initialize
+      set_defaults
+    end
+
+    def set_defaults
+      if ENV.has_key?("COURIER_AUTH_TOKEN")
+        @api_key = ENV["COURIER_AUTH_TOKEN"]
+      else
+        @api_key = ""
+      end
+    end
+  end
+end

data/lib/courier_rails/data_options.rb

@@ -0,0 +1,25 @@
+module CourierRails
+  module DataOptions
+
+    def self.included(base)
+      base.class_eval do
+        prepend InstanceMethods
+      end
+    end
+
+    module InstanceMethods
+
+      def mail(headers={}, &block)
+        headers = headers.clone
+        courier_data = headers.delete(:courier_data)
+        courier_data ||= {}
+        super(headers, &block).tap do |message|
+          message.singleton_class.class_eval { attr_accessor "courier_data" }
+          message.courier_data = courier_data
+        end
+      end
+      
+    end
+
+  end
+end

data/lib/courier_rails/delivery_method.rb

@@ -0,0 +1,89 @@
+module CourierRails
+  class DeliveryMethod
+    require "trycourier"
+    require "securerandom"
+
+    attr_accessor :settings, :payload, :response
+
+    def initialize(options = {})
+      @settings = options
+    end
+
+    def deliver!(mail)
+      @payload = {}
+
+      courier_data = find_courier_data_from mail
+
+      prepare_event_from courier_data
+      prepare_recipient_from mail, courier_data
+      prepare_profile_from mail, courier_data
+      prepare_data_from courier_data
+      prepare_brand_from courier_data
+
+      result = perfom_send_request
+
+      result
+    end
+
+    private
+
+    def client
+      ## TODO: Allow passed in Courier Data?
+      @client = Courier::Client.new CourierRails.configuration.api_key
+    end
+
+    def find_courier_data_from mail
+      mail.courier_data
+    end
+
+    def prepare_event_from courier_data
+      if courier_data.has_key?(:event)
+        @payload["event"] = courier_data[:event]
+      else
+        raise Exception.new "Must specify :event key in courier_data."
+      end
+    end
+
+    def prepare_recipient_from mail, courier_data
+      if courier_data.has_key?(:recipient)
+        @payload["recipient"] = courier_data[:recipient]
+      else
+        @payload["recipient"] = SecureRandom.uuid
+      end
+    end
+
+    def prepare_profile_from mail, courier_data
+      profile = {}
+      if courier_data.has_key?(:profile)
+        profile = courier_data[:profile]
+      end
+
+      if !mail.to.nil?
+        profile["email"] = mail.to.first
+      end
+
+      if !profile.empty?
+        @payload["profile"] = profile
+      end
+    end
+
+    def prepare_data_from courier_data
+      if courier_data.has_key?(:data)
+        @payload["data"] = courier_data[:data]
+      end
+    end
+
+    def prepare_brand_from courier_data
+      if courier_data.has_key?(:brand)
+        @payload["brand"] = courier_data[:brand]
+      end
+    end
+
+    def perfom_send_request
+      result = client.send(@payload)
+
+      result
+    end
+
+  end
+end

data/lib/courier_rails/exceptions.rb

@@ -0,0 +1,8 @@
+module CourierRails
+  class DeliveryException < StandardError
+
+    def initialize(response)
+      super(response)
+    end
+  end
+end

data/lib/courier_rails/railtie.rb

@@ -0,0 +1,15 @@
+module CourierRails
+  class Railtie < Rails::Railtie
+    initializer "courier_rails.add_delivery_method" do
+      ActiveSupport.on_load :action_mailer do
+        ActionMailer::Base.add_delivery_method :courier, CourierRails::DeliveryMethod, return_response: true
+      end
+    end
+
+    initializer "courier_rails.extend_with_data_options" do
+      ActiveSupport.on_load :action_mailer do
+        ActionMailer::Base.send :include, CourierRails::DataOptions
+      end
+    end
+  end
+end

data/lib/courier_rails/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CourierRails
+  VERSION = "0.1.3"
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: courier_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Aydrian Howard
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-12-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+- !ruby/object:Gem::Dependency
+  name: trycourier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Delivery Method for Rails ActionMailer to send notifications using the
+  Courier API
+email:
+- aydrian@trycourier.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/ISSUE_TEMPLATE.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
+- ".github/workflows/gem-push.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- courier_rails.gemspec
+- lib/courier_rails.rb
+- lib/courier_rails/data_options.rb
+- lib/courier_rails/delivery_method.rb
+- lib/courier_rails/exceptions.rb
+- lib/courier_rails/railtie.rb
+- lib/courier_rails/version.rb
+homepage: https://github.com/trycourier/courier-ruby-rails
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/trycourier/courier-ruby-rails
+  source_code_uri: https://github.com/trycourier/courier-ruby-rails
+  changelog_uri: https://github.com/trycourier/courier-ruby-rails/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Courier for Rails
+test_files: []