colloquy 1.0.0

data/examples/config/logger.yaml

@@ -0,0 +1,2 @@
+log_level: debug
+path: log/renderer.log

data/examples/config/messages.yaml

@@ -0,0 +1,3 @@
+more: "More"
+previous: "Previous"
+error_unexpected: "We're facing technical difficulties at this time. Please try again later!"

data/examples/config/mysql.yaml

@@ -0,0 +1,18 @@
+testing:
+  host: 'localhost'
+  username: 'root'
+  password: ''
+  reconnect: true
+  database: 'activations'
+  encoding: 'utf8'
+  adapter: 'em_mysql2'
+  
+customer:
+  host: 'localhost'
+  username: 'root'
+  password: ''
+  reconnect: true
+  database: 'activations'
+  encoding: 'utf8'
+  adapter: 'em_mysql2'
+

data/examples/config/redis.yaml

@@ -0,0 +1,9 @@
+testing:
+  host: localhost
+  
+sessions:
+  host: localhost
+
+state:
+  host: localhost
+

data/examples/config/scribe.yaml

@@ -0,0 +1,2 @@
+testing:
+  schema_uri: "http://s1.mobme.in/itw/schema.yml"

data/examples/config/settings.yaml

@@ -0,0 +1,2 @@
+testing: "/home/mobme/infrastructure/ussd-renderer-redux/examples/config/test.yaml"
+testing_rel: "config/test.yaml"

data/examples/config/test.yaml

@@ -0,0 +1,8 @@
+testing:
+  host: 'localhost'
+  username: 'root'
+  password: ''
+  reconnect: true
+  database: 'activations'
+  encoding: 'utf8'
+  adapter: 'em_mysql2'

data/examples/config/urls.yaml

@@ -0,0 +1,18 @@
+log_cancellations:
+  active: http://google.com/?q=hello
+  backup: http://www.google.com/search?q=%%msisdn%%
+  
+pinger:
+  log_cancellations:
+    verb: get
+    params:
+      msisdn: 9745044399
+  tick: 5
+  
+timeouts:
+  connection: 2
+  inactivity: 5
+
+logger:
+  log_level: debug
+  path: log/urls.log  

data/examples/flows/active_record_flow.rb

@@ -0,0 +1,42 @@
+
+require 'active_record'
+
+require_relative '../models/activations'
+
+class ActiveRecordFlow
+  include Colloquy::FlowParser
+  
+  index {
+    request {
+      menu << :activate << :cancel
+    }
+    
+    process { |input|
+      case menu.key(input)
+      when :activate
+        privileged_user = true
+        if privileged_user
+          if count = activate(headers[:msisdn])
+            notify [:activation_success, :count => count]
+          else
+            notify :activation_failure
+          end
+        else
+          notify :priveleges_required
+        end
+      when :cancel
+        url.call(:log_cancellations, { :msisdn => headers[:msisdn] })
+        notify :canceled
+      end
+    }
+  }
+  
+  def setup
+    ::Activation.establish_connection(mysql.configuration[:customer])
+  end
+  
+  def activate(msisdn)
+    logger.info "Activating #{msisdn}!"
+    count = Activation.count
+  end
+end

data/examples/flows/art_of_war_flow.rb

@@ -0,0 +1,27 @@
+
+class ArtOfWarFlow
+  include Colloquy::FlowParser
+  
+  index {
+    request {
+      session[:hello] = "yellow!"
+      menu.push(
+        :calculator, # to test a swtich
+        :special_redis,
+        :estimates, :waging_war, :offensive_strategy, :dispositions, :energy, 
+        :weaknesses_and_strengths, :manoeuvre, :nine_variables, :marches, 
+        :terrain, :the_nine_varieties_of_ground, :attack_by_fire, 
+        :employment_of_secret_agents
+      )
+    }
+    
+    process { |input|
+      session[:hello] = "world"
+      switch :index, :flow => :calculator if menu.key(input) == :calculator
+      switch :index, :flow => :special_redis if menu.key(input) == :special_redis
+      switch :index, :flow => :unknown if menu.key(input) == :offensive_strategy
+
+      notify "#{menu.key(input)}_notification".to_sym
+    }
+  }
+end

data/examples/flows/calculator_flow.rb

@@ -0,0 +1,71 @@
+
+class CalculatorFlow
+
+  include Colloquy::FlowParser
+  
+  index {
+    request {
+      menu << "Add" << "Subtract" << "Back"
+    }
+    
+    process { |input|
+      session[:operation] = case menu.key(input)
+        when "Add"
+          :add
+        when "Subtract"
+          :subtract
+        when "Back"
+          switch :back
+        else
+          notify :operation_invalid
+        end
+      
+      switch :number_first
+    }
+  }
+  
+  number_first {
+    request {
+      prompt "Enter the first number:"
+    }
+    
+    process { |input|
+      if valid_input? input
+        session[:first_number] = input.to_i
+        switch :number_second
+      else
+        notify :number_invalid
+      end
+    }
+  }
+  
+  number_second {
+    request {
+      prompt "Enter the second number:"
+    }
+    
+    process { |number|
+      if valid_input? number
+        value = calculate(session[:operation], session[:first_number], number.to_i)
+        notify "The result is: #{value}"
+      end
+    }
+  }
+  
+  def calculate(operation, first_number, second_number)
+    case operation
+    when :add
+      first_number + second_number
+    when :subtract
+      first_number - second_number
+    else
+      logger.error "Got an unexpected operation."
+      notify :error
+    end
+  end
+  
+  def valid_input?(number)
+    "#{number.to_i}"
+  end
+end
+

data/examples/flows/crossover_flow.rb

@@ -0,0 +1,17 @@
+
+class CrossoverFlow
+
+  include Colloquy::FlowParser
+  
+  index {
+    request { |input|
+      session[:calculator_type] = (input == "1") ? :scientific : :normal 
+      pass
+    }
+    
+    process { |input|
+      switch :index, :flow => :calculator
+    }
+  }
+end
+

data/examples/flows/database_flow.rb

@@ -0,0 +1,33 @@
+
+class DatabaseFlow
+  include Colloquy::FlowParser
+  
+  index {
+    request {
+      menu << :activate << :cancel
+    }
+    
+    process { |input|
+      case menu.key(input)
+      when :activate
+        privileged_user = mysql[:customer].query("select sleep(0.25);")
+        if privileged_user
+          if activate(headers[:msisdn])
+            notify :activation_success
+          else
+            notify :activation_failure
+          end
+        else
+          notify :priveleges_required
+        end
+      when :cancel
+        url.call(:log_cancellations, { :msisdn => headers[:msisdn] })
+        notify :canceled
+      end
+    }
+  }
+  
+  def activate(msisdn)
+    logger.info "Activating #{msisdn}!"
+  end
+end

data/examples/flows/hangman_flow.rb

@@ -0,0 +1,82 @@
+require 'random_word_generator'
+require 'active_support/inflector'
+
+class HangmanFlow
+
+  include Colloquy::FlowParser
+  NUMBER_CRYPTEX = "22233344455566677778889999"
+  
+  index {
+    request {       
+      prompt "Hangman..Ready to die? No escape now!\n" + 
+             "Enter any key to start."
+    }
+    
+    process { |input|
+      session[:secret] = RandomWordGenerator.word
+      session[:lives] = 9
+      session[:used_letters] = "0"
+      session[:message] = ""
+      
+      switch :game_logic
+    }
+  }
+  
+  game_logic {
+    request {
+      notify "#{session[:secret]}\n You WIN!" if session[:secret] == word_with_user_input
+      notify "You LOSE. The word was #{session[:secret]}" if session[:lives] == 0
+
+      prompt "#{session[:message]}\n     #{word_with_user_input}    \n" + 
+             "You have #{session[:lives]} #{pluralize(session[:lives], 'life')} left.\n" + 
+             "Enter letter (A=>2,B=>22,C=>222,D=>3). Enter 0 to quit."
+    }
+    
+    process { |input|
+      notify "Exiting application.." if input == "0"
+      
+      if valid_input? input
+        letter_entered = translate_letter_code(input)
+        if session[:used_letters].include? letter_entered 
+           session[:message] = "You already entered this letter."           
+        else
+          session[:used_letters] << letter_entered
+          if session[:secret].include? letter_entered
+             session[:message] = "You entered #{letter_entered}. Aha! Good guess."
+          else
+             session[:lives] -= 1
+             session[:message] = "You entered #{letter_entered}. Bad luck!"
+          end
+        end
+      else
+         session[:message] = "Invalid letter code."
+      end
+      switch :game_logic
+    }
+  }
+
+
+  def valid_input?(number)
+    if  number.length <= 4 && ["7","9"].include?(number.squeeze)
+      return true
+    elsif number.length <= 3 && ["2","3","4","5","6","8"].include?(number.squeeze)
+      return true
+    else 
+      return false
+    end
+  end
+  
+  def translate_letter_code(letter_code)
+    ("a".."z").to_a[NUMBER_CRYPTEX.index(letter_code) + letter_code.length - 1]
+  end
+  
+  def word_with_user_input
+    regex = Regexp.new("[^#{session[:used_letters]}]")
+    session[:secret].gsub(regex,'-')
+  end
+  
+  def pluralize(number, text)
+    return text.pluralize if number != 1
+    text
+  end
+end

data/examples/flows/metadata_flow.rb

@@ -0,0 +1,11 @@
+
+class MetadataFlow
+  include Colloquy::FlowParser
+  
+  index {
+    request { |input|
+      logger.info "Metadata: #{headers[:metadata].inspect}"
+      notify "I love #{headers[:metadata][:love]}"
+    }
+  }
+end

data/examples/flows/pagination_flow.rb

@@ -0,0 +1,23 @@
+
+class PaginationFlow
+
+  include Colloquy::FlowParser
+  
+  index {
+    request {
+      menu.prefix { 
+        if headers[:page] == 1
+          "Welcome to Some new application. Please choose from one of the packs below to get latest news from Some new application" 
+        end
+      }
+      1.upto(10).each do |item|
+        menu << "Pack #{item}"
+      end
+    }
+    
+    process { |input|
+
+    }
+  }
+end
+

data/examples/flows/pass_flow.rb

@@ -0,0 +1,29 @@
+
+class PassFlow
+  include Colloquy::FlowParser
+  
+  index {
+    request { |input|
+      pass unless input.blank?
+      menu << :activate << :cancel
+    }
+    
+    process { |input|
+      notify :direct if input.direct?
+
+      case menu.key(input)
+      when :activate
+        notify :activation_success
+      when :cancel
+        cancelation = url[:log_cancellations].call(:msisdn => headers[:msisdn])
+        notify cancelation.response
+      else
+        notif "Hello World!" #Deliberate error!
+      end
+    }
+  }
+  
+  def activate
+    logger.info "Activating!"
+  end
+end

data/examples/flows/prefix_menu_flow.rb

@@ -0,0 +1,24 @@
+
+class PrefixMenuFlow
+  include Colloquy::FlowParser
+  
+  index {
+    request { |input|
+      menu.push(headers[:msisdn])
+      menu.push(*('a'..'z').to_a)
+      menu.prefix { "Hello #{headers[:session_id]}" }
+      menu.suffix do
+        logger.info "Headers: #{headers.inspect}"
+        "Your world is my oyster! And there's nothing better than beer! Or a touch of lemonade." if headers[:page] == 1
+      end
+      
+      menu.before_page do
+        session[:wonker] = "Page: #{headers[:page]}"
+      end
+    }
+    
+    process { |input|
+      notify menu.key(input)
+    }
+  }
+end