ruby-mtbl 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9173ceae25e2feb40b4521478b658f00f34db9ce
+  data.tar.gz: fde82d2481579b57a44d78bfa1396fdf8986e5d2
+SHA512:
+  metadata.gz: 45f2dde11bed26a010294ce2d0528cb8253314876d4348df3cf0cf1eeb948a3ea7075ea1bb174c59fc59a51a8b9aed016da712170631205e850fa3b499ed6ab5
+  data.tar.gz: 63f0c17f472251d22d67212cf91c75dc829491adaf4101ea8b059c30b63d64c4b53090faa9461d9a3f6598bd7f081b443c2ebb609b48c2ee7b32aa218f3e3425

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+gemspec
+
+gem 'rake-compiler'
+gem 'rspec'

data/Gemfile.lock

@@ -0,0 +1,33 @@
+PATH
+  remote: .
+  specs:
+    ruby-mtbl (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rake (10.4.2)
+    rake-compiler (0.9.5)
+      rake
+    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)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake-compiler
+  rspec
+  ruby-mtbl!

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

@@ -0,0 +1,19 @@
+
+ruby interface to the mtbl library
+==================================
+
+Introduction
+------------
+
+`ruby-mtbl` is a Ruby interface to Farsight Security's [mtbl](https://github.com/farsightsec/mtbl/)
+library, which is a C implementation of the Sorted String Table (SSTable)
+data structure. The latest version of `mtbl` depends on [zlib](http://www.zlib.net/),
+[LZ4](https://github.com/Cyan4973/lz4) (dev branch > 129), and [Snappy](http://google.github.io/snappy/) 
+compression libraries.
+
+On Ubuntu 16.04 LTS, the following command will install the required dependencies:
+```
+$ sudo apt install libmtbl-dev
+```
+This library is still a work in progress.
+

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_helper'
+Bundler::GemHelper.install_tasks :name => "ruby-mtbl"
+
+require 'rake/extensiontask'
+
+Rake::ExtensionTask.new('mtbl')
+

data/bin/rmtbl_create

@@ -0,0 +1,71 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'ostruct'
+require 'mtbl'
+require 'csv'
+
+compression_types = {
+    'none': MTBL::COMPRESSION_NONE,
+  'snappy': MTBL::COMPRESSION_SNAPPY,
+    'zlib': MTBL::COMPRESSION_ZLIB,
+     'lz4': MTBL::COMPRESSION_LZ4,
+   'lz4hc': MTBL::COMPRESSION_LZ4HC
+}
+
+
+options = OpenStruct.new
+OptionParser.new do |opt|
+  opt.on('-k', '--key-index index', 'The field number to use as a key') { |o| options.key_index = o.to_i }
+  opt.on('-v', '--value-index index', 'The field number to use as a value') { |o| options.val_index = o.to_i }
+  opt.on('-r', '--reverse-key', 'Store the key in reverse format') { |o| options.reverse_key = true }
+  opt.on('-c', '--compression type', 'Specify the compression algorithm (#compression_types.keys.join(", ")})') { |o| options.compression = o.to_sym }
+  opt.on('-d', '--delimiter byte', 'Specify the input field delimiter') { |o| options.delimiter = o }
+  opt.on('-M', '--max-fields count', 'Specify the maximum fields (additional delimiters considered data)') { |o| options.max_fields = o.to_i }
+  opt.on('-S', '--sort-skip', 'Skip the sorting phase (assumes sorted input)') { |o| options.skip_sort = true }
+  opt.on('-t', '--sort-temp path', 'The temporary directory to use during sorts') { |o| options.sort_tmp = File.expand_path(o) }
+  opt.on('-m', '--sort-mem ', 'The maximum memory to use during sorts in gigabytes (default 1G)') { |o| options.sort_mem = o.to_i * 1_000_000_000 }
+end.parse!
+
+if ARGV.length != 1
+  $stderr.puts "#{$0} <options> [output.mtbl]"
+  exit(1)
+end
+
+options.key_index   ||= 1
+options.val_index   ||= 2
+options.compression ||= :lz4
+options.delimiter   ||= ','
+options.max_fields  ||= -1
+
+ki = options.key_index - 1
+vi = options.val_index - 1
+
+dst = ARGV.shift
+out = nil
+wri = nil
+
+if ! compression_types[options.compression]
+  $stderr.puts "[-] Invalid compression type: #{options.compression}"
+  exit(1)
+end
+
+if options.skip_sort
+  out = MTBL::Writer.new(dst, compression_types[options.compression])
+else
+  out = MTBL::Sorter.new(nil, options.sort_tmp, options.sort_mem)
+  wri = MTBL::Writer.new(dst, compression_types[options.compression])
+end
+
+$stdin.set_encoding('BINARY')
+
+$stdin.each_line do |line|
+  row = line.strip.split(options.delimiter)
+  k = row[ki]
+  v = row[vi]
+  next unless (k && v)
+  k.reverse! if options.reverse_key
+  out.add(k, v)
+end
+
+out.write(wri) if wri

data/bin/rmtbl_dump

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'ostruct'
+require 'mtbl'
+
+options = OpenStruct.new
+OptionParser.new do |opt|
+  opt.on('-k', '--key-only', 'Display keys only') { |o| options.keys_only = true }
+  opt.on('-v', '--value-only', 'Display values only') { |o| options.vals_only = true }
+  opt.on('-p', '--prefix prefix', 'Display records with a specific prefix') { |o| options.prefix = o }
+  opt.on('-R', '--reverse-key', 'Display the key reversed') { |o| options.reverse_key = true }
+  opt.on('-r', '--reverse-prefix prefix', 'Display records with a specific prefix (reversed)') { |o|
+    options.prefix = o.reverse
+    options.reverse_prefix = true
+  }
+end.parse!
+
+if ARGV.length == 0
+  $stderr.puts "#{$0} <options> [mtbl1] [mtbl2] .. [mtblX]"
+  exit(1)
+end
+
+ARGV.each do |fname|
+  reader   = MTBL::Reader.new(fname)
+  iterator = options.prefix ? reader.get_prefix(options.prefix) : reader.iterator
+  iterator.each do |r|
+
+    if options.reverse_key || options.reverse_prefix
+      r[0] = r[0].reverse
+    end
+
+    if options.keys_only
+      puts r[0]
+      next
+    end
+   
+    if options.vals_only
+      puts r[1]
+      next
+    end
+
+    puts r.join("\t")
+
+  end
+end

data/bin/rmtbl_info

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+require 'mtbl'
+
+if ARGV.length == 0
+  $stderr.puts "#{$0} [mtbl1] [mtbl2] .. [mtblX]"
+  exit(1)
+end
+
+max_key_len = nil
+
+ARGV.each do |fname|
+  info = MTBL::Utils.metadata(fname)
+  info.each_pair do |k,v|
+    puts "#{k.to_s.gsub("_", " ")}: ".ljust(23) + v.to_s
+  end  
+end

data/examples/test.rb

@@ -0,0 +1,101 @@
+#!/usr/bin/env ruby
+path_base = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+path_ext  = File.join(path_base, "lib")
+
+$:.unshift(path_ext)
+
+require 'mtbl'
+require 'pp'
+require 'tempfile'
+
+test_mtbl1 = File.expand_path(File.join(File.dirname(__FILE__), "test1.mtbl"))
+
+reader = MTBL::Reader.new(test_mtbl1)
+
+iter = reader.iterator
+1.upto(10) do |x|
+  puts [:iterator, x, iter.next].inspect
+end
+puts ("-" * 80)
+
+get = reader.get("az")
+puts [:get, get.next].inspect
+puts ("-" * 80)
+
+get = reader.get_prefix("c")
+puts [:get_prefix, get.next].inspect
+puts ("-" * 80)
+
+get = reader.get_range("ca", "cz")
+while(true)
+  x = get.next
+  break unless x
+  puts [:get_range, x].inspect
+end
+puts ("-" * 80)
+
+pp MTBL::Utils.metadata(test_mtbl1)
+puts ("-" * 80)
+
+test_write_mtbl = Tempfile.new("mtbltest")
+test_write_path = test_write_mtbl.path
+test_write_mtbl.unlink
+
+writer = MTBL::Writer.new(test_write_path)
+writer.add("Hello", "Goodbye")
+writer.close
+
+reader = MTBL::Reader.new(test_write_path)
+iter = reader.iterator
+while (r = iter.next)
+  puts [:wrote, r].inspect
+end
+puts ("-" * 80)
+
+begin
+  writer.close
+rescue ::RuntimeError
+end
+
+File.unlink(test_write_path)
+
+MTBL.constants.grep(/^COMPRESSION_/).each do |cname|
+  ctype = MTBL.const_get(cname)
+  path = test_write_path + "." + cname.to_s
+  writer = MTBL::Writer.new(path, ctype)
+  writer.add("Hello", "Goodbye")
+  writer.close
+  info = MTBL::Utils.metadata(path)
+  puts [:compression, cname, info[:compression]].inspect
+  File.unlink(path)
+end
+puts ("-" * 80)
+
+sorter = MTBL::Sorter.new
+sorter.add("bbb", "2")
+sorter.add("aaa", "1")
+sorter.add("ccc", "3")
+sorter.add("bbb", "22")
+sorter.add("aaa", "11")
+sorter.add("ccc", "33")
+sorter.add("bbb", "222")
+sorter.add("aaa", "111")
+sorter.add("ccc", "333")
+
+test_write_path + "." + "sorted"
+writer = MTBL::Writer.new(test_write_path)
+sorter.write(writer)
+sorter.close
+writer.close
+
+reader = MTBL::Reader.new(test_write_path)
+iter = reader.iterator
+while (r = iter.next)
+  puts [:sorted, r].inspect
+end
+
+File.unlink(test_write_path)
+
+
+puts ("-" * 80)
+