iostreams 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1204961c2edb46c45ff0ffd39c368f5c87c37d61d108a83a4c8e252f12512fdf
-  data.tar.gz: 6572b1c75c435228e56fbcaf6c29ca274544b592f36ce0a84034436bc306adde
+  metadata.gz: c04b1faf6890f6e1ec98965626068918c08f03b3f548f6a8e6a5c5a96da81e8b
+  data.tar.gz: 4a322fe6134797ce698f2d9bc65999b5e187d7dfc23354383965aaa0d4b85f98
 SHA512:
-  metadata.gz: c5c8dfb2434a9d7328fb1d54cd20036565cfc2d6eee4365fc30528bb1ff73170fb26d854c319ea5e43ff8a6027ac8737f9fef926082249de2a89d0e17fff71f3
-  data.tar.gz: 6d1dd7d3aea5d3c1e693c788961ae491cf7e7825a77035cb348616d5a085c4995e703258cff78c4d00c736f170c395310b9ecbfe2b2026bff4f8427e536099c0
+  metadata.gz: eb2284f07be4b270e24cf4135b3fdd9b9e8a125f73dc65c2b581a756ca2a69ee96b6f14ac398b33c264cc9d450ac13e8a37dc70fca94d04945e231687c71c594
+  data.tar.gz: a6fbb3a182e137a252f5dac842e4a327f5176db427dd8f62da183b77329545c91515ae93740897c71daf3cca37feeb1b21356645426a629074385f16201b0136

data/LICENSE

@@ -0,0 +1,202 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/README.md

@@ -1,24 +1,36 @@
-# iostreams [![Gem Version](https://badge.fury.io/rb/iostreams.svg)](http://badge.fury.io/rb/iostreams) [![Build Status](https://secure.travis-ci.org/rocketjob/iostreams.png?branch=master)](http://travis-ci.org/rocketjob/iostreams) ![](http://ruby-gem-downloads-badge.herokuapp.com/iostreams?type=total)
+# iostreams
+[![Gem Version](https://img.shields.io/gem/v/iostreams.svg)](https://rubygems.org/gems/iostreams) [![Build Status](https://travis-ci.org/rocketjob/iostreams.svg?branch=master)](https://travis-ci.org/rocketjob/iostreams) [![Downloads](https://img.shields.io/gem/dt/iostreams.svg)](https://rubygems.org/gems/iostreams) [![License](https://img.shields.io/badge/license-Apache%202.0-brightgreen.svg)](http://opensource.org/licenses/Apache-2.0) ![](https://img.shields.io/badge/status-Beta-yellow.svg) [![Gitter chat](https://img.shields.io/badge/IRC%20(gitter)-Support-brightgreen.svg)](https://gitter.im/rocketjob/support)
 
-Ruby Input and Output streaming for Ruby 
+Input and Output streaming for Ruby.
 
 ## Project Status
 
-Beta - Feedback on the API is welcome. API is subject to change.
+Production Ready, but API is subject to breaking changes until V1 is released.
 
 ## Features
 
-Currently streaming classes are available for:
+Supported file / stream types:
 
 * Zip
 * Gzip
 * BZip2
 * CSV
-* Delimited Lines / Rows
-* PGP
+* PGP (Uses GnuPG)
 * Xlsx (Reading)
 * Encryption using [Symmetric Encryption](https://github.com/reidmorrison/symmetric-encryption)
 
+Streaming support currently under development:
+
+* S3
+* SFTP
+
+Supported file formats:
+
+* CSV
+* Fixed width formats
+* JSON
+* PSV
+
 ## Introduction
 
 If all files were small, they could just be loaded into memory in their entirety. With the
@@ -74,36 +86,155 @@ through the entire file.
 Where possible each stream never goes to disk, which for example could expose
 un-encrypted data.
 
-## Architecture
+## Examples
+
+While decompressing the file, display 128 characters at a time from the file.
+
+~~~ruby
+require 'iostreams'
+IOStreams.reader('abc.csv') do |io|
+  p data while (data = io.read(128))
+end
+~~~
+
+While decompressing the file, display one line at a time from the file.
+
+~~~ruby
+IOStreams.each_line('abc.csv') do |line|
+  puts line
+end
+~~~
+
+While decompressing the file, display each row from the csv file as an array.
+
+~~~ruby
+IOStreams.each_row('abc.csv') do |array|
+  p array
+end
+~~~
+
+While decompressing the file, display each record from the csv file as a hash.
+The first line is assumed to be the header row.
+
+~~~ruby
+IOStreams.each_record('abc.csv') do |hash|
+  p hash
+end
+~~~
+
+Display each line from the array as a hash.
+The first line is assumed to be the header row.
+
+~~~ruby
+array = [
+  'name, address, zip_code',
+  'Jack, Down Under, 12345'
+]
+IOStreams.each_record(array) do |hash|
+  p hash
+end
+~~~
+
+Write data while compressing the file.
+
+~~~ruby
+IOStreams.writer('abc.csv') do |io|
+  io.write('This')
+  io.write(' is ')
+  io.write(" one line\n")
+end
+~~~
+
+Write a line at a time while compressing the file.
 
-Streams are chained together by passing the 
+~~~ruby
+IOStreams.line_writer('abc.csv') do |file|
+  file << 'these'
+  file << 'are'
+  file << 'all'
+  file << 'separate'
+  file << 'lines'
+end
+~~~
+
+Write an array (row) at a time while compressing the file.
+Each array is converted to csv before being compressed with zip.
+
+~~~ruby
+IOStreams.row_writer('abc.csv') do |io|
+  io << %w[name address zip_code]
+  io << %w[Jack There 1234]
+  io << ['Joe', 'Over There somewhere', 1234]
+end
+~~~
+
+Write a hash (record) at a time while compressing the file.
+Each hash is converted to csv before being compressed with zip.
+The header row is extracted from the first hash supplied.
+
+~~~ruby
+IOStreams.record_writer('abc.csv') do |stream|
+  stream << {name: 'Jack', address: 'There', zip_code: 1234}
+  stream << {name: 'Joe', address: 'Over There somewhere', zip_code: 1234}
+end
+~~~
+
+Write to a string IO for testing, supplying the filename so that the streams can be determined.
+
+~~~ruby
+io = StringIO.new
+IOStreams::Tabular::Writer(io, file_name: 'abc.csv') do |stream|
+  stream << {name: 'Jack', address: 'There', zip_code: 1234}
+  stream << {name: 'Joe', address: 'Over There somewhere', zip_code: 1234}
+end
+puts io.string
+~~~
+
+Read a CSV file and write the output to an encrypted file in JSON format.
 
-Every Reader or Writer is invoked by calling its `.open` method and passing the block
-that must be invoked for the duration of that stream.
+~~~ruby
+IOStreams.record_writer('sample.json.enc') do |output|
+  IOStreams.each_record('sample.csv') do |record|
+    output << record
+  end
+end
+~~~
+
+## Copying between files
 
-The above block is passed the stream that needs to be encoded/decoded using that
-Reader or Writer every time the `#read` or `#write` method is called on it.
+Stream based file copying. Changes the file type without changing the file format. For example, compress or encrypt. 
 
-### Readers
+Encrypt the contents of the file `sample.json` and write to `sample.json.enc`
 
-Each reader stream must implement: `#read`
+~~~ruby
+IOStreams.copy('sample.json', 'sample.json.enc')
+~~~
 
-### Writer
+Encrypt and compress the contents of the file `sample.json` with Symmetric Encryption and write to `sample.json.enc`
 
-Each writer stream must implement: `#write`
+~~~ruby
+IOStreams.copy('sample.json', 'sample.json.enc', target_options: {streams: {enc: {compress: true}}})
+~~~
 
-### Optional methods
+Encrypt and compress the contents of the file `sample.json` with pgp and write to `sample.json.enc`
 
-The following methods on the stream are useful for both Readers and Writers
+~~~ruby
+IOStreams.copy('sample.json', 'sample.json.pgp', target_options: {streams: {pgp: {recipient: 'sender@example.org'}}})
+~~~
 
-### close
+Decrypt the file `abc.csv.enc` and write it to `xyz.csv`.
 
-Close the stream, and cleanup any buffers, etc.
+~~~ruby
+IOStreams.copy('abc.csv.enc', 'xyz.csv')
+~~~
 
-### closed?
+Read `ABC`, PGP encrypt the file and write to `xyz.csv.pgp`, applying 
 
-Has the stream already been closed? Useful, when child streams have already closed the stream
-so that `#close` is not called more than once on a stream.
+~~~ruby
+IOStreams.copy('ABC', 'xyz.csv.pgp',
+               source_options: [:enc],
+               target_options: [pgp: {email_recipient: 'a@a.com'})
+~~~
 
 ## Notes
 
@@ -113,33 +244,10 @@ so that `#close` is not called more than once on a stream.
 * Zip becomes exponentially slower with very large files, especially files
   that exceed 4GB when uncompressed. Highly recommend using GZip for large files.
 
-## Future
-
-Below are just some of the streams that are envisaged for `iostreams`:
-* PGP reader and write
-    * Read and write PGP encrypted files
-* CSV
-    * Read and write CSV data, reading data back as Arrays and writing Arrays as CSV text
-* Delimited Text Stream
-    * Autodetect Windows/Linux line endings and return a line at a time
-* MongoFS
-    * Read and write file streams to and from MongoFS
-    
-For example:
-```ruby
-# Read a CSV file, delimited with Windows line endings, compressed with GZip, and encrypted with PGP:
-IOStreams.reader('hello.csv.gz.pgp', [:csv, :delimited, :gz, :pgp]) do |reader|
-  # Returns an Array at a time
-  reader.each do |row|
-    puts "Read: #{row.inspect}"
-  end
-end
-```
-
 To completely implement io streaming for Ruby will take a lot more input and thoughts
 from the Ruby community. This gem represents a starting point to get the discussion going.
 
-By keeping this gem in Beta state and not going V1, we can change the interface as needed
+By keeping this gem a 0.x version and not going V1, we can change the interface as needed
 to implement community feedback.
 
 ## Versioning