ftpmock 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a2714d624206cbe24807a0bcc79669622477c00e6c0940c0935b339acaced40
-  data.tar.gz: 10063104b716fa5a937926b00d351897310d270d9fbe442854ff9b9e0b9af29c
+  metadata.gz: c9fcde1b94eb86b0f144b748def95e77104d92bd45a024527a3a33dd9445e5ca
+  data.tar.gz: ac31e623824872dd372e65233d9d4a1de3277a248beda3b18cba8442b5054bcd
 SHA512:
-  metadata.gz: 7ef4fe9824f4ed0f195d7d511321a6e247e37ec64a85c76082125cacb63c3815ef64393cec661714a1c703b6cd8d1163d6c614c55bedeed1f1e05f3193ef7d37
-  data.tar.gz: 8476bcb8358b326632f6fab4c634773f13b18458124625193af5dc87af1995fc242c92ef158641c264c6dbed3a6064b161b111d50993fc9417824ad83741e2ae
+  metadata.gz: e9fe1e4d12970f57eb15d7ed68d76fc278460360de769526f58f7ed2a093a0fe294a4f59cc69c7dff4596cf664a2a80537ae490e89b62fe4f8165e6e6fcc948b
+  data.tar.gz: 48d26252d595a84ab33252c223508a059397145d57a61422b47d1da45a844a191b3610bdc2feaecf16b9f2669ff5726ba69343660ae8256596d91bbcd7aacc68

data/.gitignore

@@ -9,3 +9,6 @@
 
 # rspec failure tracking
 .rspec_status
+
+# OS
+.DS_Store

data/.rubocop.yml

@@ -9,7 +9,7 @@ AllCops:
   EnabledByDefault: false
   UseCache: true
   CacheRootDirectory: ~
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.7
   Exclude:
     - 'a/*'
     - 'bin/*'
@@ -43,11 +43,69 @@ Naming:
 Style:
   Enabled: true
 
+# Undefaulted
+
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
+
 # Custom
 
-Metrics/LineLength:
+Layout/LineLength:
   Max: 80
+  Exclude:
+    - 'spec/ftpmock/proxies_net_ftp/integration_spec.rb'
 
 # If you think this should be true, reach out!
 Style/FrozenStringLiteralComment:
   Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/MethodMissingSuper:
+  Exclude:
+    - 'lib/ftpmock/proxies/method_missing_mixin.rb'
+Style/MissingRespondToMissing:
+  Exclude:
+    - 'lib/ftpmock/proxies/method_missing_mixin.rb'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Naming/ConstantName:
+  Exclude:
+    - 'lib/ftpmock/proxies/*_proxy.rb'
+
+Naming/MethodParameterName:
+  Exclude:
+    - 'spec/ftpmock/helpers/*.rb'
+
+# http://c2.com/cgi/wiki?AbcMetric, https://en.wikipedia.org/wiki/ABC_Software_Metric
+Metrics/AbcSize:
+  # Max: 15 (default)
+  Max: 20
+  Exclude:
+    - 'spec/ftpmock/helpers/*.rb'
+
+# https://rubystyle.guide#short-methods
+Metrics/MethodLength:
+  # Max: 10 (default)
+  Max: 15
+  Exclude:
+    - 'spec/ftpmock/helpers/*.rb'
+
+Metrics/ClassLength:
+  # Max: 100 (default)
+  Max: 200
+
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - 'lib/ftpmock/proxies/*_proxy.rb'

data/.travis.yml

@@ -1,7 +1,24 @@
 ---
 sudo: false
 language: ruby
-cache: bundler
+
 rvm:
-  - 2.6.3
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
+  - ruby-head
+
 before_install: gem install bundler -v 2.0.2
+
+cache:
+  - bundler
+  - apt
+
+addons:
+  code_climate:
+    repo_token: e91dbff92783b09f531028ccb33b372a03b8ee2ec0b15bf8e250359c80e06838
+
+after_success:
+  - bundle exec codeclimate-test-reporter

data/Gemfile

@@ -3,4 +3,4 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in ftpmock.gemspec
 gemspec
 
-gem 'rubocop', '0.75.0'
+gem 'rubocop', '0.80.0' # February 18, 2020

data/Gemfile.lock

@@ -2,50 +2,69 @@ PATH
   remote: .
   specs:
     ftpmock (0.1.0)
+      diffy (~> 3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.0)
+    codeclimate-test-reporter (1.0.9)
+      simplecov (<= 0.13)
     diff-lcs (1.3)
-    jaro_winkler (1.5.3)
-    parallel (1.18.0)
-    parser (2.6.5.0)
+    diffy (3.3.0)
+    docile (1.1.5)
+    jaro_winkler (1.5.4)
+    json (2.3.0)
+    net-sftp (2.1.2)
+      net-ssh (>= 2.6.5)
+    net-ssh (5.2.0)
+    parallel (1.19.1)
+    parser (2.7.0.2)
       ast (~> 2.4.0)
     rainbow (3.0.0)
     rake (10.5.0)
+    rexml (3.2.4)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
       rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.0)
-      rspec-support (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
     rspec-expectations (3.9.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-support (3.9.0)
-    rubocop (0.75.0)
+    rspec-support (3.9.2)
+    rubocop (0.80.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 2.7.0.1)
       rainbow (>= 2.2.2, < 4.0)
+      rexml
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.7)
     ruby-progressbar (1.10.1)
-    unicode-display_width (1.6.0)
+    simplecov (0.13.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    unicode-display_width (1.6.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 2.0)
+  codeclimate-test-reporter
   ftpmock!
+  net-sftp
   rake (~> 10.0)
   rspec (~> 3.0)
-  rubocop (= 0.75.0)
+  rubocop (= 0.80.0)
+  simplecov
 
 BUNDLED WITH
    2.0.2

data/README.md

@@ -1,38 +1,162 @@
 # Ftpmock
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ftpmock`. To experiment with that code, run `bin/console` for an interactive prompt.
+Test your FTP calls offline.
 
-TODO: Delete this and the text above, and describe your gem
+## Status
+
+| Is It Working? | Is It Tested? | Code Quality | **# of Downloads** |  **Get Involved!** |
+|:---|:---|:---|:---|:---|
+| [![Master Build Status](https://api.travis-ci.org/thejamespinto/ftpmock.svg?branch=master)](https://travis-ci.org/thejamespinto/ftpmock) | [![Test Coverage](https://api.codeclimate.com/v1/badges/25ac02fa4774e3fcb569/test_coverage)](https://codeclimate.com/github/thejamespinto/ftpmock/test_coverage) | [![Maintainability](https://api.codeclimate.com/v1/badges/25ac02fa4774e3fcb569/maintainability)](https://codeclimate.com/github/thejamespinto/ftpmock/maintainability) | [![Downloads](http://img.shields.io/gem/dt/ftpmock.svg)](https://rubygems.org/gems/ftpmock) | [![GitHub Issues](https://img.shields.io/github/issues/thejamespinto/ftpmock.svg)](https://github.com/thejamespinto/ftpmock/issues) |
+
+## Compatibility
+
+| <image width=16 src='./images/ruby.png'> Ruby 2.3 | <image width=16 src='./images/ruby.png'> Ruby 2.4  | <image width=16 src='./images/ruby.png'> Ruby 2.5 | <image width=16 src='./images/ruby.png'> Ruby 2.6 | <image width=16 src='./images/ruby.png'> Ruby 2.7 |
+| :--- | :--- | :--- | :--- | :--- |
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'ftpmock'
+group :test do
+  gem 'ftpmock'
+end
 ```
 
-And then execute:
+## Usage
 
-    $ bundle
+If you know your way around tests
 
-Or install it yourself as:
+```ruby
+require 'ftpmock'
+
+RSpec.configure do |config|
+  config.around(:example) do |example|
+    Ftpmock.on! do
+      example.run
+    end
+  end
+end
+```
 
-    $ gem install ftpmock
+If you need to see a full example
 
-## Usage
+```ruby
+require 'rubygems'
+require 'test/unit'
+require 'ftpmock'
+
+# Optional (default values)
+Ftpmock.configure do |c|
+  c.path = 'test/ftp_records'
+  c.verbose = true
+end
+
+class FtpmockTest < Test::Unit::TestCase
+  def test_ubuntu_mirror
+    Ftpmock.on! do
+      # Ubuntu Download - University of Pittsburgh
+      ftp = Net::FTP.new
+      assert_equal(Ftpmock::NetFtpProxy, ftp.class)
+      assert ftp.connect('mirror.cs.pitt.edu', 21)
+      assert ftp.login('', '')
+
+      t = Time.now
+      3.times do |i|
+        list = ftp.list('/ubuntu/releases')
+        assert list.size.positive?
+
+        ftp.get('/ubuntu/releases/robots.txt', 'tmp/ubuntu_robots.txt')
+        assert File.exist?('tmp/ubuntu_robots.txt')
+
+        puts "[Take #{i+1}] #{(Time.now-t).round(3)}s"
+      end
+    end
+  end
+end
+```
+
+Run this test once, and Ftpmock will record the FTP requests to __test/ftp\_records/mirror-cs-pitt-edu\_21\_\_/__
+
+Run it again, and Ftpmock will replay the responses from __mirror.cs.pitt.edu__ when the FTP request is made.
+
+Your tests are now blazing fast because no real FTP requests are made anymore.
+
+The test will continue to pass, even if you are offline, or if the University of Pittsburgh FTP servers are down for maintenance.
+
+The responses will be accurate since they will contain the same list and files you get from a real request.
 
-TODO: Write usage instructions here
+Unlike VCR, Ftpmock combines your four credentials _(address + port + username + password)_ and caches onto the exact same directory, optimizing for both storage and readability.
 
 ## 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.
+After checking out the repo, run `bin/setup` to install dependencies.
+
+Then, run `bundle exec 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`.
+
+## Documentation
+
+![Chart](./images/ftpmock.png)
+
+- Core
+    - [x] Stubber
+    - [x] Configuration
+    - [x] Cache
+    - [x] Helpers
+- Proxies
+    - [x] Proxy for Ruby's native Net::FTP library
+    - [ ] Proxy for Jamis Buck's gem 'net-sftp'
+
+### Core instantiable classes & procedural modules
+
+links: [lib/ftpmock/core](./lib/ftpmock/core)
+
+- [x] stubber for proxies
+- [x] configuration class
+- [x] cache class
+- [x] cache path helper
+- [x] cache list helper
+- [x] cache get helper
+- [x] cache put helper
+
+### Proxy for Ruby's native Net::FTP library (Ftpmock::NetFtpProxy)
+
+links: [lib/ftpmock/proxies/net_ftp_proxy.rb](./lib/ftpmock/proxies/net_ftp_proxy.rb) , https://apidock.com/ruby/Net/FTP & https://github.com/ruby/ruby/tree/master/lib/net
+
+- [x] proxy class
+- [x] stubbers
+- [x] address & port forwarding
+- [x] username & password forwarding
+- [x] chdir forwarding
+- [x] pwd
+- [x] list
+- [x] get
+- [x] put
+- [ ] ssl support
+- [x] unit tests
+- [x] integration tests
+
+### Proxy for Jamis Buck's gem 'net-sftp' (Ftpmock::NetSftpProxy)
+
+links: [lib/ftpmock/proxies/net_sftp_proxy.rb](./lib/ftpmock/proxies/net_sftp_proxy.rb) , https://rubygems.org/gems/net-sftp & https://github.com/net-ssh/net-sftp
 
-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).
+- [x] proxy class
+- [x] stubbers
+- [ ] address & port forwarding
+- [ ] username & password forwarding
+- [ ] list
+- [ ] get
+- [ ] put
+- [ ] unit tests
+- [ ] integration tests
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ftpmock.
+Bug reports and pull requests are welcome on GitHub at https://github.com/thejamespinto/ftpmock.
 
 ## License
 

data/ftpmock.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ['James Pinto']
   spec.email         = ['thejamespinto@gmail.com']
 
-  spec.summary       = 'Record and Replay FTP requests in Ruby tests.'
+  spec.summary       = 'Test your FTP calls offline.'
   spec.description   = 'Just like VCR and WebMock, but for FTP.'
   spec.homepage      = 'https://github.com/thejamespinto/ftpmock'
   spec.license       = 'MIT'
@@ -31,6 +31,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'codeclimate-test-reporter'
+  spec.add_development_dependency 'net-sftp'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov'
+
+  spec.add_dependency 'diffy', '~> 3.0'
 end

data/lib/ftpmock.rb

@@ -1,6 +1,24 @@
+require 'pathname'
 require 'ftpmock/version'
 
+Dir['lib/ftpmock/{utils,core,helpers,proxies}/*.rb'].each do |f|
+  load f
+end
+
 module Ftpmock
   class Error < StandardError; end
-  # Your code goes here...
+  class GetNotFetched < StandardError; end
+  class PutFileNotFound < Error; end
+  class PutLocalDiffersFromCache < Error; end
+
+  def self.on!(&block)
+    NetFtpProxy.on! do
+      NetSftpProxy.on!(&block)
+    end
+  end
+
+  def self.off!
+    NetFtpProxy.off!
+    NetSftpProxy.off!
+  end
 end

data/lib/ftpmock/core/cache.rb

@@ -0,0 +1,186 @@
+module Ftpmock
+  class Cache
+    attr_reader :credentials, :configuration
+
+    def initialize(configuration, credentials)
+      @configuration = configuration
+      @credentials = credentials
+      @chdir = nil
+    end
+
+    def path
+      @path ||= Pathname("#{configuration.path}/#{path_dir}")
+    end
+
+    def path_dir
+      StringUtils.parameterize(credentials.map(&:to_s).join('_'))
+    end
+
+    def _alert(tag, content, color = :green)
+      configuration.verbose && VerboseUtils.alert(tag, content, color)
+    end
+
+    def chdir(dirname = nil)
+      return @chdir if dirname.nil?
+
+      original = @chdir
+      @chdir = PathHelper.join(@chdir, dirname)
+
+      _chdir_alert(dirname, original, @chdir)
+      @chdir
+    end
+
+    def _chdir_alert(dirname, old_chdir, new_chdir)
+      tag = "ftpmock.cache.chdir '#{dirname}'"
+
+      _alert tag, "changed from '#{old_chdir}' to '#{new_chdir}'", :green
+    end
+
+    def list(*args)
+      key = args.join(',')
+      tag = _list_tag_for(key)
+
+      list = ListHelper.read(path, chdir, key)
+      _list_alert_hit(tag, list)
+      return list if list
+
+      _list_alert_miss(tag)
+      list = yield
+
+      _list_alert_storing(tag, list)
+      ListHelper.write(path, chdir, key, list)
+
+      list
+    end
+
+    def _list_tag_for(key)
+      tag = "ftpmock.cache.list '#{key}'"
+      tag += ", chdir: '#{chdir}'" if chdir
+      tag
+    end
+
+    def _list_alert_hit(tag, list)
+      list.nil? || _alert(tag, "hit! (#{list.size} lines)")
+    end
+
+    def _list_alert_miss(tag)
+      _alert tag, 'miss!', :yellow
+    end
+
+    def _list_alert_storing(tag, list)
+      _alert tag, "storing #{list.size} lines!"
+    end
+
+    def get(remotefile, localfile = File.basename(remotefile))
+      tag = _get_tag_for(remotefile)
+
+      if GetHelper.read(path, chdir, remotefile, localfile)
+        _get_alert_hit(tag, localfile)
+        return
+      end
+
+      _get_alert_miss(tag)
+      yield
+
+      if GetHelper.fetched?(localfile)
+        _get_alert_storing(tag, localfile)
+        GetHelper.write(path, chdir, remotefile, localfile)
+      else
+        _get_raise_localfile_not_fetched(remotefile, localfile)
+      end
+    end
+
+    def _get_tag_for(remotefile)
+      tag = "ftpmock.cache.get '#{remotefile}'"
+      tag += ", chdir: '#{chdir}'" if chdir
+      tag
+    end
+
+    def _get_alert_hit(tag, localfile)
+      _alert tag, "hit! (#{localfile})"
+    end
+
+    def _get_alert_miss(tag)
+      _alert tag, 'miss!', :yellow
+    end
+
+    def _get_alert_storing(tag, localfile)
+      _alert tag, "storing #{localfile}"
+    end
+
+    def _get_raise_localfile_not_fetched(remotefile, localfile)
+      msg = "FTP GET '#{remotefile}' should have created '#{localfile}'"
+      msg = "#{msg}, but didn't."
+      raise GetNotFetched, msg
+    end
+
+    def put(localfile, remotefile = File.basename(localfile))
+      tag = _put_tag_for(localfile)
+
+      _put_alert_exists(tag)
+      PutHelper.exist?(localfile) || _put_raise_not_found(remotefile, localfile)
+
+      if PutHelper.cached?(path, remotefile)
+        _put_cached(tag, path, localfile, remotefile)
+      else
+        _put_alert_miss(tag)
+        yield
+
+        _put_alert_storing(tag, remotefile)
+        PutHelper.write(path, localfile, remotefile)
+      end
+
+      true
+    end
+
+    def _put_tag_for(localfile)
+      tag = "ftpmock.cache.put '#{localfile}'"
+      tag += ", chdir: '#{chdir}'" if chdir
+      tag
+    end
+
+    def _put_alert_exists(tag)
+      _alert tag, 'file exists?'
+    end
+
+    def _put_alert_miss(tag)
+      _alert tag, 'miss!', :yellow
+    end
+
+    def _put_alert_storing(tag, remotefile)
+      _alert tag, "storing #{remotefile}"
+    end
+
+    def _put_cached(tag, path, localfile, remotefile)
+      diff = PutHelper.compare(path, localfile, remotefile)
+
+      _put_alert_hit(tag, diff.size)
+
+      diff.any? && _put_raise_localfile_differs(remotefile, localfile, diff)
+    end
+
+    def _put_alert_hit(tag, size)
+      color = size.zero? ? :green : :red
+      _alert tag, "hit! (#{size} differing lines)", color
+    end
+
+    def _put_raise_not_found(remotefile, localfile)
+      msg = "FTP PUT '#{remotefile}' has failed"
+      msg = "#{msg} because '#{localfile}' does not exist."
+      raise PutFileNotFound, msg
+    end
+
+    def _put_raise_localfile_differs(remotefile, localfile, diff)
+      spaces = ' ' * 20
+      VerboseUtils.puts
+      VerboseUtils.puts ColorUtils.highlight "#{spaces}Diffy Begin#{spaces}"
+      VerboseUtils.puts diff
+      VerboseUtils.puts ColorUtils.highlight "#{spaces} Diffy End #{spaces}"
+      VerboseUtils.puts
+
+      msg = "FTP PUT '#{remotefile}' has failed because"
+      msg = "#{msg} '#{localfile}' contents don't match #{path}/#{remotefile}"
+      raise PutLocalDiffersFromCache, msg
+    end
+  end
+end