minitext 0.0.8 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6d9ee21ef99e7572d589fc06afe01bcb5904e773
-  data.tar.gz: 1bf7b3508161f22aa42108b4d62ea0294ddaef0f
+SHA256:
+  metadata.gz: e868a41b4b38fb23b71eb4fc8e3782023226825d83dd6c8730ec0c942225c02e
+  data.tar.gz: f2acf62b5831c96b0b95874a691bdb8128e36395a4f05fbf32213b3e82c6e74f
 SHA512:
-  metadata.gz: cc399bb12bd33709a425c99a78933e72216fc72e113206db9d74599a0ab4a6047f823087ca2b189639f887e392e8a3268a06a6b9372f3d8cb68b564f720440ee
-  data.tar.gz: eeca1488b6066a01ffadf5d337aad3152d80d0bb9a0ec4a3843c605598f85d250c5eaa909d3946581ee163a36706e609eb05f8062a6db7d45b8bd74994398c4b
+  metadata.gz: f60cd3a92a7a099e536976615b4d54f8e657aadfb9f881decda07ebb4e85d954c3a8a5a4a059ea4f76ff4b2551bf2a77c7235c316e6855042fb6694c841835a5
+  data.tar.gz: ec09e291c700f63f8831d1de157701ecff4f53c3cf5715555b205754e080d1b508013bca0ec510074d579adffba5ba78445a84d1828d8ba720732c1f8482ba6c

data/.ruby-version

@@ -0,0 +1 @@
+3.2.2

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [1.0.0] - 2023-06-19
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Kyle Rippey
+
+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,117 @@
+# minitext
+
+A simple SMS framework for sending messages via Twilio.
+
+
+## Installation
+
+In your Gemfile add:
+```ruby
+gem "minitext"
+```
+
+Install your gems:
+```bash
+bundle install
+```
+
+
+## Usage
+
+First set up a gateway:
+```ruby
+Minitext.configure do |config|
+  config.gateway = Minitext::TwilioGateway.new(account_sid: 'your_twilio_account_sid', auth_token: 'your_twilio_auth_token')
+end
+```
+
+Then send some texts:
+```ruby
+Minitext.text(from: '1234567890', to: '9876543210', body: 'Hello world').deliver
+```
+
+You can send using a Twilio Messaging Service instead of a from number by specifying it's SID:
+```ruby
+Minitext.text(messaging_service_sid: 'your-messaging-service-sid', to: '9876543210', body: 'Hello world').deliver
+```
+
+You can send mms texts with a media_url:
+```ruby
+Minitext.text(from: '1234567890', to: '9876543210', body: 'Hello world', media_url: 'http://placekitten.com/200/300').deliver
+```
+
+### Allowlist proxy
+
+If you want to restrict the numbers that you can send texts to, use the `AllowlistProxy` wrapper.
+
+Set up your allowlist proxy:
+```ruby
+Minitext.configure do |config|
+  allowlist = ['9876543210']
+  twilio_gateway = Minitext::TwilioGateway.new(account_sid: 'your_twilio_account_sid', auth_token: 'your_twilio_auth_token')
+
+  config.gateway = Minitext::AllowlistProxy.new(allowed: allowlist, gateway: twilio_gateway)
+end
+```
+
+Then send some texts:
+```ruby
+Minitext.text(from: '1234567890', to: '9876543210', body: 'This text should succeed.').deliver
+
+Minitext.text(from: '1234567890', to: '5559991111', body: 'This text should fail.').deliver
+```
+
+
+## Rails configuration
+
+Here are some examples of how you might configure Minitext in different Rails environments.
+
+### Production
+```ruby
+Minitext.configure do |config|
+  config.gateway = Minitext::TwilioGateway.new(account_sid: '123', auth_token: 'abc')
+
+  # You can set a default `from` number for all messages if you don't want to specify it everywhere you call Minitext.text
+  # config.message_defaults = { from: '5551234567' }
+
+  # Or, you can specify a messaging_service_sid instead:
+  # config.message_defaults = { messaging_service_sid: 'your_default_messaging_service_sid' }
+end
+```
+
+### Test
+```ruby
+Minitext.configure do |config|
+  config.gateway = Minitext::TestGateway.new
+end
+```
+
+### Development
+```ruby
+Minitext.configure do |config|
+  # You could allow devs to send messages to themselves in development mode if they start the server with an
+  # environment variable, like so: `SEND_LIVE_SMS_TO=5551234567 rails s`
+
+  allowlist = Array(ENV.fetch("SEND_LIVE_SMS_TO", nil)).compact
+  twilio_gateway = Minitext::TwilioGateway.new(account_sid: '123', auth_token: 'abc')
+
+  config.gateway = Minitext::AllowlistProxy.new(allowed: allowlist, gateway: twilio_gateway)
+end
+```
+
+
+## Testing
+
+If you do not specify a gateway via configuration, Minitext uses a `TestGateway` object by default.
+
+Example test:
+```ruby
+Minitext.text(from: '1234567890', to: '9876543210', body: 'This text should succeed.').deliver
+
+assert_equal 1, Minitext.gateway.deliveries.length
+```
+
+Don't forget to cleanup after yourself in your teardown methods:
+```ruby
+Minitext.gateway.deliveries.clear
+```

data/Rakefile

@@ -1,18 +1,18 @@
+# frozen_string_literal: true
 begin
-  require 'bundler/setup'
+  require "bundler/setup"
 rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
 end
 
-Bundler::GemHelper.install_tasks
+require "bundler/gem_tasks"
+require "minitest/test_task"
 
-require 'rake/testtask'
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
+Minitest::TestTask.create(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.warning = false
+  t.test_globs = ["test/**/*_test.rb"]
 end
 
 task default: :test

data/lib/minitext/allowlist_proxy.rb

@@ -0,0 +1,30 @@
+require "set"
+
+module Minitext
+  class AllowlistProxy
+    attr_reader :allowed, :gateway
+
+    def initialize(allowed:, gateway: nil)
+      @allowed = Set.new(allowed)
+      @gateway = gateway || TestGateway.new
+    end
+
+    def deliver(message)
+      gateway.deliver(message) if allowed?(message.to)
+    end
+
+    def method_missing(method, *args, &block)
+      gateway.send(method, *args, &block)
+    end
+
+    def respond_to_missing?(method, *args)
+      gateway.respond_to?(method)
+    end
+
+    protected
+
+    def allowed?(to)
+      allowed.include?(to)
+    end
+  end
+end

data/lib/minitext/configuration.rb

@@ -0,0 +1,15 @@
+module Minitext
+  class Configuration
+    attr_accessor :gateway, :message_defaults
+
+    def initialize
+      @gateway = TestGateway.new
+      @message_defaults = {}
+    end
+
+    def reset!
+      @gateway = TestGateway.new
+      @message_defaults = {}
+    end
+  end
+end

data/lib/minitext/message.rb

@@ -1,51 +1,21 @@
 module Minitext
   class Message
-    attr_accessor :from, :to, :body, :gateway, :media_url
+    attr_accessor :from, :messaging_service_sid, :to, :body, :gateway, :media_url
 
-    def initialize(params)
-      params.each do |attr, value|
-        self.public_send("#{attr}=", value)
+    def initialize(to:, body:, gateway:, from: nil, messaging_service_sid: nil, media_url: nil)
+      if from.nil? && messaging_service_sid.nil?
+        raise ArgumentError.new("must supply either the 'from' or 'messaging_service_sid' argument")
       end
-    end
 
-    def deliver!
-      deliver || raise_errors
+      @gateway = gateway
+      @messaging_service_sid = messaging_service_sid
+      @from = from
+      @to = to
+      @body = body
     end
 
     def deliver
-      return false unless valid?
-      !!gateway.deliver(self)
-    end
-
-    def valid?
-      valid_param?(from) && valid_param?(to) && valid_param?(body) && valid_optional_param?(media_url) && !gateway.nil?
-    end
-
-    protected
-
-    def valid_optional_param?(param)
-      param.nil? || valid_param?(param)
-    end
-
-    def valid_param?(param)
-      !(param.nil? || param.empty?)
-    end
-
-    def raise_errors
-      case
-      when !valid_param?(from)
-        raise_missing_parameter('from')
-      when !valid_param?(to)
-        raise_missing_parameter('to')
-      when !valid_param?(body)
-        raise_missing_parameter('body')
-      end
-    end
-
-    protected
-
-    def raise_missing_parameter(param)
-      raise Minitext::MissingParameter.new("#{param} parameter cannot be nil or empty")
+      gateway.deliver(self)
     end
   end
 end

data/lib/minitext/test_gateway.rb

@@ -10,4 +10,4 @@ module Minitext
       @deliveries << message
     end
   end
-end
+end

data/lib/minitext/twilio_gateway.rb

@@ -2,30 +2,29 @@ require 'twilio-ruby'
 
 module Minitext
   class TwilioGateway
-    attr_reader :client
+    attr_reader :account_sid, :auth_token
 
-    def initialize(config={})
-      sid = config[:sid]
-      token = config[:token]
-      subaccount = config[:subaccount]
-      @client = Twilio::REST::Client.new(sid, token)
-      @client = client.accounts.get(subaccount) if subaccount
+    def initialize(account_sid:, auth_token:)
+      @account_sid = account_sid
+      @auth_token = auth_token
     end
 
     def deliver(message)
       params = {
+        messaging_service_sid: message.messaging_service_sid,
         from: message.from,
         to: message.to,
         body: message.body.strip,
-      }
+        media_url: message.media_url,
+      }.compact
 
-      unless message.media_url.nil?
-        params = params.merge(media_url: message.media_url)
-      end
+      client.messages.create(**params)
+    end
+
+    private
 
-      client.messages.create(
-        params
-      )
+    def client
+      @client ||= Twilio::REST::Client.new(account_sid, auth_token)
     end
   end
 end

data/lib/minitext/version.rb

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

data/lib/minitext.rb

@@ -1,32 +1,29 @@
-module Minitext
-  autoload :Message, 'minitext/message'
-  autoload :MissingParameter, 'minitext/missing_parameter'
-  autoload :TestGateway, 'minitext/test_gateway'
-  autoload :TwilioGateway, 'minitext/twilio_gateway'
-  autoload :WhitelistProxy, 'minitext/whitelist_proxy'
+# frozen_string_literal: true
 
-  def self.gateway
-    @gateway ||= TestGateway.new
-  end
+require_relative "minitext/allowlist_proxy"
+require_relative "minitext/configuration"
+require_relative "minitext/message"
+require_relative "minitext/test_gateway"
+require_relative "minitext/twilio_gateway"
+require_relative "minitext/version"
 
-  def self.gateway=(gateway)
-    @gateway = gateway
+module Minitext
+  class Error < StandardError; end
+
+  def self.configuration
+    @configuration ||= Configuration.new
   end
 
-  def self.defaults
-    @defaults ||= {}
-    {gateway: gateway}.merge(@defaults)
+  def self.configure(&block)
+    yield(configuration)
   end
 
-  def self.defaults=(defaults)
-    @defaults = defaults
+  def self.gateway
+    configuration.gateway
   end
 
-  def self.text(params)
-    Message.new(defaults.merge(params))
+  def self.text(**kwargs)
+    Message.new(**configuration.message_defaults.merge(gateway: configuration.gateway).merge(kwargs))
   end
 end
 
-if defined?(Rails)
-  require 'minitext/railtie'
-end

data/minitext.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "lib/minitext/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "minitext"
+  spec.version = Minitext::VERSION
+  spec.authors = ["Kyle Rippey"]
+  spec.email = ["kylerippey@gmail.com"]
+
+  spec.summary = ""
+  spec.description = "A lightweight SMS framework for sending messages via the Twilio API"
+  spec.homepage = "http://github.com/kylerippey/minitext"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "http://github.com/kylerippey/minitext"
+
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.test_files = Dir.glob('test/*_test.rb')
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "twilio-ruby", "~> 6.1"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/sig/minitext.rbs

@@ -0,0 +1,4 @@
+module Minitext
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -1,48 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: minitext
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 1.0.0
 platform: ruby
 authors:
 - Kyle Rippey
-autorequire: 
-bindir: bin
+autorequire:
+bindir: exe
 cert_chain: []
-date: 2017-04-03 00:00:00.000000000 Z
+date: 2023-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: twilio-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.11.0
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.11.0
-description: A lightweight SMS framework
-email: kylerippey@gmail.com
+        version: '6.1'
+description: A lightweight SMS framework for sending messages via the Twilio API
+email:
+- kylerippey@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".ruby-version"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
 - Rakefile
 - lib/minitext.rb
+- lib/minitext/allowlist_proxy.rb
+- lib/minitext/configuration.rb
 - lib/minitext/message.rb
-- lib/minitext/missing_parameter.rb
-- lib/minitext/railtie.rb
 - lib/minitext/test_gateway.rb
 - lib/minitext/twilio_gateway.rb
-- lib/minitext/whitelist_proxy.rb
+- lib/minitext/version.rb
+- minitext.gemspec
+- sig/minitext.rbs
 homepage: http://github.com/kylerippey/minitext
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  homepage_uri: http://github.com/kylerippey/minitext
+  source_code_uri: http://github.com/kylerippey/minitext
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -50,16 +59,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: ''
 test_files: []

data/lib/minitext/missing_parameter.rb

@@ -1,3 +0,0 @@
-module Minitext
-  class MissingParameter < StandardError; end
-end

data/lib/minitext/railtie.rb

@@ -1,25 +0,0 @@
-require 'minitext'
-require 'rails'
-
-module Minitext
-  class Railtie < Rails::Railtie
-    config.minitext = ActiveSupport::OrderedOptions.new
-
-    initializer "minitext.configure" do |app|
-      Minitext.gateway = app.config.minitext.gateway
-    end
-  end
-end
-
-# Usage:
-# development
-# config.minitext.gateway = Minitext::TestGateway.new
-
-# production
-# config.minitext.gateway = Minitext::TwilioGateway.new(sid: '123', token: 'abc')
-
-# staging
-# whitelist = YAML.load_file('twilio_whitelist')
-# gateway = Minitext::TwilioGateway.new(sid: '123', token: 'abc')
-# config.minitext.gateway = Minitext::WhitelistProxy.new(whitelist: whitelist, gateway: gateway)
-

data/lib/minitext/whitelist_proxy.rb

@@ -1,24 +0,0 @@
-module Minitext
-  class WhitelistProxy
-    attr_reader :whitelist, :gateway
-    
-    def initialize(params)
-      @whitelist = Array(params.fetch(:whitelist) {Hash.new})
-      @gateway = params.fetch(:gateway) {TestGateway.new}
-    end
-
-    def deliver(message)
-      gateway.deliver(message) if whitelisted?(message.to)
-    end
-
-    def method_missing(method, *args, &block)
-      gateway.send(method, *args, &block)
-    end
-
-    protected
-
-    def whitelisted?(recipient)
-      whitelist.include?(recipient)
-    end
-  end
-end