rubyai 0.3.1 → 0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 387f6d1b2686f5605793b342f64de039e2510d2678f33568216e80db7ea48582
-  data.tar.gz: 3224788966e4af7d6ed44987616561bfde72f649cde944a0dab594c64f50c88a
+  metadata.gz: 6727865a08e4730350aa8a4d3ebed4e52a23ad2200698581871fc93dc37c8581
+  data.tar.gz: ce748852ad65ffd478892ed8c508516739f1dc5275fbd02ae40f1102ac39c527
 SHA512:
-  metadata.gz: 84c4e0354f8aa8c30322c088dae333104068ea23aff9530a7ff222b30f4d5c14b563da13ddee527ce989512d8b2296f8239ad384d9cd7df38295348eb3a1961e
-  data.tar.gz: 506a3f86bf010e48d2b4e8c7567d948664a5bda8eb9e7f743bab11d5b324850802161a8967d10575d7872da7ef0437ef2ac5cdf663b80d988cc1e60043dfcf76
+  metadata.gz: b529e268b5223abe0918572182ab722ebdf741fc86706a8a5a52cd53f879f3628945bd7a7107d63ccb916655b53fd88efff5d654e751d109244cb567fb4d3cee
+  data.tar.gz: 9054d961a89f41a773383f94e4722cb1d52cb3e8ac1e173a5104dbe0e22f097fd2b05e5f2f7701344b749de7feaec5ee1b7197592ef6327196309eb692a45861

data/CHANGELOG.md

@@ -0,0 +1,60 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+
+## [0.3.2] - 2024-11-21
+
+### Added
+
+- Update Gemspec and dependencies
+
+## [0.3] - 2024-11-21
+
+### Added
+
+- gpt-4-turbo
+- gpt-4o-mini
+- o1-mini
+- o1-preview
+
+- Remove outdated GPT 3.5 models
+
+## [0.2] - 2024-04-20
+
+### Added
+
+- New version
+
+## [0.1.0] - 2024-01-21
+
+### Added
+
+- Github Action
+- Faraday gem
+
+## [0.0.3] - 2024-02-22
+
+### Added
+
+- Rubocop gem
+
+## [0.0.2] - 2024-02-23
+
+### Added
+
+- Models GPT-4
+
+## [0.0.1] - 2023-03-20
+
+### Added
+
+- Initialise repository.
+- Add RubyAI::Client to connect to OpenAI API using user credentials.
+
+
+
+

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at alexrudall@users.noreply.github.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/CONTRIBUTING.md

@@ -0,0 +1,3 @@
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/alexshapalov/rubyai. 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/alexshapalov/rubyai/blob/main/CODE_OF_CONDUCT.md).

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+ruby '>= 2.7'
+
+gem 'faraday'
+gem 'faraday-net_http_persistent'
+gem 'rspec'
+gem 'webmock'

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Alex Shapalov
+
+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,107 @@
+# RubyAI - OpenAI integration Ruby gem
+
+[![Gem Version](https://badge.fury.io/rb/rubyai.svg)](https://badge.fury.io/rb/rubyai)
+[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/alexshapalov/rubyai/blob/main/LICENSE)
+
+## Use the [OpenAI API 🤖 ](https://openai.com/blog/openai-api/) with Ruby! ❤️
+
+Generate text with ChatGPT (Generative Pre-trained Transformer)
+
+
+# Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "rubyai"
+```
+
+And then execute:
+
+    $ bundle install
+
+
+Or install with:
+
+    $ gem install rubyai
+
+and require with:
+
+```ruby
+require "rubyai"
+```
+
+# Usage
+
+- Get your API key from [https://beta.openai.com/account/api-keys](https://beta.openai.com/account/api-keys)
+
+- If you belong to multiple organizations, you can get your Organization ID from [https://beta.openai.com/account/org-settings](https://beta.openai.com/account/org-settings)
+
+### Quickstart
+
+For a quick test you can pass your token directly to a new client:
+
+```ruby
+result = RubyAI::Client.new(access_token, messages).call
+```
+
+### ChatGPT
+
+ChatGPT is a conversational-style text generation model.
+You can use it to [generate a response](https://platform.openai.com/docs/api-reference/chat/create) to a sequence of [messages](https://platform.openai.com/docs/guides/chat/introduction):
+
+```ruby
+api_key = "YOUR API KEY"
+messages = "Who is the best chess player in history?"
+
+result = RubyAI::Client.new(api_key, messages, model: "gpt-4").call
+puts result.dig("choices", 0, "message", "content")
+
+# => As an AI language model, I do not have personal opinions, but according to historical records, Garry Kasparov is often considered as one of the best chess players in history. Other notable players include Magnus Carlsen, Bobby Fischer, and Jose Capablanca.
+```
+
+You can also pass client variables using the configuration file.
+Create configruation file like on example:
+```ruby
+configuration = RubyAI::Configuration.new("YOUR API KEY", "Who is the best chess player in history?")
+client = RubyAI::Client.new(configuration)
+result = client.call
+puts result.dig("choices", 0, "message", "content")
+```
+
+Also (mostly) if you are using Rails you can use configure method:
+```ruby
+RubyAI.configure do |config|
+  config.api_key = "YOUR API KEY"
+  config.messages = "Who is the best chess player in history?"
+  config.model = "gpt-4o-mini"
+end
+```
+
+## Models 
+
+We support all popular GPT models:
+
+gpt-4-turbo: A powerful variant of GPT-4 optimized for efficiency and speed, perfect for high-demand tasks.
+
+gpt-4o-mini: A streamlined version of GPT-4, designed to provide a balance between performance and resource efficiency.
+
+o1-mini: A compact, yet effective model that is well-suited for lightweight tasks.
+
+o1-preview: A preview version of the o1 model, offering insights into upcoming advancements and features.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can 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`.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at <https://github.com/alexshapalov/rubyai>. This project is intended to be a safe, welcoming space for collaboration, and contributors.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/rubyai/client.rb

@@ -0,0 +1,27 @@
+module RubyAI
+  class Client
+    attr_reader :configuration
+
+    def initialize(config_hash = {})
+      @configuration = Configuration.new(config_hash)
+    end
+
+    def call
+      response = connection.post do |req|
+        req.url Configuration::BASE_URL
+        req.headers.merge!(HTTP.build_headers(configuration.api_key))
+        req.body = HTTP.build_body(configuration.messages, configuration.model, configuration.temperature).to_json
+      end
+
+      JSON.parse(response.body)
+    end
+
+    private
+
+    def connection
+      @connection ||= Faraday.new do |faraday|
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+  end
+end

data/lib/rubyai/configuration.rb

@@ -0,0 +1,34 @@
+module RubyAI
+  class Configuration
+    BASE_URL = "https://api.openai.com/v1/chat/completions"
+
+    MODELS = {
+      "gpt-4" => "gpt-4",
+      "gpt-4-32k" => "gpt-4-32k",
+      "gpt-4-turbo" => "gpt-4-turbo",
+      "gpt-4o-mini" => "gpt-4o-mini",
+      "o1-mini" => "o1-mini",
+      "o1-preview" => "o1-preview",
+      "text-davinci-003" => "text-davinci-003"
+    }
+
+    DEFAULT_MODEL = "gpt-3.5-turbo"
+
+    attr_accessor :api_key, :model, :messages, :temperature
+
+    def initialize(config = {})
+      @api_key = config[:api_key]
+      @model = config.fetch(:model, DEFAULT_MODEL)
+      @messages = config.fetch(:messages, nil)
+      @temperature = config.fetch(:temperature, 0.7)
+    end
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/lib/rubyai/http.rb

@@ -0,0 +1,20 @@
+module RubyAI
+  module HTTP
+    extend self
+
+    def build_body(messages, model, temperature)
+      {
+        'model': Configuration::MODELS[model],
+        'messages': [{ "role": "user", "content": messages }],
+        'temperature': temperature
+      }
+    end
+
+    def build_headers(api_key)
+      {
+        'Content-Type': 'application/json',
+        'Authorization': "Bearer #{api_key}"
+      }
+    end
+  end
+end

data/lib/rubyai/version.rb

@@ -0,0 +1,3 @@
+module RubyAI
+  VERSION = "0.5".freeze
+end

data/lib/rubyai.rb

@@ -1,6 +1,12 @@
+require 'faraday'
+require 'faraday/net_http_persistent'
+require 'json'
+
 require_relative "rubyai/client"
 require_relative "rubyai/configuration"
+require_relative "rubyai/http"
+require_relative "rubyai/version"
 
 module RubyAI
   class Error < StandardError; end
-end
+end

data/pull_request_template.md

@@ -0,0 +1,5 @@
+## All Submissions:
+
+* [ ] Have you followed the guidelines in our [Contributing document](../blob/main/CONTRIBUTING.md)?
+* [ ] Have you checked to ensure there aren't other open [Pull Requests](../pulls) for the same update/change?
+* [ ] Have you added an explanation of what your changes do and why you'd like us to include them?

data/spec/client_spec.rb

@@ -0,0 +1,24 @@
+require 'webmock/rspec'
+require_relative '../lib/rubyai/client.rb'
+
+RSpec.describe RubyAI::Client do
+  let(:api_key) { 'your_api_key' }
+  let(:messages) { 'Hello, how are you?' }
+  let(:temperature) { 0.7 }
+  let(:model) { 'gpt-3.5-turbo' }
+  let(:client) { described_class.new(api_key: api_key, messages: messages, temperature: temperature, model: model) }
+
+  describe '#call' do
+    let(:response_body) { { 'completion' => 'This is a response from the model.' } }
+    let(:status) { 200 }
+
+    before do
+      stub_request(:post, RubyAI::Configuration::BASE_URL)
+        .to_return(status: status, body: response_body.to_json, headers: { 'Content-Type' => 'application/json' })
+    end
+
+    it 'returns parsed JSON response when passing through client directly' do
+      expect(client.call).to eq(response_body)
+    end
+  end
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,33 @@
+require 'webmock/rspec'
+require_relative '../lib/rubyai/client.rb'
+
+RSpec.describe RubyAI::Client do
+  let(:api_key) { 'your_api_key' }
+  let(:messages) { 'Hello, how are you?' }
+  let(:temperature) { 0.7 }
+  let(:model) { 'gpt-3.5-turbo' }
+
+  before do
+    RubyAI.configure do |config|
+      config.api_key = api_key
+      config.messages = messages
+    end
+  end
+
+  describe '#call' do
+    let(:response_body) { { 'choices' => [{ 'message' => { 'content' => 'This is a response from the model.' } }] } }
+    let(:status) { 200 }
+
+    before do
+      stub_request(:post, RubyAI::Configuration::BASE_URL)
+        .to_return(status: status, body: response_body.to_json, headers: { 'Content-Type' => 'application/json' })
+    end
+
+    it 'returns parsed JSON response when passing through client via configuration' do
+      configuration = { api_key: RubyAI.configuration.api_key, messages: RubyAI.configuration.messages }
+      client = described_class.new(configuration)
+      result = client.call
+      expect(result.dig('choices', 0, 'message', 'content')).to eq('This is a response from the model.')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,98 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See https://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  # https://rspec.info/features/3-12/rspec-core/configuration/zero-monkey-patching-mode/
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -1,26 +1,87 @@
 --- !ruby/object:Gem::Specification
 name: rubyai
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: '0.5'
 platform: ruby
 authors:
 - Alex Shapalov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-21 00:00:00.000000000 Z
-dependencies: []
-description:
+date: 2024-10-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: faraday-net_http_persistent
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+description: RubyAI is a wrapper for the OpenAI API that allows you to interact with
+  GPT-4 within Ruby/Rails applications. It provides simple methods for integrating
+  language model capabilities into your Ruby projects.
 email:
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE
+- README.md
 - lib/rubyai.rb
+- lib/rubyai/client.rb
+- lib/rubyai/configuration.rb
+- lib/rubyai/http.rb
+- lib/rubyai/version.rb
+- pull_request_template.md
+- spec/client_spec.rb
+- spec/configuration_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/alexshapalov/rubyai
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/alexshapalov/rubyai
+  changelog_uri: https://github.com/alexshapalov/rubyai/CHANGELOG.md
+  documentation_uri: https://github.com/alexshapalov/rubyai#readme
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -29,7 +90,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -39,5 +100,5 @@ requirements: []
 rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
-summary: A Ruby gem for the OpenAI (GPT-3 and GPT-4) API
+summary: A Ruby gem for the OpenAI (GPT-4) API
 test_files: []