exotel 0.1 → 0.1.1

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+script: "rake test"
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - ree

data/Gemfile.lock

@@ -0,0 +1,27 @@
+PATH
+  remote: .
+  specs:
+    exotel (0.1)
+      httparty (>= 0.9.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.2)
+    crack (0.3.1)
+    httparty (0.9.0)
+      multi_json (~> 1.0)
+      multi_xml
+    multi_json (1.5.0)
+    multi_xml (0.5.1)
+    webmock (1.9.0)
+      addressable (>= 2.2.7)
+      crack (>= 0.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.0.0)
+  exotel!
+  webmock

data/README.md

@@ -1,4 +1,30 @@
-exotel
+# exotel - A ruby wrapper for the Exotel API
+[![Build Status](https://travis-ci.org/vijendra/exotel.png?branch=master)](https://travis-ci.org/vijendra/exotel)
 ======
+# Installation
+  gem install exotel
 
-Exotel gem wrapper api
+======  
+# Usage
+    # Configure authentication keys
+    Exotel.configure do |c|
+      c.exotel_sid   = "Your exotel sid"
+      c.exotel_token = "Your exotel token"
+    end
+ 
+    #To send SMS
+    sms = Exotel::Sms.new
+    response = sms.send(from: 'FROM_NUMBER', to: 'TO_NUMBER', body: 'MESSAGE BODY')
+    sms_id = response.sid 
+    
+    #To get the details
+    sms = Exotel::Sms.new
+    response = sms.details(sms_id)
+    status = response.status
+======  
+# Run tests
+  rake test
+ 
+======  
+# TODO
+Cover exotel call

data/exotel.gemspec

@@ -16,6 +16,9 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency "bundler", ">= 1.0.0"
   s.add_development_dependency "webmock"
+  if RUBY_VERSION == "1.8.7"
+    s.add_development_dependency 'minitest', '3.2.0'
+  end
   
   s.add_dependency 'httparty', '>= 0.9.0'
   

data/lib/exotel.rb

@@ -1,4 +1,5 @@
 require 'httparty'
+require 'exotel/version'
 require 'exotel/config'
 require 'exotel/sms'
 require 'exotel/response'

data/lib/exotel/response.rb

@@ -4,8 +4,10 @@ module Exotel
     attr_accessor :sid, :date_created, :date_updated, :status, :date_sent, :to, :from, :body
     
     def initialize(response)
-      parsed_response = MultiXml.parse(response)
-      sms = parsed_response['TwilioResponse']['SMSMessage']
+      #To handle unexpected parsing from httparty
+      response = MultiXml.parse(response) unless response.is_a?(Hash) 
+      
+      sms = response['TwilioResponse']['SMSMessage']
       @sid          = sms['Sid']
       @date_created = sms['DateCreated']
       @date_updated = sms['DateUpdated']

data/lib/exotel/sms.rb

@@ -3,22 +3,27 @@ require 'httparty'
 module Exotel
   class Sms
     include HTTParty
-    base_uri "https://twilix.exotel.in/v1/Accounts/#{Exotel.exotel_sid}"
+    base_uri "https://twilix.exotel.in/v1/Accounts"
     
-    def initialize(params={})
-      @fields = {From: params[:from], To: params[:to], Body: params[:body]} 
+    def initialize
     end
     
-    def send
-      options = {body: @fields, basic_auth: auth }
-      response = self.class.post('/Sms/send',  options)
+    def send(params={})
+      fields = {:From => params[:from], :To => params[:to], :Body => params[:body]} 
+      options = {:body => fields, :basic_auth => auth }
+      response = self.class.post("/#{Exotel.exotel_sid}/Sms/send",  options)
       handle_response(response)
     end
-  
+   
+    def details(sid)
+      response = self.class.get("/#{Exotel.exotel_sid}/Sms/Messages/#{sid}",  :basic_auth => auth)
+      handle_response(response)
+    end
+    
     protected
     
     def auth
-      {username: Exotel.exotel_sid, password: Exotel.exotel_token}
+      {:username => Exotel.exotel_sid, :password => Exotel.exotel_token}
     end
     
     def handle_response(response)
@@ -29,11 +34,6 @@ module Exotel
  	      raise Exotel::UnexpectedError, response.body
  	    end
     end
-    
-    #TODO check how to remove this. Now it is not setting the correct url, if removed
-    def self.base_uri
-      "https://twilix.exotel.in/v1/Accounts/#{Exotel.exotel_sid}"
-    end
   end
 end  
 

data/lib/exotel/version.rb

@@ -1,3 +1,3 @@
 module Exotel
-  VERSION = '0.1'
+  VERSION = '0.1.1'
 end

data/test/exotel/sms_test.rb

@@ -6,9 +6,9 @@ describe Exotel::Sms do
   end
   
   it 'should have the correct base_uri' do
-    Exotel::Sms.base_uri.must_equal "https://twilix.exotel.in/v1/Accounts/#{Exotel.exotel_sid}"
+    Exotel::Sms.base_uri.must_equal "https://twilix.exotel.in/v1/Accounts"
   end
-  
+=begin  
   describe '#initialize' do
     it "should set the fields hash as required by exotel" do
       sms = Exotel::Sms.new(from: '1234', to: '4321', body: 'Test sms')
@@ -16,25 +16,26 @@ describe Exotel::Sms do
       sms.instance_variable_get(:@fields).must_equal fields_hash
     end
   end
+=end
   
   describe '#send' do
     describe 'success' do
       before do
         base_path = File.expand_path(File.join(File.dirname(__FILE__), '..'))
-        stub_request(:post, "https://test_sid:test_token@twilix.exotel.in/v1/Accounts/Sms/send").
+        stub_request(:post, "https://test_sid:test_token@twilix.exotel.in/v1/Accounts/#{Exotel.exotel_sid}/Sms/send").
         with(:body => "From=1234&To=4321&Body=Test%20sms"). 
         to_return(:status => 200, :body => File.new(base_path + '/fixtures/sms.xml'))
       end
     
       it "should return the response object" do
-        sms = Exotel::Sms.new(from: '1234', to: '4321', body: 'Test sms')
-        response = sms.send
+        sms = Exotel::Sms.new
+        response = sms.send(:from => '1234', :to => '4321', :body => 'Test sms')
         response.class.must_equal Exotel::Response
       end
       
       it "should set the response object values" do
-        sms = Exotel::Sms.new(from: '1234', to: '4321', body: 'Test sms')
-        response = sms.send 
+        sms = Exotel::Sms.new
+        response = sms.send(:from => '1234', :to => '4321', :body => 'Test sms') 
         response.sid.must_equal 'SM872fb94e3b358913777cdb313f25b46f'
         response.date_created.must_equal 'Sun, 09 Dec 2012 03:48:08'
         response.date_updated.must_equal 'Sun, 09 Dec 2012 03:48:10' 
@@ -49,14 +50,58 @@ describe Exotel::Sms do
     describe 'autentication failed' do
       before do
         base_path = File.expand_path(File.join(File.dirname(__FILE__), '..'))
-        stub_request(:post, "https://test_sid:test_token@twilix.exotel.in/v1/Accounts/Sms/send").
+        stub_request(:post, "https://test_sid:test_token@twilix.exotel.in/v1/Accounts/#{Exotel.exotel_sid}/Sms/send").
         with(:body => "From=1234&To=4321&Body=Test%20sms"). 
-        to_return(:status=>401, :body => 'Authentication is required to view this page.')
+        to_return(:status => 401, :body => 'Authentication is required to view this page.')
+      end
+      
+      it "should return the response object" do
+        sms = Exotel::Sms.new
+        proc{sms.send(:from => '1234', :to => '4321', :body => 'Test sms')}.
+            must_raise Exotel::AuthenticationError
+      end
+    end
+  end
+  
+  describe '#details' do
+    describe 'success' do
+      before do
+        base_path = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+        stub_request(:get, "https://test_sid:test_token@twilix.exotel.in/v1/Accounts/#{Exotel.exotel_sid}/Sms/Messages/SM872fb94e3b358913777cdb313f25b46f").
+        to_return(:status => 200, :body => File.new(base_path + '/fixtures/sms.xml'))
+      end
+    
+      it "should return the response object" do
+        sms = Exotel::Sms.new
+        response = sms.details('SM872fb94e3b358913777cdb313f25b46f')
+        response.class.must_equal Exotel::Response
+      end
+      
+      it "should set the response object values" do
+        sms = Exotel::Sms.new
+        response = sms.details('SM872fb94e3b358913777cdb313f25b46f')
+        response.sid.must_equal 'SM872fb94e3b358913777cdb313f25b46f'
+        response.date_created.must_equal 'Sun, 09 Dec 2012 03:48:08'
+        response.date_updated.must_equal 'Sun, 09 Dec 2012 03:48:10' 
+        response.date_sent.must_equal  'Sun, 09 Dec 2012 03:48:10'
+        response.status.must_equal 'sent'
+        response.to.must_equal '4321'
+        response.from.must_equal '1234'
+        response.body.must_equal 'Test sms'
+      end
+    end 
+    
+    describe 'autentication failed' do
+      before do
+        base_path = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+        stub_request(:get, "https://test_sid:test_token@twilix.exotel.in/v1/Accounts/#{Exotel.exotel_sid}/Sms/Messages/SM872fb94e3b358913777cdb313f25b46f").
+        to_return(:status => 401, :body => 'Authentication is required to view this page.')
       end
       
       it "should return the response object" do
-        sms = Exotel::Sms.new(from: '1234', to: '4321', body: 'Test sms')
-        proc{sms.send}.must_raise Exotel::AuthenticationError
+        sms = Exotel::Sms.new
+        proc{sms.details('SM872fb94e3b358913777cdb313f25b46f')}.
+            must_raise Exotel::AuthenticationError
       end
     end
   end

metadata

@@ -1,11 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: exotel
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  version: "0.1"
+  prerelease: 
+  version: 0.1.1
 platform: ruby
 authors: 
 - Vijendra Rao
@@ -13,8 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-12-09 00:00:00 +05:30
-default_executable: 
+date: 2012-12-21 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: bundler
@@ -24,10 +20,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 0
-        - 0
         version: 1.0.0
   type: :development
   version_requirements: *id001
@@ -39,8 +31,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
   type: :development
   version_requirements: *id002
@@ -52,10 +42,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 9
-        - 0
         version: 0.9.0
   type: :runtime
   version_requirements: *id003
@@ -70,7 +56,9 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- .travis.yml
 - Gemfile
+- Gemfile.lock
 - README.md
 - Rakefile
 - exotel.gemspec
@@ -83,7 +71,6 @@ files:
 - test/exotel/sms_test.rb
 - test/fixtures/sms.xml
 - test/helper.rb
-has_rdoc: true
 homepage: https://github.com/vijendra/exotel
 licenses: []
 
@@ -97,23 +84,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 1
-      - 3
-      - 6
       version: 1.3.6
 requirements: []
 
 rubyforge_project: exotel
-rubygems_version: 1.3.7
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Wrapper for exotel api