kinksync 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ac32beb8f7f8fb7d4337fa4212d2522e882892bf
+  data.tar.gz: 4601135a9316309ab48935d379a4b1d10a91de9c
+SHA512:
+  metadata.gz: 79d3de36c2a138a4fb4542ff35f24b841df064dd960b9105c1fd31ceee8175a9a0f51f6d6b1eae66325fb825e048141935a6f85ca2fe8cc9148c00b836aaf097
+  data.tar.gz: bdb85af153e96625c769b3ce1295fe21620ff166517bc1bbab2e90cb9947839d46930ed96fdfba74716d779a8010bbd55f37ec47b4a730cf3c4f59396d83c4cf

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.14.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Pablo
+
+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,50 @@
+# Kinksync
+
+Kinksync is a simple gem that let's you synchronize files all over your directory tree with any cloud storage mounted on your file system. If you have two similar systems in different computers and want to share certain configuration files, Kinksync will help you do it easily.
+
+## Installation
+
+Install it from RubyGems:
+
+```
+$ gem install kinksync
+```
+
+Kinksync was made to be used as a CLI, but you can also include in your application's Gemfile:
+
+```ruby
+gem 'kinksync'
+```
+
+And then execute:
+```
+    $ bundle
+```
+
+## Usage
+
+Simple run it from your terminal.
+```
+$ kinksync [-h] [PATHS_LIST]
+```
+
+### Without arguments
+Sync all files under remote cloud path with local storage
+
+### Optional arguments
+* `-h, --help` Show this help message and exit
+* `[FILE_OR_PATHS_LIST]` Sync all files inside each path, or the file itself
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at <https://github.com/Pizzicato/kinksync>.
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/kinksync

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+require 'bundler/setup'
+require 'kinksync'
+
+# -h or --help as argument
+unless (ARGV & ['-h', '--help']).empty?
+  STDOUT.puts <<-EOF
+  Usage: kinksync [-h] [PATHS_LIST]
+
+  Sync files located all over the directory tree in different computers using any cloud storage
+
+  Without arguments:
+    Sync all files under remote cloud path with local storage
+
+  Optional arguments:
+    -h, --help              Show this help message and exit
+    [FILE_OR_PATHS_LIST]    Sync all files inside each path, or the file itself
+  EOF
+  exit
+end
+
+# normal execution
+Kinksync.configure do |config|
+  config.remote_path = '~/MEGA/kinksync'
+end
+
+puts "Using #{Kinksync.configuration.remote_path} as remote path."
+puts 'Kinksyncing...'
+synced = Kinksync.sync(ARGV)
+puts 'Done!'
+if synced.empty?
+  puts 'All up to date, nothing synced.'
+else
+  puts 'Naughtily synced files:'
+  synced.each { |f| puts f.sub(Kinksync.configuration.remote_path, '') }
+end

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/kinksync.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kinksync/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'kinksync'
+  spec.version       = Kinksync::VERSION
+  spec.authors       = ['Pablo']
+  spec.email         = ['pabloguaza@gmail.com']
+
+  spec.summary       = 'Sync files all over directory tree with any cloud storage mounted on your file system'
+  spec.homepage      = 'https://github.com/Pizzicato/kinksync'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir = 'bin'
+  spec.executables << 'kinksync'
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'fakefs', '~> 0.10'
+end

data/lib/kinksync.rb

@@ -0,0 +1,69 @@
+require 'find'
+
+require 'kinksync/version'
+require 'kinksync/configuration'
+require 'kinksync/path_2_sync'
+require 'kinksync/file_2_sync'
+
+##
+# Kynsync parent module for all classes.
+# Provides methods for configuration and synchronization of a group of files
+# and/or directories
+##
+module Kinksync
+  class << self
+    # Configuration class instance
+    attr_writer :configuration
+  end
+
+  # Configures a Kynksync module with the values provided through the block
+  # it recieves
+  #
+  # @param [block]
+  #    Values:
+  #      - remote_path: path to mounting cloud storage location
+  #
+  # @example
+  #   Kinksync.configure do |config|
+  #     config.remote_path = '/home/pablo/MEGA/kinksync/'
+  #     config.log_file = config.remote_path + 'kinksync.log'
+  #   end
+  #
+  def self.configure
+    yield(configuration)
+  end
+
+  # Returns current configuration or initializes an empty one and returns it
+  #
+  # @return Configuration object
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  # Resets configuration: all attributes are set to nil
+  #
+  # @return Empty Configuration object
+  def self.reset
+    @configuration = nil
+  end
+
+  # Syncs lists of files and paths recieved as arguments. If no arg is provided
+  # syncs all files in remote path
+  #
+  # @param paths_to_sync [Array] List of files and paths to sync
+  #
+  # @example
+  #   Kinksync.sync([
+  #     'a_file.mp3',
+  #     '/an/absolute/path/',
+  #     'another_file.avi',
+  #     'a/relative/path'
+  #   ])
+  #
+  def self.sync(paths_to_sync = [])
+    synced = []
+    paths_to_sync = [Kinksync.configuration.remote_path] if paths_to_sync.empty?
+    paths_to_sync.each { |p| synced += Path2Sync.new(p).sync }
+    synced
+  end
+end

data/lib/kinksync/configuration.rb

@@ -0,0 +1,21 @@
+module Kinksync
+  # Configuration class
+  #
+  class Configuration
+    # absolute path to mounted cloud storage location
+    attr_reader :remote_path
+
+    # initializes Configuration with nil value for remote_path
+    #
+    def initialize
+      @remote_path = nil
+    end
+
+    # Returns absolute path of remote path
+    #
+    # @return [String] remote path
+    def remote_path=(remote_path)
+      @remote_path = File.expand_path(remote_path)
+    end
+  end
+end

data/lib/kinksync/file_2_sync.rb

@@ -0,0 +1,65 @@
+module Kinksync
+  #
+  # Class that represents a duple of files with *absolute* path which
+  # can be synced
+  #
+  class File2Sync
+    #
+    # Configures a File2Sync class
+    #
+    # @param file [String] local or remote file to sync
+    #
+    def initialize(file)
+      @file = file
+      @twin_file = twin_file(file)
+    end
+
+    #
+    # Sync a file, copying origin over destination
+    #
+    # @return file or nil if file is already synced
+    #
+    def sync
+      if File.exist?(@twin_file) && FileUtils.identical?(@file, @twin_file)
+        nil
+      else
+        origin = newer
+        destination = twin_file(origin)
+        FileUtils.mkdir_p(File.dirname(@twin_file))
+        FileUtils.cp(origin, destination)
+        @file
+      end
+    end
+
+    private
+
+    #
+    # Return newer file
+    #
+    def newer
+      FileUtils.uptodate?(@file, [@twin_file]) ? @file : @twin_file
+    end
+
+    #
+    # Gets twin file of file provided
+    #
+    # @param file [String] file to get twin from
+    #
+    def twin_file(file)
+      if remote? file
+        file.sub(Kinksync.configuration.remote_path, '')
+      else
+        Kinksync.configuration.remote_path + file
+      end
+    end
+
+    #
+    # Decides whether a file is remote or local
+    #
+    # @param file [String]
+    #
+    def remote?(file)
+      File.dirname(file).start_with?(Kinksync.configuration.remote_path)
+    end
+  end
+end

data/lib/kinksync/path_2_sync.rb

@@ -0,0 +1,30 @@
+module Kinksync
+  #
+  # Class that represents an *absolute* local or remote path which
+  # contains file(s) and/or directories to sync
+  #
+  class Path2Sync
+    #
+    # Configures a Path2Sync class
+    #
+    # @param path [String] local or remote path to sync
+    #
+    def initialize(path)
+      @path = File.expand_path(path)
+    end
+
+    #
+    # Syncs all files in path and its subdirectories, ignores symlinks
+    #
+    # @return lists of synced files, only including those changed
+    #
+    def sync
+      synced = []
+      files_to_sync = Find.find(@path).select do |f|
+        File.file?(f) && !File.symlink?(f)
+      end
+      files_to_sync.each { |f| synced.push(f) if File2Sync.new(f).sync }
+      synced
+    end
+  end
+end

data/lib/kinksync/version.rb

@@ -0,0 +1,4 @@
+module Kinksync
+  # Current gem version  
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: kinksync
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pablo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: 
+email:
+- pabloguaza@gmail.com
+executables:
+- kinksync
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/kinksync
+- bin/setup
+- kinksync.gemspec
+- lib/kinksync.rb
+- lib/kinksync/configuration.rb
+- lib/kinksync/file_2_sync.rb
+- lib/kinksync/path_2_sync.rb
+- lib/kinksync/version.rb
+homepage: https://github.com/Pizzicato/kinksync
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Sync files all over directory tree with any cloud storage mounted on your
+  file system
+test_files: []
+has_rdoc: