call_center 0.0.2 → 0.0.3

data/README.md

@@ -20,7 +20,7 @@ Terminology
 -----------
 
 * **Call** - An application resource of yours that encapsulates a phone call. Phone calls are then acted on: answered, transferred, declined, etc.
-* **Event** - Is something that happens outside or inside your application in relation to a **Call**. Someone picks up, hangs up, presses a button, etc.
+* **Event** - Is something that happens outside or inside your application in relation to a **Call**. Someone picks up, hangs up, presses a button, etc. But overall, it's anything that can be triggered by Twilio callbacks.
 * **State** - Is the status a **Call** is in which is descriptive of what's happened so far and what are the next things that should happen. (e.g. a call on hold is waiting for the agent to return)
 * **CallFlow** - Is a definition of the process a **Call** goes through. **Events** drive the flow between **States**. (e.g. a simple workflow is when noone answers the call, send the call to voicemail)
 * **Render** - Is the ability of the **CallFlow** to return TwiML to bring the call into the **State** or modify the live call through a **Redirect**.
@@ -56,7 +56,7 @@ Usage
       end
     end
 
-Benefits of **CallCenter** is that it's backed by [state_machine](https://github.com/pluginaweek/state_machine). Which means you can interact with events the same you do in state_machine.
+Benefits of **CallCenter** is that it's backed by [state_machine](https://github.com/pluginaweek/state_machine). Which means you can interact with events the same you do in `state_machine`.
 
     @call.incoming_call!
     @call.voicemail?
@@ -79,6 +79,18 @@ The general application flow for a **CallFlow** is like this:
    * You respond by rendering TwiML. Your TwiML contains callbacks to events or redirects
 3. Repeat 2.
 
+In order to DRY up the callbacks, it is best to have use standardized callback URLs. A handy concept is the `flow_url`, which follows the pattern:
+
+    http://domain.com/calls/flow?call_id=?&event=?
+
+By handling this in your controller, you can immediately retrieve the **Call** from persistence, run an event on the call, and return the rendered TwiML. Here's an example:
+
+    def flow
+      render :xml => @call.run(params[:event])
+    end
+
+For an in-depth example, take a look at [call_roulette](https://github.com/zendesk/call_roulette).
+
 Rendering
 ---------
 
@@ -86,12 +98,12 @@ Rendering is your way of interacting with Twilio. Thus, it provides two faciliti
 
     on_render(:sales) do |the_call, xml_builder|
       xml_builder.Say "This is Sales!"
-      
+
       the_call.flag! # You can access the call explicitly
       flag!          # Or access it implicitly
     end
 
-Renders:
+Renders with `@call.render` if the current state is :sales:
 
     <?xml version="1.0" encoding="UTF-8"?>
     <Response>

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/call_center.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{call_center}
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Henry Hsu"]
-  s.date = %q{2011-09-21}
+  s.date = %q{2011-09-29}
   s.description = %q{Support for describing call center workflows}
   s.email = %q{hhsu@zendesk.com}
   s.extra_rdoc_files = [

data/lib/call_center/test/dsl.rb

@@ -2,6 +2,7 @@ module CallCenter
   module Test
     module DSL
       def self.included(base)
+        base.send(:include, ActionController::Assertions::SelectorAssertions)
         base.extend(ClassMethods)
         base.class_eval do
           def response_from_page_or_rjs_with_body
@@ -21,7 +22,7 @@ module CallCenter
           event = options.delete(:on)
           setup_block = options.delete(:when)
           setup_block_line = setup_block.to_s.match(/.*@(.*):([0-9]+)>/)[2] if setup_block
-          state_field = options.delete(:state) || :state
+          state_field = self.call_center_state_field || options.delete(:state) || :state
           from, to = options.to_a.first
           description = ":#{from} => :#{to} via #{event}!#{setup_block_line.present? ? " when:#{setup_block_line}" : nil}"
           context "" do
@@ -47,6 +48,10 @@ module CallCenter
           end
         end
 
+        def call_center_state_field(field = nil)
+          field.nil? ? @_call_center_state_field : (@_call_center_state_field = field)
+        end
+
         def should_also(&block)
           line = block.to_s.match(/.*@(.*):([0-9]+)>/)[2]
           should "also satisfy block on line #{line}" do

data/test/helper.rb

@@ -20,8 +20,6 @@ require 'active_support'
 require 'action_pack'
 require 'action_controller'
 class Test::Unit::TestCase
-  include ActionController::Assertions::SelectorAssertions
-
   def response_from_page_or_rjs
     HTML::Document.new(@body).root
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: call_center
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Henry Hsu
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-21 00:00:00 -07:00
+date: 2011-09-29 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency