ipgeolocation_sdk 1.0.0

data/docs/TimezoneDetailDstEnd.md

@@ -0,0 +1,28 @@
+# IpgeolocationSdk::TimezoneDetailDstEnd
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **utc_time** | **String** |  | [optional] |
+| **duration** | **String** |  | [optional] |
+| **gap** | **Boolean** |  | [optional] |
+| **date_time_after** | **String** |  | [optional] |
+| **date_time_before** | **String** |  | [optional] |
+| **overlap** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ipgeolocation_sdk'
+
+instance = IpgeolocationSdk::TimezoneDetailDstEnd.new(
+  utc_time: 2025-11-02 TIME 09,
+  duration: -1H,
+  gap: null,
+  date_time_after: 2025-11-02 TIME 01,
+  date_time_before: 2025-11-02 TIME 02,
+  overlap: null
+)
+```
+

data/docs/TimezoneDetailDstStart.md

@@ -0,0 +1,28 @@
+# IpgeolocationSdk::TimezoneDetailDstStart
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **utc_time** | **String** |  | [optional] |
+| **duration** | **String** |  | [optional] |
+| **gap** | **Boolean** |  | [optional] |
+| **date_time_after** | **String** |  | [optional] |
+| **date_time_before** | **String** |  | [optional] |
+| **overlap** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ipgeolocation_sdk'
+
+instance = IpgeolocationSdk::TimezoneDetailDstStart.new(
+  utc_time: 2025-03-09 TIME 10,
+  duration: +1H,
+  gap: null,
+  date_time_after: 2025-03-09 TIME 03,
+  date_time_before: 2025-03-09 TIME 02,
+  overlap: null
+)
+```
+

data/docs/TimezoneLocation.md

@@ -0,0 +1,48 @@
+# IpgeolocationSdk::TimezoneLocation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **location_string** | **String** |  | [optional] |
+| **continent_code** | **String** |  | [optional] |
+| **continent_name** | **String** |  | [optional] |
+| **country_code2** | **String** |  | [optional] |
+| **country_code3** | **String** |  | [optional] |
+| **country_name** | **String** |  | [optional] |
+| **country_name_official** | **String** |  | [optional] |
+| **is_eu** | **Boolean** |  | [optional] |
+| **state_prov** | **String** |  | [optional] |
+| **state_code** | **String** |  | [optional] |
+| **district** | **String** |  | [optional] |
+| **city** | **String** |  | [optional] |
+| **locality** | **String** |  | [optional] |
+| **zipcode** | **String** |  | [optional] |
+| **latitude** | **String** |  | [optional] |
+| **longitude** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ipgeolocation_sdk'
+
+instance = IpgeolocationSdk::TimezoneLocation.new(
+  location_string: Londong, UK,
+  continent_code: OC,
+  continent_name: Oceania,
+  country_code2: AU,
+  country_code3: AUS,
+  country_name: Australia,
+  country_name_official: Commonwealth of Australia,
+  is_eu: false,
+  state_prov: Queensland,
+  state_code: AU-QLD,
+  district: South Brisbane,
+  city: Brisbane,
+  locality: ,
+  zipcode: 4101,
+  latitude: -27.47306,
+  longitude: 153.01421
+)
+```
+

data/docs/TimezoneLocode.md

@@ -0,0 +1,32 @@
+# IpgeolocationSdk::TimezoneLocode
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **lo_code** | **String** |  | [optional] |
+| **city** | **String** |  | [optional] |
+| **state_code** | **String** |  | [optional] |
+| **country_code** | **String** |  | [optional] |
+| **country_name** | **String** |  | [optional] |
+| **location_type** | **String** |  | [optional] |
+| **latitude** | **String** |  | [optional] |
+| **longitude** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ipgeolocation_sdk'
+
+instance = IpgeolocationSdk::TimezoneLocode.new(
+  lo_code: DEBER,
+  city: Berlin,
+  state_code: BE,
+  country_code: DE,
+  country_name: ,
+  location_type: Port, Rail Terminal, Road Terminal, Airport, Postal Exchange,
+  latitude: 52.51667,
+  longitude: 13.38333
+)
+```
+

data/docs/UserAgentApi.md

@@ -0,0 +1,235 @@
+# IpgeolocationSdk::UserAgentApi
+
+All URIs are relative to *https://api.ipgeolocation.io/v2*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_user_agent_details**](UserAgentApi.md#get_user_agent_details) | **GET** /user-agent | Get details of user-agent |
+| [**parse_bulk_user_agent_strings**](UserAgentApi.md#parse_bulk_user_agent_strings) | **POST** /user-agent-bulk | Handle multiple user-agent string lookups |
+| [**parse_user_agent_string**](UserAgentApi.md#parse_user_agent_string) | **POST** /user-agent | Handle single User-Agent string |
+
+
+## get_user_agent_details
+
+> <UserAgentData> get_user_agent_details(opts)
+
+Get details of user-agent
+
+User Agent Parser API provides the accurate browser, device, and operating system details from a User Agent String. It also provides information about crawlers and attack sources. You can use these details to customize user experience, prevent crawlers and attackers from accessing your website. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'ipgeolocation_sdk'
+# setup authorization
+IpgeolocationSdk.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['apiKey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['apiKey'] = 'Bearer'
+end
+
+api_instance = IpgeolocationSdk::UserAgentApi.new
+opts = {
+  user_agent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_2) AppleWebKit/601.3.9 (KHTML, like Gecko) Version/9.0.2 Safari/601.3.9', # String | 
+  output: 'json' # String | Desired output format (json or xml).
+}
+
+begin
+  # Get details of user-agent
+  result = api_instance.get_user_agent_details(opts)
+  p result
+rescue IpgeolocationSdk::ApiError => e
+  puts "Error when calling UserAgentApi->get_user_agent_details: #{e}"
+end
+```
+
+#### Using the get_user_agent_details_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UserAgentData>, Integer, Hash)> get_user_agent_details_with_http_info(opts)
+
+```ruby
+begin
+  # Get details of user-agent
+  data, status_code, headers = api_instance.get_user_agent_details_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UserAgentData>
+rescue IpgeolocationSdk::ApiError => e
+  puts "Error when calling UserAgentApi->get_user_agent_details_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_agent** | **String** |  | [optional] |
+| **output** | **String** | Desired output format (json or xml). | [optional] |
+
+### Return type
+
+[**UserAgentData**](UserAgentData.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/xml
+
+
+## parse_bulk_user_agent_strings
+
+> <Array<UserAgentData>> parse_bulk_user_agent_strings(opts)
+
+Handle multiple user-agent string lookups
+
+This endpoint allows you to perform the parsing of multiple User-Angent strings (max. 50,000) at the same time. The requests count per round is equal to total User-Agent strings passed. This feature is `only available for paid plans`.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ipgeolocation_sdk'
+# setup authorization
+IpgeolocationSdk.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['apiKey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['apiKey'] = 'Bearer'
+end
+
+api_instance = IpgeolocationSdk::UserAgentApi.new
+opts = {
+  output: 'json', # String | Desired output format (json or xml).
+  parse_bulk_user_agent_strings_request: IpgeolocationSdk::ParseBulkUserAgentStringsRequest.new # ParseBulkUserAgentStringsRequest | 
+}
+
+begin
+  # Handle multiple user-agent string lookups
+  result = api_instance.parse_bulk_user_agent_strings(opts)
+  p result
+rescue IpgeolocationSdk::ApiError => e
+  puts "Error when calling UserAgentApi->parse_bulk_user_agent_strings: #{e}"
+end
+```
+
+#### Using the parse_bulk_user_agent_strings_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<UserAgentData>>, Integer, Hash)> parse_bulk_user_agent_strings_with_http_info(opts)
+
+```ruby
+begin
+  # Handle multiple user-agent string lookups
+  data, status_code, headers = api_instance.parse_bulk_user_agent_strings_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<UserAgentData>>
+rescue IpgeolocationSdk::ApiError => e
+  puts "Error when calling UserAgentApi->parse_bulk_user_agent_strings_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **output** | **String** | Desired output format (json or xml). | [optional] |
+| **parse_bulk_user_agent_strings_request** | [**ParseBulkUserAgentStringsRequest**](ParseBulkUserAgentStringsRequest.md) |  | [optional] |
+
+### Return type
+
+[**Array&lt;UserAgentData&gt;**](UserAgentData.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json, application/xml
+
+
+## parse_user_agent_string
+
+> <UserAgentData> parse_user_agent_string(opts)
+
+Handle single User-Agent string
+
+You can also provide custom User-Agent string to parse in JSON payload. This endpoint is meant to be called from server-side and is available for paid subscriptions only.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ipgeolocation_sdk'
+# setup authorization
+IpgeolocationSdk.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['apiKey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['apiKey'] = 'Bearer'
+end
+
+api_instance = IpgeolocationSdk::UserAgentApi.new
+opts = {
+  output: 'json', # String | Desired output format (json or xml).
+  parse_user_agent_string_request: IpgeolocationSdk::ParseUserAgentStringRequest.new # ParseUserAgentStringRequest | 
+}
+
+begin
+  # Handle single User-Agent string
+  result = api_instance.parse_user_agent_string(opts)
+  p result
+rescue IpgeolocationSdk::ApiError => e
+  puts "Error when calling UserAgentApi->parse_user_agent_string: #{e}"
+end
+```
+
+#### Using the parse_user_agent_string_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UserAgentData>, Integer, Hash)> parse_user_agent_string_with_http_info(opts)
+
+```ruby
+begin
+  # Handle single User-Agent string
+  data, status_code, headers = api_instance.parse_user_agent_string_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UserAgentData>
+rescue IpgeolocationSdk::ApiError => e
+  puts "Error when calling UserAgentApi->parse_user_agent_string_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **output** | **String** | Desired output format (json or xml). | [optional] |
+| **parse_user_agent_string_request** | [**ParseUserAgentStringRequest**](ParseUserAgentStringRequest.md) |  | [optional] |
+
+### Return type
+
+[**UserAgentData**](UserAgentData.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json, application/xml
+

data/docs/UserAgentData.md

@@ -0,0 +1,32 @@
+# IpgeolocationSdk::UserAgentData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_agent_string** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **type** | **String** |  | [optional] |
+| **version** | **String** |  | [optional] |
+| **version_major** | **String** |  | [optional] |
+| **device** | [**UserAgentDataDevice**](UserAgentDataDevice.md) |  | [optional] |
+| **engine** | [**UserAgentDataEngine**](UserAgentDataEngine.md) |  | [optional] |
+| **operating_system** | [**UserAgentDataOperatingSystem**](UserAgentDataOperatingSystem.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ipgeolocation_sdk'
+
+instance = IpgeolocationSdk::UserAgentData.new(
+  user_agent_string: null,
+  name: null,
+  type: null,
+  version: null,
+  version_major: null,
+  device: null,
+  engine: null,
+  operating_system: null
+)
+```
+

data/docs/UserAgentDataDevice.md

@@ -0,0 +1,24 @@
+# IpgeolocationSdk::UserAgentDataDevice
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **type** | **String** |  | [optional] |
+| **brand** | **String** |  | [optional] |
+| **cpu** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ipgeolocation_sdk'
+
+instance = IpgeolocationSdk::UserAgentDataDevice.new(
+  name: null,
+  type: null,
+  brand: null,
+  cpu: null
+)
+```
+

data/docs/UserAgentDataEngine.md

@@ -0,0 +1,24 @@
+# IpgeolocationSdk::UserAgentDataEngine
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **type** | **String** |  | [optional] |
+| **version** | **String** |  | [optional] |
+| **version_major** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ipgeolocation_sdk'
+
+instance = IpgeolocationSdk::UserAgentDataEngine.new(
+  name: null,
+  type: null,
+  version: null,
+  version_major: null
+)
+```
+

data/docs/UserAgentDataOperatingSystem.md

@@ -0,0 +1,26 @@
+# IpgeolocationSdk::UserAgentDataOperatingSystem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **type** | **String** |  | [optional] |
+| **version** | **String** |  | [optional] |
+| **version_major** | **String** |  | [optional] |
+| **build** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ipgeolocation_sdk'
+
+instance = IpgeolocationSdk::UserAgentDataOperatingSystem.new(
+  name: null,
+  type: null,
+  version: null,
+  version_major: null,
+  build: null
+)
+```
+

data/docs/UserAgentXMLData.md

@@ -0,0 +1,32 @@
+# IpgeolocationSdk::UserAgentXMLData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_agent_string** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **type** | **String** |  | [optional] |
+| **version** | **String** |  | [optional] |
+| **version_major** | **String** |  | [optional] |
+| **device** | [**UserAgentDataDevice**](UserAgentDataDevice.md) |  | [optional] |
+| **engine** | [**UserAgentDataEngine**](UserAgentDataEngine.md) |  | [optional] |
+| **operating_system** | [**UserAgentDataOperatingSystem**](UserAgentDataOperatingSystem.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ipgeolocation_sdk'
+
+instance = IpgeolocationSdk::UserAgentXMLData.new(
+  user_agent_string: null,
+  name: null,
+  type: null,
+  version: null,
+  version_major: null,
+  device: null,
+  engine: null,
+  operating_system: null
+)
+```
+

data/docs/UserAgentXMLDataArray.md

@@ -0,0 +1,32 @@
+# IpgeolocationSdk::UserAgentXMLDataArray
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_agent_string** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **type** | **String** |  | [optional] |
+| **version** | **String** |  | [optional] |
+| **version_major** | **String** |  | [optional] |
+| **device** | [**UserAgentDataDevice**](UserAgentDataDevice.md) |  | [optional] |
+| **engine** | [**UserAgentDataEngine**](UserAgentDataEngine.md) |  | [optional] |
+| **operating_system** | [**UserAgentDataOperatingSystem**](UserAgentDataOperatingSystem.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ipgeolocation_sdk'
+
+instance = IpgeolocationSdk::UserAgentXMLDataArray.new(
+  user_agent_string: null,
+  name: null,
+  type: null,
+  version: null,
+  version_major: null,
+  device: null,
+  engine: null,
+  operating_system: null
+)
+```
+

data/git_push.sh

@@ -0,0 +1,57 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=$(git remote)
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'

data/ipgeolocation_sdk.gemspec

@@ -0,0 +1,29 @@
+# ipgeolocation.gemspec
+require_relative "lib/ipgeolocation_sdk/version"
+
+Gem::Specification.new do |s|
+  s.name        = "ipgeolocation_sdk"
+  s.version     = IpgeolocationSdk::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["IPGeolocation.io"]
+  s.email       = ["support@ipgeolocation.io"]
+  s.homepage    = "https://ipgeolocation.io"
+  s.summary     = "Official Ruby SDK for IPGeolocation.io APIs"
+  s.description = "A Ruby wrapper for the IPGeolocation.io API suite, providing geolocation, ip security, timezone, currency, user-agent, and other IP intelligence features. Easily integrate IP data into your Ruby applications."  
+  s.license     = "MIT"
+  s.required_ruby_version = ">= 2.7"
+
+  s.metadata = {
+    "homepage_uri" => s.homepage,
+    "source_code_uri" => "https://github.com/IPGeolocation/ip-geolocation-ruby-sdk", 
+    "bug_tracker_uri" => "https://github.com/IPGeolocation/ip-geolocation-ruby-sdk/issues" 
+  }
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end