wit_bot 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6665e746f0e43cac8afda18e6597652e9938c3c8
-  data.tar.gz: 61201b2b210381924ebbafebf873117d32f7fbec
+  metadata.gz: d6f8586c33704055bce42268f28aa62d9342368a
+  data.tar.gz: c64ca87eb3a43d348f737f63336f76fe4eb95a2b
 SHA512:
-  metadata.gz: b6b754b9c04dafd6a263b400f0d6423b0ccb553a0f809aa905c56145c2f463e3529d304949275e94c8058b1793d543b568db1ac6b888e05ee6291d80ec034565
-  data.tar.gz: 984e8ba0c67d29c9365bb9c794a6085f2cd142058ce1190bfd619b9544475f5a42899bf10b11d155e2f3b871df5ceaedbe261290e7301cbe9c85a0f638c84c0f
+  metadata.gz: 742baac6a12728fd5bbcd6968889602f2d8e805e652c1e72afd1edb02074dc796c27839c8f86ad0e51cdb52d2cd4ae0988bd8cda68f4bbfb4f5a70beef4f4a67
+  data.tar.gz: 94c26dca334458d1350e8e20ddc35952f7f0b79c4be87fe92fb8e129b2927eb0bcfb5f691208bbf47b855d8cde74b10765a182cd8eccad6998d69d24429b3dad

data/lib/generators/wit_bot/message_bus/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Sets up an initializer for wit_bot.
+
+Example:
+    rails generate wit_bot:setup
+
+    This will create:
+        config/initializers/wit_bot.rb

data/lib/generators/wit_bot/message_bus/message_bus_generator.rb

@@ -0,0 +1,35 @@
+module WitBot
+  module Generators
+    class MessageBusGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+      argument :bot_name, type: :string, required: true
+      argument :user_model, type: :string, default: 'User'
+      argument :bot_channel, type: :string, default: '/witbot'
+
+      def install_dependencies
+        gem 'redis', '~> 3'
+        gem 'message_bus', '~> 2.0.0.beta.5'
+        Bundler.with_clean_env do
+          run 'bundle install'
+        end
+      end
+
+      def create_message_bus_listener
+        template 'message_bus_listener.rb.erb', 'app/wit_bot/message_bus_listener.rb'
+      end
+
+      def create_message_bus_controller
+        template 'message_bus_controller.rb.erb', 'app/controllers/message_bus_controller.rb'
+      end
+
+      def create_job
+        template 'job.rb.erb', 'app/jobs/message_bus_job.rb'
+      end
+
+      private
+      def user_lower
+        user_model.underscore
+      end
+    end
+  end
+end

data/lib/generators/wit_bot/message_bus/templates/job.rb.erb

@@ -0,0 +1,13 @@
+class MessageBusJob < ActiveJob::Base
+  queue_as :high
+
+  def perform(<%= user_lower %>_id, text)
+    # Make sure the user still exists
+    if <%= "(#{user_lower} = #{user_model}.find_by_id #{user_lower}_id)" %>
+      # Get the listener
+      listener = MessageBusListener.from_<%= user_lower %> <%= user_lower %>
+      # And send the message
+      listener.send_message text
+    end
+  end
+end

data/lib/generators/wit_bot/message_bus/templates/message_bus_controller.rb.erb

@@ -0,0 +1,12 @@
+class MessageBusController < ApplicationController
+  <% if defined? Doorkeeper %>
+  before_action(only: [:send_message]){ doorkeeper_authorize! }
+  <% else %>
+  before_action :authorize!, only: [:send_message] # Replace with your authentication logic
+  <% end %>
+
+  def send_message
+    MessageBusJob.perform_later current_<%= user_model.underscore %>.id, params[:text] # Enqueue
+    head :accepted # Respond the with the HTTP Accepted status code.
+  end
+end

data/lib/generators/wit_bot/message_bus/templates/message_bus_listener.rb.erb

@@ -0,0 +1,45 @@
+class MessageBusListener < WitBot::Bot::Conversation::Participant
+  attr_accessor :conversation_model, <%= ":#{user_lower}" %>
+
+  # Initialize the conversation, set the local <%= user_lower %>, and add the bot to the message
+  def initialize(conversation, <%= user_lower %>)
+    # Send the conversation object to the parent class
+    super conversation.object
+
+    # Set instance variables (@conversation is the actual conversation object)
+    <%= "@#{user_lower} = #{user_lower}" %>
+    @conversation_model = conversation
+
+    # Add the bot to the conversation
+    <%= "#{bot_name}." %>new @conversation<%= ", @#{user_lower}" %>
+  end
+
+  # A method that saves the conversation.
+  def save
+    @conversation_model.object = @conversation
+    @conversation_model.save
+  end
+
+  class << self
+    # A method to retrieve a listener from a <%= user_lower %>.
+    def from_<%= user_lower %>(<%= user_lower %>)
+      unless <%= "#{user_lower}." %>conversation # If the <%= user_lower %> doesn't have a conversation...
+        # Create one
+        <%= "#{user_lower}." %>conversation = Conversation.new
+        <%= user_lower %>.save! # Save the <%= user_lower %>
+      end
+      MessageBusListener.new <%= "#{user_lower}." %>conversation, <%= "#{user_lower}." %>to_s # Create a new listener from the conversation and the <%= user_lower %>.
+    end
+  end
+
+  def bot?
+    false # Tell wit_bot that this class handles messages for a user.
+  end
+
+  # A method that gets called on output of a message automatically by wit_bot
+  def on_output(message)
+    save # Once we output a message, save the <%= user_lower %>.
+    msg_hash = {text: message.text, bot: message.bot?} # Create a hash to send to the <%= user_lower %>
+    MessageBus.publish '<%= bot_channel %>', msg_hash, user_ids: [<%= "@#{user_lower}." %>id] # Send the message to the <%= user_lower %>.
+  end
+end

data/lib/generators/wit_bot/model/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Sets up an initializer for wit_bot.
+
+Example:
+    rails generate wit_bot:setup
+
+    This will create:
+        config/initializers/wit_bot.rb

data/lib/generators/wit_bot/model/model_generator.rb

@@ -0,0 +1,30 @@
+module WitBot
+  module Generators
+    class ModelGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+      argument :user_model, type: :string, default: 'User'
+      hook_for :force, type: :boolean
+
+      def create_conversations
+        user_lower = user_model.underscore
+
+        migration_options = 'migration', 'CreateConversations', 'object:text', "#{user_lower}:references"
+        migration_options << '--force' if options[:force]
+
+        generate *migration_options
+        template 'model.rb.erb', 'app/models/conversation.rb'
+
+        user_file = "app/models/#{user_lower}.rb"
+        inject_into_class user_file, user_model, "  has_one :conversation, dependent: :destroy\n"
+
+        puts <<TEXT
+If you're thinking that storing conversations will take up a lot of room in your database,
+you are correct. You'll want to destroy inactive conversations from the database every few hours.
+Here's the guide on setting up a job to clear old conversations with Clockwork:
+
+https://github.com/penne12/wit_bot/wiki/Clear-Old-Conversations-in-ActiveRecord-with-Clockwork-and-ActiveJob
+TEXT
+      end
+    end
+  end
+end

data/lib/generators/wit_bot/model/templates/model.rb.erb

@@ -0,0 +1,16 @@
+class Conversation < ActiveRecord::Base
+  <%= "belongs_to :#{user_model.underscore}" %>
+  store :object, coder: JSON
+
+  def object
+    h = super # Get the hash from the parent method
+    if h && !h.empty? # If the hash exists and is not empty,
+      WitBot::Bot::Conversation::Base.from_hash h # Then create a conversation from it.
+    else
+      WitBot::Bot::Conversation::Base.new # Otherwise, create a new conversation.
+    end
+  end
+  def object=(conversation)
+    super conversation.as_json # Turn the conversation back into a hash.
+  end
+end

data/lib/wit_bot/version.rb

@@ -1,3 +1,3 @@
 module WitBot
-  VERSION = '0.5.0'
+  VERSION = '0.5.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wit_bot
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Ben (@penne12_)
@@ -151,6 +151,14 @@ files:
 - lib/generators/wit_bot/bot/USAGE
 - lib/generators/wit_bot/bot/bot_generator.rb
 - lib/generators/wit_bot/bot/templates/bot.rb.erb
+- lib/generators/wit_bot/message_bus/USAGE
+- lib/generators/wit_bot/message_bus/message_bus_generator.rb
+- lib/generators/wit_bot/message_bus/templates/job.rb.erb
+- lib/generators/wit_bot/message_bus/templates/message_bus_controller.rb.erb
+- lib/generators/wit_bot/message_bus/templates/message_bus_listener.rb.erb
+- lib/generators/wit_bot/model/USAGE
+- lib/generators/wit_bot/model/model_generator.rb
+- lib/generators/wit_bot/model/templates/model.rb.erb
 - lib/generators/wit_bot/setup/USAGE
 - lib/generators/wit_bot/setup/setup_generator.rb
 - lib/generators/wit_bot/setup/templates/initializer.rb