genderapi-phone-validator 1.0.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dcbce725066c9e0c1b241a4a73f1224e7b6586501ca98e709aa87fa1ee2fe417
-  data.tar.gz: 377a2c529ac9f17f4c337486b91849935e803dda0837a1b70b17cf083af4cedc
+  metadata.gz: 817e466060635482fe40ff3e62438539c85dbd9ce998e2f5ee14ef96b386c2af
+  data.tar.gz: d63736a55f0c66d996d17c8faf6c73bc8ca2164178710accd47f2772c49a2a0f
 SHA512:
-  metadata.gz: 775b58044a8433964cc7a4b37da29d89338ba83dc7a7c993e0148d7604577a65bfb5ead37f5b554dc08771b8df07d665e4f50aa7b255121fbb90e71888a89fda
-  data.tar.gz: aee42e5100ba41e97b61e5d60dbea35d972666117468f012d7435865ea850cc138a3000316ecf4eb54fe2ee1db008b22019d78c111af77b678937805f9f43ff4
+  metadata.gz: 5e506a1c7c6cacdf63daa787872d5750b131f85f6bd516ab648178bf899eee2e99ca97e75a9abba1fb1b58b1ba28721c9d71b2dcad9d25cdfb0cbd51652f8afb
+  data.tar.gz: 52e9476ea6a953c06c5b981c14f88dbadc6fedd96e9a28caba8a074a6b9082a8b533501a3c711a52415a6559aad5bb3693ddad4cf9ea0337c33243375124e5ca

data/README.md

@@ -1,6 +1,6 @@
 # 📞 Phone Number Validation & Formatter API (Ruby SDK)
 
-The `phonevalidator` gem uses the official [GenderAPI Phone Number Validation & Formatter API](https://www.genderapi.io/) to validate and format phone numbers from over 240 countries and territories.
+The `genderapi-phone-validator` gem uses the official [GenderAPI Phone Number Validation & Formatter API](https://www.genderapi.io/) to validate and format phone numbers from over 240 countries and territories.
 
 Whether your users enter phone numbers in various formats (e.g., `12128675309`, `+1 212 867 5309`, `001-212-867-5309`), this library will intelligently detect, validate, and convert the input into a standardized E.164 format (e.g., `+12128675309`).
 

data/lib/genderapi-phone-validator/client.rb

@@ -5,25 +5,30 @@ require "json"
 
 module PhoneValidator
   ##
-  # Ruby SDK for Phone Number Validation & Formatter API from www.genderapi.io
+  # PhoneValidator::Client
   #
-  # This SDK allows you to:
-  #   - Validate international phone numbers
-  #   - Detect number type (mobile, landline, VoIP, etc.)
-  #   - Retrieve region and country metadata
-  #   - Format numbers to E.164 or national format
+  # Ruby SDK for the Phone Number Validation & Formatter API provided by [GenderAPI](https://www.genderapi.io).
   #
-  # Learn more: https://www.genderapi.io
+  # This class allows you to:
+  # - Validate international phone numbers
+  # - Detect number type (mobile, landline, VoIP, etc.)
+  # - Retrieve region and country metadata
+  # - Format numbers to E.164 or national format
+  #
+  # @example Basic usage
+  #   client = PhoneValidator::Client.new(api_key: "your_api_key")
+  #   result = client.validate(number: "+1 212 867 5309", address: "US")
+  #   puts result["e164"]
   #
   class Client
     include HTTParty
     base_uri "https://api.genderapi.io"
 
     ##
-    # Initialize the PhoneValidator client.
+    # Initializes a new client instance.
     #
     # @param api_key [String] Your GenderAPI API key as a Bearer token.
-    # @param base_url [String] Optional override for the API base URL.
+    # @param base_url [String] Optional override for the base URL (defaults to api.genderapi.io).
     #
     def initialize(api_key:, base_url: nil)
       @api_key = api_key
@@ -35,12 +40,15 @@ module PhoneValidator
     end
 
     ##
-    # Validate and format a phone number.
+    # Validates and formats a phone number.
+    #
+    # @param number [String] Phone number in any format (required).
+    # @param address [String] Optional. Country code (e.g., 'US'), full country name, or city name to improve accuracy.
     #
-    # @param number [String] The phone number to validate (required).
-    # @param address [String] Optional address or country hint for better accuracy.
+    # @return [Hash] The parsed JSON response as a Ruby Hash.
     #
-    # @return [Hash] Parsed JSON response containing validation results.
+    # @example Validate number
+    #   client.validate(number: "+1 212 867 5309", address: "US")
     #
     def validate(number:, address: "")
       payload = {
@@ -54,17 +62,12 @@ module PhoneValidator
     private
 
     ##
-    # Internal helper for sending POST requests to the GenderAPI.io API.
-    #
-    # Handles:
-    #   - Bearer token authorization
-    #   - Payload cleanup (removal of nil values)
-    #   - Error handling and JSON parsing
+    # Internal helper to POST a request to the API and parse the result.
     #
-    # @param endpoint [String] API endpoint path (e.g. "/api/phone")
-    # @param payload [Hash] Request body
+    # @param endpoint [String] API endpoint path (e.g. "/api/phone").
+    # @param payload [Hash] Request body to be sent as JSON.
     #
-    # @return [Hash] Parsed JSON response
+    # @return [Hash] Parsed JSON response.
     #
     def _post_request(endpoint, payload)
       cleaned_payload = payload.reject { |_k, v| v.nil? }
@@ -89,10 +92,10 @@ module PhoneValidator
     end
 
     ##
-    # Safely parse JSON response.
+    # Safely parses a JSON string to a Ruby Hash.
     #
-    # @param body [String] JSON string
-    # @return [Hash] Ruby Hash
+    # @param body [String] Raw JSON response.
+    # @return [Hash] Parsed JSON as Hash.
     #
     def parse_json(body)
       JSON.parse(body)

data/lib/genderapi-phone-validator/version.rb

@@ -1,5 +1,5 @@
 # lib/phonevalidador/version.rb
 
 module PhoneValidator
-  VERSION = "1.0.1"
+  VERSION = "1.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: genderapi-phone-validator
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.3
 platform: ruby
 authors:
 - Onur Ozturk
@@ -73,6 +73,7 @@ licenses:
 metadata:
   source_code_uri: https://github.com/GenderAPI/phone-validator-ruby
   changelog_uri: https://github.com/GenderAPI/phone-validator-ruby/blob/main/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/github/GenderAPI/phone-validator-ruby
 post_install_message:
 rdoc_options: []
 require_paths: