karo 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 44dece09021fc876f10803a137f5909a6a621224
+  data.tar.gz: afbe83d75b36bbf57b52901dbe3b979f3dafccd3
+SHA512:
+  metadata.gz: 1400628e1e9d333cf829210ae2025a282216bcf196d721a0182d131d57b41883831108f680a46e25a023f4f2819a66692da700f5c3d58eca215f4a032ba239d9
+  data.tar.gz: afe685bcc5200489ce67459d1fbb87dbf4d0aafbd7ec665b6deec6ff7d387d686f55b3beb38a6b8b70b6170627866fc6a85bcd21dfc1eac8a044f27d0510cada

data/.gitignore

@@ -0,0 +1,9 @@
+.DS_Store
+results.html
+pkg
+html
+tmp
+Gemfile.lock
+public
+config
+.karo.yml

data/.rbenv-gemsets

@@ -0,0 +1 @@
+karo

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+## v1.0.0
+
+### Features
+
+- Added basic commands to sync db, assets from remote rails servers
+- Added basic commands to show log, clear cache from remote rails servers

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2013 YOUR NAME 
+
+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,21 @@
+# Getting Started [![Code Climate](https://codeclimate.com/github/rahult/karo.png)](https://codeclimate.com/github/rahult/karo) [![Dependency Status](https://gemnasium.com/rahult/karo.png)](https://gemnasium.com/rahult/karo) [![Gem Version](https://badge.fury.io/rb/karo.png)](http://badge.fury.io/rb/karo)
+
+**Karo** is a commandline companion for a rails application which makes db, assets syncs accross multiple rails servers easier while development
+
+## Installation
+
+Karo is released as a Ruby Gem. The gem is to be installed within a Ruby
+on Rails application. To install, simply add the following to your Gemfile:
+
+```ruby
+# Gemfile
+gem 'karo'
+```
+
+After updating your bundle, you can use Karo function from the command line
+
+## Usage (Commandline)
+
+```bash
+karo help
+```

data/Rakefile

@@ -0,0 +1,61 @@
+def dump_load_path
+  puts $LOAD_PATH.join("\n")
+  found = nil
+  $LOAD_PATH.each do |path|
+    if File.exists?(File.join(path,"rspec"))
+      puts "Found rspec in #{path}"
+      if File.exists?(File.join(path,"rspec","core"))
+        puts "Found core"
+        if File.exists?(File.join(path,"rspec","core","rake_task"))
+          puts "Found rake_task"
+          found = path
+        else
+          puts "!! no rake_task"
+        end
+      else
+        puts "!!! no core"
+      end
+    end
+  end
+  if found.nil?
+    puts "Didn't find rspec/core/rake_task anywhere"
+  else
+    puts "Found in #{path}"
+  end
+end
+require 'bundler'
+require 'rake/clean'
+
+require 'rake/testtask'
+
+require 'cucumber'
+require 'cucumber/rake/task'
+gem 'rdoc' # we need the installed RDoc gem, not the system one
+require 'rdoc/task'
+
+include Rake::DSL
+
+Bundler::GemHelper.install_tasks
+
+
+Rake::TestTask.new do |t|
+  t.pattern = 'test/tc_*.rb'
+end
+
+
+CUKE_RESULTS = 'results.html'
+CLEAN << CUKE_RESULTS
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "features --format html -o #{CUKE_RESULTS} --format pretty --no-source -x"
+  t.fork = false
+end
+
+Rake::RDocTask.new do |rd|
+  
+  rd.main = "README.rdoc"
+  
+  rd.rdoc_files.include("README.rdoc","lib/**/*.rb","bin/**/*")
+end
+
+task :default => [:test,:features]
+

data/bin/karo

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require 'karo'
+
+begin
+  Karo::CLI.start(ARGV)
+rescue SystemExit, Interrupt
+  puts "Exiting"
+rescue Exception => e
+  puts e
+end

data/features/karo.feature

@@ -0,0 +1,19 @@
+Feature: Fetch assets
+  In order to get project assets onto a new computer
+  I want a one-command way to keep them up to date
+  So I don't have to do it myself
+
+  Scenario: Basic UI
+    When I get help for "karo"
+    Then the exit status should be 0
+    And the banner should be present
+    And there should be a one line summary of what the app does
+    And the banner should document that this app takes options
+    And the banner should document that this app's arguments are:
+      |from|which is required|
+      |to  |which is required|
+
+  Scenario: Happy Path
+    Given a path with some files at "/tmp/karo/server_assets/" to be synced at "/tmp/karo/client_assets/"
+    When I successfully run `karo /tmp/karo/server_assets/ /tmp/karo/client_assets/`
+    Then the assets should be synced out in the directory "/tmp/karo/client_assets/"

data/features/step_definitions/karo_steps.rb

@@ -0,0 +1,34 @@
+include FileUtils
+
+FILES = %w(image.jpg document.pdf)
+
+def create(path)
+  base_directory   = File.dirname(path)
+  assets_directory = File.basename(path)
+
+  # Delete and create the path
+  Dir.chdir base_directory do
+    rm_rf assets_directory
+    mkdir assets_directory
+  end
+end
+
+Given(/^a path with some files at "(.*?)" to be synced at "(.*?)"$/) do |from_path, to_path|
+  create from_path
+  create to_path
+
+  # Create test assets to be used for syncing
+  Dir.chdir from_path do
+  	FILES.each { |_| touch _ }
+  end
+end
+
+Then(/^the assets should be synced out in the directory "(.*?)"$/) do |sync_to_path|
+  File.exist?(sync_to_path).should == true
+
+  Dir.chdir sync_to_path do
+    FILES.each do |file|
+      File.exist?(file).should == true
+    end
+  end
+end

data/features/support/env.rb

@@ -0,0 +1,16 @@
+require 'aruba/cucumber'
+require 'methadone/cucumber'
+
+ENV['PATH'] = "#{File.expand_path(File.dirname(__FILE__) + '/../../bin')}#{File::PATH_SEPARATOR}#{ENV['PATH']}"
+LIB_DIR = File.join(File.expand_path(File.dirname(__FILE__)),'..','..','lib')
+
+Before do
+  # Using "announce" causes massive warnings on 1.9.2
+  @puts = true
+  @original_rubylib = ENV['RUBYLIB']
+  ENV['RUBYLIB'] = LIB_DIR + File::PATH_SEPARATOR + ENV['RUBYLIB'].to_s
+end
+
+After do
+  ENV['RUBYLIB'] = @original_rubylib
+end

data/karo.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'karo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "karo"
+  spec.version       = Karo::VERSION
+  spec.authors       = ["Rahul Trikha"]
+  spec.email         = ["rahul.trikha@gmail.com"]
+  spec.description   = "SSH toolbox to make running logs, sync, cache commands easier for a given rails app"
+  spec.summary       = spec.description
+  spec.homepage      = "http://rahult.github.io/karo/"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_development_dependency  "pry"
+  spec.add_development_dependency  "bundler", "~> 1.3"
+  spec.add_development_dependency  "rake"
+  spec.add_development_dependency  "rdoc"
+  spec.add_development_dependency  "aruba"
+  spec.add_development_dependency  "rake", "~> 0.9.2"
+  spec.add_dependency "awesome_print"
+  spec.add_dependency "thor"
+end

data/lib/karo/assets.rb

@@ -0,0 +1,54 @@
+require 'karo/config'
+require 'thor'
+
+module Karo
+
+	class Assets < Thor
+
+    include Thor::Actions
+
+	  desc "pull", "syncs assets from server shared/system/dragonfly/<environment> directory into local system/dragonfly/development directory"
+	  def pull
+	    configuration = Config.load_configuration(options)
+
+      path_local  = File.expand_path("public/system/dragonfly/development")
+      empty_directory path_local unless File.exists?(path_local)
+
+      path_server = File.join(configuration["path"], "shared/system/dragonfly/#{options[:environment]}")
+
+	    host = "deploy@#{configuration["host"]}"
+	    cmd  = "rsync -az --progress #{host}:#{path_server}/ #{path_local}/"
+
+      system "#{cmd}"
+
+      say "Assets sync complete", :green
+	  end
+
+    desc "push", "syncs assets from system/dragonfly/development directory into local server shared/system/dragonfly/<environment> directory"
+	  def push
+      configuration = Config.load_configuration(options)
+
+      path_local  = File.expand_path("public/system/dragonfly/development")
+      unless File.exists?(path_local)
+        raise Thor::Error, "Please make sure that this local path exists? '#{path_local}'"
+      end
+
+      host = "deploy@#{configuration["host"]}"
+
+      path_server = File.join(configuration["path"], "shared/system/dragonfly/#{options[:environment]}")
+
+      cmd_1  = "ssh #{host} 'mkdir -p #{path_server}'"
+      cmd_2  = "rsync -az --progress #{path_local}/ #{host}:#{path_server}/"
+
+      if yes?("Are you sure?", :yellow)
+        system "#{cmd_1}"
+        system "#{cmd_2}"
+        say "Assets sync complete", :green
+      else
+        say "Assets sync cancelled", :yellow
+      end
+	  end
+
+	end
+
+end

data/lib/karo/cache.rb

@@ -0,0 +1,37 @@
+require 'karo/config'
+require 'thor'
+
+module Karo
+
+	class Cache < Thor
+
+	  desc "search", "searches for any matching cache files from the shared/cache directory"
+	  def search(name="")
+	    configuration = Config.load_configuration(options)
+	    path = File.join(configuration["path"], "shared/cache")
+	    ssh  = "ssh #{configuration["user"]}@#{configuration["host"]}"
+	    cmd  = "find #{path} -type f -name \"*#{name}*\""
+
+      system "#{ssh} '#{cmd}'"
+	  end
+
+	  desc "remove", "removes any matching cache files from the shared/cache directory"
+	  def remove(name="")
+      invoke :search
+
+      configuration = Config.load_configuration(options)
+      path = File.join(configuration["path"], "shared/cache")
+      ssh  = "ssh #{configuration["user"]}@#{configuration["host"]}"
+      cmd  = "find #{path} -type f -name \"*#{name}*\" -delete"
+
+      if yes?("Are you sure?", :yellow)
+        system "#{ssh} '#{cmd}'"
+        say "Cache removed", :green
+      else
+        say "Cache not removed", :yellow
+      end
+	  end
+
+	end
+
+end

data/lib/karo/cli.rb

@@ -0,0 +1,56 @@
+require 'karo/version'
+require 'karo/config'
+require 'karo/assets'
+require 'karo/cache'
+require 'karo/db'
+require 'thor'
+require 'ap'
+
+module Karo
+
+	class CLI < Thor
+
+	  class_option :config_file, type: :string, default: Config.default_file_name,
+	  						  aliases: "-c", desc: "name of the file containing server configuration"
+	  class_option :environment, aliases: "-e", desc: "server environment", default: "production"
+
+	  desc "log", "displays server log for a given environment"
+	  def log(name="")
+	    configuration = Config.load_configuration(options)
+
+	    path = File.join(configuration["path"], "shared/log/#{options["environment"]}.log")
+	    ssh  = "ssh #{configuration["user"]}@#{configuration["host"]}"
+
+	    if name.eql?("")
+	    	cmd = "tail -f #{path}"
+	    else
+	    	cmd = "tail #{path} | grep -A 10 -B 10 #{name}"
+	    end
+
+	    system "#{ssh} '#{cmd}'"
+	  end
+
+    desc "cache [search, remove]", "find or clears a specific or all cache from shared/cache directory on the server"
+    subcommand "cache", Cache
+
+    desc "assets [pull, push]", "syncs assets between server shared/system/dragonfly/<environment> directory and local system/dragonfly/development directory"
+    subcommand "assets", Assets
+
+    desc "db [pull, push]", "syncs MySQL database between server and localhost"
+    subcommand "db", DB
+
+	  desc "config", "displays server configuration stored in a config file"
+	  def config
+	    configuration = Config.load_configuration(options)
+
+	    ap configuration if configuration
+	  end
+
+	  desc "version", "displays karo's current version"
+	  def version
+	  	say Karo::VERSION
+	  end
+
+	end
+
+end

data/lib/karo/config.rb

@@ -0,0 +1,41 @@
+require 'yaml'
+require 'thor'
+
+module Karo
+
+	class NoConfigFileFoundError < StandardError; end
+
+	class Config
+
+		def self.default_file_name
+			".karo.yml"
+		end
+
+	  def self.load_configuration(options)
+	  	begin
+        config_file = File.expand_path(options[:config_file])
+	  		configuration = read_configuration(config_file)[options[:environment]]
+
+		  	if configuration.nil? || configuration.empty?
+		  		raise Thor::Error, "Please pass a valid configuration for an environment '#{options[:environment]}' within this file '#{config_file}'"
+		  	else
+		  		configuration
+		  	end
+		  rescue Karo::NoConfigFileFoundError
+		  	raise Thor::Error, "Please make sure that this configuration file exists? '#{config_file}'"
+		  end
+	  end
+
+	  private
+
+	  def self.read_configuration(file_name)
+	    if File.exist?(file_name)
+	      YAML.load_file(file_name)
+	    else
+	      raise NoConfigFileFoundError
+	    end
+	  end
+
+	end
+
+end

data/lib/karo/db.rb

@@ -0,0 +1,66 @@
+require 'karo/config'
+require 'thor'
+require 'yaml'
+require 'erb'
+require 'ap'
+
+module Karo
+
+	class DB < Thor
+
+    include Thor::Actions
+
+	  desc "pull", "syncs MySQL database from server to localhost"
+	  def pull
+	    configuration = Config.load_configuration(options)
+
+      local_db_config_file  = File.expand_path("config/database.yml")
+      unless File.exists?(local_db_config_file)
+        raise Thor::Error, "Please make sure that this file exists locally? '#{local_db_config_file}'"
+      end
+
+      local_db_config = YAML.load(File.read('config/database.yml'))
+
+      if local_db_config["development"].nil? || local_db_config["development"].empty?
+        raise Thor::Error, "Please make sure MySQL development configuration exists within this file? '#{local_db_config_file}'"
+      end
+
+      local_db_config = local_db_config["development"]
+
+      say "Loading local database configuration", :green
+
+      server_db_config_file = File.join(configuration["path"], "shared/config/database.yml")
+
+	    host = "deploy@#{configuration["host"]}"
+	    cmd  = "ssh #{host} 'cat #{server_db_config_file}'"
+
+      server_db_config_output = `#{cmd}`
+      yaml_without_any_ruby = ERB.new(server_db_config_output).result
+      server_db_config = YAML.load(yaml_without_any_ruby)
+
+      if server_db_config[options[:environment]].nil? || server_db_config[options[:environment]].empty?
+        raise Thor::Error, "Please make sure MySQL development configuration exists within this file? '#{server_db_config_file}'"
+      end
+
+      server_db_config = server_db_config[options[:environment]]
+
+      say "Loading #{options[:environment]} server database configuration", :green
+
+      # Drop local database and re-create
+      system "mysql -v -h #{local_db_config["host"]} -u#{local_db_config["username"]} -p#{local_db_config["password"]} -e 'DROP DATABASE `#{local_db_config["database"]}`; CREATE DATABASE IF NOT EXISTS `#{local_db_config["database"]}`;'"
+
+      ssh  = "ssh #{configuration["user"]}@#{configuration["host"]}"
+
+      system "#{ssh} \"mysqldump --opt -C -u#{server_db_config["username"]} -p#{server_db_config["password"]} #{server_db_config["database"]}\" | mysql -v -h #{local_db_config["host"]} -C -u#{local_db_config["username"]} -p#{local_db_config["password"]} #{local_db_config["database"]}"
+
+      say "Database sync complete", :green
+	  end
+
+    desc "push", "syncs MySQL database from localhost to server"
+	  def push
+      say "Pending Implementation...", :yellow
+	  end
+
+	end
+
+end

data/lib/karo/version.rb

@@ -0,0 +1,3 @@
+module Karo
+  VERSION = "1.0.0"
+end

data/lib/karo.rb

@@ -0,0 +1,5 @@
+require "karo/version"
+require "karo/cli"
+
+module Karo
+end

data/test/tc_something.rb

@@ -0,0 +1,7 @@
+require 'test/unit'
+
+class TestSomething < Test::Unit::TestCase
+  def test_truth
+    assert true
+  end
+end

metadata

@@ -0,0 +1,183 @@
+--- !ruby/object:Gem::Specification
+name: karo
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Rahul Trikha
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-30 00:00:00.000000000 Z
+dependencies:
+- !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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rdoc
+  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: aruba
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  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: thor
+  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: SSH toolbox to make running logs, sync, cache commands easier for a given
+  rails app
+email:
+- rahul.trikha@gmail.com
+executables:
+- karo
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rbenv-gemsets
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/karo
+- features/karo.feature
+- features/step_definitions/karo_steps.rb
+- features/support/env.rb
+- karo.gemspec
+- lib/karo.rb
+- lib/karo/assets.rb
+- lib/karo/cache.rb
+- lib/karo/cli.rb
+- lib/karo/config.rb
+- lib/karo/db.rb
+- lib/karo/version.rb
+- test/tc_something.rb
+homepage: http://rahult.github.io/karo/
+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.2
+signing_key: 
+specification_version: 4
+summary: SSH toolbox to make running logs, sync, cache commands easier for a given
+  rails app
+test_files:
+- features/karo.feature
+- features/step_definitions/karo_steps.rb
+- features/support/env.rb
+- test/tc_something.rb