text_message_rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 26a5894e66db8b6c2e44ed920d7acf88ceb77531
+  data.tar.gz: 8ebc8940b11eb126ea840c227b0f121fbd675230
+SHA512:
+  metadata.gz: ef033256a2d69cf276bc05a7efedde046a4854750f1035924fd84ebc48c722594c43c60f18cfb07447bc6982c7e520df9b73801878263c3d8655ad9f31536949
+  data.tar.gz: 53f212e246d673a905f3e06b309e7a6b321a173f3718557a17c1727b45730945f75d6b47f8dc7a78c43507b0c7b54c86927c267da566268823334f4428e2c257

data/.gitignore

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

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/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at aurelien.noce@imagine-app.fr. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Aurélien Noce
+
+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,99 @@
+# text_message_rails
+
+A simple gem to send text messages from rails
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'text_message_rails'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install text_message_rails
+
+## Usage
+
+In your application config, define the provider you want ot use (for now on,
+only TextMagic is supported):
+
+```ruby
+config.text_message.provider = :text_magic
+```
+
+Then create instances of the `TextMessage::Controller`:
+
+
+```ruby
+class ClientTextMessages < TextMessage::Controller
+
+  def confirm_order(order)
+    @order = order
+    @user = @order.user
+
+    # ...
+
+    phone_number = user.phone_number
+    send_to phone_number
+  end
+
+end
+```
+
+And associated view(s):
+
+```erb
+<%# in app/views/client_text_messages/confirm_order.text.erb %>
+Dear <%= user.name %> your order <%= order.id %> is confirmed !
+```
+
+Then from a different class, call:
+
+```ruby
+ClientTextMessages.confirm_order(order).deliver_now!
+# or
+ClientTextMessages.confirm_order(order).deliver_later!
+```
+
+## Provider
+
+For the time being, only the `TextMagic` provider is supported.
+
+To use it, include it in you `Gemfile`:
+
+```ruby
+# include the API gem
+gem "text_magic"
+
+# (optional but recommanded) include Phony Rails so the provider will reformat
+# the phone number in TextMagic-friendly way:
+gem "phony_rails"
+```
+
+And enable its use in the configuration:
+
+```ruby
+config.text_message.provider = :text_magic
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/text_message_rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "text/messages/rails"
+
+# 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/text_message_rails.rb

@@ -0,0 +1,14 @@
+module TextMessage
+
+  autoload :VERSION, "text_message_rails/version"
+
+  autoload :Controller, "text_message_rails/controller"
+  autoload :Delivery, "text_message_rails/delivery"
+  autoload :DeliveryJob, "text_message_rails/delivery_job"
+  autoload :DeliveryMethods, "text_message_rails/delivery_methods"
+  autoload :Rendering, "text_message_rails/rendering"
+  autoload :Providers, "text_message_rails/providers"
+
+end
+
+require "text_message_rails/railtie" if defined?(::Rails::Railtie)

data/lib/text_message_rails/controller.rb

@@ -0,0 +1,87 @@
+require "abstract_controller"
+
+module TextMessage
+
+	# = TextMessage controller base class
+	# This class acts as a controller, similar to +ActionMailer::Controller+ subclasses.
+	# To use it:
+	#
+	#  - implement action methods as in a "usual" controller
+	#
+	#   class TextMessageTest < TextMessage::Controller
+	#
+	#     # Will render app/views/sms_test/toto.(...), passing it the instance variables
+	#     def toto
+	#       @tutu = 4
+	#     end
+	#
+	#   end
+	class Controller < AbstractController::Base
+
+		# Load tons of AbstractController plugins
+		include AbstractController::Rendering
+		include AbstractController::Logger
+		include AbstractController::Helpers
+		include AbstractController::Callbacks
+
+		# Defines #render_to_body, needed by #render.
+		include ::TextMessage::Rendering
+
+		# Instanciate a new TextMessage object.
+		#
+		# Then calls +method_name+ with the given +args+.
+		def initialize(method_name, *args)
+			@recipients = []
+			super()
+			process(method_name, *args)
+		end
+
+		# Basic Recipients handling
+		attr_reader :recipients
+		def send_to(*recipients)
+			@recipients = recipients || []
+		end
+
+		class << self
+
+      def default_url_options=(options)
+        @@default_url_options =  options
+      end
+      # Reuses ActionMailer url options by default
+      def default_url_options
+        @@default_url_options || ActionMailer::Base.default_url_options
+      end
+
+      def provider=(p)
+        @@provider = p
+      end
+      # Defaults provider to the Base (empty) provider: will raise !
+      def provider
+        @@provider || TextMessage::Providers::Base
+      end
+
+			# Respond to the action methods directly on the class
+			#
+			# for example calling `TextMessageDemo.toto` (with TextMessageDemo a subclass of +TextMessage::Controller+)
+			# will create a +TextMessage::Delivery+ instance tied to the `TextMessageDemo` class,
+			# method `:toto` with no argument.
+
+			def respond_to?(method, include_private = false) #:nodoc:
+				super || action_methods.include?(method.to_s)
+			end
+
+			def method_missing(method_name, *args) #:nodoc:
+				if action_methods.include?(method_name.to_s)
+					TextMessage::Delivery.new(self, method_name, *args)
+				else
+					super
+				end
+			end
+
+      def deliver_text_message(delivery)
+        provider.deliver_text_message(delivery)
+      end
+		end
+	end
+
+end

data/lib/text_message_rails/delivery.rb

@@ -0,0 +1,41 @@
+module TextMessage
+
+  # = TextMessage Delivery Proxy
+  # The +Delivery+ class is the class returned by the +TextMessage::Base+ actions.
+  # It is used to enable lazy processing of the actions.
+  class Delivery < Delegator
+
+    include ::TextMessage::DeliveryMethods
+
+    # Creates a new +Delivery+ proxy.
+    # By providing a +TextMessage::Base+ subclass +text_message_class+, a method name to call
+    # +text_message_method+ and a set of arguments to this method +args+, we allow
+    # for lazy processing of the text_message action.
+    def initialize(text_message_class, text_message_method, *args)
+      @text_message_class = text_message_class.kind_of?(Class) ? text_message_class : text_message_class.constantize
+      @text_message_method = text_message_method
+      @args = args
+    end
+
+    # Needed by Decorator superclass
+    def __getobj__ #:nodoc:
+      @obj ||= @text_message_class.send(:new, @text_message_method, *@args)
+    end
+
+    # computes the body of the TextMessage
+    def body
+      renderer.render(view_context, template: "#{templates_dir}/#{@text_message_method}")
+    end
+
+    # The name of the templates which holds the templates.
+    # Usually it is the name of the class with underscores, something like:
+    #
+    #   TextMessageDemo.new.templates_dir => "text_message demo"
+    #   # so for exemple TextMessageDemo#toto will lookup for text_message_demo/toto{.text.erb}
+    def templates_dir
+      @text_message_class.to_s.underscore
+    end
+
+  end
+
+end

data/lib/text_message_rails/delivery_job.rb

@@ -0,0 +1,17 @@
+module TextMessage
+
+  # = TextMessage Deblivery Job
+  # The +TextMessage::DeliveryJob+ class is used to defer text_message delivery through ActiveJob.
+  class DeliveryJob < ActiveJob::Base #:nodoc:
+
+    queue_as :text_messages
+
+    # calls +deliver_now!+ on the text_message class
+    def perform(text_message_class, text_message_method, delivery_method, *args)
+      delivery = ::TextMessage::Delivery.new(text_message_class, text_message_method, *args)
+      delivery.send(delivery_method)
+    end
+  end
+
+end
+

data/lib/text_message_rails/delivery_methods.rb

@@ -0,0 +1,28 @@
+module TextMessage
+
+  # = TextMessage Delivery Methods
+  module DeliveryMethods
+
+    # Defivers a TextMessage
+    def deliver_now!
+      @text_message_class.deliver_text_message(self)
+    end
+
+    # Posts a ActionJob job to call +deliver_now!+ later
+    def deliver_later!(options={})
+      enqueue_delivery :deliver_now!, options
+    end
+
+    private
+
+    # Enqueues a delivery
+    # +options+ are passed to ActiveJob.
+    # +delivery_method+ (usually +deliver_now!+ is called with the saved +@args+ on time.
+    def enqueue_delivery(delivery_method, options={})
+      args = @text_message_class.name, @text_message_method.to_s, delivery_method.to_s, *@args
+      ::TextMessage::DeliveryJob.set(options).perform_later(*args)
+    end
+
+  end
+
+end

data/lib/text_message_rails/providers.rb

@@ -0,0 +1,38 @@
+module TextMessage
+  module Providers
+    class Error < StandardError; end
+
+    def self.find(name)
+      "TextMessage::Providers::#{name.to_s.camelize}".constantize
+    end
+
+    class Base
+      attr_reader :delivery
+      attr_reader :options
+
+      def self.deliver_text_message(delivery, options={})
+        new(delivery, options).deliver_text_message
+      end
+
+      def initialize(delivery, options={})
+        @delivery = delivery
+        @options  = options
+      end
+
+      def deliver_text_message
+        raise Error.new("no provider configured")
+      end
+
+      def message
+        delivery.body.to_str
+      end
+
+      def recipients
+        delivery.recipients.map(&:to_str)
+      end
+    end
+
+    # Known providers
+    autoload :TextMagic, "text_message_rails/providers/text_magic" if defined?(::TextMagic)
+  end
+end

data/lib/text_message_rails/providers/text_magic.rb

@@ -0,0 +1,33 @@
+module TextMessage
+  module Providers
+
+    class TextMagic < Base
+      def deliver_text_message
+        client.send(message, *escaped_recipients, options)
+      end
+
+      def escaped_recipients
+        return recipients unless defined?(PhonyRails)
+
+        Array(recipients).map { |recipient|
+          PhonyRails.normalize_number(recipient, format: :international_relative, spaces: '', add_plus: false)
+        }
+      end
+
+      def client
+        @client ||= ::TextMagic::API.new(username, password)
+      end
+
+      private
+
+      def username
+        options[:username] || ENV["TEXTMAGIC_USERNAME"]
+      end
+
+      def password
+        options[:password] || ENV["TEXTMAGIC_PASSWORD"]
+      end
+    end
+
+  end
+end

data/lib/text_message_rails/railtie.rb

@@ -0,0 +1,19 @@
+require "rails"
+
+module TextMessage
+  class Railtie < Rails::Railtie
+    config.text_message = ActiveSupport::OrderedOptions.new
+
+    initializer "text_message.configure" do |app|
+      app_options = app.config.text_message
+
+      if default_url_options = app_options.default_url_options
+        TextMessage::Controller.default_url_options = default_url_options
+      end
+
+      if provider_key = app_options.provider
+        TextMessage::Controller.provider = TextMessage::Providers.find(provider_key)
+      end
+    end
+  end
+end

data/lib/text_message_rails/rendering.rb

@@ -0,0 +1,50 @@
+require "rails"
+
+module TextMessage
+
+  # = TextMessage Rendering methods
+  module Rendering
+
+    def self.included(klass) #:nodoc:
+      # setup the view path: will lookup templates in view_paths/template_name
+      klass.view_paths = "app/views"
+    end
+
+    # Called internally by #render
+    def render_to_body(options={}) #:nodoc:
+      renderer.render(view_context, options)
+    end
+
+    # Use custom rendeing class with helpers loaded
+    def view_context # :nodoc:
+      @view_context ||= TemplateContext.new(renderer, view_assigns, self)
+    end
+
+    # Simple out-of-the box ActionView::Renderer
+    def renderer #:nodoc:
+      @renderer ||= ActionView::Renderer.new(lookup_context)
+    end
+
+
+    #
+    # Private class to render provide rendering context with helpers
+    #
+
+    class TemplateContext < ActionView::Base #:nodoc:
+      # Load route helpers
+      include Rails.application.routes.url_helpers
+      # load tag helpers (link_to ...)
+      include ActionView::Helpers::TagHelper
+
+      # Default options for urls
+      def default_url_options
+        TextMessage::Controller.default_url_options.merge({
+          #action: action_name,
+          #controller: controller.class.name.underscore
+        })
+      end
+    end
+
+  end
+
+end

data/lib/text_message_rails/version.rb

@@ -0,0 +1,3 @@
+module TextMessage
+  VERSION = "0.1.0"
+end

data/text_message_rails.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'text_message_rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "text_message_rails"
+  spec.version       = TextMessage::VERSION
+  spec.authors       = ["Aurélien Noce"]
+  spec.email         = ["aurelien.noce@imagine-app.fr"]
+
+  spec.summary       = %q{Easy text messaging from Rails.}
+  spec.description   = %q{
+    Simple ActionMail-like Text Message controllers for Rails 3+.
+    (this is a *very* early version !)
+  }
+  spec.homepage      = "http://github.com/ushu/text_message_rails"
+  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_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_runtime_dependency "rails", "> 3.0"
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: text_message_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aurélien Noce
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-10 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: "\n    Simple ActionMail-like Text Message controllers for Rails 3+.\n
+  \   (this is a *very* early version !)\n  "
+email:
+- aurelien.noce@imagine-app.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/text_message_rails.rb
+- lib/text_message_rails/controller.rb
+- lib/text_message_rails/delivery.rb
+- lib/text_message_rails/delivery_job.rb
+- lib/text_message_rails/delivery_methods.rb
+- lib/text_message_rails/providers.rb
+- lib/text_message_rails/providers/text_magic.rb
+- lib/text_message_rails/railtie.rb
+- lib/text_message_rails/rendering.rb
+- lib/text_message_rails/version.rb
+- text_message_rails.gemspec
+homepage: http://github.com/ushu/text_message_rails
+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: Easy text messaging from Rails.
+test_files: []