allnewsapi 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7070e32db6b43993f4a69273423bfd56170ba615f69fc6becc2b645b857bb6f6
+  data.tar.gz: 6981d360e096c4026881101f31692d2c16ceace106fd117258ee92aab855b2b3
+SHA512:
+  metadata.gz: 9820688bee7fe1b2b73ae6ff49d04e6e7ba583cf9c28d31fcc4be141381b035e38eea9714d6a5d49e685eb0ee2e609b50af4ac0d8b05be127d8dfcff0f894cb4
+  data.tar.gz: dc62514cc552427c2aa9dc6693674a401a554b5a07a02fb936abd5a103f130a452c0e38fd165ed8f1dfdb817bee57426626aa7a5149de40672486a02fa147573

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 AllNewsAPI
+
+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,110 @@
+# AllNewsAPI Ruby SDK
+
+[![Gem](https://img.shields.io/gem/v/allnewsapi)](https://rubygems.org/gems/allnewsapi)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+A lightweight Ruby SDK for the [AllNewsAPI](https://allnewsapi.com) with zero external dependencies. Uses `net/http` only.
+
+## Installation
+
+```bash
+gem install allnewsapi
+```
+
+Or add to your Gemfile:
+
+```ruby
+gem 'allnewsapi'
+```
+
+## Quick Start
+
+```ruby
+require 'allnewsapi'
+
+client = AllNewsAPI::Client.new('your-api-key')
+
+results = client.search(q: 'artificial intelligence', lang: 'en', max: 10)
+
+results['articles'].each do |article|
+  puts "#{article['title']} — #{article['source']['name']}"
+end
+```
+
+## Methods
+
+### `search(**params) -> Hash`
+
+Search for news articles matching any combination of filters.
+
+```ruby
+results = client.search(
+  q: 'climate change',
+  start_date: '2024-01-01',
+  end_date: '2024-06-01',
+  lang: ['en', 'fr'],
+  category: 'science',
+  max: 20
+)
+```
+
+### `headlines(**params) -> Hash`
+
+Fetch top headlines with the same filtering options as search.
+
+```ruby
+headlines = client.headlines(country: 'us', category: 'business', max: 5)
+```
+
+### `usage -> Hash`
+
+Check your API quota and consumption.
+
+```ruby
+usage = client.usage
+puts "Remaining: #{usage['requestsRemaining24Hours']}/#{usage['requestsLimit24Hours']}"
+```
+
+## Parameter Reference
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| q | `String` | Keywords to search for |
+| start_date | `String \| Date` | Start date (ISO 8601) |
+| end_date | `String \| Date` | End date (ISO 8601) |
+| content | `Boolean` | Include full article content |
+| lang | `String \| Array` | Language(s) to filter by |
+| country | `String \| Array` | Country/countries to filter by |
+| region | `String \| Array` | Region(s) to filter by |
+| category | `String \| Array` | Category/categories to filter by |
+| max | `Integer` | Maximum results (1-100) |
+| attributes | `String \| Array` | Search in title/description/content |
+| page | `Integer` | Page number |
+| sortby | `String` | Sort by `publishedAt` or `relevance` |
+| publisher | `String \| Array` | Publisher(s) to filter |
+| format | `String` | Response format: `json`, `csv`, or `xlsx` |
+| ai_sentiment | `String` | AI sentiment filter |
+| ai_entity_name | `String` | AI entity name filter |
+| ai_entity_type | `String` | AI entity type filter |
+
+## Error Handling
+
+```ruby
+require 'allnewsapi'
+
+client = AllNewsAPI::Client.new('your-api-key')
+
+begin
+  results = client.search(q: 'ruby')
+rescue AllNewsAPI::NewsAPIError => e
+  puts "Error #{e.status_code}: #{e.message}"
+end
+```
+
+## License
+
+MIT
+
+## Support
+
+Found a bug or have a feature request? Please [open an issue](https://github.com/AllNewsAPI/sdks/issues) on GitHub.

data/lib/allnewsapi/client.rb

@@ -0,0 +1,206 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'uri'
+require 'json'
+require 'date'
+
+module AllNewsAPI
+  # Main SDK client for interacting with AllNewsAPI
+  class Client
+    # Default base URL for the AllNewsAPI
+    DEFAULT_BASE_URL = 'https://api.allnewsapi.com'
+
+    # Default HTTP timeout in seconds
+    DEFAULT_TIMEOUT = 30
+
+    # Parameters that should NOT be converted from snake_case to camelCase
+    AI_PARAMS = %w[ai_sentiment ai_entity_name ai_entity_type].freeze
+
+    # Create a new AllNewsAPI client
+    #
+    # @param api_key [String] Your AllNewsAPI key
+    # @param options [Hash] Optional configuration options
+    # @option options [String] :base_url The base URL for the API
+    # @option options [Integer] :timeout HTTP timeout in seconds (default: 30)
+    def initialize(api_key, options = {})
+      if api_key.nil? || api_key.to_s.strip.empty?
+        raise Error.new(401, 'Unauthorized - Invalid API Key or Account status is inactive')
+      end
+
+      @api_key = api_key
+      @base_url = options[:base_url] || DEFAULT_BASE_URL
+      @timeout = options[:timeout] || DEFAULT_TIMEOUT
+      @search_endpoint = "#{@base_url}/search"
+      @headlines_endpoint = "#{@base_url}/headlines"
+      @usage_endpoint = "#{@base_url}/usage"
+    end
+
+    # Search for news articles
+    #
+    # @param options [Hash] Search options
+    # @option options [String] :q Keywords to search for
+    # @option options [String, Date] :start_date Start date (YYYY-MM-DD or Date object)
+    # @option options [String, Date] :end_date End date (YYYY-MM-DD or Date object)
+    # @option options [Boolean] :content Whether to include full content
+    # @option options [String, Array<String>] :lang Language(s) to filter by
+    # @option options [String, Array<String>] :country Country/countries to filter by
+    # @option options [String, Array<String>] :region Region(s) to filter by
+    # @option options [String, Array<String>] :category Category/categories to filter by
+    # @option options [Integer] :max Maximum number of results (1-100)
+    # @option options [String, Array<String>] :attributes Attributes to search in
+    # @option options [Integer] :page Page number for pagination
+    # @option options [String] :sortby Sort by 'publishedAt' or 'relevance'
+    # @option options [String, Array<String>] :publisher Publisher(s) to filter by
+    # @option options [String] :format Response format (json, csv, xlsx)
+    # @option options [String] :ai_sentiment AI sentiment filter
+    # @option options [String] :ai_entity_name AI entity name filter
+    # @option options [String] :ai_entity_type AI entity type filter
+    #
+    # @return [Hash, String] Search results (Hash for JSON, String for CSV/XLSX)
+    def search(options = {})
+      params = prepare_params(options)
+      make_request(params, @search_endpoint)
+    end
+
+    # Get top headlines
+    #
+    # @param options [Hash] Headlines options (same as search)
+    #
+    # @return [Hash, String] Headlines results (Hash for JSON, String for CSV/XLSX)
+    def headlines(options = {})
+      params = prepare_params(options)
+      make_request(params, @headlines_endpoint)
+    end
+
+    # Get account usage statistics
+    #
+    # @return [Hash] Usage statistics
+    def usage
+      make_request({}, @usage_endpoint)
+    end
+
+    private
+
+    # Prepare parameters by converting dates to ISO 8601 format
+    #
+    # @param options [Hash] Raw options from the user
+    # @return [Hash] Prepared options with dates converted
+    def prepare_params(options)
+      params = options.dup
+      params[:start_date] = params[:start_date].iso8601 if params[:start_date].is_a?(Date)
+      params[:end_date] = params[:end_date].iso8601 if params[:end_date].is_a?(Date)
+      params
+    end
+
+    # Build the URL with query parameters for the API request
+    #
+    # @param params [Hash] Query parameters for the request
+    # @param endpoint [String] The API endpoint to use
+    # @return [URI] The complete URI for the API request
+    def build_url(params, endpoint)
+      uri = URI(endpoint)
+      query_params = []
+      query_params << ['apikey', @api_key]
+
+      params.each do |key, value|
+        next if value.nil?
+
+        # Convert parameter name
+        api_key_name = convert_param_name(key)
+
+        # Handle array values by joining them with commas
+        param_value = value.is_a?(Array) ? value.join(',') : value.to_s
+
+        query_params << [api_key_name, param_value]
+      end
+
+      uri.query = URI.encode_www_form(query_params)
+      uri
+    end
+
+    # Convert Ruby snake_case parameter name to API camelCase
+    # AI params are kept as-is since they already match the API format
+    #
+    # @param key [Symbol, String] Ruby parameter name
+    # @return [String] API parameter name
+    def convert_param_name(key)
+      key_str = key.to_s
+
+      # AI params stay as-is
+      return key_str if AI_PARAMS.include?(key_str)
+
+      # Convert snake_case to camelCase
+      key_str.gsub(/_([a-z])/) { ::Regexp.last_match(1).upcase }
+    end
+
+    # Make a request to the API
+    #
+    # @param params [Hash] Query parameters for the request
+    # @param endpoint [String] The API endpoint to use
+    # @return [Hash, String] The API response
+    def make_request(params, endpoint)
+      uri = build_url(params, endpoint)
+
+      begin
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = (uri.scheme == 'https')
+        http.open_timeout = @timeout
+        http.read_timeout = @timeout
+
+        request = Net::HTTP::Get.new(uri)
+        response = http.start { |h| h.request(request) }
+
+        # Handle HTTP errors
+        unless response.is_a?(Net::HTTPSuccess)
+          error_message = parse_error_message(response)
+          raise Error.new(response.code.to_i, error_message)
+        end
+
+        # Handle different formats
+        format = params[:format] || 'json'
+
+        case format.to_s
+        when 'json'
+          JSON.parse(response.body)
+        else
+          response.body
+        end
+      rescue Error => e
+        raise e
+      rescue SocketError, Timeout::Error, Errno::ECONNREFUSED => e
+        raise Error.new(500, "Request failed: #{e.message}")
+      rescue StandardError => e
+        raise Error.new(500, "Request failed: #{e.message}")
+      end
+    end
+
+    # Parse error message from API response
+    #
+    # @param response [Net::HTTPResponse] The error response
+    # @return [String] The error message
+    def parse_error_message(response)
+      error_data = JSON.parse(response.body)
+      error_data.dig('detail', 'message') || default_error_message(response.code.to_i)
+    rescue JSON::ParserError, TypeError
+      default_error_message(response.code.to_i)
+    end
+
+    # Get a default error message based on status code
+    #
+    # @param status_code [Integer] HTTP status code
+    # @return [String] Default error message
+    def default_error_message(status_code)
+      messages = {
+        400 => 'Bad Request - Your request is invalid',
+        401 => 'Unauthorized - Invalid API Key or Account status is inactive',
+        403 => 'Forbidden - Your account is not authorized to make that request',
+        429 => 'Too Many Requests - You have reached your daily request limit',
+        500 => 'Internal Server Error - We had a problem with our server',
+        503 => "Service Unavailable - We're temporarily offline for maintenance"
+      }
+
+      messages[status_code] || 'Unknown error occurred'
+    end
+  end
+end

data/lib/allnewsapi/error.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module AllNewsAPI
+  # Custom error class for AllNewsAPI errors
+  class Error < StandardError
+    attr_reader :status_code
+
+    # @param status_code [Integer] HTTP status code
+    # @param message [String] Error message
+    def initialize(status_code, message)
+      @status_code = status_code
+      super(message)
+    end
+  end
+end

data/lib/allnewsapi/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module AllNewsAPI
+  VERSION = '0.2.0'
+end

data/lib/allnewsapi.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative 'allnewsapi/version'
+require_relative 'allnewsapi/error'
+require_relative 'allnewsapi/client'

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: allnewsapi
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- AllNewsAPI
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.14'
+description: A simple Ruby wrapper for the AllNewsAPI that allows you to search for
+  news articles, get headlines, and check usage statistics.
+email:
+- contact@allnewsapi.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/allnewsapi.rb
+- lib/allnewsapi/client.rb
+- lib/allnewsapi/error.rb
+- lib/allnewsapi/version.rb
+homepage: https://github.com/AllNewsAPI/ruby-sdk
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/AllNewsAPI/ruby-sdk
+  source_code_uri: https://github.com/AllNewsAPI/ruby-sdk
+  changelog_uri: https://github.com/AllNewsAPI/ruby-sdk/blob/main/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/allnewsapi
+  bug_tracker_uri: https://github.com/AllNewsAPI/ruby-sdk/issues
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.27
+signing_key:
+specification_version: 4
+summary: A Ruby SDK for the AllNewsAPI
+test_files: []