woro 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f2bd3ed37a7aad52ff1f43d5b0313b6caf9b6c48
+  data.tar.gz: 78b80cb0c1327dae3440728928e2fa920cff9ff0
+SHA512:
+  metadata.gz: bcc22210977dfd80a7ec89ac36a40efece5a277ae48cd9665aaf47a0e4dc26781621bd442f82debd7c9362c467fac0c43b8bdc5555731f9ff66c08c21d1109cc
+  data.tar.gz: 92ec94f072d44cbc0ed1f7a02bb5d0a88b11e332ef52084839a8108d65671a08e42498635a72e3b368c07295cfea67384666ce66aa467d3df03ceea222f9e93d

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in woro.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Daniel Senff
+
+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,121 @@
+# Woro
+
+Write once, run once.
+
+Manage one-time remote tasks in your Rails project.
+Plugins with Mina that adds support for rake tasks hosted as gists.
+
+Say you have a data migration to perform on a remote server. The procedure is too complex to just do it in the remote console. Using database migration is evil. A rake task would be nice, but checking this in with the regular repository adds clutter, as you know you will only run this once.
+Woro offers a quick way of pushing rake tasks on the remote server, execute them and delete them instantly. Using Github's gist, you keep version control of the tasks and can share them with colleagues.
+
+Woro helps you create rake task, that you can develop and run locally.
+Once you are ready, woro let's you push them online as a gist.
+Using a mina deployment setup, you these tasks are downloaded on the remote system, executing using rake and cleaned up afterwards.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```rb
+gem 'woro', require: false
+```
+
+And then execute:
+
+```shell
+$ bundle
+```
+
+Or install it yourself as:
+
+```shell
+$ gem install woro
+```
+
+Require `mina/woro` in your `config/deploy.rb`:
+
+```rb
+require 'mina/bundler'
+require 'mina/rails'
+require 'mina/git'
+require 'mina/woro'
+
+...
+
+task setup: :environment do
+  ...
+end
+
+desc 'Deploys the current version to the server.'
+task deploy: :environment do
+  ...
+end
+```
+
+Then run:
+
+```shell
+$ mina woro:init
+```
+
+This will create `lib/woro_tasks/` folder and `lib/tasks/woro.rake`.
+Here the Woro task files are stored and edited locally.
+
+## Usage
+
+```shell
+$ mina woro:new task=cleanup_users
+```
+
+Can be used to create the template for a new task in `lib/tasks/`.
+
+The task itself is a regular rake-task in the woro-namespace. You can test it locally using rake:
+
+```shell
+$ rake woro:cleanup_users
+```
+
+Once you are done writing the task and you want to execute it on the remote system.
+First you have to push them online.
+
+```shell
+$ mina woro:push task=cleanup_users
+```
+
+_Attention, depending on whether you set up a Gist/Github login on
+initialization. These tasks are online anonymous, but public, or
+private under the specified Github account._
+
+
+Now, to run a task remotely, specify the task:
+
+```shell
+$ mina woro:run task=cleanup_users
+```
+
+
+Or do pushing and running in one step:
+
+```shell
+$ mina woro:execute task=cleanup_users
+```
+
+To show a list of all uploaded tasks do:
+
+```shell
+$ mina woro:list
+```
+
+And finally you can download an existing task:
+
+```shell
+$ mina woro:pull task=cleanup_users
+```
+
+## 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

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/mina/woro.rb

@@ -0,0 +1 @@
+load File.expand_path("../../woro/tasks/mina.rake", __FILE__)

data/lib/woro/gister.rb

@@ -0,0 +1,22 @@
+require 'gist'
+require 'net/https'
+
+module Woro
+  class Gister
+    class << self
+      def create_initial_gist(app_name)
+        Gist.gist("Welcome to the Woro Task Repository for #{app_name}", filename: app_name)
+      end
+
+      def retrieve_gist(gist_id)
+        service_url = "https://api.github.com/gists/#{gist_id}"
+        response = Net::HTTP.get_response(URI.parse(service_url))
+        JSON.parse(response.body)
+      end
+
+      def get_list_of_files(gist_id)
+        retrieve_gist(gist_id)['files']
+      end
+    end
+  end
+end

data/lib/woro/task.rb

@@ -0,0 +1,66 @@
+require 'net/https'
+require 'erb'
+
+module Woro
+  class Task
+    attr_reader :task_name, :gist_id, :gist
+
+    def initialize(gist_id, task_name)
+      @task_name = task_name
+      @gist_id = gist_id
+    end
+
+    def self.create(gist_id, task_name)
+      task = Woro::Task.new(gist_id, task_name)
+      task.create_empty_task
+    end
+
+    def file_name
+      "#{task_name}.rake"
+    end
+
+    def file_path
+      "lib/woro_tasks/#{file_name}"
+    end
+
+    def create_empty_task
+      b = binding
+      template = ERB.new(read_template_file).result(b)
+      File.open(file_path, 'w') do |f|
+        f.puts template
+      end
+    end
+
+    def read_template_file
+      File.read(File.dirname(__FILE__) +"/templates/task.rake")
+    end
+
+    def read_task_file
+      File.read(file_path)
+    end
+
+    def push
+      Gist.multi_gist({ file_name => read_task_file },
+                       public: false,
+                       update: gist_id,
+                       output: :all)
+    end
+
+    def gist
+      @gist ||= Gister.retrieve_gist(gist_id)
+    end
+
+    def retrieve_file_data
+      gist['files'][file_name]
+    end
+
+    def raw_url
+      retrieve_file_data['raw_url']
+    end
+
+    def retrieve_raw_file
+      response = Net::HTTP.get_response(raw_url)
+      response.body
+    end
+  end
+end

data/lib/woro/tasks/mina.rake

@@ -0,0 +1,113 @@
+require 'ostruct'
+require 'woro/gister'
+require 'woro/task'
+
+def _tasks_dir
+  fetch(:tasks_dir, 'lib/woro_tasks')
+end
+
+def prompt(*args)
+  print(*args)
+  STDIN.gets.chomp
+end
+
+def sanitized_task_name
+  ENV['task'].strip.split(' ').first
+end
+
+def check_presence_of_task_name
+  if ENV['task'].nil?
+    print_error('No taskname given.')
+    raise 'No taskname given'
+  end
+end
+
+def extract_description(data)
+  data['content'].match(/desc ['"]([a-zA-Z0-9\s]*)['"]/)[1]
+end
+
+# tasks available to mina to run remotely
+namespace :woro do
+
+  desc 'Initialize new Woro repository'
+  task :init do
+    print status 'Configure Gist/Github access'
+
+    login_gist = prompt "Login to Gist/Github for private Woro tasks (Yes/No):"
+    if %w(yes y).include? login_gist
+      Gist.login!
+    #else
+    #  access_token = prompt "Secure gists via Access Token:"
+    end
+
+    # create Gist with welcome file
+    # additional tasks will be added to this first gist
+    app_name = fetch(:app_name, 'TestApp') #Rails.application.class.parent_name
+    result = Woro::Gister.create_initial_gist(app_name)
+
+    print status 'Setup in your project'
+    print_stdout "add this to your deploy.rb:"
+    print_stdout "set :woro_token, '#{result['id']}"
+
+    print status 'Create woro_tasks in lib/'
+    FileUtils.mkdir_p _tasks_dir if !File.exists? _tasks_dir
+
+    print status 'Create woro.rake in lib/tasks/'
+    FileUtils.cp(File.dirname(__FILE__) +"/templates/woro.rake", 'lib/tasks/')
+  end
+
+  desc 'Create new Woro task'
+  task :new do
+    check_presence_of_task_name
+    print_status "Create lib/woro_tasks/#{sanitized_task_name}.rake"
+    Woro::Task.create(fetch(:woro_token), sanitized_task_name)
+  end
+
+  desc 'Push and run Woro task remotely'
+  task execute: environment do
+    invoke :'woro:push'
+    invoke :'woro:run'
+  end
+
+  desc 'Push Woro task to remote repository, updates existing'
+  task :push do
+    check_presence_of_task_name
+    # Pushes a new woro task by given name to gist, this can be done multiple time.
+    task = Woro::Task.new(fetch(:woro_token), sanitized_task_name)
+    print_status "Upload lib/woro_tasks/#{sanitized_task_name}.rake"
+    task.push
+  end
+
+  desc 'Pull Woro task from remote repository'
+  task :pull do
+    check_presence_of_task_name
+    # Pulls the  woro task by given name to gist, this can be done multiple time.
+    task = Woro::Task.new(fetch(:woro_token), sanitized_task_name)
+    print_status "Download #{sanitized_task_name} to lib/woro_tasks/#{sanitized_task_name}.rake"
+    system "cd 'lib/tasks' && curl -O -# #{task.raw_url}"
+  end
+
+  desc 'Run Woro task remotely'
+  task run: :environment do
+    check_presence_of_task_name
+    task = Woro::Task.new(fetch(:woro_token), sanitized_task_name)
+
+    print_status "Execute #{sanitized_task_name} remotely"
+    in_directory "#{app_path}" do
+      queue! "cd 'lib/tasks' && curl -O #{task.raw_url}"
+      queue! "#{bundle_prefix} rake woro:#{sanitized_task_name}"
+      queue! "rm lib/tasks/#{task.file_name}"
+    end
+  end
+
+  desc 'List all remote Woro tasks'
+  task :list do
+    files = Woro::Gister.get_list_of_files(fetch(:woro_token))
+    tasks = files.map { |file_name, data| OpenStruct.new(name_with_args: file_name.split('.rake').first, comment: extract_description(data)) if file_name.include? '.rake' }
+    tasks.compact!
+    width ||= tasks.map { |t| t.name_with_args.length }.max || 10
+    tasks.each do |t|
+      puts "  #{name} %-#{width}s   # %s" % [ t.name_with_args, t.comment ]
+    end
+  end
+end

data/lib/woro/templates/task.rake

@@ -0,0 +1,6 @@
+namespace :woro do
+  desc 'Write your description here'
+  task <%= task_name %>: :environment do
+    # your code
+  end
+end

data/lib/woro/templates/woro.rake

@@ -0,0 +1 @@
+Dir.glob('lib/woro_tasks/*.rake').each { |r| load r}

data/lib/woro/version.rb

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

data/woro.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'woro/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "woro"
+  spec.version       = Woro::VERSION
+  spec.authors       = ["Daniel Senff"]
+  spec.email         = ["mail@danielsenff.de"]
+  spec.summary       = %q{Write once, run once. One-time migration task management on remote servers through mina.}
+  spec.description   = %q{Write once, run once.}
+  spec.homepage      = "http://github.com/Dahie/woro"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "mina", ">= 0.2.1"
+  spec.add_dependency "gist"
+  spec.add_dependency "cmdparse"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-nc"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-remote"
+  spec.add_development_dependency "pry-nav"
+  spec.add_development_dependency "pry-byebug"
+end

metadata

@@ -0,0 +1,240 @@
+--- !ruby/object:Gem::Specification
+name: woro
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Daniel Senff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mina
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+- !ruby/object:Gem::Dependency
+  name: gist
+  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: cmdparse
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: rspec-nc
+  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: guard
+  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: guard-rspec
+  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: pry
+  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: pry-remote
+  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: pry-nav
+  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: pry-byebug
+  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: Write once, run once.
+email:
+- mail@danielsenff.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/mina/woro.rb
+- lib/woro/gister.rb
+- lib/woro/task.rb
+- lib/woro/tasks/mina.rake
+- lib/woro/templates/task.rake
+- lib/woro/templates/woro.rake
+- lib/woro/version.rb
+- woro.gemspec
+homepage: http://github.com/Dahie/woro
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Write once, run once. One-time migration task management on remote servers
+  through mina.
+test_files: []