human_sql 0.1.0 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28c8b51819d0630673469964904069f4dd8cfb31a76f9afe439f28f5184a6376
-  data.tar.gz: 9c17f374223cd3d1eecbe147eef5e926b03c36501b7c7188525549202d59d2a9
+  metadata.gz: 252749f91542523c968e6819c589754afd16ff53fe5dc2851ce55b82c67fc42a
+  data.tar.gz: eab62bcd1da26e6d3f89bd1d6859122b9524dd769a24978f7fe0277e60867a9d
 SHA512:
-  metadata.gz: a0fa556ecb44c2151999eb741a128fc00846d645e31652940c292a4fe2172df3a9088a5b470ec68f352f0d5675633e4ed078fcadd427e18752e92cf90244646d
-  data.tar.gz: a712c3f78aa08d7c86ddcbd4e7c83e5abf9fde5cb6fca298fdbec80d977bd6bf89fd0cb49ab75f52852b647519a9e0142066a03d5197f7aaf460ad4f27efc767
+  metadata.gz: 1d8aeb7e0cb4247509445c9105c3885ff8395f576b35c136d0ee410f963110f9880b1f35e37bad6af32c633860486580908b8fab9c67ff9a0fab92f3e771bb08
+  data.tar.gz: eaabff247f028ec2553440ca0f52029a7bd6b32e080f3d2f4b12fcaf2de1c944858b1562488ae666a03bc459c2800cc304456eda7e0a951e792a6fe593c7131d

data/CODE_OF_CONDUCT.md

@@ -60,8 +60,7 @@ representative at an online or offline event.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
-[INSERT CONTACT METHOD].
-All complaints will be reviewed and investigated promptly and fairly.
+[mail@nicobertin.dev]. All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the
 reporter of any incident.
@@ -129,4 +128,4 @@ For answers to common questions about this code of conduct, see the FAQ at
 [v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
 [Mozilla CoC]: https://github.com/mozilla/diversity
 [FAQ]: https://www.contributor-covenant.org/faq
-[translations]: https://www.contributor-covenant.org/translations
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -18,4 +18,4 @@ 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.
+THE SOFTWARE.

data/README.md

@@ -1,43 +1,72 @@
 # HumanSql
 
-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/human_sql`. To experiment with that code, run `bin/console` for an interactive prompt.
+`HumanSql` is a gem that converts natural language queries into ActiveRecord queries using the OpenAI API. This gem allows developers to execute complex database queries by simply providing instructions in plain English (or another supported language).
 
 ## 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:
+After releasing to RubyGems.org, you can install the gem and add it to your application's Gemfile by executing:
 
 ```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+bundle add human_sql
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+If Bundler is not being used to manage dependencies, you can install the gem by executing:
 
 ```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+gem install human_sql
+```
+
+### Post Installation
+Once the gem is installed, you'll need to configure it by creating an initializer. In your Rails application, create a file named config/initializers/human_sql.rb and add the following:
+
+```ruby
+HumanSQLConfig = {
+  api_key: 'your_openai_api_key',   # Replace with your actual OpenAI API key
+  default_language: 'english'       # You can change this to 'spanish', 'japanese', etc.
+}
 ```
 
-## Usage
+Make sure to replace 'your_openai_api_key' with your actual API key from OpenAI. The default_language setting controls the language used for the natural language responses.
+
+### Usage
+
+To use HumanSql in your application, simply call the run method on HumanSQL::QueryBuilder with a natural language query. For example:
+
+```ruby
+result = HumanSQL::QueryBuilder.run("Give me the first user from my database")
+puts result
+```
 
-TODO: Write usage instructions here
+This will convert the natural language query into an ActiveRecord query, execute it, and return the results formatted in the specified language.
 
-## Development
+### Disclaimer
 
-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.
+IMPORTANT: By using this gem, you agree that the author is not responsible for any kind of data loss, damage, or issues that may arise from the use of this software. You are solely responsible for verifying the safety of the generated queries before running them in your production environment or on critical data. Use at your own risk.
 
-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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+### Development
 
-## Contributing
+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:
+
+```bash
+bundle
+```
+
+To release a new version, update the version number in version.rb, and then run:
+
+```bash
+bundle exec rake release
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/human_sql. 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]/human_sql/blob/main/CODE_OF_CONDUCT.md).
+This will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.
 
-## License
+### Contributing
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+Bug reports and pull requests are welcome on GitHub at https://github.com/nicobertin/human_sql. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.
 
-## Code of Conduct
+### License
+The gem is available as open source under the terms of the MIT License.
 
-Everyone interacting in the HumanSql project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/human_sql/blob/main/CODE_OF_CONDUCT.md).
+### Code of Conduct
+Everyone interacting in the HumanSql project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the code of conduct.

data/lib/human_sql/version.rb

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

data/lib/human_sql.rb

@@ -28,9 +28,13 @@ module HumanSQL
       raise "Could not generate a valid query." if generated_query.blank?
 
       results = execute_query(generated_query)
+      raise "No results found." if results.blank?
+
       formatted_results = format_results_for_openai(results)
       natural_language_response = generate_natural_language_response(formatted_results, @user_input)
       natural_language_response
+    rescue StandardError => e
+      process_error_in_natural_language(e.message)
     end
 
     private
@@ -53,7 +57,7 @@ module HumanSQL
         messages: [
           {
             role: "system",
-            content: "You are an assistant that converts natural language into ActiveRecord queries. The queries must be in a single line of code."
+            content: "You are an assistant that converts natural language into ActiveRecord queries and explains results in natural language."
           },
           {
             role: "user",
@@ -93,13 +97,13 @@ module HumanSQL
 
     def execute_query(generated_query)
       eval(generated_query)
-    rescue StandardError => e
+    rescue StandardError
       nil
     end
 
     def format_results_for_openai(results)
       if results.is_a?(ActiveRecord::Relation) || results.is_a?(Array)
-        formatted_results = results.map do |result|
+        results.map do |result|
           if result.respond_to?(:attributes)
             result.attributes.map { |key, value| "#{key}: #{value}" }.join(', ')
           else
@@ -107,9 +111,8 @@ module HumanSQL
           end
         end.join("\\n")
       else
-        formatted_results = results.respond_to?(:attributes) ? results.attributes.map { |key, value| "#{key}: #{value}" }.join(', ') : results.to_s
+        results.respond_to?(:attributes) ? results.attributes.map { |key, value| "#{key}: #{value}" }.join(', ') : results.to_s
       end
-      formatted_results.gsub("\n", "\\n")
     end
 
     def generate_natural_language_response(formatted_results, user_input)
@@ -119,10 +122,22 @@ module HumanSQL
 
         #{formatted_results}
 
-        Please generate a natural language description that clearly and understandably explains these results to the user in #{HumanSQLConfig[:default_language]} language.
+        Please generate a natural language description that clearly and understandably explains these results to the user in #{HumanSQLConfig[:default_language]}.
+      PROMPT
+
+      call_openai_service(prompt)
+    end
+
+    def process_error_in_natural_language(error_message)
+      prompt = <<-PROMPT
+        An error occurred while processing the user's query. The error is as follows:
+
+        "#{error_message}"
+
+        Please generate a natural language response that explains the error in a way that is understandable to the user in #{HumanSQLConfig[:default_language]}.
       PROMPT
 
       call_openai_service(prompt)
     end
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: human_sql
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.3
 platform: ruby
 authors:
 - Nicolas Bertin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-08 00:00:00.000000000 Z
+date: 2024-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -52,6 +52,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- human_sql-0.1.1.gem
 - lib/human_sql.rb
 - lib/human_sql/version.rb
 - sig/human_sql.rbs