jarvis-cli 0.0.1 → 0.0.2

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    OWI3NjY2OTRkOWIyZmYwZTA2ZGM5ZTc5MTZkNzc0OGNmM2MxOWVlZA==
-  data.tar.gz: !binary |-
-    ODc1MGM3OWRkYmM3ZDJlMWU3NzA4N2VhZDJhNDM5NTczY2Q1MWNhMA==
+SHA1:
+  metadata.gz: b00e1af36800728f18b6252fcaa52805307dc319
+  data.tar.gz: 8cd5db44811394a71a130c41831c8c7835299719
 SHA512:
-  metadata.gz: !binary |-
-    NDMzMjI2YzQ4YmMzM2I4YzAwYjU1Nzk3MWM2YTJlY2YxNTgxMGNhYmI0Yzdk
-    NTE5ZDgyNmI1OTM3NTAxY2FlNDgzMzlmMDg2M2RmMDViYzAxMjc2NmUyY2E3
-    YmZmNTM1YzM4Y2U3NjhmNTY3M2I2OTlmMWU5ODZmNjM5NjJlMTI=
-  data.tar.gz: !binary |-
-    ZTEwZWY2ZDM4NzE5MDVmOTNhMGNlOTYxZTBhODZkZDRhNzI5NGY4MjlkYjUy
-    YTU4NTk1Y2MzMDI4ZTM5ZTgyMTg1YTJkNWRmNGIwMThkZmUzODg2MDM0YTBj
-    YjIyN2YxNzBiMzcyM2M3ZDMzNjQwYTk0MTI5MDY4NTBkN2Y4YzE=
+  metadata.gz: ecff8497b0b166655b85f56a77f9cb832b00b46401fc1ae7a51031ba990d76c7c4778e9125381f637d4b3dbd2d0d809ae5aaa0e0f083bbb1bf5c9d59345a8218
+  data.tar.gz: d5e48fd4ff84fb44f92f13bddb58b77051a23d6995a6f1445b56f2671b63aefb4bb1dbf332c54585aff8b29b8d2464239937d95e68af5d9208e9e1851fc966d6

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/README.md

@@ -1,4 +1,4 @@
-# Jarvis CLI
+# Jarvis CLI [![Build Status](https://travis-ci.org/DVG/jarvis-cli.svg?branch=master)](https://travis-ci.org/DVG/jarvis-cli)
 
 ## Warning, these instructions are not true yet, but they will be!
 
@@ -18,7 +18,7 @@ Or install it yourself as:
 
 ## Usage
 
-Jarvis is an application framework for building Chat bots to integrate with your Slack chatroom. It ships with a number of useful and funny built-in services, but it also provides and easy DSL for creating your own services.
+Jarvis 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
 
@@ -34,7 +34,7 @@ $ jarvis new my-bot
 
 ```ruby
 class MyBot < Jarvis::Server
-  register_services Twitter, ImgFlip, UrbanDictionary, Weather
+  register_services :twitter, :img_flip, :urban_dictionary, :weather
 end
 ```
 
@@ -46,12 +46,76 @@ If a Service integrates with an authenticated, third party API, you may need to
 
 ```ruby
 class MyService < Jarvis::Service
-  required_environment "SERVICE_TOKEN", "SERVICE_SECRET"
+  environment :service_token, :service_secret
 end
 ```
 
-If a service is Registered in `app/server.rb` but does not have it's expected environment, Jarvis will throw an exception and respond with a polite refusal to execute the service. This message can be set in your Jarvis configuration.
+If a service is Registered in `app/server.rb` but does not have it's expected environment, Jarvis will throw an exception and respond with a polite refusal to execute the service. This message can be set in your Jarvis configuration. The enviornment method will also create a getter method for each environment variable.
 
+### Service Routing
+
+There are two ways to tell Jarvis to send a given message to a particular service.`interpreter_pattern` and `phrases`
+
+```ruby
+class ImgFlip < Jarvis::Service
+  phrases = "success kid", "overly attached girlfriend"
+  # will converted to a pattern that looks like /success kid|overly attached girlfriend/i
+end
+class SortingHat < Jarvis::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 Jarvis will send back to the channel in slack.
+
+A very simple service might look like:
+
+```ruby
+class SortingHat < Jarvis::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 < Jarvis::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 Jarvis responds. For instance:
+
+```ruby
+class Joke < Jarvis::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
+```
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/jarvis_server/fork )

data/bin/jarvis

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

data/features/fact_service.feature

@@ -0,0 +1,7 @@
+@vcr
+Feature: Fact Service
+
+Scenario: Jarvis responds with a random fact
+  Given a server is running with the fact service enabled
+  When Jarvis recieves the message "Jarvis. fact"
+  Then Jarvis will respond with "536 is the number of ways to arrange the pieces of the stomachion puzzle into a square."

data/features/step_definitions/fact_service_steps.rb

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

data/features/step_definitions/server_steps.rb

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

data/features/support/env.rb

@@ -0,0 +1,38 @@
+require 'cucumber'
+require 'jarvis'
+require 'rack/test'
+require 'byebug'
+require 'json'
+require 'capybara/cucumber'
+require 'vcr'
+require 'webmock'
+require 'jarvis/test_support/test_support'
+
+
+include Rack::Test::Methods
+include Jarvis::TestSupport
+
+Before do
+  class Server < Jarvis::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

data/features/support/hooks.rb

@@ -0,0 +1 @@
+

data/features/support/vcr_cassettes/Fact_Service/Jarvis_responds_with_a_random_fact.yml

@@ -0,0 +1,52 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://numbersapi.com/random
+    body:
+      encoding: US-ASCII
+      string: ''
+    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:
+      Server:
+      - nginx/1.4.6 (Ubuntu)
+      Date:
+      - Fri, 20 Feb 2015 15:14:17 GMT
+      Content-Type:
+      - text/plain; charset="UTF-8"; charset=utf-8
+      Content-Length:
+      - '64'
+      Connection:
+      - keep-alive
+      X-Powered-By:
+      - Express
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Headers:
+      - X-Requested-With
+      X-Numbers-Api-Number:
+      - '149000000'
+      X-Numbers-Api-Type:
+      - trivia
+      Pragma:
+      - no-cache
+      Cache-Control:
+      - no-cache
+      Expires:
+      - '0'
+    body:
+      encoding: UTF-8
+      string: 536 is the number of ways to arrange the pieces of the stomachion puzzle into a square.
+    http_version:
+  recorded_at: Fri, 20 Feb 2015 15:14:02 GMT
+recorded_with: VCR 2.9.3

data/jarvis-cli.gemspec

@@ -20,7 +20,15 @@ Gem::Specification.new do |spec|
   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_dependency "sinatra"
   spec.add_dependency "sinatra-contrib"
   spec.add_dependency "httparty"
+  spec.add_dependency "thor"
+  spec.add_dependency "activesupport"
+  spec.add_dependency "hooks"
 end

data/lib/jarvis/cli.rb

@@ -0,0 +1,25 @@
+require 'thor'
+module Jarvis
+  class CLI < Thor
+    include Thor::Actions
+
+    desc "new BOT_NAME", "Sets up a new Jarvis project"
+    def new(name)
+      @name = Thor::Util.snake_case(name)
+      directory(:project, @name)
+    end
+
+    desc "boot", "Bootup the Jarvis Application"
+    def boot(*args)
+      port_option = args.include?('-p') ? '' : ' -p 3030'
+      command = "rackup #{port_option}"
+      run_command(command)
+    end
+
+private
+
+    def run_command(command)
+      system(command)
+    end
+  end
+end

data/lib/jarvis/core_ext/symbol.rb

@@ -0,0 +1,7 @@
+require 'active_support/core_ext'
+
+class Symbol
+  def constantize
+    self.to_s.camelize.constantize
+  end
+end

data/lib/jarvis/core_ext.rb

@@ -0,0 +1 @@
+require 'jarvis/core_ext/symbol'

data/lib/jarvis/interpreter.rb

@@ -0,0 +1,32 @@
+module Jarvis
+  class Interpreter
+    attr_accessor :slack_message, :text
+    def initialize(slack_message)
+      @slack_message = slack_message
+      @text = slack_message.text
+    end
+
+
+private
+
+    def self.build_determine_service
+      determine_service = <<-code
+        def determine_service
+          case text
+      code
+      Jarvis.services.each do |service|
+        constant = service.constantize
+        determine_service += <<-code
+          when #{constant.interpreter_pattern.inspect} then #{constant}
+        code
+      end
+      determine_service += <<-code
+          else
+            NullService
+          end
+        end
+      code
+      self.class_eval determine_service
+    end
+  end
+end

data/lib/jarvis/server.rb

@@ -9,6 +9,25 @@ module Jarvis
       json text: "Hello, I'm Jarvis"
     end
 
+    post "/jarvis" do
+      message = Slack::Message.new(params)
+      service = Jarvis::Interpreter.new(message).determine_service.new(message)
+      begin
+        json text: run_service(service)
+      rescue Jarvis::UnfitEnvironmentException => e
+        json text: "I'm really sorry, but that sevice needs to be configured"
+      rescue => e
+        json text: "I'm sorry, Something went wrong"
+      end
+    end
+
+private
+
+    def run_service(service)
+      service.validate_environment
+      service.invoke
+    end
+
     run! if app_file == $0
   end
 end

data/lib/jarvis/service.rb

@@ -1,16 +1,83 @@
+require 'hooks'
 module Jarvis
   class Service
-    class << self
-      attr_accessor :required_environment_variables
-      def required_environment(*args)
-        @required_environment_variables = args
-      end
+    include Hooks
+
+    attr_accessor :message, :response
+    def initialize(message)
+      @message = message
+      @response = ""
+    end
+
+    def method_missing(name, *args, &blk)
+      message.public_send(name, *args, &blk)
+    end
+
+    def run
+
     end
 
     def validate_environment
       self.class.required_environment_variables.each do |v|
-        raise UnfitEnvironmentException unless ENV[v]
+        raise UnfitEnvironmentException unless (ENV[v] || ENV[v.downcase])
       end
     end
+
+    # Class Methods
+    class << self
+      attr_accessor :required_environment_variables, :interpreter_pattern, :phrases, :invoker
+
+      def phrases=(*args)
+        @phrases = args
+        reset_interpreter_pattern
+      end
+
+      def required_environment_variables
+        @required_environment_variables ||= []
+      end
+
+      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 interpreter_pattern
+        @interpreter_pattern ||= concatenate_phrases_into_regex
+      end
+      # class MyService < Jarvis::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 self.phrases
+        when Array then /#{self.phrases.join("|")}/i
+        when String then /#{self.phrases}/i
+        end
+      end
+
+      def reset_interpreter_pattern
+        @interpreter_pattern = nil
+      end
+    end
+
+    invoke_with :run
+    define_hooks :before_invoke, :after_invoke
   end
 end

data/lib/jarvis/services/dice.rb

@@ -0,0 +1,25 @@
+class Dice < Jarvis::Service
+  attr_accessor :dice_result
+  phrases = "roll", "dice"
+  before_invoke :perform_roll
+
+  def run
+    "You got a #{dice_result}"
+  end
+
+private
+
+  def perform_roll
+    input = extract_dice_expression.split("d").map(&:to_i)
+    self.dice_result = input[0].times.map{ roll input[1] }.inject(:+)
+  end
+
+  def extract_dice_expression
+    text[/(\d+[d]\d+)/]
+  end
+
+  def roll(sides)
+    Random.rand(sides)
+  end
+
+end

data/lib/jarvis/services/eightball.rb

@@ -0,0 +1,38 @@
+class Eightball < Jarvis::Service
+
+  interpreter_pattern = /\?$/
+
+  def run
+    responses.sample
+  end
+
+private
+
+  def responses
+    [
+      "It is certain",
+      "It is decidedly so",
+      "Without a doubt",
+      "Yes definitely",
+      "You may rely on it",
+      "As I see it, yes",
+      "Most likely",
+      "Outlook good",
+      "Yes",
+      "Signs point to yes",
+      "Reply hazy try again",
+      "Ask again later",
+      "Better not tell you now",
+      "Cannot predict now",
+      "Concentrate and ask again",
+      "Don't count on it",
+      "My reply is no",
+      "My sources say no",
+      "Outlook not so good",
+      "Very doubtful",
+      "I dont even",
+      "NO",
+      "Seriously?"
+    ]
+  end
+end

data/lib/jarvis/services/fact.rb

@@ -0,0 +1,7 @@
+class Fact < Jarvis::Service
+  self.phrases = "fact"
+
+  def run
+    Jarvis.get("http://numbersapi.com/random").parsed_response
+  end
+end

data/lib/jarvis/services/null_service.rb

@@ -0,0 +1,2 @@
+class NullService < Jarvis::Service
+end

data/lib/jarvis/services.rb

@@ -0,0 +1,4 @@
+require 'jarvis/services/null_service'
+require 'jarvis/services/dice'
+require 'jarvis/services/eightball'
+require 'jarvis/services/fact'

data/lib/jarvis/slack/message.rb

@@ -0,0 +1,17 @@
+module Slack
+  class Message
+
+    attr_accessor :text, :channel_id, :team_id, :channel_name, :user_id, :user_name, :trigger_word
+
+    def initialize(params)
+      @text = params["text"]
+      @channel_id = params["channel_id"]
+      @team_id = params["team_id"]
+      @channel_name = params["channel_name"]
+      @user_id = params["user_id"]
+      @user_name = params["user_name"]
+      @trigger_word = params["trigger_word"]
+    end
+
+  end
+end

data/lib/jarvis/slack.rb

@@ -0,0 +1 @@
+require 'jarvis/slack/message'

data/lib/jarvis/test_support/test_support.rb

@@ -0,0 +1,20 @@
+module Jarvis
+  module TestSupport
+    def slack_outgoing_message(options={text:"Jarvis, what's going on?"})
+      {
+        "team_id" => options[:team_id] || "T0001",
+        "channel_id" => options[:channel_id] || "BLAH",
+        "channel_name" => options[:channel_name] || "test",
+        "timestamp" => options[:timestamp] || "1355517523.000005",
+        "user_id" => options[:user_id] || "U2147483697",
+        "user_name" => options[:user_name] || "Steve",
+        "text" => options[:text],
+        "trigger_word" => options[:trigger_word] || "Jarvis"
+      }
+    end
+
+    def parsed_response(response)
+      JSON.parse(response.body)["text"]
+    end
+  end
+end

data/lib/jarvis/version.rb

@@ -1,3 +1,3 @@
 module Jarvis
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/jarvis.rb

@@ -1,9 +1,17 @@
+require 'active_support'
+require 'jarvis/core_ext'
 require "jarvis/version"
 require 'jarvis/server'
 require 'jarvis/service'
 require 'jarvis/exceptions'
+require 'jarvis/interpreter'
+require 'jarvis/services'
+require 'jarvis/slack'
+require 'httparty'
+require 'uri'
 
 module Jarvis
+  include HTTParty
   class << self
 
     attr_accessor :services
@@ -11,8 +19,17 @@ module Jarvis
       @services ||= []
     end
 
-    def register(klass)
-      services << klass
+    def register_services(*args)
+      args.each { |klass| services << klass}
+      Jarvis::Interpreter.build_determine_service
+    end
+
+    def clear_services
+      @services = []
+    end
+
+    def get(*args, &blk)
+      HTTParty.get(*args, &blk)
     end
 
   end