fife 0.0.1.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 43c985295f282009483540caf7df104753ccbc59
+  data.tar.gz: aa20d1317ca9286b8eb0937cb4d3b56df0eee3cd
+SHA512:
+  metadata.gz: 09931e0e7810f6ecb565887186f6336adeb4b16c11161ddbf68622e8fe3618d8d826b6fda0b59ebc9a28291907e13cb348f265bd1e6129aab900ddaad1037ae4
+  data.tar.gz: 65b51126ee185b42ce488d678837fcd6ec5f8309dac05ee02e74562668f9f17a0170b50488bafcfd424e5898b415cfd5f3bc89f018954fde2426f3352895f344

data/.gitignore

@@ -0,0 +1,126 @@
+# Created by .ignore support plugin (hsz.mobi)
+### Linux template
+*~
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+### JetBrains template
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio
+
+*.iml
+
+## Directory-based project format:
+.idea/
+# if you remove the above rule, at least ignore the following:
+
+# User-specific stuff:
+# .idea/workspace.xml
+# .idea/tasks.xml
+# .idea/dictionaries
+
+# Sensitive or high-churn files:
+# .idea/dataSources.ids
+# .idea/dataSources.xml
+# .idea/sqlDataSources.xml
+# .idea/dynamic.xml
+# .idea/uiDesigner.xml
+
+# Gradle:
+# .idea/gradle.xml
+# .idea/libraries
+
+# Mongo Explorer plugin:
+# .idea/mongoSettings.xml
+
+## File-based project format:
+*.ipr
+*.iws
+
+## Plugin-specific files:
+
+# IntelliJ
+/out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+### Vim template
+[._]*.s[a-w][a-z]
+[._]s[a-w][a-z]
+*.un~
+Session.vim
+.netrwhist
+*~
+### Ruby template
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+### OSX template
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: .
+  specs:
+    fife (0.0.1.alpha)
+      activesupport (~> 4.2)
+      net-sftp (~> 2.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (4.2.5)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    diff-lcs (1.2.5)
+    i18n (0.7.0)
+    json (1.8.3)
+    minitest (5.8.3)
+    net-sftp (2.1.2)
+      net-ssh (>= 2.6.5)
+    net-ssh (3.0.1)
+    rake (10.4.2)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.1)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.10)
+  fife!
+  rake (~> 10.0)
+  rspec (~> 3.4)
+
+BUNDLED WITH
+   1.10.6

data/README.md

@@ -0,0 +1,135 @@
+# Fife
+
+**Fife** is a multiple IO pipelining tool, originally designed for
+file uploading through HTTP, but can be used in any other cases.
+
+## Warning
+This gem is in early development stage, and the interface could be changed enormously in future releases.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fife'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fife
+
+## Usage
+
+Create a `Fife` instance by calling `Fife(io_ary)`,
+then chain as many `pipe` calls as you want.
+
+```ruby
+io_ary = [
+  File.new('/path/to/my/file'),
+  StringIO.new('Hello world'),
+  Tempfile.new('temp')
+]
+
+Fife(io_ary).pipe(-> io {io})
+            .pipe(-> io {[io, io]})
+            .pipe(:close)
+```
+
+### Kernel#Fife(*ios)
+
+This method returns a `Fife::Pipe` instance for chaining.
+
+This method expect 0 or more IO-like objects as arguments.
+Alternatively it can take an array of IO-like objects
+
+### Fife::Pipe#pipe
+
+This method returns a new `Fife::Pipe` instance.
+
+It has 2 forms of usage:
+
+1.  pass an operation as the argument
+`Fife(io_ary).pipe(->io{io})`
+2.  pass the underscored name of an operation class,
+and 0 or more arguments as the constructor arguments of that class.
+`Fife(io_ary).pipe(:store, my_storage)`
+see *Define custom operations* for detail.
+
+### Operation
+
+An operation is an object that responds to `call(io)`, and returns 0 or more IO-like objects.
+A *lambda* is often used as an operation, but an operation can be of any type.
+
+Currently, `Fife` ships with 4 operations: `:noop`, `:name`, `:store` and `:close`
+
+* noop
+Performs no operation on the IO, and returns the IO directly.
+* close
+Closes the
+* store
+Stores the content of the IO.
+* name
+Gives the IO a name according to the per-io naming strategy you specified.
+You can retrieve it's name by calling `#name` on the IO instance.
+```ruby
+name = Fife::Operations::Name.new(->io { 'some_name' })
+Fife(io_ary).pipe(name)
+
+# Or
+Fife(io_ary).pipe(:name, ->io { 'some_name' })
+```
+
+#### Define custom operations
+
+If you feel lambdas are not enough for your job,
+you can easily define your own operations.
+
+```ruby
+class Fife::Operations::MyOperation
+  def initialize(arg1, arg2)
+    # Initialize the Operation
+  end
+
+  def call(io)
+    # Handle the io and return some IO instances
+  end
+end
+```
+Then you can use it like
+```ruby
+Fife(io_ary).pipe(:my_operation, 1, 2)
+```
+
+### Storage
+To leverage the `:store` operation, you need a *storage*.
+
+A storage is just an object that responds to `store(io)`.
+
+Currently, **Fife** ships with 2 storage classes:
+
+* `Fife::Storage::Null`
+Simply does nothing
+* `Fife::Storage::Sftp`
+Streams the IO to a remote file via SFTP.
+This storage should be used with `:name` operation because
+the remote filename depends on the name of the IO.
+(I know it's nasty, but it's still under developing)
+
+```ruby
+storage = Fife::Storage::Sftp.new('localhost', 'me', '/path/to/remote/dir', password: 'P@ssw0rd')
+Fife(io_ary).pipe(:store, storage)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/aetherus/fife.

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'fife'
+
+# 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

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/fife.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fife/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'fife'
+  spec.version       = Fife::VERSION
+  spec.authors       = ['aetherus']
+  spec.email         = ['aetherus.zhou@gmail.com']
+  spec.licenses      = ['MIT']
+
+  spec.summary       = 'A multiple IO pipelining tool'
+  spec.description   = %q{
+    A multiple IO pipelining tool.
+    You can use it to spawn as many or as few IO-like instances from 0 or more IO-like instances.
+  }
+  spec.homepage      = 'https://github.com/aetherus/fife'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_runtime_dependency 'net-sftp', '~> 2.1'
+  spec.add_runtime_dependency 'activesupport', '~> 4.2'
+end

data/lib/fife/has_name.rb

@@ -0,0 +1,8 @@
+module Fife::HasName
+  def self.extended(obj)
+    class << obj
+      attr_reader :name unless instance_methods(true).include? :name
+      attr_writer :name unless instance_methods(true).include? :name=
+    end
+  end
+end

data/lib/fife/operations/close.rb

@@ -0,0 +1,5 @@
+class Fife::Operations::Close
+  def call(io)
+    io.close unless io.closed?
+  end
+end

data/lib/fife/operations/name.rb

@@ -0,0 +1,14 @@
+require 'pathname'
+require 'fileutils'
+
+class Fife::Operations::Name
+  def initialize(naming)
+    @naming = naming
+  end
+
+  def call(io)
+    io.extend(Fife::HasName)
+    io.name = @naming.call(io)
+    io
+  end
+end

data/lib/fife/operations/noop.rb

@@ -0,0 +1,5 @@
+class Fife::Operations::Noop
+  def call(io)
+    io
+  end
+end

data/lib/fife/operations/store.rb

@@ -0,0 +1,11 @@
+class Fife::Operations::Store
+  attr_reader :storage
+
+  def initialize(storage)
+    @storage = storage
+  end
+
+  def call(io)
+    storage.store(io)
+  end
+end

data/lib/fife/operations.rb

@@ -0,0 +1,8 @@
+module Fife::Operations
+  extend ActiveSupport::Autoload
+
+  autoload :Noop
+  autoload :Close
+  autoload :Name
+  autoload :Store
+end

data/lib/fife/pipe.rb

@@ -0,0 +1,22 @@
+class Fife::Pipe
+
+  attr_reader :ios
+
+  def initialize(ios)
+    @ios = ios.flatten.tap(&:compact!)
+  end
+
+  def pipe(op, *args)
+    op = Fife::Operations.const_get(op.to_s.camelize.to_sym).new(*args) unless op.respond_to? :call
+    output = []
+
+    ios.map { |io|
+      Thread.new do
+        output << op.call(io.tap(&:rewind))
+      end
+    }.each(&:join)
+
+    self.class.new(output)
+  end
+
+end

data/lib/fife/storage/null.rb

@@ -0,0 +1,5 @@
+class Fife::Storage::Null
+  def store(io)
+    # Do nothing
+  end
+end

data/lib/fife/storage/sftp.rb

@@ -0,0 +1,31 @@
+require 'net/sftp'
+require 'pathname'
+require 'fileutils'
+
+class Fife::Storage::Sftp
+  attr_reader :host, :user, :remote_dir, :ssh_options
+
+  def initialize(host, user, remote_dir, ssh_options)
+    @host, @user, @ssh_options = host, user, ssh_options
+    @remote_dir = Pathname(remote_dir)
+    ensure_remote_dir_presence!
+  end
+
+  def store(io)
+    raise UnnamedIO unless io.respond_to? :name
+    remote_path = remote_dir.join(io.name)
+    Net::SFTP.start(host, user, ssh_options) do |sftp|
+      sftp.file.open(remote_path, 'w') { |f| IO.copy_stream(io, f) }
+    end
+    io.close
+  end
+
+  private
+  def ensure_remote_dir_presence!
+    Net::SFTP.start(host, user, ssh_options) do |sftp|
+      remote_dir.descend do |path|
+        sftp.mkdir!(path) rescue nil
+      end
+    end
+  end
+end

data/lib/fife/storage.rb

@@ -0,0 +1,8 @@
+module Fife::Storage
+  extend ActiveSupport::Autoload
+
+  class UnnamedIO < RuntimeError; end
+
+  autoload :Null
+  autoload :Sftp
+end

data/lib/fife/version.rb

@@ -0,0 +1,3 @@
+module Fife
+  VERSION = "0.0.1.alpha"
+end

data/lib/fife.rb

@@ -0,0 +1,17 @@
+require 'fife/version'
+require 'active_support/all'
+
+module Fife
+  extend ActiveSupport::Autoload
+
+  autoload :Pipe
+  autoload :Operations
+  autoload :Storage
+  autoload :HasName
+end
+
+module Kernel
+  def Fife(*ios)
+    Fife::Pipe.new(ios)
+  end
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: fife
+version: !ruby/object:Gem::Version
+  version: 0.0.1.alpha
+platform: ruby
+authors:
+- aetherus
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: net-sftp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: "\n    A multiple IO pipelining tool.\n    You can use it to spawn as
+  many or as few IO-like instances from 0 or more IO-like instances.\n  "
+email:
+- aetherus.zhou@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fife.gemspec
+- lib/fife.rb
+- lib/fife/has_name.rb
+- lib/fife/operations.rb
+- lib/fife/operations/close.rb
+- lib/fife/operations/name.rb
+- lib/fife/operations/noop.rb
+- lib/fife/operations/store.rb
+- lib/fife/pipe.rb
+- lib/fife/storage.rb
+- lib/fife/storage/null.rb
+- lib/fife/storage/sftp.rb
+- lib/fife/version.rb
+homepage: https://github.com/aetherus/fife
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: A multiple IO pipelining tool
+test_files: []