textbelt 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7de6ab396ff78777875207b7315451beaf23f774
+  data.tar.gz: cfc7e29b6a77b7c9034625daf3e7743ddf21f0bf
+SHA512:
+  metadata.gz: b5b2750c761f31eab2b0a73b98f54aa474d9a44a83208ba8d3835aca44869190130808f20c07db8704b9b9de196095d887e510c5d72f2ab55a6e25ad3be6647b
+  data.tar.gz: b14840ec6d2a39932c7b10a1403148c27c30f6bc3ae00e3a7380c68ef821206daccf957f782c2414d2ab729c3cc69964b923142bd786ed057f1fe29d38f38030

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.swp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 2.3.0
+  - 2.2.3
+  - 2.2.1
+  - 2.1.1
+  - 1.9.3
+
+before_install: gem install bundler -v 1.11.0
+script: bundle exec rake test

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in textbelt.gemspec
+gemspec

data/README.md

@@ -0,0 +1,49 @@
+# Textbelt
+
+[![Build Status](https://travis-ci.org/djds23/textbelt-gem.svg?branch=master)](https://travis-ci.org/djds23/textbelt-gem)
+
+A ruby interface for sending texts free of charge through [TextBelt](http://textbelt.com/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'textbelt'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install textbelt
+
+## Usage
+
+```ruby
+TextBelt.text('01234567', 'Hello, World!') #=> Your favorite cell phone number gets a text message
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/djds23/textbelt-gem.
+
+## License
+
+The MIT License (MIT)
+
+Copyright (c) 2015 Dean Silfen
+
+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/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+task :test => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "textbelt"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/textbelt.rb

@@ -0,0 +1,61 @@
+# @author Dean Silfen
+module TextBelt
+  require 'textbelt/validators/response_validator'
+  require 'textbelt/validators/phone_validator'
+  require 'textbelt/version'
+  require 'textbelt/errors'
+  require 'net/http'
+  require 'json'
+  require 'uri'
+
+
+  # Get a list of categories from the service
+  #
+  # @param phone_number [String] number to send the text to
+  # @param message [String] the body of the text message
+  # @param country [String] ISO 3166 Country code for destination country
+  #
+  # @raise [Errors::IntegerPhoneError] phone number passed as an integer
+  # @raise [Errors::InvalidPhoneNumberError] phone number is not valid
+  # @raise [Errors::BlackListedNumberError] http server says number is blacklisted
+  # @raise [Errors::GatewayFailureError] http server had a gateway error communicating with carrier
+  # @raise [Errors::PhoneCouldNotValidateError] http server cannot validate the phone\'s quota
+  # @raise [Errors::IPCouldNotValidateError] http server cannot validate the ip's quota
+  # @raise [Errors::PhoneQuotaExceededError] the phone's quota has been exceeded
+  # @raise [Errors::IPQuotaExceededError] IP's quota has been exceeded
+  #
+  # @return [Boolean] true if TextBelt successfully passed on the message
+  #
+  def text(phone_number, message, country = 'US')
+    PhoneValidator.validate(phone_number, country)
+    url = url_for(country)
+    res = Net::HTTP.post_form(url, number: phone_number, message: message)
+    body = JSON.parse(res.body)
+    ResponseValidator.validate(phone_number, body)
+    body['success'.freeze]
+  end
+
+  # @private
+  def url_for(country)
+    url_string =
+      case country
+      when 'US'
+        base_url + 'text'
+      when 'CA'
+        base_url + 'canada'
+      else
+        base_url + 'intl'
+      end
+
+    URI(url_string)
+  end
+
+  # @private
+  def base_url
+    'http://textbelt.com/'
+  end
+
+  module_function :text
+  module_function :base_url
+  module_function :url_for
+end

data/lib/textbelt/errors.rb

@@ -0,0 +1,48 @@
+# File to hold all the errors for TextBelt
+#
+# @author Dean Silfen
+module TextBelt
+  module Errors
+
+    # Error to be raised if phone number is not passed as a string
+    #
+    # @author Dean Silfen
+    class IntegerPhoneError < StandardError; end
+
+    # Error to be raised if phone number is not valid in destination country
+    #
+    # @author Dean Silfen
+    class InvalidPhoneNumberError < StandardError; end
+
+    # Error raised if failure happens at the time of send from http service to carrier
+    #
+    # @author Dean Silfen
+    class GatewayFailureError < StandardError; end
+
+    # Error raised if number provided has been blacklisted
+    #
+    # @author Dean Silfen
+    class BlackListedNumberError < StandardError; end
+
+    # Error raised if phone number could not be validated in the http service
+    #
+    # @author Dean Silfen
+    class PhoneCouldNotValidateError < StandardError; end
+
+    # Error raised if phone number could not be validated in the http service
+    #
+    # @author Dean Silfen
+    class IPCouldNotValidateError < StandardError; end
+
+    # Error raised if service exceeded rate limit for phone number
+    #
+    # @author Dean Silfen
+    class PhoneQuotaExceededError < StandardError; end
+
+    # Error raised if service exceeded rate limit for IP
+    #
+    # @author Dean Silfen
+    class IPQuotaExceededError < StandardError; end
+  end
+end
+

data/lib/textbelt/validators/phone_validator.rb

@@ -0,0 +1,37 @@
+# File to hold all the errors for TextBelt
+#
+# @author Dean Silfen
+module TextBelt
+  require 'phonelib'
+
+  class PhoneValidator
+    class << self
+
+      # Get a list of categories from the service
+      #
+      # @param phone_number [String] number to send the text to
+      # @param country [String] ISO 3166 Country code for destination country 
+      #
+      # @return [Boolean] true if TextBelt successfully passed on the message,
+      #   false if not
+      def validate(phone_number, country)
+        unless  is_a_string?(phone_number)
+          raise TextBelt::Errors::IntegerPhoneError, "Please ensure to pass phone numbers as strings."
+        end
+
+        phone = Phonelib.parse phone_number
+
+        if phone.impossible?
+          raise TextBelt::Errors::InvalidPhoneNumberError, "#{phone_number} is not valid in destination country #{country}"
+        end
+      end
+
+      private
+
+      # @private
+      def is_a_string?(phone_number)
+        phone_number.is_a? String
+      end
+    end
+  end
+end

data/lib/textbelt/validators/response_validator.rb

@@ -0,0 +1,34 @@
+module TextBelt
+  class ResponseValidator
+    class << self
+      def validate(phone_number, body)
+        return true if body['message'].nil? && body['success']
+        message = body['message']
+        if message == 'Sorry, texts to this number are disabled.'
+          raise TextBelt::Errors::BlackListedNumberError, "#{phone_number} has been blacklisted"
+        end
+
+        if message == 'Communication with SMS gateway failed.'
+          raise TextBelt::Errors::GatewayFailureError, 'A gateway failure occured between the http service and the carrier'
+        end
+
+        if message == 'Could not validate phone# quota.'
+          raise TextBelt::Errors::PhoneCouldNotValidateError, "#{phone_number} could not be validated in http service"
+        end
+
+        if message == 'Could not validate IP quota.'
+          raise TextBelt::Errors::IPCouldNotValidateError, message
+        end
+
+        if message.include? 'Exceeded quota for this phone number.'
+          raise TextBelt::Errors::PhoneQuotaExceededError, message
+        end
+
+        if message.include? 'Exceeded quota for this IP address.'
+          raise TextBelt::Errors::IPQuotaExceededError, message
+        end
+      end
+    end
+  end
+end
+

data/lib/textbelt/version.rb

@@ -0,0 +1,4 @@
+module TextBelt
+  # @private
+  VERSION = "0.1.0"
+end

data/textbelt.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'textbelt/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "textbelt"
+  spec.version       = TextBelt::VERSION
+  spec.authors       = ["Dean Silfen"]
+  spec.email         = ["dean.silfen@gmail.com"]
+
+  spec.summary       = %q{A ruby interface for sending texts with http://textbelt.com/}
+  spec.description   = %q{A ruby interface for sending texts with http://textbelt.com/. Complete with configurable textbelt endpoint, in case you are hosting your own instance.}
+  spec.homepage      = "http://www.rubydoc.info/github/djds23/textbelt"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  #  else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  #  end
+  #  TODO: Add a server to push from, defend against this scenario
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'phonelib', '~> 0.5.4'
+
+  spec.add_development_dependency "webmock", ["~> 1.22.3"]
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "yard"
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: textbelt
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dean Silfen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: phonelib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.4
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.22.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.22.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: yard
+  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'
+description: A ruby interface for sending texts with http://textbelt.com/. Complete
+  with configurable textbelt endpoint, in case you are hosting your own instance.
+email:
+- dean.silfen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/textbelt.rb
+- lib/textbelt/errors.rb
+- lib/textbelt/validators/phone_validator.rb
+- lib/textbelt/validators/response_validator.rb
+- lib/textbelt/version.rb
+- textbelt.gemspec
+homepage: http://www.rubydoc.info/github/djds23/textbelt
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: A ruby interface for sending texts with http://textbelt.com/
+test_files: []
+has_rdoc: