twilito 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7761e9e3ab42c77312bdb7207896ece722ce001a9a1c099c4a79b702f72c2aba
-  data.tar.gz: e1e4830cf7ea75dd00f55ffb796bf034128490a2ecbc6e066d8195771e6bf133
+  metadata.gz: 319e2e7600c3634e97209ebeec8cde162d5dbae23d4f42854d9dd744babe6f05
+  data.tar.gz: 730b25f694951541de4a93a22f658e2dc9c3ea29d1604ad16a1a9a0602887a75
 SHA512:
-  metadata.gz: 12b4f5cf4934394c5e4e2f2ff3a9931c42ea6d33ebdd8faa0e7a53f27ee89a6a7a779b2cac9b122264cfbd7358556c974728e7550075db92449b1f873a6b2ba8
-  data.tar.gz: 7a4e56dfac70088de70c35bd34012573bb87c807461883062ec41a6149716676d2317f3fb849947b8a36b8bafe88251550f0f9d61d083c2840cc2a1ebe24efcc
+  metadata.gz: 784f7d0f2e7b19510da416817bcd807af73b05d3cb894233316d449490f74c5d5a6a6302a4f03294cd6a80cf8d17f22088003c629ae2c898d2a8426c9925ac48
+  data.tar.gz: a2e9efd049e3cedf04a3a83ac9ce0d6337b88a3bbb861858ff10b432445bf240b4de0b037fbd9c426d93dcd61fb6d22f46b9989877fea06600a4bbd181e52346

data/Gemfile

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-ruby '2.6.1'
+ruby '>= 2.4.0'
 
 source "https://rubygems.org"
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    twilito (0.1.0)
+    twilito (0.2.0)
 
 GEM
   remote: https://rubygems.org/
@@ -40,4 +40,4 @@ RUBY VERSION
    ruby 2.6.1p33
 
 BUNDLED WITH
-   2.0.1
+   2.0.2

data/README.md

@@ -2,15 +2,17 @@
 
 [![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
+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.
 
 ## 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.
+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 directly is fine, but can be cumbersome.
+Using [Twilio's REST API](https://www.twilio.com/docs/usage/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.
+You should consider using Twilito if the only thing you need to do is send text messages and you don't want to worry about making HTTP requests to Twilio yourself.
+
+If you use more of Twilio, consider [twilio-ruby](https://github.com/twilio/twilio-ruby) or interact with the REST API in another way.
 
 ## Usage
 
@@ -41,7 +43,7 @@ result.response # => Raw response (instance of Net::HTTPResponse)
 result.data # => Hash of response data (parsed from JSON)
 ```
 
-#### Use send! to raise on error instead
+#### Use send_sms! to raise on error instead
 
 ```ruby
 begin
@@ -78,27 +80,7 @@ end
 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!
-```
+**Everything can be defaulted, including the message body, so that a bare `Twilio.send_sms!` can work in your code**
 
 ## Testing your code
 

data/lib/twilito/api.rb

@@ -7,6 +7,7 @@ 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.basic_auth(args[:account_sid], args[:auth_token])
         req.set_form_data(twilio_params(args))
 

data/lib/twilito/result.rb

@@ -1,23 +1,27 @@
 # 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)
+  Result = Struct.new(:success, :errors, :sid, :response) do
+    def initialize(success:, errors: [], sid: nil, response: nil)
+      super(success, errors, sid, response)
     end
 
-    def self.failure(**args)
-      new(success?: false, **args)
+    def self.success(**args)
+      new(success: true, **args)
     end
 
-    def errors
-      to_h[:errors] || []
+    def self.failure(**args)
+      new(success: false, **args)
     end
 
     def data
       JSON.parse(response_body || '{}')
     end
 
+    def success?
+      to_h[:success] || false
+    end
+
     private
 
     def response_body

data/lib/twilito/version.rb

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

data/twilito.gemspec

@@ -10,6 +10,7 @@ Gem::Specification.new do |spec|
   spec.version       = Twilito::VERSION
   spec.authors       = ["Alex Ford"]
   spec.email         = ["alexford87@me.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"
   spec.homepage      = "https://github.com/alexford/twilito"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twilito
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Alex Ford
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-27 00:00:00.000000000 Z
+date: 2019-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -116,14 +116,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A tiny, zero dependency, and easy to test helper for sending text messages