courier_rails 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad674601255f7e729de16b884fd64550516ff2930e9c8388345ede8500df9a2e
-  data.tar.gz: ab171f926c7467b79f9406e657986d26cc852346225a542b82e7b1d9c0a9663a
+  metadata.gz: 6d56a0b2f52123b72806477763af890b1976d06589baedf2b8851afe706fa05e
+  data.tar.gz: 280ca834964c5035f939b205c27b7e755a069ed57ee750fcec32de60134093b3
 SHA512:
-  metadata.gz: 0045eca096853ee403d58eaba3cef7e738a99cf0027b758af717bbbe25b81789d16d5286180a1ab049adfe762ecb643c27160f822cb9ad95ec00547c64a742c5
-  data.tar.gz: 3e81c4cc98fa208a4474780522d2454dc4dcf54624b3e8a284890c695b53e6892a036145cbeca3be94d055be9d8aa9431d2b38a33f8281f9ea22807b6eaebb43
+  metadata.gz: 5dece4418a09f9cda1e4f669721906d045f00fc8798970ce3ca73033a5d39c059930f4efb75cb7e8671046daaea0904b6d5e1245d9ab64bf392bf6cd358f7466
+  data.tar.gz: 5560debe54fd938b526170b557feca5bff602ab2c712d109840544374fd051a71d2c74f6a5616e7a370e7c8af68f2106acda8d930f03143da68bb27ddecb5c69

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

@@ -9,17 +9,33 @@ on:
     branches: [main]
 
 jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby 2.7
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: 2.7.x
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests
+        # Skipping rubocop for now
+        # run: bundle exec rake
+        run: bundle exec rspec spec
   build:
     name: Build + Publish
+    needs: test
     if: startsWith(github.ref, 'refs/tags/v')
     runs-on: ubuntu-latest
 
     steps:
       - uses: actions/checkout@v2
-      - name: Set up Ruby 2.6
+      - name: Set up Ruby 2.7
         uses: actions/setup-ruby@v1
         with:
-          ruby-version: 2.6.x
+          ruby-version: 2.7.x
 
       - name: Publish to RubyGems
         run: |

data/CHANGELOG.md

@@ -5,6 +5,8 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased][unreleased]
 
+## v0.1.3 - 2020-12-17
+
 Initial release.
 
-[unreleased]: https://github.com/trycourier/courier-ruby-rails/compare/HEAD...HEAD
+[unreleased]: https://github.com/trycourier/courier-ruby-rails/compare/v0.1.3...HEAD

data/CONTRIBUTING.md

@@ -0,0 +1,28 @@
+# Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/trycourier/courier-ruby-rails.
+
+## Local development
+
+- Fork this repository
+- Clone your fork
+- Run `bundle install`
+- Write code!
+- Test your code using `bundle exec rspec spec`
+
+## Releasing New Versions
+
+To publish Courier Rails to RUBYGEMS.ORG
+
+- Update the CHANGELOG.md
+- Bump the package version in `lib/courier_rails/version.rb`
+- Submit a PR to merge changes into main
+- Create and push a new version tag
+
+  ```bash
+  git tag -a v<VERSION> -m v<VERSION>
+  git push origin v<VERSION>
+  ```
+
+- Wait for GitHub Action to test and deploy
+- Confirm you are able to successfully install the new version by running `gem install courier_rails`

data/Gemfile

@@ -9,4 +9,4 @@ gem "rake", "~> 13.0"
 
 gem "rspec", "~> 3.0"
 
-gem "rubocop", "~> 0.80"
+gem "standard", group: [:development, :test]

data/Gemfile.lock

@@ -0,0 +1,197 @@
+PATH
+  remote: .
+  specs:
+    courier_rails (0.1.3)
+      rails (~> 6.0.0)
+      trycourier
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.0.3.4)
+      actionpack (= 6.0.3.4)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.0.3.4)
+      actionpack (= 6.0.3.4)
+      activejob (= 6.0.3.4)
+      activerecord (= 6.0.3.4)
+      activestorage (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
+      mail (>= 2.7.1)
+    actionmailer (6.0.3.4)
+      actionpack (= 6.0.3.4)
+      actionview (= 6.0.3.4)
+      activejob (= 6.0.3.4)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.0.3.4)
+      actionview (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.0.3.4)
+      actionpack (= 6.0.3.4)
+      activerecord (= 6.0.3.4)
+      activestorage (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
+      nokogiri (>= 1.8.5)
+    actionview (6.0.3.4)
+      activesupport (= 6.0.3.4)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.0.3.4)
+      activesupport (= 6.0.3.4)
+      globalid (>= 0.3.6)
+    activemodel (6.0.3.4)
+      activesupport (= 6.0.3.4)
+    activerecord (6.0.3.4)
+      activemodel (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
+    activestorage (6.0.3.4)
+      actionpack (= 6.0.3.4)
+      activejob (= 6.0.3.4)
+      activerecord (= 6.0.3.4)
+      marcel (~> 0.3.1)
+    activesupport (6.0.3.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.1)
+    builder (3.2.4)
+    concurrent-ruby (1.1.8)
+    crack (0.4.4)
+    crass (1.0.6)
+    diff-lcs (1.4.4)
+    erubi (1.10.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    hashdiff (1.0.1)
+    i18n (1.8.7)
+      concurrent-ruby (~> 1.0)
+    loofah (2.9.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (1.0.0)
+    mimemagic (0.3.5)
+    mini_mime (1.0.2)
+    minitest (5.14.3)
+    nio4r (2.5.4)
+    nokogiri (1.11.1-x86_64-darwin)
+      racc (~> 1.4)
+    parallel (1.20.1)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
+    public_suffix (4.0.6)
+    racc (1.5.2)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.0.3.4)
+      actioncable (= 6.0.3.4)
+      actionmailbox (= 6.0.3.4)
+      actionmailer (= 6.0.3.4)
+      actionpack (= 6.0.3.4)
+      actiontext (= 6.0.3.4)
+      actionview (= 6.0.3.4)
+      activejob (= 6.0.3.4)
+      activemodel (= 6.0.3.4)
+      activerecord (= 6.0.3.4)
+      activestorage (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
+      bundler (>= 1.3.0)
+      railties (= 6.0.3.4)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.0.3.4)
+      actionpack (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.20.3, < 2.0)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    regexp_parser (2.0.0)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    rubocop (1.4.2)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 1.1.1)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.3.0)
+      parser (>= 2.7.1.5)
+    rubocop-performance (1.9.1)
+      rubocop (>= 0.90.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.10.1)
+    sprockets (4.0.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.2)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    standard (0.10.2)
+      rubocop (= 1.4.2)
+      rubocop-performance (= 1.9.1)
+    thor (1.1.0)
+    thread_safe (0.3.6)
+    trycourier (1.1.0)
+    tzinfo (1.2.9)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
+    webmock (3.11.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    websocket-driver (0.7.3)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  ruby
+  x86_64-darwin-19
+
+DEPENDENCIES
+  courier_rails!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  standard
+  webmock (>= 1.24.2)
+
+BUNDLED WITH
+   2.2.1

data/README.md

@@ -56,7 +56,7 @@ The unique identification key of a notification template to be sent. If the noti
 
 ### recipient (optional)
 
-The unique identification key attached to a recipient and their profile. If empty, the code will auto-generate a unique key.
+The unique identification key attached to a recipient and their profile. The value should be a string, all other values will be converted to a string. If empty, the code will either use the email provided in the to or auto-generate a unique key.
 
 ### profile (optional)
 
@@ -85,8 +85,8 @@ When calling the `deliver!` method on the mail object returned from your mailer.
 
 ```ruby
 result = MyMailer.welcome_message(user).deliver!
-puts result.code // Status Code
-puts result.message_id // Message ID
+puts result.code # Status Code
+puts result.message_id # Message ID
 ```
 
 ## Development
@@ -97,7 +97,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## 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).
+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). See [CONTRIBUTING.md](CONTRIBUTING.md) for more info.
 
 ## License
 

data/Rakefile

@@ -5,8 +5,6 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-require "rubocop/rake_task"
+require "standard/rake"
 
-RuboCop::RakeTask.new
-
-task default: %i[spec rubocop]
+task default: %i[spec standard]

data/courier_rails.gemspec

@@ -3,15 +3,15 @@
 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.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'"
@@ -25,16 +25,19 @@ Gem::Specification.new do |spec|
   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.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 "rails", "~> 6.0.0"
   spec.add_dependency "trycourier"
 
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "webmock", ">=1.24.2"
+
   # 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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative "courier_rails/data_options"
 require_relative "courier_rails/delivery_method"
 require_relative "courier_rails/railtie"
@@ -6,7 +7,7 @@ require_relative "courier_rails/version"
 
 module CourierRails
   class << self
-    attr_accessor :configuration
+    attr_writer :configuration
   end
 
   def self.configuration
@@ -26,10 +27,10 @@ module CourierRails
     end
 
     def set_defaults
-      if ENV.has_key?("COURIER_AUTH_TOKEN")
-        @api_key = ENV["COURIER_AUTH_TOKEN"]
+      @api_key = if ENV.has_key?("COURIER_AUTH_TOKEN")
+        ENV["COURIER_AUTH_TOKEN"]
       else
-        @api_key = ""
+        ""
       end
     end
   end

data/lib/courier_rails/data_options.rb

@@ -1,6 +1,5 @@
 module CourierRails
   module DataOptions
-
     def self.included(base)
       base.class_eval do
         prepend InstanceMethods
@@ -8,8 +7,7 @@ module CourierRails
     end
 
     module InstanceMethods
-
-      def mail(headers={}, &block)
+      def mail(headers = {}, &block)
         headers = headers.clone
         courier_data = headers.delete(:courier_data)
         courier_data ||= {}
@@ -18,8 +16,6 @@ module CourierRails
           message.courier_data = courier_data
         end
       end
-      
     end
-
   end
-end
+end

data/lib/courier_rails/delivery_method.rb

@@ -20,9 +20,7 @@ module CourierRails
       prepare_data_from courier_data
       prepare_brand_from courier_data
 
-      result = perfom_send_request
-
-      result
+      perfom_send_request
     end
 
     private
@@ -32,58 +30,47 @@ module CourierRails
       @client = Courier::Client.new CourierRails.configuration.api_key
     end
 
-    def find_courier_data_from mail
+    def find_courier_data_from(mail)
       mail.courier_data
     end
 
-    def prepare_event_from courier_data
+    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."
+        raise StandardError, "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]
+    def prepare_recipient_from(mail, courier_data)
+      @payload["recipient"] = if courier_data.has_key?(:recipient)
+        courier_data[:recipient].to_s
+      elsif !mail.to.nil?
+        mail.to.first
       else
-        @payload["recipient"] = SecureRandom.uuid
+        SecureRandom.uuid
       end
     end
 
-    def prepare_profile_from mail, courier_data
+    def prepare_profile_from(mail, courier_data)
       profile = {}
-      if courier_data.has_key?(:profile)
-        profile = courier_data[:profile]
-      end
+      profile = courier_data[:profile] if courier_data.has_key?(:profile)
 
-      if !mail.to.nil?
-        profile["email"] = mail.to.first
-      end
+      profile[:email] = mail.to.first unless mail.to.nil?
 
-      if !profile.empty?
-        @payload["profile"] = profile
-      end
+      @payload["profile"] = profile unless profile.empty?
     end
 
-    def prepare_data_from courier_data
-      if courier_data.has_key?(:data)
-        @payload["data"] = courier_data[:data]
-      end
+    def prepare_data_from(courier_data)
+      @payload["data"] = courier_data[:data] if courier_data.has_key?(:data)
     end
 
-    def prepare_brand_from courier_data
-      if courier_data.has_key?(:brand)
-        @payload["brand"] = courier_data[:brand]
-      end
+    def prepare_brand_from(courier_data)
+      @payload["brand"] = courier_data[:brand] if courier_data.has_key?(:brand)
     end
 
     def perfom_send_request
-      result = client.send(@payload)
-
-      result
+      client.send(@payload)
     end
-
   end
-end
+end

data/lib/courier_rails/exceptions.rb

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

data/lib/courier_rails/railtie.rb

@@ -12,4 +12,4 @@ module CourierRails
       end
     end
   end
-end
+end

data/lib/courier_rails/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: courier_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - Aydrian Howard
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-12-18 00:00:00.000000000 Z
+date: 2021-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.1.0
+        version: 6.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.1.0
+        version: 6.0.0
 - !ruby/object:Gem::Dependency
   name: trycourier
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +38,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.24.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.24.2
 description: Delivery Method for Rails ActionMailer to send notifications using the
   Courier API
 email:
@@ -51,10 +79,11 @@ files:
 - ".github/workflows/gem-push.yml"
 - ".gitignore"
 - ".rspec"
-- ".rubocop.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -89,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Courier for Rails

data/.rubocop.yml

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