cogy 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0d68c05583565f05400bafb31ec6487ed3ed72d2
-  data.tar.gz: a693a5479f2ea5c0a74ebcca4d17a1ea5ac7e5b5
+  metadata.gz: a8aa6c2ef3205ba369337329ccb410e7e04721f8
+  data.tar.gz: 8ee9376fa3a2b06846fdd32f5807753824639efc
 SHA512:
-  metadata.gz: 115ffd20c179abbdf00324759778b7ad5945213c91f6724b5e41e0f3f0f860ebd0c1c9412b5380d7bdbebd3f47876f3c22468cc52ae75f4abad235a4b55786c5
-  data.tar.gz: 02c5c9aec2d01c167a6b29e027b787988d627e27692ea24370c45491b7a0f8b0583631d0b4955eb143d6dea9ceca3c0b1a9a30359f7f9b091508ee492c710c33
+  metadata.gz: 163f6aaf64c9d1c5e596371d81980d537122bb930a04674d8dca06a5c4411aa59a9be42e260275724899e8d39f8d9b428789edb4cd0564c217b373c17eb11694
+  data.tar.gz: cf617969c35eb9c9abc90f7d2534f79c76671ae9f3cf239e45452e0e74e271ae8661906e0bb680afe8d4ea46d1dd67524ade46d38209deb29fd4c03c9c95322e

data/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 ## master (unreleased)
 
+## 0.5.0 (2017-01-25)
+
+### Changed
+
+- The `COGY_BACKEND` env. variable is now shipped from Cogy, so you don't have
+  to set it in the Relays anymore ([#37](https://github.com/skroutz/cogy/issues/37)).
+  This has the side-effect of `Cogy.cogy_endpoint` configuration being *required*
+  if you use the Capistrano tasks, since they use it instead of the old,
+  Capistrano-specific setting.
+
 ## 0.4.0 (2016-12-05)
 
 This release requires the [cogy-bundle](https://github.com/skroutz/cogy-bundle)

data/README.md

@@ -2,7 +2,6 @@
 
 [![Build Status](https://api.travis-ci.org/skroutz/cogy.svg?branch=master)](https://travis-ci.org/skroutz/cogy)
 [![Gem Version](https://badge.fury.io/rb/cogy.svg)](https://badge.fury.io/rb/cogy)
-[![Inline docs](http://inch-ci.org/github/skroutz/cogy.svg)](http://inch-ci.org/github/skroutz/cogy)
 
 Cogy integrates [Cog](https://operable.io/) with Rails
 in a way that writing & deploying commands from your application is a breeze.
@@ -13,13 +12,13 @@ Refer to the [Changelog](CHANGELOG.md) to see what's changed between releases.
 
 ## Features
 
-- Write commands inside your Rails app, using Ruby (see [_Usage_](#usage))
-- The bundle config is generated automatically
+- Define commands from your Rails app (see [_Usage_](#usage))
+- Bundle config is generated automatically
 - Commands are installed _automatically_ when you deploy (see [_Deployment_](#deployment))
-- Support for JSON responses and Templates (see [_Returning JSON to COG_](#returning-json-to-cog))
-- Customizable error templates (see [_Error template_](#error-template))
+- Supports JSON responses and Cog Templates (see [_Returning JSON to COG_](#returning-json-to-cog))
+- Customizable error template (see [_Error template_](#error-template))
 
-...and more on the way!
+...and [more on the way](https://github.com/skroutz/cogy/issues?q=is%3Aopen+is%3Aissue+label%3Afeature)!
 
 ## Why
 
@@ -73,7 +72,7 @@ Take a look at the relevant [diagrams](diagrams/) for a detailed illustration.
 
 ## Requirements
 
-* [cogy bundle v0.3.0+](https://github.com/skroutz/cogy-bundle)
+* [cogy bundle v0.4.0+](https://github.com/skroutz/cogy-bundle)
 * Ruby 2.1+
 * Rails 4.2 (support for Rails 5 is on the way)
 
@@ -189,7 +188,7 @@ Info on how Cog handles JSON can be found in the [official documentation](https:
 
 ### Templates
 
-Templates are defined in their own files under `templates/` inside any of
+[Templates](https://cog-book.operable.io/#_templates) are defined in their own files under `templates/` inside any of
 the [command load paths](#Configuration). For example:
 
 ```
@@ -272,6 +271,10 @@ Cogy.configure do |config|
 
     # The path in the Relay where the cogy command executable is located.
     cogy_executable: "/cogcmd/cogy"
+
+    # The endpoint where Cogy is reachable at. This depends on where you've
+    # mounted the Cogy engine at.
+    cogy_endpoint: "http://www.example.com/cogy"
   }
 
   # Paths in your application where the files that define the commands live in.
@@ -350,33 +353,26 @@ is the following:
 It can be overriden in the application by creating a view in
 `app/views/cogy/error.text.erb`.
 
-## Installation Trigger
+## Testing commands
 
-In order to automate the process of installing the new bundle versions
-(eg. after a new command is added), you must create a [Cog Trigger](https://cog-book.operable.io/#_developing_a_trigger)
-that will perform the installation, which will be called when you deploy your
-app.
-
-The trigger will look this:
+We don't yet provide means to write tests for the commands, but you can easily
+test them by executing a request to your development server:
 
 ```shell
-$ cogctl triggers
-Name               ID                                    Enabled  Pipeline
-ReleaseUrlTrigger  d10df83b-a737-4fc4-8d9b-bf9627412d0a  true     cogy:install --url $body.url > chat://#general
+$ curl -XPOST --data "COG_ARGV_0=foo" http://localhost:3000/cogy/foo
 ```
 
-It essentially uses the [cogy bundle](https://github.com/skroutz/cogy-bundle)
-and installs the bundle config which is served by your application
-(ie. http://your-app.com/cogy/inventory).
+In the request body you may pass the complete or any part of the
+[Cog environment](https://cog-book.operable.io/#_command_environment_variables) you need.
 
-See [_Deployment_](#deployment) on information about how this trigger is
-invoked.
+This is essentially what the [cogy executable](https://github.com/skroutz/cogy-bundle)
+also does.
 
 ## Deployment
 
-Cogy provides integration with Capistrano 2 and 3.
+Cogy provides integration with Capistrano 2 & 3.
 
-There is the just one task, `cogy:notify_cog`, which just executes the
+There is just one task, `cogy:notify_cog`, which executes the
 [installation Trigger](#installation-trigger).
 
 The task should run
@@ -386,10 +382,9 @@ example, it should run after the built-in `deploy:restart` task.
 
 The following options need to be set:
 
+* `Cogy.cogy_endpoint`: See [*Configuration*](#Configuration).
 * `cogy_release_trigger_url`: This is the URL of the Cog Trigger that will
   install the newly deployed bundle (ie. `!cogy:install`).
-* `cogy_endpoint`: Where the Cogy Engine is mounted at.
-  For example `http://myapp.com/cogy`.
 
 You can also configure the timeout value for the request to the Trigger by
 setting the `cogy_trigger_timeout` option (default: 7).
@@ -405,7 +400,6 @@ Add the following in `config/deploy.rb`:
 require "cogy/capistrano"
 
 set :cogy_release_trigger_url, "<TRIGGER-INVOCATION-URL>"
-set :cogy_endpoint, "<COGY-MOUNT-POINT>"
 
 after "deploy:restart", "cogy:notify_cog"
 ```
@@ -424,11 +418,32 @@ Then configure the task and hook it:
 # in config/deploy.rb
 
 set :cogy_release_trigger_url, "<TRIGGER-INVOCATION-URL>"
-set :cogy_endpoint, "<COGY-MOUNT-POINT>"
 
 after "<app-restart-task>", "cogy:notify_cog"
 ```
 
+### Installation Trigger
+
+In order to automate the process of installing the new bundle versions
+(eg. after a new command is added), you must create a [Cog Trigger](https://cog-book.operable.io/#_developing_a_trigger)
+that will perform the installation, which will be called when you deploy your
+app.
+
+The trigger will look this:
+
+```shell
+$ cogctl triggers
+Name               ID                                    Enabled  Pipeline
+ReleaseUrlTrigger  d10df83b-a737-4fc4-8d9b-bf9627412d0a  true     cogy:install --url $body.url > chat://#general
+```
+
+It essentially uses the [cogy bundle](https://github.com/skroutz/cogy-bundle)
+and installs the bundle config which is served by your application
+(ie. http://your-app.com/cogy/inventory).
+
+See [_Deployment_](#deployment) on information about how this trigger is
+invoked.
+
 ## Development
 
 Running the tests and RuboCop:

data/lib/cogy/capistrano/cogy.rake

@@ -6,11 +6,11 @@ namespace :cogy do
     require "json"
 
     trigger_url = fetch(:cogy_release_trigger_url)
-    cogy_endpoint = fetch(:cogy_endpoint)
+    cogy_endpoint = Cogy.cogy_endpoint
 
     begin
       raise ":cogy_release_trigger_url must be set" if trigger_url.nil?
-      raise ":cogy_endpoint must be set" if cogy_endpoint.nil?
+      raise "Cogy.cogy_endpoint must be set" if cogy_endpoint.nil?
 
       Timeout.timeout(fetch(:cogy_trigger_timeout) || 7) do
         url = URI(trigger_url)

data/lib/cogy/version.rb

@@ -1,3 +1,3 @@
 module Cogy
-  VERSION = "0.4.0".freeze
+  VERSION = "0.5.0".freeze
 end

data/lib/cogy.rb

@@ -45,6 +45,11 @@ module Cogy
   @@command_load_paths = ["cogy"]
   mattr_accessor :command_load_paths
 
+  # The endpoint where the Cogy engine is reachable at.
+  # For example "http://www.example.com/cogy"
+  @@cogy_endpoint = nil
+  mattr_accessor :cogy_endpoint
+
   # Initializes a new {Command} and registers it. All the options passed are
   # used when generating the bundle config in {Cogy.bundle_config}.
   #
@@ -129,6 +134,12 @@ module Cogy
       if cmd.examples
         config["commands"][name]["examples"] = cmd.examples
       end
+
+      if Cogy.cogy_endpoint
+        config["commands"][name]["env_vars"] = {
+          "COGY_BACKEND" => Cogy.cogy_endpoint
+        }
+      end
     end
 
     config["templates"] = templates if !templates.empty?

data/lib/generators/cogy/templates/cogy_config.rb

@@ -8,4 +8,5 @@ Cogy.configure do |config|
   #}
   #
   #config.command_load_paths = ["cogy"]
+  #config.cogy_endpoint = "http://www.example.com/cogy"
 end

data/test/dummy/config/initializers/cogy.rb

@@ -7,6 +7,7 @@ Cogy.configure do |c|
   }
 
   c.command_load_paths = ["cogy"]
+  c.cogy_endpoint = "http://www.example.com/cogy"
 
   c.helper(:foo) { env["cog_foo"] }
   c.helper(:bar) { |text| text.titleize }