fiverr_copy 1.0.2 → 1.0.3

data/README.md

@@ -18,7 +18,70 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+FiverrCopy automates the process of distributing files to multiple servers in a sync column method.
+You'll need to write a "recipe" and boot up the server with that recipe.
+
+What it actually does is to create a linked list of servers in which ever client is connected to the next client
+starting with the server.
+the server then distributes the file to the first client in queue, and this client passes every chunk of data it gets to the next client and so on.
+
+the main benefit is obviously getting a more efficient way to distribute files to multiple machines than the normal scp, nfs mount, etc.
+
+## Recipes
+
+To create a FiverrCopy recipe, just create a ruby file that looks something like this
+
+```ruby
+FiverrCopy::Server.recipe = FiverrCopy::Recipe.new("My Awesome Script", "a void description") do |recipe|
+  recipe.filter = "*.jpg"
+  recipe.clients = ["server1", "server2"]
+  recipe.username = "serveruser"
+  recipe.port = 1555
+  recipe.chunk_size = 1024
+  recipe.manual = true
+end
+```
+* filter: this is the file selector that the FiverrCopy::Server will grab and tar before distribution, you can either specify a wildcard, a specific file or join both by spaces.
+* clients: a list of ips or hosts to distribute the file to. protip: use host names that all the servers in the process are familiar with (server and clients).
+* username: FiverrCopy uses Net::SSH to fire up some events, it counts on you that your current user can login to any of the machines using a username only and an ssh key.
+* port: which port to run on.
+* chunk_size: buffer size when sending file chunks.
+* manuak: FiverrCopy will try to fire up clients when it runs, if you want to run them by yourself - toggle this option and the FiverrCopy::Server will assume the clients are ready.
+
+## Binary
+
+FiverrCopy contains only one binary which is `fiverr_copy`:
+
+```bash
+Usage: fiverr_copy [options]
+    -c, --client                     Run as client
+    -s, --server                     Run as server
+    -p, --port PORT                  Select a port. (default: 1234)
+    -r, --recipe FILE                Specify a recipe file
+    -n, --nexthop IP/HOST            Specify the next hop for distribution
+    -f, --filename FILENAME          Specify filename
+    -w, --chunk CHUNK_SIZE           specify chunk size
+    -h, --help                       Display this screen
+```
+
+## Examples
+
+running a server:
+
+`fiverr_copy --server --recipe /etc/distribute_mysql_dump.rb`
+
+the server will only need the `--server` and the `--recipe` options.
+
+running a client manually:
+
+`fiverr_copy --client --port 1555 --filename mysql_dump_compressed_1333364100.tgz --chunk 1024`
+
+this will run a FiverrCopy::Client instance on port 1555, reading 1024 bytes at a time from stream to the mysql_dump_compressed_* file destination.
+
+## TODOs
+
+1. Testing, how.
+
 
 ## Contributing
 

data/lib/fiverr_copy/server.rb

@@ -17,6 +17,22 @@ class FiverrCopy::Server
     compressed_file_name = "fiverr_copy_compressed_#{Time.now.to_i}.tgz"
 
     if !(self.recipe.manual_client_activation?)
+
+      last_hop =  self.recipe.initialized_clients.shift
+      
+      puts "Last Hop: #{last_hop.inspect}"
+      threads << Thread.new(last_hop) do |current_client|
+        current_client.setup!
+        Net::SSH.start(current_client.client_ip, current_client.username) do |ssh|
+          gem_exists = ssh.exec("which fiverr_copy") == "" ? false : true
+          if !(gem_exists)
+            puts "Please install the fiverr_copy gem on all clients."
+            exit 0
+          end
+          ssh.exec("fiverr_copy --client --port #{self.recipe.port} --filename #{compressed_file_name} --chunk #{self.recipe.chunk_size} \&")
+        end
+      end
+
       self.recipe.initialized_clients.each do |client|
         threads << Thread.new(client) do |current_client|
           current_client.setup!
@@ -27,11 +43,7 @@ class FiverrCopy::Server
               puts "Please install the fiverr_copy gem on all clients."
               exit 0
             end
-            next_client = "--nexthop #{current_client.next_client}" if current_client.next_client
-            puts "#{current_client.client_ip}: fiverr_copy --client --port #{self.recipe.port} --filename #{compressed_file_name} --chunk #{self.recipe.chunk_size} #{next_client} \&"
-            silence_stream(STDOUT) do
-              ssh.exec("fiverr_copy --client --port #{self.recipe.port} --filename #{compressed_file_name} --chunk #{self.recipe.chunk_size} #{next_client} \&")
-            end
+            ssh.exec("fiverr_copy --client --port #{self.recipe.port} --filename #{compressed_file_name} --chunk #{self.recipe.chunk_size} --nexthop #{current_client.next_client} \&")
           end
         end
       end
@@ -75,7 +87,7 @@ class FiverrCopy::Server
       while !(client_session.closed?) && (buffer = transmitted_file.read(self.recipe.chunk_size)) do
         client_session.write buffer
         sent += self.recipe.chunk_size
-        print "\r#{"%.2f" % (sent.to_f / file_size.to_f * 100)}% "
+        print "\r#{"%.2f" % (sent.to_f / file_size.to_f * 100)}% " if Time.now.to_i % 3 == 0
       end
       puts "Done!"
     end

data/lib/fiverr_copy/version.rb

@@ -1,3 +1,3 @@
 module FiverrCopy
-  VERSION = "1.0.2"
+  VERSION = "1.0.3"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: fiverr_copy
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: false
   segments: 
   - 1
   - 0
-  - 2
-  version: 1.0.2
+  - 3
+  version: 1.0.3
 platform: ruby
 authors: 
 - Elad Meidar