ruby-text2sql 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3a9f97011365b686bbe91ce6b095e462d3f09804f9480c6795e11e3a0ce57d3
-  data.tar.gz: 3b5bffd84f79245138b5b283d1b737197e221accbb42000b6f005e9c6b289905
+  metadata.gz: dfaa44f0339d328ce49d43002837c15aecaa6f26ef61ed19a0815f2ee88a5fb4
+  data.tar.gz: 6fed3d7a77b38851fa4790ff881103ef82938e7a37440ab9c303fac0f5af0d10
 SHA512:
-  metadata.gz: 5743d2762d4d58e710ee6ac1383dac01e31215755d09170657bb3d781d402ade28f64eb7d8418eb60e4d1cc64a106ca0abbb7205c6341d9556e191621642f7d3
-  data.tar.gz: d50db50d2bdb5d470457a83f8ba05ce7a3f4e36857e22a950d85bfe07a4da5bf56bb6e52d955c43e4f8cef330deafb36ffb23943d6db430094dd8f4d92b1d47d
+  metadata.gz: b3409fa5ad821c60e177533bdbdd19ee7d77e605ebc42810bee2d912b600e3fb568a9210aa9bac845bb91f04564822f7510ee6fc99024defdf8bd8a90b2d04c9
+  data.tar.gz: f0f4eaeef6f1c88e78f8b8c9b175f2fb6b29d41ea9e50fa65b54add829d7f2647d2aca723d3975f284537652274c05f807a7d11eeb50ca6ce2bb4a200ef76dfe

data/.rubocop.yml

@@ -1,5 +1,6 @@
 AllCops:
   TargetRubyVersion: 2.6
+  NewCops: enable
 
 Style/StringLiterals:
   Enabled: true
@@ -11,3 +12,24 @@ Style/StringLiteralsInInterpolation:
 
 Layout/LineLength:
   Max: 120
+
+FactoryBot/CreateList:
+  AutoCorrect: true
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 20
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
+require:
+  - rubocop-rspec

data/README.md

@@ -1,24 +1,39 @@
 # Ruby::Text2sql
 
-TODO: Delete this and the text below, and describe your gem
+**Chat with your Database!**
 
-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/ruby/text2sql`. To experiment with that code, run `bin/console` for an interactive prompt.
+How It Works?
 
-## Installation
+Text2SQL takes:
+- **Your natural language Query** (in any language).
+- **Your OpenAI API Key** to process the query.
+- **Your Database Schema** to understand table structures.
+
+Using these, Text2SQL generates SQL queries, executes them, and returns results in a human-readable format—simplifying data access for both developers and non-developers.
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_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.
+## Installation
 
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+    $ bundle add ruby-text2sq
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+    $ gem install ruby-text2sq
 
 ## Usage
 
-TODO: Write usage instructions here
+- Set your `OPENAI_API_KEY` as an environment variable in `.env`.
+
+- Use `Text2sql.call` method with a plain-text query. Here’s an example:
+```
+require 'text2sql'
+
+response = Ruby::Text2sql.call("List all users who registered in the last 30 days")
+puts "SQL Query: #{response[:sql_query]}"                    # Outputs the generated SQL query
+puts "Query Result: #{response[:query_result]}"              # Outputs the result of the SQL query
+puts "Response: #{response[:natural_language_response]}"     # Outputs a human-readable response
+```
 
 ## Development
 
@@ -28,7 +43,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ruby-text2sql. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/ruby-text2sql/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/nicofh/ruby-text2sql. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/nicofh/ruby-text2sql/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -36,4 +51,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Ruby::Text2sql project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/ruby-text2sql/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Ruby::Text2sql project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/nicofh/ruby-text2sql/blob/master/CODE_OF_CONDUCT.md).

data/lib/ruby/text2sql/version.rb

@@ -2,6 +2,6 @@
 
 module Ruby
   module Text2sql
-    VERSION = "0.1.0"
+    VERSION = "1.0.0"
   end
 end

data/lib/ruby/text2sql.rb

@@ -33,25 +33,31 @@ module Ruby
       private
 
       def client
-        @client ||= OpenAI::Client.new(access_token: ENV["OPENAI_API_KEY"])
+        @client ||= OpenAI::Client.new(access_token: ENV.fetch("OPENAI_API_KEY", nil))
       end
 
       def generate_sql_query(user_request, schema)
-        full_prompt = "Ruby Schema:\n#{schema}\n\nUser Request: #{user_request}\n\nGenerate only the SQL query to answer the request. Do not include any explanation or additional text. If the request doesn't make sense just return 'SELECT '#{user_request}';'."
-        
+        full_prompt = "Ruby Schema:\n#{schema}\n\n
+                      User Request: #{user_request}\n\n
+                      Generate only the SQL query to answer the request.
+                      Do not include any explanation or additional text.
+                      If the request doesn't make sense just return 'SELECT '#{user_request}';'."
+
         response = client.chat(
           parameters: {
             model: "gpt-3.5-turbo",
             messages: [{ role: "system", content: "You are an expert SQL generator." },
-              { role: "user", content: full_prompt }]
-            }
-          )
+                       { role: "user", content: full_prompt }]
+          }
+        )
 
         response["choices"][0]["message"]["content"].strip
       end
 
       def generate_response(user_request, query_result)
-        result_prompt = "User Request: #{user_request}\nSQL Query Result: #{query_result.inspect}\n\nAnswer the user's request in natural language. Answer in the same language as the question"
+        result_prompt = "User Request: #{user_request}\n
+                         SQL Query Result: #{query_result.inspect}\n\n
+                         Answer the user's request in natural language. Answer in the same language as the question"
 
         response = client.chat(
           parameters: {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-text2sql
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Nicolas Fabre
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-15 00:00:00.000000000 Z
+date: 2024-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-openai
@@ -24,10 +24,10 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '7.1'
-description: Text2SQL is a gem designed to generate SQL queries from natural language
-  inputs. It leverages machine learning models to interpret schema files and user
-  inputs, generating SQL queries that can be executed and returning results in a human-readable
-  format.
+description: |-
+  Text2SQL is a gem designed to generate SQL queries from natural language inputs.
+                        It leverages machine learning models to interpret schema files and user inputs,
+                        generating SQL queries that can be executed and returning results in a human-readable format.
 email:
 - nicofh93@gmail.com
 executables: []
@@ -45,7 +45,6 @@ files:
 - lib/ruby/text2sql/schema_parser.rb
 - lib/ruby/text2sql/sql_executor.rb
 - lib/ruby/text2sql/version.rb
-- ruby-text2sql.gemspec
 - sig/ruby/text2sql.rbs
 homepage: https://github.com/nicofh/ruby-text2sql
 licenses:
@@ -55,6 +54,7 @@ metadata:
   homepage_uri: https://github.com/nicofh/ruby-text2sql
   source_code_uri: https://github.com/nicofh/ruby-text2sql
   changelog_uri: https://github.com/nicofh/ruby-text2sql/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -70,7 +70,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: A Ruby gem to convert natural language to SQL queries using LLMs.

data/ruby-text2sql.gemspec

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/ruby/text2sql/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "ruby-text2sql"
-  spec.version = Ruby::Text2sql::VERSION
-  spec.authors = ["Nicolas Fabre"]
-  spec.email = ["nicofh93@gmail.com"]
-
-  spec.summary = "A Ruby gem to convert natural language to SQL queries using LLMs."
-  spec.description = "Text2SQL is a gem designed to generate SQL queries from natural language inputs. It leverages machine learning models to interpret schema files and user inputs, generating SQL queries that can be executed and returning results in a human-readable format."
-  spec.homepage = "https://github.com/nicofh/ruby-text2sql"
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.6.0"
-
-  spec.metadata["allowed_push_host"] = "https://rubygems.org"
-
-  spec.metadata["homepage_uri"] = "https://github.com/nicofh/ruby-text2sql"
-  spec.metadata["source_code_uri"] = "https://github.com/nicofh/ruby-text2sql"
-  spec.metadata["changelog_uri"] = "https://github.com/nicofh/ruby-text2sql/blob/main/CHANGELOG.md"
-
-  # 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(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (File.expand_path(f) == __FILE__) ||
-        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile])
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  # Uncomment to register a new dependency of your gem
-  spec.add_dependency "ruby-openai", "~> 7.1"
-
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
-end