brave_search 0.1.0

data/lib/brave_search/storage/s3.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "uri"
+
+module BraveSearch
+  module Storage
+    class S3
+      def initialize(bucket:, access_key: nil, secret_key: nil, endpoint: nil, region: "us-east-1")
+        @bucket = bucket
+        @access_key = access_key || ENV.fetch("AWS_ACCESS_KEY_ID", nil)
+        @secret_key = secret_key || ENV.fetch("AWS_SECRET_ACCESS_KEY", nil)
+        @endpoint = endpoint || "https://s3.#{region}.amazonaws.com"
+        @region = region
+      end
+
+      def upload(content, key:)
+        # For now, simulate upload
+        {
+          key: key,
+          url: "#{@endpoint}/#{@bucket}/#{key}",
+          size: content.bytesize
+        }
+      end
+
+      def download(url, key:)
+        uri = URI(url)
+        response = Net::HTTP.get_response(uri)
+
+        raise "Download failed: #{response.code}" unless response.code == "200"
+
+        upload_result = upload(response.body, key: key)
+
+        {
+          key: key,
+          url: upload_result[:url],
+          size: response.body.bytesize,
+          original_url: url
+        }
+      end
+
+      private
+
+      attr_reader :bucket, :access_key, :secret_key, :endpoint, :region
+    end
+  end
+end

data/lib/brave_search/storage.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative "storage/s3"
+
+module BraveSearch
+  module Storage
+    ADAPTERS = {
+      aws: S3,
+      hetzner: S3,
+      digitalocean: S3,
+      s3: S3
+    }.freeze
+
+    def self.for(provider, **options)
+      adapter_class = ADAPTERS[provider]
+      raise ArgumentError, "Unknown storage provider: #{provider}" unless adapter_class
+
+      adapter_class.new(**options)
+    end
+  end
+end

data/lib/brave_search/summarizer.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module BraveSearch
+  class Summarizer
+    SEARCH_ENDPOINT = "/summarizer/search"
+    SUMMARY_ENDPOINT = "/summarizer/summary"
+
+    def initialize(client)
+      @client = client
+    end
+
+    def search_and_summarize(q:, **options)
+      params = build_search_params(q: q, **options)
+      make_summarizer_request(SEARCH_ENDPOINT, params)
+    end
+
+    def summarize(key:, **options)
+      params = build_summary_params(key: key, **options)
+      make_summarizer_request(SUMMARY_ENDPOINT, params)
+    end
+
+    private
+
+    def make_summarizer_request(endpoint, params)
+      response = @client.send(:make_request, endpoint, params, method: :post)
+      data = @client.send(:handle_response, response)
+      SummaryResult.new(data)
+    end
+
+    def build_search_params(q:, **options)
+      { q: q }.merge(options.compact)
+    end
+
+    def build_summary_params(key:, **options)
+      { key: key }.merge(options.compact)
+    end
+  end
+end

data/lib/brave_search/summary_result.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module BraveSearch
+  class SummaryResult
+    attr_reader :raw_data
+
+    def initialize(data)
+      @raw_data = data
+    end
+
+    def summary
+      @raw_data.dig(:summarizer, :summary) || []
+    end
+
+    def key
+      @raw_data.dig(:summarizer, :key)
+    end
+
+    def status
+      @raw_data.dig(:summarizer, :status)
+    end
+
+    def type
+      @raw_data.dig(:summarizer, :type)
+    end
+
+    def enriched_results
+      results = @raw_data.dig(:summarizer, :enriched_results) || []
+      results.map { |result| EnrichedResult.new(result) }
+    end
+
+    # Support pattern matching (Ruby 3+)
+    def deconstruct_keys(keys)
+      hash = {
+        summary: summary,
+        key: key,
+        status: status,
+        type: type,
+        enriched_results: enriched_results
+      }
+      keys ? hash.slice(*keys) : hash
+    end
+
+    def to_h
+      @raw_data
+    end
+  end
+
+  class EnrichedResult
+    attr_reader :raw_data
+
+    def initialize(data)
+      @raw_data = data
+    end
+
+    def title
+      @raw_data[:title]
+    end
+
+    def url
+      @raw_data[:url]
+    end
+
+    def description
+      @raw_data[:description]
+    end
+
+    def snippets
+      @raw_data[:snippets] || []
+    end
+
+    def to_h
+      @raw_data
+    end
+  end
+end

data/lib/brave_search/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module BraveSearch
+  VERSION = "0.1.0"
+end

data/lib/brave_search.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "brave_search/version"
+require_relative "brave_search/configuration"
+require_relative "brave_search/results"
+require_relative "brave_search/storage"
+require_relative "brave_search/pdf_downloader"
+require_relative "brave_search/exporter"
+require_relative "brave_search/summarizer"
+require_relative "brave_search/summary_result"
+require_relative "brave_search/client"
+require_relative "brave_search/async_client"
+require_relative "brave_search/railtie" if defined?(Rails)
+
+if defined?(ActiveJob)
+  require_relative "brave_search/jobs/export_job"
+  require_relative "brave_search/jobs/pdf_download_job"
+end
+
+module BraveSearch
+  class Error < StandardError; end
+  class AuthenticationError < Error; end
+  class RateLimitError < Error; end
+  class QuotaExceededError < Error; end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  def self.config
+    self.configuration ||= Configuration.new
+  end
+end

data/lib/generators/brave_search/install_generator.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module BraveSearch
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("templates", __dir__)
+
+    def create_initializer
+      create_file "config/initializers/brave_search.rb", <<~RUBY
+        # frozen_string_literal: true
+
+        BraveSearch.configure do |config|
+          # Get your API key from https://brave.com/search/api/
+          config.api_key = Rails.application.credentials.brave_api_key
+        #{'  '}
+          # Optional configuration
+          # config.timeout = 30
+          # config.retry_attempts = 3
+        end
+      RUBY
+    end
+
+    def show_instructions
+      say <<~TEXT
+
+        BraveSearch has been installed!
+
+        Next steps:
+        1. Get your API key from https://brave.com/search/api/
+        2. Add it to your Rails credentials:
+           rails credentials:edit
+        #{'   '}
+           Add this line:
+           brave_api_key: your_api_key_here
+
+        3. Use the client:
+           client = BraveSearch::Client.new
+           results = client.search(q: "ruby programming")
+
+      TEXT
+    end
+  end
+end

data/test_with_real_api.rb

@@ -0,0 +1,69 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative "lib/brave_search"
+require "json"
+
+puts "BraveSearch Real API Test"
+puts "=" * 40
+
+# Check for API key
+api_key = ENV.fetch("BRAVE_API_KEY", nil)
+if api_key.nil? || api_key.empty?
+  puts "❌ Please set BRAVE_API_KEY environment variable"
+  puts "Usage: BRAVE_API_KEY=your_key ruby test_with_real_api.rb"
+  exit 1
+end
+
+begin
+  client = BraveSearch::Client.new(api_key: api_key)
+  puts "✅ Client initialized with API key: #{api_key[0..8]}..."
+
+  # Test basic search
+  puts "\n🔍 Testing search: 'ruby programming'"
+  results = client.search(q: "ruby programming", count: 3)
+
+  puts "✅ Search successful!"
+  puts "Query: #{results.dig(:query, :original) || 'ruby programming'}"
+
+  if results[:web] && results[:web][:results]
+    puts "📄 Found #{results[:web][:results].length} web results:"
+
+    results[:web][:results].each_with_index do |result, i|
+      puts "\n#{i + 1}. #{result[:title]}"
+      puts "   URL: #{result[:url]}"
+      puts "   Description: #{result[:description][0..100]}..." if result[:description]
+    end
+  end
+
+  # Test news search if available
+  if results[:news] && results[:news][:results] && !results[:news][:results].empty?
+    puts "\n📰 News results found: #{results[:news][:results].length}"
+    results[:news][:results].first(2).each_with_index do |news, i|
+      puts "#{i + 1}. #{news[:title]} (#{news[:meta_tag]})"
+    end
+  end
+
+  # Show raw response structure
+  puts "\n📊 Response structure:"
+  puts "Available sections: #{results.keys.join(', ')}"
+
+  # Test different query
+  puts "\n🔍 Testing search: 'Rails 8 features'"
+  rails_results = client.search(q: "Rails 8 features", count: 2)
+  puts "✅ Second search successful!"
+  puts "Found #{rails_results.dig(:web, :results)&.length || 0} results"
+
+  puts "\n🎉 All tests passed!"
+rescue BraveSearch::AuthenticationError => e
+  puts "❌ Authentication failed: #{e.message}"
+  puts "Check your API key at https://brave.com/search/api/"
+rescue BraveSearch::RateLimitError => e
+  puts "❌ Rate limit exceeded: #{e.message}"
+rescue BraveSearch::QuotaExceededError => e
+  puts "❌ Quota exceeded: #{e.message}"
+rescue StandardError => e
+  puts "❌ Error: #{e.message}"
+  puts "Class: #{e.class}"
+  puts e.backtrace.first(3) if ENV["DEBUG"]
+end

metadata

@@ -0,0 +1,248 @@
+--- !ruby/object:Gem::Specification
+name: brave_search
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Remi AI
+bindir: exe
+cert_chain: []
+date: 2025-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: async
+  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'
+- !ruby/object:Gem::Dependency
+  name: caxlsx
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.50'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.50'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.20'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+description: Simple Ruby client for Brave Search API with Rails integration
+email:
+- denis@goremi.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- README.md
+- Rakefile
+- brave_search.gemspec
+- dummy_app/.dockerignore
+- dummy_app/.github/dependabot.yml
+- dummy_app/.github/workflows/ci.yml
+- dummy_app/.rubocop.yml
+- dummy_app/Dockerfile
+- dummy_app/Gemfile
+- dummy_app/README.md
+- dummy_app/Rakefile
+- dummy_app/app/controllers/application_controller.rb
+- dummy_app/app/controllers/concerns/.keep
+- dummy_app/app/controllers/searches_controller.rb
+- dummy_app/app/jobs/application_job.rb
+- dummy_app/app/mailers/application_mailer.rb
+- dummy_app/app/models/application_record.rb
+- dummy_app/app/models/concerns/.keep
+- dummy_app/app/views/layouts/mailer.html.erb
+- dummy_app/app/views/layouts/mailer.text.erb
+- dummy_app/bin/brakeman
+- dummy_app/bin/dev
+- dummy_app/bin/docker-entrypoint
+- dummy_app/bin/rails
+- dummy_app/bin/rake
+- dummy_app/bin/rubocop
+- dummy_app/bin/setup
+- dummy_app/bin/thrust
+- dummy_app/config.ru
+- dummy_app/config/application.rb
+- dummy_app/config/boot.rb
+- dummy_app/config/cable.yml
+- dummy_app/config/database.yml
+- dummy_app/config/environment.rb
+- dummy_app/config/environments/development.rb
+- dummy_app/config/environments/production.rb
+- dummy_app/config/environments/test.rb
+- dummy_app/config/initializers/brave_search.rb
+- dummy_app/config/initializers/cors.rb
+- dummy_app/config/initializers/filter_parameter_logging.rb
+- dummy_app/config/initializers/inflections.rb
+- dummy_app/config/locales/en.yml
+- dummy_app/config/puma.rb
+- dummy_app/config/routes.rb
+- dummy_app/config/storage.yml
+- dummy_app/db/seeds.rb
+- dummy_app/lib/tasks/.keep
+- dummy_app/public/robots.txt
+- dummy_app/script/.keep
+- dummy_app/test/controllers/.keep
+- dummy_app/test/fixtures/files/.keep
+- dummy_app/test/integration/.keep
+- dummy_app/test/mailers/.keep
+- dummy_app/test/models/.keep
+- dummy_app/test/test_helper.rb
+- dummy_app/vendor/.keep
+- example.rb
+- lib/brave_search.rb
+- lib/brave_search/async_client.rb
+- lib/brave_search/client.rb
+- lib/brave_search/configuration.rb
+- lib/brave_search/exporter.rb
+- lib/brave_search/exporters/base.rb
+- lib/brave_search/exporters/csv.rb
+- lib/brave_search/exporters/json.rb
+- lib/brave_search/exporters/xlsx.rb
+- lib/brave_search/jobs/export_job.rb
+- lib/brave_search/jobs/pdf_download_job.rb
+- lib/brave_search/pdf_downloader.rb
+- lib/brave_search/railtie.rb
+- lib/brave_search/results.rb
+- lib/brave_search/storage.rb
+- lib/brave_search/storage/s3.rb
+- lib/brave_search/summarizer.rb
+- lib/brave_search/summary_result.rb
+- lib/brave_search/version.rb
+- lib/generators/brave_search/install_generator.rb
+- test_with_real_api.rb
+homepage: https://github.com/Remi-org/brave-search-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Remi-org/brave-search-ruby
+  source_code_uri: https://github.com/Remi-org/brave-search-ruby
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Ruby client for Brave Search API
+test_files: []