edi 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5dec39d30abdd3e6d06e0cf83760054aec0c9c4a
-  data.tar.gz: fd798a1b99fa7fd35a4957be70363c5aca7cf96f
+  metadata.gz: 678184e62fabd6b36de22fd7373be103a547748f
+  data.tar.gz: 22df8582ad826e7d481fe13007db80e68f6fefb9
 SHA512:
-  metadata.gz: c64a98478aff5c70c7a62ca81822dd8e72d3857777ef7763a373a5e90c89288d7b6ee51e257712047ed18da53de42c6770ab626111d5693fe95014a6edbc3a5b
-  data.tar.gz: dd6b9aa22bb635e9a954caa9b67382d9645b48cbefb6efe6a713139dd22b11245d3fcf1fe397f3602a82a361c0fdfb43a8b4c5d68170b446815076bb86c7cc56
+  metadata.gz: 7fc32a6e729f356e96ed9ee2a9014c194a01422873ef08be1e2cce3ea760ba696511a6f2ffbcc61df298b191f86b2627ddd37cf224986c760cd020febf223512
+  data.tar.gz: acc3d7ec301c1aaaa5798fe59cdacbf789de8570f343202466304675fea0f2add6bee6c4834ce3f44ca488d60bafa1d43a9b6af51e7f60baca1a4737bff34adf

data/.gitignore

@@ -21,3 +21,4 @@ tmp
 *.a
 mkmf.log
 variables.sh
+.vagrant/

data/.ruby-version

@@ -1 +1 @@
-ruby-2.1.4
+2.2.1

data/Guardfile

@@ -32,9 +32,9 @@
 #  * 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" }
+guard :rspec, cmd: 'rspec', all_on_start: true, all_after_pass: true do
+  watch(%r{^spec/.+_spec\.rb$}) { "spec" }
+  watch(%r{^lib/(.+)\.rb$})     { "spec" }
   watch('spec/spec_helper.rb')  { "spec" }
 end
 

data/README.md

@@ -42,7 +42,7 @@ class MyService < EDI::Service
 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.
+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.
 
 ### Service Routing
 
@@ -95,11 +95,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
-    Slack::Post.new(channel_id, "What do you call a fish with no eyes?").send_message
+    post_to_slack(message: "What do you call a fish with no eyes?", channel: "##{channel_name}")
     sleep 1
   end
 
@@ -108,6 +109,46 @@ class Joke < EDI::Service
   end
 end
 ```
+
+## Jobs
+
+Jobs are just Services that occur at a regular interval or specific time instead of in response to a message.
+
+They can be used to poll your CI status and let the Team know if the build is broken, or tell a joke once in awhile, or inform the team of the weather before everyone drives in.
+
+```ruby
+require 'travis'
+class CIStatus < EDI::Job
+  every "1m" :check_ci
+  channel "#general"
+
+  def check_ci
+    edi = Travis::Repository.find('DVG/EDI')
+    if edi.last_build.failed?
+      post_to_slack(message: "Oh noes, the build is broken!")
+    end
+  end
+end
+```
+
+In this example EDI is going to check the CI status of the project, and post a message to the general channel if it fails.
+
+Unlike Services, Jobs have to opt-in to posting to the chatroom with the `post` method. Jobs that run frequently may not always make a post.
+
+EDI Schedule is in-process and in-memory. It will not persist in cron if EDI shuts down. You can use the `enable_keepalive` configuration option to have EDI try and stay awake on Heroku
+
+### Configuration
+
+The following config values are available for Jobs:
+
+```
+EDI.configure do |config|
+  config.slack_incoming_webhook_url # Required, the Incoming Webhook for your slack chatroom
+  config.job_default_channel # Defaults to #general, but you can specify a different Default Channel. This will be used if you don't specify a channel in the job
+  config.enable_keepalive # If you are on heroku, this will attempt to keep your dyno alive.
+end
+```
+
 ## Ship List
 
 When these things are done, we'll be ready for 1.0

data/Vagrantfile

@@ -0,0 +1,8 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+VAGRANTFILE_API_VERSION = "2"
+
+Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
+  config.vm.box = "ubuntu/trusty64"
+  config.vm.provision :shell, path: "scripts/bootstrap_edi.sh"
+end

data/lib/edi.rb

@@ -3,6 +3,9 @@ require 'active_support/string_inquirer'
 require 'edi/core_ext'
 require "edi/version"
 require 'edi/server'
+require 'edi/dsl'
+require 'edi/postable'
+require 'edi/environment'
 require 'edi/service'
 require 'edi/exceptions'
 require 'edi/interpreter'
@@ -14,7 +17,8 @@ require 'edi/configuration'
 require 'edi/http_utilities'
 require 'edi/application'
 require 'edi/utilities/array_responder'
-require 'edi/scheduler'
+require 'edi/schedule'
+require 'edi/job'
 module EDI
   class << self
     attr_accessor :services
@@ -47,6 +51,7 @@ module EDI
     def env=(environment)
       self.config.environment = ActiveSupport::StringInquirer.new(environment)
     end
+
   end
   include EDI::HTTPUtilities
   include EDI::Configuration

data/lib/edi/application.rb

@@ -33,7 +33,7 @@ module EDI
     end
 
     def self.start_keepalive
-      EDI.keepalive
+      EDI.keepalive if EDI.config.attempt_keepalive
     end
   end
 end

data/lib/edi/configuration.rb

@@ -6,7 +6,6 @@ module EDI
     def self.included(base)
       base.include ActiveSupport::Configurable
       base.configure do |config|
-
         # Bot Name
         config.bot_name = "EDI"
 
@@ -20,6 +19,9 @@ module EDI
 
         # Autoload Services
         config.autoload_paths = ["bot/services"]
+
+        # Postable Configuration
+        config.default_channel = "#general"
       end
     end
   end

data/lib/edi/dsl.rb

@@ -0,0 +1,57 @@
+require 'hooks'
+module EDI
+  module DSL
+    module ClassMethods
+      attr_accessor :required_environment_variables, :pattern, :interpreter_phrases, :invoker
+      def phrases(*args)
+        @interpreter_phrases = args
+        reset_interpreter_pattern
+      end
+
+      def interpreter_pattern(pattern)
+        @pattern = pattern
+      end
+
+      def pattern
+        @pattern ||= concatenate_phrases_into_regex
+      end
+
+      # class MyService < EDI::Service
+      #   invoke_with :post_tweet
+      #
+      # end
+      def invoke_with(method_name)
+        send :define_method, :invoke do
+          run_hook :before_invoke
+          @response = send method_name
+          run_hook :after_invoke
+          @response
+        end
+      end
+      private
+
+      def concatenate_phrases_into_regex
+        case interpreter_phrases
+        when Array then /#{interpreter_phrases.join("|")}/i
+        when String then /#{interpreter_phrases}/i
+        end
+      end
+
+      def reset_interpreter_pattern
+        @pattern = nil
+      end
+    end
+
+
+    def run
+    end
+
+    def self.included(base)
+      base.send(:include, Hooks)
+      base.send(:extend, ClassMethods)
+      base.send(:invoke_with, :run)
+      base.send(:define_hooks, :before_invoke, :after_invoke)
+    end
+
+  end
+end

data/lib/edi/environment.rb

@@ -0,0 +1,33 @@
+module EDI
+  module Environment
+
+    module ClassMethods
+      attr_accessor :required_environment_variables
+
+      def environment(*args)
+        args.each do |sym|
+          str = sym.to_s.upcase
+          send :define_method, sym do
+            ENV[str] || ENV[str.downcase]
+          end
+          required_environment_variables << str
+        end
+      end
+      
+      def required_environment_variables
+        @required_environment_variables ||= []
+      end
+
+    end
+    
+    def validate_environment
+      self.class.required_environment_variables.each do |v|
+        raise UnfitEnvironmentException unless (ENV[v] || ENV[v.downcase])
+      end
+    end
+
+    def self.included(base)
+      base.send(:extend, ClassMethods)
+    end
+  end
+end

data/lib/edi/job.rb

@@ -0,0 +1,10 @@
+module EDI
+  class Job
+    include Environment
+    include Postable
+
+    def run
+    end
+
+  end
+end

data/lib/edi/postable.rb

@@ -0,0 +1,37 @@
+module EDI
+  module Postable
+
+    module ClassMethods
+      attr_accessor :_channel
+      def channel(channel)
+        @_channel = channel
+      end
+    end
+
+    private
+    def _actually_post(message:, channel: nil)
+      body = {
+        text: message,
+        channel: channel || self.class._channel || EDI.config.default_channel
+      }
+      EDI.post(slack_webhook_url, body: body.to_json)
+    end
+
+    public
+    def post_to_slack(message:, channel: nil)
+      begin
+        validate_environment
+      rescue EDI::UnfitEnvironmentException
+        return
+      end
+      _actually_post(message: message, channel: channel)
+    end
+
+
+    def self.included(base)
+      base.send(:extend, ClassMethods)
+      base.send(:environment, :slack_webhook_url)
+    end
+
+  end
+end

data/lib/edi/{scheduler.rb → schedule.rb}

@@ -1,12 +1,12 @@
 require 'rufus-scheduler'
 module EDI
-  module Scheduler
-    def scheduler
-      @scheduler ||= Rufus::Scheduler.new
+  module Schedule
+    def schedule
+      @schedule ||= Rufus::Scheduler.new
     end
 
     def keepalive
-      scheduler.every "30s" do
+      schedule.every "30s" do
         host = if EDI.env.development?
           puts "http://127.0.0.1:#{EDI.config.port}"
           "http://127.0.0.1:#{EDI.config.port}"
@@ -17,5 +17,5 @@ module EDI
       end
     end
   end
-  extend Scheduler
+  extend Schedule
 end

data/lib/edi/service.rb

@@ -1,7 +1,7 @@
-require 'hooks'
 module EDI
   class Service
-    include Hooks
+    include ::EDI::DSL
+    include ::EDI::Environment
 
     attr_accessor :message, :response
     def initialize(message)
@@ -17,73 +17,5 @@ module EDI
 
     end
 
-    def validate_environment
-      self.class.required_environment_variables.each do |v|
-        raise UnfitEnvironmentException unless (ENV[v] || ENV[v.downcase])
-      end
-    end
-
-    # Class Methods
-    class << self
-      attr_accessor :required_environment_variables, :pattern, :interpreter_phrases, :invoker
-    end
-
-    def self.phrases(*args)
-      @interpreter_phrases = args
-      reset_interpreter_pattern
-    end
-
-    def self.required_environment_variables
-      @required_environment_variables ||= []
-    end
-
-    def self.environment(*args)
-      args.each do |sym|
-        str = sym.to_s.upcase
-        send :define_method, sym do
-          ENV[str] || ENV[str.downcase]
-        end
-        required_environment_variables << str
-      end
-    end
-
-
-    def self.interpreter_pattern(pattern)
-      @pattern = pattern
-    end
-
-    def self.pattern
-      @pattern ||= concatenate_phrases_into_regex
-    end
-
-    # class MyService < EDI::Service
-    #   invoke_with :post_tweet
-    #
-    # end
-    def self.invoke_with(method_name)
-      send :define_method, :invoke do
-        run_hook :before_invoke
-        self.response = send method_name
-        run_hook :after_invoke
-        self.response
-      end
-    end
-
-
-    private
-
-    def self.concatenate_phrases_into_regex
-      case self.interpreter_phrases
-      when Array then /#{self.interpreter_phrases.join("|")}/i
-      when String then /#{self.interpreter_phrases}/i
-      end
-    end
-
-    def self.reset_interpreter_pattern
-      @pattern = nil
-    end
-
-    invoke_with :run
-    define_hooks :before_invoke, :after_invoke
   end
 end

data/lib/edi/version.rb

@@ -1,3 +1,3 @@
 module EDI
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/scripts/bootstrap_edi.sh

@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+
+sudo apt-get update
+sudo apt-get install -y build-essential git curl libxslt1-dev libxml2-dev libssl-dev
+
+# rvm and ruby
+su - vagrant -c "gpg --keyserver hkp://keys.gnupg.net --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3"
+su - vagrant -c 'curl -sSL https://get.rvm.io | bash -s stable'
+su - vagrant -c 'rvm install 2.1.4'
+su - vagrant -c 'rvm rvmrc warning ignore allGemfiles'

data/spec/edi/postable_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+RSpec.describe EDI::Postable, vcr: { cassette_name: 'postable', :record => :new_episodes} do
+  subject do
+    Class.new do
+      include EDI::Environment
+      include EDI::Postable
+      channel "#testing"
+    end
+  end
+
+  describe "post_to_slack" do
+    before { stub_env("SLACK_WEBHOOK_URL" => "http://api.slack.com/my/webhook/url") }
+    it "posts to the configured channel" do
+      expect(subject.new.post_to_slack(message: "Hello World").status).to eq 200
+    end
+  end
+
+  describe "Doesn't try to post if slack webhook isn't set up" do
+    before { stub_env("SLACK_WEBHOOK_URL" => nil) }
+    it "validates environment" do
+      expect(EDI).to_not receive(:post)
+      subject.new.post_to_slack message: "Hello World"
+    end
+  end
+
+  describe "Can override class-level channel definition by passing channel" do
+    before { stub_env("SLACK_WEBHOOK_URL" => "http://api.slack.com/my/webhook/url") }
+    let(:expected_body) { {text: "Hello World", channel: "#edi_testing"}.to_json }
+    it "posts with the passed in channel" do
+      expect(EDI).to receive(:post).with(ENV["SLACK_WEBHOOK_URL"], :body => expected_body)
+      subject.new.post_to_slack(message: "Hello World", channel: "#edi_testing")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -48,4 +48,6 @@ VCR.configure do |config|
   config.cassette_library_dir = "spec/support/fixtures/vcr_cassettes"
   config.configure_rspec_metadata!
   config.hook_into :webmock
+  config.filter_sensitive_data("<SLACK_WEBHOOK_URL>") { ENV["SLACK_WEBHOOK_URL"] }
+  config.allow_http_connections_when_no_cassette = true
 end

data/spec/support/fixtures/vcr_cassettes/i_heart_quotes.yml

@@ -219,4 +219,3 @@ http_interactions:
         a good kiss!","link":"http://iheartquotes.com/fortune/show/1293","source":"starwars"}'
     http_version: 
   recorded_at: Sat, 21 Feb 2015 03:02:10 GMT
-recorded_with: VCR 2.9.3

data/spec/support/fixtures/vcr_cassettes/postable.yml

@@ -0,0 +1,44 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: "<SLACK_WEBHOOK_URL>"
+    body:
+      encoding: UTF-8
+      string: '{"text":"Hello World","channel":"#testing"}'
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Origin:
+      - "*"
+      Content-Type:
+      - text/html
+      Date:
+      - Fri, 06 Mar 2015 01:00:04 GMT
+      Server:
+      - Apache
+      Strict-Transport-Security:
+      - max-age=31536000; includeSubDomains; preload
+      Vary:
+      - Accept-Encoding
+      X-Frame-Options:
+      - SAMEORIGIN
+      Content-Length:
+      - '22'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: ok
+    http_version: 
+  recorded_at: Fri, 06 Mar 2015 01:00:04 GMT
+recorded_with: VCR 2.9.3

data/templates/project/Gemfile

@@ -1,7 +1,6 @@
 source "https://rubygems.org"
 
-gem 'edi', path: "../../"
-gem 'unicorn'
+gem 'edi'
 group :development, :test do
   gem 'byebug'
 end

data/templates/project/config/environment.rb

@@ -2,11 +2,29 @@ require 'bundler/setup'
 Bundler.require(:default, ENV["RACK_ENV"].to_sym)
 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
+  # config.bot_name = "EDI"
+
   # Default response is what EDI will say in response to a message that doesn't have a registered service.
   # If you configure this to be an array of strings, a random one will be selected.
   # config.default_response = "What is this, I don't even"
+  
+  # Hello Message, returned when browsing to / on your bot's host
+  # config.hello_message = "Hello, I'm #{config.bot_name}"
+  
+  # Message returned to slack if an unconfigured service is invoked
+  # config.unfit_environment_response = "I'm really sorrt, but that service needs to be configured"
+  
+  # Message returned to slack if a third party api fails
+  # config.third_party_api_failure_response = "Most unfortunately, that service is not working right now."
+  
+  # Standard Error Response sent back to slack if anything else goes wrong
+  # config.standard_error_response = "I'm sorry, something went wrong."
 
   # 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: edi
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - DVG
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-04 00:00:00.000000000 Z
+date: 2015-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -307,6 +307,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- Vagrantfile
 - bin/edi
 - edi.gemspec
 - features/fact_service.feature
@@ -343,12 +344,16 @@ files:
 - lib/edi/configuration.rb
 - lib/edi/core_ext.rb
 - lib/edi/core_ext/symbol.rb
+- lib/edi/dsl.rb
+- lib/edi/environment.rb
 - lib/edi/exceptions.rb
 - lib/edi/http_utilities.rb
 - lib/edi/interpreter.rb
+- lib/edi/job.rb
+- lib/edi/postable.rb
 - lib/edi/refinements.rb
 - lib/edi/refinements/zip_refinement.rb
-- lib/edi/scheduler.rb
+- lib/edi/schedule.rb
 - lib/edi/server.rb
 - lib/edi/service.rb
 - lib/edi/services.rb
@@ -382,8 +387,10 @@ files:
 - lib/edi/test_support/test_support.rb
 - lib/edi/utilities/array_responder.rb
 - lib/edi/version.rb
+- scripts/bootstrap_edi.sh
 - spec/edi/edi_spec.rb
 - spec/edi/interpreter_spec.rb
+- spec/edi/postable_spec.rb
 - spec/edi/server_spec.rb
 - spec/edi/service_spec.rb
 - spec/services/dice_spec.rb
@@ -413,6 +420,7 @@ files:
 - spec/support/fixtures/vcr_cassettes/img_flip_what_if_I_told_you.yml
 - spec/support/fixtures/vcr_cassettes/img_flip_willy_wonka.yml
 - spec/support/fixtures/vcr_cassettes/img_flip_y_u_no.yml
+- spec/support/fixtures/vcr_cassettes/postable.yml
 - spec/support/fixtures/vcr_cassettes/tweet_that.yml
 - spec/support/fixtures/vcr_cassettes/weather.yml
 - spec/support/shared_contexts/server.rb
@@ -445,7 +453,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Chatbot Application Framework for Slack Chat Rooms
@@ -479,6 +487,7 @@ test_files:
 - features/weather_service.feature
 - spec/edi/edi_spec.rb
 - spec/edi/interpreter_spec.rb
+- spec/edi/postable_spec.rb
 - spec/edi/server_spec.rb
 - spec/edi/service_spec.rb
 - spec/services/dice_spec.rb
@@ -508,6 +517,7 @@ test_files:
 - spec/support/fixtures/vcr_cassettes/img_flip_what_if_I_told_you.yml
 - spec/support/fixtures/vcr_cassettes/img_flip_willy_wonka.yml
 - spec/support/fixtures/vcr_cassettes/img_flip_y_u_no.yml
+- spec/support/fixtures/vcr_cassettes/postable.yml
 - spec/support/fixtures/vcr_cassettes/tweet_that.yml
 - spec/support/fixtures/vcr_cassettes/weather.yml
 - spec/support/shared_contexts/server.rb