Initial commit

xymbol · xymbol · commit 13b393d00ba8 · 2025-01-26T14:53:21.000-03:00
Set up a Ruby gem with a basic client. The goal is to have a gem that can be used to interact with the DeepSeek API and try their services. https://api-docs.deepseek.com
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -0,0 +1,30 @@
+name: Ruby
+
+on:
+  push:
+    branches:
+      - main
+
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Ruby ${{ matrix.ruby }}
+    strategy:
+      matrix:
+        ruby:
+          - '3.3.7'
+          - '3.4.1'
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Run the default task
+        env:
+          DEEPSEEK_API_KEY: ${{ secrets.DEEPSEEK_API_KEY }}
+        run: bundle exec rake
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+*.gem
+.byebug_history
+.env
diff --git a/.standard.yml b/.standard.yml
@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.1
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-01-26
+
+- Initial release
diff --git a/Gemfile b/Gemfile
@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in deepseek.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.16"
+
+gem "standard", "~> 1.3"
+
+gem "byebug", "~> 11.1"
+
+gem "dotenv", "~> 3.1"
diff --git a/LICENSE.txt b/LICENSE.txt
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Adrián Mugnolo
+
+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.
diff --git a/README.md b/README.md
@@ -0,0 +1,51 @@
+# Deepseek
+
+A Ruby client for accessing the DeepSeek API.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add deepseek
+```
+
+If bundler is not being used to manage dependencies, install the gem by
+executing:
+
+```bash
+gem install deepseek
+```
+
+## Usage
+
+```ruby
+client = Deepseek::Client.new("your-api-key")
+
+response = client.chat_completions(
+  model: "deepseek-chat",
+  messages: [{role: "user", content: "Hello, world!"}]
+)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake test` to run the tests. 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 the created tag, 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/xymbol/deepseek-ruby.
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](https://opensource.org/licenses/MIT).
diff --git a/Rakefile b/Rakefile
@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "standard/rake"
+
+task default: %i[test standard]
diff --git a/bin/console b/bin/console
@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "deepseek"
+
+# 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.
+
+require "irb"
+IRB.start(__FILE__)
diff --git a/bin/setup b/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
diff --git a/deepseek.gemspec b/deepseek.gemspec
@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "lib/deepseek/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "deepseek"
+  spec.version = Deepseek::VERSION
+  spec.authors = ["Adrián Mugnolo"]
+  spec.email = ["adrian@mugnolo.com"]
+
+  spec.summary = "A Ruby client for accessing the DeepSeek API"
+  spec.description = "DeepSeek is a Chinese artificial intelligence company which develops open-source large language models."
+  spec.homepage = "https://github.com/xymbol/deepseek-ruby"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.3.7"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/xymbol/deepseek-ruby"
+  spec.metadata["changelog_uri"] = "https://github.com/xymbol/deepseek-ruby/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.
+  gemspec = File.basename(__FILE__)
+  spec.files = IO.popen(%w[git ls-files -z], chdir: __dir__, err: IO::NULL) do |ls|
+    ls.readlines("\x0", chomp: true).reject do |f|
+      (f == gemspec) ||
+        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 "faraday", "~> 2.12", ">= 2.12.2"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end
diff --git a/lib/deepseek.rb b/lib/deepseek.rb
@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "deepseek/version"
+require_relative "deepseek/client"
+
+module Deepseek
+  class Error < StandardError; end
+end
+
+DeepSeek = Deepseek
diff --git a/lib/deepseek/client.rb b/lib/deepseek/client.rb
@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "faraday"
+
+module Deepseek
+  DEFAULT_URL = "https://api.deepseek.com"
+  BETA_URL = "https://api.deepseek.com/beta"
+
+  class Client
+    def initialize(api_key = nil, url = DEFAULT_URL)
+      @api_key = api_key || ENV.fetch("DEEPSEEK_API_KEY")
+      @url = url
+    end
+
+    def self.beta
+      new(nil, BETA_URL)
+    end
+
+    def chat_completions(params)
+      handle_response(conn.post("chat/completions", params))
+    end
+
+    def fim_completions(params)
+      handle_response(conn.post("completions", params))
+    end
+
+    def models
+      handle_response(conn.get("models"))
+    end
+
+    def user_balance
+      handle_response(conn.get("user/balance"))
+    end
+
+    private
+
+    def conn
+      @conn ||= Faraday.new(url: @url) do |conn|
+        conn.request :json
+        conn.response :json
+        conn.headers["Authorization"] = "Bearer #{@api_key}"
+        conn.headers["Content-Type"] = "application/json"
+        conn.adapter Faraday.default_adapter
+      end
+    end
+
+    def handle_response(response)
+      if response.status == 200
+        response.body
+      else
+        raise Deepseek::Error, "Request failed with status #{response.status}: #{response.body}"
+      end
+    end
+  end
+end
diff --git a/lib/deepseek/version.rb b/lib/deepseek/version.rb
@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Deepseek
+  VERSION = "0.1.0"
+end
diff --git a/sig/deepseek.rbs b/sig/deepseek.rbs
@@ -0,0 +1,4 @@
+module Deepseek
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end
diff --git a/test/test_deepseek.rb b/test/test_deepseek.rb
@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class TestDeepseek < Minitest::Test
+  def test_that_it_has_a_version_number
+    refute_nil ::Deepseek::VERSION
+  end
+
+  def test_chat_completions
+    client = Deepseek::Client.new
+    response = client.chat_completions(
+      model: "deepseek-chat",
+      messages: [{role: "user", content: "Hello, world!"}]
+    )
+    assert_match(/Hello/i, response.dig("choices", 0, "message", "content"))
+  end
+
+  def test_fim_completions
+    client = Deepseek::Client.beta
+    response = client.fim_completions(
+      model: "deepseek-chat",
+      prompt: "The quick brown fox jumps over the lazy"
+    )
+    assert_match(/dog/, response.dig("choices", 0, "text"))
+  end
+
+  def test_models
+    client = Deepseek::Client.new
+    models = client.models
+    assert_equal "list", models["object"]
+  end
+
+  def test_user_balance
+    client = Deepseek::Client.new
+    balance = client.user_balance
+    assert_equal true, balance["is_available"]
+  end
+
+  def test_module_alias
+    assert_equal Deepseek::Client, DeepSeek::Client
+  end
+end
diff --git a/test/test_helper.rb b/test/test_helper.rb
@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+require "deepseek"
+
+require "minitest/autorun"
+require "byebug"
+require "dotenv/load"

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# For available configuration options, see:`
	`2`	`+# https://github.com/standardrb/standard`
	`3`	`+ruby_version: 3.1`