queue_sync 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: af37da4a62e03a4d4e8f745e119663ba8bc07f7e
+  data.tar.gz: 23f4ac642bb878cd614a27eb03e2e7e6ef671eb7
+SHA512:
+  metadata.gz: 63e3b403218ba1a47d4ec06e51b7c5aebb0aebe7c969868f1d5d02464ebfb97fb1aaf2b474b21c6e3b28b6aac904378351157295dfb2fb8f8f3f0b7701d81ffc
+  data.tar.gz: a4ded6b2800ac52d26b4f81e92b0c489d133da8415172d36b9a895b974b64bc3fb0060df3f0a944141a22edf72f74943565b531b0e22619545cb71329e43c627

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Karthik T
+
+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,56 @@
+# QueueSync
+
+This is a script that was specifically built to transfer video files from my Macbook pro to my Android phone where they are consumed. This is a restricted sync in which new files are pushed only from source to consumer, and deletions are only propogated from consumer to source, thus becoming a queue. 
+
+This also means that currently this only works for local source, and ssh remote consumer.
+
+Currently this script doesnt delete consumed files, it just moves them into a `.deleted` folder. At some point, this folder might get cleared on the next run of the script, giving you a little safety to catch accidental deletions.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'queue_sync'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install queue_sync
+
+## Usage
+
+The script can be used as follows
+
+`queue_sync <src_path> <dest_host> <dest_port> <dest_path>`
+
+Where the `src_path` and `dest_path` are paths to the folder to be synced on the source and consumer respectively, and `dest_host` and `dest_port` are the host to ssh to and the port to use for connection.
+
+I keep a wrapper which hardcodes all the parameters which might stay constant and just reads the `dest_host` from the console since that changes often. This wrapper then calls `queue_sync` appropriately.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Development
+
+1. Clean up the code into modular components
+2. Add some tests
+3. Allow for non ssh consumers and other usability fixes
+4. Implement actual deletion again
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ktaragorn/queue_sync.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "queue_sync"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/queue_sync

@@ -0,0 +1,114 @@
+#!/usr/bin/env ruby
+src_path, dest_host, dest_port, dest_path = ARGV
+port ||= 22
+require "ostruct"
+require 'fileutils'
+
+class LastSyncList
+  def initialize src_path
+    @file = File.join(src_path, ".last_sync_list")
+  end
+
+  def read
+    File.readlines(@file).map(&:chomp)
+  rescue Errno::ENOENT
+    []
+  end
+
+  def write list
+    File.write(@file, Array(list).join("\n"))
+  end
+end
+
+class FileLister
+  attr_reader :dir
+  def initialize dir
+    @dir = File.expand_path(dir)
+  end
+  def list
+    files = _list
+    post_process files
+  end
+
+  def file_list_cmd
+    #ignore dot files/folders
+    "cd \"#{dir}\" && find . -type f"
+  end
+
+  def post_process list_of_files
+    is_hidden = ->(f){f.match(/\/\..*/)}
+    list_of_files.split("\n").map{|file| file.gsub(dir, "./").gsub(/^.\//, "")}.reject(&is_hidden)
+  end
+end
+
+class RemoteFileLister < FileLister
+  attr_reader :dest
+  def initialize dest
+    @dest = dest
+    super(dest.path)
+  end
+
+  def ssh_command host, port, command
+    ret = `ssh #{host} -p #{port} \"#{command}\"`
+    if $? != 0
+      raise "Command Failed"
+    end
+    ret
+  end
+
+  def _list
+    ssh_command dest.host, dest.port, file_list_cmd
+  end
+end
+
+class LocalFileLister < FileLister
+  def initialize src_path
+    super(src_path)
+  end
+
+  def _list
+    `#{file_list_cmd}`
+  end
+end
+
+def current_list_remote dest
+  RemoteFileLister.new(dest).list
+end
+
+def delete_remote_deleted_files src_path, list
+  #TODO once tested, to add a stage here, before the next stage, to wipe .deleted
+  del_folder =File.join(src_path, ".deleted")
+  Dir.mkdir del_folder unless File.directory?(del_folder)
+  list.each do |file|
+    puts "Deleting #{file}"
+    #2 stage deletion - to prevent accidental deletion
+    #perhaps shift to .deleted folder and delete in 2nd pass
+
+    src    = File.join(src_path, file)
+    target = File.join(del_folder, file)
+    FileUtils.mkdir_p(File.dirname(target))
+    File.rename(src, target)
+  end
+end
+
+def rsync_push_new_files src, dest
+  # ignore existing to optimize for android transfer where i think modification time or something is not being set
+  # Files are not expected to be modified on the remote, so this should suffice
+  # -W to optimize for large files
+  # exclude dot files and folders -http://askubuntu.com/a/482920/92812
+  system("rsync -rvzWh --exclude \".*\" --exclude \".*/\" --ignore-existing --progress -e \"ssh -p #{dest.port}\" \"#{src}\" \"#{dest.host}:#{dest.path}\"")
+end
+
+def current_list_local path
+  LocalFileLister.new(path).list
+end
+
+dest = OpenStruct.new(host: dest_host, port: dest_port, path: dest_path)
+lsl = LastSyncList.new(src_path)
+
+list_at_last_sync = lsl.read
+
+delete_remote_deleted_files(src_path, list_at_last_sync - current_list_remote(dest))
+rsync_push_new_files(src_path, dest)
+
+lsl.write(current_list_local(src_path))

data/lib/queue_sync/version.rb

@@ -0,0 +1,3 @@
+module QueueSync
+  VERSION = "0.1.0"
+end

data/lib/queue_sync.rb

@@ -0,0 +1,5 @@
+require "queue_sync/version"
+
+module QueueSync
+  # Your code goes here...
+end

data/queue_sync.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'queue_sync/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "queue_sync"
+  spec.version       = QueueSync::VERSION
+  spec.authors       = ["Karthik T"]
+  spec.email         = ["karthikt.holmes+github@gmail.com"]
+
+  spec.summary       = %q{This is a script to sync files from a source to a consumer of said files}
+  spec.description   = %q{This is a script that was specifically built to transfer video files from my Macbook pro to my Android phone where they are consumed. This is a restricted sync in which new files are pushed only from source to consumer, and deletions are only propogated from consumer to source, thus becoming a queue.}
+  spec.homepage      = "https://github.com/ktaragorn/queue_sync"
+  spec.license       = "MIT"
+
+  # # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: queue_sync
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Karthik T
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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'
+description: This is a script that was specifically built to transfer video files
+  from my Macbook pro to my Android phone where they are consumed. This is a restricted
+  sync in which new files are pushed only from source to consumer, and deletions are
+  only propogated from consumer to source, thus becoming a queue.
+email:
+- karthikt.holmes+github@gmail.com
+executables:
+- queue_sync
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/queue_sync
+- lib/queue_sync.rb
+- lib/queue_sync/version.rb
+- queue_sync.gemspec
+homepage: https://github.com/ktaragorn/queue_sync
+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.5.1
+signing_key: 
+specification_version: 4
+summary: This is a script to sync files from a source to a consumer of said files
+test_files: []