Bump version to protocol version

Author: Ben Lavender

README.md

@@ -1,6 +1,6 @@
 # ChatopsControllers
 
-Rails helpers for JSON-RPC based easy chatops.
+Rails helpers for easy, JSON-RPC based chatops.
 
 A minimal controller example:
 
@@ -22,7 +22,7 @@ Some routing boilerplate is required in `config/routes.rb`:
 
 ```ruby
 Rails.application.routes.draw do
-  post "/_chatops/:action", controller: "anonymous"
+  post "/_chatops/:chatop", controller: "anonymous", action: :execute_chatop
   get  "/_chatops" => "chatops#list"
 end
 ```
@@ -103,3 +103,64 @@ foo` and `.echo foo in staging` to use two different servers to run `.echo foo`.
 script/bootstrap
 script/test
 ```
+
+## Upgrading from early versions
+
+Early versions of RPC chatops had two major changes:
+
+##### They used Rails' dynamic `:action` routing, which was depcrated in Rails 5.
+
+To work around this, you need to update your router boilerplate:
+
+This:
+
+```ruby
+  post  "/_chatops/:action", controller: "anonymous"
+```
+
+Becomes this:
+
+```ruby
+  post  "/_chatops/:chatop", controller: "anonymous", action: :execute_chatop
+```
+
+#####
+
+They did not require a prefix. Version 2 of the Chatops RPC protocol assumes a unique prefix for each endpoint. This decision was made for several reasons:
+
+ * The previous suffix-based system creates semantic ambiguities with keyword arguments
+ * Prefixes allow big improvements to `.help`
+ * Prefixes make regex-clobbering impossible
+
+To upgrade to version 2, upgrade to version 2.x of this gem. To migrate:
+
+ * Migrate your chatops to remove any prefixes you have:
+
+```ruby
+ chatop :foo, "help", /ci build whatever/, do "yay" end
+```
+
+Becomes:
+
+```ruby
+ chatop :foo, "help", /build whatever/, do "yay" end
+```
+
+ * Update your tests:
+
+```ruby
+  chat "ci build foobar"
+```
+
+Becomes:
+
+```ruby
+  chat "build foobar"
+```
+
+ * Remove and re-add your endpoint with a prefix:
+
+```
+.rpc delete https://my-endpoint.dev
+.rpc add https://my-endpoint.dev with prefix ci
+```

lib/chatops/controller.rb

@@ -15,7 +15,8 @@ def list
         namespace: self.class.chatops_namespace,
         help: self.class.chatops_help,
         error_response: self.class.chatops_error_response,
-        methods: chatops }
+        methods: chatops,
+        version: "2" }
     end
 
     def process(*args)

lib/chatops_controller/version.rb

@@ -1,3 +1,3 @@
 module ChatopsController
-  VERSION = "0.2.0"
+  VERSION = "2.0.0"
 end

spec/lib/chatops/controller_spec.rb

@@ -116,7 +116,8 @@ def rails_flexible_post(path, outer_params, jsonrpc_params = nil)
             "params" => [],
             "path" => "foobar"
           }
-        }
+        },
+        "version" => "2"
       })
     end