smsified 0.1.4 → 0.1.5

data/README.md

@@ -28,6 +28,18 @@ Find a subscription:
 	subscriptions = Smsified::Subscriptions.new(:username => 'user', :password => 'bug.fungus24')
 	subscriptions.inbound_subscriptions('17177455076')
 
+Parse the JSON for a callback Incoming Message:
+
+    require 'rubygems'
+    require 'smsified'
+    # Also require your favorite web framework such as Rails or Sinatra
+    incoming_message = Smsified::IncomingMessage.new json_body
+	puts incoming_message.date_time           # Wed May 11 18:05:54 UTC 2011
+    puts incoming_message.destination_address # '16575550100'
+    puts incoming_message.message             # 'Inbound test'
+    puts incoming_message.message_id          # 'ef795d3dac56a62fef3ff1852b0c123a'
+    puts incoming_message.sender_address      # '14075550100'
+
 Documentation
 -------------
 

data/lib/smsified/helpers.rb

@@ -23,7 +23,7 @@ module Smsified
       end
       
       if options[:callback_data]
-        params[:callbackData] = options[:callback_data]
+        options[:callbackData] = options[:callback_data]
         options.delete(:callback_data)
       end
       

data/lib/smsified/incoming_message.rb

@@ -0,0 +1,33 @@
+module Smsified
+  class IncomingMessage
+    attr_reader :date_time, :destination_address, :message, :message_id, :sender_address, :json
+    
+    ##
+    # Intantiate a new object to provide convenience methods on an Incoming Message
+    # http://www.smsified.com/sms-api-documentation/receiving
+    # 
+    # @param [required, String] valid JSON for an Incoming Message to be parsed
+    # @return [Object] the parsed incoming message
+    # @raise [ArgumentError] if json is not valid JSON or an Incoming Message type
+    # @example 
+    #   incoming_message = IncomingMessage.new(json)
+    #   puts incoming_message.message # foobar
+    def initialize(json)
+      begin
+        @json                = JSON.parse json
+        
+        contents             = @json['inboundSMSMessageNotification']['inboundSMSMessage']
+        
+        @date_time           = Time.parse contents['dateTime']
+        @destination_address = contents['destinationAddress']
+        @message             = contents['message']
+        @message_id          = contents['messageId']
+        @sender_address      = contents['senderAddress']
+      rescue => error
+        raise MessageError, "Not valid JSON or IncomingMessage"
+      end
+    end
+    
+    class MessageError < StandardError; end
+  end
+end

data/lib/smsified.rb

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

data/spec/smsified_spec.rb

@@ -11,6 +11,30 @@ describe "Smsified" do
     @sender_address = '13035551212'
   end
   
+  describe "Helpers" do
+    it 'Should camelcase the appropriate keys' do
+      class Foo
+        include Smsified::Helpers
+        
+        attr_reader :keys 
+        
+        def initialize(hash)
+          @keys = camelcase_keys(hash)
+        end
+      end
+      
+      camelcased_keys = Foo.new({ :destination_address => 'foo',
+                                  :notify_url          => 'bar',
+                                  :client_correlator   => 'baz',
+                                  :callback_data       => 'donkey' }).keys
+                                  
+      camelcased_keys[:destinationAddress].should eql 'foo'
+      camelcased_keys[:notifyURL].should eql 'bar'
+      camelcased_keys[:clientCorrelator].should eql 'baz'
+      camelcased_keys[:callbackData].should eql 'donkey'
+    end
+  end
+  
   describe "OneAPI" do
     before(:all) do
       @one_api = Smsified::OneAPI.new :username => @username, :password => @password, :debug => true
@@ -254,6 +278,7 @@ describe "Smsified" do
     
     describe 'Updated 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, 
@@ -263,11 +288,10 @@ describe "Smsified" do
       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
+        result.data.should eql @inbound_subscription
       end
       
       it 'Should update an outbound subscription' do
@@ -443,4 +467,35 @@ describe "Smsified" do
       sms_message.data.should eql @message
     end
   end
+  
+  describe 'IncomingMessage' do
+    it 'Should parse an incoming message from SMSified' do
+      json = '{
+                "inboundSMSMessageNotification": {
+                  "inboundSMSMessage": {
+                    "dateTime": "2011-05-11T18:05:54.546Z", 
+                    "destinationAddress": "16575550100", 
+                    "message": "Inbound test", 
+                    "messageId": "ef795d3dac56a62fef3ff1852b0c123a", 
+                    "senderAddress": "14075550100"
+                  }
+                }
+              }'
+      
+      incoming_message = Smsified::IncomingMessage.new json
+      incoming_message.date_time.should eql Time.parse '2011-05-11T18:05:54.546Z'
+      incoming_message.destination_address.should eql '16575550100'
+      incoming_message.message.should eql 'Inbound test'
+      incoming_message.message_id.should eql 'ef795d3dac56a62fef3ff1852b0c123a'
+      incoming_message.sender_address.should eql '14075550100'
+    end
+    
+    it "Should raise an error if JSON not passed" do
+      lambda { Smsified::IncomingMessage.new 'foobar' }.should raise_error(Smsified::IncomingMessage::MessageError)
+    end
+    
+    it "Should raise an error if a different type than an IncomingMessage is passed" do
+      lambda { Smsified::IncomingMessage.new "{ 'foo': 'bar'}" }.should raise_error(Smsified::IncomingMessage::MessageError)
+    end
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: smsified
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: 
   segments: 
   - 0
   - 1
-  - 4
-  version: 0.1.4
+  - 5
+  version: 0.1.5
 platform: ruby
 authors: 
 - Jason Goecke
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-24 00:00:00 -07:00
+date: 2011-07-05 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -165,6 +165,7 @@ files:
 - README.md
 - lib/smsified.rb
 - lib/smsified/helpers.rb
+- lib/smsified/incoming_message.rb
 - lib/smsified/oneapi.rb
 - lib/smsified/reporting.rb
 - lib/smsified/response.rb