wrake 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 972f2f0bce0b17584a67e9ece00141d31a09d31f
+  data.tar.gz: 716bf8153e6be36a92ec7ed09484b8e2009d5ea0
+SHA512:
+  metadata.gz: d7689966fb80e510f266543429b0da59e325ca1009675a18e016ca0a1c5df1468ad86c9cf2e59f30d15359618066bc4ef2692a03e32940c801dc21b7d3af84df
+  data.tar.gz: 10fcd32080b5094485f4fad3225590b2c00cbaf887736b177f4f6c09e175a3e37dcacd34e9316cd174b9e52a8e626b305b6b9e81eab05b7b25e2c1f5a403ca98

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 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,98 @@
+# Wrake
+
+A web partner of Rake. Runs wrake via web api.
+
+[![Build Status](https://travis-ci.org/mjacobus/wrake.png?branch=master)](https://travis-ci.org/mjacobus/wrake)
+[![Coverage Status](https://coveralls.io/repos/mjacobus/wrake/badge.png)](https://coveralls.io/r/mjacobus/wrake)
+[![Code Climate](https://codeclimate.com/github/mjacobus/wrake.png)](https://codeclimate.com/github/mjacobus/wrake)
+[![Dependency Status](https://gemnasium.com/mjacobus/wrake.png)](https://gemnasium.com/mjacobus/wrake)
+[![Gem Version](https://badge.fury.io/rb/wrake.png)](http://badge.fury.io/rb/wrake)
+
+## But why?
+
+When you run rake inside rails, you have to load the entire application. By running wrake,
+rake will be callled via web API, through your aready loaded rails app.
+
+## Instalation
+
+Add this line to your application's Gemfile:
+
+    gem 'wrake'
+
+And then execute:
+
+    $ bundle
+    $ rails g wrake:install
+
+This will create the following files:
+
+- ```config/wrake.yml``` - the configuration file is self explicative.
+- ```config/initializers/wrake.rb``` - the configuration file is self explicative.
+
+Also, you wil need to mount the engine:
+
+```ruby
+# config/routes.rb
+
+mount Wrake::Engine, at: 'wrake'
+```
+
+## Usage
+
+### Using API
+```ruby
+api  = Wrake::Api.new(url: base_url, username: username, password: password)
+
+# or to get the api with default configuration
+
+api = Wrake.api
+
+response = api.invoke_task('some:task', { args: 'a b c' })
+# or
+response = api.invoke_task('some:task', args: ['a', 'b', 'c'])
+
+puts response.code, response.headers, response.body, response.message
+
+```
+
+### Using the CLI
+
+```bash
+wrake cache:clean -c path/to/wrake.yml -e development
+
+wrake mail:welcome new@user.com -c path/to/wrake.yml
+```
+
+### Password protecting the API
+
+By default, the API is protected by Basic Auth. You could change the default behavior
+by overwriting the wrake_authorization method:
+
+```ruby
+class ApplicationController < ActionController::Base
+  def wrake_authorization
+    authenticate_or_request_with_http_basic do |username, password|
+      User.with_wrake_privileges.where(email: username, password: password).first!
+    end
+  end
+end
+```
+
+
+## TODO
+
+- [Next features](https://github.com/mjacobus/wrake/issues?labels=enhancement&page=1&state=open)
+
+## Authors
+
+- [Marcelo Jacobus](https://github.com/mjacobus)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+** Do not forget to write tests**

data/Rakefile

@@ -0,0 +1,21 @@
+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    = 'Wrake'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/app/assets/stylesheets/wrake/application.css

@@ -0,0 +1,13 @@
+/*
+ * 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 vendor/assets/stylesheets of plugins, if any, 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 top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/controllers/wrake/application_controller.rb

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

data/app/controllers/wrake/tasks_controller.rb

@@ -0,0 +1,43 @@
+require_dependency "wrake/application_controller"
+require_relative "../../../spec/support/task_tester"
+
+module Wrake
+  class TasksController < ApplicationController
+
+    before_filter :load_tasks
+    before_filter :wrake_authorization
+
+    def invoke
+      @task_name = task_name
+      @args      = args
+      @return    = Rake::Task[task_name].invoke(*args)
+    end
+
+    def wrake_authorization
+      config = Wrake.config
+
+      authenticate_or_request_with_http_basic do |username, password|
+        username == config.username && password == config.password
+      end
+    end
+
+    protected
+      def args
+        data = params[:args].presence || []
+
+        if data.is_a?(String)
+          data = data.split(' ')
+        end
+
+        data
+      end
+
+      def task_name
+        params[:task_name]
+      end
+
+      def load_tasks
+        Rails.application.load_tasks
+      end
+  end
+end

data/app/helpers/wrake/application_helper.rb

@@ -0,0 +1,4 @@
+module Wrake
+  module ApplicationHelper
+  end
+end

data/app/views/layouts/wrake/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Wrake</title>
+  <%= stylesheet_link_tag    "wrake/application", media: "all" %>
+  <%= javascript_include_tag "wrake/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/app/views/wrake/tasks/invoke.html.erb

@@ -0,0 +1,5 @@
+<h1><%= @task_name %></h1>
+<h2>Arguments</h2>
+<div><%= @args.join(' ') %></div>
+<h2>Output</h2>
+<pre><%= @output %></pre>

data/config/routes.rb

@@ -0,0 +1,3 @@
+Wrake::Engine.routes.draw do
+  match '/tasks/:task_name' => 'tasks#invoke', via: [:get, :post]
+end

data/lib/generators/wrake/install/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Install config files
+
+Example:
+    rails generate wrake:install
+
+    This will create:
+        config/initializers/wrake.rb
+        config/wrake.yml

data/lib/generators/wrake/install/install_generator.rb

@@ -0,0 +1,12 @@
+class Wrake::InstallGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  def copy_initializer
+    template "initializer.rb", "config/initializers/wrake.rb"
+  end
+
+  def copy_config_file
+    template "wrake.yml", "config/wrake.yml"
+  end
+
+end

data/lib/generators/wrake/install/templates/initializer.rb

@@ -0,0 +1,3 @@
+Wrake.configure do |config|
+  config.from_file Rails.root.join('config/wrake.yml')
+end

data/lib/generators/wrake/install/templates/wrake.yml

@@ -0,0 +1,5 @@
+test:
+  url: http://example.com
+  username: jondoe
+  password: secret
+

data/lib/tasks/wrake_tasks.rake

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

data/lib/wrake.rb

@@ -0,0 +1,24 @@
+require "wrake/engine" if defined?(Rails)
+require "wrake/api"
+require "wrake/configuration"
+require "wrake/authorization/access_denied"
+
+module Wrake
+
+  def self.config
+    @@config ||= Configuration.new
+  end
+
+  def self.configure(&block)
+    yield config
+  end
+
+  def self.api
+    @@api ||= Api.new(
+      url: config.url,
+      username: config.username,
+      password: config.password
+    )
+  end
+
+end

data/lib/wrake/api.rb

@@ -0,0 +1,45 @@
+require 'wrake/api/request'
+require 'wrake/api/response'
+
+module Wrake
+  class Api
+
+    def initialize(params = { })
+      @params = params
+    end
+
+    def url
+      @params.fetch(:url)
+    end
+
+     def invoke_task(task, data = {})
+      perform_request(url_for("tasks/#{task}"), data)
+    end
+
+    def prepare_data(data)
+      { query: data, basic_auth: { username: username, password: password } }
+    end
+
+    private
+
+      def perform_request(path, data)
+        Request.new(path, prepare_data(data)).perform
+      end
+
+      def url_for(path = '/')
+        "#{url}/#{path}"
+      end
+
+      def params
+        @params
+      end
+
+      def username
+        params[:username]
+      end
+
+      def password
+        params[:password]
+      end
+  end
+end

data/lib/wrake/api/request.rb

@@ -0,0 +1,20 @@
+require 'httparty'
+
+module Wrake
+  class Api
+    class Request
+
+      attr_reader :url, :data
+
+      def initialize(url, data = {})
+        @url  = url
+        @data = data
+      end
+
+      def perform
+        Response.new(HTTParty.post(url, data))
+      end
+
+    end
+  end
+end

data/lib/wrake/api/response.rb

@@ -0,0 +1,27 @@
+module Wrake
+  class Api
+    class Response
+
+      def initialize(response)
+        @response = response
+      end
+
+      def body
+        @response.body
+      end
+
+      def code
+        @response.code
+      end
+
+      def message
+        @response.message
+      end
+
+      def headers
+        @response.headers
+      end
+
+    end
+  end
+end

data/lib/wrake/authorization/access_denied.rb

@@ -0,0 +1,6 @@
+module Wrake
+  module Authorization
+    class AccessDenied < StandardError
+    end
+  end
+end

data/lib/wrake/command.rb

@@ -0,0 +1,14 @@
+module Wrake
+  class Command
+    attr_reader :options
+
+    def initialize(options)
+      @options = options
+      Wrake.config.from_file(options.config_file, options.env)
+    end
+
+    def execute
+      Wrake.api.invoke_task(options.task_name, args: options.task_args)
+    end
+  end
+end

data/lib/wrake/command/options.rb

@@ -0,0 +1,60 @@
+require 'optparse'
+
+module Wrake
+  class Command
+    class Options
+      class Error < StandardError; end
+
+      attr_reader :config_file, :env, :task_args, :task_name
+
+      def initialize(options = [])
+        @env = 'production'
+        parse(options)
+      end
+
+      private
+        def parse(options)
+          @parser = OptionParser.new do |opts|
+            opts.banner = "Usage: wrake task_name [params] [options]"
+            parse_config_file(opts)
+            parse_environment(opts)
+
+            opts.on_tail("-h", "--help", "Show this message") do
+              puts opts
+              exit
+            end
+          end
+
+          @parser.parse!(options)
+          parse_task_name(options)
+          parse_task_args(options)
+        rescue OptionParser::InvalidOption => e
+          raise_error(e.message)
+        end
+
+        def raise_error(message)
+          raise Error, message + "\n\n#{@parser}"
+        end
+
+        def parse_task_name(options)
+          @task_name = options.shift
+        end
+
+        def parse_task_args(options)
+          @task_args = options
+        end
+
+        def parse_config_file(opts)
+          opts.on('-c', '--config-file CONFIG_FILE', "Set the config file to read from.") do |file|
+            @config_file = file
+          end
+        end
+
+        def parse_environment(opts)
+          opts.on('-e', '--env ', "Set the environment. Defaults to 'production'") do |file|
+            @env = file
+          end
+        end
+    end
+  end
+end

data/lib/wrake/configuration.rb

@@ -0,0 +1,14 @@
+module Wrake
+  class Configuration
+    attr_accessor :username, :password, :url
+
+    def from_file(file, env = nil)
+      env ||= defined?(Rails) ? Rails.env : 'production'
+      config = YAML::load(File.open(file))[env]
+
+      config.each do |key, value|
+        send("#{key}=", value)
+      end
+    end
+  end
+end

data/lib/wrake/engine.rb

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

data/lib/wrake/version.rb

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

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: wrake
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Marcelo Jacobus
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - <=
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - <=
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Runs rake without having to load the entire rais app
+email:
+- marcelo.jacobus@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/stylesheets/wrake/application.css
+- app/controllers/wrake/application_controller.rb
+- app/controllers/wrake/tasks_controller.rb
+- app/helpers/wrake/application_helper.rb
+- app/views/layouts/wrake/application.html.erb
+- app/views/wrake/tasks/invoke.html.erb
+- config/routes.rb
+- lib/generators/wrake/install/USAGE
+- lib/generators/wrake/install/install_generator.rb
+- lib/generators/wrake/install/templates/initializer.rb
+- lib/generators/wrake/install/templates/wrake.yml
+- lib/tasks/wrake_tasks.rake
+- lib/wrake.rb
+- lib/wrake/api.rb
+- lib/wrake/api/request.rb
+- lib/wrake/api/response.rb
+- lib/wrake/authorization/access_denied.rb
+- lib/wrake/command.rb
+- lib/wrake/command/options.rb
+- lib/wrake/configuration.rb
+- lib/wrake/engine.rb
+- lib/wrake/version.rb
+homepage: http://github.com/mjacobus/wrake
+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.2.1
+signing_key: 
+specification_version: 4
+summary: Web Api for Rake
+test_files: []