edi 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5dec39d30abdd3e6d06e0cf83760054aec0c9c4a
+  data.tar.gz: fd798a1b99fa7fd35a4957be70363c5aca7cf96f
+SHA512:
+  metadata.gz: c64a98478aff5c70c7a62ca81822dd8e72d3857777ef7763a373a5e90c89288d7b6ee51e257712047ed18da53de42c6770ab626111d5693fe95014a6edbc3a5b
+  data.tar.gz: dd6b9aa22bb635e9a954caa9b67382d9645b48cbefb6efe6a713139dd22b11245d3fcf1fe397f3602a82a361c0fdfb43a8b4c5d68170b446815076bb86c7cc56

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+variables.sh

data/.rspec

@@ -0,0 +1 @@
+--color

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.4

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+    - 2.1.2
+script:
+  - bundle exec rspec
+  - bundle exec cucumber

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in edi.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,47 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features)
+
+## Uncomment to clear the screen before every task
+# clearing :on
+
+## Guard internally checks for changes in the Guardfile and exits.
+## If you want Guard to automatically start up again, run guard in a
+## shell loop, e.g.:
+##
+##  $ while bundle exec guard; do echo "Restarting Guard..."; done
+##
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+
+guard "cucumber" do
+  watch(%r{^features/.+\.feature$})
+  watch(%r{^features/support/.+$})          { "features" }
+  watch(%r{^features/step_definitions/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "features"
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 DVG
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,129 @@
+# EDI [![Build Status](https://travis-ci.org/DVG/EDI.svg?branch=master)](https://travis-ci.org/DVG/EDI)
+
+## Warning, these instructions are not true yet, but they will be!
+
+## Installation
+
+Or install it yourself as:
+
+    $ gem install edi
+
+## Usage
+
+edi is an application framework for building Chat bots to integrate with your Slack chat room. It ships with a number of useful and funny built-in services, but it also provides and easy DSL for creating your own services.
+
+### Generating a new chat bot
+
+Creating a chatbot is as easy as:
+
+```bash
+$ 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.
+
+```ruby
+class Server < EDI::Server
+  register_services :tweet_that, :img_flip, :urban_dictionary, :weather
+end
+```
+
+These are the services that will be enabled when edi interprets a message from Slack.
+
+### Required Environment Variables
+
+If a Service integrates with an authenticated, third party API, you may need to set up environment variables for API Tokens, Secrets, Usernames and Passwords, etc. To ensure that services are not run in environments that aren't set up to support them, services can require certain variables be set up.
+
+```ruby
+class MyService < EDI::Service
+  environment :service_token, :service_secret
+end
+```
+
+If a service is Registered in `app/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.
+
+### Service Routing
+
+There are two ways to tell edi to send a given message to a particular service.`interpreter_pattern` and `phrases`
+
+```ruby
+class ImgFlip < EDI::Service
+  phrases "success kid", "overly attached girlfriend"
+  # will converted to a pattern that looks like /success kid|overly attached girlfriend/i
+end
+class SortingHat < EDI::Service
+  interpreter_pattern /sorting hat|where do I belong/i
+end
+```
+
+Setting interpreter pattern directly will take precendence over phrases if you include both.
+
+### Running the Service
+
+Services should expose a `run` method. This method will perform whatever actions necessary to fulfill the service and should ultimately return the string that edi will send back to the channel in slack.
+
+A very simple service might look like:
+
+```ruby
+class SortingHat < EDI::Service
+  def run
+    [
+      "Gryphondor, where dwell the brave of heart!",
+      "Slytherine, because you are kind of a jerk"
+    ].sample
+  end
+end
+```
+
+If you want to use a more semantic name for your service, you can override the method using `invoke_with`
+
+```ruby
+class IJustMetYou < EDI::Service
+  invoke_with :call_me_maybe
+
+  def call_me_maybe
+    "This is crazy, but here's my number, so call me maybe"
+  end
+end
+```
+
+### Callbacks
+
+You can do actions before or after the service is run, but before edi responds. For instance:
+
+```ruby
+class Joke < EDI::Service
+  before_invoke :setup
+  invoke_with :punch
+
+  def setup
+    Slack::Post.new(channel_id, "What do you call a fish with no eyes?").send_message
+    sleep 1
+  end
+
+  def punch
+    "A FSH!"
+  end
+end
+```
+## Ship List
+
+When these things are done, we'll be ready for 1.0
+
+- [x] Finish Porting The Services from the original bot to the framework
+- [ ] Ability for edi to Post Back into the Slack Chatroom
+- [ ] EDI::Schedule
+- [ ] Add Test Framework to the Project Generator
+- [x] Service Generator
+- [x] Configure All The Things
+- [x] Boot Process for the Generated App
+
+## Contributing
+
+1. Fork it ( https://github.com/DVG/EDI/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+
+desc "RSpec"
+task :rspec do
+  system "bundle exec rspec"
+end
+desc "Cucumber"
+task :cucumber do
+  system "bundle exec cucumber"
+end
+task :default => [:rspec, :cucumber]

data/bin/edi

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'edi'
+
+require "pathname"
+bin_file = Pathname.new(__FILE__).realpath
+$:.unshift File.expand_path("../../lib", bin_file)
+
+require 'edi/cli'
+
+EDI::CLI.source_root(File.expand_path('../../templates', bin_file))
+EDI::CLI.start(ARGV)

data/edi.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'edi/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "edi"
+  spec.version       = EDI::VERSION
+  spec.authors       = ["DVG"]
+  spec.email         = ["bradley.temple@gmail.com"]
+  spec.summary       = %q{Chatbot Application Framework for Slack Chat Rooms}
+  spec.homepage      = "https://github.com/DVG/edi.git"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "cucumber"
+  spec.add_development_dependency "capybara"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "guard-cucumber"
+  spec.add_development_dependency "terminal-notifier-guard"
+  spec.add_dependency "sinatra"
+  spec.add_dependency "sinatra-contrib"
+  spec.add_dependency "httparty"
+  spec.add_dependency "thor"
+  spec.add_dependency "activesupport"
+  spec.add_dependency "hooks"
+  spec.add_dependency "twitter"
+  spec.add_dependency "rufus-scheduler"
+end

data/features/fact_service.feature

@@ -0,0 +1,7 @@
+@vcr
+Feature: Fact Service
+
+Scenario: EDI responds with a random fact
+  Given a server is running with the fact service enabled
+  When EDI recieves the message "EDI. fact"
+  Then EDI will respond with "38 is the number of minutes in the shortest war in history in which Zanzibar surrendered to England in 1896."

data/features/giphy_service.feature

@@ -0,0 +1,43 @@
+@vcr
+Feature: Giphy Service
+  In order to amuse my team
+  As a lover of GIFs
+  I want EDI to return random GIFs from a variety of categories
+
+  Background:
+    Given the environment is configured for Giphy
+
+  Scenario: Plain old GIF
+    Given a server is running with the giphy service enabled
+    When EDI recieves the message "EDI a gif please"
+    Then EDI will respond with "http://s3.amazonaws.com/giphymedia/media/10eqhIldgc59za/giphy.gif"
+
+  Scenario: Cat GIF - Cat Wording
+    Given a server is running with the giphy service enabled
+    When EDI recieves the message "EDI a cat gif please"
+    Then EDI will respond with "http://s3.amazonaws.com/giphymedia/media/ucEr1xRMsj6Fi/giphy.gif"
+
+  Scenario: Cat GIF - Kitty Wording
+    Given a server is running with the giphy service enabled
+    When EDI recieves the message "EDI a Kitty gif please"
+    Then EDI will respond with "http://s3.amazonaws.com/giphymedia/media/xA88mlhRVZ3lm/giphy.gif"
+
+  Scenario: Cat GIF - Kitty Wording - Case Insensitive
+    Given a server is running with the giphy service enabled
+    When EDI recieves the message "EDI a KiTty gif please"
+    Then EDI will respond with "http://s3.amazonaws.com/giphymedia/media/paYyHCsUUXQPK/giphy.gif"
+
+  Scenario: Sloth
+    Given a server is running with the giphy service enabled
+    When EDI recieves the message "EDI a sloth gif please"
+    Then EDI will respond with "http://s3.amazonaws.com/giphymedia/media/QoxeDUyerqIrC/giphy.gif"
+
+  Scenario: Bacon
+    Given a server is running with the giphy service enabled
+    When EDI recieves the message "EDI a bacon gif please"
+    Then EDI will respond with "http://s3.amazonaws.com/giphymedia/media/PJ3wMa5ImiVY4/giphy.gif"
+
+  Scenario: Trippy
+    Given a server is running with the giphy service enabled
+    When EDI recieves the message "EDI a sloth gif please"
+    Then EDI will respond with "http://s3.amazonaws.com/giphymedia/media/upNoNLqei1FVS/giphy.gif"

data/features/i_heart_quotes_service.feature

@@ -0,0 +1,21 @@
+@vcr
+Feature: I Heart Quotes
+
+  Because quotes are awesome
+  As a consumer of popular culture
+  I want EDI to return random quotes
+
+  Scenario: A Random Quote
+    Given a server is running with the i heart quotes service enabled
+    When EDI recieves the message "EDI know any good quotes?"
+    Then EDI will respond with "A random quote goes here"
+
+  Scenario: A Simpsons Quote
+    Given a server is running with the i heart quotes service enabled
+    When EDI recieves the message "EDI know any good simpsons quotes?"
+    Then EDI will respond with "Marge: I would love you if you weighed 1,000 pounds but ..."
+
+  Scenario: A Star Wars Quote
+    Given a server is running with the i heart quotes service enabled
+    When EDI recieves the message "EDI know any good star wars quotes?"
+    Then EDI will respond with "Emperor Palpatine Strike me down with all of your hatred and your journey towards the dark side will be complete!"

data/features/step_definitions/fact_service_steps.rb

@@ -0,0 +1,7 @@
+When(/^EDI recieves the message "(.*?)"$/) do |message|
+  @response = post("/edi", slack_outgoing_message(text: message))
+end
+
+Then(/^EDI will respond with "(.*?)"$/) do |message|
+  expect(parsed_response(@response)).to eq message
+end

data/features/step_definitions/giphy_steps.rb

@@ -0,0 +1,3 @@
+Given(/^the environment is configured for Giphy$/) do
+  stub_env("GIPHY_API_VERSION" => "v1", "GIPHY_API_KEY" => "key")
+end

data/features/step_definitions/server_steps.rb

@@ -0,0 +1,3 @@
+Given(/^a server is running with the (.+) service enabled$/) do |service|
+  Server.register_services service.gsub(" ", "_").to_sym
+end

data/features/step_definitions/tweet_that_steps.rb

@@ -0,0 +1,19 @@
+
+
+
+Given(/^the Tweet That is configured$/) do
+  stub_env "SLACK_TOKEN" => "slack_token",
+  "TWITTER_ACCESS_TOKEN" => "twitter_access_token",
+  "TWITTER_CONSUMER_KEY" => "twitter_consumer_key",
+  "TWITTER_CONSUMER_SECRET" => "twitter_consumer_secret",
+  "TWITTER_HANDLE" => "twitter_handle",
+  "TWITTER_TOKEN_SECRET" => "twitter_token_secret"
+end
+
+When(/^the user (.+) post a message to the general channel saying "(.*?)"$/) do |user_name, message|
+  @response = post("/edi", slack_outgoing_message(text: message, channel_id: general_channel_id, user_name: user_name))
+end
+
+def general_channel_id
+  "C0000001"
+end

data/features/step_definitions/weather_steps.rb

@@ -0,0 +1,3 @@
+Given(/^a default location of (\d+)$/) do |arg1|
+  stub_env("DEFAULT_LOCATION" => "43204")
+end

data/features/support/env.rb

@@ -0,0 +1,37 @@
+require 'cucumber'
+require 'edi'
+require 'rack/test'
+require 'byebug'
+require 'json'
+require 'capybara/cucumber'
+require 'vcr'
+require 'webmock'
+require 'edi/test_support/test_support'
+require 'edi/test_support/cucumber'
+
+
+include Rack::Test::Methods
+include EDI::TestSupport
+
+Before do
+  class Server < EDI::Server
+  end
+  Capybara.app = Server
+end
+
+After do
+  Object.send :remove_const, :Server
+end
+
+VCR.configure do |config|
+  config.cassette_library_dir = "features/support/vcr_cassettes"
+  config.hook_into :webmock
+end
+
+VCR.cucumber_tags do |t|
+  t.tag  '@vcr', :use_scenario_name => true
+end
+
+def app
+  Server
+end