ftpmvc-async-upload 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 67f72c4e49af56f61d4bf71c97776904e4220801
+  data.tar.gz: 354e84173f1e31d17eb36641e07cd7f28b660271
+SHA512:
+  metadata.gz: d65edcad83ec46b51962d48f27ffd3c87136caee2a35b2efb280fb1fa85d722008a5f72849cbcf67acee7286be292435dc4b03a5bb4ed5af164d1c79edc246e9
+  data.tar.gz: 9ebcbe7b2c75a0f92fb7a7f5d8eb876aa48f65dccf26c2b74a006dac2e40fdbe33d8063aa557209cb720f95fe428444f4698c159ca23b64875c2297bba6b301e

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,77 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec feature)
+
+## Uncomment to clear the screen before every task
+# clearing :on
+
+## Guard internally checks for changes in the Guardfile and exits.
+## If you want Guard to automatically start up again, run guard in a
+## shell loop, e.g.:
+##
+##  $ while bundle exec guard; do echo "Restarting Guard..."; done
+##
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), the you will want to move the Guardfile
+## to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w(erb haml slim))
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.("routing/#{m[1]}_routing"),
+      rspec.spec.("controllers/#{m[1]}_controller"),
+      rspec.spec.("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 André Aizim Kelmanson
+
+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,31 @@
+# Ftpmvc::Async::Upload
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ftpmvc-async-upload'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ftpmvc-async-upload
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/ftpmvc-async-upload/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/ftpmvc-async-upload.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ftpmvc/async/upload/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ftpmvc-async-upload"
+  spec.version       = Ftpmvc::Async::Upload::VERSION
+  spec.authors       = ["André Aizim Kelmanson"]
+  spec.email         = ["akelmanson@gmail.com"]
+  spec.summary       = %q{FTPMVC asynchronous upload using resque}
+  spec.description   = %q{FTPMVC asynchronous upload using resque}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "vfs"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "resque_spec"
+  spec.add_dependency "ftpmvc", ">= 0.9.0"
+  spec.add_dependency "resque"
+  spec.add_dependency "app"
+end

data/lib/ftpmvc/async/upload.rb

@@ -0,0 +1,16 @@
+require 'vfs'
+require 'ftpmvc/async/upload/version'
+require 'ftpmvc/async/upload/config'
+require 'ftpmvc/async/upload/job'
+require 'ftpmvc/async/upload/default_job'
+require 'ftpmvc/filter/async_upload'
+
+module FTPMVC
+  module Async
+    module Upload
+      def self.storage
+        FTPMVC::Async::Upload.config.dir.to_dir
+      end
+    end
+  end
+end

data/lib/ftpmvc/async/upload/config.rb

@@ -0,0 +1,22 @@
+require 'tmpdir'
+require 'app'
+
+module FTPMVC
+  module Async
+    module Upload
+      class Config < Configurable
+        config.dir = Dir.tmpdir
+        config.job = nil
+      end
+
+      def self.configure(&block)
+        config.configure(&block)
+      end
+
+      def self.config
+        Config
+      end
+
+    end
+  end
+end

data/lib/ftpmvc/async/upload/default_job.rb

@@ -0,0 +1,22 @@
+require 'ftpmvc/async/upload/job'
+require 'ftpmvc/async/upload/config'
+
+module FTPMVC
+  module Async
+    module Upload
+      class DefaultJob
+        @queue = :ftpmvc
+        
+        extend Job
+
+        def self.perform(path, id)
+          FTPMVC::Async::Upload.config.application.put(path, input(id))
+        end
+      end
+    end
+  end
+end
+
+FTPMVC::Async::Upload.configure do
+  config.job = config.job || FTPMVC::Async::Upload::DefaultJob
+end

data/lib/ftpmvc/async/upload/input.rb

@@ -0,0 +1,21 @@
+require 'ftpmvc/async/upload'
+require 'ftpmvc/input'
+
+module FTPMVC
+  module Async
+    module Upload
+      class Input
+
+        include FTPMVC::Input
+
+        def initialize(id)
+          @file = FTPMVC::Async::Upload.storage[id]
+        end
+
+        def read
+          @file.read { |chunk| yield chunk }
+        end
+      end
+    end
+  end
+end

data/lib/ftpmvc/async/upload/job.rb

@@ -0,0 +1,20 @@
+require 'ftpmvc/async/upload'
+require 'ftpmvc/async/upload/input'
+
+module FTPMVC
+  module Async
+    module Upload
+      module Job
+        def after_perform_delete_uploaded_file(path, id)
+          FTPMVC::Async::Upload.storage[id].delete
+        end
+
+        protected
+
+        def input(id)
+          FTPMVC::Async::Upload::Input.new(id)
+        end
+      end
+    end
+  end
+end

data/lib/ftpmvc/async/upload/version.rb

@@ -0,0 +1,7 @@
+module Ftpmvc
+  module Async
+    module Upload
+      VERSION = "0.0.1"
+    end
+  end
+end

data/lib/ftpmvc/filter/async_upload.rb

@@ -0,0 +1,26 @@
+require 'ftpmvc/async/upload'
+require 'ftpmvc/filter/base'
+require 'vfs'
+require 'resque'
+
+module FTPMVC
+  module Filter
+    class AsyncUpload < FTPMVC::Filter::Base
+      def put(path, input)
+        return super if input.kind_of?(FTPMVC::Async::Upload::Input)
+        SecureRandom.uuid.tap do |id|
+          file(id).write do |out|
+            input.read { |chunk| out.write(chunk) }
+          end
+          Resque.enqueue(FTPMVC::Async::Upload.config.job, path, id)
+        end
+      end
+
+      protected
+
+      def file(id)
+        FTPMVC::Async::Upload.storage[id]
+      end
+    end
+  end
+end

data/spec/integration/async_upload_spec.rb

@@ -0,0 +1,77 @@
+require 'ftpmvc'
+require 'ftpmvc/async/upload'
+require 'ftpmvc/test_helpers'
+require 'resque_spec'
+
+describe 'Async Upload' do
+  include FTPMVC::TestHelpers
+  before do
+    ResqueSpec.reset!
+  end
+  let(:etc_dir_class) do
+    Class.new(FTPMVC::Directory) do
+      attr_reader :received
+      def put(path, input)
+        @received = [path, input.read_all]
+      end
+    end
+  end
+  let(:etc_dir) { etc_dir_class.new(name: 'etc') }
+  let(:app) do
+    dir = etc_dir
+    FTPMVC::Application.new do
+      filter :async_upload
+
+      filesystem do
+        directory dir
+      end
+    end
+  end
+  before do
+    application = app
+    FTPMVC::Async::Upload.configure do
+      config.application = application
+    end
+  end
+  it 'delegates the put command to the job' do
+    with_resque do
+      with_application(app) do |ftp|
+        ftp.login
+        put(ftp, '/etc/hosts', '127.0.0.1 localhost')
+        expect(etc_dir.received).to eq ['hosts', "127.0.0.1 localhost\n"]
+      end
+    end
+  end
+  context 'when job is custom' do
+    let(:my_job_class) do
+      Class.new do
+        extend FTPMVC::Async::Upload::Job
+
+        @queue = :ftpmvc
+
+        def self.perform(path, id)
+          @result = input(id).read_all
+        end
+
+        def self.result
+          @result
+        end
+      end
+    end
+    before do
+      stub_const 'MyJob', my_job_class
+      FTPMVC::Async::Upload.configure do
+        config.job = MyJob
+      end
+    end
+    it 'uses that job' do
+      with_resque do
+        with_application(app) do |ftp|
+          ftp.login
+          put(ftp, '/etc/hosts', '127.0.0.1 localhost')
+          expect(MyJob.result).to eq "127.0.0.1 localhost\n"
+        end
+      end
+    end
+  end
+end

data/spec/lib/ftpmvc/async/upload/default_job_spec.rb

@@ -0,0 +1,42 @@
+require 'ftpmvc/async/upload/default_job'
+require 'ftpmvc/async/upload/config'
+require 'ftpmvc/application'
+require 'tmpdir'
+
+describe FTPMVC::Async::Upload::DefaultJob do
+  let(:etc_dir_class) do
+    Class.new(FTPMVC::Directory) do
+      attr_reader :received
+      def put(path, input)
+        @received = [path, input.read_all]
+      end
+    end
+  end
+  let(:etc_dir) { etc_dir_class.new(name: 'etc') }
+  let(:application) do
+    dir = etc_dir
+    FTPMVC::Application.new do
+      filesystem do
+        directory dir
+      end
+    end
+  end
+  around do |example|
+    Dir.mktmpdir do |dir|
+      app = application
+      FTPMVC::Async::Upload.configure do
+        config.application = app
+        config.dir = dir
+      end
+      File.open(File.join(dir, '123456'), 'w') { |f| f.write '127.0.0.1 localhost' }
+      example.run
+    end
+  end
+  describe '.perform' do
+    it 'calls Application#put' do
+
+      FTPMVC::Async::Upload::DefaultJob.perform('/etc/hosts', '123456')
+      expect(etc_dir.received).to eq ['hosts', '127.0.0.1 localhost']
+    end
+  end
+end

data/spec/lib/ftpmvc/async/upload/input_spec.rb

@@ -0,0 +1,26 @@
+require 'ftpmvc/async/upload/input'
+require 'ftpmvc/async/upload/config'
+require 'tmpdir'
+
+describe '#input' do
+  around do |example|
+    Dir.mktmpdir do |dir|
+      File.open(File.join(dir, 'my-file'), 'w') { |f| f.write('content') }
+      FTPMVC::Async::Upload.configure do
+        config.dir = dir
+      end
+      example.run
+    end
+  end
+  let(:input) { FTPMVC::Async::Upload::Input.new('my-file') }
+  describe '#read' do
+    it 'reads the file content chunk-by-chunk' do
+      expect { |b| input.read(&b) }.to yield_with_args 'content'
+    end
+  end
+  describe '#read_all' do
+    it 'reads all the file content' do
+      expect(input.read_all).to eq 'content'
+    end
+  end
+end

data/spec/lib/ftpmvc/async/upload/job_spec.rb

@@ -0,0 +1,36 @@
+require 'ftpmvc/async/upload'
+
+describe FTPMVC::Async::Upload::Job do
+  let(:file) { File.join(FTPMVC::Async::Upload.config.dir, 'my-file') }
+  before do
+  end
+  around do |example|
+    Dir.mktmpdir do |dir|
+      FTPMVC::Async::Upload.configure do
+        config.dir = dir
+      end
+      File.open(file, 'w') { |f| f.write('file content') }
+      example.run
+    end
+  end
+  let(:job) do
+    Class.new do
+      extend FTPMVC::Async::Upload::Job
+
+      def self.perform(path, id)
+        input(id).read_all
+      end
+    end
+  end
+  describe '#after_perform_delete_uploaded_file' do
+    it 'deletes the uploaded file' do
+      job.after_perform_delete_uploaded_file('/Documents/file.txt', 'my-file')
+      expect(File).not_to exist(file)
+    end
+  end
+  describe '#input' do
+    it 'is the file input' do
+      expect(job.perform('/Documents/file.txt', 'my-file')).to eq 'file content'
+    end
+  end
+end

data/spec/lib/ftpmvc/filter/async_upload_spec.rb

@@ -0,0 +1,35 @@
+require 'tmpdir'
+require 'resque_spec'
+require 'ftpmvc/filter/async_upload'
+require 'ftpmvc/async/upload/job'
+require 'ftpmvc/async/upload/config'
+require 'ftpmvc/string_input'
+
+describe FTPMVC::Filter::AsyncUpload do
+  let(:storage) { Dir.mktmpdir }
+  let(:filter) { FTPMVC::Filter::AsyncUpload.new(nil, nil) }
+  let(:job_class) { Class.new { @queue = :ftpmvc } }
+  before do
+    ResqueSpec.reset!
+  end
+  around do |example|
+    job = job_class
+    Dir.mktmpdir do |dir|
+      FTPMVC::Async::Upload.configure do
+        config.dir = dir
+        config.job = job
+      end
+      example.run
+    end
+  end
+  describe '#put' do
+    it 'writes content to storage' do
+      id = filter.put('/Documents/password.txt', FTPMVC::StringInput.new('mypassword'))
+      expect(File.read(File.join(FTPMVC::Async::Upload::Config.dir, id))).to eq 'mypassword'
+    end
+    it 'enqueues the job' do
+      id = filter.put('/Documents/password.txt', FTPMVC::StringInput.new('mypassword'))
+      expect(job_class).to have_queued('/Documents/password.txt', id).in(:ftpmvc)
+    end
+  end
+end

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification
+name: ftpmvc-async-upload
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- André Aizim Kelmanson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: vfs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: resque_spec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ftpmvc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: app
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: FTPMVC asynchronous upload using resque
+email:
+- akelmanson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ftpmvc-async-upload.gemspec
+- lib/ftpmvc/async/upload.rb
+- lib/ftpmvc/async/upload/config.rb
+- lib/ftpmvc/async/upload/default_job.rb
+- lib/ftpmvc/async/upload/input.rb
+- lib/ftpmvc/async/upload/job.rb
+- lib/ftpmvc/async/upload/version.rb
+- lib/ftpmvc/filter/async_upload.rb
+- spec/integration/async_upload_spec.rb
+- spec/lib/ftpmvc/async/upload/default_job_spec.rb
+- spec/lib/ftpmvc/async/upload/input_spec.rb
+- spec/lib/ftpmvc/async/upload/job_spec.rb
+- spec/lib/ftpmvc/filter/async_upload_spec.rb
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: FTPMVC asynchronous upload using resque
+test_files:
+- spec/integration/async_upload_spec.rb
+- spec/lib/ftpmvc/async/upload/default_job_spec.rb
+- spec/lib/ftpmvc/async/upload/input_spec.rb
+- spec/lib/ftpmvc/async/upload/job_spec.rb
+- spec/lib/ftpmvc/filter/async_upload_spec.rb