xip 0.0.1 → 2.0.0.beta2

data/VERSION

@@ -0,0 +1 @@
+2.0.0.beta2

data/bin/xip

@@ -1,13 +1,5 @@
 #!/usr/bin/env ruby
 
-require_relative '../lib/xip/cli'
-
-begin
-  cli = Xip::CLI.instance
-  cli.parse
-  cli.run
-rescue => e
-  STDERR.puts e.message
-  STDERR.puts e.backtrace.join("\n")
-  exit 1
-end
+require 'bundler'
+require 'xip/cli'
+Xip::Cli.start

data/lib/xip.rb

@@ -1,3 +1 @@
-# frozen_string_literal: true
-
-require 'xip/version'
+require 'xip/base'

data/lib/xip/base.rb

@@ -0,0 +1,189 @@
+# frozen_string_literal: true
+
+# base requirements
+require 'yaml'
+require 'sidekiq'
+require 'active_support/all'
+
+begin
+  require "rails"
+  require "active_record"
+rescue LoadError
+  # Don't require ActiveRecord
+end
+
+# core
+require 'xip/version'
+require 'xip/errors'
+require 'xip/core_ext'
+require 'xip/logger'
+require 'xip/configuration'
+require 'xip/reloader'
+
+# helpers
+require 'xip/helpers/redis'
+
+module Xip
+
+  def self.env
+    @env ||= ActiveSupport::StringInquirer.new(ENV['XIP_ENV'] || 'development')
+  end
+
+  def self.root
+    @root ||= File.expand_path(Pathname.new(Dir.pwd))
+  end
+
+  def self.boot
+    load_services_config
+    load_environment
+  end
+
+  def self.config
+    Thread.current[:configuration] ||= load_services_config
+  end
+
+  def self.configuration=(config)
+    Thread.current[:configuration] = config
+  end
+
+  def self.default_autoload_paths
+    [
+      File.join(Xip.root, 'bot', 'controllers', 'concerns'),
+      File.join(Xip.root, 'bot', 'controllers'),
+      File.join(Xip.root, 'bot', 'models', 'concerns'),
+      File.join(Xip.root, 'bot', 'models'),
+      File.join(Xip.root, 'bot', 'helpers'),
+      File.join(Xip.root, 'config')
+    ]
+  end
+
+  def self.bot_reloader
+    @bot_reloader
+  end
+
+  def self.set_config_defaults(config)
+    defaults = {
+      dynamic_delay_muliplier: 1.0,                     # values > 1 increase, values < 1 decrease delay
+      session_ttl: 0,                                   # 0 seconds; don't expire sessions
+      lock_autorelease: 30,                             # 30 seconds
+      transcript_logging: false,                        # show user replies in the logs
+      hot_reload: Xip.env.development?,                 # hot reload bot files on change (dev only)
+      eager_load: Xip.env.production?,                  # eager load bot files for performance (prod only)
+      autoload_paths: Xip.default_autoload_paths,       # array of autoload paths used in eager and hot reloading
+      autoload_ignore_paths: [],                        # paths to exclude from eager and hot reloading
+      nlp_integration: nil,                             # NLP service to use, defaults to none
+      log_all_nlp_results: false,                       # log NLP service requests; useful for debugging/improving NLP models
+      auto_insert_delays: true                          # automatically insert delays/typing indicators between all replies
+    }
+    defaults.each { |option, default| config.set_default(option, default) }
+  end
+
+  # Loads the services.yml configuration unless one has already been loaded
+  def self.load_services_config(services_yaml=nil)
+    @semaphore ||= Mutex.new
+    services_yaml ||= Xip.load_services_config(
+      File.read(File.join(Xip.root, 'config', 'services.yml'))
+    )
+
+    Thread.current[:configuration] ||= begin
+      @semaphore.synchronize do
+        services_config = YAML.load(ERB.new(services_yaml).result)
+
+        unless services_config.has_key?(env)
+          raise Xip::Errors::ConfigurationError, "Could not find services.yml configuration for #{env} environment"
+        end
+
+        config = Xip::Configuration.new(services_config[env])
+        set_config_defaults(config)
+
+        config
+      end
+    end
+  end
+
+  # Same as `load_services_config` but forces the loading even if one has
+  # already been loaded
+  def self.load_services_config!(services_yaml=nil)
+    Thread.current[:configuration] = nil
+    load_services_config(services_yaml)
+  end
+
+  def self.load_bot!
+    @bot_reloader ||= begin
+      bot_reloader = Xip::Reloader.new
+      bot_reloader.load_bot!
+      bot_reloader
+    end
+  end
+
+  def self.load_environment
+    require File.join(Xip.root, 'config', 'boot')
+    require_directory('config/initializers')
+
+    load_bot!
+
+    Sidekiq.options[:reloader] = Xip.bot_reloader
+
+    if defined?(ActiveRecord)
+      if ENV['DATABASE_URL'].present?
+        ActiveRecord::Base.establish_connection(ENV['DATABASE_URL'])
+      else
+        database_config = File.read(File.join(Xip.root, 'config', 'database.yml'))
+        ActiveRecord::Base.establish_connection(
+          YAML.load(ERB.new(database_config).result)[Xip.env]
+        )
+      end
+    end
+  end
+
+  def self.tid
+    Thread.current.object_id.to_s(36)
+  end
+
+  def self.require_directory(directory)
+    for_each_file_in(directory) { |file| require_relative(file) }
+  end
+
+private
+
+  def self.for_each_file_in(directory, &blk)
+    directory = directory.to_s.gsub(%r{(\/|\\)}, File::SEPARATOR)
+    directory = Pathname.new(Dir.pwd).join(directory).to_s
+    directory = File.join(directory, '**', '*.rb') unless directory =~ /(\*\*)/
+
+    Dir.glob(directory).sort.each(&blk)
+  end
+
+end
+
+require 'xip/jobs'
+require 'xip/dispatcher'
+require 'xip/server'
+require 'xip/reply'
+require 'xip/scheduled_reply'
+require 'xip/service_reply'
+require 'xip/service_message'
+require 'xip/session'
+require 'xip/lock'
+require 'xip/nlp/result'
+require 'xip/nlp/client'
+require 'xip/controller/callbacks'
+require 'xip/controller/replies'
+require 'xip/controller/messages'
+require 'xip/controller/unrecognized_message'
+require 'xip/controller/catch_all'
+require 'xip/controller/helpers'
+require 'xip/controller/dynamic_delay'
+require 'xip/controller/interrupt_detect'
+require 'xip/controller/dev_jumps'
+require 'xip/controller/nlp'
+require 'xip/controller/controller'
+require 'xip/flow/base'
+require 'xip/services/base_client'
+
+if defined?(ActiveRecord)
+  require 'xip/migrations/configurator'
+  require 'xip/migrations/generators'
+  require 'xip/migrations/railtie_config'
+  require 'xip/migrations/tasks'
+end

data/lib/xip/cli.rb

@@ -0,0 +1,273 @@
+# frozen_string_literal: true
+
+require 'thor'
+require 'xip/cli_base'
+require 'xip/commands/console'
+require 'xip/generators/builder'
+require 'xip/generators/generate'
+
+module Xip
+  class Cli < Thor
+    extend CliBase
+
+    desc 'new', 'Creates a new Xip bot'
+    long_desc <<-EOS
+    `xip new <name>` creates a new Xip both with the given name.
+
+    $ > xip new new_bot
+    EOS
+    def new(name)
+      Xip::Generators::Builder.start([name])
+    end
+
+
+    desc 'generate', 'Generates scaffold Xip files'
+    long_desc <<-EOS
+    `xip generate <generator> <name>` generates scaffold Xip files
+
+    $ > xip generate flow quote
+    EOS
+    def generate(generator, name)
+      case generator
+      when 'migration'
+        Xip::Migrations::Generator.migration(name)
+      when 'flow'
+        Xip::Generators::Generate.start([generator, name])
+      else
+        puts "Could not find generator '#{generator}'."
+        puts "Run `xip help generate` for more options."
+      end
+    end
+    map 'g' => 'generate'
+
+
+    desc 'version', 'Prints xip version'
+    long_desc <<-EOS
+    `xip version` prints the version of the bundled xip gem.
+    EOS
+    def version
+      require 'xip/version'
+      puts "#{ Xip::VERSION }"
+    end
+    map %w{--version -v} => :version
+
+
+    desc 'server', 'Starts a xip server'
+    long_desc <<-EOS
+    `xip server` starts a server for the current xip project.
+
+    $ > xip server
+
+    $ > xip server -p 4500
+    EOS
+    method_option :port, aliases: '-p', desc: 'The port to run the server on'
+    method_option :help, desc: 'Displays the usage message'
+    def server
+      if options[:help]
+        invoke :help, ['server']
+      else
+        require 'xip/commands/server'
+        Xip::Commands::Server.new(port: options.fetch(:port) { 5000 }).start
+      end
+    end
+    map 's' => 'server'
+
+
+    desc 'console', 'Starts a xip console'
+    long_desc <<-EOS
+    `xip console` starts the interactive xip console.
+
+    $ > xip console --engine=pry
+    EOS
+    method_option :engine, desc: "Choose a specific console engine: (#{Xip::Commands::Console::ENGINES.keys.join('/')})"
+    method_option :help, desc: 'Displays the usage method'
+    def console
+      if options[:help]
+        invoke :help, ['console']
+      else
+        Xip::Commands::Console.new(options).start
+      end
+    end
+    map 'c' => 'console'
+
+
+    desc 'setup', 'Runs setup tasks for a specified service'
+    long_desc <<-EOS
+    `xip setup <service>` runs setup tasks for the specified service.
+
+    $ > xip setup facebook
+    EOS
+    def setup(service)
+      Xip.load_environment
+      service_setup_klass = "Xip::Services::#{service.classify}::Setup".constantize
+      service_setup_klass.trigger
+    end
+
+
+    desc 'sessions:clear', 'Clears all sessions in development'
+    long_desc <<-EOS
+    `xip sessions:clear` clears all sessions from Redis in development.
+
+    $ > xip sessions:clear
+    EOS
+    define_method 'sessions:clear' do
+      Xip.load_environment
+      $redis.flushdb if Xip.env.development?
+    end
+
+
+    desc 'db:create', 'Creates the database from DATABASE_URL or config/database.yml for the current XIP_ENV'
+    long_desc <<-EOS
+    `xip db:create` Creates the database from DATABASE_URL or config/database.yml for the current XIP_ENV (use db:create:all to create all databases in the config). Without XIP_ENV or when XIP_ENV is development, it defaults to creating the development and test databases.
+
+    $ > xip db:create
+    EOS
+    define_method 'db:create' do
+      Kernel.exec('bundle exec rake db:create')
+    end
+
+
+    desc 'db:create:all', 'Creates all databases from DATABASE_URL or config/database.yml'
+    long_desc <<-EOS
+    `xip db:create:all` Creates all databases from DATABASE_URL or config/database.yml regardless of the enviornment specified in XIP_ENV
+
+    $ > xip db:create:all
+    EOS
+    define_method 'db:create:all' do
+      Kernel.exec('bundle exec rake db:create:all')
+    end
+
+
+    desc 'db:drop', 'Drops the database from DATABASE_URL or config/database.yml for the current XIP_ENV'
+    long_desc <<-EOS
+    `xip db:drop` Drops the database from DATABASE_URL or config/database.yml for the current XIP_ENV (use db:drop:all to drop all databases in the config). Without XIP_ENV or when XIP_ENV is development, it defaults to dropping the development and test databases.
+
+    $ > xip db:drop
+    EOS
+    define_method 'db:drop' do
+      Kernel.exec('bundle exec rake db:drop')
+    end
+
+
+    desc 'db:drop:all', 'Drops all databases from DATABASE_URL or config/database.yml'
+    long_desc <<-EOS
+    `xip db:drop:all` Drops all databases from DATABASE_URL or config/database.yml
+
+    $ > xip db:drop:all
+    EOS
+    define_method 'db:drop:all' do
+      Kernel.exec('bundle exec rake db:drop:all')
+    end
+
+
+    desc 'db:environment:set', 'Set the environment value for the database'
+    long_desc <<-EOS
+    `xip db:environment:set` Set the environment value for the database
+
+    $ > xip db:environment:set
+    EOS
+    define_method 'db:environment:set' do
+      Kernel.exec('bundle exec rake db:enviornment:set')
+    end
+
+
+    desc 'db:migrate', 'Migrate the database'
+    long_desc <<-EOS
+    `xip db:migrate` Migrate the database (options: VERSION=x, VERBOSE=false, SCOPE=blog).
+
+    $ > xip db:migrate
+    EOS
+    define_method 'db:migrate' do
+      Kernel.exec('bundle exec rake db:migrate')
+    end
+
+
+    desc 'db:rollback', 'Rolls the schema back to the previous version'
+    long_desc <<-EOS
+    `xip db:rollback` Rolls the schema back to the previous version (specify steps w/ STEP=n).
+
+    $ > xip db:rollback
+    EOS
+    define_method 'db:rollback' do
+      Kernel.exec('bundle exec rake db:rollback')
+    end
+
+
+    desc 'db:schema:load', 'Loads a schema.rb file into the database'
+    long_desc <<-EOS
+    `xip db:schema:load` Loads a schema.rb file into the database
+
+    $ > xip db:schema:load
+    EOS
+    define_method 'db:schema:load' do
+      Kernel.exec('bundle exec rake db:schema:load')
+    end
+
+
+    desc 'db:schema:dump', 'Creates a db/schema.rb file that is portable against any DB supported by Active Record'
+    long_desc <<-EOS
+    `xip db:schema:dump` Creates a db/schema.rb file that is portable against any DB supported by Active Record
+
+    $ > xip db:schema:dump
+    EOS
+    define_method 'db:schema:dump' do
+      Kernel.exec('bundle exec rake db:schema:dump')
+    end
+
+
+    desc 'db:seed', 'Seeds the database with data from db/seeds.rb'
+    long_desc <<-EOS
+    `xip db:seed` Seeds the database with data from db/seeds.rb
+
+    $ > xip db:seed
+    EOS
+    define_method 'db:seed' do
+      Kernel.exec('bundle exec rake db:seed')
+    end
+
+
+    desc 'db:version', 'Retrieves the current schema version number'
+    long_desc <<-EOS
+    `xip db:version` Retrieves the current schema version number
+
+    $ > xip db:version
+    EOS
+    define_method 'db:version' do
+      Kernel.exec('bundle exec rake db:version')
+    end
+
+
+    desc 'db:setup', 'Creates the database, loads the schema, and initializes with the seed data (use db:reset to also drop the database first)'
+    long_desc <<-EOS
+    `xip db:setup` Creates the database, loads the schema, and initializes with the seed data (use db:reset to also drop the database first)
+
+    $ > xip db:setup
+    EOS
+    define_method 'db:setup' do
+      Kernel.exec('bundle exec rake db:setup')
+    end
+
+
+    desc 'db:structure:dump', 'Dumps the database structure to db/structure.sql. Specify another file with SCHEMA=db/my_structure.sql'
+    long_desc <<-EOS
+    `xip db:structure:dump` Dumps the database structure to db/structure.sql. Specify another file with SCHEMA=db/my_structure.sql
+
+    $ > xip db:structure:dump
+    EOS
+    define_method 'db:structure:dump' do
+      Kernel.exec('bundle exec rake db:structure:dump')
+    end
+
+
+    desc 'db:structure:load', 'Recreates the databases from the structure.sql file'
+    long_desc <<-EOS
+    `xip db:structure:load` Recreates the databases from the structure.sql file
+
+    $ > xip db:structure:load
+    EOS
+    define_method 'db:structure:load' do
+      Kernel.exec('bundle exec rake db:structure:load')
+    end
+
+  end
+end