smsified 0.1.3

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Jason Goecke
+
+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,39 @@
+smsified
+========
+
+SMSified is a simple API for sending and receiving text messages using regular phone numbers or short codes. SMSified uses a simple REST interface based on the GSMA OneAPI standard and is backed by Voxeo - the worlds largest communications cloud. Ruby lib for consuming the SMSified OneAPI.
+
+This is a Ruby gem for consuming the SMSified OneAPI.
+
+Installation
+------------
+
+	gem install smsified
+ 
+Example
+-------
+
+Send an SMS:
+
+	require 'rubygems'
+	require 'smsified'
+	oneapi = Smsified::OneAPI.new(:username => 'user', :password => 'bug.fungus24')
+	oneapi.send_sms :address => '14155551212', :message => 'Hi there!', :sender_address => '13035551212'
+
+
+Find a subscription:
+
+	require 'rubygems'
+	require 'smsified'
+	subscriptions = Smsified::Subscriptions.new(:username => 'user', :password => 'bug.fungus24')
+	subscriptions.inbound_subscriptions('17177455076')
+
+Documentation
+-------------
+
+May be found at http://tropo.github.com/smsified & http://smsified.com.
+
+License
+-------
+
+MIT - See LICENSE.txt

data/examples/sending_and_subscribing.rb

@@ -0,0 +1,39 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__), '..', 'lib')
+require 'rubygems'
+require 'smsified'
+require 'yaml'
+
+config = YAML.load(File.open('examples/config.yml'))
+
+smsified = Smsified::OneAPI.new :username       => config['smsified']['username'],
+                                :password       => config['smsified']['password']
+
+# Send an SMS to one address
+result = smsified.send_sms :message        => 'Hello there!', 
+                           :address        => '14157044517',
+                           :notify_url     => config['postbin'],
+                           :sender_address => '17177455076'
+puts result.data.inspect
+puts result.http.inspect
+                           
+# Send an SMS to multiple addresses
+result = smsified.send_sms :message        => 'Hello there!', 
+                           :address        => ['14157044517', '14153675082'],
+                           :notify_url     => config['postbin'],
+                           :sender_address => '17177455076'
+puts result.data.inspect
+puts result.http.inspect
+
+# Create in inbound subscription
+result = smsified.create_inbound_subscription '17177455076', :notify_url => config['postbin']
+puts result.data.inspect
+puts result.http.inspect
+
+# Get some of your sent SMS details
+result = smsified.search_sms 'startDate=2011-02-14&endDate=2011-02-15'
+puts result.data.inspect
+puts result.data.inspect
+
+                                
+
+

data/lib/smsified/helpers.rb

@@ -0,0 +1,33 @@
+module Smsified
+  module Helpers
+    private
+    
+    ##
+    # Camelcases the options
+    def camelcase_keys(options)
+      options = options.clone
+      
+      if options[:destination_address]
+        options[:destinationAddress] = options[:destination_address]
+        options.delete(:destination_address)
+      end
+      
+      if options[:notify_url]
+        options[:notifyURL] = options[:notify_url]
+        options.delete(:notify_url)
+      end
+      
+      if options[:client_correlator]
+        options[:clientCorrelator] = options[:client_correlator]
+        options.delete(:client_correlator)
+      end
+      
+      if options[:callback_data]
+        params[:callbackData] = options[:callback_data]
+        options.delete(:callback_data)
+      end
+      
+      options
+    end
+  end
+end

data/lib/smsified/oneapi.rb

@@ -0,0 +1,107 @@
+module Smsified
+  SMSIFIED_ONEAPI_PUBLIC_URI = 'https://api.smsified.com/v1'
+  SMSIFIED_HTTP_HEADERS      = { 'Content-Type' => 'application/x-www-form-urlencoded' }
+  
+  class OneAPI
+    include Helpers
+    
+    include HTTParty
+    format :json
+    
+    ##
+    # Intantiate a new class to work with OneAPI
+    # 
+    # @param [required, Hash] params to create the user
+    # @option params [required, String] :username username to authenticate with
+    # @option params [required, String] :password to authenticate with
+    # @option params [optional, String] :base_uri of an alternative location of SMSified
+    # @option params [optional, String] :destination_address to use with subscriptions
+    # @option params [optional, String] :sender_address to use with subscriptions
+    # @option params [optional, Boolean] :debug to turn on the HTTparty debugging to stdout
+    # @raise [ArgumentError] if :username is not passed as an option
+    # @raise [ArgumentError] if :password is not passed as an option
+    # @example 
+    #   one_api = OneAPI.new :username => 'user', :password => '123'
+    def initialize(options)
+      raise ArgumentError, ':username required' if options[:username].nil?
+      raise ArgumentError, ':password required' if options[:password].nil?
+      
+      self.class.debug_output $stdout if options[:debug]
+      self.class.base_uri options[:base_uri] || SMSIFIED_ONEAPI_PUBLIC_URI
+      @auth = { :username => options[:username], :password => options[:password] }
+      
+      @destination_address = options[:destination_address]
+      @sender_address      = options[:sender_address]
+      
+      @subscriptions = Subscriptions.new(options)
+      @reporting     = Reporting.new(options)
+    end
+    
+    ##
+    # Send an SMS to one or more addresses
+    #
+    # @param [required, Hash] params to send an sms
+    # @option params [required, String] :address to send the SMS to
+    # @option params [required, String] :message to send with the SMS
+    # @option params [optional, String] :sender_address to use with subscriptions, required if not provided on initialization of OneAPI
+    # @option params [optional, String] :notify_url to send callbacks to
+    # @return [Object] A Response Object with http and data instance methods
+    # @raise [ArgumentError] if :sender_address is not passed as an option when not passed on object creation
+    # @raise [ArgumentError] if :address is not provided as an option
+    # @raise [ArgumentError] if :message is not provided as an option
+    # @example 
+    #   one_api.send_sms :address => '14155551212', :message => 'Hi there!', :sender_address => '13035551212'
+    #   one_api.send_sms :address => ['14155551212', '13035551212'], :message => 'Hi there!', :sender_address => '13035551212'
+    def send_sms(options)
+      raise ArgumentError, ':sender_address is required' if options[:sender_address].nil? && @sender_address.nil?
+      raise ArgumentError, ':address is required' if options[:address].nil?
+      raise ArgumentError, ':message is required' if options[:message].nil?
+      
+      options[:sender_address] = options[:sender_address] || @sender_address
+      query_options = options.clone
+      query_options.delete(:sender_address)
+      query_options = camelcase_keys(query_options)
+
+      Response.new self.class.post("/smsmessaging/outbound/#{options[:sender_address]}/requests",
+                                   :body       => build_query_string(query_options),
+                                   :basic_auth => @auth,
+                                   :headers    => SMSIFIED_HTTP_HEADERS)
+    end
+    
+    ##
+    # Dispatches method calls to other objects for subscriptions and reporting
+    def method_missing(method, *args)
+      if method.to_s.match /subscription/
+        if args.size == 2
+          @subscriptions.send method, args[0], args[1]
+        else
+          @subscriptions.send method, args[0]
+        end
+      else
+        if method == :delivery_status || method == :retrieve_sms || method == :search_sms
+          @reporting.send method, args[0]
+        else
+          raise RuntimeError, 'Unknown method'
+        end
+      end
+    end
+    
+    private
+    
+    ##
+    # Builds the necessary query string
+    def build_query_string(options)
+      query = ''
+      
+      options.each do |k,v|
+        if k == :address
+          v.each { |address| query += "#{ '&' if query != '' }address=#{CGI.escape address}" }
+        else
+          query += "#{ '&' if query != '' }#{k.to_s}=#{CGI.escape v}"
+        end
+      end
+      
+      query
+    end
+  end
+end

data/lib/smsified/reporting.rb

@@ -0,0 +1,70 @@
+module Smsified
+  class Reporting
+    include HTTParty
+    format :json
+    
+    ##
+    # Intantiate a new class to work with reporting
+    # 
+    # @param [required, Hash] params to create the Reporting object with
+    # @option params [required, String] :username username to authenticate with
+    # @option params [required, String] :password to authenticate with
+    # @option params [optional, String] :base_uri of an alternative location of SMSified
+    # @option params [optional, String] :destination_address to use with subscriptions
+    # @option params [optional, String] :sender_address to use with subscriptions
+    # @option params [optional, Boolean] :debug to turn on the HTTparty debugging to stdout
+    # @example
+    #   subscription = Subscription.new :username => 'user', :password => '123'
+    def initialize(options)
+      raise ArgumentError, ':username required' if options[:username].nil?
+      raise ArgumentError, ':password required' if options[:password].nil?
+      
+      self.class.debug_output $stdout if options[:debug]
+      self.class.base_uri options[:base_uri] || SMSIFIED_ONEAPI_PUBLIC_URI
+      @auth = { :username => options[:username], :password => options[:password] }
+      
+      @destination_address = options[:destination_address]
+      @sender_address      = options[:sender_address]
+    end
+    
+    ##
+    # Get the delivery status of an outstanding SMS request
+    #
+    # @param [required, Hash] params to get the delivery status
+    # @option params [required, String] :request_id to fetch the status for
+    # @option params [optional, String] :sender_address used to send the SMS, required if not provided on initialization of OneAPI
+    # @return [Object] A Response Object with http and data instance methods
+    # @raise [ArgumentError] of :sender_address is not passed here when not passed on instantiating the object
+    # @example
+    #   one_api.delivery_status :request_id => 'f359193765f6a3149ca76a4508e21234', :sender_address => '14155551212'
+    def delivery_status(options)
+      raise ArgumentError, ':sender_address is required' if options[:sender_address].nil? && @sender_address.nil?
+      
+      options[:sender_address] = options[:sender_address] || @sender_address
+
+      Response.new self.class.get("/smsmessaging/outbound/#{options[:sender_address]}/requests/#{options[:request_id]}/deliveryInfos", :basic_auth => @auth)
+    end
+    
+    ##
+    # Retrieve a single SMS
+    # 
+    # @param [required, String] message_id of the message to retrieve
+    # @return [Object] A Response Object with http and data instance methods
+    # @example
+    #   reporting.retrieve_sms '74ae6147f915eabf87b35b9ea30c5916'
+    def retrieve_sms(message_id)
+      Response.new self.class.get("/messages/#{message_id}", :basic_auth => @auth)
+    end
+    
+    ##
+    # Retrieve multiple SMS messages based on a query string
+    # 
+    # @param [required, String] query_string to search SMS messages for
+    # @return [Object] A Response Object with http and data instance methods
+    # @example
+    #   reporting.search_sms 'startDate=2011-02-14&endDate=2011-02-15'
+    def search_sms(query_string)
+      Response.new self.class.get("/messages?#{query_string}", :basic_auth => @auth)
+    end
+  end
+end

data/lib/smsified/response.rb

@@ -0,0 +1,14 @@
+module Smsified
+  class Response
+    attr_reader :data, :http
+    
+    ##
+    # Provides the standard response for the library
+    #
+    # @param [Object] an HTTParty result object
+    def initialize(httparty)
+      @data = httparty.parsed_response
+      @http = httparty.response
+    end
+  end
+end

data/lib/smsified/subscriptions.rb

@@ -0,0 +1,147 @@
+module Smsified
+  class Subscriptions
+    include Helpers
+        
+    include HTTParty
+    format :json
+    
+    ##
+    # Intantiate a new class to work with subscriptions
+    # 
+    # @param [required, Hash] params to create the user
+    # @option params [required, String] :username username to authenticate with
+    # @option params [required, String] :password to authenticate with
+    # @option params [optional, String] :base_uri of an alternative location of SMSified
+    # @option params [optional, String] :destination_address to use with subscriptions
+    # @option params [optional, String] :sender_address to use with subscriptions
+    # @option params [optional, Boolean] :debug to turn on the HTTparty debugging to stdout
+    # @example
+    #   subscription = Subscription.new :username => 'user', :password => '123'
+    def initialize(options)
+      raise ArgumentError, ':username required' if options[:username].nil?
+      raise ArgumentError, ':password required' if options[:password].nil?
+      
+      self.class.debug_output $stdout if options[:debug]
+      self.class.base_uri options[:base_uri] || SMSIFIED_ONEAPI_PUBLIC_URI
+      @auth = { :username => options[:username], :password => options[:password] }
+      
+      @destination_address = options[:destination_address]
+      @sender_address      = options[:sender_address]
+    end
+
+    ##
+    # Creates an inbound subscription
+    # 
+    # @param [required, String] destination_address to subscribe to
+    # @param [required, Hash] params to send an sms
+    # @option params [optional, String] :notify_url to send callbacks to
+    # @option params [optional, String] :client_correlator to update
+    # @option params [optional, String] :callback_data to update
+    # @return [Object] A Response Object with http and data instance methods
+    # @param [required, String] notify_url to send callbacks to
+    # @return [Object] A Response Object with http and data instance methods
+    # @example
+    #   subscriptions.create_inbound_subscription('tel:+14155551212', :notify_url => 'http://foobar.com')
+    def create_inbound_subscription(destination_address, options)
+      query = options.merge({ :destination_address => destination_address })
+      
+      Response.new self.class.post("/smsmessaging/inbound/subscriptions", 
+                                   :basic_auth => @auth,
+                                   :body       => camelcase_keys(query))
+    end
+    
+    ##
+    # Creates an outbound subscription
+    # 
+    # @param [required, String] sender_address to subscribe to
+    # @option params [optional, String] :notify_url to send callbacks to
+    # @option params [optional, String] :client_correlator to update
+    # @option params [optional, String] :callback_data to update
+    # @return [Object] A Response Object with http and data instance methods
+    # @example
+    #   subscriptions.create_outbound_subscription('tel:+14155551212', :notify_url => 'http://foobar.com')    
+    def create_outbound_subscription(sender_address, options)
+      Response.new self.class.post("/smsmessaging/outbound/#{sender_address}/subscriptions", 
+                                   :basic_auth => @auth,
+                                   :body       => camelcase_keys(options))
+    end
+    
+    ##
+    # Deletes an inbound subscription
+    # 
+    # @param [required, String] subscription_id to delete
+    # @return [Object] A Response Object with http and data instance methods
+    # @example
+    #   subscriptions.delete_inbound_subscription('89edd71c1c7f3d349f9a3a4d5d2d410c')
+    def delete_inbound_subscription(subscription_id)
+      Response.new self.class.delete("/smsmessaging/inbound/subscriptions/#{subscription_id}", :basic_auth => @auth)
+    end
+    
+    ##
+    # Deletes an outbound subscription
+    # 
+    # @param [required, String] subscription_id to delete
+    # @return [Object] A Response Object with http and data instance methods
+    # @example
+    #   subscriptions.delete_outbound_subscription('89edd71c1c7f3d349f9a3a4d5d2d410c')
+    def delete_outbound_subscription(sender_address)
+      Response.new self.class.delete("/smsmessaging/outbound/subscriptions/#{sender_address}", :basic_auth => @auth)
+    end
+    
+    ##
+    # Fetches the inbound subscriptions
+    #
+    # @param [required, String] destination_address to fetch the subscriptions for
+    # @return [Object] A Response Object with http and data instance methods
+    # @example
+    #   subscriptions.inbound_subscriptions('tel:+14155551212')
+    def inbound_subscriptions(destination_address)
+      Response.new self.class.get("/smsmessaging/inbound/subscriptions?destinationAddress=#{destination_address}", :basic_auth => @auth)
+    end
+
+    ##
+    # Fetches the outbound subscriptions
+    #
+    # @param [required, String] sender_address to fetch the subscriptions for
+    # @return [Object] A Response Object with http and data instance methods
+    # @example
+    #   subscriptions.outbound_subscriptions('tel:+14155551212')
+    def outbound_subscriptions(sender_address)
+      Response.new self.class.get("/smsmessaging/outbound/subscriptions?senderAddress=#{sender_address}", :basic_auth => @auth)
+    end
+    
+    ##
+    # Updates an inbound subscription
+    # 
+    # @option params [required, String] subscription_id updating
+    # @param [required, Hash] params to update the inbound subscription with
+    # @option params [optional, String] :notify_url to send callbacks to
+    # @option params [optional, String] :client_correlator to update
+    # @option params [optional, String] :callback_data to update
+    # @return [Object] A Response Object with http and data instance methods
+    # @example
+    #   subscriptions.update_inbound_subscription('89edd71c1c7f3d349f9a3a4d5d2d410c', :notify_url => 'foobar')
+    def update_inbound_subscription(subscription_id, options)
+      Response.new self.class.post("/smsmessaging/inbound/subscriptions/#{subscription_id}", 
+                                   :basic_auth => @auth,
+                                   :body       => camelcase_keys(options))
+    end
+    
+    ##
+    # Updates an outbound subscription
+    # 
+    # @option params [required, String] sender_address updating
+    # @param [required, Hash] params to update the outbound subscription with
+    # @option params [optional, String] :notify_url to send callbacks to
+    # @option params [optional, String] :client_correlator to update
+    # @option params [optional, String] :callback_data to update
+    # @return [Object] A Response Object with http and data instance methods
+    # @example
+    #   subscriptions.update_outbound_subscription('tel:+14155551212', :notify_url => 'foobar')
+    def update_outbound_subscription(sender_address, options)
+      Response.new self.class.post("/smsmessaging/outbound/#{sender_address}/subscriptions", 
+                                   :basic_auth => @auth,
+                                   :body       => camelcase_keys(options))
+    end
+  end
+end

data/lib/smsified.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+%w(cgi httparty smsified/helpers smsified/oneapi smsified/subscriptions smsified/reporting smsified/response).each { |lib| require lib }

data/spec/smsified_spec.rb

@@ -0,0 +1,416 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+# These tests are all local unit tests
+FakeWeb.allow_net_connect = false
+
+describe "Smsified" do
+  before(:all) do
+    @username       = 'user'
+    @password       = 'pass'
+    @address        = '14155551212'
+    @sender_address = '13035551212'
+  end
+  
+  describe "OneAPI" do
+    before(:all) do
+      @one_api = Smsified::OneAPI.new :username => @username, :password => @password, :debug => true
+      
+      @message_sent = { "resourceReference" => { "resourceURL" => "https://api.smsified.com/v1/smsmessaging/outbound/tel%3A%2B#{@sender_address}/requests/795bd02c8e343b2dfd673b67dd0ee55a" } }
+      
+      FakeWeb.register_uri(:post, 
+                           "https://#{@username}:#{@password}@api.smsified.com/v1/smsmessaging/outbound/#{@sender_address}/requests",
+                           :status => ["200", "OK"],
+                           :body   => @message_sent.to_json)                           
+    end
+   
+    it "Should get errors if instantiating without all of the right parameters" do
+      begin
+        Smsified::OneAPI.new 'foobar'
+      rescue => e
+        e.to_s.should eql ':username required'
+      end
+   
+      begin
+        Smsified::OneAPI.new(:username => @username)
+      rescue => e
+        e.to_s.should eql ':password required'
+      end
+    end
+  
+    it "Should raise an error if no :sender_address specified" do
+      begin
+        @one_api.send_sms('foobar')
+      rescue => e
+        e.to_s.should eql ':sender_address is required'
+      end
+    end
+    
+    it "Should not raise an error if a :sender_address was specified at instantiation" do
+      one_api = Smsified::OneAPI.new :username => @username, :password => @password, :debug => true, :sender_address => @sender_address
+      response = one_api.send_sms :address => @address, :message => 'Hola from RSpec!'
+      response.data.should eql @message_sent
+    end
+    
+    it "Should raise an error if all required params are not passed when sending an SMS" do
+      begin
+        @one_api.send_sms(:message => 'Hola from RSpec!', :sender_address => @sender_address)
+      rescue => e
+        e.to_s.should eql ':address is required'
+      end
+      
+      begin
+        @one_api.send_sms(:address => @address, :sender_address => @sender_address)
+      rescue => e
+        e.to_s.should eql ':message is required'
+      end
+    end
+    
+    it "Should instantiate a OneAPI object" do
+      oneapi = Smsified::OneAPI.new :username => @username, :password => @password, :debug => true
+      oneapi.instance_of?(Smsified::OneAPI).should eql true
+    end
+  
+    it "Should send an SMS" do
+      response = @one_api.send_sms(:address => @address, :message => 'Hola from RSpec!', :sender_address => @sender_address)
+      response.data.should eql @message_sent
+    end
+    
+    it "Should send an SMS to multiple destinations" do
+      response = @one_api.send_sms(:address        => ['14155551212', '13035551212'], 
+                                   :message        => 'Hola from RSpec!', 
+                                   :sender_address => @sender_address)
+      response.data.should eql @message_sent
+    end
+    
+    it "Should raise an error if you pass an unknown method name" do
+      begin 
+        @one_api.foobar
+      rescue => e
+        e.to_s.should eql "Unknown method"
+      end
+    end
+  end
+  
+  describe 'Subscriptions' do
+    before(:all) do
+      @subscriptions = Smsified::Subscriptions.new :username => @username, :password => @password, :debug => true
+    end
+    
+    it "Should instantiate a Subscriptions object" do
+      smsified = Smsified::Subscriptions.new(:username => @username, :password => @password)
+      smsified.instance_of?(Smsified::Subscriptions).should eql true
+    end
+    
+    it "Should get errors if instantiating without all of the right parameters" do
+      begin
+        Smsified::Subscriptions.new 'foobar'
+      rescue => e
+        e.to_s.should eql ':username required'
+      end
+      
+      begin
+        Smsified::Subscriptions.new(:username => @username)
+      rescue => e
+        e.to_s.should eql ':password required'
+      end
+    end
+
+    describe 'Listing subscriptions' do
+      before(:all) do
+        @no_subscription = { "inboundSubscriptionList" => { "numberOfSubscriptions" => "0" } }
+        
+        @inbound_subscriptions = {
+                                      "inboundSubscriptionList" => {
+                                            "inboundSubscription" => [
+                                                  {
+                                                         "resourceURL" => "https://api.smsified.com/v1/smsmessaging/inbound/subscriptions/3cf88f9cfd0dae96cbfdf16f18c07411",
+                                                      "subscriptionId" => "3cf88f9cfd0dae96cbfdf16f18c07411",
+                                                  "notificationFormat" => "JSON",
+                                                  "destinationAddress" => "tel:+17177455076",
+                                                           "notifyURL" => "http://98.207.5.162:8080"
+                                              },
+                                                  {
+                                                         "resourceURL" => "https://api.smsified.com/v1/smsmessaging/inbound/subscriptions/75bb5bef239aed425c2966cbb95f33c9",
+                                                      "subscriptionId" => "75bb5bef239aed425c2966cbb95f33c9",
+                                                  "notificationFormat" => "JSON",
+                                                  "destinationAddress" => "tel:+17177455076",
+                                                           "notifyURL" => "http://98.207.5.162:8080"
+                                              }
+                                          ],
+                                          "numberOfSubscriptions" => "2",
+                                                    "resourceURL" => "https://api.smsified.com/v1/smsmessaging/inbound/subscriptions"
+                                      }
+                                  }
+        
+        @outbound_subscriptions = {
+                                      "outboundSubscriptionList" => {
+                                          "numberOfSubscriptions" => "2",
+                                                    "resourceURL" => "https://api.smsified.com/v1/smsmessaging/outbound/subscriptions",
+                                           "outboundSubscription" => [
+                                                  {
+                                                       "senderAddress" => "tel:+17177455076",
+                                                         "resourceURL" => "https://api.smsified.com/v1/smsmessaging/outbound/subscriptions/68faa512b1c81ee0d33a6b97004d1212",
+                                                      "subscriptionId" => "68faa512b1c81ee0d33a6b97004d1212",
+                                                  "notificationFormat" => "JSON",
+                                                           "notifyURL" => "http://98.207.5.162:8080"
+                                              },
+                                                  {
+                                                       "senderAddress" => "tel:+17177455076",
+                                                         "resourceURL" => "https://api.smsified.com/v1/smsmessaging/outbound/subscriptions/6e64fb72cd2a27b8a9460caccbd4dc53",
+                                                      "subscriptionId" => "6e64fb72cd2a27b8a9460caccbd4dc53",
+                                                  "notificationFormat" => "JSON",
+                                                           "notifyURL" => "http://98.207.5.162:8080"
+                                              }
+                                          ]
+                                      }
+                                  }
+        
+        FakeWeb.register_uri(:get, 
+                             "https://#{@username}:#{@password}@api.smsified.com/v1/smsmessaging/inbound/subscriptions?destinationAddress=#{@address}",
+                             :status => ["200", "OK"],
+                             :body   => @no_subscription.to_json)
+                             
+        FakeWeb.register_uri(:get, 
+                             "https://#{@username}:#{@password}@api.smsified.com/v1/smsmessaging/inbound/subscriptions?destinationAddress=#{@sender_address}",
+                             :status => ["200", "OK"],
+                             :body   => @inbound_subscriptions.to_json)
+                             
+        FakeWeb.register_uri(:get, 
+                             "https://#{@username}:#{@password}@api.smsified.com/v1/smsmessaging/outbound/subscriptions?senderAddress=#{@sender_address}",
+                             :status => ["200", "OK"],
+                             :body   => @outbound_subscriptions.to_json)
+      end
+      
+      it "Should let me instantiate a OneAPI object and call subscription methods" do
+        one_api = Smsified::OneAPI.new :username => @username, :password => @password, :debug => true
+        inbound_subscriptions = one_api.inbound_subscriptions(@address)
+        inbound_subscriptions.data.should eql @no_subscription
+      end
+      
+      it "Should find no subscriptions" do
+        inbound_subscriptions = @subscriptions.inbound_subscriptions(@address)
+        inbound_subscriptions.data.should eql @no_subscription
+      end
+      
+      it "Should get a list of inbound subscriptions" do
+        inbound_subscriptions = @subscriptions.inbound_subscriptions(@sender_address)
+        inbound_subscriptions.http.code.should eql '200'
+        inbound_subscriptions.data.should eql @inbound_subscriptions
+      end
+
+      it "Should get a list of outbound subscriptions" do
+        outbound_subscriptions = @subscriptions.outbound_subscriptions(@sender_address)
+        outbound_subscriptions.http.code.should eql '200'
+        outbound_subscriptions.data.should eql @outbound_subscriptions
+      end
+    end
+    
+    describe 'Create subscriptions' do
+      before(:all) do
+        @inbound_subscription  = { "resourceReference" => { "resourceURL" => "https://api.smsified.com/v1/smsmessaging/inbound/subscriptions/e636368b7fddac0e93e34ae03bad33dd" } }
+        @outbound_subscription = { "resourceReference" => { "resourceURL" => "https://api.smsified.com/v1/smsmessaging/outbound/subscriptions/4bc465cd394c9f5e78802af5ad6bb442" } }
+        
+        FakeWeb.register_uri(:post, 
+                             %r|https://#{@username}:#{@password}@api.smsified.com/v1/smsmessaging/inbound/subscriptions?|,
+                             :status => ["200", "OK"],
+                             :body   => @inbound_subscription.to_json)
+                                          
+        FakeWeb.register_uri(:post, 
+                             %r|https://#{@username}:#{@password}@api.smsified.com/v1/smsmessaging/outbound/17177455076/subscriptions?|,
+                             :status => ["200", "OK"],
+                             :body   => @outbound_subscription.to_json)
+      end
+      
+      it 'Should create an inbound subscription' do
+        result = @subscriptions.create_inbound_subscription('17177455076', :notify_url => 'http://foobar.com')
+        result.http.code.should eql '200'
+        result.data.should eql @inbound_subscription
+      end
+    
+      it 'Should create an outbound subscription' do
+        result = @subscriptions.create_outbound_subscription('17177455076', :notify_url => 'http://foobar.com')
+        result.http.code.should eql '200'
+        result.data.should eql @outbound_subscription
+      end
+    end
+    
+    describe 'Updated subscriptions' do
+      before(:all) do
+        @outbound_subscription = { "resourceReference" => { "resourceURL" => "https://api.smsified.com/v1/smsmessaging/outbound/subscriptions/4bc465cd394c9f5e78802af5ad6bb442" } }
+        
+        FakeWeb.register_uri(:post, 
+                             "https://#{@username}:#{@password}@api.smsified.com/v1/smsmessaging/outbound/#{@sender_address}/subscriptions",
+                             :status => ["200", "OK"],
+                             :body   => @outbound_subscription.to_json)
+      end
+      
+      it 'Should update an inbound subscription' do
+        pending('udpate resources being deployed')
+        result = @subscriptions.update_inbound_subscription('c880c96f161f6220d4977b29b4bfc111', :notify_url => 'http://foobar1.com')
+
+        result.http.code.should eql '200'
+        result.data.should eql nil
+      end
+      
+      it 'Should update an outbound subscription' do
+        result = @subscriptions.update_outbound_subscription(@sender_address, :notify_url => 'http://foobar.com')
+        result.http.code.should eql '200'
+        result.data.should eql @outbound_subscription
+      end
+    end
+    
+    describe 'Deleting subscriptions' do
+      before(:all) do
+        FakeWeb.register_uri(:delete, 
+                             %r|https://#{@username}:#{@password}@api.smsified.com/v1/smsmessaging/|,
+                             :status => ["204", "OK"])        
+      end
+      
+      it "Should delete an inbound subscription" do
+        result = @subscriptions.delete_inbound_subscription('3cf88f9cfd0dae96cbfdf16f18c07411')
+        result.http.code.should eql '204'
+      end
+    
+      it "Should delete an outbound subscription" do
+        result = @subscriptions.delete_outbound_subscription('342b61efc3ba9fd2fd992e58903ef050')
+        result.http.code.should eql '204'
+      end
+    end
+  end
+  
+  describe "Reporting" do
+    before(:all) do
+      @reporting = Smsified::Reporting.new :username => @username, :password => @password, :debug => true
+      
+      @delivery_status = {
+          "deliveryInfoList" => {
+              "deliveryInfo" => [
+                      {
+                              "address" => "tel:+14153675082",
+                                "parts" => "1",
+                        "senderAddress" => "tel:+17177455076",
+                            "messageId" => "74ae6147f915eabf87b35b9ea30c5916",
+                                 "code" => "0",
+                      "createdDateTime" => 'Fri May 13 16:14:50 UTC 2011',
+                         "sentDateTime" => 'Fri May 13 16:14:53 UTC 2011',
+                       "deliveryStatus" => "DeliveredToNetwork",
+                              "message" => "Hola from RSpec!",
+                            "direction" => "outbound"
+                  }
+              ],
+               "resourceURL" => "https://api.smsified.com/v1/smsmessaging/outbound/tel%3A%2B17177455076/requests/795bd02c8e343b2dfd673b67dd0ee55a/deliveryInfos"
+          }
+      }
+      
+      @message = { "parts"     => 1, 
+                   "sent"      => "2011-05-13T16:14:50.480+0000", 
+                   "code"      => "0", 
+                   "body"      => "Hola from RSpec!", 
+                   "messageId" => "74ae6147f915eabf87b35b9ea30c5916", 
+                   "from"      => "17177455076", 
+                   "to"        => "14153675082", 
+                   "direction" => "out", 
+                   "status"    => "success", 
+                   "created"   => "2011-05-13T16:14:50.480+0000"}
+      
+      @message_range = [
+                         {
+                               "parts" => 1,
+                                "sent" => "2011-05-13T20:27:56.690+0000",
+                                "code" => "-1",
+                                "body" => "foobar9446",
+                           "messageId" => "d194e91c32de943ae942ad4043b7905b",
+                                "from" => "17177455076",
+                                  "to" => "14155551",
+                           "direction" => "out",
+                              "status" => "fail",
+                             "created" => "2011-05-13T20:27:56.690+0000"
+                         },
+                         {
+                               "parts" => 1,
+                                "sent" => "2011-05-13T20:27:53.660+0000",
+                                "code" => "-1",
+                                "body" => "foobar4374",
+                           "messageId" => "4d9237b323618ab164fb6d646882da99",
+                                "from" => "17177455076",
+                                  "to" => "14155551212",
+                           "direction" => "out",
+                              "status" => "fail",
+                             "created" => "2011-05-13T20:27:53.660+0000"
+                         }
+                      ]
+                      
+      FakeWeb.register_uri(:get, 
+                           "https://#{@username}:#{@password}@api.smsified.com/v1/messages/74ae6147f915eabf87b35b9ea30c5916",
+                           :status => ["200", "OK"],
+                           :body   => @message.to_json)
+      
+      FakeWeb.register_uri(:get, 
+                           "https://#{@username}:#{@password}@api.smsified.com/v1/messages?startDate=2011-05-12&endDate=2011-05-12",
+                           :status => ["200", "OK"],
+                           :body   => @message_range.to_json)
+      
+      FakeWeb.register_uri(:get, 
+                           "https://#{@username}:#{@password}@api.smsified.com/v1/smsmessaging/outbound/#{@sender_address}/requests/795bd02c8e343b2dfd673b67dd0ee55a/deliveryInfos",
+                           :status => ["200", "OK"],
+                           :body   => @delivery_status.to_json)
+    end
+    
+    it "Should instantiate a Reporting object" do
+      reporting = Smsified::Reporting.new :username => 'smsified_tester_smsified', :password => 'bug.fungus52', :debug => true
+      reporting.instance_of?(Smsified::Reporting).should eql true
+    end
+    
+    it "Should get errors if instantiating without all of the right parameters" do
+      begin
+        Smsified::Reporting.new 'foobar'
+      rescue => e
+        e.to_s.should eql ':username required'
+      end
+      
+      begin
+        Smsified::Reporting.new(:username => @username)
+      rescue => e
+        e.to_s.should eql ':password required'
+      end
+    end
+    
+    it "Should raise an error if no :sender_address specified" do
+      begin
+        @reporting.delivery_status('foobar')
+      rescue => e
+        e.to_s.should eql ':sender_address is required'
+      end
+    end
+    
+    it "Should not raise an error if a :sender_address was specified at instantiation" do
+      reporting = Smsified::Reporting.new :username => @username, :password => @password, :debug => true, :sender_address => @sender_address
+      delivery_response = reporting.delivery_status :request_id => '795bd02c8e343b2dfd673b67dd0ee55a'
+      delivery_response.data.should == @delivery_status
+    end
+    
+    it "Should retrieve an SMS message" do
+      response = @reporting.retrieve_sms '74ae6147f915eabf87b35b9ea30c5916'
+      response.data.should eql @message
+    end
+    
+    it "Should retrieve SMS messages based on a query string" do
+      response = @reporting.search_sms 'startDate=2011-05-12&endDate=2011-05-12'
+      response.data.should eql @message_range
+    end
+    
+    it "Should send an SMS and get the Delivery status" do
+      delivery_response = @reporting.delivery_status :request_id => '795bd02c8e343b2dfd673b67dd0ee55a', :sender_address => @sender_address
+      delivery_response.data.should == @delivery_status
+    end
+    
+    it "Should let me instantiate a OneAPI object and call reporting methods" do
+      one_api = Smsified::OneAPI.new :username => @username, :password => @password, :debug => true
+      delivery_response = one_api.delivery_status :request_id => '795bd02c8e343b2dfd673b67dd0ee55a', :sender_address => @sender_address
+      delivery_response.data.should eql @delivery_status
+      
+      sms_message = one_api.retrieve_sms '74ae6147f915eabf87b35b9ea30c5916'
+      sms_message.data.should eql @message
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'smsified'
+require 'fakeweb'
+require 'awesome_print'
+require 'json'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,213 @@
+--- !ruby/object:Gem::Specification 
+name: smsified
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 3
+  version: 0.1.3
+platform: ruby
+authors: 
+- Jason Goecke
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-20 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  name: rspec
+  version_requirements: *id001
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  name: yard
+  version_requirements: *id002
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  name: bundler
+  version_requirements: *id003
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  name: jeweler
+  version_requirements: *id004
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rcov
+  version_requirements: *id005
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: fakeweb
+  version_requirements: *id006
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: awesome_print
+  version_requirements: *id007
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: json
+  version_requirements: *id008
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: httparty
+  version_requirements: *id009
+  prerelease: false
+description: Gem for consuming the SMSified OneAPI
+email: jsgoecke@voxeo.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+files: 
+- README.md
+- lib/smsified.rb
+- lib/smsified/helpers.rb
+- lib/smsified/oneapi.rb
+- lib/smsified/reporting.rb
+- lib/smsified/response.rb
+- lib/smsified/subscriptions.rb
+- LICENSE.txt
+- examples/sending_and_subscribing.rb
+- spec/smsified_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/tropo/smsified-oneapi
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Gem for consuming the SMSified OneAPI
+test_files: 
+- examples/sending_and_subscribing.rb
+- spec/smsified_spec.rb
+- spec/spec_helper.rb