platphorm-maxmind-db 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: afa321d993ccbd95470fe663eac2dfca5e2faa6058beb561bfcdf2bbcc04af5e
+  data.tar.gz: 02d8c493ec7bce8b7c908033db69c21a9354ba38faa7679a8c863ab64a303600
+SHA512:
+  metadata.gz: 60cbfff8d83edbe6fe9b57d2ad34040ad7fdf644a4af754771c88175acc7e3d145876055f31cce0d7f267b5db7319bb35f128668434bfe660f81e19542843ab6
+  data.tar.gz: a6c4d15c5d1c61acc3c7e781cefc4cc0533e35b14d4811477c6caef7f40e354c68b13e4c6a6f57a4f0930f6f96194480d22e5f3356e1d0a5863f430adcc0b437

data/CHANGELOG.md

@@ -0,0 +1,25 @@
+# Changelog
+
+## 1.1.1
+
+* Fixed the memory reader's inspect method to no longer attempt to modify a
+  frozen string. Pull request by Tietew. GitHub #35.
+
+## 1.1.0 (2020-01-08)
+
+* The method `get_with_prefix_length` was added. This method returns both
+  the record and the network prefix length associated with the record in
+  the database.
+* Simplified a check for whether to return early in the decoder. Pull
+  request by Ivan Palamarchuk. GitHub #12.
+* Support for Ruby 2.3 was dropped since it is now end of life.
+
+## 1.0.0 (2019-01-04)
+
+* We no longer include the database's buffer in inspect output. This avoids
+  showing excessive output when creating a memory reader in irb. Reported
+  by Wojciech Wnętrzak. GitHub #6.
+
+## 1.0.0.beta (2018-12-24)
+
+* Initial implementation.

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'minitest', group: :development
+gem 'rake', group: :development

data/Gemfile.lock

@@ -0,0 +1,15 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.14.0)
+    rake (13.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest
+  rake
+
+BUNDLED WITH
+   1.14.6

data/LICENSE-APACHE

@@ -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/LICENSE-MIT

@@ -0,0 +1,17 @@
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.dev.md

@@ -0,0 +1,34 @@
+# How to release
+* Update dependencies and commit: `bundle update`
+* Update changelog and set release date
+* Bump version in `maxmind-db.gemspec`
+* Commit: `git commit -m v1.0.0`
+* Tag: `git tag -a v1.0.0 -m v1.0.0`
+* Clean up to be sure nothing stray gets into gem: `git clean -dxff`
+* Create `.gem` file: `gem build maxmind-db.gemspec`
+* Complete prerequisites (see below)
+* Upload to rubygems.org: `gem push maxmind-db-1.0.0.gem`
+* Push: `git push`
+* Push tag: `git push --tags`
+* Double check it looks okay at https://rubygems.org/gems/maxmind-db and
+  https://www.rubydoc.info/gems/maxmind-db
+
+
+# Prerequisites
+
+## Step 1
+Sign up for an account at rubygems.org if you don't have one.
+
+Enable multi factor authentication.
+
+
+## Step 2
+Ask someone who is an owner of the gem to add you as one.
+
+They do this by using the `gem owner` command
+([docs](https://guides.rubygems.org/command-reference/#gem-owner)).
+
+
+## Step 3
+Go to your rubygems.org profile and find the curl command to run to
+download your API key.

data/README.md

@@ -0,0 +1,63 @@
+# MaxMind DB Reader Ruby API
+
+## Description
+
+This is the Ruby API for reading [MaxMind
+DB](https://maxmind.github.io/MaxMind-DB/) files. MaxMind DB is a binary
+file format that stores data indexed by IP address subnets (IPv4 or IPv6).
+
+
+## Installation
+
+```
+gem install maxmind-db
+```
+
+## Usage
+
+```ruby
+require 'maxmind/db'
+
+reader = MaxMind::DB.new('GeoIP2-City.mmdb', mode: MaxMind::DB::MODE_MEMORY)
+
+record = reader.get('1.1.1.1')
+if record.nil?
+  puts '1.1.1.1 was not found in the database'
+else
+  puts record['country']['iso_code']
+  puts record['country']['names']['en']
+end
+
+reader.close
+```
+
+For more information see the
+[documentation](https://www.rubydoc.info/gems/maxmind-db).
+
+## Requirements
+
+This code requires Ruby version 2.4 or higher.
+
+## Contributing
+
+Patches and pull requests are encouraged. Please include unit tests
+whenever possible.
+
+## Support
+
+Please report all issues with this code using the [GitHub issue
+tracker](https://github.com/maxmind/MaxMind-DB-Reader-ruby/issues).
+
+If you are having an issue with a MaxMind service that is not specific to the
+client API, please see [our support page](https://www.maxmind.com/en/support).
+
+## Versioning
+
+This library uses [Semantic Versioning](https://semver.org/).
+
+## Copyright and License
+
+This software is Copyright (c) 2018 - 2020 by MaxMind, Inc.
+
+This is free software, licensed under the [Apache License, Version
+2.0](LICENSE-APACHE) or the [MIT License](LICENSE-MIT), at your option.

data/Rakefile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+task default: :test

data/bin/mmdb-benchmark.rb

@@ -0,0 +1,64 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'maxmind/db'
+
+def main
+  args = parse_args
+  return false if args.nil?
+
+  reader = MaxMind::DB.new(args[:database], mode: MaxMind::DB::MODE_MEMORY)
+  benchmark(reader, args[:ip_file])
+  true
+end
+
+def parse_args
+  if ARGV.length != 2
+    print_usage
+    return nil
+  end
+
+  database = ARGV[0]
+  ip_file  = ARGV[1]
+
+  {
+    database: database,
+    ip_file: ip_file,
+  }
+end
+
+def print_usage
+  # rubocop:disable Style/StderrPuts
+  STDERR.puts "Usage: #{$PROGRAM_NAME} <MMDB file> <IP file>"
+  STDERR.puts
+  STDERR.puts 'Benchmark by reading IPs from the IP file and looking up each one in the MMDB file.'
+  # rubocop:enable Style/StderrPuts
+end
+
+def benchmark(reader, file)
+  n = 0
+  count = 200_000
+  start = Time.now.to_f
+  File.open(file) do |fh|
+    fh.each do |line|
+      n += 1
+      line.strip!
+
+      reader.get(line)
+
+      write_status(start, n) if n % 1000 == 0
+      break if n == count
+    end
+  end
+end
+
+def write_status(start, count)
+  now = Time.now.to_f
+  elapsed = now - start
+  rate = 1.0 * count / elapsed
+  puts format('%d @ %.2f lookups per second (%d seconds elapsed)', count, rate, elapsed)
+end
+
+exit 0 if main
+
+exit 1