ruby-mtbl 1.0.1

data/ruby-mtbl.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name        = 'ruby-mtbl'
+  s.version     = '1.0.1'
+  s.author      = 'HD Moore'
+  s.email       = 'x@hdm.io'
+  s.license     = 'Apache-2.0'
+  s.homepage    = "https://www.github.com/hdm/ruby-mtbl"
+  s.summary     = %q{ruby-mtbl: Ruby interface to the MTBL SortedString library}
+  s.description = %q{
+    The ruby-mtbl gem provides a Ruby interface to Farsight Security's MTBL SortedString library.
+  }.gsub(/\s+/, ' ').strip
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.extensions    = [ 'ext/mtbl/extconf.rb' ]
+  s.require_paths = ['lib']
+end

data/spec/mtbl_reader_spec.rb

@@ -0,0 +1,112 @@
+require 'mtbl'
+
+RSpec.describe MTBL::Reader, "#new" do
+
+  context "missing file" do
+    it "throws an exception" do
+      expect { MTBL::Reader.new("missing.mtbl") }.to raise_error(::RuntimeError)
+    end
+  end
+
+  context "valid file" do
+    test_mtbl1 = File.expand_path(File.join(File.dirname(__FILE__), "..", "examples", "test1.mtbl"))
+    it "opens successfully" do
+      expect { reader = MTBL::Reader.new(test_mtbl1) }.to_not raise_error
+    end
+  end
+end
+
+RSpec.describe MTBL::Reader, "#iterator" do
+  test_mtbl1 = File.expand_path(File.join(File.dirname(__FILE__), "..", "examples", "test1.mtbl"))
+
+  context "finds all records" do
+    it "has 676 entries" do
+      iterator = MTBL::Reader.new(test_mtbl1).iterator
+      count = 0
+      while (r = iterator.next)
+        count += 1
+      end
+      expect(count).to be(676)
+    end
+
+    it "returns the first entry" do 
+      iterator = MTBL::Reader.new(test_mtbl1).iterator
+      expect(iterator.next).to eq(["aa","1"])
+    end
+
+    it "returns the last entry" do
+      iterator = MTBL::Reader.new(test_mtbl1).iterator
+      last_entry = nil
+      while(r = iterator.next)
+        last_entry = r
+      end
+      expect(last_entry).to eq(["zz","676"])
+    end
+  end
+end
+
+RSpec.describe MTBL::Reader, "#get" do
+  test_mtbl1 = File.expand_path(File.join(File.dirname(__FILE__), "..", "examples", "test1.mtbl"))
+
+  context "finds an exact key" do
+    it "finds aj" do
+      expect(MTBL::Reader.new(test_mtbl1).get("aj").next).to eq(["aj", "10"])
+    end
+    it "finds zx" do
+      expect(MTBL::Reader.new(test_mtbl1).get("zx").next).to eq(["zx", "674"])
+    end
+  end
+end
+
+RSpec.describe MTBL::Reader, "#get_prefix" do
+  test_mtbl1 = File.expand_path(File.join(File.dirname(__FILE__), "..", "examples", "test1.mtbl"))
+
+  context "finds prefixes" do
+    it "finds a*" do
+      count = 0
+      iterator = MTBL::Reader.new(test_mtbl1).get_prefix("a")
+      while(r = iterator.next)
+        count += 1
+      end
+      expect(count).to be(26)
+    end
+
+    it "finds z*" do
+      count = 0
+      iterator = MTBL::Reader.new(test_mtbl1).get_prefix("z")
+      while(r = iterator.next)
+        count += 1
+      end
+      expect(count).to be(26)
+    end
+
+    it "finds jj" do
+      expect(MTBL::Reader.new(test_mtbl1).get_prefix("jj").next).to eq(["jj", "244"])
+    end
+  end
+end
+
+RSpec.describe MTBL::Reader, "#get_range" do
+  test_mtbl1 = File.expand_path(File.join(File.dirname(__FILE__), "..", "examples", "test1.mtbl"))
+  
+  context "finds ranges" do
+
+    it "finds ab..az" do
+       count = 0
+      iterator = MTBL::Reader.new(test_mtbl1).get_range("ab", "az")
+      while(r = iterator.next)
+        count += 1
+      end
+      expect(count).to eq(25)
+    end
+
+    it "finds ca..jp" do
+       count = 0
+      iterator = MTBL::Reader.new(test_mtbl1).get_range("ca", "jp")
+      while(r = iterator.next)
+        count += 1
+      end
+      expect(count).to eq(198)
+    end
+  end
+end 

data/spec/mtbl_sorter_spec.rb

@@ -0,0 +1,29 @@
+require 'mtbl'
+require 'tempfile'
+
+RSpec.describe MTBL::Sorter, "#new" do
+
+  context "records" do
+    sorter =  MTBL::Sorter.new
+
+    it "handles invalid adds" do
+      expect { sorter.add(:invalid, "test") }.to raise_error(ArgumentError)
+      expect { sorter.add("test", :invalid) }.to raise_error(ArgumentError)
+      expect { sorter.add("test", 9000) }.to raise_error(ArgumentError)
+      expect { sorter.add(400, "blah") }.to raise_error(ArgumentError)
+    end
+
+    it "accepts sequential keys" do
+      expect { sorter.add("1000", "test1") }.to_not raise_error
+      expect { sorter.add("1005", "test2") }.to_not raise_error
+      expect { sorter.add("1010", "test3") }.to_not raise_error
+    end
+
+    it "accepts non-sequential keys" do
+      expect { sorter.add("1001", "test1") }.to_not raise_error
+      expect { sorter.add("1004", "test1") }.to_not raise_error
+      expect { sorter.add("1009", "test1") }.to_not raise_error
+    end
+
+  end
+end

data/spec/mtbl_spec.rb

@@ -0,0 +1,17 @@
+require 'mtbl'
+
+RSpec.describe MTBL, "#constants" do
+  context "class" do
+    it "has classes" do
+      expect(MTBL.constants.include?(:Reader)).to be(true)
+      expect(MTBL.constants.include?(:Writer)).to be(true)
+      expect(MTBL.constants.include?(:Utils)).to be(true)
+      expect(MTBL.constants.include?(:Sorter)).to be(true)
+      expect(MTBL.constants.include?(:COMPRESSION_NONE)).to be(true)
+      expect(MTBL.constants.include?(:COMPRESSION_ZLIB)).to be(true)
+      expect(MTBL.constants.include?(:COMPRESSION_SNAPPY)).to be(true)
+      expect(MTBL.constants.include?(:COMPRESSION_LZ4)).to be(true)
+      expect(MTBL.constants.include?(:COMPRESSION_LZ4HC)).to be(true)
+    end
+  end
+end

data/spec/mtbl_utils_spec.rb

@@ -0,0 +1,40 @@
+require 'mtbl'
+require 'tempfile'
+
+RSpec.describe MTBL::Utils, "#metadata" do
+  test_mtbl1 = File.expand_path(File.join(File.dirname(__FILE__), "..", "examples", "test1.mtbl"))
+
+  context "invalid file" do
+
+    it "throws an exception with an invalid path" do
+      expect{ MTBL::Utils.metadata("missing.mtbl") }.to raise_error(RuntimeError)
+    end
+
+    it "throws an exception with an invalid file" do
+      tfile = Tempfile.new("mtbl")
+      expect{ MTBL::Utils.metadata(tfile.path) }.to raise_error(RuntimeError)
+    end
+
+    it "throws an exception with a non-string argument" do
+       expect{ MTBL::Utils.metadata(3000) }.to raise_error(ArgumentError)
+    end
+
+  end
+
+  context "valid file" do
+    info = MTBL::Utils.metadata(test_mtbl1)
+    it "has correct metadata" do
+      expect(info[:filesize]).to eq(2866)
+      expect(info[:index_block_offset]).to eq(2332)
+      expect(info[:index_bytes]).to eq(22)
+      expect(info[:data_block_bytes]).to eq(2332)
+      expect(info[:data_block_size]).to eq(8192)
+      expect(info[:data_block_count]).to eq(1)
+      expect(info[:entry_count]).to eq(676)
+      expect(info[:key_bytes]).to eq(1352)
+      expect(info[:value_bytes]).to eq(1920)
+      expect(info[:compression]).to eq("zlib")
+    end
+  end
+end
+

data/spec/mtbl_writer_spec.rb

@@ -0,0 +1,101 @@
+require 'mtbl'
+require 'tempfile'
+
+RSpec.describe MTBL::Writer, "#new" do
+
+  context "arguments" do
+    it "throws an exception on missing filename" do
+      expect { MTBL::Writer.new() }.to raise_error(ArgumentError)
+    end
+
+    it "does not throw an exception with a valid filename" do
+      tfile = Tempfile.new("mtbl-writer")
+      tpath = tfile.path
+      tfile.unlink
+      expect { MTBL::Writer.new(tpath) }.to_not raise_error
+      File.unlink(tpath)
+    end
+
+    it "throws an exception with existing file" do
+      tfile = Tempfile.new("mtbl-writer")
+      expect { MTBL::Writer.new(tfile.path) }.to raise_error(ArgumentError)
+    end
+
+    it "throws an exception with non-string arguments" do
+      expect { MTBL::Writer.new(9000) }.to raise_error(ArgumentError)
+    end
+
+    it "throws an exception with non-integer compression type" do
+      tfile = Tempfile.new("mtbl-writer")
+      tpath = tfile.path
+      tfile.unlink
+      expect { MTBL::Writer.new(tpath, "blagh") }.to raise_error(ArgumentError)
+    end
+
+    it "throws an exception with an invalid compression type" do
+      tfile = Tempfile.new("mtbl-writer")
+      tpath = tfile.path
+      tfile.unlink
+      expect { MTBL::Writer.new(tpath, 999) }.to raise_error(ArgumentError)
+    end
+
+    it "does not throw an exception with a valid compression type" do
+      tfile = Tempfile.new("mtbl-writer")
+      tpath = tfile.path
+      tfile.unlink
+      expect { MTBL::Writer.new(tpath, MTBL::COMPRESSION_ZLIB) }.to_not raise_error
+      File.unlink(tpath)
+    end
+
+    it "throws an exception with an non-integer block size" do
+      tfile = Tempfile.new("mtbl-writer")
+      tpath = tfile.path
+      tfile.unlink
+      expect { MTBL::Writer.new(tpath, MTBL::COMPRESSION_ZLIB, "blargh") }.to raise_error(ArgumentError)
+    end
+
+    it "does not throw an exception with an integer block size" do
+      tfile = Tempfile.new("mtbl-writer")
+      tpath = tfile.path
+      tfile.unlink
+      expect { MTBL::Writer.new(tpath, MTBL::COMPRESSION_ZLIB, 2048) }.to_not raise_error
+      File.unlink(tpath)
+    end
+
+    it "throws an exception with an non-integer restart interval" do
+      tfile = Tempfile.new("mtbl-writer")
+      tpath = tfile.path
+      tfile.unlink
+      expect { MTBL::Writer.new(tpath, MTBL::COMPRESSION_ZLIB, 4096, "blargh") }.to raise_error(ArgumentError)
+    end
+
+  end
+
+  context "records" do
+    tfile = Tempfile.new("mtbl-writer")
+    tpath = tfile.path
+    tfile.unlink
+    writer =  MTBL::Writer.new(tpath)
+
+    it "handles invalid adds" do
+      expect { writer.add(:invalid, "test") }.to raise_error(ArgumentError)
+      expect { writer.add("test", :invalid) }.to raise_error(ArgumentError)
+      expect { writer.add("test", 9000) }.to raise_error(ArgumentError)
+      expect { writer.add(400, "blah") }.to raise_error(ArgumentError)
+    end
+
+    it "accepts sequential keys" do
+      expect { writer.add("1000", "test1") }.to_not raise_error
+      expect { writer.add("1005", "test2") }.to_not raise_error
+      expect { writer.add("1010", "test3") }.to_not raise_error
+    end
+
+    it "does not accept non-sequential keys" do
+      expect { writer.add("1001", "test1") }.to raise_error(RuntimeError)
+      expect { writer.add("1004", "test1") }.to raise_error(RuntimeError)
+      expect { writer.add("1009", "test1") }.to raise_error(RuntimeError)
+    end
+
+    File.unlink(tpath)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,96 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: ruby-mtbl
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- HD Moore
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-06 00:00:00.000000000 Z
+dependencies: []
+description: The ruby-mtbl gem provides a Ruby interface to Farsight Security's MTBL
+  SortedString library.
+email: x@hdm.io
+executables:
+- rmtbl_create
+- rmtbl_dump
+- rmtbl_info
+extensions:
+- ext/mtbl/extconf.rb
+extra_rdoc_files: []
+files:
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/rmtbl_create
+- bin/rmtbl_dump
+- bin/rmtbl_info
+- examples/test.rb
+- examples/test1.mtbl
+- ext/mtbl/extconf.rb
+- ext/mtbl/ruby-mtbl.c
+- ruby-mtbl.gemspec
+- spec/mtbl_reader_spec.rb
+- spec/mtbl_sorter_spec.rb
+- spec/mtbl_spec.rb
+- spec/mtbl_utils_spec.rb
+- spec/mtbl_writer_spec.rb
+- spec/spec_helper.rb
+homepage: https://www.github.com/hdm/ruby-mtbl
+licenses:
+- Apache-2.0
+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.5.2
+signing_key: 
+specification_version: 4
+summary: 'ruby-mtbl: Ruby interface to the MTBL SortedString library'
+test_files: []