twilito 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7761e9e3ab42c77312bdb7207896ece722ce001a9a1c099c4a79b702f72c2aba
+  data.tar.gz: e1e4830cf7ea75dd00f55ffb796bf034128490a2ecbc6e066d8195771e6bf133
+SHA512:
+  metadata.gz: 12b4f5cf4934394c5e4e2f2ff3a9931c42ea6d33ebdd8faa0e7a53f27ee89a6a7a779b2cac9b122264cfbd7358556c974728e7550075db92449b1f873a6b2ba8
+  data.tar.gz: 7a4e56dfac70088de70c35bd34012573bb87c807461883062ec41a6149716676d2317f3fb849947b8a36b8bafe88251550f0f9d61d083c2840cc2a1ebe24efcc

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/tmp/
+
+.ruby-version

data/.rubocop.yml

@@ -0,0 +1,18 @@
+AllCops:
+  Exclude:
+    - "bin/**/*"
+    - "twilito.gemspec"
+
+Metrics/BlockLength:
+  Exclude:
+    - "test/**/*"
+
+Style/StringLiterals:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+  IndentationWidth: 2
+
+Style/Documentation:
+  Enabled: false

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+ruby '2.6.1'
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in twilito.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    twilito (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    coderay (1.1.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    hashdiff (0.3.8)
+    method_source (0.9.2)
+    minitest (5.11.3)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    public_suffix (3.0.3)
+    rake (10.5.0)
+    safe_yaml (1.0.5)
+    webmock (3.5.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  minitest (~> 5.11)
+  pry
+  rake (~> 10.0)
+  twilito!
+  webmock (~> 3)
+
+RUBY VERSION
+   ruby 2.6.1p33
+
+BUNDLED WITH
+   2.0.1

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Alex Ford
+
+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,109 @@
+# Twilito
+
+[![Build Status](https://travis-ci.org/alexford/twilito.svg?branch=master)](https://travis-ci.org/alexford/twilito)
+
+A tiny, zero dependency helper for sending text messages with Twilio
+
+## Why
+
+Twilio's full on Ruby library does a lot, and has a large memory footprint—too large for just sending an SMS. It's also more difficult to mock and verify than I'd like for a simple task like sending an individual SMS.
+
+Using Twilio's REST API directly is fine, but can be cumbersome.
+
+Twilito is just enough of a wrapper to abstract away the REST API without loading the rest of the Twilio ecosystem.
+
+## Usage
+
+#### Install the gem
+
+```
+gem 'twilito'
+```
+
+#### Simplest case
+
+```ruby
+# All options are required (but can be defaulted, see below)
+result = Twilito.send_sms(
+  to: '+15555555555',
+  from: '+15554444444',
+  content: 'This is my content'
+  account_sid: '...', # Twilio Credentials
+  auth_token: '...'
+)
+
+# Returns Twilito::Result struct
+
+result.success? # => boolean
+result.errors # => [] or error messages
+result.sid #=> Twilio SID for Message (SM[...])
+result.response # => Raw response (instance of Net::HTTPResponse)
+result.data # => Hash of response data (parsed from JSON)
+```
+
+#### Use send! to raise on error instead
+
+```ruby
+begin
+  Twilito.send_sms!(
+    to: '+15555555555',
+    from: '+12333',
+    body: 'This is my content',
+    account_sid: '...',
+    auth_token: '...'
+  )
+rescue Twilito::SendError => e
+  e.message # => 'Error from Twilio API'
+  e.response # => Raw response (instance of Net::HTTPResponse)
+end
+```
+
+#### Every argument can be defaulted
+
+```ruby
+# In an initializer or something like that:
+
+Twilito.configure do |config|
+  # Store your secrets elsewhere
+  config.account_sid = ENV['TWILIO_ACCOUNT_SID']
+  config.auth_token = ENV['TWILIO_AUTH_TOKEN']
+
+  config.from = '+16145555555'
+end
+```
+
+```ruby
+# Later, in your code:
+
+Twilito.send_sms!(to: '+15555555555', body: 'Foo')
+```
+
+#### Really, everything
+
+```ruby
+# In an initializer or something like that:
+
+Twilito.configure do |config|
+  # Store your secrets elsewhere
+  config.account_sid = ENV['TWILIO_ACCOUNT_SID']
+  config.auth_token = ENV['TWILIO_AUTH_TOKEN']
+
+  config.from = '+16145555555'
+  config.to = '+15555555555'
+  config.body = 'A new user signed up'
+end
+```
+
+```ruby
+# Later, in your code:
+
+Twilito.send_sms!
+```
+
+## Testing your code
+
+_TODO: Add examples of mocking and/or test helpers for asserting your code sends an SMS_
+
+## Contributing
+
+_TODO_

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/bin/console

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

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/twilito/api.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Twilito
+  module API
+    def send_response(args)
+      uri = messages_uri(args[:account_sid])
+
+      Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
+        req = Net::HTTP::Post.new(uri)
+        req.basic_auth(args[:account_sid], args[:auth_token])
+        req.set_form_data(twilio_params(args))
+
+        http.request(req)
+      end
+    end
+
+    def messages_uri(account_sid)
+      components = [
+        Configuration::TWILIO_VERSION,
+        'Accounts',
+        account_sid,
+        'Messages.json'
+      ]
+
+      URI::HTTPS.build(
+        host: Configuration::TWILIO_HOST,
+        path: '/' + components.join('/')
+      )
+    end
+
+    private
+
+    def twilio_params(args)
+      {
+        'To' => args[:to],
+        'From' => args[:from],
+        'Body' => args[:body]
+      }
+    end
+  end
+end

data/lib/twilito/configuration.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Twilito
+  def self.configure
+    yield(configuration)
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset_configuration!
+    @configuration = Configuration.new
+  end
+
+  class Configuration
+    attr_accessor :account_sid, :auth_token, :from, :to, :body,
+                  :twilio_host, :twilio_version
+
+    TWILIO_HOST = 'api.twilio.com'
+    TWILIO_VERSION = '2010-04-01'
+
+    def to_h
+      {
+        to: to,
+        from: from,
+        body: body,
+        account_sid: account_sid,
+        auth_token: auth_token
+      }
+    end
+  end
+end

data/lib/twilito/result.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Twilito
+  Result = Struct.new(:success?, :errors, :sid, :response, keyword_init: true) do
+    def self.success(**args)
+      new(success?: true, **args)
+    end
+
+    def self.failure(**args)
+      new(success?: false, **args)
+    end
+
+    def errors
+      to_h[:errors] || []
+    end
+
+    def data
+      JSON.parse(response_body || '{}')
+    end
+
+    private
+
+    def response_body
+      return nil unless to_h[:response]&.respond_to?(:read_body)
+
+      to_h[:response].read_body
+    end
+  end
+end

data/lib/twilito/send_error.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Twilito
+  class SendError < StandardError
+    attr_reader :response
+
+    def initialize(message, response)
+      @response = response
+      super(message)
+    end
+  end
+end

data/lib/twilito/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Twilito
+  VERSION = "0.1.0"
+end

data/lib/twilito.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require "twilito/version"
+require "twilito/configuration"
+require "twilito/result"
+require "twilito/api"
+require "twilito/send_error"
+
+module Twilito
+  class ArgumentError < StandardError; end
+
+  class << self
+    include API
+
+    def send_sms(**args)
+      response = send_sms!(args)
+      Result.success(
+        response: response,
+        sid: JSON.parse(response.read_body)['sid']
+      )
+    rescue SendError => e
+      Result.failure(errors: [e.message], response: e.response)
+    rescue JSON::ParserError
+      Result.failure(errors: ['Unable to parse response'], response: response)
+    end
+
+    def send_sms!(**args)
+      args = merge_configuration(args)
+
+      send_response(args).tap do |response|
+        unless response.is_a? Net::HTTPSuccess
+          raise SendError.new('Error from Twilio API', response)
+        end
+      end
+    end
+
+    private
+
+    def merge_configuration(**args)
+      configuration.to_h.merge(args).tap do |merged|
+        missing_keys = merged.select { |_k, v| v.nil? }.keys
+
+        if missing_keys.any?
+          raise ArgumentError, "Missing argument(s): #{missing_keys.join(', ')}"
+        end
+      end
+    end
+  end
+end

data/twilito.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "twilito/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "twilito"
+  spec.licenses      = ['MIT']
+  spec.version       = Twilito::VERSION
+  spec.authors       = ["Alex Ford"]
+  spec.email         = ["alexford87@me.com"]
+
+  spec.summary       = "A tiny, zero dependency, and easy to test helper for sending text messages with Twilio"
+  spec.homepage      = "https://github.com/alexford/twilito"
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "minitest", "~> 5.11"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "webmock", "~> 3"
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: twilito
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alex Ford
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: 
+email:
+- alexford87@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/twilito.rb
+- lib/twilito/api.rb
+- lib/twilito/configuration.rb
+- lib/twilito/result.rb
+- lib/twilito/send_error.rb
+- lib/twilito/version.rb
+- twilito.gemspec
+homepage: https://github.com/alexford/twilito
+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: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: A tiny, zero dependency, and easy to test helper for sending text messages
+  with Twilio
+test_files: []