twilito 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3cfb75e4c673aacee3f2e2d4d76bc4106c0129820825918b12f6ccd0c440a2bb
-  data.tar.gz: de0d9a0d43911c1db4cd3406aab39a4beb89f6f17d75e02b4dd0c13863c5bd8e
+  metadata.gz: ac55859f2c24ea8da46a22d84d2b34473c586280bd4f2541d70fdbe5de044229
+  data.tar.gz: 9301076c59a7372e51870b2b65c33fe793e3163333f6925e67646d8dd1f0c497
 SHA512:
-  metadata.gz: 37fdc8154d808290a9b85c6d55a5a93905882d558203ebdd587148d6a2b9f4661cc5455287a86a3d0739792aee9cabbe58b58eefe150980e13bebcdcb2646479
-  data.tar.gz: 607ad6172943a0ddc9d8bdfd9ed51b78e9d3f1f005bb34a6003967b1c6b089013eec8974d48cebd4b699ca7a3ccc6a621fcdb696908d201c6322de5314376fc4
+  metadata.gz: d8528c27bcf15dffa8a1e844fd80cd5e648102ca6c7e20afb3af00edbbe7193ba23ff86f367771f901f4e92198ba1304afa730f757cb27964178b68cb3dd524b
+  data.tar.gz: 9edd9bc5e5c52a872db0a4e45e0eba6b04a5fba0de98ef615ca2c1a5c8dbb5abf01f772cb6760a7c3e363cbfa98a6e9129a13f67a366bad746a0f57e7f09135c

data/Gemfile.lock

@@ -6,13 +6,13 @@ PATH
 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)
@@ -21,7 +21,7 @@ GEM
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    public_suffix (3.0.3)
+    public_suffix (4.0.6)
     rainbow (3.0.0)
     rake (13.0.1)
     regexp_parser (1.7.1)
@@ -38,12 +38,11 @@ GEM
     rubocop-ast (0.0.3)
       parser (>= 2.7.0.1)
     ruby-progressbar (1.10.1)
-    safe_yaml (1.0.5)
     unicode-display_width (1.7.0)
-    webmock (3.5.1)
+    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
@@ -56,11 +55,11 @@ DEPENDENCIES
   rake (~> 13.0)
   rubocop
   twilito!
-  webmock (~> 3)
+  webmock (~> 3.12)
   yard (~> 0.9)
 
 RUBY VERSION
    ruby 2.7.2p137
 
 BUNDLED WITH
-   2.2.14
+   2.2.15

data/README.md

@@ -1,6 +1,6 @@
 # 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)
 
@@ -16,7 +16,7 @@ If you use more of Twilio, consider [twilio-ruby](https://github.com/twilio/twil
 
 ## Usage
 
-Twilito should work on Ruby 2.4 and up.
+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
 
@@ -27,11 +27,11 @@ gem 'twilito'
 #### Simplest case
 
 ```ruby
-# All of these arguments 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: '...'
 )
@@ -63,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:
@@ -83,34 +85,21 @@ 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
 
-#### Sending MMS
+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
-# Use the optional media_url argument, which is sent
-# to Twilio as MediaUrl
+# 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',
-  content: 'This is my content',
-  media_url: 'https://example.com/image.png',
+  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
 )
-
-```
-
-#### Set the optional `callback_url` argument if you want to receive HTTP callbacks from Twilio
-
-```ruby
-# Use the optional media_url argument, which is sent
-# to Twilio as MediaUrl
-
-result = Twilito.send_sms(
-  to: '+15555555555',
-  content: 'This is my content',
-  status_callback: 'https://your.app.io/sms/callback',
-)
-
 ```
 
 ## Testing your code

data/lib/twilito/api.rb

@@ -9,7 +9,7 @@ module Twilito
         req = Net::HTTP::Post.new(uri)
         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,14 +31,13 @@ module Twilito
 
     private
 
-    def twilio_params(args)
-      {
-        'To' => args[:to],
-        'From' => args[:from],
-        'Body' => args[:body],
-        'MediaUrl' => args[:media_url],
-        'StatusCallback' => args[:status_callback]
-      }.compact
+    # 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

data/lib/twilito/version.rb

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

data/twilito.gemspec

@@ -27,6 +27,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rubocop"
-  spec.add_development_dependency "webmock", "~> 3"
+  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.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Alex Ford
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-12 00:00:00.000000000 Z
+date: 2021-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,14 +86,14 @@ dependencies:
     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'
+        version: '3.12'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -152,7 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.0.3
 signing_key:
 specification_version: 4
 summary: A tiny, zero dependency, and easy to test helper for sending text messages