exotel_api 0.5.6 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: da142fb4d136ef153225277bad396dae3cb76ecd
-  data.tar.gz: fd5d01f94697116b3c83585cc72073a08b0a1c0d
+  metadata.gz: 779e025eb3f0db01bfe0e54bcc581e4fbd1b2ff5
+  data.tar.gz: 3c1ba244ca13984dc513aaf3645e78b72fdc544c
 SHA512:
-  metadata.gz: e556c082d558160bd243495b30cbf9a7afce250ce7f9e87969a454b811e7531e4a3bb889f2eae52d19a07bba031613a3c7b4b05859f960bda25731931bea5fc6
-  data.tar.gz: 51419f09b9bd37dbd8b6262b48547a5dcdeeebd74d3fc24c2193103d4ab58569f6a425a8529bcef06ec2634944190df7a4aac4c7c7886686e7cd96dff549dc47
+  metadata.gz: d0d4270095e19af98e8e04b524a9d93eb8e58ebb6acc1320edafc701a3be00daf11ccf3953a870c3024002d2538b6691f92455a334f2b9870f95ff43dce260ab
+  data.tar.gz: 35d78aaca1d821da9bd9ac91c70d419d451dea0af418f36f3d73228eddaa746795cd13f574b60cb7ae3f8bfd2ab6ed2f1178589db87ec774139fb7df0e3d6dba

data/app/controllers/exotel_api/call_controller.rb

@@ -1,19 +1,6 @@
 module ExotelApi
   class CallController < StartController
-    #response - greeting,menu,connect
-    def start
-      begin
-        _call = direction
-        if _call.present?
-          applet = "{\"select\":\"#{_call.start(params)}\"}" if defined?(_call.start)
-        end
-      rescue => e
-        logger.error e.message
-        logger.error e.backtrace.join("\n")
-      end
-      render :plain => applet, content_type: "text/html", status: 200
-    end
-    #response - list of URLS
+    #response - audio file or list of URLS of audio files
     def greeting
       begin
         _call = direction
@@ -26,7 +13,7 @@ module ExotelApi
       end
       render :plain => urls, content_type: "text/plain", :status => 200
     end
-    #response - menu,connect
+    #response - switch case ivr_menu, hangup
     def after_greeting
       begin
         _call = direction
@@ -39,25 +26,25 @@ module ExotelApi
       end
       render :plain => applet, content_type: "text/html", status: 200
     end
-    #response - phone
-    def connect
+    #response - audio file or list of URLS of audio files
+    def ivr_menu
       begin
         _call = direction
         if _call.present?
-          phones = _call.connect if defined?(_call.connect)
+          urls = _call.ivr_menu(params) if defined?(_call.ivr_menu)
         end
       rescue => e
         logger.error e.message
         logger.error e.backtrace.join("\n")
       end
-      render :plain => phones, content_type: "text/plain", :status => 200
+      render :plain => urls, content_type: "text/plain", :status => 200
     end
-    #response - nil
-    def finish
+    #response - status 200 and plain ''
+    def keypress
       begin
         _call = direction
         if _call.present?
-          _call.finish(params) if defined?(_call.finish)
+          _call.keypress(params) if defined?(_call.keypress)
         end
       rescue => e
         logger.error e.message
@@ -65,62 +52,57 @@ module ExotelApi
       end
       render :plain => '', content_type: "text/plain", :status => 200
     end
-    #response - list of URLS
-    def menu
+    #response - audio file or list of URLs of audio files
+    def after_keypress
       begin
         _call = direction
         if _call.present?
-          urls = _call.menu(params) if defined?(_call.menu)
+          urls = _call.after_keypress(params) if defined?(_call.after_keypress)
         end
       rescue => e
         logger.error e.message
         logger.error e.backtrace.join("\n")
       end
-      render :plain => urls, content_type: "text/plain", :status => 200
+      render :plain => urls, content_type: "text/plain", status: 200
     end
-    #response - nil
-    def dtmf
+    #response - switch case ivr_menu, hangup
+    def after_keypress_greeting
       begin
         _call = direction
         if _call.present?
-          _call.dtmf_key(params) if defined?(_call.dtmf_key)
+          applet = "{\"select\":\"#{_call.after_keypress_greeting(params)}\"}" if defined?(_call.after_keypress_greeting)
         end
       rescue => e
         logger.error e.message
         logger.error e.backtrace.join("\n")
       end
-      render :plain => '', content_type: "text/plain", :status => 200
+      render :plain => applet, content_type: "text/html", status: 200
     end
-    #response - greeting,connect
-    def after_dtmf
+    #response - status 200, 404 or 302 and plain ''
+    def play_again
       begin
         _call = direction
         if _call.present?
-          applet = "{\"select\":\"#{_call.after_dtmf(params)}\"}" if defined?(_call.after_dtmf)
+          applet = "{\"select\":\"#{_call.play_again(params)}\"}" if defined?(_call.play_again)
         end
       rescue => e
         logger.error e.message
         logger.error e.backtrace.join("\n")
       end
-      render :plain => applet, content_type: "text/html", status: 200
+      render :plain => applet, content_type: "text/plain", :status => 200
     end
-    #response - status code 200,302
-    def repeat
+    #response - status 200 and plain ''
+    def finish
       begin
         _call = direction
         if _call.present?
-          answer = _call.play_again(params) if defined?(_call.play_again)
-          if answer == 'yes'
-            status = '200'
-          else
-            status = '302'
-          end
+          _call.finish(params) if defined?(_call.finish)
         end
       rescue => e
         logger.error e.message
         logger.error e.backtrace.join("\n")
       end
-      render :plain => '', content_type: "text/plain", :status => status
+      render :plain => '', content_type: "text/plain", :status => 200
     end
   end
 end

data/config/routes.rb

@@ -1,41 +1,14 @@
 Rails.application.routes.draw do
   namespace :exotel_api do
-    namespace :ivr do
-      namespace :call do
-        get 'greeting_and_menu'
-        get 'dtmf'
-        get 'closing'
-        get 'repeat'
-        post 'status'
-      end
-    end
-
     namespace :call do
-      get 'start'
       get 'greeting'
       get 'after_greeting'
-      namespace :after_greeting do
-        get 'connect'
-        namespace :connect do
-          get 'status'
-        end
-      end
-      get 'connect'
-      namespace :connect do
-        get 'status'
-      end
+      get 'ivr_menu'
+      get 'keypress'
+      get 'after_keypress'
+      get 'after_keypress_greeting'
+      get 'play_again'
       post 'finish'
-      get 'menu'
-      get 'dtmf'
-      get 'after_dtmf'
-      namespace :after_dtmf do
-        get 'greeting'
-        get 'after_greeting'
-        namespace :connect do
-          get 'status'
-        end
-      end
-      get 'repeat'
     end
   end
 end

data/lib/exotel_api/call.rb

@@ -0,0 +1,109 @@
+# -*- encoding: utf-8 -*-
+require 'httparty'
+module ExotelApi
+  class Call
+    include HTTParty
+    base_uri "https://twilix.exotel.in/v1/Accounts"
+    default_timeout 10
+    
+    def initialize; end
+  
+    #TODO check if this is a good decision to provide a wrapper.
+    def self.shoot(params={})
+      self.new.shoot(params)
+    end
+    
+    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 shoot(params={})
+      if valid?(params, {:type => 'flow'})
+        params = transfrom_params(params, {:type => 'flow'})
+        make_call(params)
+      end
+    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("/#{ExotelApi.exotel_sid}/Calls/#{sid}",  :basic_auth => auth)
+      handle_response(response)
+    end
+  
+    protected
+  
+    def make_call(params)
+      response = self.class.post(URI.escape("/#{ExotelApi.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 ExotelApi::ParamsError, "Missing one or many required parameters." 
+      end 
+      valid_call_type?(params)
+      return true  
+    end
+  
+    def valid_call_type?(params)
+      raise ExotelApi::ParamsError, "Call Type is not valid" unless ['trans', 'promo'].include?(params[:call_type])
+    end
+  
+    def auth
+      {:username => ExotelApi.exotel_sid, :password => ExotelApi.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 ExotelApi::Response.new(response)
+      when 401 then raise ExotelApi::AuthenticationError, "#{response.body} Verify your sid and token." 
+      when 403 then ExotelApi::Response.new(response)
+      else
+        raise ExotelApi::UnexpectedError, response.body
+      end
+    end
+  end
+end

data/lib/exotel_api/version.rb

@@ -1,3 +1,3 @@
 module ExotelApi
-  VERSION = "0.5.6"
+  VERSION = "0.6.1"
 end

data/lib/exotel_api.rb

@@ -6,7 +6,7 @@ require 'exotel_api/engine'
 require 'exotel_api/config'
 require 'exotel_api/response'
 require 'exotel_api/metadata'
-require 'exotel_api/ivr/call'
+require 'exotel_api/call'
 
 module ExotelApi
   # Your code goes here...

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: exotel_api
 version: !ruby/object:Gem::Version
-  version: 0.5.6
+  version: 0.6.1
 platform: ruby
 authors:
 - Aashutosh Chaudhary
@@ -116,22 +116,16 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- app/controllers/exotel_api/call/after_dtmf/connect_controller.rb
-- app/controllers/exotel_api/call/after_dtmf_controller.rb
-- app/controllers/exotel_api/call/after_greeting/connect_controller.rb
-- app/controllers/exotel_api/call/after_greeting_controller.rb
-- app/controllers/exotel_api/call/connect_controller.rb
 - app/controllers/exotel_api/call_controller.rb
-- app/controllers/exotel_api/ivr/call_controller.rb
 - app/controllers/exotel_api/start_controller.rb
 - bin/console
 - bin/setup
 - config/routes.rb
 - exotel_api.gemspec
 - lib/exotel_api.rb
+- lib/exotel_api/call.rb
 - lib/exotel_api/config.rb
 - lib/exotel_api/engine.rb
-- lib/exotel_api/ivr/call.rb
 - lib/exotel_api/metadata.rb
 - lib/exotel_api/response.rb
 - lib/exotel_api/version.rb

data/app/controllers/exotel_api/call/after_dtmf/connect_controller.rb

@@ -1,21 +0,0 @@
-module ExotelApi
-  module Call
-    module AfterDtmf
-      class ConnectController < StartController
-        #response - nil
-        def status
-          begin
-            _call = direction
-            if _call.present?
-              _call.status(params) if defined?(_call.status)
-            end
-          rescue => e
-            logger.error e.message
-            logger.error e.backtrace.join("\n")
-          end
-          render :plain => '', content_type: "text/plain", :status => 200
-        end
-      end
-    end
-  end
-end

data/app/controllers/exotel_api/call/after_dtmf_controller.rb

@@ -1,45 +0,0 @@
-module ExotelApi
-  module Call
-    class AfterDtmfController < StartController
-      #response - list of URLs
-      def greeting
-        begin
-          _call = direction
-          if _call.present?
-            urls = _call.greeting(params) if defined?(_call.greeting)
-          end
-        rescue => e
-          logger.error e.message
-          logger.error e.backtrace.join("\n")
-        end
-        render :plain => urls, content_type: "text/plain", :status => 200
-      end
-      #response - menu
-      def after_greeting
-        begin
-          _call = direction
-          if _call.present?
-            applet = "{\"select\":\"#{_call.after_greeting(params)}\"}" if defined?(_call.after_greeting)
-          end
-        rescue => e
-          logger.error e.message
-          logger.error e.backtrace.join("\n")
-        end
-        render :plain => applet, content_type: "text/html", status: 200
-      end
-      #response - phones
-      def connect
-        begin
-          _call = direction
-          if _call.present?
-            phones = _call.connect if defined?(_call.connect)
-          end
-        rescue => e
-          logger.error e.message
-          logger.error e.backtrace.join("\n")
-        end
-        render :plain => phones, content_type: "text/plain", :status => 200
-      end
-    end
-  end
-end

data/app/controllers/exotel_api/call/after_greeting/connect_controller.rb

@@ -1,21 +0,0 @@
-module ExotelApi
-  module Call
-    module AfterGreeting
-      class ConnectController < StartController
-        #response - nil
-        def status
-          begin
-            _call = direction
-            if _call.present?
-              _call.status(params) if defined?(_call.status)
-            end
-          rescue => e
-            logger.error e.message
-            logger.error e.backtrace.join("\n")
-          end
-          render :plain => '', content_type: "text/plain", :status => 200
-        end
-      end
-    end
-  end
-end

data/app/controllers/exotel_api/call/after_greeting_controller.rb

@@ -1,19 +0,0 @@
-module ExotelApi
-  module Call
-    class AfterGreetingController < StartController
-      #response - phone
-      def connect
-        begin
-          _call = direction
-          if _call.present?
-            phones = _call.connect if defined?(_call.connect)
-          end
-        rescue => e
-          logger.error e.message
-          logger.error e.backtrace.join("\n")
-        end
-        render :plain => phones, content_type: "text/plain", :status => 200
-      end
-    end
-  end
-end

data/app/controllers/exotel_api/call/connect_controller.rb

@@ -1,19 +0,0 @@
-module ExotelApi
-  module Call
-    class ConnectController < StartController
-      #response - nil
-      def status
-        begin
-          _call = direction
-          if _call.present?
-            _call.status(params) if defined?(_call.status)
-          end
-        rescue => e
-          logger.error e.message
-          logger.error e.backtrace.join("\n")
-        end
-        render :plain => '', content_type: "text/plain", :status => 200
-      end
-    end
-  end
-end

data/app/controllers/exotel_api/ivr/call_controller.rb

@@ -1,86 +0,0 @@
-module ExotelApi
-  class Ivr::CallController < ApplicationController
-    skip_before_action  :verify_authenticity_token, raise: false
-    def greeting_and_menu
-      begin
-        _call = direction
-        if _call.present?
-          _call.update(status: 'completed')
-          urls = _call.greeting_and_menu if defined?(_call.greeting_and_menu)
-        end
-      rescue => e
-        logger.error e.message
-        logger.error e.backtrace.join("\n")
-      end
-      render :plain => urls, content_type: "text/plain", :status => 200
-    end
-
-    def dtmf
-      begin
-        _call = direction
-        if _call.present?
-          _call.update(dtmf: params[:digits].parameterize.to_i)
-          _call.dtmf_callback(params) if defined?(_call.dtmf_callback)
-        end
-      rescue => e
-        logger.error e.message
-        logger.error e.backtrace.join("\n")
-      end
-      render :plain => '', content_type: "text/plain", :status => 200
-    end
-
-    def closing
-      begin
-        _call = direction
-        urls = _call.closing if _call.present? and defined?(_call.closing)
-      rescue => e
-        logger.error e.message
-        logger.error e.backtrace.join("\n")
-      end
-      render :plain => urls, content_type: "text/plain", :status => 200
-    end
-
-    def status
-      begin
-        _call = direction
-        if _call.present?
-          _call.update(status: params[:Status])
-          _call.status_callback(params) if defined?(_call.status_callback)
-        end
-      rescue => e
-        logger.error e.message
-        logger.error e.backtrace.join("\n")
-      end
-      render :plain => '', content_type: "text/plain", :status => 200
-    end
-
-    def repeat
-      begin
-        _call = direction
-        if _call.present?
-          status = _call.repeat_callback(params) if defined?(_call.repeat_callback)
-        end
-      rescue => e
-        logger.error e.message
-        logger.error e.backtrace.join("\n")
-      end
-      render :plain => '', content_type: "text/plain", :status => status
-    end
-
-    private
-    def find_call
-      if params[:CustomField].present?
-        params[:CustomField].titleize.split.join.constantize::Call.find_by_call_sid(params[:CallSid])
-      else
-        eval(ExotelApi.status_callback_query)
-      end
-    end
-    def direction
-      if params[:Direction] == 'incoming'
-        eval(ExotelApi.inbound_query)
-      else
-        find_call
-      end
-    end
-  end
-end

data/lib/exotel_api/ivr/call.rb

@@ -1,111 +0,0 @@
-# -*- encoding: utf-8 -*-
-require 'httparty'
-module ExotelApi
-  module Ivr
-    class Call
-      include HTTParty
-      base_uri "https://twilix.exotel.in/v1/Accounts"
-      default_timeout 10
-      
-      def initialize; end
-    
-      #TODO check if this is a good decision to provide a wrapper.
-      def self.shoot(params={})
-        self.new.shoot(params)
-      end
-      
-      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 shoot(params={})
-        if valid?(params, {:type => 'flow'})
-          params = transfrom_params(params, {:type => 'flow'})
-          make_call(params)
-        end
-      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("/#{ExotelApi.exotel_sid}/Calls/#{sid}",  :basic_auth => auth)
-        handle_response(response)
-      end
-    
-      protected
-    
-      def make_call(params)
-        response = self.class.post(URI.escape("/#{ExotelApi.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 ExotelApi::ParamsError, "Missing one or many required parameters." 
-        end 
-        valid_call_type?(params)
-        return true  
-      end
-    
-      def valid_call_type?(params)
-        raise ExotelApi::ParamsError, "Call Type is not valid" unless ['trans', 'promo'].include?(params[:call_type])
-      end
-    
-      def auth
-        {:username => ExotelApi.exotel_sid, :password => ExotelApi.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 ExotelApi::Response.new(response)
-        when 401 then raise ExotelApi::AuthenticationError, "#{response.body} Verify your sid and token." 
-        when 403 then ExotelApi::Response.new(response)
-        else
-          raise ExotelApi::UnexpectedError, response.body
-        end
-      end
-    end
-  end
-end