apiverve_tickernews 1.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7365895f07e0b265838543e38dea28bad1bf4188420fa35bc98aadca298140f8
+  data.tar.gz: 14c3b7fc3d5e92a37623efb8dc9a73c05900951db3692968e36a76f9e5b2029f
+SHA512:
+  metadata.gz: 9883d7e365fe2c992f51b029c37b857b3b091b911ff74aa2b1b980e8edf79120a7a769bc1dd983a1ea7255c1d530346d278230e111360a228ba4f291459c4c30
+  data.tar.gz: 94d8cf741939a37e9e8862b9490728bc8df4d40eb57dc49e900b9ed7d4fd424f31cf1a9224faa8ba2ff12f1ec6a7394db3683ee3698165c6e818da2f48e73713

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,139 @@
+# Ticker News API - Ruby Gem
+
+Ticker News is a stock news API that returns the latest news stories about one ticker symbol: US stocks and ETFs, stocks on 18 international markets, cryptocurrencies, futures and currency pairs. Each story comes with its headline, link, source, publisher and publication time, and is tagged as directly about the company or as a related market story. Paid plans add story summaries, headline tone and more stories per call.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'apiverve_tickernews'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install apiverve_tickernews
+```
+
+## Getting Started
+
+Get your API key at [APIVerve](https://apiverve.com)
+
+### Basic Usage
+
+```ruby
+require 'apiverve_tickernews'
+
+# Initialize the client
+client = APIVerve::Tickernews::Client.new(api_key: "YOUR_API_KEY")
+
+# Make a request
+response = client.execute({
+  ticker: "AAPL",
+  market: "US",
+  relevance: "direct",
+  since: "2026-10-01"
+})
+
+# Print the response
+puts response
+```
+
+
+### Error Handling
+
+```ruby
+begin
+  response = client.execute({ ticker: "AAPL", market: "US", relevance: "direct", since: "2026-10-01" })
+  puts response["data"]
+rescue APIVerve::Tickernews::ValidationError => e
+  puts "Validation error: #{e.errors.join(', ')}"
+rescue APIVerve::Tickernews::APIError => e
+  puts "API error: #{e.message}"
+  puts "Status code: #{e.status_code}"
+end
+```
+
+### Debug Mode
+
+```ruby
+# Enable debug logging
+client = APIVerve::Tickernews::Client.new(
+  api_key: "YOUR_API_KEY",
+  debug: true
+)
+```
+
+## Example Response
+
+```json
+{
+  "status": "ok",
+  "error": null,
+  "data": {
+    "ticker": "AAPL",
+    "name": "Apple Inc. Common Stock",
+    "market": "US",
+    "exchange": "XNAS",
+    "assetClass": "equity",
+    "relevance": "direct",
+    "lastUpdated": "2026-10-06T19:18:01.000Z",
+    "count": 3,
+    "articles": [
+      {
+        "title": "Scott Galloway: “Apple Wins by Showing Up Late” in AI, and Its New Home Hub Is the Test",
+        "link": "https://www.tikr.com/blog/scott-galloway-apple-wins-by-showing-up-late-in-ai-and-its-new-home-hub-is-the-test?ref=yahoofinance",
+        "source": "Yahoo Finance",
+        "publisher": "tikr.com",
+        "publishedAt": "2026-10-06T18:44:16.000Z",
+        "relevance": "direct",
+        "snippet": "Key TakeawaysApple is expected to launch its first smart home hub on Oct. 13, and Scott Galloway predicts it will be the top smart display by revenue within 18 months.",
+        "sentiment": "very positive",
+        "sentimentScore": 8
+      },
+      {
+        "title": "Only Four Trillion-Dollar Stocks Are Beating the S&P 500. What’s Next for the Megacaps?",
+        "link": "https://finance.yahoo.com/m/7003431f-36c8-336f-bf14-80d032b6a728/only-four-trillion-dollar.html",
+        "source": "Yahoo Finance",
+        "publisher": "finance.yahoo.com",
+        "publishedAt": "2026-10-06T18:22:00.000Z",
+        "relevance": "direct",
+        "snippet": "Only four trillion-dollar companies, including Nvidia and Apple, have beaten the S&P 500 this year, but recent rallies have left several looking overbought.",
+        "sentiment": "very negative",
+        "sentimentScore": -3
+      },
+      {
+        "title": "Apple's Market Value Grew From $350 Billion to $4.75 Trillion During Tim Cook's 15 Years as CEO. Here's What That Growth Curve Means for Betting on Apple's Next Chapter Under John Ternus.",
+        "link": "https://www.fool.com/investing/2026/10/06/apples-market-value-grew-from-350-billion-to-475-t/",
+        "source": "Yahoo Finance",
+        "publisher": "fool.com",
+        "publishedAt": "2026-10-06T17:12:00.000Z",
+        "relevance": "direct",
+        "snippet": "Ternus is inheriting a well-oiled machine, but Apple's growth may slow in the coming years.",
+        "sentiment": "very positive",
+        "sentimentScore": 4
+      }
+    ]
+  }
+}
+```
+
+## Documentation
+
+For more information, visit the [API Documentation](https://docs.apiverve.com/ref/tickernews?utm_source=rubygems&utm_medium=referral&utm_content=readme).
+
+## Support
+
+- Website: [https://apiverve.com/marketplace/tickernews?utm_source=ruby&utm_medium=referral&utm_content=readme](https://apiverve.com/marketplace/tickernews?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_tickernews/client.rb

@@ -0,0 +1,184 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "faraday/multipart"
+require "json"
+
+module APIVerve
+  module Tickernews
+    # Client for the Ticker News API
+    #
+    # @example Basic usage
+    #   client = APIVerve::Tickernews::Client.new(api_key: "your_api_key")
+    #   response = client.execute({ ticker: "AAPL", market: "US", relevance: "direct", since: "2026-10-01" })
+    #   puts response
+    #
+    # @see https://apiverve.com/marketplace/tickernews?utm_source=ruby&utm_medium=referral&utm_content=readme
+    class Client
+      BASE_URL = "https://api.apiverve.com/v1/tickernews"
+      DEFAULT_TIMEOUT = 30
+
+      # Validation rules for parameters
+      VALIDATION_RULES = { 'ticker' => { type: 'string', required: true, max_length: 24 }, 'market' => { type: 'string', required: false }, 'relevance' => { type: 'string', required: false }, 'since' => { type: 'string', required: false, max_length: 30, format: 'date' } }
+
+      # 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::Tickernews] #{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_tickernews.rb

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

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: apiverve_tickernews
+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 News is a stock news API that returns the latest news stories
+  about one ticker symbol: US stocks and ETFs, stocks on 18 international markets,
+  cryptocurrencies, futures and currency pairs. Each story comes with its headline,
+  link, source, publisher and publication time, and is tagged as directly about the
+  company or as a related market story. Paid plans add story summaries, headline tone
+  and more stories per call.'
+email:
+- hello@apiverve.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/apiverve_tickernews.rb
+- lib/apiverve_tickernews/client.rb
+homepage: https://apiverve.com/marketplace/tickernews?utm_source=ruby&utm_medium=referral&utm_content=homepage
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://apiverve.com/marketplace/tickernews?utm_source=ruby&utm_medium=referral&utm_content=homepage
+  source_code_uri: https://github.com/apiverve/tickernews-API/tree/main/ruby
+  changelog_uri: https://apiverve.com/changelog
+  documentation_uri: https://docs.apiverve.com/ref/tickernews
+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 News API - Ruby Client
+test_files: []