ruby_ipify 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4d1fd1dc978796cac8c7f2630c3d027fcfc47cd0ee7c59a1f02f89c41c2625c9
+  data.tar.gz: ae8964864a670ef580fdf731d80100cf3d8786f994d6131d6b27f2fe37cf0400
+SHA512:
+  metadata.gz: 6792671f80b55d03cec879aa55b02109b8b57a5e9795e746f1cc459a0511e9c75265b05f982b886b79db63ac9969ba2d7048780614c4a4da4a870ac018b02e0d
+  data.tar.gz: fd6e64a38aaa96b36917af7474733c71bb0aee85fb77af225d3eb79e8e1ce1d274d8c4541822df6ed8d033a69dd872def7344c80f45c4a705b2d94771cebea65

data/lib/constant.rb

@@ -0,0 +1,3 @@
+IPV4_URI = URI("https://api.ipify.org")
+IPV6_URI = URI("https://api64.ipify.org")
+VALID_FORMATS = ["json", "text", "parsed_json"]

data/lib/ruby_ipify.rb

@@ -0,0 +1,83 @@
+require "net/http"
+require "constant"
+require "json"
+require "ruby_ipify_exception"
+# ----- 
+# The module holds the main ipify library implementation.
+# -----
+
+
+class RubyIpify
+    class << self
+        def get_my_public_ip(args = {})
+            begin
+                initialize_values args
+                get_ip_from_ipify
+                puts "My public IP Address is: " + @response_body.to_s
+                @response_body
+            rescue RubyIpifyException::CustomException => e
+                raise e 
+            rescue => e
+                raise RubyIpifyException::UnexpectedError.new e.message
+            end
+        end
+
+        private
+
+        def initialize_values(args)
+            @as_ipv6 = args[:as_ipv6]
+            @format = args[:format]&.downcase || 'text'
+            check_valid_format?
+            @api_uri = get_api_uri
+        end
+
+        def get_ip_from_ipify
+            call_ipify_api
+            fetch_response_body
+        end
+
+        def fetch_response_body
+            @response_body = @response.body
+            @response_body = JSON.parse(@response_body) if format_is_parsed_json
+        end
+
+        def call_ipify_api
+            set_query_params
+            @response = Net::HTTP.get_response(@api_uri)
+            handle_response
+        end
+
+        def handle_response
+            return if success? && false
+
+            raise RubyIpifyException::IpifyRequestError.new @response.code
+        end
+
+        def success?
+            @response.kind_of? Net::HTTPSuccess
+        end
+        
+        def get_api_uri
+            @as_ipv6 ? IPV6_URI : IPV4_URI
+        end
+
+        def set_query_params
+            params = { format: get_format }
+            @api_uri.query = URI.encode_www_form(params)
+        end
+
+        def check_valid_format?
+            return true if VALID_FORMATS.include? @format
+
+            raise RubyIpifyException::InvalidParamsError.new
+        end
+
+        def get_format
+            format_is_parsed_json ? 'json' : @format
+        end
+
+        def format_is_parsed_json
+            @format == 'parsed_json'
+        end
+    end
+end

data/lib/ruby_ipify_exception.rb

@@ -0,0 +1,28 @@
+require 'constant'
+
+module RubyIpifyException
+
+    class CustomException < StandardError
+    end
+
+    class IpifyRequestError < CustomException
+        def initialize(code='')
+            msg = "Received an invalid status code from ipify: #{code}. The service might be experiencing issues."
+            super(msg)
+        end
+    end
+
+    class InvalidParamsError < CustomException
+        def initialize
+            msg = "Wrong Format value passed. Please pass anyone from [#{VALID_FORMATS.join(', ')}]."
+            super(msg)
+        end
+    end
+
+    class UnexpectedError <CustomException
+        def initialize(err_msg='')
+            msg = "Unexpected error occured. Failed with an error: #{err_msg}."
+            super(msg)
+        end
+    end
+end 

metadata

@@ -0,0 +1,45 @@
+--- !ruby/object:Gem::Specification
+name: ruby_ipify
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Gokulakrishnan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-10-07 00:00:00.000000000 Z
+dependencies: []
+description: A Ruby gem to use ipify which is a simple public IP address API.
+email: gokulakrishnan312@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/constant.rb
+- lib/ruby_ipify.rb
+- lib/ruby_ipify_exception.rb
+homepage: https://rubygems.org/gems/ruby_ipify
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.5
+signing_key: 
+specification_version: 4
+summary: Ipify in ruby
+test_files: []