textbelt 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7de6ab396ff78777875207b7315451beaf23f774
-  data.tar.gz: cfc7e29b6a77b7c9034625daf3e7743ddf21f0bf
+  metadata.gz: 38297e46bd3eae49514cf2c8f7bccae3f255dbdf
+  data.tar.gz: 8d1b3ab5d96f98aa37a6592cc89456c4da139671
 SHA512:
-  metadata.gz: b5b2750c761f31eab2b0a73b98f54aa474d9a44a83208ba8d3835aca44869190130808f20c07db8704b9b9de196095d887e510c5d72f2ab55a6e25ad3be6647b
-  data.tar.gz: b14840ec6d2a39932c7b10a1403148c27c30f6bc3ae00e3a7380c68ef821206daccf957f782c2414d2ab729c3cc69964b923142bd786ed057f1fe29d38f38030
+  metadata.gz: 3a1db7d63484bb4c3861708901db6fe1cbdf8a4f3ab205e591a12445a09a73dbc56b892e3df2b57dbde4635185f8b31993579febea2a03957890f980eaf53b62
+  data.tar.gz: b28735b08948bc4be828a64777f55931f134bb9de12530619b0def08407082af7c126ef278db51ac10c48a0f2aa4aea29aa41dd836148e0fb95413d188f7b572

data/README.md

@@ -1,6 +1,7 @@
 # Textbelt
 
 [![Build Status](https://travis-ci.org/djds23/textbelt-gem.svg?branch=master)](https://travis-ci.org/djds23/textbelt-gem)
+[![Gem Version](https://badge.fury.io/rb/textbelt.svg)](https://rubygems.org/gems/textbelt)
 
 A ruby interface for sending texts free of charge through [TextBelt](http://textbelt.com/).
 
@@ -22,10 +23,27 @@ Or install it yourself as:
 
 ## Usage
 
+The main API is [`TextBelt.text`](http://www.rubydoc.info/github/djds23/textbelt-gem/master/TextBelt.text). Sending messages should be as simple as passing a number & message, then watching it go!
+
 ```ruby
 TextBelt.text('01234567', 'Hello, World!') #=> Your favorite cell phone number gets a text message
 ```
 
+If there are any errors that happen server side, we raise then as exceptions locally, see the documentation for `text` for a look at the different errors that might be raised.
+
+```ruby
+require 'textbelt'
+
+def send_cats(number)
+  TextBelt.text(number, 'https://www.youtube.com/watch?v=tntOCGkgt98')
+rescue TextBelt::Errors::PhoneQuotaExceededError => e
+  puts 'too many cats!!!!'
+rescue TextBelt::Errors::BlackListedNumberError => e
+  puts 'can not send any more cats to that number :('
+end
+```
+
+[See the full documentation here.](http://www.rubydoc.info/github/djds23/textbelt-gem/master)
 ## 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.

data/Rakefile

@@ -5,3 +5,4 @@ RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
 task :test => :spec
+

data/lib/textbelt.rb

@@ -2,6 +2,7 @@
 module TextBelt
   require 'textbelt/validators/response_validator'
   require 'textbelt/validators/phone_validator'
+  require 'textbelt/textutils'
   require 'textbelt/version'
   require 'textbelt/errors'
   require 'net/http'
@@ -28,34 +29,13 @@ module TextBelt
   #
   def text(phone_number, message, country = 'US')
     PhoneValidator.validate(phone_number, country)
-    url = url_for(country)
+    url = TextUtils.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/textutils.rb

@@ -0,0 +1,34 @@
+# @author Dean Silfen
+module TextBelt
+  class TextUtils
+    class << self
+
+      # Return the correct URL for the correct country code
+      #
+      # @param country [String] ISO 3166 Country code for destination country
+      #
+      # @return [URI] URI object holding the url to match the country code
+      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
+
+      # @private
+      def base_url
+        'http://textbelt.com/'
+      end
+    end
+  end
+end
+

data/lib/textbelt/validators/phone_validator.rb

@@ -1,9 +1,9 @@
-# File to hold all the errors for TextBelt
-#
-# @author Dean Silfen
 module TextBelt
   require 'phonelib'
 
+  # Validator for outgoing phone numbers
+  #
+  # @author Dean Silfen
   class PhoneValidator
     class << self
 
@@ -12,6 +12,9 @@ module TextBelt
       # @param phone_number [String] number to send the text to
       # @param country [String] ISO 3166 Country code for destination country 
       #
+      # @raise [Errors::IntegerPhoneError] error raised if phone number is passed as an integer
+      # @raise [Errors::InvalidPhoneNumberError] error raised if phone number is not valid
+      #
       # @return [Boolean] true if TextBelt successfully passed on the message,
       #   false if not
       def validate(phone_number, country)

data/lib/textbelt/validators/response_validator.rb

@@ -1,6 +1,25 @@
 module TextBelt
+
+  # Validator for incoming http responses
+  #
+  # @author Dean Silfen
   class ResponseValidator
     class << self
+
+      # Validate the response from http service
+      #
+      # @param phone_number [String] number to send the text to
+      # @param body [Hash] The body of the server's http response
+      #
+      # @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 body is valid
+      #
       def validate(phone_number, body)
         return true if body['message'].nil? && body['success']
         message = body['message']
@@ -27,6 +46,8 @@ module TextBelt
         if message.include? 'Exceeded quota for this IP address.'
           raise TextBelt::Errors::IPQuotaExceededError, message
         end
+
+        true
       end
     end
   end

data/lib/textbelt/version.rb

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

data/textbelt.gemspec

@@ -10,8 +10,8 @@ Gem::Specification.new do |spec|
   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"
+  spec.description   = %q{A ruby interface for sending texts with http://textbelt.com/}
+  spec.homepage      = "https://github.com/djds23/textbelt-gem"
 
   # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
   # delete this section to allow pushing this gem to any host.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: textbelt
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Dean Silfen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-12-31 00:00:00.000000000 Z
+date: 2016-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: phonelib
@@ -94,8 +94,7 @@ dependencies:
     - - ">="
       - !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.
+description: A ruby interface for sending texts with http://textbelt.com/
 email:
 - dean.silfen@gmail.com
 executables: []
@@ -112,11 +111,12 @@ files:
 - bin/setup
 - lib/textbelt.rb
 - lib/textbelt/errors.rb
+- lib/textbelt/textutils.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
+homepage: https://github.com/djds23/textbelt-gem
 licenses: []
 metadata: {}
 post_install_message: