fake_ftp 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 16d22a49aeec88b087647080ff78af2cba62258f
-  data.tar.gz: 1fc101ff74542713e759abd3f7e96a223c7ed4ec
+  metadata.gz: 7a8165d49d247b14c5a9c6dddde8ebf348b54a97
+  data.tar.gz: f57a69068555bf2911e54008695a7a72b1d51baf
 SHA512:
-  metadata.gz: a00eb184ceb029f516e92d8d0b01438156565f5ec9fd09ee3746b4755440f25d64d2dbe47533f00a88d2fec3f6b870d4cb67c3703a2a6111e2b030df98646d84
-  data.tar.gz: a27f8e3aa33522b31b04fc6cd1cf2cba529f5fba9f8b516e8c916741a7b82e71993f658b4d994feb6db8707d0883a8635a5903d02cf357fcae3d6aa0404b8fe7
+  metadata.gz: 357a8a7b06d3c6eb7ece24592724e30357859299ca3718cd42a54e90da48b69b95f320010d7c773527fc0dd1dc402ce14a0ca58d97c3fd35f80f0c81e4f44e13
+  data.tar.gz: e539dfca9312bd701c72e0e71ae6e3b6a08e7bf6abcaab69da55047c1cbf86f6db5c768c44f68fc9600d34913643d670524afa8ecfc409e0d9c74e39030600be

data/.codeclimate.yml

@@ -0,0 +1,16 @@
+---
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: false
+ratings:
+  paths:
+  - "**.rb"
+exclude_paths:
+- spec/

data/.gitignore

@@ -6,3 +6,4 @@ pkg/*
 .rbenv-version
 .rbenv-gemsets
 /Gemfile.lock
+/coverage/

data/.rspec

@@ -1,2 +1,4 @@
 --color
 --format documentation
+--order rand
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,27 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  TargetRubyVersion: '2.4'
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 40
+
+Metrics/CyclomaticComplexity:
+  Max: 15
+
+Metrics/MethodLength:
+  Max: 45
+
+Metrics/PerceivedComplexity:
+  Max: 15
+
+Metrics/BlockLength:
+  Exclude:
+  - 'spec/**/*'
+  Max: 40
+
+Metrics/ClassLength:
+  Max: 200

data/.rubocop_todo.yml

@@ -0,0 +1,7 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2017-08-01 12:55:33 -0400 using RuboCop version 0.49.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.

data/.simplecov

@@ -0,0 +1,6 @@
+if ENV['COVERAGE'] == '1'
+  SimpleCov.start do
+    add_filter '/spec/'
+    minimum_coverage 90
+  end
+end

data/.travis.yml

@@ -1,8 +1,33 @@
 language: ruby
 sudo: false
 dist: trusty
-cache: bundler
+cache:
+  bundler: true
+  directories:
+  - ~/.local/bin
 rvm:
 - 2.4.1
 - 2.3.4
-- 2.2.7
+env:
+  matrix:
+  - COVERAGE=0 FUNCTIONAL_SPECS=0 INTEGRATION_SPECS=0
+  - COVERAGE=1 FUNCTIONAL_SPECS=1 INTEGRATION_SPECS=1
+  global:
+  - PATH="$HOME/.local/bin:$PATH"
+before_install:
+- if ! cc-test-reporter --version; then
+    mkdir -p ~/.local/bin;
+    curl -sSL
+         -o ~/.local/bin/cc-test-reporter
+         https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64;
+    chmod +x ~/.local/bin/cc-test-reporter;
+  fi
+- cc-test-reporter before-build
+after_script:
+- if [[ "${TRAVIS_PULL_REQUEST}" == "false" &&
+        "${COVERAGE}" == "1" &&
+        "${FUNCTIONAL_SPECS}" == "1" &&
+        "${INTEGRATION_SPECS}" == "1" &&
+        "${TRAVIS_RUBY_VERSION}" == "2.4.1" ]]; then
+    cc-test-reporter after-build --exit-code "${TRAVIS_TEST_RESULT}";
+  fi

data/CHANGELOG.md

@@ -0,0 +1,136 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+### Changed
+
+### Deprecated
+
+### Removed
+
+### Fixed
+
+### Security
+
+## [0.3.0] - 2017-08-01
+### Added
+- integration with Code Climate + simplecov
+- RuboCop with auto-fixes
+- this changelog
+- server: more debugging
+
+### Changed
+- server:
+  - command dispatch via class
+  - store files as a set
+
+### Removed
+- tests: running against ruby 2.2.7
+
+## [0.2.0] - 2017-07-26
+### Added
+- server: `size` command implementation
+
+### Changed
+- tests: updated ruby versions tested via Travis CI
+
+## [0.1.1] - 2014-04-17
+### Added
+- documentation: more, plus a contributors doc
+
+### Changed
+- server:
+  - fail to initialize if control or passive ports are invalid
+  - reset port from initial server address
+
+## [0.1.0] - 2013-09-30
+### Added
+- tests: integration with Travis CI
+- documentation: GitHub-flavored markdown changes
+- file: `last_modified_time`
+- server:
+  - wildcard support in `list` command
+  - `mdtm` command implementation
+  - `rnfr` command implementation
+  - `rnto` command implementation
+  - `dele` command implementation
+  - `mkd` command implementation
+
+### Changed
+- server: real implementation of `cwd` command
+
+## [0.0.9] - 2011-11-21
+### Changed
+- server: initial respond code `220`
+
+## [0.0.8] - 2011-11-21
+### Changed
+- server: detect running state via `TCPSocket` instead of `lsof`
+
+## [0.0.7] - 2011-10-07
+### Added
+- server: `reset` command to clear stored files
+
+## [0.0.6] - 2011-06-12
+### Changed
+- server: pass args to commands via splat
+
+## [0.0.5] - 2011-05-12
+### Added
+- file: accessors for data and created fields
+- server:
+  - `add_file` method for direct file addition
+  - `retr` command implementation
+  - `list` command implementation
+  - `nlst` command implementation
+
+## [0.0.4] - 2011-03-06
+### Added
+- docs: show how to test active upload
+
+### Changed
+- file: accept active/passive type at initialization
+
+## [0.0.3] - 2011-03-06
+### Added
+- server:
+  - initial active mode implementation
+  - `port` command
+
+### Changed
+- server:
+  - `stor` behavior depending on active/passive mode
+
+## [0.0.2] - 2011-03-05
+### Added
+- file: initial implementation for in-memory store
+- server:
+  - `#files` method for fetching all stored file names
+  - `#file` method for fetching rich file object by name
+
+### Changed
+- server: use in-memory store instead of local scratch directory
+
+## 0.0.1 - 2011-02-28
+
+### Added
+- initial release with basic usage and docs
+
+[Unreleased]: https://github.com/livinginthepast/fake_ftp/compare/v0.2.0...HEAD
+[0.2.0]: https://github.com/livinginthepast/fake_ftp/compare/v0.1.1...v0.2.0
+[0.1.1]: https://github.com/livinginthepast/fake_ftp/compare/v0.1.0...v0.1.1
+[0.1.0]: https://github.com/livinginthepast/fake_ftp/compare/v0.0.9...v0.1.0
+[0.0.9]: https://github.com/livinginthepast/fake_ftp/compare/v0.0.8...v0.0.9
+[0.0.8]: https://github.com/livinginthepast/fake_ftp/compare/v0.0.7...v0.0.8
+[0.0.7]: https://github.com/livinginthepast/fake_ftp/compare/v0.0.6...v0.0.7
+[0.0.6]: https://github.com/livinginthepast/fake_ftp/compare/v0.0.5...v0.0.6
+[0.0.5]: https://github.com/livinginthepast/fake_ftp/compare/v0.0.4...v0.0.5
+[0.0.4]: https://github.com/livinginthepast/fake_ftp/compare/v0.0.3...v0.0.4
+[0.0.3]: https://github.com/livinginthepast/fake_ftp/compare/v0.0.2...v0.0.3
+[0.0.2]: https://github.com/livinginthepast/fake_ftp/compare/v0.0.1...v0.0.2

data/Gemfile

@@ -1,12 +1,14 @@
-source "http://rubygems.org"
+# frozen_string_literal: true
+
+source 'http://rubygems.org'
 
-# Specify your gem's dependencies in fake_ftp.gemspec
 gemspec
 
 group :test do
-  gem "rspec", '~> 2.14.0'
-  gem "rake", '~> 0.9.2.2'
-
-  gem "guard-rspec", '~> 0.6.0'
-  gem 'pry-nav', '~> 0.2.3'
+  gem 'guard-rspec', '~> 4.7.3'
+  gem 'pry-nav', '~> 0.2.4'
+  gem 'rake', '~> 12.0.0'
+  gem 'rspec', '~> 3.6.0'
+  gem 'rubocop', '~> 0.49.1'
+  gem 'simplecov', '~> 0.14.1', require: false
 end

data/Guardfile

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 # A sample Guardfile
 # More info at https://github.com/guard/guard#readme
 
-guard 'rspec', :version => 2 do
+guard 'rspec', version: 2 do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { "spec" }
-  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('spec/spec_helper.rb')  { 'spec' }
+  watch(%r{^spec/support/(.+)\.rb$}) { 'spec' }
 end
-

data/LICENSE.md

@@ -0,0 +1,20 @@
+The MIT License
+
+Copyright (c) 2017 Eric Saxby
+
+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

@@ -1,25 +1,21 @@
-FakeFtp
-=======
+# FakeFtp
 
-[![Build status](https://secure.travis-ci.org/livinginthepast/fake_ftp.svg)](http://travis-ci.org/livinginthepast/fake_ftp)
-
-This is a gem that allows you to test FTP implementations in ruby. It is 
-a minimal single-client FTP server that can be bound to any arbitrary 
-port on localhost.
+[![Build status](https://api.travis-ci.org/livinginthepast/fake_ftp.svg?branch=master)](http://travis-ci.org/livinginthepast/fake_ftp)
 
+This is a gem that allows you to test FTP implementations in ruby. It is a
+minimal single-client FTP server that can be bound to any arbitrary port on
+localhost.
 
 ## Why?
 
-We want to ensure that our code works, in a way that is agnostic to the 
+We want to ensure that our code works, in a way that is agnostic to the
 implementation used (unlike with stubs or mocks).
 
-
 ## How
 
-FakeFtp is a simple FTP server that fakes out enough of the protocol to 
-get us by, allowing us to test that files get to their intended destination 
-rather than testing how our code does so.
-
+FakeFtp is a simple FTP server that fakes out enough of the protocol to get us
+by, allowing us to test that files get to their intended destination rather than
+testing how our code does so.
 
 ## Usage
 
@@ -40,10 +36,10 @@ ftp.passive = true
 ftp.put('some_file.txt')
 ftp.close
 
-server.files.should include('some_file.txt')
-server.file('some_file.txt').bytes.should == 25
-server.file('some_file.txt').should be_passive
-server.file('some_file.txt').should_not be_active
+expect(server.files).to include('some_file.txt')
+expect(server.file('some_file.txt').bytes).to eq 25
+expect(server.file('some_file.txt')).to be_passive
+expect(server.file('some_file.txt')).not_not be_active
 
 server.stop
 ```
@@ -62,73 +58,44 @@ ftp.passive = false
 ftp.put('some_file.txt')
 ftp.close
 
-server.files.should include('some_file.txt')
-server.file('some_file.txt').bytes.should == 25
-server.file('some_file.txt').should be_active
-server.file('some_file.txt').should_not be_passive
+expect(server.files).to include('some_file.txt')
+expect(server.file('some_file.txt').bytes).to eq 25
+expect(server.file('some_file.txt')).to be_active
+expect(server.file('some_file.txt')).to_not be_passive
 
 server.stop
 ```
 
 Note that many FTP clients default to active, unless specified otherwise.
 
-
 ## Caveats
 
-This is *not* a real FTP server and should not be treated as one. The goal 
-of this gem is not to create a thread-safe multi-client implementation.
-It is best used to unit test models that generate files and transfer
-them to an FTP server.
+This is *not* a real FTP server and should not be treated as one. The goal of
+this gem is not to create a thread-safe multi-client implementation.  It is best
+used to unit test code that generates files and transfers them to an FTP server.
 
 As such, there are some things that won't be accepted upstream from pull
 requests:
 * simultaneous multi-client code
-* support for long term file persistence
+* persistence support
 * binding to arbitrary IPs
 * global state beyond that required to pass the minimum required to
   generate passing tests
 
-
 ## Recommendations for testing patterns
 
-*Separate configuration from code.* Do not hard code the IP address,
-FQDN or port of an FTP server in your classes. It introduces fragility
-into your tests. Also, the default FTP port of 21 is a privileged port,
-and should be avoided.
-
-*Separate the code that generates files from the code that uploads
-files.* You tests will run much more quickly if you only try to upload
-small files. If you have tests showing that you generate correct files
-from your data, then you can trust that. Why do you need to upload a 20M
-file in your tests if you can stub out your file generation method and
-test file upload against 10 bytes? Fast fast fast.
+*Separate configuration from code.* Do not hard code the IP address, FQDN or
+port of an FTP server in your code. It introduces fragility into your tests.
+Also, the default FTP port of 21 is a privileged port, and should be avoided.
 
+*Separate the code that generates files from the code that uploads files.* You
+tests will run much more quickly if you only try to upload small files. If you
+have tests showing that you generate correct files from your data, then you can
+trust that. Why do you need to upload a 20M file in your tests if you can stub
+out your file generation method and test file upload against 10 bytes? Fast fast
+fast.
 
 ## References
 
 * http://rubyforge.org/projects/ftpd/ - a simple ftp daemon written by Chris Wanstrath
 * http://ruby-doc.org/stdlib/libdoc/gserver/rdoc/index.html - a generic server in the Ruby standard library, by John W Small
-
-## License
-
-The MIT License
-
-Copyright (c) 2011 Eric Saxby
-
-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.