ipcheck 0.1.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab23a1a2feb30858b30bc2fee4aedb743431e2ef68722105b91a2fcef650f999
-  data.tar.gz: b8a4917f735aee92c27781742e9b9b72d9436be60d9e13c13d979da538f887f8
+  metadata.gz: 5d45c3ce454d64a2c69607e152f42be6827729531a8b509f5ac0295588146b68
+  data.tar.gz: 862ef643791b14b4fc13c0b37a391fafcfe0eb605dcb9d911267a8bb0ea5f498
 SHA512:
-  metadata.gz: f51756748210a991579a2d02b262589be8f1adec376a1ccfef56e11bcd91acd1b9a696016f5484433e540fe2549e943a6da612710bab31121c0d8265776cf7fa
-  data.tar.gz: e09900c0fb4d7afdc78b4a2a2840f167ac69ab957bc172b6c48aefa0d549463ea15fd03c710b1eea748ea2c32bb20f8fa0afc11ef8f8a3f6586f11eadc413e64
+  metadata.gz: 6cef0cbcfe3d9c57743ab0e3ed5698517c22e017708722dbc31ee40badb5cc0a0cb27b73dd8c41ae068a9d8ca0fef1b9ada5185c4e4ad03d003684727a34e098
+  data.tar.gz: ea219e042de3e94a32a79ee475637bbf0a23c38712226f406833211e07a94f70dbf8c77ef314d77f1425a1c8c5e8c12521267cdb16f87035d747c4dd8c160820

data/.github/workflows/main.yml

@@ -0,0 +1,27 @@
+name: Ruby
+
+on:
+  push:
+    branches:
+      - main
+
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Ruby ${{ matrix.ruby }}
+    strategy:
+      matrix:
+        ruby:
+          - '3.0.0'
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Run the default task
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+coverage
+.DS_Store

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,20 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.0.0
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  AllowedMethods: ['describe', 'context']

data/Gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ipcheck.gemspec
+gemspec
+
+gem 'nokogiri-happymapper', require: 'happymapper'
+gem 'rake', '~> 13.0'
+gem 'rubocop', '~> 1.21'
+
+group :test do
+  gem 'rspec', '~> 3.0'
+  gem 'simplecov', require: false
+  gem 'webmock'
+end

data/Gemfile.lock

@@ -0,0 +1,89 @@
+PATH
+  remote: .
+  specs:
+    ipcheck (1.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.6)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    bigdecimal (3.1.6)
+    crack (1.0.0)
+      bigdecimal
+      rexml
+    diff-lcs (1.5.1)
+    docile (1.4.0)
+    hashdiff (1.1.0)
+    json (2.7.1)
+    language_server-protocol (3.17.0.3)
+    mini_portile2 (2.8.5)
+    nokogiri (1.16.2)
+      mini_portile2 (~> 2.8.2)
+      racc (~> 1.4)
+    nokogiri-happymapper (0.10.0)
+      nokogiri (~> 1.5)
+    parallel (1.24.0)
+    parser (3.3.0.5)
+      ast (~> 2.4.1)
+      racc
+    public_suffix (5.0.4)
+    racc (1.7.3)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    regexp_parser (2.9.0)
+    rexml (3.2.6)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.0)
+    rubocop (1.60.2)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    unicode-display_width (2.5.0)
+    webmock (3.20.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ipcheck!
+  nokogiri-happymapper
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  simplecov
+  webmock
+
+BUNDLED WITH
+   2.5.6

data/README.md

@@ -0,0 +1,45 @@
+# Ipcheck
+
+![Gem Version](https://img.shields.io/gem/v/ipcheck)
+[![Ruby](https://github.com/EvanBrightside/ipcheck/actions/workflows/main.yml/badge.svg)](https://github.com/EvanBrightside/ipcheck/actions/workflows/main.yml)
+
+This gem allows you to obtain information via IP - for example, country, city, coordinates.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ipcheck'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install ipcheck
+
+## Usage
+
+```ruby
+my_ip = Ipcheck.my_ip # 169.254.1.2
+
+ip_meta = Ipcheck.lookup('8.8.8.8')
+ip_meta.city # Ashburn
+ip_meta.country # United States
+ip_meta.countryCode # US
+ip_meta.lat # 39.03
+ip_meta.lon # -77.5
+```
+
+## 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`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git 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/EvanBrightside/ipcheck.

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 'ipcheck'
+
+# 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/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/ipcheck.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative 'lib/ipcheck/version'
+
+Gem::Specification.new do |spec|
+  spec.name                  = 'ipcheck'
+  spec.version               = Ipcheck::VERSION
+  spec.authors               = ['Ivan Zabrodin']
+  spec.email                 = ['xvanx84@gmail.com']
+  spec.summary               = 'Check IP geolocation'
+  spec.description           = 'Check IP geolocation with https://ip-api.com'
+  spec.homepage              = 'https://github.com/EvanBrightside/ipcheck'
+  spec.required_ruby_version = '>= 3.0.0'
+
+  spec.metadata = {
+    'rubygems_mfa_required' => 'true',
+    'source_code_uri' => 'https://github.com/EvanBrightside/ipcheck',
+    'changelog_uri' => 'https://github.com/EvanBrightside/ipcheck'
+  }
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+end

data/lib/ipcheck/metadata.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'happymapper'
+
+module Ipcheck
+  class Metadata
+    include HappyMapper
+
+    tag 'query'
+    element :city, String, tag: 'city'
+    element :country, String, tag: 'country'
+    element :countryCode, String, tag: 'countryCode'
+    element :lat, Float, tag: 'lat'
+    element :lon, Float, tag: 'lon'
+  end
+end

data/lib/ipcheck/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Ipcheck
+  VERSION = '1.1.0'
+end

data/lib/ipcheck.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'open-uri'
+require_relative 'ipcheck/version'
+require_relative 'ipcheck/metadata'
+
+module Ipcheck
+  class Error < StandardError; end
+
+  def self.lookup(ip_address)
+    return raise Error, 'Invalid IP address format' unless ip_address.match?(/\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}/)
+
+    url = "http://ip-api.com/xml/#{ip_address}"
+    response = URI.parse(url).read
+    Metadata.parse(response)
+  end
+
+  def self.my_ip
+    url = 'https://api64.ipify.org'
+    URI.parse(url).read
+  end
+end

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: ipcheck
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Ivan Zabrodin
 autorequire:
-bindir: bin
+bindir: exe
 cert_chain: []
 date: 2024-02-12 00:00:00.000000000 Z
 dependencies: []
@@ -16,7 +16,21 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ipcheck.gemspec
+- lib/ipcheck.rb
+- lib/ipcheck/metadata.rb
+- lib/ipcheck/version.rb
 homepage: https://github.com/EvanBrightside/ipcheck
 licenses: []
 metadata: