pure_mmdb 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: ee81a9604620a2b0900449b3f3cd065a063d4d040f491a9354af1aac7718642a
-  data.tar.gz: 1b37dacbf6496bd6f24c442f4d4b131f60acf930c9abad6e6191afeab9ae93f4
+SHA1:
+  metadata.gz: d0010e9343a3b56eb03d19206b390f02ec7b3e42
+  data.tar.gz: cab205542fbf0509a112424350449242f5161c12
 SHA512:
-  metadata.gz: a5e643c8666abbf5ed503f9892d3a014982de48eec013c30ebad213cbe36bcb40b57f8fa50127fd5aab4e97e19b113558d086dace89c6b8cfeeacff6a58699ae
-  data.tar.gz: f2f71adbf1f3fe81fea7c1585c631bf316b1112c500237807e4dcb481159886f1db9323dfb6d7d729b0ce6874aa4ac6cdc53fd2c3922fd1ae12d545e5ec80f3a
+  metadata.gz: b86efda039d51dec77abda477a507b54f5ff1e57b381fadd4c3ab12aed9b6d032e4108b62a9635e1a04ae1de8af14eeb7aa63cace07dad90cfaa92122d679b70
+  data.tar.gz: fe9c616737556a8afe3b734c7fae57b55bedbdf04cac6f7cfc879da4eb0948bafe2ed61b6b66a6bdfabd11c88b45114f9d0ddc367bea478ae8df53ac147b3497

data/.gitignore

@@ -11,3 +11,5 @@
 .rspec_status
 
 spec/data/GeoLite*.mmdb
+
+*.gem

data/.travis.yml

@@ -1,5 +1,19 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=d216d9599c37e222d9ef67dca792a7046dc352a887c8ef4ad8b2ab547bed92fe
 sudo: false
 language: ruby
 rvm:
+  - 2.3.0
+  - 2.4.0
   - 2.5.0
 before_install: gem install bundler -v 1.16.1
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rake
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mmdb (0.1.0)
+    pure_mmdb (0.2.0)
 
 GEM
   remote: https://rubygems.org/
@@ -36,8 +36,8 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.16)
-  mmdb!
   pry-byebug (~> 3.0)
+  pure_mmdb!
   rake (~> 10.0)
   rspec (~> 3.0)
 

data/README.md

@@ -1,15 +1,19 @@
-# Mmdb
+# MaxMindDB
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/mmdb`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Gem Version](https://badge.fury.io/rb/pure_mmdb.svg)](https://badge.fury.io/rb/pure_mmdb)
+[![Build Status](https://travis-ci.org/trevorrjohn/mmdb.svg?branch=master)](https://travis-ci.org/trevorrjohn/mmdb)
+[![Maintainability](https://api.codeclimate.com/v1/badges/7eb3d3e1389a8c16a2da/maintainability)](https://codeclimate.com/github/trevorrjohn/mmdb/maintainability)
 
-TODO: Delete this and the text above, and describe your gem
+The purpose of this gem is to implement the [MaxMindDB File Format](http://maxmind.github.io/MaxMind-DB/) in Ruby. 
+
+The gem is highly influenced by the implementation of the [MaxMindDB gem](https://github.com/yhirose/maxminddb) and I have to give a lot of credit to that project.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'mmdb'
+gem 'pure_mmdb'
 ```
 
 And then execute:
@@ -18,11 +22,38 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install mmdb
+    $ gem install pure_mmdb
 
 ## Usage
 
-TODO: Write usage instructions here
+### Configuration
+
+To configure the gem, simply set the `file_path` in the configure block.
+
+```ruby
+Mmdb.configure do |c|
+  c.file_path = '/path/to/db.mmdb'
+end
+Mmdb.query('192.168.1.1')
+#=> { 'data' => 'hash' }
+```
+
+### Multiple Database Files
+
+If you need to have multiple database files you can query each file individually after specifying the files. You can configure as many database files as you like. The database will only be loaded into memory once it is queried.
+
+```ruby
+Mmdb.configure do |c|
+  c.files = {
+    vpn: 'path to vpn.mmdb',
+    location: 'path to location.mmdb'
+  }
+end
+Mmdb.lookup('192.168.1.1', file_key: :vpn)
+#=> { 'data' => 'vpn data' }
+Mmdb.lookup('192.168.1.1', file_key: :location)
+#=> { 'data' => 'location data' }
+```
 
 ## Development
 
@@ -32,12 +63,11 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/mmdb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
-
+Bug reports and pull requests are welcome on GitHub at https://github.com/trevorrjohn/mmdb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.  
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
 ## Code of Conduct
 
-Everyone interacting in the Mmdb project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/mmdb/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Mmdb project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/trevorrjohn/mmdb/blob/master/CODE_OF_CONDUCT.md).

data/lib/mmdb/configuration.rb

@@ -1,5 +1,11 @@
 module Mmdb
   class Configuration
-    attr_accessor :file_path
+    DEFAULT_FILE_KEY = :file
+
+    attr_accessor :files
+
+    def file_path=(file_path)
+      @files = { DEFAULT_FILE_KEY => file_path }
+    end
   end
 end

data/lib/mmdb/version.rb

@@ -1,3 +1,3 @@
 module Mmdb
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/mmdb.rb

@@ -17,19 +17,28 @@ module Mmdb
 
     def reset
       @config = Configuration.new
-      @db = nil
+      @databases = nil
     end
 
-    def query(ip)
-      Query.new(db: db, ip: ip).fetch
+    def query(ip, file_key: Configuration::DEFAULT_FILE_KEY)
+      Query.new(db: db_for_key(file_key), ip: ip).fetch
     end
 
     private
 
-    attr_reader :db
+    attr_reader :databases
 
-    def db
-      @db ||= DB.new(config.file_path)
+    def db_for_key(file_key)
+      databases[file_key].tap do |db|
+        raise DatabaseNotFound if db.nil?
+      end
+    end
+
+    def databases
+      @databases ||=
+        config.files.map do |key, file_path|
+          [key, DB.new(file_path)]
+        end.to_h
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pure_mmdb
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Trevor John
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-23 00:00:00.000000000 Z
+date: 2018-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -113,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: This is a ruby implementation of the MaxMindDB file format