cnfs-comm 0.0.1.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e83faabad39fa0034ef10af4b89f3f19d9070da73bd319edbcdd08763f516756
+  data.tar.gz: 2975ef6f8729dee40fab0a4524ba2fb30d91e31ecc10dd7c571177e6b3983e7c
+SHA512:
+  metadata.gz: 233b5c4d2200924ec43fb1f678ba93114a77573e1bb88d698a31f40cd3aa0c1fe15cd053878a993196e457abee47bae711ff3dc6ecbb962fa67b06f87ed98b57
+  data.tar.gz: 21a3f71ee15d2fcd1c1ebbcb1706e9fa9173bf202f7e934f43c5a67cb2d7910dc88513f756475125d24344a572be9b82e5da408549ce9653593518c32189e580

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Robert Roach
+
+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,17 @@
+## Summary
+
+Created by rails-templates
+
+
+def tcall(from: '+12565308753', to: '+6581132988')
+  @twilio_client.calls.create(to: to, from: from, url: 'http://demo.twilio.com/docs/voice.xml')
+end
+
+def tsms(from: '+12565308753', to: '+6581132988', body: 'Hey friend!')
+  @twilio_client.messages.create(
+    from: from,
+    to: to,
+    body: body
+  )
+end
+

data/Rakefile

@@ -0,0 +1,22 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Ros::Comm'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'

data/app/controllers/campaigns_controller.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class CampaignsController < Comm::ApplicationController
+end

data/app/controllers/comm/application_controller.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Comm
+  class ApplicationController < ::ApplicationController
+  end
+end

data/app/controllers/events_controller.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class EventsController < Comm::ApplicationController
+end

data/app/controllers/messages_controller.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+class MessagesController < Comm::ApplicationController
+  def create
+    res = MessageCreate.call(params: assign_params, user: context[:user])
+    if res.success?
+      render json: json_resource(resource_class: MessageResource, record: res.model), status: :created
+    else
+      resource = ApplicationResource.new(res, nil)
+      handle_exceptions JSONAPI::Exceptions::ValidationErrors.new(resource)
+    end
+  end
+
+  private
+
+  def assign_params
+    jsonapi_params.permit(MessageResource.creatable_fields(context))
+  end
+end

data/app/controllers/providers_controller.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class ProvidersController < Comm::ApplicationController
+end

data/app/controllers/templates_controller.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class TemplatesController < Comm::ApplicationController
+end

data/app/controllers/whatsapps_controller.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+# module ServiceTwilio
+class WhatsappsController < Comm::ApplicationController
+  # skip_before_action :authenticate_user!
+  # before_action :set_whatsapp, only: [:show, :update, :destroy]
+
+  # GET /whatsapps
+  def index
+    @whatsapps = Whatsapp.all
+
+    render json: @whatsapps
+  end
+
+  # GET /whatsapps/1
+  def show
+    render json: @whatsapp
+  end
+
+  # POST /whatsapps
+  # NOTE: This is an endpoint that response to a Twilio notification
+  # when a whatsapp message is sent to a registered number
+  def create
+    @whatsapp = Whatsapp.new(whatsapp_params)
+
+    who = 'Blob'
+    who = 'Narayani' if @whatsapp.from.ends_with? '26'
+
+    if @whatsapp.save
+      # Put a message on a bus (rabbitMQ)
+      # Channels are named in a standardized way including service and tenant
+      # TODO:
+      # UserSpace, e.g. perx, truewards, LoyatlyCampaign listens on bus and sends message back
+      # Twilio service listens on bus and sends message
+      # Something like this
+      twiml = Twilio::TwiML::MessagingResponse.new do |r|
+        r.message(body: "Ahoy #{who}! Thanks so much for your message that said: '#{@whatsapp.Body}'")
+      end
+      render xml: twiml
+    else
+      # render json: @whatsapp, status: :created, location: @whatsapp
+      render json: @whatsapp.errors, status: :unprocessable_entity
+    end
+  end
+
+  # PATCH/PUT /whatsapps/1
+  def update
+    if @whatsapp.update(whatsapp_params)
+      render json: @whatsapp
+    else
+      render json: @whatsapp.errors, status: :unprocessable_entity
+    end
+  end
+
+  # DELETE /whatsapps/1
+  def destroy
+    @whatsapp.destroy
+  end
+
+  private
+
+  # Use callbacks to share common setup or constraints between actions.
+  def set_whatsapp
+    @whatsapp = Whatsapp.find(params[:id])
+  end
+
+  # Only allow a trusted parameter "white list" through.
+  # NOTE: Twilio sends params as SmsStatus
+  def whatsapp_params
+    request.request_parameters.deep_transform_keys!(&:underscore).except(:controller, :action)
+  end
+end
+# end

data/app/jobs/call_job.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class CallJob < Comm::ApplicationJob
+  def perform(call:)
+    # 'http://demo.twilio.com/docs/voice.xml')
+    @tenant.twilio_client.calls.create(from: call.from, to: call.to, url: call.url)
+  end
+end

data/app/jobs/comm/application_job.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Comm
+  class ApplicationJob < Ros::ApplicationJob
+  end
+end

data/app/jobs/event_process_job.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class EventProcessJob < Comm::ApplicationJob
+end

data/app/jobs/message_process_job.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class MessageProcessJob < Comm::ApplicationJob
+end

data/app/jobs/message_send_job.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class MessageSendJob < Comm::ApplicationJob
+end

data/app/mailers/application_mailer.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/app/models/campaign.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class Campaign < Comm::ApplicationRecord
+  has_many :events
+  has_many :templates
+
+  before_save :set_base_url
+
+  def set_base_url
+    # https://{{tenant}}-blackcomb-sales.uat.whistler.perxtech.io/
+    self.base_url ||= current_tenant.properties.fetch(:campaign_base_url, '')
+  end
+
+  def final_url
+    "#{base_url}loading/"
+  end
+end

data/app/models/comm/application_record.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Comm
+  class ApplicationRecord < ::ApplicationRecord
+    self.abstract_class = true
+  end
+end

data/app/models/event.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+class Event < Comm::ApplicationRecord
+  # - includes/extends
+  include AASM
+
+  # - constants
+
+  # - gems and related
+  # TODO: we should have an extra status that informs us that all the messages
+  # for this event have been scheduled
+  aasm whiny_transitions: true, column: :status do
+    state :pending, initial: true
+    state :processing, :published
+
+    after_all_transitions :log_status_change
+
+    event :process do
+      transitions from: :pending, to: :processing
+    end
+
+    event :publish do
+      transitions from: :processing, to: :published
+    end
+  end
+
+  # - serialized attributes
+
+  # - associations
+  belongs_to :template, optional: true
+  belongs_to :provider
+  belongs_to :campaign, optional: true
+  # maybe target should be cognito_pool_id
+  belongs_to_resource :target, polymorphic: true
+  belongs_to_resource :owner, polymorphic: true
+
+  has_many :messages, as: :owner
+  # api_has_many :users, through: :target
+
+  # - attr_accessible
+
+  # - scopes
+
+  # - class methods
+
+  # - validations
+  validate :provider_channel
+  # NOTE: if there channel is not weblink, then target is mandatory
+  validates :target, presence: true, if: -> { channel != 'weblink' }
+
+  # - callbacks
+  after_commit :queue_job, on: :create
+
+  # - other methods
+
+  # TODO: Decide if the target is always a Pool or not
+  # TODO: Implement as api_has_many :users, through: :target
+  def users
+    query_resource(:target) { |query| query.includes(:users) }.users
+  end
+
+  def log_status_change
+    Rails.logger.info("changing from #{aasm.from_state} to #{aasm.to_state} (event: #{aasm.current_event})")
+  end
+
+  # - private
+  private
+
+  def provider_channel
+    return unless provider
+
+    channels = provider.class.services + ['weblink']
+    return if channel.in? channels
+
+    errors.add(:channel, "must be one of: #{channels.join(' ')}")
+  end
+
+  def queue_job
+    EventProcessJob.set(wait_until: send_at).perform_later(id: id)
+  end
+end

data/app/models/message.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+class Message < Comm::ApplicationRecord
+  belongs_to :provider
+  belongs_to :owner, polymorphic: true, optional: true
+
+  attr_accessor :recipient_id
+
+  def self.sent_to(phone_number)
+    search_number = phone_number.tr('^0-9', '%')
+    where('messages.to LIKE ?', search_number)
+  end
+
+  validate :provider_channel, if: :provider
+
+  def provider_channel
+    return if channel.in? provider.class.services
+
+    errors.add(:channel, "must be one of: #{provider.class.services.join(' ')}")
+  end
+end

data/app/models/provider.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+class Provider < Comm::ApplicationRecord
+  attr_reader :client
+
+  attr_encrypted_options.merge!(key: Settings.encryption_key, encode: true, encode_iv: true)
+  attr_encrypted :credential_1
+  attr_encrypted :credential_2
+  attr_encrypted :credential_3
+
+  validates :type, presence: true
+
+  def self.services
+    []
+  end
+
+  def provider_from
+    current_tenant.properties.dig(:from) || 'Perx'
+  end
+
+  def sms
+    raise NotImplementedError
+  end
+end

data/app/models/providers/aws.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Providers
+  class Aws < Provider
+    alias_attribute :access_key_id, :credential_1
+    alias_attribute :secret_access_key, :credential_2
+
+    def self.services
+      %w[sms]
+    end
+
+    def client
+      return unless x_access_key_id && x_secret_access_key
+
+      @client ||= ::Aws::SNS::Client.new(client_params)
+    end
+
+    def x_access_key_id
+      access_key_id || (current_tenant.platform_aws_enabled ? ENV['AWS_ACCESS_KEY_ID'] : nil)
+    end
+
+    def x_secret_access_key
+      secret_access_key || (current_tenant.platform_aws_enabled ? ENV['AWS_SECRET_ACCESS_KEY'] : nil)
+    end
+
+    def provider_from
+      current_tenant.properties.dig(:from) || 'Perx'
+    end
+
+    def sms(from, to, body)
+      sender = from || provider_from
+      client.set_sms_attributes(attributes: { 'DefaultSenderID' => sender })
+      client.publish(phone_number: to, message: body)
+    rescue ::Aws::SNS::Errors::ServiceError => e
+      Rails.logger.warn("No AWS client configured for tenant.account_id. #{e.inspect}")
+    end
+
+    private
+
+    # TODO: Cleanup this logic. This should probably live in an initializer.
+    # The problem might be that a tenant uses Perx SNS credentials for sending
+    # the sms but then wants to use his own credentials for storing the assets
+    # in the S3. We should have the configuration being picked up from
+    # 1. settings, env variables, our defaults
+    def client_params
+      params = { region: 'ap-southeast-1',
+                 access_key_id: x_access_key_id,
+                 secret_access_key: x_secret_access_key }
+
+      params[:endpoint] = ENV['AWS_ENDPOINT'] unless ENV['AWS_ENDPOINT'].nil?
+      params
+    end
+  end
+end