func_bot 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c00ad5a2b3aea12bced2b60da8ffe88910c0413ba5a56163f8f08dee540b3e0
-  data.tar.gz: 2c91552073019309fc23ae95046763143f1a7f403bd9ee78493201303fe9a592
+  metadata.gz: b6f1906f61868b8d3ceaad0d239f927d3b962d36ffc811c474f49171e53b2925
+  data.tar.gz: 06e384d423073541824b800a279554058b825d62d39fbaa41f26db905991569f
 SHA512:
-  metadata.gz: 3397880c0ff9482c56653bc3f9b552cdd747f946d13e5091dffa5cc004127506e1c49b2a409daf03c1699fd6368f884d42fd07c4f1fa9b0ca546ea17127c5923
-  data.tar.gz: d7139064f6ec1dd6546356be3ff93a2a31a0c12307d426e0ffe686db40fca419564d944c30d426cb03d26f093918df411a10d7503f6cdf1f825f63917ad5f880
+  metadata.gz: ea4c9ab74ea6cdbaff2b76e51ae2bd700136b7a1197a1538c3fd4822c63447c40a72d18366a7ace0e33845be2c085bc883c12ec083f0c46ab7265b5f7bc890c6
+  data.tar.gz: 823923bfc4fca76b567f29de390d6580ada38ac2171f4600fb04bededfde893978ba9331d3e3761e100a99cc52836f70cfff271ba10b4d3e8db4ba8991e9a11c

data/README.md

@@ -2,77 +2,6 @@
 
 FuncBot is a Rails gem built on top of the [ruby-openai](https://github.com/alexrudall/ruby-openai) gem. It allows you to easily create chatbots that can answer questions by calling on functions you define. It's goal is to provide a simple interface to consume [OpenAI's Function Calling API](https://openai.com/blog/function-calling-and-other-api-updates?ref=upstract.com).
 
-## Usage
-
-- Generate a new function
-
-```bash
-rails g func_bot:function <function_name>
-```
-
-- Update the function in `app/lib/func_bot/functions/<function_name>.rb`
-
-  - A function can be as simple or as complex as you need it to be. Your bot will process the results and express them to the user.
-  - All functions must have an `execute` method.
-  - Here's a sample function that returns the current weather for the given location.
-
-    ```ruby
-    module FuncBot
-      module Functions
-        class WeatherFunction < BaseFunction
-          def execute
-            weather_info = {
-              location: parsed_response["location"],
-              temperature: 98,
-              forecast: ["sunny", "windy"]
-            }
-
-            JSON.dump(weather_info)
-          end
-        end
-      end
-    end
-    ```
-
-  - The `parsed_response` and `response` methods are available to all functions.
-    - `parsed_response` is a hash that contains the response relevant to your function from OpenAI.
-    - `response` is the raw response from OpenAI.
-  - Functions also have access to the `bot` attribute which returns the instance of the bot that called the function.
-
-    - This is useful if you need to access the bot's history or other methods.
-    - There might be times when you need to ask gpt a question from within a function, but you don't want to trigger the function again. You can set the `bot.include_functions` attribute to false before asking the question and then set it back to true after.
-
-    ```ruby
-    module FuncBot
-      module Functions
-        class SomeFunction < BaseFunction
-          def execute
-            bot.include_functions = false
-            response = bot.ask "Some question that you don't want to trigger any functions for"
-            bot.include_functions = true
-            do_something_with_response(response)
-            ....
-          end
-        end
-      end
-    end
-    ```
-
-- Update your new function in the list of functions in `app/lib/func_bot/functions/list.yml`.
-  - This list of functions will be available to the bot with every request.
-  - Adding good descriptions to the functions will help the bot infer when to use which function.
-- If the user asks a question that is not related to a function in your list, the bot will just ask ChatGPT.
-
-`bin/rails c`
-
-```ruby
-irb(main):001:0> bot = FuncBot::Bot.new
-=> #<FuncBot::Bot:0x0000000105ecd8e8 @history=#<FuncBot::Bots::History:0x0000000105ecd848 @history=[]>>
-irb(main):002:0> bot.ask "What's the weather like in Miami, FL?"
-=> "The current weather in Miami, FL is sunny and windy with a temperature of 98 degrees."
-irb(main):003:0>
-```
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -107,6 +36,62 @@ openai:
   api_key: your-private-key
 ```
 
+## Usage
+
+- Generate a new function
+
+```bash
+rails g func_bot:function <function_name>
+```
+
+- Update your new function in the list of functions in `app/lib/func_bot/functions/list.yml`.
+  - This list of functions will be available to the bot with every request.
+  - Adding good descriptions to the functions will help the bot infer when to use which function.
+- If the user asks a question that is not related to a function in your list, the bot will just ask ChatGPT.
+- A function can be as simple or as complex as you need it to be. Your bot will process the results and express them to the user.
+- All functions must have an `execute` method.
+- Here's a sample function that returns the current weather for the given location.
+
+  ```ruby
+  module FuncBot
+    module Functions
+      class WeatherFunction < BaseFunction
+        def execute
+          weather_info = {
+            location: parsed_response["location"],
+            temperature: 98,
+            forecast: ["sunny", "windy"]
+          }
+
+          JSON.dump(weather_info)
+        end
+      end
+    end
+  end
+  ```
+
+  - The `parsed_response` and `response` methods are available to all functions.
+    - `parsed_response` is a hash that contains the response relevant to your function from OpenAI.
+    - `response` is the raw response from OpenAI.
+  - Functions also have access to the `bot` attribute which returns the instance of the bot that called the function.
+
+    - This is useful if you need to access the bot's history or other methods.
+    - There might be times when you need to ask gpt a question from within a function, but you don't want to trigger the functions again. You can set the `bot.include_functions` attribute to false before asking the question and then set it back to true after.
+
+`bin/rails c`
+
+```ruby
+irb(main):001:0> bot = FuncBot::Bot.new
+=> #<FuncBot::Bot:0x0000000105ecd8e8 @history=#<FuncBot::Bots::History:0x0000000105ecd848 @history=[]>>
+irb(main):002:0> bot.ask "What's the weather like in Miami, FL?"
+=> "The current weather in Miami, FL is sunny and windy with a temperature of 98 degrees."
+irb(main):003:0>
+irb(main):006:0> bot.include_functions = false
+=> false
+irb(main):007:0> bot.ask "What's the weather like in Miami, FL today?"
+=> "I'm sorry, I cannot provide real-time information as my responses are generated based on pre-existing data. Please check a reliable weather source for the most up-to-date information on the weather in Miami, FL."
+```
+
 ## Testing
 
 ```bash

data/lib/func_bot/version.rb

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

data/lib/generators/func_bot/function_generator.rb

@@ -4,6 +4,7 @@ module FuncBot
 
     def generate_function
       template "function.rb", "app/lib/func_bot/functions/#{file_name}_function.rb"
+      template "function_spec.rb", "spec/models/func_bot/functions/#{file_name}_function_spec.rb" if defined?(RSpec)
     end
 
     def append_to_functions_list

data/lib/generators/func_bot/templates/function.rb.tt

@@ -2,9 +2,8 @@ module FuncBot
   module Functions
     class <%= class_name %>Function < BaseFunction
       def execute
-        # Add your function logic here.
-        # eg. data = {some: "data"}
-        # JSON.dump(data)
+        data = {key: "value"}
+        JSON.dump(data)
       end
     end
   end

data/lib/generators/func_bot/templates/function_spec.rb.tt

@@ -0,0 +1,31 @@
+require "rails_helper"
+
+RSpec.describe FuncBot::Functions::<%= class_name %>Function do
+  let(:bot) { FuncBot::Bot.new }
+  let(:function_response) { described_class.new(bot).execute }
+  let(:function_arguments) do
+    {
+      "choices" => [
+        {
+          "message" => {
+            "function_call" => {
+              "arguments" => JSON.dump({key: "value"})
+            }
+          }
+        }
+      ]
+    }
+  end
+
+  before do
+    bot.response = function_arguments
+  end
+
+  describe "#execute" do
+    describe "FuncBot::Functions::<%= class_name %>Function" do
+      it "returns the expected data" do
+        expect(JSON.parse(function_response)["key"]).to eq("value")
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: func_bot
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - lbp
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-20 00:00:00.000000000 Z
+date: 2023-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -227,6 +227,7 @@ files:
 - lib/generators/func_bot/function_generator.rb
 - lib/generators/func_bot/install_generator.rb
 - lib/generators/func_bot/templates/function.rb.tt
+- lib/generators/func_bot/templates/function_spec.rb.tt
 - lib/generators/func_bot/templates/list.yml
 - lib/generators/func_bot/templates/openai.rb
 - lib/generators/func_bot/templates/weather_function.rb