remote_rails_rake_runner 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 621a556dfc8cff55193453d49b5b4eb1c8fe4c38
+  data.tar.gz: 7f2b3197dbcf7f25488f24d641309d58db5dea0f
+SHA512:
+  metadata.gz: c833ec85f791f78b03264b5fd7351176dc00d13282e2a7e34a158726d81942d62e0927a1de18eae32c8c0d0e3c18b9827924c00348e1afc94ace47d87d928a59
+  data.tar.gz: e6c07078ce89ab3271f3551ad88af3085dd7f38a39d87d9da1c39030feb74d79531d9f52b4e61664df3c94677f3cd08d94face4a79881e7e1721a5759a9ffe9d

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 YOURNAME
+
+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,66 @@
+# Remote Rails Rake Runner
+
+The goal to deal with one problem: The startup time of a big Rails
+project when running a functional suite across multiple servers.
+
+## Background
+The project this lil' app was started on is running a Cucumber suite
+that spans a total of 10 concurrent runners, all of whom need data at
+different times. It was originally developed with rake tasks that was
+reused from local development and run on the servers remotely through SSH.
+
+But ~30s startup time per task was starting to have too big of an effect,
+so this gem was born with the hope of removing all the starting cost while
+keeping it really simple to reuse the already existing rake tasks.
+
+## Installation
+
+Add to your Gemfile and ensure you mount the app in your routes.
+
+To your Gemfile:
+
+```ruby
+gem 'remote_rails_rake_runner'
+```
+
+To your `routes.rb`:
+
+```ruby
+Rails.application.routes.draw do
+
+  mount RemoteRailsRakeRunner::Engine => '/rake'
+end
+```
+
+## Configuration
+
+You can specify the path to your `Rakefile` by setting the option
+`Rails.application.config.remote_rake_runner_rakefile_path` which defaults to `Rails.root.join('Rakefile').to_s`.
+
+## Usage
+
+The app exposes two endpoints, a listing of all the rake tasks and the actual runner.
+To run a task with arguments just put the arguments in into the argument `args` separated by commas.
+The task will not be considered successful if it raises an exception, otherwise it's assumed to have been successful.
+
+If you mount the app under `/rake` as suggested above:
+
+```shell
+$ curl http://localhost:3000/rake
+[{"name":"about","args":[],"description":null}, …] # a listing of all tasks (like rake -T)
+
+$ curl http://localhost:3000/rake/simple:hello -d args=Björn
+{"success":true,"output":"Hello Björn!\n"}
+```
+
+## Acknowledgements
+
+The running and capturing of output that was taken from
+[this blog post](http://andowebsit.es/blog/noteslog.com/post/how-to-run-rake-tasks-programmatically/)
+by [Andrea Ercolino].
+
+[Andrea Ercolino]: https://github.com/aercolino/
+
+## License
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,23 @@
+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    = 'RemoteRailsRakeRunner'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+

data/app/controllers/remote_rails_rake_runner/application_controller.rb

@@ -0,0 +1,4 @@
+module RemoteRailsRakeRunner
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/remote_rails_rake_runner/runner_controller.rb

@@ -0,0 +1,50 @@
+require_dependency 'remote_rails_rake_runner/application_controller'
+
+module RemoteRailsRakeRunner
+  class RunnerController < ApplicationController
+    before_filter :load_rake
+
+    def index
+      tasks = Rake.application.tasks.map do |t|
+        {
+            name: t.to_s,
+            args: t.arg_names,
+            description: t.comment,
+        }
+      end
+
+      render json: tasks
+    end
+
+    def run
+      success = true
+      task = Rake.application.tasks.find { |t| t.name == params[:task] }
+      return head :not_found unless task
+
+      begin
+        output = capture_stdout { task.invoke(*(params[:args] || '').split(',')) }
+      rescue => e
+        success = false
+        output = e.inspect
+      end
+
+      render json: {success: success, output: output}
+    end
+
+    private
+    def capture_stdout
+      previous, $stdout = $stdout, StringIO.new
+      yield
+      $stdout.string
+    ensure
+      $stdout = previous
+    end
+
+    def load_rake
+      return if defined? Rake
+
+      require 'rake'
+      load Rails.application.config.remote_rake_runner_rakefile_path || Rails.root.join('Rakefile').to_s
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,4 @@
+RemoteRailsRakeRunner::Engine.routes.draw do
+  root 'runner#index'
+  post '/:task', to: 'runner#run', as: :rake
+end

data/lib/remote_rails_rake_runner/engine.rb

@@ -0,0 +1,9 @@
+module RemoteRailsRakeRunner
+  class Engine < ::Rails::Engine
+    isolate_namespace RemoteRailsRakeRunner
+
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+  end
+end

data/lib/remote_rails_rake_runner/version.rb

@@ -0,0 +1,3 @@
+module RemoteRailsRakeRunner
+  VERSION = '0.9.0'
+end

data/lib/remote_rails_rake_runner.rb

@@ -0,0 +1,4 @@
+require "remote_rails_rake_runner/engine"
+
+module RemoteRailsRakeRunner
+end

data/lib/tasks/remote_rails_rake_runner_tasks.rake

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

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: remote_rails_rake_runner
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Björn Andersson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- ba@sanitarium.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/controllers/remote_rails_rake_runner/application_controller.rb
+- app/controllers/remote_rails_rake_runner/runner_controller.rb
+- config/routes.rb
+- lib/remote_rails_rake_runner/engine.rb
+- lib/remote_rails_rake_runner/version.rb
+- lib/remote_rails_rake_runner.rb
+- lib/tasks/remote_rails_rake_runner_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: https://github.com/gaqzi/remote_rails_rake_runner
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: A simple API endpoint to run your rake tasks in the Rails context.
+test_files: []