cogy 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e15ce0ee4619b458af94f3d11906117e1ef9e987
+  data.tar.gz: ef84ade1821bde53cbc22578613e0e2cab8475f9
+SHA512:
+  metadata.gz: fbe156629d8120fa161bcc1dcedbb679b3e1574adaacc9d47416d710ed18da24b0b7338888be602ad101c7c09f4151ba4ecb48fc49f00eea23e6120ccaa43b07
+  data.tar.gz: f6f4665eb0daedb50227c1c3a653918bdbebde758065db578f3b5f4a2c4856f9654e27da096b6d24316a98f9c68545aa282d6e3c95a3b19236a0521ae3bc5e68

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Agis Anastasopoulos
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,136 @@
+# Cogy
+
+Cogy provides a way to integrate Cog with Rails apps, in a way that managing
+and adding commands is a breeze.
+
+## Why
+
+Creating a command that talks with a Rails app, typically involves writing
+a route, maybe a controller, an action and code to handle the command arguments
+and options.
+
+This is a repetitive task and Cogy provides a way to get rid of this tedious
+boilerplate code.
+
+With Cogy, writing a new command is as simple as adding the following line
+to a file in your application:
+
+```ruby
+# in cogy/my_commands.rb
+
+on "foo", desc: "Echo a foo bar back at you!" do |req_args, _, user|
+  "@#{user}: foo bar"
+end
+```
+
+## How it works
+
+Cogy is essentially three things:
+
+1. An opinionated way to build commands: All Cogy commands are defined in your
+   Rails app and end up in a single executable within the Relay (see below).
+   Cogy provides versioning and dynamically generates the bundle config, which
+   is also served by your Rails app. This, accompanied with the command [TODO: INSERT LINK HERE] that
+   can install bundles from other bundles, makes it possible to automatically
+   install the newly-written commands by invoking a trigger when you deploy
+   your app.
+2. A Rails Engine that is mounted in your application and routes the incoming
+   requests to their user-defined handlers. It also creates the `/inventory`
+   endpoint, which serves the installable bundle configuration in YAML and can be
+   consumed directly by the `cogutils:install` command [TODO: INSERT LINK].
+3. An executable [TODO: INSERT LINK HERE] which all commands point to.
+   This is placed inside the Relays and performs the requests to your application
+   when a user invokes a command in the chat. It then posts the result back
+   to the user.
+
+## Installation
+
+Add the following to your Gemfile:
+
+```ruby
+gem "cogy"
+```
+
+## Configuration
+
+The options provided are the following:
+
+```ruby
+# in config/initializers/cogy.rb
+
+Cogy.configure do |config|
+  # Used in the generated bundle config YAML.
+  #
+  # Default: "cogy"
+  config.bundle_name = "myapp"
+
+  # Used in the generated bundle config YAML.
+  #
+  # Default: "Cogy-generated commands"
+  config.bundle_description = "myapp-generated commands from Cogy"
+
+  # Can be either a string or an object that responds to `#call` and returns
+  # a string. Must be set explicitly.
+  config.bundle_version = "0.0.1"
+
+  # If you used a callable object, it will be evaluated each time the inventory
+  # is called. This can be useful if you want the version to change dynamically
+  # when it's needed.
+  #
+  # For example, this will change the version only when a command is
+  # added or is modified (uses the 'grit' gem).
+  config.bundle_version = -> {
+    repo = Grit::Repo.new(Rails.root.to_s)
+    repo.log("HEAD", "cogy/", max_count: 1).first.date.strftime("%y%m%d.%H%M%S")
+  }
+
+  # The path in the Relay where the cogy command executable is located at.
+  # Must be set explicitly.
+  config.executable_path = "/cogcmd/cogy"
+
+  # Paths in your application where the files that define the commands live in.
+  # For example the default value will search for all `*.rb` files in the `cogy/`
+  # directory relative to the root of your application.
+  #
+  # Default: ["cogy"]
+  config.command_load_paths = "cogy_commands/"
+end
+
+```
+
+## Usage
+
+Commands are defined like so:
+
+```ruby
+# in cogy/commands.rb
+
+on "foo", desc: "Echo a bar" do
+  "bar"
+end
+```
+
+The last line evaluated is the result of the command.
+
+A more complete example:
+
+```ruby
+# in cogy/commands.rb
+on "calc",
+  args: [:a, :b],
+  opts: { op: { type: "string", required: true, short_flag: "o" } },
+  desc: "Performs a calculation between numbers <a> and <b>",
+  example: "!myapp:calc sum 1 2" do |req_args, req_opts, user|
+  op = req_opts[:op].to_sym
+  result = req_args.map(&:to_i).inject(&op)
+  "Hello @#{user}, the result is: #{result}"
+end
+```
+
+## Credits
+
+TODO
+
+
+
+

data/Rakefile

@@ -0,0 +1,37 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Cogy'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/controllers/cogy/application_controller.rb

@@ -0,0 +1,5 @@
+module Cogy
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/controllers/cogy/cogy_controller.rb

@@ -0,0 +1,21 @@
+require_dependency "cogy/application_controller"
+
+module Cogy
+  class CogyController < ApplicationController
+    # GET /cmd/:cmd/:user
+    def command
+      cmd = params[:cmd]
+      args = request.query_parameters.select { |k,_| k !~ /\Acog_opt_/ }.values
+      opts = request.query_parameters.select { |k,_| k =~ /\Acog_opt_/ }
+        .transform_keys { |k| k.sub("cog_opt_", "") }
+      user = params[:user]
+
+      render text: Cogy.commands[cmd].run!(args, opts, user)
+    end
+
+    # GET /inventory
+    def inventory
+      render text: Cogy.bundle_config.to_yaml
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,4 @@
+Cogy::Engine.routes.draw do
+  get "cmd/:cmd/:user" => 'cogy#command'
+  get "inventory" => 'cogy#inventory'
+end

data/lib/cogy/command.rb

@@ -0,0 +1,43 @@
+module Cogy
+  class Command
+    attr :name, :args, :opts, :desc, :long_desc, :example, :rules, :handler
+
+    def initialize(name, args: [], opts: {}, desc:, long_desc: nil, example: nil, rules: nil)
+      @name = name
+      @args = [args].flatten.map!(&:to_s)
+      @opts = opts.with_indifferent_access
+      @desc = desc
+      @long_desc = long_desc
+      @example = example
+      @rules = rules || ["allow"]
+    end
+
+    def register!(handler)
+      if Cogy.commands[name]
+        raise "A command with the name #{name} is already registered"
+      end
+
+      @handler = handler
+      @handler.command = self
+
+      Cogy.commands[name] = self
+    end
+
+    def run!(*args)
+      handler.run(*args)
+    end
+
+    # Suitable for bundle config display
+    def formatted_args
+      args.map { |a| "<#{a}>" }.join(" ")
+    end
+
+    # Suitable for bundle config display.
+    #
+    # Get rid of HashWithIndifferentAccess, otherwise the resulting YAML
+    # will contain garbage.
+    def formatted_opts
+      opts.to_hash
+    end
+  end
+end

data/lib/cogy/engine.rb

@@ -0,0 +1,20 @@
+module Cogy
+  class Engine < ::Rails::Engine
+    isolate_namespace Cogy
+
+    config.after_initialize do
+      if Cogy.bundle_version.nil?
+        raise "You must set the :bundle_version setting"
+      end
+
+      if Cogy.executable_path.nil?
+        raise "You must set the :executable_path setting"
+      end
+
+      Cogy.command_load_paths.each do |path|
+        files = Dir[Rails.root.join(path,"*.rb")]
+        files.each { |f| Cogy.module_eval(File.read(f)) }
+      end
+    end
+  end
+end

data/lib/cogy/handler.rb

@@ -0,0 +1,14 @@
+module Cogy
+  class Handler
+    attr_accessor :command
+
+    def initialize(blk)
+      @blk = blk
+      @command = nil
+    end
+
+    def run(args, opts, user)
+      @blk.call(args, opts, user)
+    end
+  end
+end

data/lib/cogy/version.rb

@@ -0,0 +1,3 @@
+module Cogy
+  VERSION = "0.0.1"
+end

data/lib/cogy.rb

@@ -0,0 +1,82 @@
+require "cogy/engine"
+require "cogy/handler"
+require "cogy/command"
+
+module Cogy
+  COG_BUNDLE_VERSION = 4
+
+  # Holds all the registered Commands. Not to be messed with.
+  mattr_accessor :commands
+  @@commands = {}
+
+  # Bundle config-related stuff
+	mattr_accessor :bundle_name
+	@@bundle_name = "cogy"
+
+  mattr_accessor :bundle_description
+  @@bundle_description = "Cogy-generated commands"
+
+  # Can be either a string or an object that responds to `#call` and returns
+  # a string.
+  #
+  # Must be set explicitly
+  mattr_accessor :bundle_version
+  @@bundle_version = nil
+
+  # The path in the Cog Relay where the command executable is located.
+  #
+  # Must be set explicitly.
+  mattr_accessor :executable_path
+  @@executable_path = nil
+
+  # Paths where the files that define the commands will be searched in
+  mattr_accessor :command_load_paths
+  @@command_load_paths = ["cogy"]
+
+  def self.on(cmd_name, opts = {}, &blk)
+    cmd = Command.new(cmd_name, opts)
+    handler = Handler.new(blk)
+    cmd.register!(handler)
+  end
+
+  # @return [Hash]
+  def self.bundle_config
+    version = if bundle_version.respond_to?(:call)
+      bundle_version.call
+    else
+      bundle_version
+    end
+
+    config = {
+      "cog_bundle_version" => COG_BUNDLE_VERSION,
+      "name" => bundle_name,
+      "description" => bundle_description,
+      "version" => version,
+      "commands" => {}
+    }
+
+    commands.each do |name, cmd|
+      config["commands"][name] = {
+        "executable" => executable_path,
+        "description" => cmd.desc,
+        "arguments" => cmd.formatted_args,
+        "options" => cmd.formatted_opts,
+        "rules" => cmd.rules
+      }
+
+      if cmd.long_desc
+        config["commands"][name]["long_description"] = cmd.long_desc
+      end
+
+      if cmd.example
+        config["commands"][name]["example"] = cmd.example
+      end
+    end
+
+    config
+  end
+
+  def self.configure
+    yield self
+  end
+end

data/lib/tasks/cogy_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :cogy do
+#   # Task goes here
+# end

data/test/cogy_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class CogyTest < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, Cogy
+  end
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/bin/setup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts "== Installing dependencies =="
+  system "gem install bundler --conservative"
+  system "bundle check || bundle install"
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   system "cp config/database.yml.sample config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system "bin/rake db:setup"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system "rm -f log/*"
+  system "rm -rf tmp/cache"
+
+  puts "\n== Restarting application server =="
+  system "touch tmp/restart.txt"
+end

data/test/dummy/config/application.rb

@@ -0,0 +1,26 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "cogy"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Do not swallow errors in after_commit/after_rollback callbacks.
+    config.active_record.raise_in_transactional_callbacks = true
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,41 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations.
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+
+  # Asset digests allow you to set far-future HTTP expiration dates on all assets,
+  # yet still be able to expire them through the digest params.
+  config.assets.digest = true
+
+  # Adds additional error checking when serving assets at runtime.
+  # Checks for improperly declared sprockets dependencies.
+  # Raises helpful error messages.
+  config.assets.raise_runtime_errors = true
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+end