deepseek-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b9976ec8055efd738544ae48c6438b68dc9c20583f32326f4c5cd2b61c4d7695
+  data.tar.gz: 537b4efc2bc483e392ecf1986006f85127563b5b0edc3b0a5d63fc22d0d0da32
+SHA512:
+  metadata.gz: 362e71a7534389666aed2396361142503012e3794d2eda94075e1944f65be71e2dea42445166288d8aee836bbf8b170754636258332c9ba07b7fd7915c12f81f
+  data.tar.gz: 931e5d2bbf3ec9d4482896bee830b1da074866b9081f7c612fdc6307ce4680e1a5ed0e52ea09895149451311abb172d7fae11a6f5c1ce6d447e0253bd0533d61

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Nagendra Dhanakeerthi
+
+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,235 @@
+# Deepseek Ruby SDK
+
+<a href="https://badge.fury.io/rb/deepseek"><img src="https://img.shields.io/gem/v/deepseek?style=for-the-badge" alt="Gem Version"></a>
+<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-yellow?style=for-the-badge" alt="License"></a>
+<a href="https://codeclimate.com/github/nagstler/deepseek-ruby/maintainability"><img src="https://img.shields.io/codeclimate/maintainability/nagstler/deepseek-ruby?style=for-the-badge" alt="Maintainability"></a>
+<a href="https://codeclimate.com/github/nagstler/deepseek-ruby/test_coverage"><img src="https://img.shields.io/codeclimate/coverage/nagstler/deepseek-ruby?style=for-the-badge" alt="Test Coverage"></a>
+<a href="https://github.com/nagstler/deepseek-ruby/actions/workflows/ci.yml"><img src="https://img.shields.io/github/actions/workflow/status/nagstler/deepseek-ruby/ci.yml?branch=main&style=for-the-badge" alt="CI"></a>
+<a href="https://github.com/nagstler/deepseek-ruby/stargazers"><img src="https://img.shields.io/github/stars/nagstler/deepseek-ruby?style=for-the-badge" alt="GitHub stars"></a>
+
+A Ruby SDK for interacting with the Deepseek AI API. This SDK provides a simple and intuitive interface for making API calls, handling responses, and managing errors.
+
+## Features
+
+- 🚀 Simple and intuitive interface
+- ⚡️ Automatic retries with exponential backoff
+- 🛡️ Comprehensive error handling
+- ⚙️ Flexible configuration options
+- 🔒 Secure API key management
+- 📝 Detailed response handling
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Quick Start](#quick-start)
+- [Configuration](#configuration)
+- [API Reference](#api-reference)
+- [Usage Examples](#usage-examples)
+- [Error Handling](#error-handling)
+- [Retry Handling](#retry-handling)
+- [Development](#development)
+- [Contributing](#contributing)
+- [Support](#support)
+- [License](#license)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'deepseek'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install deepseek
+```
+
+## Quick Start
+
+```ruby
+require 'deepseek'
+
+# Initialize client
+client = Deepseek::Client.new(api_key: 'your-api-key')
+
+# Make a chat completion request
+response = client.chat(
+  messages: [
+    { role: 'user', content: 'What is artificial intelligence?' }
+  ],
+  model: 'deepseek-chat'
+)
+
+puts response['choices'][0]['message']['content']
+```
+
+## Configuration
+
+### Basic Configuration
+
+```ruby
+client = Deepseek::Client.new(
+  api_key: 'your-api-key',
+  timeout: 60,      # Custom timeout in seconds
+  max_retries: 3    # Number of retries for failed requests
+)
+```
+
+### Environment Variables
+
+The SDK supports configuration through environment variables:
+
+```bash
+DEEPSEEK_API_KEY=your-api-key
+DEEPSEEK_API_BASE_URL=https://api.deepseek.com  # Optional
+DEEPSEEK_TIMEOUT=30                             # Optional
+DEEPSEEK_MAX_RETRIES=3                         # Optional
+```
+
+## API Reference
+
+### Available Methods
+
+#### chat(messages:, model: 'deepseek-chat', **params)
+
+Make a chat completion request.
+
+Parameters:
+- `messages` (Array, required): Array of message objects
+- `model` (String, optional): Model to use, defaults to 'deepseek-chat'
+- `temperature` (Float, optional): Sampling temperature
+
+Response Format:
+```ruby
+{
+  "choices" => [{
+    "message" => {
+      "content" => "Hello! How can I help you today?",
+      "role" => "assistant"
+    },
+    "finish_reason" => "stop"
+  }],
+  "created" => 1677649420,
+  "id" => "chatcmpl-123",
+  "model" => "deepseek-chat",
+  "usage" => {
+    "completion_tokens" => 17,
+    "prompt_tokens" => 57,
+    "total_tokens" => 74
+  }
+}
+```
+
+## Usage Examples
+
+### Chat with System Message
+```ruby
+response = client.chat(
+  messages: [
+    { role: 'system', content: 'You are a friendly AI assistant.' },
+    { role: 'user', content: 'Hello!' }
+  ],
+  temperature: 0.7,
+  model: 'deepseek-chat'
+)
+```
+
+### Conversation with History
+```ruby
+conversation = [
+  { role: 'user', content: 'What is your favorite color?' },
+  { role: 'assistant', content: 'I don\'t have personal preferences, but I can discuss colors!' },
+  { role: 'user', content: 'Tell me about blue.' }
+]
+
+response = client.chat(
+  messages: conversation,
+  temperature: 0.8
+)
+```
+
+### Advanced Configuration Example
+```ruby
+client = Deepseek::Client.new(
+  api_key: ENV['DEEPSEEK_API_KEY'],
+  timeout: 60,               # Custom timeout
+  max_retries: 5,           # Custom retry limit
+  api_base_url: 'https://custom.deepseek.api.com'  # Custom API URL
+)
+```
+
+## Error Handling
+
+The SDK provides comprehensive error handling for various scenarios:
+
+```ruby
+begin
+  response = client.chat(messages: messages)
+rescue Deepseek::AuthenticationError => e
+  # Handle authentication errors (e.g., invalid API key)
+  puts "Authentication error: #{e.message}"
+rescue Deepseek::RateLimitError => e
+  # Handle rate limit errors
+  puts "Rate limit exceeded: #{e.message}"
+rescue Deepseek::InvalidRequestError => e
+  # Handle invalid request errors
+  puts "Invalid request: #{e.message}"
+rescue Deepseek::ServiceUnavailableError => e
+  # Handle API service errors
+  puts "Service error: #{e.message}"
+rescue Deepseek::APIError => e
+  # Handle other API errors
+  puts "API error: #{e.message}"
+end
+```
+
+## Retry Handling
+
+The SDK automatically handles retries with exponential backoff for failed requests:
+
+- Automatic retry on network failures
+- Exponential backoff strategy
+- Configurable max retry attempts
+- Retry on rate limits and server errors
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+### Running Tests
+
+```bash
+bundle exec rake spec
+```
+
+### Running the Console
+
+```bash
+bin/console
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/nagstler/deepseek-ruby. 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.md).
+
+For detailed contribution guidelines, please see our [Contributing Guide](CONTRIBUTING.md).
+
+## Support
+
+If you discover any issues or have questions, please create an issue on GitHub.
+
+## License
+
+The gem is available as open source under the terms of the MIT License. See [LICENSE.txt](LICENSE.txt) for details.
+
+## Code of Conduct
+
+Everyone interacting in the Deepseek project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).

data/bin/console

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "deepseek"
+require "pry"
+
+# Load environment variables from .env file if present
+begin
+  require 'dotenv'
+  Dotenv.load
+rescue LoadError
+  # dotenv gem not installed, skipping
+end
+
+# Configure the client with environment variables
+Deepseek.configure do |config|
+  config.api_key = ENV['DEEPSEEK_API_KEY']
+end
+
+# Create a client instance for convenience
+@client = Deepseek::Client.new
+
+puts "Loaded Deepseek Ruby SDK (v#{Deepseek::VERSION})"
+puts "Environment: #{ENV['DEEPSEEK_ENV'] || 'development'}"
+puts "\nAvailable variables:"
+puts "  @client - Preconfigured Deepseek::Client instance"
+puts "\nExample usage:"
+puts '  response = @client.chat(messages: [{ role: "user", content: "Hello!" }])'
+puts "\n"
+
+Pry.start

data/bin/setup

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+require 'fileutils'
+
+# path to your application root.
+APP_ROOT = File.expand_path('..', __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+FileUtils.chdir APP_ROOT do
+  # This script is a way to set up or update your development environment automatically.
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  puts "\n== Creating example .env file =="
+  if File.exist?('.env')
+    puts '== .env file already exists =='
+  else
+    FileUtils.cp '.env.example', '.env' if File.exist?('.env.example')
+  end
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rake log:clear tmp:clear'
+
+  puts "\n== Setup complete =="
+end

data/lib/deepseek/client.rb

@@ -0,0 +1,121 @@
+require 'faraday'
+require 'faraday/retry'
+require 'json'
+
+module Deepseek
+  class Client
+    attr_reader :config
+
+    def initialize(api_key: nil, **options)
+      @config = Configuration.new
+      @config.api_key = api_key if api_key
+      options.each do |key, value|
+        @config.send("#{key}=", value) if @config.respond_to?("#{key}=")
+      end
+      @config.validate! # This will raise ConfigurationError if no API key is set
+    end
+
+    def chat(messages:, model: 'deepseek-chat', **params)
+      post('/v1/chat/completions', {
+        model: model,
+        messages: messages,
+        **params
+      })
+    rescue Faraday::Error => e
+      handle_error_response(e.response) if e.response
+      raise e
+    end
+
+    private
+
+    def connection
+      @connection ||= Faraday.new(url: config.api_base_url) do |faraday|
+        faraday.request :json
+        
+        faraday.request :retry, {
+          max: config.max_retries,
+          interval: 0.5,
+          interval_randomness: 0.5,
+          backoff_factor: 2,
+          exceptions: [
+            Faraday::ConnectionFailed,
+            Faraday::TimeoutError,
+            'Timeout::Error',
+            'Error::TimeoutError'
+          ]
+        }
+
+        # Don't automatically raise errors, we want to handle them ourselves
+        faraday.response :raise_error
+
+        faraday.adapter Faraday.default_adapter
+        faraday.options.timeout = config.timeout
+      end
+    end
+
+    def handle_error_response(response)
+      status = response[:status]
+      error_info = parse_error_response(response[:body])
+
+      case status
+      when 401
+        raise AuthenticationError.new(error_info[:message], code: status, response: response)
+      when 429
+        raise RateLimitError.new(error_info[:message], code: status, response: response)
+      when 400, 404
+        raise InvalidRequestError.new(error_info[:message], code: status, response: response)
+      when 500..599
+        raise ServiceUnavailableError.new("Service error: #{status}", code: status, response: response)
+      else
+        raise APIError.new("Unknown error: #{status}", code: status, response: response)
+      end
+    end
+
+    def parse_error_response(body)
+      return { message: body } unless body.is_a?(String)
+      
+      parsed = JSON.parse(body, symbolize_names: true)
+      {
+        message: parsed.dig(:error, :message) || parsed[:message] || "Unknown error",
+        code: parsed.dig(:error, :code) || parsed[:code]
+      }
+    rescue JSON::ParserError
+      { message: body }
+    end
+
+    def request_headers
+      {
+        'Authorization' => "Bearer #{config.api_key}",
+        'Content-Type' => 'application/json',
+        'Accept' => 'application/json',
+        'User-Agent' => "deepseek-ruby/#{VERSION}"
+      }
+    end
+
+    def post(endpoint, body = {})
+      response = connection.post(endpoint) do |req|
+        req.headers = request_headers
+        req.body = body
+      end
+
+      case response.status
+      when 200..299
+        JSON.parse(response.body)
+      else
+        handle_error_response(
+          status: response.status,
+          body: response.body,
+          headers: response.headers,
+          request: {
+            method: 'POST',
+            url: response.env.url.to_s,
+            headers: response.env.request_headers,
+            body: body
+          }
+        )
+      end
+    rescue JSON::ParserError
+      raise APIError.new("Invalid JSON response", response: response)
+    end
+  end
+end

data/lib/deepseek/configuration.rb

@@ -0,0 +1,16 @@
+module Deepseek
+  class Configuration
+    attr_accessor :api_key, :api_base_url, :timeout, :max_retries
+
+    def initialize
+      @api_key = ENV['DEEPSEEK_API_KEY']
+      @api_base_url = ENV['DEEPSEEK_API_BASE_URL'] || 'https://api.deepseek.com'
+      @timeout = ENV['DEEPSEEK_TIMEOUT']&.to_i || 30
+      @max_retries = ENV['DEEPSEEK_MAX_RETRIES']&.to_i || 3
+    end
+
+    def validate!
+      raise ConfigurationError, 'API key must be set' if api_key.nil? || api_key.to_s.strip.empty?
+    end
+  end
+end

data/lib/deepseek/errors.rb

@@ -0,0 +1,21 @@
+module Deepseek
+    class Error < StandardError; end
+    
+    class ConfigurationError < Error; end
+    
+    class APIError < Error
+      attr_reader :code, :response
+  
+      def initialize(message = nil, code: nil, response: nil)
+        @code = code
+        @response = response
+        super(message)
+      end
+    end
+  
+    class AuthenticationError < APIError; end
+    class RateLimitError < APIError; end
+    class InvalidRequestError < APIError; end
+    class APIConnectionError < APIError; end
+    class ServiceUnavailableError < APIError; end
+  end

data/lib/deepseek/version.rb

@@ -0,0 +1,3 @@
+module Deepseek
+    VERSION = "0.1.0"
+  end

data/lib/deepseek.rb

@@ -0,0 +1,25 @@
+require 'faraday'
+require 'json'
+
+require_relative 'deepseek/version'
+require_relative 'deepseek/configuration'
+require_relative 'deepseek/errors'
+require_relative 'deepseek/client'
+
+module Deepseek
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def reset_configuration!
+      @configuration = Configuration.new
+    end
+  end
+end

metadata

@@ -0,0 +1,216 @@
+--- !ruby/object:Gem::Specification
+name: deepseek-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nagendra Dhanakeerthi
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-02-02 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-retry
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+- !ruby/object:Gem::Dependency
+  name: simplecov-cobertura
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+description: A comprehensive Ruby client library for interacting with Deepseek's AI
+  APIs, providing a simple and intuitive interface for making API calls, handling
+  responses, and managing API resources.
+email:
+- nagendra.dhanakeerthi@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- bin/console
+- bin/setup
+- lib/deepseek.rb
+- lib/deepseek/client.rb
+- lib/deepseek/configuration.rb
+- lib/deepseek/errors.rb
+- lib/deepseek/version.rb
+homepage: https://github.com/nagstler/deepseek-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/nagstler/deepseek-ruby
+  source_code_uri: https://github.com/nagstler/deepseek-ruby
+  changelog_uri: https://github.com/nagstler/deepseek-ruby/blob/main/CHANGELOG.md
+  documentation_uri: https://github.com/nagstler/deepseek-ruby/blob/main/README.md
+  bug_tracker_uri: https://github.com/nagstler/deepseek-ruby/issues
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: Ruby SDK for Deepseek AI API
+test_files: []