twilito 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 319e2e7600c3634e97209ebeec8cde162d5dbae23d4f42854d9dd744babe6f05
-  data.tar.gz: 730b25f694951541de4a93a22f658e2dc9c3ea29d1604ad16a1a9a0602887a75
+  metadata.gz: ac55859f2c24ea8da46a22d84d2b34473c586280bd4f2541d70fdbe5de044229
+  data.tar.gz: 9301076c59a7372e51870b2b65c33fe793e3163333f6925e67646d8dd1f0c497
 SHA512:
-  metadata.gz: 784f7d0f2e7b19510da416817bcd807af73b05d3cb894233316d449490f74c5d5a6a6302a4f03294cd6a80cf8d17f22088003c629ae2c898d2a8426c9925ac48
-  data.tar.gz: a2e9efd049e3cedf04a3a83ac9ce0d6337b88a3bbb861858ff10b432445bf240b4de0b037fbd9c426d93dcd61fb6d22f46b9989877fea06600a4bbd181e52346
+  metadata.gz: d8528c27bcf15dffa8a1e844fd80cd5e648102ca6c7e20afb3af00edbbe7193ba23ff86f367771f901f4e92198ba1304afa730f757cb27964178b68cb3dd524b
+  data.tar.gz: 9edd9bc5e5c52a872db0a4e45e0eba6b04a5fba0de98ef615ca2c1a5c8dbb5abf01f772cb6760a7c3e363cbfa98a6e9129a13f67a366bad746a0f57e7f09135c

data/.github/workflows/main.yml

@@ -0,0 +1,20 @@
+name: CI
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ["2.4", "2.5", "2.6", "2.7", "3.0"]
+    name: Run Tests (Ruby ${{ matrix.ruby }})
+    steps:
+      - uses: actions/checkout@master
+      - name: Setup ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Run tests
+        run: bundle exec rake

data/.gitignore

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

data/Gemfile.lock

@@ -1,29 +1,49 @@
 PATH
   remote: .
   specs:
-    twilito (0.2.0)
+    twilito (0.3.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.6.0)
-      public_suffix (>= 2.0.2, < 4.0)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.1)
     coderay (1.1.2)
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
-    hashdiff (0.3.8)
+    crack (0.4.5)
+      rexml
+    hashdiff (1.0.1)
     method_source (0.9.2)
     minitest (5.11.3)
+    parallel (1.19.2)
+    parser (2.7.1.3)
+      ast (~> 2.4.0)
     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)
+    public_suffix (4.0.6)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
+    rubocop (0.85.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.0.3)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.0.3)
+      parser (>= 2.7.0.1)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.7.0)
+    webmock (3.12.2)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
-      hashdiff
+      hashdiff (>= 0.4.0, < 2.0.0)
+    yard (0.9.25)
 
 PLATFORMS
   ruby
@@ -32,12 +52,14 @@ DEPENDENCIES
   bundler (~> 2.0)
   minitest (~> 5.11)
   pry
-  rake (~> 10.0)
+  rake (~> 13.0)
+  rubocop
   twilito!
-  webmock (~> 3)
+  webmock (~> 3.12)
+  yard (~> 0.9)
 
 RUBY VERSION
-   ruby 2.6.1p33
+   ruby 2.7.2p137
 
 BUNDLED WITH
-   2.0.2
+   2.2.15

data/README.md

@@ -1,12 +1,12 @@
 # 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. _Just enough_ of a wrapper to abstract away Twilio's REST API for sending messages, without _anything_ else.
 
-A tiny, zero dependency helper for sending text messages with Twilio. Just enough of a wrapper to abstract away Twilio's REST API for sending messages, without *anything* else.
+[![Gem Version](https://badge.fury.io/rb/twilito.svg)](https://badge.fury.io/rb/twilito) [![Actions Status](https://github.com/alexford/twilito/workflows/CI/badge.svg)](https://github.com/alexford/twilito/actions)
 
 ## Why
 
-Twilio's [full Ruby library](https://github.com/twilio/twilio-ruby) does a *lot*, and has a large memory footprint to go with it—too large for just sending a message. It's also more difficult to mock and verify in tests than I'd like.
+Twilio's [full Ruby library](https://github.com/twilio/twilio-ruby) does a _lot_, and has a large memory footprint to go with it—too large for just sending a message. It's also more difficult to mock and verify in tests than I'd like.
 
 Using [Twilio's REST API](https://www.twilio.com/docs/usage/api) directly is fine, but can be cumbersome.
 
@@ -16,6 +16,8 @@ If you use more of Twilio, consider [twilio-ruby](https://github.com/twilio/twil
 
 ## Usage
 
+Twilito should work on Ruby 2.4 and up. Unit tests [run in CI](https://github.com/alexford/twilito/actions) on 2.4, 2.5, 2.6, 2.7, and 3.0.
+
 #### Install the gem
 
 ```
@@ -25,16 +27,17 @@ gem 'twilito'
 #### Simplest case
 
 ```ruby
-# All options are required (but can be defaulted, see below)
+# All of these arguments are required, but can be configured as defaults (see below)
 result = Twilito.send_sms(
   to: '+15555555555',
   from: '+15554444444',
-  content: 'This is my content'
+  body: 'This is my content',
   account_sid: '...', # Twilio Credentials
   auth_token: '...'
 )
 
-# Returns Twilito::Result struct
+
+# Returns instance of Twilito::Result
 
 result.success? # => boolean
 result.errors # => [] or error messages
@@ -60,7 +63,9 @@ rescue Twilito::SendError => e
 end
 ```
 
-#### Every argument can be defaulted
+### Configuring Defaults For Required Arguments
+
+The five required arguments (`to`, `from`, `body`, `account_sid`, and `auth_token`) can be configured as defaults with `Twilito.configure`.
 
 ```ruby
 # In an initializer or something like that:
@@ -80,7 +85,22 @@ end
 Twilito.send_sms!(to: '+15555555555', body: 'Foo')
 ```
 
-**Everything can be defaulted, including the message body, so that a bare `Twilio.send_sms!` can work in your code**
+### Using Other, Optional (Arbitrary) Arguments
+
+There are a number of optional parameters defined by Twilio for sending a message (see [the API documentation](https://www.twilio.com/docs/sms/api/message-resource#create-a-message-resource)). Any of these can be sent with Twilito using the "Ruby-style" snake cased equivalent of the parameter.
+
+```ruby
+# Twilito sends arbitrary arguments to Twilio's API after CamelCasing keys to match Twilio's style.
+# NOTE: This example assumes auth_token, account_sid, and from have already been configured.
+
+result = Twilito.send_sms(
+  to: '+15555555555',
+  body: 'This is my content',
+  media_url: 'https://example.com/image.png', # MediaUrl
+  status_callback: 'https://your.app.io/sms/callback', # StatusCallback
+  smart_encoded: true # SmartEncoded
+)
+```
 
 ## Testing your code
 
@@ -88,4 +108,23 @@ _TODO: Add examples of mocking and/or test helpers for asserting your code sends
 
 ## Contributing
 
-_TODO_
+### Contribute Feedback, Ideas, and Bug Reports
+
+- Create or comment on an issue
+
+### Contribute Code
+
+- Find an open issue or create one
+- Fork this repo and open a PR
+- Write unit tests for your change
+
+### Contribute Docs
+
+- Open a PR to make the README better, or help with contribution guidelines, etc.
+- There is currently an open issue for adding RDoc/YARD documentation
+
+### Contribute Beer
+
+Did Twilito save you some RAM?
+
+<a href="https://www.buymeacoffee.com/alexford" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/lato-white.png" alt="Buy Me A Beer" height="51" width="217" style="height: 51px !important;width: 217px !important;" ></a>

data/Rakefile

@@ -2,6 +2,7 @@
 
 require "bundler/gem_tasks"
 require "rake/testtask"
+require 'yard'
 
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
@@ -10,3 +11,8 @@ Rake::TestTask.new(:test) do |t|
 end
 
 task default: :test
+
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/**/*.rb'] # optional
+  t.options = ['-odocs'] # optional
+end

data/lib/twilito.rb

@@ -13,7 +13,7 @@ module Twilito
     include API
 
     def send_sms(**args)
-      response = send_sms!(args)
+      response = send_sms!(**args)
       Result.success(
         response: response,
         sid: JSON.parse(response.read_body)['sid']
@@ -28,21 +28,17 @@ module Twilito
       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
+        raise SendError.new('Error from Twilio API', response) unless response.is_a? Net::HTTPSuccess
       end
     end
 
     private
 
-    def merge_configuration(**args)
+    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
+        raise ArgumentError, "Missing argument(s): #{missing_keys.join(', ')}" if missing_keys.any?
       end
     end
   end

data/lib/twilito/api.rb

@@ -7,9 +7,9 @@ module Twilito
 
       Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
         req = Net::HTTP::Post.new(uri)
-        req.initialize_http_header({ 'User-Agent' => "Ruby Twilito/#{Twilito::VERSION}" })
+        req.initialize_http_header('User-Agent' => user_agent)
         req.basic_auth(args[:account_sid], args[:auth_token])
-        req.set_form_data(twilio_params(args))
+        req.set_form_data(twilio_form_data(args))
 
         http.request(req)
       end
@@ -31,12 +31,17 @@ module Twilito
 
     private
 
-    def twilio_params(args)
-      {
-        'To' => args[:to],
-        'From' => args[:from],
-        'Body' => args[:body]
-      }
+    # NOTE: Converts snake_cased hash of arguments to CamelCase to match Twilio
+    # API expectations. Also, removes auth_token and account_sid as those are
+    # included separately in .send_response as basic auth instead of POST body
+    def twilio_form_data(args)
+      args
+        .merge(auth_token: nil, account_sid: nil).compact
+        .reduce({}) { |result, (k, v)| result.merge(k.to_s.split('_').collect(&:capitalize).join => v) }
+    end
+
+    def user_agent
+      "Ruby Twilito/#{Twilito::VERSION}"
     end
   end
 end

data/lib/twilito/result.rb

@@ -1,17 +1,22 @@
 # frozen_string_literal: true
 
 module Twilito
-  Result = Struct.new(:success, :errors, :sid, :response) do
+  class Result
+    attr_reader :success, :errors, :sid, :response
+
     def initialize(success:, errors: [], sid: nil, response: nil)
-      super(success, errors, sid, response)
+      @success = success
+      @errors = errors
+      @sid = sid
+      @response = response
     end
 
-    def self.success(**args)
-      new(success: true, **args)
+    def self.success(response:, sid:)
+      new(success: true, response: response, sid: sid)
     end
 
-    def self.failure(**args)
-      new(success: false, **args)
+    def self.failure(response:, errors:)
+      new(success: false, response: response, errors: errors)
     end
 
     def data
@@ -19,15 +24,15 @@ module Twilito
     end
 
     def success?
-      to_h[:success] || false
+      success || false
     end
 
     private
 
     def response_body
-      return nil unless to_h[:response]&.respond_to?(:read_body)
+      return nil unless response&.respond_to?(:read_body)
 
-      to_h[:response].read_body
+      response.read_body
     end
   end
 end

data/lib/twilito/version.rb

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

data/twilito.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.licenses      = ['MIT']
   spec.version       = Twilito::VERSION
   spec.authors       = ["Alex Ford"]
-  spec.email         = ["alexford87@me.com"]
+  spec.email         = ["alexford@hey.com"]
   spec.required_ruby_version = '>= 2.4.0'
 
   spec.summary       = "A tiny, zero dependency, and easy to test helper for sending text messages with Twilio"
@@ -25,6 +25,8 @@ Gem::Specification.new do |spec|
   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"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "webmock", "~> 3.12"
+  spec.add_development_dependency "yard", "~> 0.9"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twilito
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Alex Ford
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-11-30 00:00:00.000000000 Z
+date: 2021-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,35 +58,64 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
-description: 
+        version: '0.9'
+description:
 email:
-- alexford87@me.com
+- alexford@hey.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
@@ -108,7 +137,7 @@ homepage: https://github.com/alexford/twilito
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -124,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: A tiny, zero dependency, and easy to test helper for sending text messages
   with Twilio