infobright-loader 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,19 @@
+# Copyright (c) 2012 SnowPlow Analytics Ltd. All rights reserved.
+#
+# This program is licensed to you under the Apache License Version 2.0,
+# and you may not use this file except in compliance with the Apache License Version 2.0.
+# You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the Apache License Version 2.0 is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the Apache License Version 2.0 for the specific language governing permissions and limitations there under.
+
+# Author::    Alex Dean (mailto:support@snowplowanalytics.com)
+# Copyright:: Copyright (c) 2012 SnowPlow Analytics Ltd
+# License::   Apache License Version 2.0
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in infobright-loader.gemspec
+gemspec

data/LICENSE-2.0.txt

@@ -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

@@ -0,0 +1,232 @@
+# Infobright Ruby Loader
+
+## Overview
+
+Infobright Ruby Loader (IRL) is a data loader for [Infobright Community Edition] [ice] (ICE) and Enterprise Edition (IEE), built in Ruby.
+
+IRL was inspired by [ParaFlex] [paraflex], a Bash script from the Infobright team to perform parallel loading of ICE and IEE. 
+
+IRL can be used in two ways:
+
+1. **As a command-line tool** - i.e. as a direct alternative to ParaFlex. No Ruby expertise required
+2. **As part of another application** - IRL is a Ruby gem with a Ruby API, so can be integrated into larger Ruby ETL processes (such as [SnowPlow's] [snowplow-repo])
+
+## Main differences from ParaFlex
+
+The main differences between IRL and ParaFlex are as follows:
+
+1. IRL can be integrated into Ruby apps (see above)
+2. IRL lets you specify the Infobright username and/or password
+2. IRL lets you specify the data delimiter and encloser
+3. IRL allows loads of multiple files into the same table - it just runs them in series, not in parallel
+4. IRL can be fed a directory of files, as well as a file list
+
+## Installation
+
+### Overview
+
+To add.
+
+### For command-line use
+
+You can install IRL like so:
+
+    $ gem install infobright-loader
+
+### For use in your own application
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'infobright-loader'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+### Operation modes
+
+IRL has two main ways of operating:
+
+1. Loading all the files from a specific directory into a specific table
+2. Loading a set of tables from a set of files (where each table can have multiple files loaded into it)
+
+Both modes of use are available whether you are running IRL from the command-line or from another Ruby application:
+
+### From the command-line
+
+You can use IRL from the command-line:
+
+    $ bundle exec infobright-loader -v
+    infobright-loader 0.0.1
+
+#### Usage options
+
+The usage options look like this:
+
+    Usage: infobright-loader [options]
+    
+    Specify a control file:
+        -c, --control FILE               control file
+        -x, --processes INT              optional number of parallel processes to run *
+
+    Or load a table from a folder of data files:
+        -d, --db NAME                    database name *
+        -u, --username NAME              database username *
+        -p, --password NAME              database password *
+        -t, --table NAME                 table to load data files into
+        -f, --folder DIR                 directory containing data files to load
+        -s, --separator CHAR             optional field separator, defaults to pipe bar (|) *
+        -e, --encloser CHAR              optional field encloser, defaults to none *
+
+    * overrides the same setting in the control file if control file also specified
+
+    Common options:
+        -h, --help                       Show this message
+        -v, --version                    Show version
+
+In other words, you can run IRL from the command-line in two ways:
+
+1. With `--control` specifying a control file containing a list of tables to load, each with a list of files
+2. With `--db`, `--table` and `--folder` to load all the files from a specific directory into a single database table
+
+As an added bonus, if you are using a control file you can still specify the asterisked parameters at the
+command-line, to override the settings found in your control file.
+
+#### Control file format
+
+You can find a template control file in the repository as [`control-file/template.yml`] [control-file]. Its contents
+is as follows:
+
+```yaml
+# Example control file for Infobright Ruby Loader
+
+# Can be overridden at the command line...
+:load:
+  :processes: ADD HERE
+:database:
+  :name: ADD HERE
+  :username: ADD HERE # Or leave blank to default to the user running the script
+  :password: ADD HERE # Or leave blank if no password
+:data_format:
+  :separator: ADD HERE
+  :encloser: ADD HERE # Or leave blank if no encloser
+# ... end of variables overridable at command line.
+
+# Map of tables to populate, along with files to load for each table
+:data_loads:
+  # For each table, list the data files to load
+  TABLE_NAME_1:
+    - PATH/TO/FILE-1
+    - PATH/TO/FILE-2
+  TABLE_NAME_2:
+    - PATH/TO/FILE-3
+    - PATH/TO/FILE-4
+```
+
+### From your own application
+
+Using IRL from your own Ruby application (e.g. an ETL process) is quite straightforward.
+
+First require the necessary file:
+
+```ruby
+require 'infobright-loader/loader'
+```
+
+Now populate a `DbConfig` struct:
+
+```ruby
+db = InfobrightLoader::Db::DbConfig.new('my-db', 'my-db-user', nil) # No password
+```
+
+And now you're ready to load either a single table or a hash of tables:
+
+#### Load a single table
+
+Loading a single table from a folder is quite straightforward:
+
+```ruby
+InfobrightLoader::Loader::load_from_folder(
+  '/data/snowplow/etl-fla/latest', # folder
+  'snowplow_events',               # table
+  db,                              # database config
+  '/t',                            # field separator
+  ''                               # field encloser
+)
+```
+
+Note that the last two arguments are optional - they default to the pipe bar (|) and empty () respectively.
+
+#### Load a hash of tables
+
+To load a hash of tables, let's first create the hash:
+
+```ruby
+load_hash = {}
+load_hash[impressions] = ['/tmp/imps-1', '/tmp/imps-2', '/tmp/imps-3']
+load_hash[clicks] = ['/tmp/clicks-1', '/tmp/clicks-2']
+load_hash[conversions] = ['/tmp/convs-1', '/tmp/convs-2', '/tmp/convs-4', '/tmp/convs-4']
+load_hash[bids] = ['/tmp/bids-1', '/tmp/bids-2', '/tmp/bids-4', '/tmp/bids-4']
+```
+
+Now we can run a parallel load of the tables:
+
+```ruby
+InfobrightLoader::Loader::load_from_hash(
+  load_hash, # hash of tables to load into
+  db,        # database config
+  3,         # number of table loads to run in parallel (using Ruby threads)
+  '/t',      # field separator
+  ''         # field encloser
+)
+```
+
+The last three arguments are optional:
+
+* Number of processes defaults to `10` or the number of tables to populate, whichever is lower
+* The field separator defaults to the pipe bar (`|`)
+* The field encloser defaults to empty ()
+
+## Roadmap
+
+* Add error handling for when individual file loads fail
+* Move tests into Rspec or Cucumber from Bash
+* Add metrics so load time can be reported
+
+## Hacking and contributing
+
+### Hacking locally
+
+1. Build the gem (`gem build infobright-loader.gemspec`)
+2. Install the gem (`sudo gem install ./infobright-loader-0.0.1.gem`)
+
+### Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Copyright and license
+
+Infobright Ruby Loader is copyright 2012 SnowPlow Analytics Ltd.
+
+Licensed under the [Apache License, Version 2.0] [license] (the "License");
+you may not use this software except in compliance with the License.
+
+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.
+
+[ice]: http://www.infobright.org/
+[paraflex]: http://www.infobright.org/Blog/Entry/unscripted/
+[snowplow-repo]: https://github.com/snowplow/snowplow
+[control-file]: https://github.com/snowplow/infobright-ruby-loader/blob/master/control-file/template.yml
+[license]: http://www.apache.org/licenses/LICENSE-2.0