twilito 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2dcd1b8e536bbbea68b629b9b8d61c767dd9fba389fbaa8c47ae1f9a3d32fc4c
-  data.tar.gz: 2b54a9064e4ac99c9b0609f1a48ab5147007fa0d988d5d7fc073476a2fdc2349
+  metadata.gz: b2f08b5829f031adf3297cd2affd3098a5ea36ab6b6f4afad2e6c7c3b252cc41
+  data.tar.gz: 3bdc3c6ad79ab22d5eaa8eddae4bde8843598b0769a54ff4318409bf0505c66b
 SHA512:
-  metadata.gz: 01a8a88dd16eb2cdc4c226bbd51a1d6f74f563d713616144eb74a372eb83650f19bc57a31c52239747bce0080bd2625c975cce20fa76821cf7e2374a13e70f6b
-  data.tar.gz: 60bceaf8bd2779ecf996e4de2b5ae6d5dfff56f489eda670911d5c2b9a184169dca0d5dc7a6502d32ead29feb2df5aba7d97771b0bc3149d6d8a600404b1c998
+  metadata.gz: 7a2da6ec5bd1cd861dc537868dcdec42e1820fd9813420b2b6ae70994f901dad1c032dd088334b89e2d8466d6905cd648770a6448b032e87c775e68ab1051268
+  data.tar.gz: 2a8286b6f3de32eb14c81608b0beba3502759c2ea1c25c6d6441d72b2f16674333937e3c6b6f300994ba52ac35b763d1da2ffb04b68ca54782d983f0dde5d6f1

data/.github/workflows/main.yml

@@ -15,7 +15,6 @@ jobs:
         uses: actions/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-          architecture: 'x64'
       - name: Run tests
         run: |
           gem install bundler

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,50 @@
 PATH
   remote: .
   specs:
-    twilito (0.3.0)
+    twilito (0.3.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
     addressable (2.6.0)
       public_suffix (>= 2.0.2, < 4.0)
+    ast (2.4.1)
     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)
+    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)
+    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)
     safe_yaml (1.0.5)
+    unicode-display_width (1.7.0)
     webmock (3.5.1)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff
+    yard (0.9.25)
 
 PLATFORMS
   ruby
@@ -33,8 +54,10 @@ DEPENDENCIES
   minitest (~> 5.11)
   pry
   rake (~> 13.0)
+  rubocop
   twilito!
   webmock (~> 3)
+  yard (~> 0.9)
 
 RUBY VERSION
    ruby 2.6.1p33

data/README.md

@@ -37,7 +37,7 @@ result = Twilito.send_sms(
 )
 
 
-# Returns Twilito::Result struct
+# Returns instance of Twilito::Result
 
 result.success? # => boolean
 result.errors # => [] or error messages
@@ -105,4 +105,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

@@ -28,9 +28,7 @@ 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
 
@@ -40,9 +38,7 @@ module Twilito
       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/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.3.0"
+  VERSION = "0.3.1"
 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"
@@ -26,5 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "minitest", "~> 5.11"
   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 "yard", "~> 0.9"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twilito
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Alex Ford
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-27 00:00:00.000000000 Z
+date: 2020-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         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
@@ -80,9 +94,23 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
-description: 
+- !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: '0.9'
+description:
 email:
-- alexford87@me.com
+- alexford@hey.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -109,7 +137,7 @@ homepage: https://github.com/alexford/twilito
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -125,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