exotel 0.1.1 → 0.2

data/.travis.yml

@@ -4,4 +4,4 @@ rvm:
   - 1.8.7
   - 1.9.2
   - 1.9.3
-  - ree
+  #- ree

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    exotel (0.1)
+    exotel (0.2)
       httparty (>= 0.9.0)
 
 GEM
@@ -9,11 +9,14 @@ GEM
   specs:
     addressable (2.3.2)
     crack (0.3.1)
-    httparty (0.9.0)
+    httparty (0.10.2)
       multi_json (~> 1.0)
-      multi_xml
+      multi_xml (>= 0.5.2)
+    metaclass (0.0.1)
+    mocha (0.13.0)
+      metaclass (~> 0.0.1)
     multi_json (1.5.0)
-    multi_xml (0.5.1)
+    multi_xml (0.5.2)
     webmock (1.9.0)
       addressable (>= 2.2.7)
       crack (>= 0.1.7)
@@ -24,4 +27,5 @@ PLATFORMS
 DEPENDENCIES
   bundler (>= 1.0.0)
   exotel!
+  mocha
   webmock

data/README.md

@@ -1,30 +1,55 @@
 # 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
+[![Build Status](https://travis-ci.org/vijendra/exotel.png?branch=master)](https://travis-ci.org/vijendra/exotel)  [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/vijendra/exotel)
+
+## Installation
   gem install exotel
 
-======  
-# Usage
-    # Configure authentication keys
+## 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 send SMS**
+  
+    response = Exotel::Sms.send(:from => 'FROM_NUMBER', :to => 'TO_NUMBER', :body => 'MESSAGE BODY')
+    sms_id = response.sid #sid is used to find the delivery status and other details of the message in future.
+    
+  **To get the details/check the delivery status of a sms**
+  
+    sms = Exotel::Sms.details(sms_id)
+    status = response.status
+    date_sent = response.date_sent
     
-    #To get the details
-    sms = Exotel::Sms.new
-    response = sms.details(sms_id)
+  **To connect a customer to an agent in your company**
+  
+    response = Exotel::Call.connect_to_agent(:to => 'Your Exotel Virtual Number', :from => 'The customer phone number that will be called', :caller_id => 'Your Exotel Number', :call_type => 'trans or promo')
+    call_id = response.sid #sid is used to find the details of the call. Ex: Total price of teh call. 
+    
+    For complete details about the parameters refer exotel api doc.
+    http://goo.gl/nx4Tf
+  
+  **To connect a customer to an existing App/Flow**
+  
+    response = Exotel::Call.connect_to_agent(:to => 'Your Exotel Virtual Number', :from => 'The customer phone number that will be called', :caller_id => 'Your Exotel Number', :call_type => 'trans or promo'. :flow_id => 'App/Flow id to be connected')
+    call_id = response.sid #sid is used to find the details of the call. Ex: Total price of teh call. 
+    
+    For complete details about the parameters refer exotel api doc.
+    http://goo.gl/0zxMx
+  
+  **To get the details of a call**
+  
+    sms = Exotel::Call.details(call_id)
+    price = response.price
     status = response.status
-======  
-# Run tests
+    duration = response.duration
+  
+  **DND numbers**  
+  
+    response.status = 'DND'
+    response.message will be some thing like 'Call to ****** cannot be made because of TRAI NDNC regulations'
+   
+## Run tests
   rake test
- 
-======  
-# TODO
-Cover exotel call

data/exotel.gemspec

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

data/lib/exotel.rb

@@ -2,6 +2,7 @@ require 'httparty'
 require 'exotel/version'
 require 'exotel/config'
 require 'exotel/sms'
+require 'exotel/call'
 require 'exotel/response'
 
 module Exotel

data/lib/exotel/call.rb

@@ -0,0 +1,100 @@
+# -*- encoding: utf-8 -*-
+require 'httparty'
+module Exotel
+  class Call
+    include HTTParty
+    base_uri "https://twilix.exotel.in/v1/Accounts"
+    
+    def initialize; end
+    
+    #TODO check if this is a good decision to provide a wrapper.
+    def self.connect_to_flow(params={})
+      self.new.connect_to_flow(params)
+    end
+
+    def self.connect_to_agent(params={})
+      self.new.connect_to_agent(params)
+    end
+    
+    def self.details(params={})
+      self.new.details(params)
+    end
+    
+    def connect_to_flow(params={})
+      if valid?(params, {:type => 'flow'})
+        params = transfrom_params(params, {:type => 'flow'})
+        make_call(params)
+      end
+    end
+    
+    def connect_to_agent(params={})
+      if valid?(params, {:type => 'agent'})
+        params = transfrom_params(params, {:type => 'agent'})
+        make_call(params)
+      end
+    end
+   
+    def details(sid)
+      response = self.class.get("/#{Exotel.exotel_sid}/Calls/#{sid}",  :basic_auth => auth)
+      handle_response(response)
+    end
+    
+    protected
+    
+    def make_call(params)
+      response = self.class.post(URI.escape("/#{Exotel.exotel_sid}/Calls/connect"), {:body => params, :basic_auth => auth })
+      handle_response(response)
+    end
+    
+    def valid?(params, options)
+      mandatory_keys = [:from, :to, :caller_id, :call_type]
+      mandatory_keys << :flow_id if options[:type] == 'flow'
+      
+      unless mandatory_keys.all?{|key| params.keys.include?(key)}
+        raise Exotel::ParamsError, "Missing one or many required parameters." 
+      end 
+      valid_call_type?(params)
+      return true  
+    end
+    
+    def valid_call_type?(params)
+      raise Exotel::ParamsError, "Call Type is not valid" unless ['trans', 'promo'].include?(params[:call_type])
+    end
+    
+    def auth
+      {:username => Exotel.exotel_sid, :password => Exotel.exotel_token}
+    end
+    
+    def flow_url(flow_id)
+      "http://my.exotel.in/exoml/start/#{flow_id}"
+    end
+    
+    def transfrom_params(params, options)
+      if options[:type] == 'flow'
+        #Construct flow url and delete flow_id.
+        params = params.merge(:URL => flow_url(params[:flow_id]))
+        params.delete(:flow_id)
+      end
+        
+      #Keys are converted to camelcase
+      params.inject({}){ |h, (key, value)| h[camelcase_key(key)] = value; h }
+    end
+    
+    def camelcase_key(key)
+      key.to_s.split('_').map(&:capitalize).join.to_sym #Input: call_type, Output: :CallType
+    end
+    
+    def handle_response(response)
+      case response.code.to_i
+ 	    when 200...300 then Exotel::Response.new(response)
+      when 401 then raise Exotel::AuthenticationError, "#{response.body} Verify your sid and token." 
+      when 403 then Exotel::Response.new(response)
+ 	    else
+ 	      raise Exotel::UnexpectedError, response.body
+ 	    end
+    end
+  end
+end  
+
+
+

data/lib/exotel/config.rb

@@ -10,6 +10,8 @@ module Exotel
   class AuthenticationError < StandardError;  end
 
   class UnexpectedError < StandardError;  end
+
+  class ParamsError < StandardError;  end
 end
 
 

data/lib/exotel/response.rb

@@ -1,21 +1,45 @@
 # -*- encoding: utf-8 -*-
 module Exotel
   class Response
-    attr_accessor :sid, :date_created, :date_updated, :status, :date_sent, :to, :from, :body
     
     def initialize(response)
       #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']
-      @status       = sms['Status']
-      @date_sent    = sms['DateSent']
-      @to           = sms['To']
-      @from         = sms['From']
-      @body         = sms['Body']
+      response_base = response['TwilioResponse']
+      unless response_base.include?('RestException')
+        set_response_data(response_base)
+      else
+        set_response_error(response_base)
+      end
+    end
+    
+    def set_response_data(response_base)
+      (response_base['Call'] or response_base['SMSMessage']).each do |key, value|
+        set_variable(key, value)
+      end
+    end
+    
+    def set_response_error(response_base)
+      response_base['RestException'].each do |key, value|
+        set_variable(key, value)
+        instance_variable_set('@status', 'DND') #Override
+      end
+    end
+    
+    def set_variable(key, value)
+      attr_name = underscore_format(key)
+      self.class.send(:attr_accessor, attr_name) #Set accessors dynamically
+      instance_variable_set("@#{attr_name}", value)
+    end
+    
+    protected
+ 
+    #TODO: CamelCase to underscore: check if we have to add this to string class.
+    def underscore_format(string)
+      string.gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+      gsub(/([a-z\d])([A-Z])/,'\1_\2').
+      tr("-", "_").
+      downcase
     end
   end
 end

data/lib/exotel/sms.rb

@@ -5,14 +5,22 @@ module Exotel
     include HTTParty
     base_uri "https://twilix.exotel.in/v1/Accounts"
     
-    def initialize
+    def initialize; end
+    
+    def self.send(params={})
+      self.new.send(params)
+    end
+    
+    def self.details(params={})
+      self.new.details(params)
     end
     
     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)
+      if valid?(params)
+        params = transfrom_params(params)
+        response = self.class.post("/#{Exotel.exotel_sid}/Sms/send",  {:body => params, :basic_auth => auth })
+        handle_response(response)
+      end  
     end
    
     def details(sid)
@@ -22,6 +30,19 @@ module Exotel
     
     protected
     
+    def valid?(params)
+      unless [:from, :to, :body].all?{|key| params.keys.include?(key)}
+        raise Exotel::ParamsError, "Missing one or many required parameters." 
+      else
+        true  
+      end 
+    end
+    
+    def transfrom_params(params)
+      #Keys are converted to camelcase
+      params.inject({}){ |h, (key, value)| h[key.to_s.capitalize.to_sym] = value; h }
+    end
+    
     def auth
       {:username => Exotel.exotel_sid, :password => Exotel.exotel_token}
     end

data/lib/exotel/version.rb

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

data/test/exotel/call_test.rb

@@ -0,0 +1,105 @@
+require 'helper'
+
+describe Exotel::Call do
+  it 'should have a version' do
+    Exotel::Call.must_include HTTParty
+  end
+  
+  it 'should have the correct base_uri' do
+    Exotel::Call.base_uri.must_equal "https://twilix.exotel.in/v1/Accounts"
+  end
+  
+  describe '.connect_to_flow' do
+    before do
+      @params = {:from => '01234', :to => '04321', :caller_id => '04321', :call_type => 'trans', :flow_id => '3432'}
+    end
+    
+    it "should pass the call to an object" do
+      Exotel::Call.any_instance.expects(:connect_to_flow)
+      Exotel::Call.connect_to_flow
+    end
+    
+    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/#{Exotel.exotel_sid}/Calls/connect").
+        with(:body => {:From => '01234', :To => '04321', :CallerId => '04321', :CallType => 'trans', :Url => 'http://my.exotel.in/exoml/start/3432' }). 
+        to_return(:status => 200, :body => File.new(base_path + '/fixtures/call.xml'))
+      end
+    
+      it "should return the response object" do
+        call = Exotel::Call.new
+        response = call.connect_to_flow(@params)
+        response.class.must_equal Exotel::Response
+      end
+      
+      it "should set the response object values" do
+        call = Exotel::Call.new
+        response = call.connect_to_flow(@params)
+        response.sid.must_equal 'CAe1644a7eed5088b159577c5802d8be38'
+        response.date_created.must_equal 'Tue, 10 Aug 2010 08:02:17'
+        response.date_updated.must_equal 'Tue, 10 Aug 2010 08:02:47' 
+        response.start_time.must_equal  'Tue, 10 Aug 2010 08:02:31 +0000'
+        response.end_time.must_equal  'Tue, 10 Aug 2010 08:02:47 +0000'
+        response.status.must_equal 'completed'
+        response.from.must_equal '01234'
+        response.to.must_equal '04321'
+      end
+    end 
+    
+    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/#{Exotel.exotel_sid}/Calls/connect").
+        with(:body => {:From => '01234', :To => '04321', :CallerId => '04321', :CallType => 'trans', :Url => 'http://my.exotel.in/exoml/start/3432'}).
+        to_return(:status => 401, :body => 'Authentication is required to view this page.')
+      end
+      
+      it "should raise the authentication error" do
+        call = Exotel::Call.new
+        proc{call.connect_to_flow(@params)}.
+            must_raise Exotel::AuthenticationError
+      end
+    end
+
+    describe 'missing parameters' do
+      before do
+        @call = Exotel::Call.new
+      end
+      
+      [:from, :to, :caller_id, :call_type, :flow_id].each do |param|
+        it "should raise the missing params error when #{param} is missing" do
+          @params.delete(param)
+          proc{@call.connect_to_flow(@params)}.must_raise Exotel::ParamsError
+        end
+      end
+
+       it "should raise the params exception for invalid :call_type" do
+         @params[:call_type] = 'invalid'
+         proc{@call.connect_to_flow(@params)}.must_raise Exotel::ParamsError
+      end
+    end
+  end   
+  
+  describe '#details' 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}/Calls/CAe1644a7eed5088b159577c5802d8be38").
+      to_return(:status => 200, :body => File.new(base_path + '/fixtures/call.xml'))
+    end
+    
+    it "should return the response object" do
+      response = Exotel::Call.details('CAe1644a7eed5088b159577c5802d8be38')
+      response.class.must_equal Exotel::Response
+    end
+      
+    it "should set the response object values" do
+      response = Exotel::Call.details('CAe1644a7eed5088b159577c5802d8be38')
+      response.sid.must_equal 'CAe1644a7eed5088b159577c5802d8be38'
+      response.status.must_equal 'completed'
+      response.price.must_equal '2.3'
+    end
+  end  
+  
+end
+

data/test/exotel/sms_test.rb

@@ -23,7 +23,7 @@ describe Exotel::Sms 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/#{Exotel.exotel_sid}/Sms/send").
-        with(:body => "From=1234&To=4321&Body=Test%20sms"). 
+        with(:body => {:From => '1234', :To => '4321', :Body => 'Test sms'}). 
         to_return(:status => 200, :body => File.new(base_path + '/fixtures/sms.xml'))
       end
     
@@ -51,16 +51,36 @@ describe Exotel::Sms 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/#{Exotel.exotel_sid}/Sms/send").
-        with(:body => "From=1234&To=4321&Body=Test%20sms"). 
+        with(:body => {:From => '1234', :To => '4321', :Body => 'Test sms'}). 
         to_return(:status => 401, :body => 'Authentication is required to view this page.')
       end
       
-      it "should return the response object" do
+      it "should raise the authentication error" do
         sms = Exotel::Sms.new
         proc{sms.send(:from => '1234', :to => '4321', :body => 'Test sms')}.
             must_raise Exotel::AuthenticationError
       end
     end
+    
+    describe 'missing parameters' do
+      it "should raise the missing params error when :from is missing" do
+        sms = Exotel::Sms.new
+        proc{sms.send(:to => '4321', :body => 'Test sms')}.
+            must_raise Exotel::ParamsError
+      end
+      
+      it "should raise the missing params error when :to is missing" do
+        sms = Exotel::Sms.new
+        proc{sms.send(:from => '1234', :body => 'Test sms')}.
+            must_raise Exotel::ParamsError
+      end
+      
+      it "should raise the missing params error when :body is missing" do
+        sms = Exotel::Sms.new
+        proc{sms.send(:to => '4321', :from => '1234')}.
+            must_raise Exotel::ParamsError
+      end
+    end
   end
   
   describe '#details' do
@@ -98,7 +118,7 @@ describe Exotel::Sms do
         to_return(:status => 401, :body => 'Authentication is required to view this page.')
       end
       
-      it "should return the response object" do
+      it "should raise the authentication error" do
         sms = Exotel::Sms.new
         proc{sms.details('SM872fb94e3b358913777cdb313f25b46f')}.
             must_raise Exotel::AuthenticationError

data/test/fixtures/call.xml

@@ -0,0 +1,28 @@
+<TwilioResponse>
+    <Call>
+        <Sid>CAe1644a7eed5088b159577c5802d8be38</Sid>
+        <DateCreated>Tue, 10 Aug 2010 08:02:17</DateCreated>
+        <DateUpdated>Tue, 10 Aug 2010 08:02:47</DateUpdated>
+        <ParentCallSid/>
+        <AccountSid>AC5ea872f6da5a21de157d80997a64bd33</AccountSid>
+        <To>04321</To>
+        <From>01234</From>
+        <PhoneNumberSid></PhoneNumberSid>
+        <Status>completed</Status>
+        <StartTime>Tue, 10 Aug 2010 08:02:31 +0000</StartTime>
+        <EndTime>Tue, 10 Aug 2010 08:02:47 +0000</EndTime>
+        <Duration>16</Duration>
+        <Price>2.3</Price>
+        <Flags>
+            <Flag>outbound-api</Flag>
+        </Flags>
+        <ApiVersion>2008-08-01</ApiVersion>
+        <ForwardedFrom/>
+        <CallerName/>
+        <Uri>/2010-04-01/Accounts/AC5ea872f6da5a21de157d80997a64bd33/Calls/CAe1644a7eed5088b159577c5802d8be38</Uri>
+        <SubresourceUris>
+            <Notifications>/2010-04-01/Accounts/AC5ea872f6da5a21de157d80997a64bd33/Calls/CAe1644a7eed5088b159577c5802d8be38/Notifications</Notifications>
+            <Recordings>/2010-04-01/Accounts/AC5ea872f6da5a21de157d80997a64bd33/Calls/CAe1644a7eed5088b159577c5802d8be38/Recordings</Recordings>
+        </SubresourceUris>
+    </Call>
+</TwilioResponse>

data/test/fixtures/call_dnd.xml

@@ -0,0 +1,6 @@
+<TwilioResponse>
+ <RestException>
+  <Status>403</Status>
+  <Message>Call to [01234] cannot be made because of TRAI NDNC regulations</Message>
+ </RestException>
+</TwilioResponse>

data/test/helper.rb

@@ -1,6 +1,7 @@
 require 'minitest/spec'
 require 'minitest/autorun'
 require 'webmock/minitest'
+require "mocha/setup"
 require 'exotel'
 
 Exotel.configure do |c|

metadata

@@ -2,7 +2,7 @@
 name: exotel
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.1
+  version: "0.2"
 platform: ruby
 authors: 
 - Vijendra Rao
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-12-21 00:00:00 Z
+date: 2013-02-23 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: bundler
@@ -35,16 +35,27 @@ dependencies:
   type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: httparty
+  name: mocha
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
         version: 0.9.0
   type: :runtime
-  version_requirements: *id003
+  version_requirements: *id004
 description: Exotel api wrapper.
 email: 
 - vijendrakarkala@gmail.com
@@ -63,12 +74,16 @@ files:
 - Rakefile
 - exotel.gemspec
 - lib/exotel.rb
+- lib/exotel/call.rb
 - lib/exotel/config.rb
 - lib/exotel/response.rb
 - lib/exotel/sms.rb
 - lib/exotel/version.rb
+- test/exotel/call_test.rb
 - test/exotel/exotel_test.rb
 - test/exotel/sms_test.rb
+- test/fixtures/call.xml
+- test/fixtures/call_dnd.xml
 - test/fixtures/sms.xml
 - test/helper.rb
 homepage: https://github.com/vijendra/exotel