actiontexter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c07c70abba49ae94efaf917157560d5875da1a33
+  data.tar.gz: 47ed0798483fcb979995ee767d85b7267f344094
+SHA512:
+  metadata.gz: 26b22ffcbd88a798bc69f9d598ab17ef59613c1f5afe4fe69ada7cf80a84fddd02b6a3cf155b7f2e989db1b165cfce920538cf18baa8a6e88b06caae6690f988
+  data.tar.gz: 1d05bcc3498f847f4978c025a7d3c766b4bdcf056ae2a74fe256fb3010563452f955471e4cd9f978d8d9985b976ac72628a1aeefd045c1daa6af565084eef0dd

data/.gitignore

@@ -0,0 +1,7 @@
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/log/*.log
+test/dummy/tmp/
+*.swp

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) {{year}} {{fullname}}
+
+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.rdoc

@@ -0,0 +1,27 @@
+= ActionTexter
+
+Allows you to build text messages similar to ActionMailer
+
+== Installation
+
+In your Gemfile add:
+
+  gem 'action_texter'
+
+Install your gems:
+
+  bundle install
+
+That's it!
+
+== Configuration
+
+In your environments/[RAILS_ENV].rb file, add:
+
+  config.action_texter.delivery_method = :file
+  config.action_texter.file_settings = {}
+
+== Contributing
+
+If you'd like to contribute to this project, please fork and send me a pull
+request.

data/actiontexter.gemspec

@@ -0,0 +1,18 @@
+require File.expand_path('../lib/action_texter/version', __FILE__)
+Gem::Specification.new do |s|
+  s.name = "actiontexter"
+  s.version = ActionTexter::VERSION::STRING
+  s.description = 'Allows you to build text messages similar to ActionMailer'
+  s.summary = 'Allows you to build text messages similar to ActionMailer'
+  s.add_dependency "activesupport", ">= 3.0.0"
+
+  s.author = "Jeff Ching"
+  s.email = "jeff@chingr.com"
+  s.homepage = "http://github.com/chingor13/action_texter"
+  s.extra_rdoc_files = ['README.rdoc']
+  s.has_rdoc = true
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files = Dir.glob('test/*_test.rb')
+end
+

data/lib/action_texter.rb

@@ -0,0 +1,22 @@
+actionpack_path = File.expand_path('../../../actionpack/lib', __FILE__)
+$:.unshift(actionpack_path) if File.directory?(actionpack_path) && !$:.include?(actionpack_path)
+
+require 'abstract_controller'
+require 'action_view'
+require 'action_texter/version'
+
+module ActionTexter
+  extend ::ActiveSupport::Autoload
+
+  autoload :Base
+  autoload :Message
+  autoload :DeliveryMethods
+  autoload :FileDelivery
+  autoload :TestDelivery
+  autoload :TwilioDelivery
+  autoload :WhitelistProxyDelivery
+end
+
+if defined?(Rails)
+  require 'action_texter/railtie'
+end

data/lib/action_texter/base.rb

@@ -0,0 +1,115 @@
+module ActionTexter
+  class Base < AbstractController::Base
+    include DeliveryMethods
+    abstract!
+
+    include AbstractController::Logger
+    include AbstractController::Rendering
+    include AbstractController::Layouts
+    include AbstractController::Helpers
+    include AbstractController::Translation
+    include AbstractController::AssetPaths
+
+    self.protected_instance_variables = %w(@_action_has_layout)
+
+    class_attribute :default_params
+    self.default_params = {}.freeze
+
+    class << self
+      # Register one or more Observers which will be notified when mail is delivered.
+      def register_observers(*observers)
+        observers.flatten.compact.each { |observer| register_observer(observer) }
+      end
+
+      # Register one or more Interceptors which will be called before mail is sent.
+      def register_interceptors(*interceptors)
+        interceptors.flatten.compact.each { |interceptor| register_interceptor(interceptor) }
+      end
+
+      # Register an Observer which will be notified when mail is delivered.
+      # Either a class or a string can be passed in as the Observer. If a string is passed in
+      # it will be <tt>constantize</tt>d.
+      def register_observer(observer)
+        delivery_observer = (observer.is_a?(String) ? observer.constantize : observer)
+        Mail.register_observer(delivery_observer)
+      end
+
+      # Register an Interceptor which will be called before mail is sent.
+      # Either a class or a string can be passed in as the Interceptor. If a string is passed in
+      # it will be <tt>constantize</tt>d.
+      def register_interceptor(interceptor)
+        delivery_interceptor = (interceptor.is_a?(String) ? interceptor.constantize : interceptor)
+        Mail.register_interceptor(delivery_interceptor)
+      end
+
+      def texter_name
+        @texter_name ||= name.underscore
+      end
+      attr_writer :texter_name
+      alias :controller_path :texter_name
+
+      def default(value = nil)
+        self.default_params = default_params.merge(value).freeze if value
+        default_params
+      end
+
+      def respond_to?(method, include_private = false)
+        super || action_methods.include?(method.to_s)
+      end
+
+      protected
+
+      def method_missing(method, *args)
+        return super unless respond_to?(method)
+        new(method, *args).message
+      end
+    end
+
+    attr_internal :message
+
+    def initialize(method_name = nil, *args)
+      super()
+      @_message = Message.new
+      process(method_name, *args) if method_name
+    end
+
+    def process(*args)
+      lookup_context.skip_default_locale!
+      super
+    end
+
+    def texter_name
+      self.class.texter_name
+    end
+
+    def text(headers={}, &block)
+      m = @_message
+
+      wrap_delivery_behavior!(headers.delete(:delivery_method))
+
+      # Call all the procs (if any)
+      default_values = self.class.default.merge(self.class.default) do |k,v|
+        v.respond_to?(:call) ? v.bind(self).call : v
+      end
+      headers = headers.reverse_merge(default_values)
+      headers.each do |k, v|
+        m[k] = v
+      end
+
+      templates_path = self.class.texter_name
+      templates_name = action_name
+
+      each_template(templates_path, templates_name) do |template|
+        m.body ||= render(:template => template)
+      end
+      m
+    end
+
+    def each_template(paths, name, &block)
+      templates = lookup_context.find_all(name, Array.wrap(paths))
+      templates.uniq { |t| t.formats }.each(&block)
+    end
+
+    ActiveSupport.run_load_hooks(:action_texter, self)
+  end
+end

data/lib/action_texter/delivery_methods.rb

@@ -0,0 +1,74 @@
+require 'tmpdir'
+
+module ActionTexter
+  # This module handles everything related to mail delivery, from registering new
+  # delivery methods to configuring the mail object to be sent.
+  module DeliveryMethods
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :delivery_methods, :delivery_method
+
+      # Do not make this inheritable, because we always want it to propagate
+      cattr_accessor :raise_delivery_errors
+      self.raise_delivery_errors = true
+
+      cattr_accessor :perform_deliveries
+      self.perform_deliveries = true
+
+      self.delivery_methods = {}.freeze
+      self.delivery_method  = :file
+
+      add_delivery_method :file, ActionTexter::FileDelivery,
+        :location => defined?(Rails.root) ? "#{Rails.root}/tmp/texts" : "#{Dir.tmpdir}/texts"
+      add_delivery_method :test, ActionTexter::TestDelivery
+      add_delivery_method :twilio, ActionTexter::TwilioDelivery
+      add_delivery_method :whitelist_proxy, ActionTexter::WhitelistProxyDelivery
+    end
+
+    module ClassMethods
+      # Provides a list of SMS messages that have been delivered by ActionTexter::TestDelivery
+      delegate :deliveries, :deliveries=, :to => ActionTexter::TestDelivery
+
+      # Adds a new delivery method through the given class using the given symbol
+      # as alias and the default options supplied:
+      #
+      # Example:
+      #
+      #   add_delivery_method :sendmail, Mail::Sendmail,
+      #     :location   => '/usr/sbin/sendmail',
+      #     :arguments  => '-i -t'
+      #
+      def add_delivery_method(symbol, klass, default_options={})
+        class_attribute(:"#{symbol}_settings") unless respond_to?(:"#{symbol}_settings")
+        send(:"#{symbol}_settings=", default_options)
+        self.delivery_methods = delivery_methods.merge(symbol.to_sym => klass).freeze
+      end
+
+      def wrap_delivery_behavior(message, method=nil) #:nodoc:
+        method ||= self.delivery_method
+        message.delivery_handler = self
+
+        case method
+        when NilClass
+          raise "Delivery method cannot be nil"
+        when Symbol
+          if klass = delivery_methods[method.to_sym]
+            message.delivery_method(klass, send(:"#{method}_settings"))
+          else
+            raise "Invalid delivery method #{method.inspect}"
+          end
+        else
+          message.delivery_method(method)
+        end
+
+        message.perform_deliveries    = perform_deliveries
+        message.raise_delivery_errors = raise_delivery_errors
+      end
+    end
+
+    def wrap_delivery_behavior!(*args) #:nodoc:
+      self.class.wrap_delivery_behavior(@_message, *args)
+    end
+  end
+end

data/lib/action_texter/file_delivery.rb

@@ -0,0 +1,19 @@
+module ActionTexter
+  class FileDelivery
+    attr_reader :location
+    def initialize(config = {})
+      @location = config[:location]
+      raise ArgumentError, "you must specify config.action_texter.file_settings to contain a :location" unless @location
+      Dir.mkdir(@location) unless Dir.exists?(@location)
+    end
+
+    def deliver(message)
+      File.open(File.join(location, "#{message.to}.txt"), "a") do |file|
+        file.puts("FROM: #{message.from}")
+        file.puts(message.body)
+        file.puts("-"*40)
+      end
+      true
+    end
+  end
+end

data/lib/action_texter/message.rb

@@ -0,0 +1,39 @@
+module ActionTexter
+  class Message
+    attr_accessor :to, :from, :body
+
+    attr_accessor :delivery_handler, :perform_deliveries, :raise_delivery_errors
+    attr_reader :delivery_method, :delivery_options
+
+    def initialize(attrs = {})
+      attrs.each do |k, v|
+        self.send("#{k}=", v) if self.respond_to?("#{k}=")
+      end
+    end
+
+    def []=(k, v)
+      self.send("#{k}=", v) if self.respond_to?("#{k}=")
+    end
+
+    def [](k)
+      self.send(k) if self.respond_to?(k)
+    end
+
+    def deliver
+      return false unless perform_deliveries
+      begin
+        @delivery_method.deliver(self)
+      rescue => e
+        raise e if raise_delivery_errors
+      end
+    end
+
+    def delivery_method(method = nil, opts = {})
+      unless method
+        @delivery_method
+      else
+        @delivery_method = method.new(opts)
+      end
+    end
+  end
+end

data/lib/action_texter/railtie.rb

@@ -0,0 +1,45 @@
+require "action_texter"
+require "rails"
+require "abstract_controller/railties/routes_helpers"
+
+module ActionTexter
+  class Railtie < Rails::Railtie
+    config.action_texter = ActiveSupport::OrderedOptions.new
+
+    initializer "action_texter.logger" do
+      ActiveSupport.on_load(:action_texter) { self.logger ||= Rails.logger }
+    end
+
+    initializer "action_texter.set_configs" do |app|
+      paths   = app.config.paths
+      options = app.config.action_texter
+
+      options.assets_dir      ||= paths["public"].first
+      options.javascripts_dir ||= paths["public/javascripts"].first
+      options.stylesheets_dir ||= paths["public/stylesheets"].first
+
+      # make sure readers methods get compiled
+      #options.asset_path          ||= app.config.asset_path
+      options.asset_host          ||= app.config.asset_host
+      options.relative_url_root   ||= app.config.relative_url_root
+
+      ActiveSupport.on_load(:action_texter) do
+        include AbstractController::UrlFor
+        extend ::AbstractController::Railties::RoutesHelpers.with(app.routes)
+        include app.routes.mounted_helpers
+
+        register_interceptors(options.delete(:interceptors))
+        register_observers(options.delete(:observers))
+
+        options.each { |k,v| send("#{k}=", v) }
+        prepend_view_path(Rails.configuration.paths["app/views"])
+      end
+    end
+
+    initializer "action_texter.compile_config_methods" do
+      ActiveSupport.on_load(:action_texter) do
+        config.compile_methods! if config.respond_to?(:compile_methods!)
+      end
+    end
+  end
+end

data/lib/action_texter/test_delivery.rb

@@ -0,0 +1,14 @@
+module ActionTexter
+  class TestDelivery
+    cattr_accessor :deliveries
+    self.deliveries = []
+
+    def initialize(config = {})
+    end
+
+    def deliver(message)
+      self.class.deliveries << message
+      true
+    end
+  end
+end

data/lib/action_texter/twilio_delivery.rb

@@ -0,0 +1,23 @@
+module ActionTexter
+  class TwilioDelivery
+    attr_reader :client
+
+    def initialize(config = {})
+      @sid = config[:sid]
+      @token = config[:token]
+      @subaccount = config[:subaccount]
+      raise ArgumentError, "you must specify config.action_texter.twilio_settings to contain a :sid" unless @sid
+      raise ArgumentError, "you must specify config.action_texter.twilio_settings to contain a :token" unless @token
+      @client = Twilio::REST::Client.new(@sid, @token)
+      @client = client.accounts.find(@subaccount) if @subaccount
+    end
+
+    def deliver(message)
+      client.sms.messages.create(
+        :from => message.from,
+        :to => message.to,
+        :body => message.body.strip
+      )
+    end
+  end
+end

data/lib/action_texter/version.rb

@@ -0,0 +1,10 @@
+module ActionTexter
+  module VERSION
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 0
+    PRE   = nil
+
+    STRING =  [MAJOR, MINOR, TINY, PRE].compact.join('.')
+  end
+end

data/lib/action_texter/whitelist_proxy_delivery.rb

@@ -0,0 +1,32 @@
+module ActionTexter
+  class WhitelistProxyDelivery
+    class BlockedDelivery < StandardError; end
+    attr_reader :delivery_method, :whitelist
+
+    def initialize(config = {})
+      @delivery_method = config[:delivery_method]
+      @whitelist = config[:whitelist]
+      raise ArgumentError, "you must specify config.action_texter.whitelist_proxy_settings to contain a :delivery_method" unless @delivery_method
+      raise ArgumentError, "you must specify config.action_texter.whitelist_proxy_settings to contain a :whitelist" unless @whitelist
+    end
+
+    def deliver(message)
+      raise BlockedDelivery if blocked?(message.to)
+
+      real_delivery_method.deliver(message)
+    end
+
+    protected
+
+    def blocked?(to)
+      !whitelist.include?(to.to_s)
+    end
+
+    def real_delivery_method
+      @real_delivery_method ||= begin
+        settings = ActionTexter::Base.send(:"#{self.delivery_method}_settings")
+        ActionTexter::Base.delivery_methods[self.delivery_method].new(settings)
+      end
+    end
+  end
+end

data/lib/actiontexter.rb

@@ -0,0 +1 @@
+require 'action_texter'

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: actiontexter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeff Ching
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Allows you to build text messages similar to ActionMailer
+email: jeff@chingr.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- .gitignore
+- LICENSE
+- README.rdoc
+- actiontexter.gemspec
+- lib/action_texter.rb
+- lib/action_texter/base.rb
+- lib/action_texter/delivery_methods.rb
+- lib/action_texter/file_delivery.rb
+- lib/action_texter/message.rb
+- lib/action_texter/railtie.rb
+- lib/action_texter/test_delivery.rb
+- lib/action_texter/twilio_delivery.rb
+- lib/action_texter/version.rb
+- lib/action_texter/whitelist_proxy_delivery.rb
+- lib/actiontexter.rb
+homepage: http://github.com/chingor13/action_texter
+licenses: []
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Allows you to build text messages similar to ActionMailer
+test_files: []