dbip_util 0.1.0.2025.07

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: aaaa32a97d1442cbb719e80a4e9b807f0a08c4c8a302f98977a6461c726ca740
+  data.tar.gz: daa998a114a3b13c8036e91da64b6ab9972b8a637dda67ab2df0bd035ae5474b
+SHA512:
+  metadata.gz: 61549e7205ef41e77e5bd4b6f8bf3c8b3939ca6d9191793530715ab8272a297c02ff1bb34e5e467d81f521b66de3af28a16938548a05d9d8de972943c37c58d5
+  data.tar.gz: 6d37b8e33fdd40045e92a5fcaf04f0a51cbcdfcc7cd28710f2352b983f3c967b2bbdabdb38aa706bd04e549f0ba2a12a3ac974b6dee27995d4025fc6767a81b7

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,271 @@
+AllCops:
+  TargetRubyVersion: 3.1
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+# We use an open method which has nothing to do with Kernel#open.
+Security/Open:
+  Enabled: false
+
+Gemspec/AddRuntimeDependency: # new in 1.65
+  Enabled: true
+Gemspec/DeprecatedAttributeAssignment: # new in 1.30
+  Enabled: true
+Gemspec/DevelopmentDependencies: # new in 1.44
+  Enabled: true
+Gemspec/RequireMFA: # new in 1.23
+  Enabled: true
+Layout/LineContinuationLeadingSpace: # new in 1.31
+  Enabled: true
+Layout/LineContinuationSpacing: # new in 1.31
+  Enabled: true
+Layout/LineEndStringConcatenationIndentation: # new in 1.18
+  Enabled: true
+Layout/SpaceBeforeBrackets: # new in 1.7
+  Enabled: true
+Lint/AmbiguousAssignment: # new in 1.7
+  Enabled: true
+Lint/AmbiguousOperatorPrecedence: # new in 1.21
+  Enabled: true
+Lint/AmbiguousRange: # new in 1.19
+  Enabled: true
+Lint/ArrayLiteralInRegexp: # new in 1.71
+  Enabled: true
+Lint/ConstantOverwrittenInRescue: # new in 1.31
+  Enabled: true
+Lint/ConstantReassignment: # new in 1.70
+  Enabled: true
+Lint/CopDirectiveSyntax: # new in 1.72
+  Enabled: true
+Lint/DeprecatedConstants: # new in 1.8
+  Enabled: true
+Lint/DuplicateBranch: # new in 1.3
+  Enabled: true
+Lint/DuplicateMagicComment: # new in 1.37
+  Enabled: true
+Lint/DuplicateMatchPattern: # new in 1.50
+  Enabled: true
+Lint/DuplicateRegexpCharacterClassElement: # new in 1.1
+  Enabled: true
+Lint/DuplicateSetElement: # new in 1.67
+  Enabled: true
+Lint/EmptyBlock: # new in 1.1
+  Enabled: true
+Lint/EmptyClass: # new in 1.3
+  Enabled: true
+Lint/EmptyInPattern: # new in 1.16
+  Enabled: true
+Lint/HashNewWithKeywordArgumentsAsDefault: # new in 1.69
+  Enabled: true
+Lint/IncompatibleIoSelectWithFiberScheduler: # new in 1.21
+  Enabled: true
+Lint/ItWithoutArgumentsInBlock: # new in 1.59
+  Enabled: true
+Lint/LambdaWithoutLiteralBlock: # new in 1.8
+  Enabled: true
+Lint/LiteralAssignmentInCondition: # new in 1.58
+  Enabled: true
+Lint/MixedCaseRange: # new in 1.53
+  Enabled: true
+Lint/NoReturnInBeginEndBlocks: # new in 1.2
+  Enabled: true
+Lint/NonAtomicFileOperation: # new in 1.31
+  Enabled: true
+Lint/NumberedParameterAssignment: # new in 1.9
+  Enabled: true
+Lint/NumericOperationWithConstantResult: # new in 1.69
+  Enabled: true
+Lint/OrAssignmentToConstant: # new in 1.9
+  Enabled: true
+Lint/RedundantDirGlobSort: # new in 1.8
+  Enabled: true
+Lint/RedundantRegexpQuantifiers: # new in 1.53
+  Enabled: true
+Lint/RedundantTypeConversion: # new in 1.72
+  Enabled: true
+Lint/RefinementImportMethods: # new in 1.27
+  Enabled: true
+Lint/RequireRangeParentheses: # new in 1.32
+  Enabled: true
+Lint/RequireRelativeSelfPath: # new in 1.22
+  Enabled: true
+Lint/SharedMutableDefault: # new in 1.70
+  Enabled: true
+Lint/SuppressedExceptionInNumberConversion: # new in 1.72
+  Enabled: true
+Lint/SymbolConversion: # new in 1.9
+  Enabled: true
+Lint/ToEnumArguments: # new in 1.1
+  Enabled: true
+Lint/TripleQuotes: # new in 1.9
+  Enabled: true
+Lint/UnescapedBracketInRegexp: # new in 1.68
+  Enabled: true
+Lint/UnexpectedBlockArity: # new in 1.5
+  Enabled: true
+Lint/UnmodifiedReduceAccumulator: # new in 1.1
+  Enabled: true
+Lint/UselessConstantScoping: # new in 1.72
+  Enabled: true
+Lint/UselessDefined: # new in 1.69
+  Enabled: true
+Lint/UselessNumericOperation: # new in 1.66
+  Enabled: true
+Lint/UselessRescue: # new in 1.43
+  Enabled: true
+Lint/UselessRuby2Keywords: # new in 1.23
+  Enabled: true
+Metrics/CollectionLiteralLength: # new in 1.47
+  Enabled: true
+Naming/BlockForwarding: # new in 1.24
+  Enabled: true
+Security/CompoundHash: # new in 1.28
+  Enabled: true
+Security/IoMethods: # new in 1.22
+  Enabled: true
+Style/AmbiguousEndlessMethodDefinition: # new in 1.68
+  Enabled: true
+Style/ArgumentsForwarding: # new in 1.1
+  Enabled: true
+Style/ArrayIntersect: # new in 1.40
+  Enabled: true
+Style/BitwisePredicate: # new in 1.68
+  Enabled: true
+Style/CollectionCompact: # new in 1.2
+  Enabled: true
+Style/CombinableDefined: # new in 1.68
+  Enabled: true
+Style/ComparableClamp: # new in 1.44
+  Enabled: true
+Style/ConcatArrayLiterals: # new in 1.41
+  Enabled: true
+Style/DataInheritance: # new in 1.49
+  Enabled: true
+Style/DigChain: # new in 1.69
+  Enabled: true
+Style/DirEmpty: # new in 1.48
+  Enabled: true
+Style/DocumentDynamicEvalDefinition: # new in 1.1
+  Enabled: true
+Style/EmptyHeredoc: # new in 1.32
+  Enabled: true
+Style/EndlessMethod: # new in 1.8
+  Enabled: true
+Style/EnvHome: # new in 1.29
+  Enabled: true
+Style/ExactRegexpMatch: # new in 1.51
+  Enabled: true
+Style/FetchEnvVar: # new in 1.28
+  Enabled: true
+Style/FileEmpty: # new in 1.48
+  Enabled: true
+Style/FileNull: # new in 1.69
+  Enabled: true
+Style/FileRead: # new in 1.24
+  Enabled: true
+Style/FileTouch: # new in 1.69
+  Enabled: true
+Style/FileWrite: # new in 1.24
+  Enabled: true
+Style/HashConversion: # new in 1.10
+  Enabled: true
+Style/HashExcept: # new in 1.7
+  Enabled: true
+Style/HashSlice: # new in 1.71
+  Enabled: true
+Style/IfWithBooleanLiteralBranches: # new in 1.9
+  Enabled: true
+Style/InPatternThen: # new in 1.16
+  Enabled: true
+Style/ItAssignment: # new in 1.70
+  Enabled: true
+Style/KeywordArgumentsMerging: # new in 1.68
+  Enabled: true
+Style/MagicCommentFormat: # new in 1.35
+  Enabled: true
+Style/MapCompactWithConditionalBlock: # new in 1.30
+  Enabled: true
+Style/MapIntoArray: # new in 1.63
+  Enabled: true
+Style/MapToHash: # new in 1.24
+  Enabled: true
+Style/MapToSet: # new in 1.42
+  Enabled: true
+Style/MinMaxComparison: # new in 1.42
+  Enabled: true
+Style/MultilineInPatternThen: # new in 1.16
+  Enabled: true
+Style/NegatedIfElseCondition: # new in 1.2
+  Enabled: true
+Style/NestedFileDirname: # new in 1.26
+  Enabled: true
+Style/NilLambda: # new in 1.3
+  Enabled: true
+Style/NumberedParameters: # new in 1.22
+  Enabled: true
+Style/NumberedParametersLimit: # new in 1.22
+  Enabled: true
+Style/ObjectThen: # new in 1.28
+  Enabled: true
+Style/OpenStructUse: # new in 1.23
+  Enabled: true
+Style/OperatorMethodCall: # new in 1.37
+  Enabled: true
+Style/QuotedSymbols: # new in 1.16
+  Enabled: true
+Style/RedundantArgument: # new in 1.4
+  Enabled: true
+Style/RedundantArrayConstructor: # new in 1.52
+  Enabled: true
+Style/RedundantConstantBase: # new in 1.40
+  Enabled: true
+Style/RedundantCurrentDirectoryInPath: # new in 1.53
+  Enabled: true
+Style/RedundantDoubleSplatHashBraces: # new in 1.41
+  Enabled: true
+Style/RedundantEach: # new in 1.38
+  Enabled: true
+Style/RedundantFilterChain: # new in 1.52
+  Enabled: true
+Style/RedundantFormat: # new in 1.72
+  Enabled: true
+Style/RedundantHeredocDelimiterQuotes: # new in 1.45
+  Enabled: true
+Style/RedundantInitialize: # new in 1.27
+  Enabled: true
+Style/RedundantInterpolationUnfreeze: # new in 1.66
+  Enabled: true
+Style/RedundantLineContinuation: # new in 1.49
+  Enabled: true
+Style/RedundantRegexpArgument: # new in 1.53
+  Enabled: true
+Style/RedundantRegexpConstructor: # new in 1.52
+  Enabled: true
+Style/RedundantSelfAssignmentBranch: # new in 1.19
+  Enabled: true
+Style/RedundantStringEscape: # new in 1.37
+  Enabled: true
+Style/ReturnNilInPredicateMethodDefinition: # new in 1.53
+  Enabled: true
+Style/SafeNavigationChainLength: # new in 1.68
+  Enabled: true
+Style/SelectByRegexp: # new in 1.22
+  Enabled: true
+Style/SendWithLiteralMethodName: # new in 1.64
+  Enabled: true
+Style/SingleLineDoEndBlock: # new in 1.57
+  Enabled: true
+Style/StringChars: # new in 1.12
+  Enabled: true
+Style/SuperArguments: # new in 1.64
+  Enabled: true
+Style/SuperWithArgsParentheses: # new in 1.58
+  Enabled: true
+Style/SwapValues: # new in 1.1
+  Enabled: true
+Style/YAMLFileRead: # new in 1.53
+  Enabled: true

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-07-14
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,38 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 hmdne
+
+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.
+
+---------------------------------------------------------------------------
+
+This gem contains database that is licensed under a following license:
+
+The free IP to City Lite database by DB-IP is licensed under a
+Creative Commons Attribution 4.0 International License.
+
+You are free to use this IP to City Lite database in your application,
+provided you give attribution to DB-IP.com for the data.
+
+In the case of a web application, you must include a link back to
+DB-IP.com on pages that display or use results from the database.
+You may do it by pasting the HTML code snippet below into your code :
+
+<a href='https://db-ip.com'>IP Geolocation by DB-IP</a>
+

data/README.md

@@ -0,0 +1,71 @@
+# DbipUtil
+
+DbipUtil includes DB-IP Lite databases and a simple interface to them, based on `maxmind-db` gem.
+
+The included databases are refreshed automatically. A GitHub Actions workflow runs `bin/dbiputil-refresh` and then `rake release` at **00:45 GMT+1 on the 15th of every month** to publish a new gem version. Ensure to comply with the database licensing terms below in this document.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add dbip_util
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install dbip_util
+```
+
+## Usage
+
+```ruby
+record = DbipUtil::Country.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
+
+# Also: DbipUtil::ASN, DbipUtil::City
+```
+
+This gem uses a `maxmind-db` gem. More documentation is provided by said gem: https://www.rubydoc.info/gems/maxmind-db
+
+The databases are documented here:
+
+- https://db-ip.com/db/format/ip-to-country-lite/mmdb.html
+- https://db-ip.com/db/format/ip-to-city-lite/mmdb.html
+- https://db-ip.com/db/format/ip-to-asn-lite/mmdb.html
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. If you need to trigger a release manually, run `bin/dbiputil-refresh` and then `bundle exec rake release`. This will create a git tag for the version, push commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rbutils/dbip_util.
+
+## License
+
+The code inside this gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+Note that this gem contains DB-IP Lite databases. The license terms of those databases are as follows:
+
+```
+The free IP to City Lite database by DB-IP is licensed under a
+Creative Commons Attribution 4.0 International License.
+
+You are free to use this IP to City Lite database in your application,
+provided you give attribution to DB-IP.com for the data.
+
+In the case of a web application, you must include a link back to
+DB-IP.com on pages that display or use results from the database.
+You may do it by pasting the HTML code snippet below into your code :
+
+<a href='https://db-ip.com'>IP Geolocation by DB-IP</a>
+```

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "dbip_util"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "irb"
+IRB.start(__FILE__)

data/bin/dbiputil-refresh

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+
+Dir.chdir "#{__dir__}/../lib/dbip_util" do
+  date = Time.now.strftime("%Y-%m")
+  date_ver = date.gsub("-", ".")
+
+  system "rm -rf db"
+  system "mkdir db"
+  Dir.chdir "db" do
+    %i[country city asn].each do |type|
+      system <<~SH
+        curl 'https://download.db-ip.com/free/dbip-#{type}-lite-#{date}.mmdb.gz' |
+          gunzip -c > dbip-#{type}-lite.mmdb
+      SH
+    end
+  end
+
+  # Version bump
+  version_file = File.read("version.rb")
+  version_file = version_file.gsub(/DB_VERSION = .*/, %(DB_VERSION = "#{date_ver}"))
+  File.write("version.rb", version_file)
+end

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/dbip_util/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module DbipUtil
+  DB_VERSION = "2025.07"
+  VERSION = "0.1.0.#{DB_VERSION}".freeze
+end

data/lib/dbip_util.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "dbip_util/version"
+require "maxmind/db"
+
+# DbipUtil includes DB-IP Lite databases and a simple interface to them, based on `maxmind-db` gem.
+module DbipUtil
+  extend self
+
+  def open(db, options = {})
+    ensure_provisioned!
+
+    options = { mode: MaxMind::DB::MODE_FILE }.merge(options)
+    fn = db_path(db)
+    MaxMind::DB.new(fn, options)
+  end
+
+  def const_missing(const)
+    case const
+    when :Country
+      const_set(const, open(:country))
+    when :City
+      const_set(const, open(:city))
+    when :ASN
+      const_set(const, open(:asn))
+    else
+      super
+    end
+  end
+
+  private
+
+  def db_path(db)
+    __dir__ + "/dbip_util/db/dbip-#{db}-lite.mmdb"
+  end
+
+  def ensure_provisioned!
+    # Check for a sample database. If not present, provision it.
+    system "#{__dir__}/../bin/dbiputil-refresh" unless File.exist?(db_path(:country))
+  rescue StandardError
+    warn "Couldn't provision a database! Use a `dbip_util` gem from Rubygems, as it includes a database."
+    raise
+  end
+end

data/sig/dbip_util/version.rbs

@@ -0,0 +1,5 @@
+module DbipUtil
+  DB_VERSION: "2025.07"
+
+  VERSION: ::String
+end

data/sig/dbip_util.rbs

@@ -0,0 +1,16 @@
+# DbipUtil includes DB-IP Lite databases and a simple interface to them, based on `maxmind-db` gem.
+module DbipUtil
+  extend ::DbipUtil
+
+  def open: (Symbol db, ?::Hash[Symbol, untyped] options) -> MaxMind::DB
+  def const_missing: (Symbol const) -> MaxMind::DB
+
+  private
+
+  def db_path: (Symbol db) -> String
+  def ensure_provisioned!: () -> untyped
+
+  AST: MaxMind::DB
+  City: MaxMind::DB
+  Country: MaxMind::DB
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: dbip_util
+version: !ruby/object:Gem::Version
+  version: 0.1.0.2025.07
+platform: ruby
+authors:
+- hmdne
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: maxmind-db
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+email:
+- 54514036+hmdne@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/dbiputil-refresh
+- bin/setup
+- lib/dbip_util.rb
+- lib/dbip_util/db/dbip-asn-lite.mmdb
+- lib/dbip_util/db/dbip-city-lite.mmdb
+- lib/dbip_util/db/dbip-country-lite.mmdb
+- lib/dbip_util/version.rb
+- sig/dbip_util.rbs
+- sig/dbip_util/version.rbs
+homepage: https://github.com/rbutils/dbip_util
+licenses:
+- MIT + CC-BY-4.0
+metadata:
+  homepage_uri: https://github.com/rbutils/dbip_util
+  source_code_uri: https://github.com/rbutils/dbip_util
+  changelog_uri: https://github.com/rbutils/dbip_util/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: DbipUtil includes DB-IP Lite databases and a simple interface to them, based
+  on `maxmind-db` gem
+test_files: []