xip 0.0.1 → 2.0.0.beta2

data/lib/xip/generators/builder/bot/controllers/goodbyes_controller.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class GoodbyesController < BotController
+
+  def say_goodbye
+    send_replies
+  end
+
+end

data/lib/xip/generators/builder/bot/controllers/hellos_controller.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class HellosController < BotController
+
+  def say_hello
+    send_replies
+  end
+
+end

data/lib/xip/generators/builder/bot/controllers/interrupts_controller.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class InterruptsController < BotController
+
+  def say_interrupted
+    do_nothing
+  end
+
+end

data/lib/xip/generators/builder/bot/controllers/unrecognized_messages_controller.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class UnrecognizedMessagesController < BotController
+
+  def handle_unrecognized_message
+    do_nothing
+  end
+
+end

data/lib/xip/generators/builder/bot/helpers/bot_helper.rb

@@ -0,0 +1,2 @@
+module BotHelper
+end

data/lib/xip/generators/builder/bot/models/bot_record.rb

@@ -0,0 +1,3 @@
+class BotRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/lib/xip/generators/builder/bot/replies/catch_alls/level1.yml

@@ -0,0 +1,2 @@
+- reply_type: text
+  text: Oops. It looks like something went wrong. Let's try that again

data/lib/xip/generators/builder/bot/replies/goodbyes/say_goodbye.yml

@@ -0,0 +1,2 @@
+- reply_type: text
+  text: Goodbye World!

data/lib/xip/generators/builder/bot/replies/hellos/say_hello.yml

@@ -0,0 +1,2 @@
+- reply_type: text
+  text: Hello World!

data/lib/xip/generators/builder/config.ru

@@ -0,0 +1,4 @@
+require 'rack/handler/puma'
+require_relative 'config/boot'
+
+Rack::Handler::Puma.run(Xip::Server)

data/lib/xip/generators/builder/config/boot.rb

@@ -0,0 +1,6 @@
+require 'xip'
+require_relative './environment'
+
+Bundler.require(:default, Xip.env)
+
+Xip.boot

data/lib/xip/generators/builder/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: <%= ENV.fetch("XIP_MAX_THREADS") { 5 } %>
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3

data/lib/xip/generators/builder/config/environment.rb

@@ -0,0 +1,2 @@
+REDIS_URL = ENV['REDIS_URL'] || 'redis://localhost:6379/0'
+$redis = Redis.new(:url => REDIS_URL)

data/lib/xip/generators/builder/config/flow_map.rb

@@ -0,0 +1,25 @@
+class FlowMap
+
+  include Xip::Flow
+
+  flow :hello do
+    state :say_hello
+  end
+
+  flow :goodbye do
+    state :say_goodbye
+  end
+
+  flow :interrupt do
+    state :say_interrupted
+  end
+
+  flow :unrecognized_message do
+    state :handle_unrecognized_message
+  end
+
+  flow :catch_all do
+    state :level1
+  end
+
+end

data/lib/xip/generators/builder/config/initializers/autoload.rb

@@ -0,0 +1,8 @@
+# Add additional directories below for hot-reloading during development.
+# You'll want to include any custom directories you create for your code.
+# To stop certain files or directories from autoloading, use autoload_ignore_paths
+
+# Xip.config.autoload_paths << File.join(Xip.root, 'bot', 'services')
+# Xip.config.autoload_paths << File.join(Xip.root, 'bot', 'jobs')
+
+# Xip.config.autoload_ignore_paths << File.join(Xip.root, 'bot', 'overrides')

data/lib/xip/generators/builder/config/initializers/inflections.rb

@@ -0,0 +1,16 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format. Inflections
+# are locale specific, and you may define rules for as many different
+# locales as you wish. All of these examples are active by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end
+
+# These inflection rules are supported but not enabled by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.acronym 'RESTful'
+# end

data/lib/xip/generators/builder/config/puma.rb

@@ -0,0 +1,25 @@
+threads_count = ENV.fetch("XIP_MAX_THREADS") { 5 }.to_i
+threads threads_count, threads_count
+
+# Specifies the `port` that Puma will listen on to receive requests, default is 3000.
+#
+port ENV.fetch("PORT") { 3000 }
+
+# Specifies the number of `workers` to boot in clustered mode.
+# Workers are forked webserver processes. If using threads and workers together
+# the concurrency of the application would be max `threads` * `workers`.
+# Workers do not work on JRuby or Windows (both of which do not support
+# processes).
+#
+# workers ENV.fetch("WEB_CONCURRENCY") { 2 }
+
+# Use the `preload_app!` method when specifying a `workers` number.
+# This directive tells Puma to first boot the application and load code
+# before forking the application. This takes advantage of Copy On Write
+# process behavior so workers use less memory.
+#
+# preload_app!
+
+# Specifies the `environment` that Puma will run in.
+#
+environment ENV.fetch("XIP_ENV") { "development" }

data/lib/xip/generators/builder/config/services.yml

@@ -0,0 +1,35 @@
+default: &default
+  # ==========================================
+  # ===== Example Facebook Service Setup =====
+  # ==========================================
+  # facebook:
+  #   verify_token: XXXFACEBOOK_VERIFY_TOKENXXX
+  #   page_access_token: XXXFACEBOOK_ACCESS_TOKENXXX
+  #   setup:
+  #     greeting: # Greetings are broken up by locale
+  #       - locale: default
+  #         text: "Welcome to my Facebook Bot."
+  #     get_started:
+  #       payload: new_user
+  #     persistent_menu:
+  #       - locale: default
+  #         composer_input_disabled: false
+  #         call_to_actions:
+  #         - type: payload
+  #           text: Some Button
+  #           payload: some_button
+  #
+  # ===========================================
+  # ======== Example SMS Service Setup ========
+  # ===========================================
+  # twilio:
+  #   account_sid: XXXTWILIO_ACCOUNT_SIDXXX
+  #   auth_token: XXXTWILIO_AUTH_TOKENXXX
+  #   from_phone: +14155330000
+
+production:
+  <<: *default
+development:
+  <<: *default
+test:
+  <<: *default

data/lib/xip/generators/builder/config/sidekiq.yml

@@ -0,0 +1,3 @@
+---
+:verbose: false
+:concurrency:  <%= ENV.fetch('SIDEKIQ_CONCURRENCY', 5).to_i %>

data/lib/xip/generators/builder/db/seeds.rb

@@ -0,0 +1,7 @@
+# This file should contain all the record creation needed to seed the database with its default values.
+# The data can then be loaded with the `xip db:seed` command (or created alongside the database with db:setup).
+#
+# Examples:
+#
+#   movies = Movie.create([{ name: 'Star Wars' }, { name: 'Lord of the Rings' }])
+#   Character.create(name: 'Luke', movie: movies.first)

data/lib/xip/generators/generate.rb

@@ -0,0 +1,39 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+require 'thor/group'
+
+module Xip
+  module Generators
+    class Generate < Thor::Group
+      include Thor::Actions
+
+      argument :generator
+      argument :name
+
+      def self.source_root
+        File.dirname(__FILE__) + "/generate/flow"
+      end
+
+      def create_controller
+        template('controllers/controller.tt', "bot/controllers/#{name.pluralize}_controller.rb")
+      end
+
+      def create_replies
+        # Sample Ask Reply
+        template('replies/ask_example.tt', "bot/replies/#{name.pluralize}/ask_example.yml.erb")
+      end
+
+      def create_helper
+        template('helpers/helper.tt', "bot/helpers/#{name}_helper.rb")
+      end
+
+      def edit_flow_map
+        inject_into_file "config/flow_map.rb", after: "include Xip::Flow\n" do
+          "\n\tflow :#{name} do\n\t\tstate :ask_example\n\tend\n"
+        end
+      end
+
+    end
+  end
+end

data/lib/xip/generators/generate/flow/controllers/controller.tt

@@ -0,0 +1,7 @@
+class <%= name.classify.pluralize %>Controller < BotController
+
+  def ask_example
+    send_replies
+  end
+
+end

data/lib/xip/generators/generate/flow/helpers/helper.tt

@@ -0,0 +1,3 @@
+module <%= name.capitalize.underscore.camelize %>Helper
+
+end

data/lib/xip/generators/generate/flow/replies/ask_example.tt

@@ -0,0 +1,9 @@
+- reply_type: text
+  text: "Welcome to your brand new Xip flow."
+- reply_type: delay
+  duration: 2
+- reply_type: text
+  text: 'That was pretty easy huh?'
+  suggestions:
+    - text: "Yes"
+    - text: "No"

data/lib/xip/helpers/redis.rb

@@ -0,0 +1,40 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+module Xip
+  module Redis
+    extend ActiveSupport::Concern
+
+    included do
+      private
+
+      def get_key(key, expiration: Xip.config.session_ttl)
+        if expiration > 0
+          getex(key, expiration)
+        else
+          $redis.get(key)
+        end
+      end
+
+      def delete_key(key)
+        $redis.del(key)
+      end
+
+      def getex(key, expiration=Xip.config.session_ttl)
+        $redis.multi do
+          $redis.expire(key, expiration)
+          $redis.get(key)
+        end.last
+      end
+
+      def persist_key(key:, value:, expiration: Xip.config.session_ttl)
+        if expiration > 0
+          $redis.setex(key, expiration, value)
+        else
+          $redis.set(key, value)
+        end
+      end
+
+    end
+  end
+end

data/lib/xip/jobs.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Xip
+  class Jobs
+
+    include Sidekiq::Worker
+
+  end
+end

data/lib/xip/lock.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Xip
+  class Lock
+
+    include Xip::Redis
+
+    attr_accessor :session_id, :session_slug, :position, :tid
+
+    def initialize(session_id:, session_slug: nil, position: nil)
+      @session_id = session_id
+      @session_slug = session_slug
+      @position = position
+      @tid = Xip.tid
+    end
+
+    def self.find_lock(session_id:)
+      lock = Lock.new(session_id: session_id)
+      lock_slug = lock.slug # fetch lock from Redis
+
+      return if lock_slug.nil?
+
+      # parse the lock slug
+      tid_and_session_slug, position = lock_slug.split(':')
+      tid, session_slug = tid_and_session_slug.split('#')
+
+      # set the values from the slug to the lock object
+      lock.session_slug = session_slug
+      lock.position = position&.to_i
+      lock.tid = tid
+      lock
+    end
+
+    def create
+      if session_slug.blank?
+        raise(
+          ArgumentError,
+          'A session_slug must be specified before a lock can be created.'
+        )
+      end
+
+      # Expire locks after 30 seconds to prevent zombie locks from blocking
+      # other threads to interact with a session.
+      persist_key(
+        key: lock_key,
+        value: generate_lock,
+        expiration: Xip.config.lock_autorelease
+      )
+    end
+
+    def release
+      delete_key(lock_key)
+    end
+
+    def slug
+      # We don't want to extend the expiration time that would result if
+      # we specified one here.
+      get_key(lock_key, expiration: 0)
+    end
+
+    # Returns a hash:
+    #   { flow: 'flow_name', state: 'state_name' }
+    def flow_and_state
+      Session.flow_and_state_from_session_slug(slug: session_slug)
+    end
+
+    private
+
+      def lock_key
+        [@session_id, 'lock'].join('-')
+      end
+
+      def generate_lock
+        if @position.present?
+          @session_slug = [@session_slug, @position].join(':')
+        end
+
+        [@tid, @session_slug].join('#')
+      end
+
+  end
+end

data/lib/xip/logger.rb

@@ -25,7 +25,9 @@ module Xip
     end
 
     def self.log(topic:, message:)
-      puts "#{print_topic(topic)} #{message}"
+      unless ENV['XIP_ENV'] == 'test'
+        puts "TID-#{Xip.tid} #{print_topic(topic)} #{message}"
+      end
     end
 
     def self.print_topic(topic)
@@ -36,13 +38,17 @@ module Xip
                 :green
               when :previous_session, :back_to_session
                 :yellow
+              when :interrupt
+                :magenta
               when :facebook, :twilio, :bandwidth
                 :blue
               when :smooch
                 :magenta
-              when :alexa
+              when :alexa, :voice, :unrecognized_message
                 :light_cyan
-              when :catch_all
+              when :nlp
+                :cyan
+              when :catch_all, :err
                 :red
               when :user
                 :white