exaonruby 1.0.0

data/lib/exa.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+# typed: strict
+
+require_relative "exa/version"
+require_relative "exa/errors"
+require_relative "exa/configuration"
+
+require_relative "exa/utils/parameter_converter"
+require_relative "exa/utils/webhook_handler"
+
+require_relative "exa/resources/base"
+require_relative "exa/resources/search_result"
+require_relative "exa/resources/search_response"
+require_relative "exa/resources/contents_response"
+require_relative "exa/resources/answer_response"
+require_relative "exa/resources/research_task"
+require_relative "exa/resources/webset"
+require_relative "exa/resources/webset_item"
+require_relative "exa/resources/paginated_response"
+require_relative "exa/resources/monitor"
+require_relative "exa/resources/import"
+require_relative "exa/resources/webhook"
+require_relative "exa/resources/event"
+
+require_relative "exa/endpoints/search"
+require_relative "exa/endpoints/contents"
+require_relative "exa/endpoints/find_similar"
+require_relative "exa/endpoints/answer"
+require_relative "exa/endpoints/research"
+require_relative "exa/endpoints/websets"
+require_relative "exa/endpoints/webset_items"
+require_relative "exa/endpoints/webset_searches"
+require_relative "exa/endpoints/webset_enrichments"
+require_relative "exa/endpoints/monitors"
+require_relative "exa/endpoints/imports"
+require_relative "exa/endpoints/webhooks"
+require_relative "exa/endpoints/events"
+
+require_relative "exa/client"
+
+module Exa
+  class << self
+    # @return [Configuration] Global configuration
+    attr_accessor :configuration
+
+    # @return [Logger, nil] Optional logger for debug output
+    attr_accessor :logger
+
+    # Configures the Exa gem globally
+    #
+    # @yield [Configuration] Configuration instance
+    #
+    # @example Configure globally
+    #   Exa.configure do |config|
+    #     config.api_key = "your-api-key"
+    #     config.timeout = 120
+    #   end
+    def configure
+      self.configuration ||= Configuration.new
+      yield(configuration)
+    end
+
+    # Returns a default client using global configuration
+    #
+    # @return [Client] Default client instance
+    #
+    # @example Using default client
+    #   Exa.configure { |c| c.api_key = ENV["EXA_API_KEY"] }
+    #   results = Exa.client.search("AI research")
+    def client
+      @client ||= Client.new do |config|
+        if configuration
+          config.api_key = configuration.api_key
+          config.base_url = configuration.base_url
+          config.websets_base_url = configuration.websets_base_url
+          config.timeout = configuration.timeout
+          config.max_retries = configuration.max_retries
+          config.retry_delay = configuration.retry_delay
+          config.max_retry_delay = configuration.max_retry_delay
+          config.retry_statuses = configuration.retry_statuses.dup
+          config.retry_exceptions = configuration.retry_exceptions.dup
+        end
+      end
+    end
+
+    # Resets the default client (useful for testing)
+    #
+    # @return [void]
+    def reset_client!
+      @client = nil
+    end
+
+    # Convenience method to perform a search using the default client
+    #
+    # @param query [String] Search query
+    # @param options [Hash] Search options
+    # @return [Resources::SearchResponse] Search results
+    #
+    # @example Quick search
+    #   Exa.search("Latest AI research", text: true)
+    def search(query, **options)
+      client.search(query, **options)
+    end
+
+    # Convenience method to get contents using the default client
+    #
+    # @param urls [Array<String>] URLs to fetch
+    # @param options [Hash] Content options
+    # @return [Resources::ContentsResponse] Contents results
+    #
+    # @example Quick contents
+    #   Exa.get_contents(["https://example.com"])
+    def get_contents(urls, **options)
+      client.get_contents(urls, **options)
+    end
+
+    # Convenience method to find similar links using the default client
+    #
+    # @param url [String] Source URL
+    # @param options [Hash] Search options
+    # @return [Resources::SearchResponse] Similar links
+    #
+    # @example Quick find similar
+    #   Exa.find_similar("https://example.com/article")
+    def find_similar(url, **options)
+      client.find_similar(url, **options)
+    end
+  end
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: exaonruby
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- tigel-agm
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: faraday-retry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  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'
+description: A production-ready Ruby gem wrapper for the Exa.ai Search and Websets
+  APIs. Features neural search, LLM-powered answers, async research tasks, Websets
+  management (monitors, imports, webhooks), and a beautiful CLI. Includes n8n/Zapier
+  webhook signature verification utilities.
+email: []
+executables:
+- exa
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- exaonruby.gemspec
+- exe/exa
+- lib/exa.rb
+- lib/exa/cli.rb
+- lib/exa/client.rb
+- lib/exa/configuration.rb
+- lib/exa/endpoints/answer.rb
+- lib/exa/endpoints/contents.rb
+- lib/exa/endpoints/events.rb
+- lib/exa/endpoints/find_similar.rb
+- lib/exa/endpoints/imports.rb
+- lib/exa/endpoints/monitors.rb
+- lib/exa/endpoints/research.rb
+- lib/exa/endpoints/search.rb
+- lib/exa/endpoints/webhooks.rb
+- lib/exa/endpoints/webset_enrichments.rb
+- lib/exa/endpoints/webset_items.rb
+- lib/exa/endpoints/webset_searches.rb
+- lib/exa/endpoints/websets.rb
+- lib/exa/errors.rb
+- lib/exa/resources/answer_response.rb
+- lib/exa/resources/base.rb
+- lib/exa/resources/contents_response.rb
+- lib/exa/resources/event.rb
+- lib/exa/resources/import.rb
+- lib/exa/resources/monitor.rb
+- lib/exa/resources/paginated_response.rb
+- lib/exa/resources/research_task.rb
+- lib/exa/resources/search_response.rb
+- lib/exa/resources/search_result.rb
+- lib/exa/resources/webhook.rb
+- lib/exa/resources/webset.rb
+- lib/exa/resources/webset_item.rb
+- lib/exa/utils/parameter_converter.rb
+- lib/exa/utils/webhook_handler.rb
+- lib/exa/version.rb
+homepage: https://github.com/tigel-agm/exaonruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/tigel-agm/exaonruby
+  source_code_uri: https://github.com/tigel-agm/exaonruby
+  changelog_uri: https://github.com/tigel-agm/exaonruby/blob/main/CHANGELOG.md
+  documentation_uri: https://github.com/tigel-agm/exaonruby#readme
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.2
+specification_version: 4
+summary: Complete Ruby client for the Exa.ai API with beautiful CLI
+test_files: []