actionmessage 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1e8dd0c9af288515843fff286e349e99643de21b
+  data.tar.gz: 7d20e3d3d5bd082368b09ea9444e4cf368b9b6c1
+SHA512:
+  metadata.gz: 54b804f67897116c2348740c98590b45fe94978f88fa5cb89570a7ff5dbf7399d530444a2dd489aeb4d08db95834b3b3f97e54ab80d3ec3d493f2464531a6f8f
+  data.tar.gz: 571c203e8f113b75b7cd8bc9949d4935695aefaa4fc37c833f38ff4ea6953a958e7795c07e087b1c0d20c190a762236240011275dcc6a154bcea8a7946e8389c

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Diego Ballona
+
+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,59 @@
+# ActionMessage
+
+This is a pet project – an ActionMailer heavily-inspired gem for working with SMS/Text messages.
+Pull requests are more than welcome!
+
+## Usage
+
+Install it using bundler
+
+```sh
+# Gemfile
+gem 'actionmessage'
+```
+
+or just require it:
+```sh
+gem install actionmessage
+require 'action_message'
+```
+
+If you're using Rails, place this on your environment file or application.rb
+```ruby
+ActionMessage::Base.default_options = {
+	from: "number to send from in international format, e.g.: +11231231234", 
+	adapter: { 
+		name: :twilio,
+		credentials: {
+			account_sid: 'MY TWILIO ACCOUNT SID'.freeze,
+			auth_token: 'MY AUTH TOKEN'.freeze
+		}
+	}
+}
+```
+
+Put this for example, under app/messages/merchant_message.rb
+```ruby
+class MerchantMessage < ActionMessage::Base
+	def send_welcome_sms(name)
+		@name = name
+		sms(to: "+5531982726767")
+	end
+end
+```
+
+Define your views under app/views/merchant_message/send_welcome_sms.text.erb
+```html
+Welcome, <%= @name %>!!!
+```
+
+TODO:
+
+- Add tests to what we've got already;
+- Add background processing (deliver_later);
+- Log instrumentation with ActiveSupport;
+- Add generators;
+- Add a Railtie;
+- Add delivery methods;
+- Add test helpers; 
+- Add more adapters;

data/Rakefile

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

data/actionmessage.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'action_message/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "actionmessage"
+  spec.version       = ActionMessage::VERSION
+  spec.authors       = ["Diego Ballona"]
+  spec.email         = ["root@dballona.com"]
+
+  spec.summary       = "ActionMailer heavily-inspired gem to handle SMS/Text Messages"
+  spec.description   = "ActionMailer heavily-inspired gem to handle SMS/Text Messages"
+  spec.homepage      = "http://github.com/dballona/actionmessage"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'actionpack', '>= 4.0.0'
+  spec.add_dependency 'actionview', '>= 4.0.0'
+  spec.add_dependency 'twilio-ruby', '>= 4.11.1'
+  
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/app/messages/merchant_message.rb

@@ -0,0 +1,8 @@
+require 'action_message'
+
+class MerchantMessage < ActionMessage::Base
+  def send_welcome_sms(name)
+    @name = name
+    sms(to: "+5531982726767")
+  end
+end

data/app/views/merchant_message/send_welcome_sms.text.erb

@@ -0,0 +1 @@
+Yeah <%= @name %>!!!

data/bin/console

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

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/lib/action_message.rb

@@ -0,0 +1,18 @@
+require 'abstract_controller'
+
+require 'action_message/adapters'
+require 'action_message/base'
+require 'action_message/message'
+require 'action_message/message_delivery'
+require 'action_message/version'
+
+require 'active_support/rails'
+
+module ActionMessage; end
+
+autoload :Mime, 'action_dispatch/http/mime_type'
+
+ActiveSupport.on_load(:action_view) do
+  ActionView::Base.default_formats ||= Mime::SET.symbols
+  ActionView::Template::Types.delegate_to Mime
+end

data/lib/action_message/adapters.rb

@@ -0,0 +1,14 @@
+require 'action_message/adapters/base'
+require 'action_message/adapters/test'
+require 'action_message/adapters/twilio'
+
+module ActionMessage
+	module Adapters
+		class << self
+			def adapter
+				adapter_params = ActionMessage::Base.default_params[:adapter]
+				const_get(adapter_params[:name].to_s.capitalize).new(adapter_params[:credentials])
+			end
+		end
+	end
+end

data/lib/action_message/adapters/base.rb

@@ -0,0 +1,23 @@
+module ActionMessage
+  module Adapters
+    class Base
+      def initialize(params={})
+        @params = params
+      end
+
+      def send_message(body, params={})
+        raise ArgumentError, 'You should provide at least one phone for sending messages' if !senders.present?
+        @from = pick_sender
+      end
+
+      def senders
+        @senders ||= @params[:from].present? ? @params[:from] : ActionMessage::Base.default_params[:from]
+      end
+
+      private
+        def pick_sender
+          senders.is_a?(String) ? senders : senders.shuffle.sample
+        end
+    end
+  end
+end

data/lib/action_message/adapters/test.rb

@@ -0,0 +1,20 @@
+module ActionMessage
+  module Adapters
+    class Test < Base
+      def initialize(params={})
+        super(params)
+      end
+
+      def client
+        @client ||= OpenStruct.new
+      end
+
+      def send_message(body, params={})
+        raise ArgumentError, 'you should include a receipient for sending messages' unless params[:to].present?
+
+        @to = params[:to]
+        puts "Sending message to #{@to}"
+      end
+    end
+  end
+end

data/lib/action_message/adapters/twilio.rb

@@ -0,0 +1,36 @@
+require 'twilio-ruby'
+
+module ActionMessage
+  module Adapters
+    class Twilio < Base
+      def initialize(params={})
+        raise ArgumentError, 'account_sid is a mandatory setting for sending messages through Twilio' unless params[:account_sid].present?
+        raise ArgumentError, 'auth_token is a mandatory setting for sending messages through Twilio' unless params[:auth_token].present?
+
+        @account_sid = params[:account_sid]
+        @auth_token = params[:auth_token]
+
+        super(params)
+      end
+
+      def client
+        @client ||= ::Twilio::REST::Client.new(@account_sid, @auth_token)
+      end
+
+      def send_message(body, params={})
+        raise ArgumentError, 'you should include a receipient for sending messages' unless params[:to].present?
+        super(body, params)
+
+        sms = {
+          to: params[:to],
+          from: @from,
+          body: body
+        }
+        
+        sms.merge!(media_url: params[:media_url]) if params[:media_url].present?
+
+        client.account.messages.create(sms)
+      end
+    end
+  end
+end

data/lib/action_message/base.rb

@@ -0,0 +1,92 @@
+require 'active_support/core_ext/string/inflections'
+require 'active_support/core_ext/module/anonymous'
+
+module ActionMessage
+  class Base < AbstractController::Base
+
+    abstract!
+
+    include AbstractController::Rendering
+    include AbstractController::Logger
+    include AbstractController::Callbacks
+
+    include ActionView::Layouts
+
+    class << self
+
+      class_attribute :default_params
+      self.default_params = {
+        adapter: {
+          name: :test,
+          credentials: {}
+        },
+        mime_version: "1.0",
+        charset:      "UTF-8"
+      }
+
+      # Sets the defaults through app configuration:
+      #
+      #     config.action_message.default(from: "+11231231234")
+      #
+      # Aliased by ::default_options=
+      def default(value = nil)
+        self.default_params = default_params.merge(value).freeze if value
+        default_params
+      end
+      # Allows to set defaults through app configuration:
+      #
+      #    config.action_mailer.default_options = { from: "no-reply@example.org" }
+      alias :default_options= :default
+
+      def mailer_name
+        @mailer_name ||= anonymous? ? 'anonymous' : name.underscore
+      end
+      # Allows to set the name of current mailer.
+      attr_writer :mailer_name
+      alias :controller_path :mailer_name
+
+      def base_paths
+        %w(
+          app/views 
+          app/views/messages 
+          app/views/mailers 
+          app/views/application 
+          app/views/layouts
+        ).freeze
+      end
+
+      protected
+        def method_missing(method_name, *args) # :nodoc:
+          if action_methods.include?(method_name.to_s)
+            MessageDelivery.new(self, method_name, *args)
+          else
+            super
+          end
+        end
+    end
+
+    attr_internal :message
+    attr_accessor :template_name
+
+    def initialize
+      super()
+      @_message_was_called = false
+      @_message = Message.new
+    end
+
+    def sms(params = {}, &block)
+      return message if @_message_was_called && params[:to].blank? && !block
+      
+      @_message_was_called = true
+
+      lookup_context.view_paths = self.class.base_paths
+
+      message.headers = self.class.default_params.slice(:charset, :mime_version)
+      message.to = params[:to]
+      message.debug = params[:debug]
+      message.body = render(template_name)
+
+      message
+    end
+  end
+end

data/lib/action_message/message.rb

@@ -0,0 +1,18 @@
+module ActionMessage
+  class Message
+    attr_accessor :headers, :action, :args, :body, :to, :debug
+
+    def initialize
+      @adapter = Adapters.adapter
+    end
+
+    def debug?
+      !!@debug
+    end
+
+    def deliver
+      puts "Sending message \"#{body}\" to number #{to}" # TODO: Switch to a decent logger
+      @adapter.send_message(body, to: to) unless debug?
+    end
+  end
+end

data/lib/action_message/message_delivery.rb

@@ -0,0 +1,20 @@
+module ActionMessage
+  class MessageDelivery
+    attr_reader :message_class, :action, :args, :adapter
+
+    def initialize(message_class, action, *args)
+      @message_class, @action, @args = message_class, action, args
+    end
+
+    def deliver_now
+      processed_sms.send(action, *args).deliver
+    end
+
+    protected
+      def processed_sms
+        @processed_sms ||= @message_class.new.tap do |message|
+          message.template_name = action.to_s
+        end
+      end
+  end
+end

data/lib/action_message/version.rb

@@ -0,0 +1,3 @@
+module ActionMessage
+  VERSION = "0.0.0".freeze
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: actionmessage
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Diego Ballona
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: twilio-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.11.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.11.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: ActionMailer heavily-inspired gem to handle SMS/Text Messages
+email:
+- root@dballona.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- actionmessage.gemspec
+- app/messages/merchant_message.rb
+- app/views/merchant_message/send_welcome_sms.text.erb
+- bin/console
+- bin/setup
+- lib/action_message.rb
+- lib/action_message/adapters.rb
+- lib/action_message/adapters/base.rb
+- lib/action_message/adapters/test.rb
+- lib/action_message/adapters/twilio.rb
+- lib/action_message/base.rb
+- lib/action_message/message.rb
+- lib/action_message/message_delivery.rb
+- lib/action_message/version.rb
+homepage: http://github.com/dballona/actionmessage
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: ActionMailer heavily-inspired gem to handle SMS/Text Messages
+test_files: []