rubyrag 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: abbdc3c699787565500a9e55282a74bb54bb7066ff3af263100ddb49516f3503
-  data.tar.gz: a0336850672d490e3666dec3c1a03fedc4d25af69e988a288450c789a42359bb
+  metadata.gz: a06d4cbb6436336852a00e1ece33426edd6d12afb513a121504ad0cb429ceba3
+  data.tar.gz: d4e0a68cc490cf7bc22b81b1a0bc0fd7f69bee9b527b63c19f4b6344d3353e4f
 SHA512:
-  metadata.gz: 1bd5254fa1ae89ed174e749651c0891781d74990f6589fdef5bd911e8ed148817ee58bd19a577ec387fcfa2527e0caddd5c76fe2eb86bca264f38b866ef3d36b
-  data.tar.gz: 86ddbf4c00b41c7494db113d2403131aa00690d870297e26cc29476dd956cef88d36fca886f21177dc010e228c1ab52c70b18a194039418dbef9becbed468fdf
+  metadata.gz: 3f38e83268e4e012a18ff9743c8dbd0ce3de8bed17c72455314876d72c2ea86aa62eff37a410275437d0eb0c51cf4351ab1625d64db57414bcb7de1ea9875f4d
+  data.tar.gz: f4826cbb7da89d2b7e122a8532abaf1e883b9bccf5259ef81fd5f8888269f535a1164aaea5eca375b6440a4967743508f063483590b420fde283bbe43a4d30ab

data/.rubocop.yml

@@ -1,5 +1,7 @@
+inherit_from: .rubocop_todo.yml
+
 AllCops:
-  TargetRubyVersion: 3.1
+  TargetRubyVersion: 2.7.7
   NewCops: enable
 
 Style/StringLiterals:
@@ -7,3 +9,13 @@ Style/StringLiterals:
 
 Style/StringLiteralsInInterpolation:
   EnforcedStyle: double_quotes
+
+Gemspec/DevelopmentDependencies:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Layout/LineLength:
+  Exclude:
+    - rubyrag.gemspec

data/.rubocop_todo.yml

@@ -0,0 +1,30 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2025-04-10 19:57:10 UTC using RuboCop version 1.75.2.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
+Metrics/AbcSize:
+  Max: 21
+
+# Offense count: 1
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+# AllowedMethods: refine
+Metrics/BlockLength:
+  Max: 59
+
+# Offense count: 1
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+Metrics/MethodLength:
+  Max: 11
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns, SplitStrings.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 568

data/README.md

@@ -1,28 +1,44 @@
 # Rubyrag
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rubyrag`. To experiment with that code, run `bin/console` for an interactive prompt.
+Seamlessly integrate Cloudflare AutoRag into your Ruby on Rails applications with this gem. It provides a simple and idiomatic Ruby interface for leveraging AutoRag’s automatic retrieval-augmented generation (RAG) pipeline—making it easy to connect your app’s data with powerful AI models using Cloudflare Workers and Vectorize.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
-Install the gem and add to the application's Gemfile by executing:
 
 ```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+bundle add rubyrag
 ```
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
 ```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+gem install rubyrag
 ```
 
 ## Usage
 
-TODO: Write usage instructions here
+Setup Cloudflare Autorag
+![Setup Autorag](docs/create_rag.png)
+Get API keys for R2
+![Get API keys for R2](docs/create_api_key_for_r2.png) 
+Get API keys for AI
+![Get API keys for R2](docs/create_api_key_for_ai.png)
+Setup rubyrag
+```ruby
+client = Rubyrag.new(provider: :cloudflare_auto_rag,
+                     bucket: "bucket_name",
+                     access_key_id: "access_key_id",
+                     secret_access_key: "secret_access_key",
+                     r2_endpoint: "http://endpoint.com",
+                     autorag_endpoint: "http://endpoint.com",
+                     autorag_access_token: "autorag_access_token",)
+
+# Add file to index
+client.add(file_path: File.expand_path("file_with_text.txt", __dir__))
+
+# Query the rag
+client.query(query: "query")
+```
 
 ## Development
 
@@ -37,3 +53,4 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERN
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+

data/lib/rubyrag/cloudflare_auto_rag.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require "aws-sdk-s3"
+require "digest"
+require "net/http"
+require "uri"
+require "json"
+
+class Rubyrag
+  class Rags
+    class CloudflareAutoRag
+      attr_reader :client, :options
+
+      class Error < StandardError; end
+
+      DEFAULT_OPTIONS = {
+        region: "auto"
+      }.freeze
+
+      def initialize(options)
+        @options = options.merge(DEFAULT_OPTIONS)
+
+        @client = Aws::S3::Client.new(
+          access_key_id: options[:access_key_id],
+          secret_access_key: options[:secret_access_key],
+          endpoint: options[:r2_endpoint],
+          region: "auto"
+        )
+      end
+
+      def add(file_path:, key: nil)
+        raise Error, "Passed file: #{file_path}" unless File.exist?(file_path)
+
+        client.put_object(
+          bucket: options[:bucket],
+          key: key || Digest::MD5.file(file_path).hexdigest,
+          content_length: File.size(file_path),
+          body: File.open(file_path)
+        )
+      end
+
+      def query(query:)
+        raise Error, "Invalid or empty query provided" unless query.length.positive?
+
+        uri = URI("#{options[:autorag_endpoint]}/ai-search")
+
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+
+        request = Net::HTTP::Post.new(uri.path, {
+                                        "Content-Type" => "application/json",
+                                        "Authorization" => "Bearer #{options[:autorag_access_token]}"
+                                      })
+
+        request.body = { query: query }.to_json
+
+        response = http.request(request)
+
+        JSON.parse(response.body)
+      end
+    end
+  end
+end

data/lib/rubyrag.rb

@@ -1,6 +1,26 @@
 # frozen_string_literal: true
 
-module Rubyrag
+require "rubyrag/cloudflare_auto_rag"
+
+class Rubyrag
+  attr_reader :rag
+
   class Error < StandardError; end
-  # Your code goes here...
+
+  def initialize(provider:, **options)
+    @rag = case provider
+           when :cloudflare_auto_rag
+             Rubyrag::Rags::CloudflareAutoRag.new(options)
+           else
+             raise Error("Invalid provider: #{provider}")
+           end
+  end
+
+  def add(**options)
+    rag.add(**options)
+  end
+
+  def query(**options)
+    rag.query(**options)
+  end
 end

data/sig/rubyrag.rbs

@@ -1,4 +1,2 @@
 module Rubyrag
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
 end

metadata

@@ -1,14 +1,98 @@
 --- !ruby/object:Gem::Specification
 name: rubyrag
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Max Rukomoynikov
 bindir: exe
 cert_chain: []
-date: 2025-04-08 00:00:00.000000000 Z
-dependencies: []
+date: 2025-04-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-s3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: libxml-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Seamlessly integrate Cloudflare AutoRag into your Ruby on Rails applications
   with this gem. It provides a simple and idiomatic Ruby interface for leveraging
   AutoRag’s automatic retrieval-augmented generation (RAG) pipeline—making it easy
@@ -22,12 +106,17 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
+- ".rubocop_todo.yml"
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
 - Rakefile
 - docker-compose.yml
+- docs/create_api_key_for_ai.png
+- docs/create_api_key_for_r2.png
+- docs/create_rag.png
 - lib/rubyrag.rb
+- lib/rubyrag/cloudflare_auto_rag.rb
 - sig/rubyrag.rbs
 homepage: https://github.com/rukomoynikov/rubyrag
 licenses:
@@ -44,7 +133,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 2.7.7
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="