remote_rails_rake_runner 0.9.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 621a556dfc8cff55193453d49b5b4eb1c8fe4c38
-  data.tar.gz: 7f2b3197dbcf7f25488f24d641309d58db5dea0f
+  metadata.gz: 17831862bcbb7eb3e4b7b2d58e4989eebe334ddc
+  data.tar.gz: 381aa048a192d599ab521b0b9c4a468748d43f2a
 SHA512:
-  metadata.gz: c833ec85f791f78b03264b5fd7351176dc00d13282e2a7e34a158726d81942d62e0927a1de18eae32c8c0d0e3c18b9827924c00348e1afc94ace47d87d928a59
-  data.tar.gz: e6c07078ce89ab3271f3551ad88af3085dd7f38a39d87d9da1c39030feb74d79531d9f52b4e61664df3c94677f3cd08d94face4a79881e7e1721a5759a9ffe9d
+  metadata.gz: fabba42d81551a3c75f37391ef8642d5b50cdaf77ec5e7d09ac900ae171b6aa1e25280d8212c9c2a2ceb1573775fffe944be0d431fee451e8fb5d1a435562b3f
+  data.tar.gz: b49bad47f6f6b2ac9ca8309b52e6296a19fe1b663b52f8ef5930cebd92aa2156aeade5ecbc80c77cad98ae278e896242181ee615a198af2f34c497e8b345c6f6

data/README.md

@@ -3,6 +3,10 @@
 The goal to deal with one problem: The startup time of a big Rails
 project when running a functional suite across multiple servers.
 
+[![Circle CI](https://circleci.com/gh/gaqzi/remote_rails_rake_runner/tree/master.svg?style=svg)](https://circleci.com/gh/gaqzi/remote_rails_rake_runner/tree/master)
+[![Coverage Status](https://coveralls.io/repos/gaqzi/remote_rails_rake_runner/badge.svg?branch=master&service=github)](https://coveralls.io/github/gaqzi/remote_rails_rake_runner?branch=master)
+[![Gem Version](https://badge.fury.io/rb/remote_rails_rake_runner.svg)](http://badge.fury.io/rb/remote_rails_rake_runner)
+
 ## 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
@@ -35,13 +39,18 @@ 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`.
+`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.
+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.
+
+To override an environment variable for one task run set the variable in the
+`environment` variable which acts like a hash.
 
 If you mount the app under `/rake` as suggested above:
 
@@ -51,8 +60,19 @@ $ curl http://localhost:3000/rake
 
 $ curl http://localhost:3000/rake/simple:hello -d args=Björn
 {"success":true,"output":"Hello Björn!\n"}
+
+$ curl http://localhost:3000/rake/simple:hello_environment -d 'environment[name]=Björn&args=Ahlo'
+{"success":true,"output":"Ahlo Björn!\n"}
 ```
 
+## Arguments
+
+* `args`: A comma separated list string of arguments passed to the rake task,
+  like on the command line
+* `environment`: A hash of overridden values.  
+  Example in Ruby: `{environment: {name: 'Björn'}}` or in curl
+  `environment[name]=Björn`.
+
 ## Acknowledgements
 
 The running and capturing of output that was taken from

data/app/controllers/remote_rails_rake_runner/runner_controller.rb

@@ -2,7 +2,8 @@ require_dependency 'remote_rails_rake_runner/application_controller'
 
 module RemoteRailsRakeRunner
   class RunnerController < ApplicationController
-    before_filter :load_rake
+    before_action :load_rake
+    skip_before_action :verify_authenticity_token rescue ArgumentError
 
     def index
       tasks = Rake.application.tasks.map do |t|
@@ -18,20 +19,30 @@ module RemoteRailsRakeRunner
 
     def run
       success = true
-      task = Rake.application.tasks.find { |t| t.name == params[:task] }
+      rake_tasks = Rake.application.tasks
+      task = rake_tasks.find { |t| t.name == params[:task] }
       return head :not_found unless task
 
       begin
-        output = capture_stdout { task.invoke(*(params[:args] || '').split(',')) }
+        output = capture_stdout do
+          override_env(environment_params) { task.invoke(*(params[:args] || '').split(',')) }
+        end
       rescue => e
         success = false
         output = e.inspect
+      ensure
+        rake_tasks.each { |task| task.reenable }
       end
 
       render json: {success: success, output: output}
     end
 
     private
+    def environment_params
+      params[:environment].permit! if params[:environment].respond_to?(:permit!)
+      params[:environment]
+    end
+
     def capture_stdout
       previous, $stdout = $stdout, StringIO.new
       yield
@@ -40,11 +51,25 @@ module RemoteRailsRakeRunner
       $stdout = previous
     end
 
+    def override_env(variables)
+      unless variables.blank?
+        begin
+          previous = ENV.to_h
+          ENV.update(variables)
+          yield
+        ensure
+          ENV.replace(previous)
+        end
+      else
+        yield
+      end
+    end
+
     def load_rake
-      return if defined? Rake
+      return if defined? Rake.application
 
       require 'rake'
-      load Rails.application.config.remote_rake_runner_rakefile_path || Rails.root.join('Rakefile').to_s
+      load Rails.application.config.try(:remote_rake_runner_rakefile_path) || Rails.root.join('Rakefile').to_s
     end
   end
 end

data/lib/remote_rails_rake_runner/version.rb

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

metadata

@@ -1,68 +1,68 @@
 --- !ruby/object:Gem::Specification
 name: remote_rails_rake_runner
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Björn Andersson
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-05-07 00:00:00.000000000 Z
+date: 2021-04-19 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: 
+description:
 email:
 - ba@sanitarium.se
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- MIT-LICENSE
+- README.md
+- Rakefile
 - 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.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: 
+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: 
+rubyforge_project:
+rubygems_version: 2.5.2.3
+signing_key:
 specification_version: 4
 summary: A simple API endpoint to run your rake tasks in the Rails context.
 test_files: []