sm_sms_campaign_webhook 0.1.1 → 1.0.0

data/lib/generators/sm_sms_campaign_webhook/install/templates/README

@@ -0,0 +1,25 @@
+================================================================================
+
+Some setup you must do manually if you haven't yet:
+
+  1. Set the ENV value SM_SMS_CAMPAIGN_WEBHOOK_AUTH_TOKEN with a Rails secret:
+
+       $ bundle exec rails secret
+
+  2. Prep the app for ActiveJob using Sidekiq. In config/application.rb:
+
+       config.active_job.queue_adapter = :sidekiq
+
+     In Procfile or appropriate app launch config:
+
+       worker: bundle exec sidekiq --config config/sidekiq.yml
+
+  3. Implement SmsPayloadProcessor behavior. Remember, the generated processor
+     provides the skeleton but will raise errors out of the box. Data handling
+     is app specific!
+
+This will configure the app to be ready to accept SMS campaign service payloads.
+
+Happy hacking!
+
+================================================================================

data/lib/generators/sm_sms_campaign_webhook/install/templates/sm_sms_campaign_webhook.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "sm_sms_campaign_webhook"
+
+SmSmsCampaignWebhook.config do |config|
+  # SMS campaign payload processor implementing SmSmsCampaignWebhook::Processable behavior.
+  # default: SmSmsCampaignWebhook::DefaultProcessor (raises errors for processing)
+  config.processor = SmsPayloadProcessor
+end

data/lib/generators/sm_sms_campaign_webhook/install/templates/sms_payload_processor.rb.erb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# Processes SMS campaign service payloads.
+# @see https://github.com/SouthernMade/sm_sms_campaign_webhook/blob/v<%= SmSmsCampaignWebhook::VERSION %>/app/processors/sm_sms_campaign_webhook/processable.rb SmSmsCampaignWebhook::Processable
+class SmsPayloadProcessor
+  include SmSmsCampaignWebhook::Processable
+
+  # @param campaign_enagement [SmSmsCampaignWebhook::CampaignEngagement]
+  # @see https://github.com/SouthernMade/sm_sms_campaign_webhook/blob/v<%= SmSmsCampaignWebhook::VERSION %>/app/models/sm_sms_campaign_webhook/campaign_engagement.rb SmSmsCampaignWebhook::CampaignEngagement
+  # @todo Implement business logic to process campaign engagement.
+  # def self.process_campaign_engagement(campaign_engagement)
+  # end
+end

data/lib/sm_sms_campaign_webhook.rb

@@ -1,9 +1,32 @@
 # frozen_string_literal: true
 
+require "sm_sms_campaign_webhook/engine"
 require "sm_sms_campaign_webhook/version"
 
 # Namespace for SMS campaign webhook.
 module SmSmsCampaignWebhook
-  # General base error type for custom errors.
-  class Error < StandardError; end
+  # @return [SmSmsCampaignWebhook] self for configuration purposes
+  def self.config(&block)
+    yield self if block
+  end
+
+  # @return [String] SMS campaign webhook auth token
+  # @raise [MissingConfigError] when ENV does not contain SM_SMS_CAMPAIGN_WEBHOOK_AUTH_TOKEN value
+  def self.auth_token
+    @auth_token ||= ENV.fetch("SM_SMS_CAMPAIGN_WEBHOOK_AUTH_TOKEN") do
+      raise MissingConfigError,
+            "ENV does not contain SM_SMS_CAMPAIGN_WEBHOOK_AUTH_TOKEN value"
+    end
+  end
+
+  # @return [Processable] SMS campaign payload processor used by operations
+  def self.processor
+    @processor ||= DefaultProcessor
+  end
+
+  # @param processor [Processable] Custom SMS campaign payload processor
+  # @see Processable
+  def self.processor=(processor)
+    @processor = processor
+  end
 end

data/lib/sm_sms_campaign_webhook/engine.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "rails"
+
+module SmSmsCampaignWebhook
+  # General Rails engine configuration.
+  class Engine < ::Rails::Engine
+    isolate_namespace SmSmsCampaignWebhook
+    config.generators.api_only = true
+  end
+end

data/lib/sm_sms_campaign_webhook/version.rb

@@ -2,5 +2,5 @@
 
 module SmSmsCampaignWebhook
   # @return [String] gem version
-  VERSION = "0.1.1"
+  VERSION = "1.0.0"
 end

data/sm_sms_campaign_webhook.gemspec

@@ -3,32 +3,40 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "sm_sms_campaign_webhook/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "sm_sms_campaign_webhook"
-  spec.version       = SmSmsCampaignWebhook::VERSION
-  spec.authors       = ["Cameron Dykes", "Matt Mueller"]
-  spec.email         = ["cameron@southernmade.com", "matt@southernmade.com"]
-
-  spec.summary       = %q{Middleware providing webhook for Southern Made SMS Campaign Engagement.}
-  spec.homepage      = "https://github.com/SouthernMade/sm_sms_campaign_webhook"
-  spec.license       = "MIT"
+  spec.name        = "sm_sms_campaign_webhook"
+  spec.version     = SmSmsCampaignWebhook::VERSION
+  spec.license     = "MIT"
+  spec.summary     = %q{Middleware providing webhook for Southern Made SMS Campaign Engagement.}
+  spec.description = %q{Middleware providing webhook for Southern Made SMS Campaign Engagement.}
+  spec.homepage    = "https://github.com/SouthernMade/sm_sms_campaign_webhook"
+  spec.authors     = ["Cameron Dykes", "Matt Mueller"]
+  spec.email       = ["cameron@southernmade.com", "matt@southernmade.com"]
 
   spec.metadata["allowed_push_host"] = "https://rubygems.org"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/SouthernMade/sm_sms_campaign_webhook"
-  spec.metadata["changelog_uri"] = "https://github.com/SouthernMade/sm_sms_campaign_webhook/blob/develop/CHANGELOG.md"
+  spec.metadata["homepage_uri"]      = spec.homepage
+  spec.metadata["source_code_uri"]   = spec.homepage
+  spec.metadata["changelog_uri"]     = "#{spec.homepage}/blob/develop/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('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.files = Dir[
+    "{app,config,lib}/**/*",
+    "CHANGELOG.md",
+    "LICENSE.txt",
+    "README.md",
+    "sm_sms_campaign_webhook.gemspec"
+  ]
   spec.require_paths = ["lib"]
 
+  # Required version of Ruby guided by Rails.
+  spec.required_ruby_version = "~> 2.5"
+
+  # Runtime dependencies.
+  spec.add_dependency "rails", [">= 5.2.3", "< 6.1"]
+
+  # Development + test dependencies.
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 12.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-rails", "~> 3.8"
+  spec.add_development_dependency "simplecov", "~> 0.17"
   spec.add_development_dependency "yard", "~> 0.9"
 end

metadata

@@ -1,16 +1,36 @@
 --- !ruby/object:Gem::Specification
 name: sm_sms_campaign_webhook
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Cameron Dykes
 - Matt Mueller
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2019-07-16 00:00:00.000000000 Z
+date: 2019-07-26 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -40,19 +60,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '12.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -67,7 +101,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-description: 
+description: Middleware providing webhook for Southern Made SMS Campaign Engagement.
 email:
 - cameron@southernmade.com
 - matt@southernmade.com
@@ -75,17 +109,33 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
+- app/controllers/sm_sms_campaign_webhook/application_controller.rb
+- app/controllers/sm_sms_campaign_webhook/webhook_controller.rb
+- app/exceptions/sm_sms_campaign_webhook/error.rb
+- app/exceptions/sm_sms_campaign_webhook/invalid_payload.rb
+- app/exceptions/sm_sms_campaign_webhook/invalid_payload_value.rb
+- app/exceptions/sm_sms_campaign_webhook/missing_config_error.rb
+- app/exceptions/sm_sms_campaign_webhook/payload_dispatch_error.rb
+- app/jobs/sm_sms_campaign_webhook/application_job.rb
+- app/jobs/sm_sms_campaign_webhook/dispatch_payload_job.rb
+- app/jobs/sm_sms_campaign_webhook/process_campaign_engagement_job.rb
+- app/models/sm_sms_campaign_webhook/campaign_engagement.rb
+- app/models/sm_sms_campaign_webhook/campaign_engagement/answer.rb
+- app/operations/sm_sms_campaign_webhook/campaign_engagement_operation.rb
+- app/operations/sm_sms_campaign_webhook/payload_operation.rb
+- app/processors/sm_sms_campaign_webhook/default_processor.rb
+- app/processors/sm_sms_campaign_webhook/processable.rb
+- config/routes.rb
+- lib/generators/sm_sms_campaign_webhook/install/USAGE
+- lib/generators/sm_sms_campaign_webhook/install/install_generator.rb
+- lib/generators/sm_sms_campaign_webhook/install/templates/README
+- lib/generators/sm_sms_campaign_webhook/install/templates/sm_sms_campaign_webhook.rb
+- lib/generators/sm_sms_campaign_webhook/install/templates/sms_payload_processor.rb.erb
 - lib/sm_sms_campaign_webhook.rb
+- lib/sm_sms_campaign_webhook/engine.rb
 - lib/sm_sms_campaign_webhook/version.rb
 - sm_sms_campaign_webhook.gemspec
 homepage: https://github.com/SouthernMade/sm_sms_campaign_webhook
@@ -102,9 +152,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/.gitignore

@@ -1,16 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status
-
-# local dev
-*.swp
-.tool-versions
-Gemfile.lock

data/.rspec

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

data/.travis.yml

@@ -1,18 +0,0 @@
----
-env:
-  global:
-    - CC_TEST_REPORTER_ID=10742624af48a8870427ef318104de2f29460d1ae694df9aa3d422b77c8a470d
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.6.3
-before_install: gem install bundler -v 2.0.2
-before_script:
-  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-  - chmod +x ./cc-test-reporter
-  - ./cc-test-reporter before-build
-script:
-  - bundle exec rspec
-after_script:
-  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/Gemfile

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

data/Rakefile

@@ -1,6 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "sm_sms_campaign_webhook"
-
-# 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

@@ -1,8 +0,0 @@
-#!/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