kate-get 0.1.0

data/LICENCE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2011 Evan Boyd Sosenko
+
+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

@@ -0,0 +1,94 @@
+= Kate-Get
+
+Kate-Get takes a space separated list of file paths and checks each one against a list of sources. If a match is found, the file is copied via rsync to a local directory. Options for each source are controlled by a config file. Subdirectories are handled automatically based on how local and remote root paths are set.
+
+== Making a config file
+
+By default, Kate-Get looks for the YAML file
+
+  ~/.kate-get.yml
+
+An example of a config file
+
+  :global:
+    :host: "example.com"
+    :port: 22
+    :user: "user-name"
+
+  :sources:
+    "foo.com":
+      :local: "~/Development/foo"
+      :root: "/var/www/vhosts/##source_name##/htdocs"
+      :base: "sftp://user@foo.com:22/var/www/vhosts/##source_name##/htdocs/"
+    "bar.com":
+      :local: "~/Development/bar"
+      :root: "/var/www/vhosts/##source_name##/htdocs"
+      :base: "sftp://user@bar.com:22/var/www/vhosts/##source_name##/htdocs/"
+      :host: "bar.com"
+      :port: 42
+      :user: "bar-user-name"
+
+There are two sections
+* *global* - rsync connection information
+  * *host* - hostname or IP
+  * *port* - port to connect on
+  * *user* - username to connect with
+  * These options may be overridden on a per-source basis by specifying them there.
+
+* *sources* - each entry is a source name (string) with the following options
+  * *local* - path to local folder where files should be copied too (no leading slash)
+  * *root* - path to remote folder (input file must exist in some subdirectory of this to be copied)
+  * *base* - prefix string that will be stripped from the file name
+
+Note that the string ##source_name## will be automatically replaced by the source name.
+
+== Limitations
+
+* Currently, only rsync over ssh is supported.
+* An input file path matches a source if the input file path contains the source name.
+  * This can cause unexpected behavior if the input file name includes two strings which match two different source names.
+
+== Setting up Kate to use Kate-Get
+
+Kate-Get is meant to be used with Kate (http://kate-editor.org/) as an external tool. For information on adding external tools to Kate see http://docs.kde.org/stable/en/kdesdk/kate/config-dialog.html.
+
+
+If you want a tool that only copies the currently open file use
+
+  kate-get "%URL"
+
+If you want to loop through all open files use
+
+  kate-get "%URLs"
+
+Note that you may need to use the full path to the kate-get binary, usually
+
+  /var/lib/gems/1.9.1/bin/kate-get
+
+== Installation
+
+=== Gem Installation
+
+Download and install Kate-Get with
+
+ gem install kate-get
+
+== Development
+
+=== Source Repository
+
+Kate-Get is currently hosted at github. The github web page is
+https://github.com/razor-x/kate-get. To clone the project run
+
+  git clone git://github.com/razor-x/kate-get.git
+
+== License
+
+Kate-Get is licensed under the MIT license.
+
+== Warranty
+
+This software is provided "as is" and without any express or
+implied warranties, including, without limitation, the implied
+warranties of merchantibility and fitness for a particular
+purpose.

data/bin/kate-get

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby1.9.1
+
+require 'kate-get'
+
+fail "No file given." if ARGV.first.nil?
+
+files = ARGV.first.split " "
+
+rs = KateGet.new "~/.kate-get.yml"
+files.each do |f|
+	rs.add_file f
+end
+rs.get

data/lib/kate-get.rb

@@ -0,0 +1,62 @@
+# Main class for Kate-Get.
+class KateGet
+
+	# Reads in a YAML config file or hash.
+	# @param [String, Hash] config YAML config file or hash of config options
+	def initialize config
+		@config = \
+			if config.is_a? String
+				require 'yaml'
+				file = File.expand_path config
+				YAML.load File.read file if File.exists? file
+			elsif config.is_a? Hash
+				config
+			end
+
+		fail "Failed to load config." unless @config.is_a? Hash
+
+	end
+
+	# Files to get
+	# @param [String] files space seperated list of file paths
+	def add_file file
+		@files = [] unless @files
+		@files << file
+	end
+
+	# Uses rsync to download files based on config options.
+	def get
+
+		@files.each do |f|
+
+			# Look for the first source that matches the file.
+			site, name = nil
+			@config[:sources].each do |n, s|
+				name, site = [n, s] if f[n]
+				break if site
+			end
+
+			# Skip the file if there is no matching source.
+			next if site.nil?
+
+			# Load global connection settings and merge with source specific ones.
+			remote = @config[:global]
+			remote.merge! site[:remote] unless site[:remote].nil?
+
+			# Prepare the elements for the rsync command.
+			root_dir = site[:root].sub "##source_name##", name
+			base_url = site[:base].sub "##source_name##", name
+
+			# Skip the file if it is not in the root directory of the source.
+			next unless f[root_dir]
+
+			f.sub! base_url, ""
+			base = File.basename f
+
+			rsync = "rsync -a -e 'ssh -p #{remote[:port]}' #{remote[:user]}@#{remote[:host]}:#{root_dir}/#{f} #{site[:local]}/#{f}"
+
+			# Get the file using rsync.
+			system rsync
+		end
+	end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: kate-get
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Evan Boyd Sosenko
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-05 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: "\t\tKate-Get takes a space separated list of file paths and checks each one against a list of sources. If a match is found, the file is copied via rsync to a local directory. Options for each source are controlled by a config file.\n"
+email: 
+executables: 
+- kate-get
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/kate-get.rb
+- README
+- LICENCE
+- bin/kate-get
+has_rdoc: true
+homepage: 
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 9
+      - 2
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: 
+- rsync
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Kate external tool to intelligently copy open remote files to local directories.
+test_files: []
+