smser 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fa4a51837ff0ef6c0b71514210978aa258a2fcdf
+  data.tar.gz: 63ed011eabd9eaf6fbd8b6bc2b70c050b942063b
+SHA512:
+  metadata.gz: b091f138ef7ed03d02c42c490944543bca26e546da786432132a837d5ce62bebe5bd116e69695d3afbf26b09bf877f488cb002735a9fffa4db24643aeb7e29a9
+  data.tar.gz: 74a433e7c6cb6cfcf97c3d9737adf93aa459c01515512f5c3c7f4741cc7b3781abc6173f7f00bb06926cfd9008470623d0e32cb52661d212a3c6b1d8b780a926

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,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Anton Sozontov
+
+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,41 @@
+# Smser
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/smser`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'smser'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install smser
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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]/smser.
+
+
+## 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 "smser"
+
+# 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/smser.rb

@@ -0,0 +1,9 @@
+require 'smser/version'
+
+require 'smser/base'
+require 'smser/sms_delivery'
+require 'smser/message'
+
+module Smser
+  mattr_accessor :deliver_method
+end

data/lib/smser/base.rb

@@ -0,0 +1,60 @@
+require 'smser/rescuable'
+
+module Smser
+  class Base < AbstractController::Base
+    include Rescuable
+
+    class_attribute :default_params
+    self.default_params = {}.freeze
+
+    cattr_accessor :deliver_later_queue_name
+    self.deliver_later_queue_name = :smsers
+
+    class << self
+      def default(value = nil)
+        self.default_params = default_params.merge(value).freeze if value
+        default_params
+      end
+      alias :default_options= :default
+
+      def sms_path
+        @sms_path ||= name.underscore
+      end
+
+      # Allows to set the name of current mailer.
+      attr_writer :smser_name
+      alias :controller_path :sms_path
+
+      def method_missing(method_name, *args) # :nodoc:
+        if action_methods.include?(method_name.to_s)
+          Smser::SmsDelivery.new(self, method_name, *args)
+        else
+          super
+        end
+      end
+    end
+
+    attr_internal :message, :action_name
+
+    def sms(to:, body: nil, from: nil, callback: nil)
+      @_message ||= Message.new(
+        to: to,
+        from: from || default_params[:from],
+        body: body || default_i18n_body,
+        status_callback: callback || default_params[:status_callback]
+      )
+    end
+
+    def process(method_name, *args) #:nodoc:
+      @_action_name = method_name.to_s
+      process_action(method_name, *args)
+    end
+
+    private
+
+    def default_i18n_body(interpolations = {})
+      mailer_scope = self.class.sms_path.tr('/', '.')
+      I18n.t!(action_name, interpolations.merge(scope: [mailer_scope]))
+    end
+  end
+end

data/lib/smser/delivery_job.rb

@@ -0,0 +1,34 @@
+require 'active_job'
+
+module Smser
+  # The <tt>Smser::DeliveryJob</tt> class is used when you
+  # want to send emails outside of the request-response cycle.
+  #
+  # Exceptions are rescued and handled by the smser class.
+  class DeliveryJob < ActiveJob::Base # :nodoc:
+    queue_as { Smser::Base.deliver_later_queue_name }
+
+    rescue_from StandardError, with: :handle_exception_with_smser_class
+
+    def perform(smser, mail_method, delivery_method, *args) #:nodoc:
+      smser.constantize.public_send(mail_method, *args).send(delivery_method)
+    end
+
+    private
+    # "Deserialize" the smser class name by hand in case another argument
+    # (like a Global ID reference) raised DeserializationError.
+    def smser_class
+      if smser = Array(@serialized_arguments).first || Array(arguments).first
+        smser.constantize
+      end
+    end
+
+    def handle_exception_with_smser_class(exception)
+      if klass = smser_class
+        klass.handle_exception exception
+      else
+        raise exception
+      end
+    end
+  end
+end

data/lib/smser/message.rb

@@ -0,0 +1,16 @@
+module Smser
+  class Message
+    attr_reader :to, :from, :body, :options
+
+    def initialize(to:, from:, body:, **options)
+      @to = to
+      @from = from
+      @body = body
+      @options = options
+    end
+
+    def deliver
+      Smser.deliver_method.call(self)
+    end
+  end
+end

data/lib/smser/rescuable.rb

@@ -0,0 +1,27 @@
+module Smser #:nodoc:
+  # Provides `rescue_from` for mailers. Wraps mailer action processing,
+  # mail job processing, and mail delivery.
+  module Rescuable
+    extend ActiveSupport::Concern
+    include ActiveSupport::Rescuable
+
+    class_methods do
+      def handle_exception(exception) #:nodoc:
+        rescue_with_handler(exception) || raise(exception)
+      end
+    end
+
+    def handle_exceptions #:nodoc:
+      yield
+    rescue => exception
+      rescue_with_handler(exception) || raise
+    end
+
+    private
+    def process(*)
+      handle_exceptions do
+        super
+      end
+    end
+  end
+end

data/lib/smser/sms_delivery.rb

@@ -0,0 +1,126 @@
+require 'smser/delivery_job'
+require 'delegate'
+
+module Smser
+  # The <tt>ActionMailer::MessageDelivery</tt> class is used by
+  # <tt>ActionMailer::Base</tt> when creating a new mailer.
+  # <tt>MessageDelivery</tt> is a wrapper (+Delegator+ subclass) around a lazy
+  # created <tt>Mail::Message</tt>. You can get direct access to the
+  # <tt>Mail::Message</tt>, deliver the email or schedule the email to be sent
+  # through Active Job.
+  #
+  #   Notifier.welcome(User.first)               # an ActionMailer::MessageDelivery object
+  #   Notifier.welcome(User.first).deliver_now   # sends the email
+  #   Notifier.welcome(User.first).deliver_later # enqueue email delivery as a job through Active Job
+  #   Notifier.welcome(User.first).message       # a Mail::Message object
+  class SmsDelivery < Delegator
+    def initialize(smser_class, action, *args) #:nodoc:
+      @smser_class, @action, @args = smser_class, action, args
+
+      # The sms is only processed if we try to call any methods on it.
+      # Typical usage will leave it unloaded and call deliver_later.
+      @processed_smser = nil
+      @sms_message = nil
+    end
+
+    # Method calls are delegated to the Mail::Message that's ready to deliver.
+    def __getobj__ #:nodoc:
+      @sms_message ||= processed_smser.message
+    end
+
+    # Unused except for delegator internals (dup, marshaling).
+    def __setobj__(sms_message) #:nodoc:
+      @sms_message = sms_message
+    end
+
+    # Returns the resulting Mail::Message
+    def message
+      __getobj__
+    end
+
+    # Was the delegate loaded, causing the smser action to be processed?
+    def processed?
+      @processed_smser || @sms_message
+    end
+
+    # Enqueues the esms to be delivered through Active Job. When the
+    # job runs it will send the esms using +deliver_now!+. That means
+    # that the message will be sent bypassing checking +perform_deliveries+
+    # and +raise_delivery_errors+, so use with caution.
+    #
+    #   Notifier.welcome(User.first).deliver_later!
+    #   Notifier.welcome(User.first).deliver_later!(wait: 1.hour)
+    #   Notifier.welcome(User.first).deliver_later!(wait_until: 10.hours.from_now)
+    #
+    # Options:
+    #
+    # * <tt>:wait</tt> - Enqueue the esms to be delivered with a delay
+    # * <tt>:wait_until</tt> - Enqueue the esms to be delivered at (after) a specific date / time
+    # * <tt>:queue</tt> - Enqueue the esms on the specified queue
+    def deliver_later!(options={})
+      enqueue_delivery :deliver_now!, options
+    end
+
+    # Enqueues the esms to be delivered through Active Job. When the
+    # job runs it will send the esms using +deliver_now+.
+    #
+    #   Notifier.welcome(User.first).deliver_later
+    #   Notifier.welcome(User.first).deliver_later(wait: 1.hour)
+    #   Notifier.welcome(User.first).deliver_later(wait_until: 10.hours.from_now)
+    #
+    # Options:
+    #
+    # * <tt>:wait</tt> - Enqueue the esms to be delivered with a delay.
+    # * <tt>:wait_until</tt> - Enqueue the esms to be delivered at (after) a specific date / time.
+    # * <tt>:queue</tt> - Enqueue the esms on the specified queue.
+    def deliver_later(options={})
+      enqueue_delivery :deliver_now, options
+    end
+
+    # Delivers an esms without checking +perform_deliveries+ and +raise_delivery_errors+,
+    # so use with caution.
+    #
+    #   Notifier.welcome(User.first).deliver_now!
+    #
+    def deliver_now!
+      processed_smser.handle_exceptions do
+        message.deliver!
+      end
+    end
+
+    # Delivers an esms:
+    #
+    #   Notifier.welcome(User.first).deliver_now
+    #
+    def deliver_now
+      processed_smser.handle_exceptions do
+        message.deliver
+      end
+    end
+
+    private
+    # Returns the processed Mailer instance. We keep this instance
+    # on hand so we can delegate exception handling to it.
+    def processed_smser
+      @processed_smser ||= @smser_class.new.tap do |smser|
+        smser.process @action, *@args
+      end
+    end
+
+    def enqueue_delivery(delivery_method, options={})
+      if processed?
+        ::Kernel.raise "You've accessed the message before asking to " \
+            "deliver it later, so you may have made local changes that would " \
+            "be silently lost if we enqueued a job to deliver it. Why? Only " \
+            "the smser method *arguments* are passed with the delivery job! " \
+            "Do not access the message in any way if you mean to deliver it " \
+            "later. Workarounds: 1. don't touch the message before calling " \
+            "#deliver_later, 2. only touch the message *within your smser " \
+            "method*, or 3. use a custom Active Job instead of #deliver_later."
+      else
+        args = @smser_class.name, @action.to_s, delivery_method.to_s, *@args
+        ::Smser::DeliveryJob.set(options).perform_later(*args)
+      end
+    end
+  end
+end

data/lib/smser/version.rb

@@ -0,0 +1,3 @@
+module Smser
+  VERSION = '0.1.0'
+end

data/smser.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'smser/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'smser'
+  spec.version       = Smser::VERSION
+  spec.authors       = ['Anton Sozontov']
+  spec.email         = ['a.sozontov@gmail.com']
+
+  spec.summary       = %q{ActionMailer for SMS}
+  spec.description   = %q{Smser provides simple way to manage your sms messages}
+  spec.homepage      = 'https://github.com/qwiqer/smser'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_dependency 'activesupport', '>=3.2', '<5.1'
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: smser
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Anton Sozontov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+description: Smser provides simple way to manage your sms messages
+email:
+- a.sozontov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/smser.rb
+- lib/smser/base.rb
+- lib/smser/delivery_job.rb
+- lib/smser/message.rb
+- lib/smser/rescuable.rb
+- lib/smser/sms_delivery.rb
+- lib/smser/version.rb
+- smser.gemspec
+homepage: https://github.com/qwiqer/smser
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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 for SMS
+test_files: []