edi 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 601cdae478aa39f3a62c7fa674c5611004d72d5c
-  data.tar.gz: 4c663b2a26f1006c0ab47c63f3e323b68b4fd985
+  metadata.gz: ef25fec135979397b1fea972687189980ee8a5fb
+  data.tar.gz: 9c041ea28f1aef74c9d53d7be8cd798e5cb87aa8
 SHA512:
-  metadata.gz: 430594d7295f5dc3827b2d4cf1d29e988d1599eb3b0cfbd6b8e6f1f12ffd4ba32348abae9b92f11205f52b6efb5ef581d87cd4b90723a3d1fb0a3c87cdc67291
-  data.tar.gz: bb11a163d75bb8eb35bce7949ed1cbc1891ea89833ead95b1c0607c98f8516c9a3d40068204c8a65b486b8e079e8a3a4714fd6b5b9e84742c9c64e2378edd607
+  metadata.gz: 85899c1736993aae9099e35cbbe0a161c3ecf711f3452a075550b9b6b652b93dc3b9db3a63d5267628a20f478117b074c27b2c5d1f9a70308a84180ce31ca273
+  data.tar.gz: 757cdb058ef18868bef48b1b38e79955d23b0d7f9af18e81f23c27032138392601dbac4c9052380396a8246ba84da7a058414d6602debc539b747d951d7da14c

data/README.md

@@ -18,11 +18,11 @@ $ edi new my-bot
 
 ### Registering Services
 
-`/bot/server.rb` is the main brain of your edi bot. Here you can register which services you want to be available on your chatbot.
+`bot/core.rb` is the main brain of your edi bot. Here you can register which services you want to be available on your chatbot.
 
 ```ruby
-class Server < EDI::Server
-  register_services :tweet_that, :img_flip, :urban_dictionary, :weather
+class Core < EDI::Core
+  register_services :tweet_that, :img_flip, :urban_dictionary, :weather, :joke
 end
 ```
 
@@ -38,7 +38,7 @@ class MyService < EDI::Service
 end
 ```
 
-If a service is Registered in `bot/server.rb` but does not have it's expected environment, edi will throw an exception and respond with a polite refusal to execute the service. This message can be set in your EDI configuration. The enviornment method will also create a getter method for each environment variable.
+If a service is Registered in `bot/core.rb` but does not have it's expected environment, edi will throw an exception and respond with a polite refusal to execute the service. This message can be set in your EDI configuration. The enviornment method will also create a getter method for each environment variable.
 
 ### Service Routing
 
@@ -91,13 +91,12 @@ You can do actions before or after the service is run, but before edi responds.
 
 ```ruby
 class Joke < EDI::Service
-  include Postable
   before_invoke :setup
   invoke_with :punch
 
   def setup
-    post_to_slack(message: "What do you call a fish with no eyes?", channel: "##{channel_name}")
-    sleep 1
+    EDI.send_message("What do you call a fish with no eyes?", channel: channel)
+    sleep 2
   end
 
   def punch
@@ -111,7 +110,7 @@ end
 Since EDI is, under the hood, a web socket client, it can be deployed to any internet connected computer, and does not require a web server. Simple run
 
 ```shell
-$ edi start -D
+$ edi start
 ```
 
 And EDI will connect to slack and will stay connected for the life of the process.
@@ -129,21 +128,6 @@ When these things are done, we'll be ready for 1.0
 - [x] Boot Process for the Generated App
 - [x] Switch from sinatra-based incoming and outgoing webhooks to websocket-based implementation
 
-## Upcoming Features
-
-This stuff isn't true yet, think of this section as a scratchpad for designs to be.
-
-### Messages
-
-You can make special classes that model special messages you'd like EDI to send into slack. These have all the functionality of Slack's Message Attachments for making richly formatted messages.
-
-```ruby
-class CiMessage < EDI::Message
-  channel "#general"
-
-end
-```
-
 ## Contributing
 
 1. Fork it ( https://github.com/DVG/EDI/fork )

data/lib/edi/version.rb

@@ -1,3 +1,3 @@
 module EDI
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

data/templates/project/.gitignore

@@ -0,0 +1 @@
+variables.sh

data/templates/project/bot/core.rb

@@ -1,6 +1,6 @@
 class Core < EDI::Core
   # Use `register_services` to enable services in your EDI Bot. Available built-in services are:
-  # :dice, :eightball, :fact, :giphy, :i_heart_quotes
+  # :dice, :eightball, :fact, :giphy, :i_heart_quotes, :img_flip, :tweet_that, :weather
   # You can make your own services with `edi generate service my_service`
   register_services :fact
 end

data/templates/project/config/environment.rb

@@ -2,7 +2,8 @@ require 'bundler/setup'
 Bundler.require(:default)
 EDI.configure do |config|
   config.root = File.expand_path "./"
-  # Your bot's name, not required for anything, but you can use it to have your bot speak it's name
+  # Your bot's name. Defaults to "EDI". Used to determine if your bot should respond to a given message, and can also be used
+  # to have your bot speak it's name via EDI.bot_name
   # config.bot_name = "EDI"
 
   # Default response is what EDI will say in response to a message that doesn't have a registered service.
@@ -23,8 +24,5 @@ EDI.configure do |config|
 
   # Add additional autoload directories to autoload_paths
   # config.autoload_paths += "bot/models"
-
-  # Default channel to post to using the post_to_slack method
-  # config.default_channel = "#general"
 end
 EDI.bootstrap

data/templates/project/variables.sh.example

@@ -0,0 +1,26 @@
+# Use this shell script to set up your environment variables.
+# Run cp variables.sh.example variables.sh
+
+# Slack API Token. Generate token at https://api.slack.com/web
+export SLACK_TOKEN=
+
+# Bot User Integration Token. Create your bot user integration at https://YOURTEAM.slack.com/services/new#diy
+export SLACK_EDI_TOKEN=
+
+# Giphy Service Configuration. Public Beta API Key Included Below
+export GIPHY_API_KEY=dc6zaTOxFJmzC
+export GIPHY_API_VERSION=v1
+
+# Tweet That Service Variables
+export TWITTER_ACCESS_TOKEN=
+export TWITTER_CONSUMER_KEY=
+export TWITTER_CONSUMER_SECRET=
+export TWITTER_HANDLE=
+export TWITTER_TOKEN_SECRET=
+
+# ImgFlip Service Variables. Set up a User at https://imgflip.com/signup
+export IMGFLIP_USER=
+export IMGFLIP_PASSWORD=
+
+# ZIP Code to use as the default location for the weather service.
+export DEFAULT_LOCATION=90210

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: edi
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - DVG
@@ -288,7 +288,6 @@ files:
 - ".rspec"
 - ".ruby-version"
 - ".travis.yml"
-- ":w"
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -391,6 +390,7 @@ files:
 - spec/support/fixtures/vcr_cassettes/weather.yml
 - spec/support/shared_contexts/server.rb
 - spec/support/shared_contexts/service.rb
+- templates/project/.gitignore
 - templates/project/Gemfile
 - templates/project/boot.rb
 - templates/project/bot/core.rb
@@ -398,6 +398,7 @@ files:
 - templates/project/config/.gitkeep
 - templates/project/config/environment.rb
 - templates/project/config/initializers/.gitkeep
+- templates/project/variables.sh.example
 - templates/services/%name%.rb.tt
 homepage: https://github.com/DVG/edi.git
 licenses:

data/:w

@@ -1,57 +0,0 @@
-require 'faye/websocket'
-require 'eventmachine'
-
-module Websocket
-  class Client
-    attr_accessor :ws_url, :client, :id
-
-    def initialize
-      self.id = 1
-    end
-
-    def connect
-      connection = EDI.get("https://slack.com/api/rtm.start?token=#{EDI.bot_token}").response
-      require 'byebug'
-      debugger
-      self.ws_url = connection["url"]
-      EM.run {
-
-        self.client = Faye::WebSocket::Client.new(ws_url)
-
-        client.on :open do |event|
-          puts "EDI is now online"
-        end
-
-        # Respond to Messages
-        client.on :message do |event|
-          incoming_message = Slack::WebsocketIncomingMessage.new(event.data)
-          if incoming_message.should_respond?
-            puts "EDI received message #{incoming_message.text} in channel #{incoming_message.channel}"
-            response_text = ""
-            service = Proc.new { response_text = EDI.runner.new(message: incoming_message).execute }
-            response = Proc.new { client.send Slack::WebsocketOutgoingMessage.new(text: response_text, channel: incoming_message.channel, id: id).to_json if response_text }
-            EM.defer service, response
-            increment_id
-          end
-        end
-
-        # Kepp Websocket Connection Alive
-        EM.add_periodic_timer(1) do
-          client.ping
-        end
-      }
-    end
-
-    def send_message(message)
-      client.send Slack::WebsocketOutgoingMessage.new(text: message, channel: "D046WN43L", id: id).to_json
-      increment_id
-    end
-
-private
-
-    # There has to be a way to do this better
-    def increment_id
-      self.id += 1
-    end
-  end
-end