apiverve_tickersymbols 1.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5f8bfe6508486b2943c64cba6afe9e730526a5ec9d35fe9507d6b120d8daba62
+  data.tar.gz: 8cb4af9c42f3ce3d046cb7ecd7041f65108a02008ef08639896427d95b0723af
+SHA512:
+  metadata.gz: efb7abf9d173254b6e5fd14fd615c33ad21758202f0e81a650982676db9a7247f4066b780a8364da36e3ad386aa08cbaa8297da1f19c055d37b6c8b6eac1db91
+  data.tar.gz: 3805c796fbcc5ca49362a721d6a4bfa20ba8f7341e531d62e0158dc0ffce27b5f5136ddaf1523e1fdcb12bcea48e549f3e2e2641f5e26ceda18479a1e3392be0

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 APIVerve and EvlarSoft LLC
+
+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,128 @@
+# Ticker Symbols API - Ruby Gem
+
+Ticker Symbols identifies what a ticker symbol is and where it trades. Look up a symbol to get every listing that carries it across the US and 18 international stock markets, cryptocurrencies, futures and currency pairs, or find a stock symbol by company name. Every result carries its name, market, exchange, security type and asset class; paid plans add FIGI identifiers, SEC CIK numbers and fuller search results.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'apiverve_tickersymbols'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install apiverve_tickersymbols
+```
+
+## Getting Started
+
+Get your API key at [APIVerve](https://apiverve.com)
+
+### Basic Usage
+
+```ruby
+require 'apiverve_tickersymbols'
+
+# Initialize the client
+client = APIVerve::Tickersymbols::Client.new(api_key: "YOUR_API_KEY")
+
+# Make a request
+response = client.execute({
+  symbol: "SHEL",
+  market: "GB",
+  assetClass: "equity"
+})
+
+# Print the response
+puts response
+```
+
+
+### Error Handling
+
+```ruby
+begin
+  response = client.execute({ symbol: "SHEL", market: "GB", assetClass: "equity" })
+  puts response["data"]
+rescue APIVerve::Tickersymbols::ValidationError => e
+  puts "Validation error: #{e.errors.join(', ')}"
+rescue APIVerve::Tickersymbols::APIError => e
+  puts "API error: #{e.message}"
+  puts "Status code: #{e.status_code}"
+end
+```
+
+### Debug Mode
+
+```ruby
+# Enable debug logging
+client = APIVerve::Tickersymbols::Client.new(
+  api_key: "YOUR_API_KEY",
+  debug: true
+)
+```
+
+## Example Response
+
+```json
+{
+  "status": "ok",
+  "error": null,
+  "data": {
+    "symbol": "SHEL",
+    "search": null,
+    "count": 2,
+    "results": [
+      {
+        "symbol": "SHEL",
+        "name": "Shell PLC American Depositary Shares (each representing two (2) Ordinary Shares)",
+        "market": "US",
+        "country": "US",
+        "exchange": "XNYS",
+        "exchangeName": "New York Stock Exchange",
+        "type": "Depositary Receipt",
+        "assetClass": "equity",
+        "figi": "BBG0147BN6G2",
+        "compositeFigi": "BBG0147BN6G2",
+        "shareClassFigi": "BBG0147BN6H1",
+        "cik": "0001306965"
+      },
+      {
+        "symbol": "SHEL",
+        "name": "Shell Plc",
+        "market": "GB",
+        "country": "GB",
+        "exchange": "XLON",
+        "exchangeName": "London Stock Exchange",
+        "type": "Common Stock",
+        "assetClass": "equity",
+        "figi": "BBG0149N4YC8",
+        "compositeFigi": "BBG0149N4YB9",
+        "shareClassFigi": "BBG0149N4YG4",
+        "cik": null
+      }
+    ]
+  }
+}
+```
+
+## Documentation
+
+For more information, visit the [API Documentation](https://docs.apiverve.com/ref/tickersymbols?utm_source=rubygems&utm_medium=referral&utm_content=readme).
+
+## Support
+
+- Website: [https://apiverve.com/marketplace/tickersymbols?utm_source=ruby&utm_medium=referral&utm_content=readme](https://apiverve.com/marketplace/tickersymbols?utm_source=ruby&utm_medium=referral&utm_content=readme)
+- Email: hello@apiverve.com
+
+## License
+
+This gem is available under the [MIT License](LICENSE).

data/lib/apiverve_tickersymbols/client.rb

@@ -0,0 +1,184 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "faraday/multipart"
+require "json"
+
+module APIVerve
+  module Tickersymbols
+    # Client for the Ticker Symbols API
+    #
+    # @example Basic usage
+    #   client = APIVerve::Tickersymbols::Client.new(api_key: "your_api_key")
+    #   response = client.execute({ symbol: "SHEL", market: "GB", assetClass: "equity" })
+    #   puts response
+    #
+    # @see https://apiverve.com/marketplace/tickersymbols?utm_source=ruby&utm_medium=referral&utm_content=readme
+    class Client
+      BASE_URL = "https://api.apiverve.com/v1/tickersymbols"
+      DEFAULT_TIMEOUT = 30
+
+      # Validation rules for parameters
+      VALIDATION_RULES = { 'symbol' => { type: 'string', required: true, max_length: 24 }, 'market' => { type: 'string', required: false }, 'assetClass' => { type: 'string', required: false } }
+
+      # Format validation patterns
+      FORMAT_PATTERNS = {
+        'email' => /^[^\s@]+@[^\s@]+\.[^\s@]+$/,
+        'url' => /^https?:\/\/.+/,
+        'ip' => /^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$|^([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}$/,
+        'date' => /^\d{4}-\d{2}-\d{2}$/,
+        'hexColor' => /^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$/
+      }.freeze
+
+      # Initialize the client
+      #
+      # @param api_key [String] Your APIVerve API key
+      # @param timeout [Integer] Request timeout in seconds (default: 30)
+      # @param debug [Boolean] Enable debug logging (default: false)
+      # @raise [ArgumentError] If API key is invalid
+      def initialize(api_key:, timeout: DEFAULT_TIMEOUT, debug: false)
+        validate_api_key!(api_key)
+
+        @api_key = api_key
+        @timeout = timeout
+        @debug = debug
+
+        @connection = Faraday.new(url: BASE_URL) do |conn|
+          conn.request :multipart
+          conn.request :url_encoded
+          conn.adapter Faraday.default_adapter
+          conn.options.timeout = @timeout
+          conn.headers["x-api-key"] = @api_key
+          conn.headers["auth-mode"] = "rubygems-package"
+          conn.headers["Content-Type"] = "application/json"
+        end
+      end
+
+      # Execute the API request
+      #
+      # @param params [Hash] Query parameters or request body
+      # @return [Hash] API response
+      # @raise [APIError] If the request fails
+      # @raise [ValidationError] If parameter validation fails
+      def execute(params = {})
+        validate_params!(params)
+
+        log("Making GET request to #{BASE_URL}")
+        log("Parameters: #{params.inspect}") if params.any?
+
+        response = @connection.get do |req|
+          params.each { |k, v| req.params[k.to_s] = v }
+        end
+
+        handle_response(response)
+      end
+
+      private
+
+      def validate_api_key!(api_key)
+        raise ArgumentError, "API key is required. Get your API key at: https://apiverve.com" if api_key.nil? || api_key.strip.empty?
+
+        unless api_key.match?(/^[a-zA-Z0-9_-]+$/)
+          raise ArgumentError, "Invalid API key format. API key should only contain letters, numbers, hyphens, and underscores."
+        end
+      end
+
+      def validate_params!(params)
+        return if VALIDATION_RULES.empty?
+
+        errors = []
+
+        VALIDATION_RULES.each do |param_name, rules|
+          value = params[param_name.to_sym] || params[param_name]
+
+          # Check required
+          if rules[:required] && (value.nil? || value.to_s.empty?)
+            errors << "Required parameter [#{param_name}] is missing."
+            next
+          end
+
+          next if value.nil?
+
+          case rules[:type]
+          when "integer", "number"
+            begin
+              num_value = rules[:type] == "number" ? Float(value) : Integer(value)
+              errors << "Parameter [#{param_name}] must be at least #{rules[:min]}." if rules[:min] && num_value < rules[:min]
+              errors << "Parameter [#{param_name}] must be at most #{rules[:max]}." if rules[:max] && num_value > rules[:max]
+            rescue ArgumentError, TypeError
+              errors << "Parameter [#{param_name}] must be a valid #{rules[:type]}."
+            end
+          when "string"
+            unless value.is_a?(String)
+              errors << "Parameter [#{param_name}] must be a string."
+              next
+            end
+            errors << "Parameter [#{param_name}] must be at least #{rules[:min_length]} characters." if rules[:min_length] && value.length < rules[:min_length]
+            errors << "Parameter [#{param_name}] must be at most #{rules[:max_length]} characters." if rules[:max_length] && value.length > rules[:max_length]
+
+            if rules[:format] && FORMAT_PATTERNS[rules[:format]]
+              unless value.match?(FORMAT_PATTERNS[rules[:format]])
+                errors << "Parameter [#{param_name}] must be a valid #{rules[:format]}."
+              end
+            end
+          when "boolean"
+            unless [true, false, "true", "false"].include?(value)
+              errors << "Parameter [#{param_name}] must be a boolean."
+            end
+          end
+
+          # Enum validation
+          if rules[:enum] && !rules[:enum].include?(value)
+            errors << "Parameter [#{param_name}] must be one of: #{rules[:enum].join(', ')}."
+          end
+        end
+
+        raise ValidationError, errors unless errors.empty?
+      end
+
+      def handle_response(response)
+        log("Response status: #{response.status}")
+
+        data = JSON.parse(response.body)
+
+        if data["status"] == "error"
+          raise APIError.new(data["error"] || "Unknown API error", response.status, data)
+        end
+
+        unless response.success?
+          raise APIError.new(data["error"] || "HTTP #{response.status} error", response.status, data)
+        end
+
+        log("Request successful")
+        data
+      rescue JSON::ParserError => e
+        raise APIError.new("Invalid JSON response: #{e.message}", response.status)
+      end
+
+      def log(message)
+        puts "[APIVerve::Tickersymbols] #{message}" if @debug
+      end
+    end
+
+    # Custom error class for API errors
+    class APIError < StandardError
+      attr_reader :status_code, :response
+
+      def initialize(message, status_code = nil, response = nil)
+        @status_code = status_code
+        @response = response
+        super(message)
+      end
+    end
+
+    # Custom error class for validation errors
+    class ValidationError < StandardError
+      attr_reader :errors
+
+      def initialize(errors)
+        @errors = errors
+        super("Validation failed: #{errors.join(' ')}")
+      end
+    end
+  end
+end

data/lib/apiverve_tickersymbols.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "apiverve_tickersymbols/client"
+
+module APIVerve
+  module Tickersymbols
+    VERSION = "1.2.2"
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: apiverve_tickersymbols
+version: !ruby/object:Gem::Version
+  version: 1.2.2
+platform: ruby
+authors:
+- APIVerve
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2026-10-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: faraday-multipart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Ticker Symbols identifies what a ticker symbol is and where it trades.
+  Look up a symbol to get every listing that carries it across the US and 18 international
+  stock markets, cryptocurrencies, futures and currency pairs, or find a stock symbol
+  by company name. Every result carries its name, market, exchange, security type
+  and asset class; paid plans add FIGI identifiers, SEC CIK numbers and fuller search
+  results.
+email:
+- hello@apiverve.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/apiverve_tickersymbols.rb
+- lib/apiverve_tickersymbols/client.rb
+homepage: https://apiverve.com/marketplace/tickersymbols?utm_source=ruby&utm_medium=referral&utm_content=homepage
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://apiverve.com/marketplace/tickersymbols?utm_source=ruby&utm_medium=referral&utm_content=homepage
+  source_code_uri: https://github.com/apiverve/tickersymbols-API/tree/main/ruby
+  changelog_uri: https://apiverve.com/changelog
+  documentation_uri: https://docs.apiverve.com/ref/tickersymbols
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Ticker Symbols API - Ruby Client
+test_files: []