genderapi 1.0.3 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f558520709dbb5224575d6e410741551cd4ff76cafa69c64a62ec0e1573de1e
-  data.tar.gz: 6bcac028da0a83fb9a0b06e82efb4883bdc70b22b3dd0b3ce575e1a389f7db79
+  metadata.gz: 37dbdf8388b98f265d98ac47a00be36fffba6fd5c7b1580827caebfb7ad24f34
+  data.tar.gz: 2fb4c652c1e4c3deba6dd3e455d8d781c180f8a254d38b97590e549f27f1848d
 SHA512:
-  metadata.gz: f0b36e7d41ef81d765808adab1074327da31ec5c7789a8318c78796264c6f676b5c2268ccbf99d64bf576b8fbf6fbfc9df6c16569e878826e13e8902bbbc0623
-  data.tar.gz: d46bd3681cd58f007ce4235f26e3e6332cc14a1938031542b6a5c259e01fe870622d2175c6a8ad106563072e7f230b82f254d238f2aea0aef7a2912b575ea613
+  metadata.gz: 762244904c3ff5fa25f6a822d96f9c713c7864962a7e3e0ab2e37fe8d5783023e6a36b1d02e4b1fca258e93e176041cb4b01373795c9bcfae1fb38b24391875c
+  data.tar.gz: 86aaf648984d64cd832f3da1c9b0098705c3c2e9a0d061e122b9b41986cfcec3f37fbfaa065bfce8611348512f53d7ca8f5c0ecb57c969fac3e08cbe00072e69

data/README.md

@@ -44,7 +44,7 @@ result = api.get_gender_by_name(name: "Michael")
 puts result
 
 # With askToAI set to true
-result = api.get_gender_by_name(name: "李雷", askToAI: true)
+result = api.get_gender_by_name(name: "李雷", ask_to_ai: true)
 puts result
 ```
 
@@ -57,7 +57,7 @@ result = api.get_gender_by_email(email: "michael.smith@example.com")
 puts result
 
 # With askToAI set to true
-result = api.get_gender_by_email(email: "michael.smith@example.com", askToAI: true)
+result = api.get_gender_by_email(email: "michael.smith@example.com", ask_to_ai: true)
 puts result
 ```
 
@@ -70,7 +70,49 @@ result = api.get_gender_by_username(username: "michael_dev")
 puts result
 
 # With askToAI set to true
-result = api.get_gender_by_username(username: "michael_dev", askToAI: true)
+result = api.get_gender_by_username(username: "michael_dev", ask_to_ai: true)
+puts result
+```
+
+---
+
+### 🔹 Get Gender by Name (Bulk)
+
+```ruby
+bulk_data = [
+  { name: "Andrea", country: "DE", id: "123" },
+  { name: "andrea", country: "IT", id: "456" }
+]
+
+result = api.get_gender_by_name_bulk(data: bulk_data)
+puts result
+```
+
+---
+
+### 🔹 Get Gender by Email (Bulk)
+
+```ruby
+bulk_data = [
+  { email: "john@example.com", country: "US", id: "abc123" },
+  { email: "maria@domain.de", country: "DE", id: "def456" }
+]
+
+result = api.get_gender_by_email_bulk(data: bulk_data)
+puts result
+```
+
+---
+
+### 🔹 Get Gender by Username (Bulk)
+
+```ruby
+bulk_data = [
+  { username: "johnwhite", country: "US", id: "u001" },
+  { username: "maria2025", country: "DE", id: "u002" }
+]
+
+result = api.get_gender_by_username_bulk(data: bulk_data)
 puts result
 ```
 
@@ -114,6 +156,45 @@ All API methods accept parameters as keyword arguments. All fields are optional
 
 ---
 
+### Name Lookup (Bulk)
+
+| Parameter          | Type     | Required | Description |
+|--------------------|----------|----------|-------------|
+| data               | Array<Hash> | Yes | Array of objects containing name, optional country, and optional id. Limit is 100 records per request. |
+
+Each object in the data array may include:
+- `name`: The name to analyze (required).
+- `country`: Two-letter country code (optional).
+- `id`: Custom identifier to correlate input/output (optional).
+
+---
+
+### Email Lookup (Bulk)
+
+| Parameter          | Type     | Required | Description |
+|--------------------|----------|----------|-------------|
+| data               | Array<Hash> | Yes | Array of objects containing email, optional country, and optional id. Limit is 50 records per request. |
+
+Each object in the data array may include:
+- `email`: The email address to analyze (required).
+- `country`: Two-letter country code (optional).
+- `id`: Custom identifier to correlate input/output (optional).
+
+---
+
+### Username Lookup (Bulk)
+
+| Parameter          | Type     | Required | Description |
+|--------------------|----------|----------|-------------|
+| data               | Array<Hash> | Yes | Array of objects containing username, optional country, and optional id. Limit is 50 records per request. |
+
+Each object in the data array may include:
+- `username`: The username to analyze (required).
+- `country`: Two-letter country code (optional).
+- `id`: Custom identifier to correlate input/output (optional).
+
+---
+
 ## ✅ API Response
 
 Example JSON response for all endpoints:

data/lib/genderapi/client.rb

@@ -97,6 +97,71 @@ module GenderAPI
       _post_request("/api/username", payload)
     end
 
+    ##
+    # Bulk determine gender from multiple personal names.
+    #
+    # Allows sending up to 100 name records in a single request.
+    # Useful for high-volume batch processing where performance
+    # and cost efficiency are critical.
+    #
+    # Each name object can contain:
+    #   - name [String] The personal name to analyze. (Required)
+    #   - country [String, nil] Optional two-letter country code (e.g. "US").
+    #   - id [String, Integer, nil] Optional custom identifier to correlate input and output.
+    #
+    # @param data [Array<Hash>] Array of name data hashes.
+    #
+    # @return [Hash] JSON response as a Ruby Hash.
+    #
+    def get_gender_by_name_bulk(data:)
+      payload = { data: data }
+      _post_request("/api/name/multi/country", payload)
+    end
+
+    ##
+    # Bulk determine gender from multiple email addresses.
+    #
+    # Allows sending up to 50 email records in a single request.
+    # This method is designed for scenarios such as bulk database
+    # cleaning, analytics, or personalization tasks where email
+    # data is available and high throughput is required.
+    #
+    # Each email object can contain:
+    #   - email [String] The email address to analyze. (Required)
+    #   - country [String, nil] Optional two-letter country code (e.g. "US").
+    #   - id [String, Integer, nil] Optional custom identifier to correlate input and output.
+    #
+    # @param data [Array<Hash>] Array of email data hashes.
+    #
+    # @return [Hash] JSON response as a Ruby Hash.
+    #
+    def get_gender_by_email_bulk(data:)
+      payload = { data: data }
+      _post_request("/api/email/multi/country", payload)
+    end
+
+    ##
+    # Bulk determine gender from multiple social media usernames.
+    #
+    # Allows sending up to 50 username records in a single request.
+    # Useful for bulk social media analytics, profiling, or
+    # marketing segmentation tasks where usernames are the primary
+    # identifier and high performance is required.
+    #
+    # Each username object can contain:
+    #   - username [String] The social media username to analyze. (Required)
+    #   - country [String, nil] Optional two-letter country code (e.g. "US").
+    #   - id [String, Integer, nil] Optional custom identifier to correlate input and output.
+    #
+    # @param data [Array<Hash>] Array of username data hashes.
+    #
+    # @return [Hash] JSON response as a Ruby Hash.
+    #
+    def get_gender_by_username_bulk(data:)
+      payload = { data: data }
+      _post_request("/api/username/multi/country", payload)
+    end
+
     private
 
     ##
@@ -127,7 +192,6 @@ module GenderAPI
       if [500, 502, 503, 504, 408].include?(response.code)
         raise "GenderAPI Server Error or Timeout: HTTP #{response.code} - #{response.body}"
       else
-        # Try parsing JSON response
         begin
           parse_json(response.body)
         rescue JSON::ParserError

data/lib/genderapi/version.rb

@@ -1,5 +1,5 @@
 # lib/genderapi/version.rb
 
 module GenderAPI
-  VERSION = "1.0.3"
+  VERSION = "1.0.5"
 end

metadata

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