quickftp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 33254c2a2c5a1c46aab779afcb1b73a911011d26
+  data.tar.gz: 28b180b3abb9134bdf9167c50cea02d357a286dc
+SHA512:
+  metadata.gz: f79def306f5c690a8f5c682856cbe6f4fe5b0767aabe68635b49e1abde7b5038af42c17b9a1c9e0cc689f7b7a671c07b9e60e3c474c168042eeb6bf44e4c38ce
+  data.tar.gz: 1d68fffa34eebf9cf0a5f3249ca6d6ddbf2f1d85c99283d6a360bf2b4494bbd4b293b41488a54ed5249b2263147ca23563f56c0f635ba8367383020e830055ba

data/.gitignore

@@ -0,0 +1,5 @@
+.rvmrc
+.env
+.ruby-version
+.rbenv-gemsets
+*.gem

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,25 @@
+PATH
+  remote: .
+  specs:
+    quickftp (0.0.1)
+      ftpd (~> 1.1, >= 1.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ftpd (1.1.1)
+      memoizer (~> 1.0)
+    memoizer (1.0.1)
+    minitest (5.8.3)
+    rake (10.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest (~> 5.8, >= 5.8.3)
+  quickftp!
+  rake (~> 10.4, >= 10.4.2)
+
+BUNDLED WITH
+   1.10.6

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Alfonso Cora
+
+MIT License
+
+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,38 @@
+# Quickftp
+
+Quickftp is a command line application that allows to quickly start an ftp server without worrying about configuration. This makes it a handy tool to transfer files easily.
+Although the server is stable, it's not intended to be used for public servers. This gem is based on the [ftpd gem by Wayne Conrad](https://github.com/wconrad/ftpd/), so you can find more information about reliability and the protocol internals in the gem documentation.
+
+## Installation
+
+```bash
+gem install quickftp
+```
+
+## Usage
+
+To simply start the server at any available port serving the files from the current directory, run:
+
+```bash
+quickftp
+```
+
+## Options
+
+- -h HOST: The interface where the server should start. When not specified, the server will start on localhost.
+- -p PORT: The port where the server should start. When not specified, a random available port will be chosen.
+
+### Examples
+
+```bash
+# start the server in localhost, under port 3002 and files from the current directory:
+quickftp -p 3002
+
+# start the server in 192.168.1.1:9000 and serve files from /tmp/dir:
+quickftp /tmp/dir -h 192.168.1.1 -p 9000
+```
+
+## Contributions and credits
+
+- This project is based on the [ftpd gem by Wayne Conrad](https://github.com/wconrad/ftpd/).
+- If you want to contribute to this project, just fork it and create a pull request. Also, feel free to report issues on the [issues section](issues).

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/test*.rb']
+end
+
+task :default => [:test]

data/bin/quickftp

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+
+require 'ftpd'
+require 'quickftp'
+require 'pathname'
+require 'logger'
+
+trap('SIGINT') { throw :ctrl_c }
+
+def get_argv(option)
+  value = nil
+  if option_index = ARGV.index(option)
+    value = ARGV[option_index + 1]
+    ARGV.slice!(option_index..option_index+1)
+  end
+  value
+end
+
+host = get_argv('-h')
+port = get_argv('-p').to_i
+
+if ARGV.any? {|f| f == '--help'}
+  # help mode
+  puts 'Usage:'
+  puts '  quickftp [path/to/directory] [-h HOST] [-p PORT]'
+else
+  path = ARGV.first || '.'
+  path = Pathname.new(path).realpath.to_s
+
+  driver = Quickftp::Driver.new(path)
+  server = Ftpd::FtpServer.new(driver)
+  server.server_name = "Quickftp"
+  server.server_version = Quickftp::VERSION
+  server.log = Logger.new(STDOUT)
+  server.interface = host if host
+  server.port = port if port
+  server.start
+
+  puts "#{server.server_name} #{server.server_version}"
+  puts "Server listening on #{server.interface}:#{server.bound_port}"
+  puts "Serving all files under '#{path}'"
+  puts "Press Ctrl+C to stop"
+  begin
+    sleep
+  rescue Exception
+  end
+end

data/lib/quickftp.rb

@@ -0,0 +1,2 @@
+require 'quickftp/version'
+require 'quickftp/driver'

data/lib/quickftp/driver.rb

@@ -0,0 +1,15 @@
+module Quickftp
+  class Driver
+    def initialize(dir)
+      @dir = dir
+    end
+
+    def authenticate(user, password)
+      true
+    end
+
+    def file_system(user)
+      Ftpd::DiskFileSystem.new(@dir)
+    end
+  end
+end

data/lib/quickftp/version.rb

@@ -0,0 +1,3 @@
+module Quickftp
+  VERSION = '0.1.0'
+end

data/license.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Alfonso Cora
+
+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/quickftp.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'quickftp/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'quickftp'
+  gem.version       = Quickftp::VERSION
+  gem.authors       = ['Alf Cora']
+  gem.email         = ['alfius@protonmail.com']
+  gem.description   = %q{Quickftp is an in-place ftp server}
+  gem.summary       = %q{Quickftp is a command line application that allows to quickly start an ftp server without worrying about configuration. This makes it a handy tool to transfer files easily. It's not intended to be used in public servers.}
+  gem.homepage      = 'https://github.com/alfonsocora/quickftp'
+  gem.license       = 'MIT'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency 'ftpd', '~> 1.1', '>= 1.1.1'
+  gem.add_development_dependency 'minitest', '~> 5.8', '>= 5.8.3'
+  gem.add_development_dependency 'rake', '~> 10.4', '>= 10.4.2'
+end

data/test/lib/quickftp/test_driver.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class TestDriver < Minitest::Test
+  def test_authenticates_all_users
+    driver = Quickftp::Driver.new('.')
+    assert driver.authenticate('someone', 'super secret password')
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'quickftp'

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: quickftp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alf Cora
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ftpd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.8.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+description: Quickftp is an in-place ftp server
+email:
+- alfius@protonmail.com
+executables:
+- quickftp
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/quickftp
+- lib/quickftp.rb
+- lib/quickftp/driver.rb
+- lib/quickftp/version.rb
+- license.txt
+- quickftp.gemspec
+- test/lib/quickftp/test_driver.rb
+- test/test_helper.rb
+homepage: https://github.com/alfonsocora/quickftp
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Quickftp is a command line application that allows to quickly start an ftp
+  server without worrying about configuration. This makes it a handy tool to transfer
+  files easily. It's not intended to be used in public servers.
+test_files:
+- test/lib/quickftp/test_driver.rb
+- test/test_helper.rb