rails-nl2sql 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 87e9ce4d9e33ac2e3620b824a2103b452f0faccc4ea3f50fb5535a3bbdfd2791
+  data.tar.gz: d098ab06c8ac24a0cef6b31fd827470667dafb4f014a7d8cd4b9f63b70a479a0
+SHA512:
+  metadata.gz: ff7b5738ad5b10aec1a005a91858e54a46f7af95e0adbcb862337c7d6c3069c89cdf8578463233e3e0b705f914c491b0fec2ef6631f3dd9296680ade9f3d019a
+  data.tar.gz: 2b2449a921c1262000c99eae8cbc6532964576c46ebb8a1f47dc1781c947a491b1bb95aef63a72a5bcdad30368975ba4f20f40164727213fc564a60c122d72e5

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/
+/spec/dummy/
+/*.gem
+/.rspec
+/spec/rails_helper.rb
+/spec/spec_helper.rb

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in rails-nl2sql.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,95 @@
+PATH
+  remote: .
+  specs:
+    rails-nl2sql (0.1.0)
+      openai (~> 0.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (6.1.4.7)
+      actionview (= 6.1.4.7)
+      activesupport (= 6.1.4.7)
+      rack (~> 2.0, >= 2.0.9)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (6.1.4.7)
+      activesupport (= 6.1.4.7)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activesupport (6.1.4.7)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    builder (3.3.0)
+    concurrent-ruby (1.3.5)
+    crass (1.0.6)
+    diff-lcs (1.6.2)
+    erubi (1.13.1)
+    i18n (1.14.7)
+      concurrent-ruby (~> 1.0)
+    loofah (2.24.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    method_source (1.1.0)
+    mini_portile2 (2.8.9)
+    minitest (5.25.4)
+    nokogiri (1.13.10)
+      mini_portile2 (~> 2.8.0)
+      racc (~> 1.4)
+    openai (0.3.0)
+    racc (1.8.1)
+    rack (2.2.17)
+    rack-test (2.2.0)
+      rack (>= 1.3)
+    rails-dom-testing (2.3.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.5.0)
+      loofah (~> 2.19, >= 2.19.1)
+    railties (6.1.4.7)
+      actionpack (= 6.1.4.7)
+      activesupport (= 6.1.4.7)
+      method_source
+      rake (>= 0.13)
+      thor (~> 1.0)
+    rake (10.5.0)
+    rspec-core (3.13.5)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-rails (6.1.5)
+      actionpack (>= 6.1)
+      activesupport (>= 6.1)
+      railties (>= 6.1)
+      rspec-core (~> 3.13)
+      rspec-expectations (~> 3.13)
+      rspec-mocks (~> 3.13)
+      rspec-support (~> 3.13)
+    rspec-support (3.13.4)
+    thor (1.3.2)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.6.18)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  rails-nl2sql!
+  rake (~> 10.0)
+  rspec-rails
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Van Curen
+
+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,71 @@
+# Rails NL2SQL
+
+This gem provides an easy way to integrate natural language to SQL functionality into your Ruby on Rails projects. It uses AI models to convert natural language queries into SQL statements.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails-nl2sql'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails-nl2sql
+
+Next, you need to run the install generator:
+
+    $ rails generate rails:nl2sql:install
+
+This will create an initializer file at `config/initializers/rails_nl2sql.rb`. You will need to configure your OpenAI API key in this file.
+
+```ruby
+# config/initializers/rails_nl2sql.rb
+Rails::Nl2sql.configure do |config|
+  config.api_key = ENV["OPENAI_API_KEY"] # It's recommended to use an environment variable
+  # config.model = "text-davinci-003" # Optional: Specify the AI model to use (default is text-davinci-003)
+end
+```
+
+Make sure to set the `OPENAI_API_KEY` environment variable in your development and production environments.
+
+## Usage
+
+To execute a natural language query, you can use the `execute` method:
+
+```ruby
+results = Rails::Nl2sql::Processor.execute("Show me all the users from California")
+```
+
+You can also specify which tables to include or exclude:
+
+```ruby
+results = Rails::Nl2sql::Processor.execute("Show me all the orders for the user with email 'test@example.com'", include: ["users", "orders"])
+```
+
+### Getting a list of tables
+
+```ruby
+Rails::Nl2sql::Processor.get_tables
+```
+
+### Getting the schema
+
+```ruby
+Rails::Nl2sql::Processor.get_schema(include: ["users", "orders"])
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/vancuren/rails-nl2sql.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rails/nl2sql"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/generators/rails/nl2sql/install_generator.rb

@@ -0,0 +1,15 @@
+require 'rails/generators'
+
+module Rails
+  module Nl2sql
+    module Generators
+      class InstallGenerator < Rails::Generators::Base
+        source_root File.expand_path('../templates', __FILE__)
+
+        def copy_initializer
+          template 'rails_nl2sql.rb', 'config/initializers/rails_nl2sql.rb'
+        end
+      end
+    end
+  end
+end

data/lib/generators/rails/nl2sql/templates/rails_nl2sql.rb

@@ -0,0 +1,4 @@
+Rails::Nl2sql.configure do |config|
+  config.api_key = "YOUR_API_KEY"
+  # config.model = "text-davinci-003"
+end

data/lib/rails/nl2sql/query_generator.rb

@@ -0,0 +1,26 @@
+require "openai"
+
+module Rails
+  module Nl2sql
+    class QueryGenerator
+      def initialize(api_key, model = "text-davinci-003")
+        @client = OpenAI::Client.new(api_key: api_key)
+        @model = model
+      end
+
+      def generate_query(prompt, schema)
+        full_prompt = "Given the following schema:\n\n#{schema}\n\nGenerate a SQL query for the following request:\n\n#{prompt}"
+
+        response = @client.completions(
+          parameters: {
+            model: @model,
+            prompt: full_prompt,
+            max_tokens: 150
+          }
+        )
+
+        response.choices.first.text.strip
+      end
+    end
+  end
+end

data/lib/rails/nl2sql/query_validator.rb

@@ -0,0 +1,22 @@
+module Rails
+  module Nl2sql
+    class QueryValidator
+      def self.validate(query)
+        # Basic validation: prevent destructive commands
+        disallowed_keywords = %w(DROP DELETE UPDATE INSERT TRUNCATE ALTER CREATE)
+        if disallowed_keywords.any? { |keyword| query.upcase.include?(keyword) }
+          raise "Query contains disallowed keywords."
+        end
+
+        # Use Rails' built-in sanitization to be safe
+        begin
+          ActiveRecord::Base.connection.execute("EXPLAIN #{query}")
+        rescue ActiveRecord::StatementInvalid => e
+          raise "Invalid SQL query: #{e.message}"
+        end
+
+        true
+      end
+    end
+  end
+end

data/lib/rails/nl2sql/railtie.rb

@@ -0,0 +1,14 @@
+require "rails/nl2sql"
+require "rails"
+
+module Rails
+  module Nl2sql
+    class Railtie < Rails::Railtie
+      initializer "rails-nl2sql.configure_rails_initialization" do |app|
+        app.config.after_initialize do
+          # Nothing to do here for now
+        end
+      end
+    end
+  end
+end

data/lib/rails/nl2sql/schema_builder.rb

@@ -0,0 +1,18 @@
+module Rails
+  module Nl2sql
+    class SchemaBuilder
+      def self.build_schema(options = {})
+        tables = ActiveRecord::Base.connection.tables
+        tables -= options[:exclude] if options[:exclude]
+        tables = options[:include] if options[:include]
+
+        schema = {}
+        tables.each do |table|
+          schema[table] = ActiveRecord::Base.connection.columns(table).map(&:name)
+        end
+
+        schema
+      end
+    end
+  end
+end

data/lib/rails/nl2sql/version.rb

@@ -0,0 +1,5 @@
+module Rails
+  module Nl2sql
+    VERSION = "0.1.1"
+  end
+end

data/lib/rails/nl2sql.rb

@@ -0,0 +1,40 @@
+require "rails/nl2sql/version"
+require "rails/nl2sql/query_generator"
+require "rails/nl2sql/schema_builder"
+require "rails/nl2sql/query_validator"
+
+module Rails
+  module Nl2sql
+    class Error < StandardError; end
+
+    class << self
+      attr_accessor :api_key
+      attr_accessor :model
+    end
+    @@model = "text-davinci-003"
+
+    def self.configure
+      yield self
+    end
+
+    class Processor
+      def self.execute(natural_language_query, options = {})
+        schema = SchemaBuilder.build_schema(options)
+        query_generator = QueryGenerator.new(Rails::Nl2sql.api_key, Rails::Nl2sql.model)
+        generated_query = query_generator.generate_query(natural_language_query, schema)
+
+        QueryValidator.validate(generated_query)
+
+        ActiveRecord::Base.connection.execute(generated_query)
+      end
+
+      def self.get_tables(options = {})
+        ActiveRecord::Base.connection.tables
+      end
+
+      def self.get_schema(options = {})
+        SchemaBuilder.build_schema(options)
+      end
+    end
+  end
+end

data/rails-nl2sql.gemspec

@@ -0,0 +1,43 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rails/nl2sql/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails-nl2sql"
+  spec.version       = Rails::Nl2sql::VERSION
+  spec.authors       = ["Russell Van Curen"]
+  spec.email         = ["russell@vancuren.net"]
+
+  spec.summary       = %q{A Ruby on Rails gem for converting natural language to SQL.}
+  spec.description   = %q{This gem provides an easy way to integrate natural language to SQL functionality into your Ruby on Rails projects. It uses AI models to convert natural language queries into SQL statements.}
+  spec.homepage      = "https://github.com/vancuren/rails-nl2sql"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/vancuren/rails-nl2sql"
+    spec.metadata["changelog_uri"] = "https://github.com/vancuren/rails-nl2sql/blob/main/CHANGELOG.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "openai", "~> 0.3"
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec-rails", "~> 6.0"
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: rails-nl2sql
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Russell Van Curen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2025-07-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: openai
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description: This gem provides an easy way to integrate natural language to SQL functionality
+  into your Ruby on Rails projects. It uses AI models to convert natural language
+  queries into SQL statements.
+email:
+- russell@vancuren.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/rails/nl2sql/install_generator.rb
+- lib/generators/rails/nl2sql/templates/rails_nl2sql.rb
+- lib/rails/nl2sql.rb
+- lib/rails/nl2sql/query_generator.rb
+- lib/rails/nl2sql/query_validator.rb
+- lib/rails/nl2sql/railtie.rb
+- lib/rails/nl2sql/schema_builder.rb
+- lib/rails/nl2sql/version.rb
+- rails-nl2sql.gemspec
+homepage: https://github.com/vancuren/rails-nl2sql
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/vancuren/rails-nl2sql
+  source_code_uri: https://github.com/vancuren/rails-nl2sql
+  changelog_uri: https://github.com/vancuren/rails-nl2sql/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '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: A Ruby on Rails gem for converting natural language to SQL.
+test_files: []