ifbyphone_response 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NWJhYWFhOWFjNzY1OTBjODVlNTc0MDE1YTNmMmExMzczNDQwNTIyOQ==
+  data.tar.gz: !binary |-
+    MGViNzQ3MDM5MmFhNWEyNjU2ZjZhZjZlODZlYzQ3NzRlNDMxMDM2Mg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    YTRmYmY2OWRmZjkwM2Y5YTkxNGI1NzIxM2RkMjQ2Y2Q0NDZjNmY2NmNiNDhk
+    ZmQ4MjRkZTNkYTIxNWE4MzhkZGRhMTE0NjRhN2JiNDY1NzYyNzUzOGJiMjgx
+    N2Y3NjQ3OTcxOWViNzE4NGVmZGQ2NDg5NzM2NDY0OWVjOWZhMDE=
+  data.tar.gz: !binary |-
+    MjRmMTU3ZDQ0YjgwMzJlZTJiMDk3OTBhZmZmN2NiNTM3YjI2NDFlOTNjOWNh
+    NTY1NzVjOTI2OWE1NjYxYjEyZmQwNGVjYzQxMmNjYTVkODE1YTVjNTAzYTlm
+    MjVmMTEzM2MzNzY3ZmFjNzQyZDIxYjhkYjVlZDQ2N2ZhNGU1ZDg=

data/README.md

@@ -0,0 +1,39 @@
+Ifbyphone XML Generator
+=======================
+
+[![Build Status](https://travis-ci.org/Opus1no2/Ifbyphone-Responses-Gem.png)](https://travis-ci.org/Opus1no2/Ifbyphone-Responses-Gem)
+ 
+A simple interface for creating valid Ifbyphone XML structures
+
+Installation
+------------
+
+```sh
+gem install ifbypone_response
+```
+
+Usage
+-----
+
+Using the gem is easy:
+
+```ruby
+
+require 'ifbyphone_response'
+
+route = Route.new
+
+# Performa a blind transfer
+route.transfer(952457****)
+
+# Route to an IVR
+route.survo(1234)
+
+# Gracefully end a call
+route.hangup
+
+```
+
+License
+--------
+MIT

data/lib/ifbyphone_response.rb

@@ -0,0 +1,108 @@
+require 'rexml/document'
+
+class Route
+  include REXML
+  
+  # Initialize new dom doc and global elements
+  def initialize 
+    @doc    = Document.new 
+    @action = @doc.add_element('action')
+    @param  = Element.new('parameter')
+  end
+  
+  # Performa a blind transfer
+  #
+  # @param [int] num | transfer number
+  # @return [string]
+  def transfer(num)
+    @action.add_element('app').text = 'transfer'
+    @action.add_element(@param)
+    @param.add_element('destination').text = num
+    return @doc.to_s
+  end
+  
+  # Route a caller to an IVR app
+  #
+  # @param [int] id | IVR ID
+  # @param [hash] usr_param | customer user parameters
+  # @pt [string] | user defined string
+  # @return [string]
+  def survo(id, usr_param={}, pt='') 
+    self.helper('survo', id)
+    
+    if usr_param.any?
+      params = @param.add_element('user_params')
+      usr_param.each do |k,v|
+        params.add_element(k).text = v
+      end  
+    end
+    
+    unless pt.nil?
+      @param.add_element('pt').text = pt
+    end
+    return @doc.to_s
+  end
+  
+  # Route caller to a findme (hunt group) app
+  #
+  # @param [int] id | findme ID
+  # @return [string]
+  def findme(id)
+    self.helper('findme',id)
+    return @doc.to_s
+  end
+  
+  # Dynamically create a hunt group
+  #
+  # @param [array] list | list of transfer numbers
+  # @param [hash] config | additional options
+  # @return [string]
+  def findme_list(list, config={})
+    @action.add_element('app').text = 'findme'
+    @action.add_element(@param)
+    @param.add_element('phone_list').text = list.join('|')
+    
+    if config.any?
+      config.each do |k,v|
+        @param.add_element(k).text = v
+      end
+    end
+    return @doc.to_s
+  end
+  
+  # Route caller to a virtual receptionist
+  #
+  # @param [int] id | VR ID
+  # @return [string]
+  def virtual_receptionist(id)
+    self.helper('vr',id)
+    return @doc.to_s
+  end
+  
+  # Route caller to a voicemail app
+  #
+  # @param [int] int | VM ID
+  # @return [string]
+  def voicemail(id)
+    self.helper('voicemail',id)
+    return @doc.to_s
+  end
+  
+  # Gracefully hangu up a call
+  # 
+  # @return [string]
+  def hangup
+    @action.add_element('app').text = 'hangup'
+    return @doc.to_s
+  end
+  
+  # Convenience method
+  #
+  # @param [string] app
+  # @param [int] id
+  def helper(app, id) 
+    @action.add_element('app').text = app
+    @action.add_element(@param)
+    @param.add_element('id').text = id
+  end
+end

data/spec/ifbyphone_response_spec.rb

@@ -0,0 +1,66 @@
+# encoding: utf-8
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'ifbyphone_response')
+
+describe Route do 
+
+  before(:each) do 
+    @route = Route.new
+  end  
+
+  describe "#hangup" do
+    it 'Should respond with valid xml' do 
+      result = @route.hangup
+      result.should eql '<action><app>hangup</app></action>'
+    end
+  end
+  
+  describe "#transfer" do 
+    it 'should respond with valid xml' do 
+      result = @route.voicemail(1234)
+      result.should == '<action><app>voicemail</app><parameter><id>1234</id></parameter></action>'
+    end
+  end
+  
+  describe "#trasnfer" do 
+    it 'should respond with valid xml' do 
+      result = @route.transfer(1112223333)
+      result.should == '<action><app>transfer</app><parameter><destination>1112223333</destination></parameter></action>'
+    end
+  end
+  
+  describe "#survo" do 
+    it 'should respond with valid xml' do 
+      result = @route.survo(1234, {'foo' => 'bar'}, 'passthrough')
+      result.should == '<action><app>survo</app><parameter><id>1234</id><user_params><foo>bar</foo></user_params><pt>passthrough</pt></parameter></action>'
+    end
+  end
+  
+  describe "#findme" do 
+    it 'should respond with valid xml' do 
+      result = @route.findme(1234)
+      result.should == '<action><app>findme</app><parameter><id>1234</id></parameter></action>'
+    end
+  end
+  
+  describe "#findme_list" do 
+    it 'should respond with valid xml' do 
+      result = @route.findme_list([1112223333, 2223334444], {'nextactionitem' =>  7})
+      result.should == '<action><app>findme</app><parameter><phone_list>1112223333|2223334444</phone_list><nextactionitem>7</nextactionitem></parameter></action>'
+    end
+  end
+  
+  describe "#virtual_receptionist" do 
+    it 'should resond with valid xml' do 
+      result = @route.virtual_receptionist(1234)
+      result.should == '<action><app>vr</app><parameter><id>1234</id></parameter></action>'
+    end
+  end
+  
+  describe "#voicemail" do 
+    it 'should respond wiht valid xml' do 
+      result = @route.voicemail(1234)
+      result.should == '<action><app>voicemail</app><parameter><id>1234</id></parameter></action>'
+    end
+  end
+end

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: ifbyphone_response
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Travis Tillotson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-27 00:00:00.000000000 Z
+dependencies: []
+description: Convenience class that provides an interface for creating valid Ifbyphone
+  XML responses
+email:
+- tillotson.travis@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- lib/ifbyphone_response.rb
+- README.md
+- spec/ifbyphone_response_spec.rb
+homepage: https://github.com/Opus1no2/Ifbyphone-response-Gem
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.4
+signing_key: 
+specification_version: 4
+summary: Interface for creating valid XML responses
+test_files:
+- spec/ifbyphone_response_spec.rb