freegeoip-api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8f71b838799971f42f7256a31e6cba90cdabc8d8f4520d344481e1d29ce380e0
+  data.tar.gz: c63f6cbe06ca800419d1a939d410b38fcc0fab693beec9d2be0401d302b2e179
+SHA512:
+  metadata.gz: 5b716d662429c91d4fca558076c1efa46664a1ed58204a273237c14da0a0e5a48db167aae85a018e1cd9f3bf8b8c8b0407bdbd7eafe32dce7c974b28e096d6a0
+  data.tar.gz: '0339cd0bf0fa693e172932ef239640426e2e470f8d0e875e7cc2ebcf835b7b928c4be8f820d29c37ea8a5928c7fff224e20bcfc7df1e6cf3545c7ed815519995'

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,2 @@
+AllCops:
+  NewCops: enable

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in freegeoip.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Muhammad Khan
+
+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.md

@@ -0,0 +1,86 @@
+# Freegeoip Ruby
+
+A Ruby library for the [Freegeoip API](https://freegeoip.app).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'freegeoip-api'
+```
+
+And then execute:
+
+```bash
+bundle
+```
+
+Or install it yourself as:
+
+```bash
+gem install freegeoip-api
+```
+
+## Usage
+
+Anywhere in your code
+
+```ruby
+require 'freegeoip'
+
+Freegeoip.get('google.com')
+ => #<Freegeoip::Response:0x007f9552bb9ba0
+     @remote="google.com",
+     @ip="172.217.7.14",
+     @country_code="US",
+     @country_name="United States",
+     @region_code="CA",
+     @region_name="California",
+     @city="Mountain View",
+     @zip_code="94043",
+     @time_zone="America/Los_Angeles",
+     @latitude=37.4192,
+     @longitude=-122.0574,
+     @metro_code=807>
+```
+
+In the command line
+
+```bash
+$ freegeoip get google.com
+Searching for: google.com
+------------------------
+IP: 172.217.5.14
+Country code: US
+Country name: United States
+Region code: CA
+Region name: California
+City: Mountain View
+ZIP Code: 94043
+Time zone: America/Los_Angeles
+Latitude: 37.4192
+Longitude: -122.0574
+Metro code: 807
+```
+
+## 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub.
+This project is intended to be a safe, welcoming
+space for collaboration, and contributors are
+expected to adhere to basic human decency.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Credits
+
+> This codebase is very much a modified version of <https://github.com/TheNaoX/freegeoip>

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'freegeoip'
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/freegeoip

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'freegeoip'
+
+case ARGV[0]
+when 'get'
+  remote = ARGV[1]
+
+  puts "Searching for: #{remote}"
+  puts '------------------------'
+
+  response = Freegeoip.get(remote)
+
+  puts "IP: #{response.ip}"
+  puts "Country code: #{response.country_code}"
+  puts "Country name: #{response.country_name}"
+  puts "Region code: #{response.region_code}"
+  puts "Region name: #{response.region_name}"
+  puts "City: #{response.city}"
+  puts "ZIP Code: #{response.zip_code}"
+  puts "Time zone: #{response.time_zone}"
+  puts "Latitude: #{response.latitude}"
+  puts "Longitude: #{response.longitude}"
+  puts "Metro code: #{response.metro_code}"
+else
+  puts 'Unknown command, usage: freegeoip get [IP|DOMAIN]'
+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/freegeoip.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'freegeoip/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'freegeoip-api'
+  spec.version       = Freegeoip::VERSION
+  spec.authors       = ['MBM_1607']
+  spec.email         = ['muhammadkhan1607@gmail.com']
+
+  spec.summary       = 'Ruby library for interacting with the freegeoip.app API'
+  spec.description   = 'This gem will help you access the freegeoip.app API from your ruby code'
+  spec.homepage      = 'https://github.com/MBM1607/freegeoip-api'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+    spec.metadata['rubygems_mfa_required'] = 'true'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+          'public gem pushes.'
+  end
+
+  spec.required_ruby_version = '>= 2.7.4'
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = ['freegeoip']
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 2.3.11'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.11'
+end

data/lib/freegeoip/request.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'uri'
+require 'net/http'
+
+module Freegeoip
+  # Class to contain main request making logic to api.freegeoip.app
+  class Request
+    ENDPOINT = 'https://api.freegeoip.app/json'
+
+    attr_reader :remote
+
+    def initialize(remote, api_key)
+      @remote = remote
+      @api_key = api_key
+    end
+
+    def get
+      uri = URI("#{ENDPOINT}/#{remote}?apikey=#{@api_key}")
+      res = Net::HTTP.get(uri)
+
+      JSON.parse(res)
+    end
+  end
+end

data/lib/freegeoip/response.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Freegeoip
+  #  Class to contain main api response parsing
+  class Response
+    attr_reader :remote, :ip, :country_code, :country_name,
+                :region_code, :region_name, :city, :zip_code,
+                :time_zone, :latitude, :longitude, :metro_code
+
+    def initialize(remote, data)
+      @remote = remote
+      data.each do |key, value|
+        instance_variable_set "@#{key}", value
+      end
+    end
+  end
+end

data/lib/freegeoip/version.rb

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

data/lib/freegeoip.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'freegeoip/version'
+require 'freegeoip/request'
+require 'freegeoip/response'
+require 'helpers/configuration'
+
+# Main gem module
+module Freegeoip
+  extend Configuration
+
+  define_setting :api_key, 'XXXXXXXXX'
+
+  def self.get(remote)
+    request = Request.new(remote, Freegeoip.api_key)
+    Response.new(remote, request.get)
+  end
+end

data/lib/helpers/configuration.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# rubocop:disable Style/ClassVars
+
+# Module for configuration to allow fancy modification for gem users
+# https://www.viget.com/articles/easy-gem-configuration-variables-with-defaults/
+module Configuration
+  def configuration
+    yield self
+  end
+
+  def define_setting(name, default = nil)
+    class_variable_set("@@#{name}", default)
+
+    define_class_method "#{name}=" do |value|
+      class_variable_set("@@#{name}", value)
+    end
+
+    define_class_method name do
+      class_variable_get("@@#{name}")
+    end
+  end
+
+  private
+
+  def define_class_method(name, &block)
+    (class << self; self; end).instance_eval do
+      define_method name, &block
+    end
+  end
+end
+
+# rubocop:enable Style/ClassVars

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: freegeoip-api
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- MBM_1607
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.11
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.11'
+description: This gem will help you access the freegeoip.app API from your ruby code
+email:
+- muhammadkhan1607@gmail.com
+executables:
+- freegeoip
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/freegeoip
+- bin/setup
+- freegeoip.gemspec
+- lib/freegeoip.rb
+- lib/freegeoip/request.rb
+- lib/freegeoip/response.rb
+- lib/freegeoip/version.rb
+- lib/helpers/configuration.rb
+homepage: https://github.com/MBM1607/freegeoip-api
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.4
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Ruby library for interacting with the freegeoip.app API
+test_files: []