zget 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5a831b06d7c4da66c9b0632b5110bc6031754ac1
+  data.tar.gz: 69b1be9ef5e06e7f5651cc7c8d9c5aa01e9ae5c1
+SHA512:
+  metadata.gz: 690435177f2fa5d251e575cd71235dcf324abf71e0a970948161847443ed2c9964fbe5b8e6cff64918f0b5afd55a2188a77a5497e49f1e47b9bfe3383d49db77
+  data.tar.gz: dcf962e64d9804c051207bf80fd34cc1c805f05370c46238e19ec040b7e2957184afd127a7d819f9165b40db2806fc6c4217ca2cd5c079755cfa59db14a5b0ff

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 zget.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Patricio Mac Adden
+
+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,111 @@
+# Zget
+
+A simple, zeroconf-based, p2p file transfer utility. A port of [zget](https://github.com/nils-werner/zget).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "zget"
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install zget
+```
+
+## Usage
+
+### Sharing
+
+```
+$ zput awesome_file.zip
+```
+
+Then the other end can just:
+
+```
+$ zget awesome_file.zip
+```
+
+### Receiving
+
+```
+$ zget awesome_file.zip
+```
+
+Then the other end can just:
+
+```
+$ zput awesome_file.zip
+```
+
+### Aliases
+
+In case of complicated filenames you can use aliases or have `zget`/`zput`
+generate one for you:
+
+```
+$ zput myReaLlyComp_licat3d_fiLeNam3.zip
+Download this file using `zget myReaLlyComp_licat3d_fiLeNam3.zip` or `zget e208`
+```
+
+Also `zget` can generate an alias so you can initiate the transfer without
+knowing what file will be transferred:
+
+```
+$ zget
+Upload a file using `zput <filename> 8332`
+```
+
+### Options
+
+To see the available options you can just run:
+
+```
+$ zget -h
+```
+
+or
+
+```
+$ zput -h
+```
+
+## Compatibility
+
+Unfortunately this version isn't compatible with python's zget. The main reason
+is because [dnssd](github.com/tenderlove/dnssd) doesn't play well with service
+names with a dot, therefore we can't use the same service name as python's zget.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake spec` to run the tests. 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).
+
+## TODO
+
+* Improve the test suite
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/patriciomacadden/zget](https://github.com/patriciomacadden/zget).
+
+## 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/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "zget"
+
+# 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(__FILE__)

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/zget

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+
+require "optparse"
+require "zget"
+
+options = {}
+
+parser = OptionParser.new do |opts|
+  opts.banner = "Usage: #{File.basename __FILE__} [options] file_or_alias [output]"
+
+  opts.on "-h", "--help", "Show this message" do
+    puts opts.help
+    exit
+  end
+
+  opts.on "-v", "--version", "Show version" do
+    puts "#{File.basename __FILE__} #{Zget::VERSION}"
+    exit
+  end
+end
+
+parser.parse!
+
+if ARGV.size > 2
+  puts parser.help
+  exit
+end
+
+options[:file_or_alias] = ARGV.first
+options[:output] = ARGV.size == 2 ? ARGV.last : nil
+
+Zget.get options
+

data/exe/zput

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+
+require "optparse"
+require "zget"
+
+options = {}
+
+parser = OptionParser.new do |opts|
+  opts.banner = "Usage: #{File.basename __FILE__} [options] file [alias]"
+
+  opts.on "-b", "--bind-address BIND_ADDRESS", "The address to share the file on (default: 0.0.0.0)" do |bind_address|
+    options[:bind_address] = bind_address
+  end
+
+  opts.on "-h", "--help", "Show this message" do
+    puts opts.help
+    exit
+  end
+
+  opts.on "-p", "--port PORT", Integer, "The port to share the file on (default: 6666)" do |port|
+    options[:port] = port
+  end
+
+  opts.on "-v", "--version", "Show version" do
+    puts "#{File.basename __FILE__} #{Zget::VERSION}"
+    exit
+  end
+end
+
+parser.parse!
+
+if ARGV.none? || ARGV.size > 2
+  puts parser.help
+  exit
+end
+
+options[:file] = ARGV.first
+if ARGV.size == 2
+  options[:_alias] = ARGV.last
+end
+
+begin
+  Zget.put options
+rescue IPAddr::InvalidAddressError
+  puts "Invalid bind address"
+rescue Zget::InvalidFileError
+  puts "Invalid file"
+rescue Zget::InvalidPortError
+  puts "Invalid port"
+end
+

data/lib/zget.rb

@@ -0,0 +1,25 @@
+require "digest"
+require "dnssd"
+require "ipaddr"
+require "open-uri"
+require "securerandom"
+require "socket"
+require "webrick"
+
+require "zget/command"
+require "zget/command/zget"
+require "zget/command/zput"
+require "zget/errors"
+require "zget/file_handler"
+require "zget/version"
+
+module Zget
+  def self.get(file_or_alias: nil, output: nil)
+    Zget.new(file_or_alias: file_or_alias, output: output).call
+  end
+
+  def self.put(_alias: SecureRandom.hex(2), bind_address: "0.0.0.0", file:, port: 6666)
+    Zput.new(_alias: _alias, bind_address: bind_address, file: file, port: port).call
+  end
+end
+

data/lib/zget/command.rb

@@ -0,0 +1,8 @@
+module Zget
+  class Command
+    def call
+      raise NotImplementedError
+    end
+  end
+end
+

data/lib/zget/command/zget.rb

@@ -0,0 +1,53 @@
+module Zget
+  class Zget < Command
+    attr_reader :file_or_alias, :output
+
+    def initialize(file_or_alias: nil, output: nil)
+      @file_or_alias = file_or_alias
+      @output = output
+    end
+
+    def call
+      if file_or_alias.nil?
+        @file_or_alias = SecureRandom.hex 2
+        puts "Upload a file using `zput <filename> #{file_or_alias}`"
+      else
+        puts "Upload a file using `zput #{file_or_alias}` or `zput <filename> #{file_or_alias}`"
+      end
+
+      services = []
+      DNSSD.browse! "_http._tcp" do |reply|
+        services << reply
+
+        next if reply.flags.more_coming?
+
+        service = services.detect { |s| s.name == hash }
+
+        unless service.nil?
+          DNSSD.resolve! service do |r|
+            open url(r) do |f|
+              filename = output || f.meta["content-disposition"].split(";").last.split("=").last
+              File.write filename, f.read
+            end
+            break
+          end
+        end
+        break
+      end
+    end
+
+    private
+
+    def hash
+      Digest::SHA1.hexdigest File.basename(file_or_alias)
+    end
+
+    def url(reply)
+      info = Socket.getaddrinfo(reply.target, nil, Socket::AF_INET)
+      host = info[0][2]
+
+      "http://#{host}:#{reply.port}"
+    end
+  end
+end
+

data/lib/zget/command/zput.rb

@@ -0,0 +1,43 @@
+module Zget
+  class Zput < Command
+    attr_reader :alias, :bind_address, :file, :port
+
+    def initialize(_alias: SecureRandom.hex(2), bind_address: "0.0.0.0", file:, port: 6666)
+      @bind_address = IPAddr.new bind_address
+      @file = file.tap do |f|
+        raise InvalidFileError unless File.exist? f
+      end
+      @alias = _alias
+      @port = port.tap do |p|
+        raise InvalidPortError unless p.between? 0, 65535
+      end
+    end
+
+    def call
+      puts "Download this file using `zget #{File.basename file}` or `zget #{@alias}`"
+
+      hashes.each do |hash|
+        DNSSD.register hash, "_http._tcp", nil, port
+      end
+
+      server.start
+    end
+
+    private
+
+    def hashes
+      [
+        Digest::SHA1.hexdigest(File.basename(file)),
+        Digest::SHA1.hexdigest(@alias)
+      ]
+    end
+
+    def server
+      @server ||= WEBrick::HTTPServer.new(AccessLog: [], BindAddress: bind_address.to_s, Logger: WEBrick::Log.new("/dev/null"), Port: port).tap do |s|
+        s.mount "/", FileHandler, file
+        trap("INT") { s.shutdown }
+      end
+    end
+  end
+end
+

data/lib/zget/errors.rb

@@ -0,0 +1,5 @@
+module Zget
+  InvalidFileError = Class.new StandardError
+  InvalidPortError = Class.new StandardError
+end
+

data/lib/zget/file_handler.rb

@@ -0,0 +1,11 @@
+module Zget
+  # We want this server to shutdown as soon as the file is downloaded
+  class FileHandler < WEBrick::HTTPServlet::DefaultFileHandler
+    def do_GET(request, response)
+      response["Content-Disposition"] = "inline; filename=#{File.basename @local_path}"
+      super
+      @server.shutdown
+    end
+  end
+end
+

data/lib/zget/version.rb

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

data/zget.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "zget/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "zget"
+  spec.version       = Zget::VERSION
+  spec.authors       = ["Patricio Mac Adden"]
+  spec.email         = ["patriciomacadden@gmail.com"]
+
+  spec.summary       = %q{Write a short summary, because Rubygems requires one.}
+  spec.description   = %q{Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/patriciomacadden/zget"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing 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 do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  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_runtime_dependency "dnssd", "~> 3.0.1"
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: zget
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Patricio Mac Adden
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-23 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: dnssd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+description: Write a longer description or delete this line.
+email:
+- patriciomacadden@gmail.com
+executables:
+- zget
+- zput
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/zget
+- exe/zput
+- lib/zget.rb
+- lib/zget/command.rb
+- lib/zget/command/zget.rb
+- lib/zget/command/zput.rb
+- lib/zget/errors.rb
+- lib/zget/file_handler.rb
+- lib/zget/version.rb
+- zget.gemspec
+homepage: https://github.com/patriciomacadden/zget
+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: Write a short summary, because Rubygems requires one.
+test_files: []