babysms 0.5.1

data/.rubocop.yml

@@ -0,0 +1,75 @@
+inherit_from:
+  - .rubocop-airbnb.yml
+
+AllCops:
+  TargetRubyVersion: 2.6.3
+
+Rails:
+  Enabled: true
+
+Layout/EmptyLines:
+  Enabled: false
+
+# Restore Rubocop default
+Layout/DotPosition:
+  EnforcedStyle: leading
+
+# The inbuilt style does not accommodate for:
+#
+# var = begin
+#   something
+# rescue
+#   something
+# end
+#
+# without indenting the entire block and looking dumb.
+
+Layout/RescueEnsureAlignment:
+  Enabled: false
+
+# In every instance where I've removed these extra lines, the result was less readable.
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: false
+
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+# Restore Rubocop default
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: aligned
+
+Layout/CaseIndentation:
+  EnforcedStyle: end
+
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: variable
+
+# Allow both %x() and backticks
+Style/CommandLiteral:
+  Enabled: false
+
+# $? and $: are more idiomatic than importing English and using $MAGIC_GLOBALS.
+# If it's more esoteric, comment.
+Style/SpecialGlobalVars:
+  Enabled: false
+
+# Direct opposite of Prettier, allow either.
+Style/TrailingCommaInHashLiteral:
+  Enabled: false
+
+# Direct opposite of Prettier, allow either
+Style/TrailingCommaInArrayLiteral:
+  Enabled: false
+
+# Allow top-level mixins.  Rightfully used in stubs/tasks
+Style/MixinUsage:
+  Enabled: false
+
+# Generated code/stubs as well as the rest of the code use what's
+# appropriate according to the context
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+# "warn" and $stderr.puts have different connotations
+Style/StderrPuts:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.0
+before_install: gem install bundler -v 1.17.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in babysms.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Mike A. Owens
+
+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,184 @@
+# BabySMS
+
+BabySMS is a Ruby interface to a decent collection of SMS service providers.  With it, you can
+fire and forget SMS messages, or script entire two-way SMS conversations.  All without tying
+yourself to a single provider.
+
+The interface stays the same, So you can comparison-shop for prices or reliability.
+
+BabySMS allows multiple services to be used at once for failover, or random selection of a
+provider for load-balancing (against throttling.)
+
+
+## Installation
+
+Add these lines to your application's `Gemfile`:
+
+```ruby
+gem 'YourAPIProviderGem' # see below
+gem 'babysms', '~> 0.5'
+```
+
+## Usage
+
+### Basic
+```ruby
+BabySMS.adapter = BabySMS::Adapters::SomeAdapter.new(...)
+
+BabySMS::Message.new(to: '+1 555-555-5555', contents: 'Hello, World!').deliver
+```
+
+If you need just basic outgoing functionality, that's all there is to it.
+
+### Multiple Adapters for Reliability
+```ruby
+BabySMS.adapters = [
+  BabySMS::Adapters::HooliAdapter.new(...),
+  BabySMS::Adapters::PiedPiperAdapter.new(...)
+]
+
+BabySMS.strategy = :in_order
+BabySMS::Message.new(...).deliver
+```
+
+This will try `HooliAdapter` first, but if it fails, `PiedPiperAdapter`.  Changing the `strategy`
+to `:random` will go through the list randomly, providing something akin to load-balancing.
+
+## Sending Messages
+
+`BabySMS::Message#deliver` can directly accept an `adapters` keyword argument that overrides the
+global adapters list in `BabySMS.adapter[s]`.
+
+BabySMS will attempt delivery with each adapter until one succeeds, or will raise
+`BabySMS::FailedDelivery` once exhausted.
+
+`#deliver` returns a `BabySMS::Receipt`.  This allows you to inspect (and log) adapters that failed
+along the way to delivery.  Use `#exceptions?` to discover if something is failing, and
+`#exceptions` to see the list of failed deliveries before the successful one.
+
+## Receiving Messages
+
+*Note: This functionality is currently being implemented.*
+
+The API providers report incoming messages to you by accessing a publicly-available URL.  This means
+you have to have a web server running on the open internet to receive and process incoming messages
+
+`BabySMS::WebApplication` is a Rack (Sinatra) application that does just that.
+
+```ruby
+# config.ru
+require 'babysms'
+require 'babysms/web_application'
+
+# Replace this with your service provider as listed below
+BabySMS.adapter = BabySMS::TestAdapter.new
+
+# Publicly-accessible URL
+BabySMS.web_hook_root = "https://example.com/_babysms"
+
+BabySMS.inbox = BabySMS::Inbox.new do
+  receive do |message|
+    puts "Incoming message from #{message.from}:\n"
+    puts "  > #{message.contents}"
+
+    # Replies with same number/adapter, regardless of strategy
+    message.reply(contents: "Thank you for your message.")
+  end
+end
+
+run BabySMS::WebApplication.new
+```
+
+You'll need to secure the web-application against the general public, allowing only your SMS
+providers to access them.
+
+*TODO: Explain exactly how to do that with Rack*
+
+## Rails Integration
+
+*TODO: Write about mounting BabySMS::WebApplication in routes.rb, sending messages via ActiveJob,
+etc*
+
+## Adapters
+
+Each adapter uses the terminology of the service provider for configuration.  E.g., `api_key`
+vs. `auth_token`, etc.  Other than `TestAdapter`, they all share a common `from` initialization
+parameter to specify the number you're sending from.
+
+You can configure multiple adapters (even instances of the same adapter class with different
+configurations) by assigning `BabySMS.adapters` or using the `adapters:` argument to
+`Message#deliver`.
+
+Adapters require external gems to interface with their respective services.  You will have to
+require these gems yourself, and *before* `babysms`: BabySMS enables functionality by feature-
+detecting these gems.
+
+Putting it before `babysms` in your `Gemfile` should work.
+
+
+### TestAdapter
+
+The built-in testing adapter.  It stores outgoing texts in its `outbox`.  It prints colorful lines
+to stderr when a message is sent for development purposes.  It is the default adapter.
+
+`verbose:` controls if it displays the outgoing SMS to stderr.  `fails:` determines if deliveries
+will fail.
+
+```ruby
+BabySMS::Adapters::TestAdapter.new(verbose: true, fails: false, from: '15555555555')
+```
+
+
+### BandwidthAdapter
+
+Requires the `ruby-bandwidth` gem.
+
+```ruby
+BabySMS::Adapters::BandwidthAdapter.new(user_id:, api_token:, api_secret:, from:)
+```
+
+
+### TwilioAdapter
+
+Requires the `twilio-ruby` gem.
+
+```ruby
+BabySMS::Adapters::TwilioAdapter.new(account_sid:, auth_token:, from:)
+```
+
+
+### NexmoAdapter
+
+Requires the `nexmo` gem.
+
+```ruby
+BabySMS::Adapters::NexmoAdapter.new(api_key:, api_secret:, from:)
+```
+
+
+### PlivoAdapter
+
+Requires the `plivo-ruby` gem.
+
+```ruby
+BabySMS::Adapters::PlivoAdapter.new(auth_id:, auth_token:, from:)
+```
+
+
+### SignalwireAdapter
+
+Requires the `signalwire` gem.
+
+```ruby
+# Notice the capitalization, to be consistent with their SDK naming
+BabySMS::Adapters::SignalwireAdapter.new(from:, project:, token:, space_url:)
+```
+
+## Credits
+
+BabySMS was written by Mike A. Owens <mike@filespanker.com>
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](https://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/babysms.gemspec

@@ -0,0 +1,51 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "babysms/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "babysms"
+  spec.version = BabySMS::VERSION
+  spec.authors = ["Mike A. Owens"]
+  spec.email = ["mike@filespanker.com"]
+
+  spec.summary = "Simple Rails interface to a SMS APIs"
+  spec.description = "Functionality to send SMS via Twilio, Nexmo, etc."
+  spec.homepage = "https://github.com/mieko/babysms"
+  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["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/mieko/babysms"
+    spec.metadata["changelog_uri"] = "https://github.com/mieko/babysms/CHANGELOG.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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_dependency "activesupport", ">= 5.2.1"
+  spec.add_dependency "rainbow", ">= 3.0"
+  spec.add_dependency "phony", ">= 0.14"
+  spec.add_dependency "sinatra", "~> 2.0"
+
+  spec.add_development_dependency "bundler", ">= 1.17"
+  spec.add_development_dependency "rake", ">= 10.0"
+  spec.add_development_dependency "rspec", ">= 3.0"
+
+  spec.add_development_dependency "rack-test", "~> 1.1.0"
+  spec.add_development_dependency "twilio-ruby", ">= 5.18.0"
+  spec.add_development_dependency "nexmo", ">= 5.5.0"
+  spec.add_development_dependency "ruby-bandwidth", ">= 1.0.20"
+  spec.add_development_dependency "plivo", ">= 4.1.6"
+end

data/bin/console

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

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/config.ru

@@ -0,0 +1,2 @@
+require 'babysms/web_application'
+run BabySMS::WebApplication.new

data/lib/babysms.rb

@@ -0,0 +1,52 @@
+require 'babysms/version'
+require 'babysms/adapter'
+require 'babysms/receipt'
+require 'babysms/errors'
+require 'babysms/mail_man'
+require 'babysms/message'
+
+require 'babysms/adapters/test_adapter'
+require 'babysms/adapters/bandwidth_adapter' if Object.const_defined?(:Bandwidth)
+require 'babysms/adapters/nexmo_adapter' if Object.const_defined?(:Nexmo)
+require 'babysms/adapters/plivo_adapter' if Object.const_defined?(:Plivo)
+require 'babysms/adapters/twilio_adapter' if Object.const_defined?(:Twilio)
+require 'babysms/adapters/signalwire_adapter' if Object.const_defined?(:Signalwire)
+
+require 'active_support/core_ext/module/attribute_accessors'
+require 'phony'
+
+module BabySMS
+  mattr_accessor :web_hook_root, default: "http://example.com/web_hooks/"
+  mattr_accessor :strategy, default: :in_order
+  mattr_accessor :adapters, default: [BabySMS::Adapters::TestAdapter.new(verbose: true)]
+
+  # Shorthand to set a list of one adapter in the simple case
+  def self.adapter=(adapter)
+    self.adapters = [adapter]
+  end
+
+  def self.adapter
+    fail "can't use #adapters= with multiple adapters" unless adapters.size == 1
+    adapters.first
+  end
+
+  def self.available_adapters(test: false, cache: true)
+    # Allow cache-busting
+    @found_adapters = nil if !cache
+
+    @found_adapters ||= begin
+      BabySMS::Adapters.constants.map do |constant|
+        cls = BabySMS::Adapters.const_get(constant)
+        if cls.is_a?(Class) && cls.ancestors.include?(BabySMS::Adapter)
+          cls
+        end
+      end.compact
+    end
+
+    if test
+      @found_adapters
+    else
+      @found_adapters - [BabySMS::Adapters::TestAdapter]
+    end
+  end
+end

data/lib/babysms/adapter.rb

@@ -0,0 +1,60 @@
+module BabySMS
+  class Adapter
+    attr_reader :from
+    attr_reader :client
+
+    def initialize(from:)
+      @from = Phony.normalize(from)
+    end
+
+    # Locates an adapter instance associated with a phone number
+    def self.for_number(number, pool: BabySMS.adapters)
+      number = Phony.normalize(number)
+      pool.find { |adapter| adapter.from == number }
+    end
+
+    def self.for_adapter_id(adapter_id, pool: BabySMS.adapters)
+      pool.find { |adapter| adapter.adapter_id == adapter_id }
+    end
+
+    def self.adapter_name
+      bare_name = name.split('::').last
+      bare_name.gsub(/Adapter\z/, '').downcase
+    end
+
+    # e.g., "twilio"
+    def adapter_name
+      self.class.adapter_name
+    end
+
+    # e.g., "15555555555@twilio"
+    def adapter_id
+      "#{from}@#{adapter_name}"
+    end
+
+    # if the adapter supports web hooks, it'll have a nested class
+    # called "WebHook".  This returns the class
+    def web_hook_class
+      self.class.const_get(:WebHook)
+    end
+
+    def web_hook?
+      !!web_hook_class
+    end
+
+    # Returns an instance of the web hook handler, if it exists
+    def web_hook
+      unless instance_variable_defined?(:@web_hook)
+        @web_hook = if (cls = web_hook_class)
+          cls.new(self)
+        end
+      end
+
+      @web_hook
+    end
+
+    protected
+
+    attr_writer :client
+  end
+end