RubyGems - chatops-controller - Versions diffs - 3.0.3 - Mend

chatops-controller 3.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (53) hide show

checksums.yaml +7 -0
data/README.md +204 -0
data/lib/chatops-controller.rb +1 -0
data/lib/chatops.rb +21 -0
data/lib/chatops/controller.rb +209 -0
data/lib/chatops/controller/rspec.rb +5 -0
data/lib/chatops/controller/test_case.rb +5 -0
data/lib/chatops/controller/test_case_helpers.rb +91 -0
data/lib/chatops/controller/version.rb +3 -0
data/spec/dummy/README.rdoc +28 -0
data/spec/dummy/Rakefile +6 -0
data/spec/dummy/app/assets/javascripts/application.js +13 -0
data/spec/dummy/app/assets/stylesheets/application.css +15 -0
data/spec/dummy/app/controllers/application_controller.rb +5 -0
data/spec/dummy/app/helpers/application_helper.rb +2 -0
data/spec/dummy/app/views/layouts/application.html.erb +14 -0
data/spec/dummy/bin/bundle +3 -0
data/spec/dummy/bin/rails +4 -0
data/spec/dummy/bin/rake +4 -0
data/spec/dummy/bin/setup +29 -0
data/spec/dummy/config.ru +4 -0
data/spec/dummy/config/application.rb +24 -0
data/spec/dummy/config/boot.rb +5 -0
data/spec/dummy/config/database.yml +25 -0
data/spec/dummy/config/environment.rb +5 -0
data/spec/dummy/config/environments/development.rb +41 -0
data/spec/dummy/config/environments/production.rb +79 -0
data/spec/dummy/config/environments/test.rb +46 -0
data/spec/dummy/config/initializers/assets.rb +13 -0
data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
data/spec/dummy/config/initializers/cookies_serializer.rb +3 -0
data/spec/dummy/config/initializers/filter_parameter_logging.rb +4 -0
data/spec/dummy/config/initializers/inflections.rb +16 -0
data/spec/dummy/config/initializers/mime_types.rb +4 -0
data/spec/dummy/config/initializers/session_store.rb +3 -0
data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
data/spec/dummy/config/locales/en.yml +23 -0
data/spec/dummy/config/routes.rb +56 -0
data/spec/dummy/config/secrets.yml +22 -0
data/spec/dummy/db/development.sqlite3 +0 -0
data/spec/dummy/db/schema.rb +16 -0
data/spec/dummy/db/test.sqlite3 +0 -0
data/spec/dummy/log/test.log +3830 -0
data/spec/dummy/public/404.html +67 -0
data/spec/dummy/public/422.html +67 -0
data/spec/dummy/public/500.html +66 -0
data/spec/dummy/public/favicon.ico +0 -0
data/spec/dummy/spec +1 -0
data/spec/lib/chatops/controller_spec.rb +376 -0
data/spec/rails_helper.rb +65 -0
data/spec/spec_helper.rb +92 -0
data/spec/support/json_response.rb +28 -0
metadata +195 -0

data/spec/dummy/public/404.html ADDED

@@ -0,0 +1,67 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The page you were looking for doesn't exist (404)</title>
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <style>
+  body {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+    margin: 0;
+  }
+  div.dialog {
+    width: 95%;
+    max-width: 33em;
+    margin: 4em auto 0;
+  }
+  div.dialog > div {
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 12% 0;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+  div.dialog > p {
+    margin: 0 0 1em;
+    padding: 1em;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/404.html -->
+  <div class="dialog">
+    <div>
+      <h1>The page you were looking for doesn't exist.</h1>
+      <p>You may have mistyped the address or the page may have moved.</p>
+    </div>
+    <p>If you are the application owner check the logs for more information.</p>
+  </div>
+</body>
+</html>

data/spec/dummy/public/422.html ADDED

@@ -0,0 +1,67 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The change you wanted was rejected (422)</title>
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <style>
+  body {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+    margin: 0;
+  }
+  div.dialog {
+    width: 95%;
+    max-width: 33em;
+    margin: 4em auto 0;
+  }
+  div.dialog > div {
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 12% 0;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+  div.dialog > p {
+    margin: 0 0 1em;
+    padding: 1em;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/422.html -->
+  <div class="dialog">
+    <div>
+      <h1>The change you wanted was rejected.</h1>
+      <p>Maybe you tried to change something you didn't have access to.</p>
+    </div>
+    <p>If you are the application owner check the logs for more information.</p>
+  </div>
+</body>
+</html>

data/spec/dummy/public/500.html ADDED

@@ -0,0 +1,66 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>We're sorry, but something went wrong (500)</title>
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <style>
+  body {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+    margin: 0;
+  }
+  div.dialog {
+    width: 95%;
+    max-width: 33em;
+    margin: 4em auto 0;
+  }
+  div.dialog > div {
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 12% 0;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+  div.dialog > p {
+    margin: 0 0 1em;
+    padding: 1em;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/500.html -->
+  <div class="dialog">
+    <div>
+      <h1>We're sorry, but something went wrong.</h1>
+    </div>
+    <p>If you are the application owner check the logs for more information.</p>
+  </div>
+</body>
+</html>

data/spec/dummy/public/favicon.ico ADDED

File without changes

data/spec/dummy/spec ADDED

	@@ -0,0 +1 @@
1	+ ../../spec

data/spec/lib/chatops/controller_spec.rb ADDED

@@ -0,0 +1,376 @@
+require 'rails_helper'
+require 'openssl'
+require 'base64'
+describe ActionController::Base, type: :controller do
+  controller do
+    include Chatops::Controller
+    chatops_namespace :test
+    chatops_help "Chatops of and relating to testing"
+    chatops_error_response "Try checking haystack?"
+    before_action :ensure_app_given, :only => [:wcid]
+    chatop :wcid,
+    /(?:where can i deploy|wcid)(?: (?<app>\S+))?/,
+    "where can i deploy?" do
+      return jsonrpc_invalid_params("I need nope, sorry") if params[:app] == "nope"
+      jsonrpc_success "You can deploy #{params["app"]} just fine."
+    end
+    chatop :foobar,
+    /(?:how can i foo and bar all at once)?/,
+    "how to foo and bar" do
+      raise "there's always params" unless jsonrpc_params.respond_to?(:[])
+      jsonrpc_success "You just foo and bar like it just don't matter"
+    end
+    skip_before_action :ensure_method_exists, only: :non_chatop_method
+    def non_chatop_method
+      render :plain => "Why would you have something thats not a chatop?"
+    end
+    def unexcluded_chatop_method
+      render :text => "Sadly, I'll never be reached"
+    end
+    def ensure_app_given
+      return jsonrpc_invalid_params("I need an app, every time") unless params[:app].present?
+    end
+  end
+  before :each do
+    routes.draw do
+      get  "/_chatops" => "anonymous#list"
+      post  "/_chatops/:chatop", controller: "anonymous", action: :execute_chatop
+      get  "/other" => "anonymous#non_chatop_method"
+      get  "/other_will_fail" => "anonymous#unexcluded_chatop_method"
+    end
+    @private_key = OpenSSL::PKey::RSA.new(2048)
+    ENV["CHATOPS_AUTH_PUBLIC_KEY"] = @private_key.public_key.to_pem
+    ENV["CHATOPS_AUTH_BASE_URL"] = "http://test.host"
+  end
+  def rails_flexible_post(path, outer_params, jsonrpc_params = nil)
+    if Rails.version.starts_with?("4")
+      post path, outer_params.merge("params" => jsonrpc_params)
+    else
+      jsonrpc_params ||= {}
+      post path, :params => outer_params.merge("params" => jsonrpc_params)
+    end
+  end
+  it "requires authentication" do
+    request.headers["Chatops-Timestamp"] = Time.now.utc.iso8601
+    get :list
+    expect(response.status).to eq 403
+  end
+  it "allows public key authentication for a GET request" do
+    nonce = SecureRandom.hex(20)
+    timestamp = Time.now.utc.iso8601
+    request.headers["Chatops-Nonce"] = nonce
+    request.headers["Chatops-Timestamp"] = timestamp
+    digest = OpenSSL::Digest::SHA256.new
+    signature_string = "http://test.host/_chatops\n#{nonce}\n#{timestamp}\n"
+    signature = Base64.encode64(@private_key.sign(digest, signature_string))
+    request.headers["Chatops-Signature"] = "Signature keyid=foo,signature=#{signature}"
+    get :list
+    expect(response.headers["Chatops-Signature-String"]).to eq Base64.strict_encode64(signature_string)
+    expect(response.status).to eq 200
+    expect(response).to be_valid_json
+  end
+  it "allows public key authentication for a POST request" do
+    nonce = SecureRandom.hex(20)
+    timestamp = Time.now.utc.iso8601
+    request.headers["Chatops-Nonce"] = nonce
+    request.headers["Chatops-Timestamp"] = timestamp
+    digest = OpenSSL::Digest::SHA256.new
+    params = { :room_id => "123", :user => "bhuga", :params => {}}
+    body = params.to_json
+    @request.headers["Content-Type"] = "application/json"
+    @request.env["RAW_POST_DATA"] = body
+    signature_string = "http://test.host/_chatops/foobar\n#{nonce}\n#{timestamp}\n#{body}"
+    signature = Base64.encode64(@private_key.sign(digest, signature_string))
+    request.headers["Chatops-Signature"] = "Signature keyid=foo,signature=#{signature}"
+    major_version = Rails.version.split(".")[0].to_i
+    if major_version >= 5
+      post :execute_chatop, params: params.merge(chatop: "foobar")
+    else
+      post :execute_chatop, params.merge(chatop: "foobar")
+    end
+    expect(response.status).to eq 200
+    expect(response).to be_valid_json
+  end
+  it "allows using a second public key to authenticate" do
+    ENV["CHATOPS_AUTH_ALT_PUBLIC_KEY"] = ENV["CHATOPS_AUTH_PUBLIC_KEY"]
+    other_key = OpenSSL::PKey::RSA.new(2048)
+    ENV["CHATOPS_AUTH_PUBLIC_KEY"] = other_key.public_key.to_pem
+    nonce = SecureRandom.hex(20)
+    timestamp = Time.now.utc.iso8601
+    request.headers["Chatops-Nonce"] = nonce
+    request.headers["Chatops-Timestamp"] = timestamp
+    digest = OpenSSL::Digest::SHA256.new
+    signature_string = "http://test.host/_chatops\n#{nonce}\n#{timestamp}\n"
+    signature = Base64.encode64(@private_key.sign(digest, signature_string))
+    request.headers["Chatops-Signature"] = "Signature keyid=foo,signature=#{signature}"
+    get :list
+    expect(response.status).to eq 200
+    expect(response).to be_valid_json
+  end
+  it "raises an error trying to auth without a base url" do
+    nonce = SecureRandom.hex(20)
+    timestamp = Time.now.utc.iso8601
+    request.headers["Chatops-Nonce"] = nonce
+    request.headers["Chatops-Timestamp"] = timestamp
+    digest = OpenSSL::Digest::SHA256.new
+    signature_string = "http://test.host/_chatops\n#{nonce}\n#{timestamp}\n"
+    signature = Base64.encode64(@private_key.sign(digest, signature_string))
+    request.headers["Chatops-Signature"] = "Signature keyid=foo,signature=#{signature}"
+    ENV.delete "CHATOPS_AUTH_BASE_URL"
+    expect {
+      get :list
+    }.to raise_error(Chatops::Controller::ConfigurationError)
+  end
+  it "raises an error trying to auth without a public key" do
+    nonce = SecureRandom.hex(20)
+    timestamp = Time.now.utc.iso8601
+    request.headers["Chatops-Nonce"] = nonce
+    request.headers["Chatops-Timestamp"] = timestamp
+    digest = OpenSSL::Digest::SHA256.new
+    signature_string = "http://test.host/_chatops\n#{nonce}\n#{timestamp}\n"
+    signature = Base64.encode64(@private_key.sign(digest, signature_string))
+    request.headers["Chatops-Signature"] = "Signature keyid=foo,signature=#{signature}"
+    ENV.delete "CHATOPS_AUTH_PUBLIC_KEY"
+    expect {
+      get :list
+    }.to raise_error(Chatops::Controller::ConfigurationError)
+  end
+  it "doesn't authenticate with the wrong public key'" do
+    other_key = OpenSSL::PKey::RSA.new(2048)
+    ENV["CHATOPS_AUTH_PUBLIC_KEY"] = other_key.public_key.to_pem
+    nonce = SecureRandom.hex(20)
+    timestamp = Time.now.utc.iso8601
+    request.headers["Chatops-Nonce"] = nonce
+    request.headers["Chatops-Timestamp"] = timestamp
+    digest = OpenSSL::Digest::SHA256.new
+    signature_string = "http://test.host/_chatops\n#{nonce}\n#{timestamp}\n"
+    signature = Base64.encode64(@private_key.sign(digest, signature_string))
+    request.headers["Chatops-Signature"] = "Signature keyid=foo,signature=#{signature}"
+    get :list
+    expect(response.status).to eq 403
+  end
+  it "doesn't allow requests more than 1 minute old" do
+    nonce = SecureRandom.hex(20)
+    timestamp = 2.minutes.ago.utc.iso8601
+    request.headers["Chatops-Nonce"] = nonce
+    request.headers["Chatops-Timestamp"] = timestamp
+    digest = OpenSSL::Digest::SHA256.new
+    signature_string = "http://test.host/_chatops\n#{nonce}\n#{timestamp}\n"
+    signature = Base64.encode64(@private_key.sign(digest, signature_string))
+    request.headers["Chatops-Signature"] = "Signature keyid=foo,signature=#{signature}"
+    get :list
+    expect(response.status).to eq 403
+    expect(response.body).to include "Chatops timestamp not within 1 minute"
+  end
+  it "doesn't allow requests more than 1 minute in the future" do
+    nonce = SecureRandom.hex(20)
+    timestamp = 2.minutes.from_now.utc.iso8601
+    request.headers["Chatops-Nonce"] = nonce
+    request.headers["Chatops-Timestamp"] = timestamp
+    digest = OpenSSL::Digest::SHA256.new
+    signature_string = "http://test.host/_chatops\n#{nonce}\n#{timestamp}\n"
+    signature = Base64.encode64(@private_key.sign(digest, signature_string))
+    request.headers["Chatops-Signature"] = "Signature keyid=foo,signature=#{signature}"
+    get :list
+    expect(response.status).to eq 403
+    expect(response.body).to include "Chatops timestamp not within 1 minute"
+  end
+  it "does not add authentication to non-chatops routes" do
+    get :non_chatop_method
+    expect(response.status).to eq 200
+    expect(response.body).to eq "Why would you have something thats not a chatop?"
+  end
+  context "when authenticated" do
+    before do
+      chatops_auth!
+    end
+    it "provides a list method" do
+      get :list
+      expect(response.status).to eq 200
+      expect(json_response).to eq({
+        "namespace" => "test",
+        "help" => "Chatops of and relating to testing",
+        "error_response" => "Try checking haystack?",
+        "methods" => {
+          "wcid" => {
+            "help" => "where can i deploy?",
+            "regex" => /(?:where can i deploy|wcid)(?: (?<app>\S+))?/.source,
+            "params" => ["app"],
+            "path" => "wcid"
+          },
+          "foobar" => {
+            "help" => "how to foo and bar",
+            "regex" => /(?:how can i foo and bar all at once)?/.source,
+            "params" => [],
+            "path" => "foobar"
+          }
+        },
+        "version" => "3"
+      })
+    end
+    it "requires a user be sent to chatops" do
+      rails_flexible_post :execute_chatop, chatop: :foobar
+      expect(response.status).to eq 400
+      expect(json_response).to eq({
+        "jsonrpc" => "2.0",
+        "id" => nil,
+        "error" => {
+          "code" => -32602,
+          "message" => "A username must be supplied as 'user'"
+        }
+      })
+    end
+    it "returns method not found for a not found method" do
+      rails_flexible_post :execute_chatop, chatop: :barfoo, user: "foo"
+      expect(json_response).to eq({
+        "jsonrpc" => "2.0",
+        "id" => nil,
+        "error" => {
+          "code" => -32601,
+          "message" => "Method not found"
+        }
+      })
+      expect(response.status).to eq 404
+    end
+    it "requires skipping a before_action to find non-chatop methods, sorry about that" do
+      get :unexcluded_chatop_method
+      expect(json_response).to eq({
+        "jsonrpc" => "2.0",
+        "id" => nil,
+        "error" => {
+          "code" => -32601,
+          "message" => "Method not found"
+        }
+      })
+      expect(response.status).to eq 404
+    end
+    it "runs a known method" do
+      rails_flexible_post :execute_chatop, chatop: :foobar, user: "foo"
+      expect(json_response).to eq({
+        "jsonrpc" => "2.0",
+        "id" => nil,
+        "result" => "You just foo and bar like it just don't matter"
+      })
+      expect(response.status).to eq 200
+    end
+    it "passes parameters to methods" do
+      rails_flexible_post :execute_chatop, { :chatop => "wcid", :user => "foo" }, { "app" => "foo" }
+      expect(json_response).to eq({
+        "jsonrpc" => "2.0",
+        "id" => nil,
+        "result" => "You can deploy foo just fine."
+      })
+      expect(response.status).to eq 200
+    end
+    it "uses typical controller fun like before_action" do
+      rails_flexible_post :execute_chatop, :chatop => "wcid", :user => "foo"
+      expect(json_response).to eq({
+        "jsonrpc" => "2.0",
+        "id" => nil,
+        "error" => {
+          "code" => -32602,
+          "message" => "I need an app, every time"
+        }
+      })
+      expect(response.status).to eq 400
+    end
+    it "allows methods to return invalid params with a message" do
+      rails_flexible_post :execute_chatop, { :chatop => "wcid", :user => "foo" }, { "app" => "nope" }
+      expect(response.status).to eq 400
+      expect(json_response).to eq({
+        "jsonrpc" => "2.0",
+        "id" => nil,
+        "error" => {
+          "code" => -32602,
+          "message" => "I need nope, sorry"
+        }
+      })
+    end
+    context "rspec helpers" do
+      it "makes it easy to test a response" do
+        chatop "wcid", :user => "foo", :app => "foo"
+        expect(chatop_response).to eq "You can deploy foo just fine."
+      end
+      it "makes it easy to test an error message" do
+        chatop "wcid", :user => "foo", :app => "nope"
+        expect(chatop_error).to eq "I need nope, sorry"
+      end
+    end
+    context "regex-based test helpers" do
+      it "routes based on regexes from test helpers" do
+        chat "where can i deploy foobar", "bhuga"
+        expect(request.params["action"]).to eq "execute_chatop"
+        expect(request.params["chatop"]).to eq "wcid"
+        expect(request.params["user"]).to eq "bhuga"
+        expect(request.params["params"]["app"]).to eq "foobar"
+        expect(chatop_response).to eq "You can deploy foobar just fine."
+      end
+      it "works with generic arguments" do
+        chat "where can i deploy foobar --fruit apple --vegetable green celery", "bhuga"
+        expect(request.params["action"]).to eq "execute_chatop"
+        expect(request.params["chatop"]).to eq "wcid"
+        expect(request.params["user"]).to eq "bhuga"
+        expect(request.params["params"]["app"]).to eq "foobar"
+        expect(request.params["params"]["fruit"]).to eq "apple"
+        expect(request.params["params"]["vegetable"]).to eq "green celery"
+        expect(chatop_response).to eq "You can deploy foobar just fine."
+      end
+      it "works with boolean arguments" do
+        chat "where can i deploy foobar --this-is-sparta", "bhuga"
+        expect(request.params["action"]).to eq "execute_chatop"
+        expect(request.params["chatop"]).to eq "wcid"
+        expect(request.params["user"]).to eq "bhuga"
+        expect(request.params["params"]["this-is-sparta"]).to eq "true"
+      end
+      it "anchors regexes" do
+        expect {
+          chat "too bad that this message doesn't start with where can i deploy foobar", "bhuga"
+        }.to raise_error(Chatops::Controller::TestCaseHelpers::NoMatchingCommandRegex)
+      end
+      it "allows setting a v2 prefix" do
+        chatops_prefix "test-prefix"
+        chat "test-prefix where can i deploy foobar --this-is-sparta", "bhuga"
+        expect(request.params["chatop"]).to eq "wcid"
+      end
+    end
+  end
+end