act_as_api_client 1.0.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2879b607f0a39fdba8f0b5c92097320aacafd5e98a23e8082f051e9b95340765
-  data.tar.gz: c694503be26586f6c184f64b1df4084d261c1dae82aede31951fe7aa023d2c10
+  metadata.gz: a90b4aea75a3d4fffe79dc9d882cc6560c464409cfa07aa9227806573cef5055
+  data.tar.gz: 70429d7b213697175b2283bfa2aabca4b019a7c7272b097e34fa9786904ae6cd
 SHA512:
-  metadata.gz: 8d94a6752470991a895526ed0a371e34c44a5db3cc7c1f6d9a81a3e38c4d1ba7a3b39ab0a2406277aa407037744b60f2bbe0408197eaf6cccd625b9f80ef767d
-  data.tar.gz: fc1abaa4b3ae8541dd3a67de89d0a74035ebc8d909aab2d1d48f1d2d34b609bd8406aa28a5a864eff3402aa5a922abcfecf6169b022c9408d6eebc8620d9b65d
+  metadata.gz: b2f6b525f14bf39b4463d40cba93aa2cf84d98b92e5e5a77ddc9bc34cb8ba8f02a5e098d38788657317b6b5f0774a22f5345de6338e4b47e2548896b9216c794
+  data.tar.gz: 64a64300293bf60782357e32c7909dc8d01a95e47e22c6df36226f6278d4dc941449d38d6fc135e42620ecf7efa9a8a874dbad4d523e175cba22a90f7c762c99

data/.github/workflows/main.yml

@@ -36,7 +36,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest]
-        ruby-version: ["2.6", "2.7", "3.0", "3.1", "3.2"]
+        ruby-version: ["2.6", "2.7", "3.0", "3.1", "3.2", "3.3"]
     steps:
       - uses: actions/checkout@v3
       - name: Set up Ruby

data/.gitignore

@@ -14,4 +14,6 @@
 .byebug_history
 spec/credentials.yml
 
-*.gem
+*.gem
+
+.DS_Store

data/.rubocop.yml

@@ -20,3 +20,8 @@ AllCops:
 
 Style/Documentation:
   Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - 'act_as_api_client.gemspec'

data/.rubocop_todo.yml

@@ -12,17 +12,6 @@ Metrics/AbcSize:
   Exclude:
     - "lib/act_as_api_client/clients/github_repositories_client.rb"
 
-# Offense count: 5
-# Configuration parameters: CountComments, Max, CountAsOne, ExcludedMethods.
-# ExcludedMethods: refine
-Metrics/BlockLength:
-  Exclude:
-    - "**/*.gemspec"
-    - "spec/act_as_api_client/clients/authorize_net/authorize_net_notifications_client_spec.rb"
-    - "spec/act_as_api_client/clients/github_client/find_by_spec.rb"
-    - "spec/act_as_api_client/clients/github_client/find_spec.rb"
-    - "spec/act_as_api_client/clients/github_client/where_spec.rb"
-
 # Offense count: 1
 # Configuration parameters: IgnoredMethods, Max.
 Metrics/CyclomaticComplexity:
@@ -63,12 +52,6 @@ RSpec/NestedGroups:
   Exclude:
     - "spec/act_as_api_client/clients/github_client/find_by_spec.rb"
 
-# Offense count: 1
-# Configuration parameters: MinBodyLength.
-Style/GuardClause:
-  Exclude:
-    - "lib/act_as_api_client/clients/authorize_net_webhooks_client.rb"
-
 # Offense count: 4
 # Cop supports --auto-correct.
 # Configuration parameters: AutoCorrect, Max, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    act_as_api_client (1.0.0)
+    act_as_api_client (1.3.0)
 
 GEM
   remote: https://rubygems.org/
@@ -68,7 +68,4 @@ DEPENDENCIES
   rubocop (~> 0.80)
   rubocop-rspec
   vcr (~> 6.1)
-  webmock (~> 3.14)
-
-BUNDLED WITH
-   1.17.2
+  webmock (~> 3.14)

data/act_as_api_client.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = "act_as_api_client"
-  spec.version       = "1.0.0"
+  spec.version       = "1.3.0"
   spec.authors       = ["Max Rukomoynikov"]
   spec.email         = ["rukomoynikov@gmail.com"]
 

data/examples/anthropic_playground.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# Run it with `ruby anthropic_playground.rb`
+# See Anthropic development API documentation on https://docs.anthropic.com/en/api/messages
+
+require "bundler/inline"
+
+gemfile(true) do
+  source "https://rubygems.org"
+
+  gem "act_as_api_client", path: "../"
+end
+
+require "act_as_api_client"
+
+class AnthropicClient < ApiClient
+  act_as_api_client for: %i[anthropic messages],
+                    with: { x_api_key: ENV["ANTHROPIC_API_KEY"] }
+end
+
+anthropic_client = AnthropicClient.new
+
+pp anthropic_client.create(
+  model: "claude-3-5-sonnet-20241022",
+  messages: [
+    { "role": "user", "content": "Hello there." },
+    { "role": "assistant", "content": "Hi, I'm Claude. How can I help you?" },
+    { "role": "user", "content": "Can you explain LLMs in plain English?" }
+  ],
+  max_tokens: 1024
+)

data/examples/github_repositories.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# Run it with `ruby github_repositories.rb`
+
+require "bundler/inline"
+
+gemfile(true) do
+  source "https://rubygems.org"
+
+  gem "act_as_api_client", path: "./"
+  gem "tabled"
+end
+
+require "act_as_api_client"
+
+class GithubApiClient < ApiClient
+  act_as_api_client for: :github_repositories
+end
+
+github_api_client = GithubApiClient.new
+pp github_api_client.find("Rukomoynikov/tabled")

data/lib/act_as_api_client/client_loader.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module ActAsApiClient
+  class ClientLoader
+    attr_reader :client_for
+
+    def initialize(client_for:)
+      @client_for = client_for
+    end
+
+    def class_name
+      case client_for.class.to_s
+      when "String", "Symbol"
+        "#{convert_underscore_to_camelcase(client_for)}Client"
+      when "Array"
+        client_for
+          .map { |item| convert_underscore_to_camelcase(item) }
+          .join("::")
+          .concat("Client")
+      end
+    end
+
+    def path
+      case client_for.class.to_s
+      when "String", "Symbol"
+        File.expand_path("clients/#{client_for}_client", File.dirname(__FILE__))
+      when "Array"
+        client_path = client_for.join("/")
+
+        File.expand_path("clients/#{client_path}_client", File.dirname(__FILE__))
+      end
+    end
+
+    private
+
+    # Converting from authorize_net_webhooks_client to AuthorizeNetWebhooksClient
+    #
+    # @param value [String] string with underscores
+    # @return [String] transformed in camel case format string
+    def convert_underscore_to_camelcase(value)
+      value.to_s.capitalize.gsub(/_(.)/) do |s|
+        s.upcase.gsub("_", "")
+      end
+    end
+  end
+end

data/lib/act_as_api_client/clients/anthropic/messages_client.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require_relative "../http_client"
+
+# See the documentation on https://docs.anthropic.com/en/api/messages
+
+module ActAsApiClient
+  module Clients
+    module Anthropic
+      module MessagesClient
+        ANTHROPIC_VERSION = "2023-06-01"
+        BASE_URL = "https://api.anthropic.com/v1/messages"
+
+        include HttpClient
+
+        # Sends request to Anthropic API https://docs.anthropic.com/en/api/messages
+        #
+        # @param model [String] The model that will complete your prompt
+        # @param messages [Array] Input messages
+        # @param max_tokens [Integer] The maximum number of tokens to generate before stopping
+        # @param metadata [Hash] An object describing metadata about the request
+        # @param stop_sequences [Array<String>] Custom text sequences that will cause the model to stop generating
+        # @param stream [Boolean] Whether to incrementally stream the response using server-sent events
+        # @param system [String] System prompt
+        # @param temperature [Float] Amount of randomness injected into the response
+        # @param tool_choice [Hash] How the model should use the provided tools
+        # @param tools [Array<Hash>] Definitions of tools that the model may use
+        # @param top_k [Integer] Only sample from the top K options for each subsequent token
+        # @param top_p [Float] Use nucleus sampling
+        #
+        # @return [Hash] Response from Anthropic API
+        def create(**params)
+          post(BASE_URL, headers: headers, body: body(**params))
+        end
+
+        private
+
+        def headers
+          default = {
+            "Content-Type": "application/json",
+            "x-api-key" => options[:x_api_key],
+            "anthropic-version" => options[:anthropic_version] || ANTHROPIC_VERSION
+          }
+
+          default["anthropic-beta"] = options[:anthropic_beta] if options[:anthropic_beta]
+
+          default
+        end
+
+        # rubocop:disable Metrics/ParameterLists, Metrics/CyclomaticComplexity, Metrics/MethodLength
+        def body(model:,
+                 messages:,
+                 max_tokens:,
+                 metadata: nil,
+                 stop_sequences: nil,
+                 stream: false,
+                 system: nil,
+                 temperature: 1.0,
+                 tool_choice: nil,
+                 tools: nil,
+                 top_k: nil,
+                 top_p: nil)
+          default = {
+            model: model,
+            messages: messages,
+            max_tokens: max_tokens,
+            stream: stream,
+            temperature: temperature
+          }
+
+          default[:metadata] = metadata if metadata
+          default[:stop_sequences] = stop_sequences if stop_sequences
+          default[:system] = system if system
+          default[:tool_choice] = tool_choice if tool_choice
+          default[:tools] = tools if tools
+          default[:top_k] = top_k if top_k
+          default[:top_p] = top_p if top_p
+
+          default
+        end
+        # rubocop:enable Metrics/ParameterLists, Metrics/CyclomaticComplexity, Metrics/MethodLength
+      end
+    end
+  end
+end

data/lib/act_as_api_client/clients/http_client.rb

@@ -3,19 +3,22 @@
 require "net/http"
 require "json"
 
+require "act_as_api_client/errors/invalid_response_error"
+require "act_as_api_client/errors/network_error"
+
 module ActAsApiClient
   module Clients
     module HttpClient
       private
 
-      def get(url, options = {})
+      def get(url, **options)
         # Request part
         uri = URI(url)
         uri.query = URI.encode_www_form(options.fetch(:params, {}))
 
         request = Net::HTTP::Get.new(uri)
-        request_headers(headers: options.fetch(:headers, {}),
-                        request: request)
+        set_request_headers(headers: options.fetch(:headers, {}),
+                            request: request)
 
         # Response part
         response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
@@ -28,8 +31,31 @@ module ActAsApiClient
         end
       end
 
-      def post
-        # HTTParty.post
+      def post(url, headers: {}, **options) # rubocop:disable Metrics/AbcSize
+        # Request part
+        uri = URI(url)
+        uri.query = URI.encode_www_form(options.fetch(:params, {}))
+
+        request = Net::HTTP::Post.new(uri)
+
+        request.body = options.fetch(:body, {}).to_json
+        set_request_headers(headers: headers, request: request)
+
+        # Response part
+        response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
+          http.request(request)
+        end
+
+        case response
+        when Net::HTTPSuccess
+          ::JSON.parse(response.body)
+        when Net::HTTPNotFound, Net::HTTPUnprocessableEntity, Net::HTTPUnauthorized
+          ::JSON.parse(response.body)
+        end
+      rescue Net::OpenTimeout, Net::ReadTimeout, SocketError => e
+        raise ActAsApiClient::NetworkError, "Network error occurred: #{e.message}"
+      rescue JSON::ParserError => e
+        raise ActAsApiClient::InvalidResponseError, "Invalid JSON response: #{e.message}"
       end
 
       def put
@@ -44,7 +70,7 @@ module ActAsApiClient
         # HTTParty.delete
       end
 
-      def request_headers(headers:, request:)
+      def set_request_headers(headers:, request:)
         headers.each do |key, value|
           request[key] = value
         end

data/lib/act_as_api_client/errors/invalid_response_error.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module ActAsApiClient
+  module Errors
+    class InvalidResponseError < StandardError
+    end
+  end
+end

data/lib/act_as_api_client/errors/network_error.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module ActAsApiClient
+  module Errors
+    class NetworkError < StandardError
+    end
+  end
+end

data/lib/act_as_api_client/errors/non_existing_client_error.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module ActAsApiClient
+  module Errors
+    class NonExistingClient < StandardError
+      def initialize(requested_client:)
+        @requested_client = requested_client
+        super
+      end
+
+      def message
+        "The requested client (#{@requested_client}) doesn't exist"
+      end
+    end
+  end
+end

data/lib/act_as_api_client.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require_relative "act_as_api_client/base_api_methods"
+require "act_as_api_client/errors/non_existing_client_error"
+require "act_as_api_client/client_loader"
 
 class ApiClient
   include ActAsApiClient::BaseApiMethods
@@ -16,26 +18,16 @@ class ApiClient
     def set_general_client(client_for:)
       return if client_for.nil?
 
-      class_name = convert_underscore_to_camelcase(client_for)
+      client_loader = ActAsApiClient::ClientLoader.new(client_for: client_for)
 
-      require(File.expand_path("act_as_api_client/clients/#{client_for}_client",
-                               File.dirname(__FILE__)))
-      include const_get("ActAsApiClient::Clients::#{class_name}Client")
+      require(client_loader.path)
+      include const_get("ActAsApiClient::Clients::#{client_loader.class_name}")
+    rescue LoadError
+      raise ActAsApiClient::Errors::NonExistingClient.new(requested_client: client_for)
     end
 
     def set_options(options:)
       define_method("options") { options }
     end
-
-    # Converting from authorize_net_webhooks_client to AuthorizeNetWebhooksClient
-    #
-    # @param value [String] string with underscores
-    #
-    # @return [String] transformed in camel case format string
-    def convert_underscore_to_camelcase(value)
-      value.to_s.capitalize.gsub(/_(.)/) do |s|
-        s.upcase.gsub("_", "")
-      end
-    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: act_as_api_client
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Max Rukomoynikov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-10-22 00:00:00.000000000 Z
+date: 2024-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -134,10 +134,17 @@ files:
 - bin/setup
 - demo.rb
 - docker-compose.yml
+- examples/anthropic_playground.rb
+- examples/github_repositories.rb
 - lib/act_as_api_client.rb
 - lib/act_as_api_client/base_api_methods.rb
+- lib/act_as_api_client/client_loader.rb
+- lib/act_as_api_client/clients/anthropic/messages_client.rb
 - lib/act_as_api_client/clients/github_repositories_client.rb
 - lib/act_as_api_client/clients/http_client.rb
+- lib/act_as_api_client/errors/invalid_response_error.rb
+- lib/act_as_api_client/errors/network_error.rb
+- lib/act_as_api_client/errors/non_existing_client_error.rb
 homepage: https://rubygems.org/gems/act_as_api_client
 licenses:
 - MIT