act_as_api_client 1.0.0 → 1.3.1

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,92 @@
+# frozen_string_literal: true
+
+require "act_as_api_client/clients/http/simple_client"
+require "act_as_api_client/clients/http/streaming_client"
+
+module ActAsApiClient
+  module Clients
+    module Anthropic
+      module MessagesClient
+        ANTHROPIC_VERSION = "2023-06-01"
+        BASE_URL = "https://api.anthropic.com/v1/messages"
+
+        # 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, &block)
+          client = if params.fetch(:stream, false)
+                     ActAsApiClient::Clients::Http::StreamingClient.new
+                   else
+                     ActAsApiClient::Clients::Http::SimpleClient.new
+                   end
+
+          client.post(BASE_URL,
+                      headers: headers,
+                      stream: params.fetch(:stream, false),
+                      body: body(**params),
+                      &block)
+        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/github_repositories_client.rb

@@ -1,12 +1,10 @@
 # frozen_string_literal: true
 
-require_relative "http_client"
+require "act_as_api_client/clients/http/simple_client"
 
 module ActAsApiClient
   module Clients
     module GithubRepositoriesClient
-      include HttpClient
-
       # Searches Github for one repository by it's owner and repository names.
       # More details look at the corresponding {https://docs.github.com/en/rest/repos/repos#get-a-repository Github Docs page}
       #
@@ -18,9 +16,11 @@ module ActAsApiClient
           raise StandardError, "repository_name parameter is not valid"
         end
 
-        get("https://api.github.com/repos/#{repository_name}",
-            headers: { "Accept" => "application/vnd.github.v3+json",
-                       "Authorization" => (options[:token] ? "token #{options[:token]}" : nil) })
+        http_client = ActAsApiClient::Clients::Http::SimpleClient.new
+
+        http_client.get("https://api.github.com/repos/#{repository_name}",
+                        headers: { "Accept" => "application/vnd.github.v3+json",
+                                   "Authorization" => (options[:token] ? "token #{options[:token]}" : nil) })
       end
 
       # Search through Github repositories using query string and additional parameters explained on the {https://docs.github.com/en/rest/search#search-repositories Github Docs page}
@@ -38,10 +38,12 @@ module ActAsApiClient
       #
       # @return [Array] list of repositories
       def where(query_string, parameters = {})
-        get("https://api.github.com/search/repositories",
-            headers: { "Accept" => "application/vnd.github.v3+json",
-                       "Authorization" => (options[:token] ? "token #{options[:token]}" : nil) },
-            params: { q: query_string }.merge(parameters))
+        http_client = ActAsApiClient::Clients::Http::SimpleClient.new
+
+        http_client.get("https://api.github.com/search/repositories",
+                        headers: { "Accept" => "application/vnd.github.v3+json",
+                                   "Authorization" => (options[:token] ? "token #{options[:token]}" : nil) },
+                        params: { q: query_string }.merge(parameters))
       end
 
       # Use this method if you need to get list of repositories selected by one of this conditions: user, authenticated_user, organization
@@ -72,23 +74,12 @@ module ActAsApiClient
                 "https://api.github.com/repositories"
               end
 
-        get(url,
-            headers: { "Accept" => "application/vnd.github.v3+json",
-                       "Authorization" => (options[:token] ? "token #{options[:token]}" : nil) })
-      end
+        http_client = ActAsApiClient::Clients::Http::SimpleClient.new
 
-      # def delete
-      #   # Call only on queried before repository and repository is not 404/400 and has right to delete (write)
-      #   "delete"
-      # end
-      #
-      # def create
-      #   "create"
-      # end
-      #
-      # def update
-      #   "update"
-      # end
+        http_client.get(url,
+                        headers: { "Accept" => "application/vnd.github.v3+json",
+                                   "Authorization" => (options[:token] ? "token #{options[:token]}" : nil) })
+      end
     end
   end
 end

data/lib/act_as_api_client/clients/http/base_client.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module ActAsApiClient
+  module Clients
+    module Http
+      module BaseClient
+        private
+
+        def build_uri(url, **options)
+          uri = URI(url)
+          uri.query = URI.encode_www_form(options.fetch(:params, {}))
+
+          uri
+        end
+
+        def set_request_headers(headers:, request:)
+          headers.each do |key, value|
+            request[key] = value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/act_as_api_client/clients/http/simple_client.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "json"
+
+require "act_as_api_client/errors/invalid_response_error"
+require "act_as_api_client/errors/network_error"
+
+require "act_as_api_client/clients/http/base_client"
+
+module ActAsApiClient
+  module Clients
+    module Http
+      class SimpleClient
+        include BaseClient
+
+        def get(url, **options)
+          uri = build_uri(url, **options)
+
+          request = Net::HTTP::Get.new(uri)
+          set_request_headers(headers: options.fetch(:headers, {}),
+                              request: request)
+
+          response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
+            http.request(request)
+          end
+
+          parse_response(response)
+        rescue Net::OpenTimeout, Net::ReadTimeout, SocketError => e
+          raise ActAsApiClient::Errors::NetworkError, "Network error occurred: #{e.message}"
+        end
+
+        def post(url, headers: {}, **options)
+          uri = build_uri(url, **options)
+          request = Net::HTTP::Post.new(uri)
+          set_request_headers(headers: headers, request: request)
+          request.body = options.fetch(:body, {}).to_json
+
+          response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
+            http.request(request)
+          end
+
+          parse_response(response)
+        rescue Net::OpenTimeout, Net::ReadTimeout, SocketError => e
+          raise ActAsApiClient::Errors::NetworkError, "Network error occurred: #{e.message}"
+        end
+
+        private
+
+        def parse_response(response)
+          case response
+          when Net::HTTPSuccess, Net::HTTPBadRequest
+            ::JSON.parse(response.body)
+          when Net::HTTPNotFound, Net::HTTPUnprocessableEntity, Net::HTTPUnauthorized
+            ::JSON.parse(response.body)
+          end
+        rescue JSON::ParserError => e
+          raise ActAsApiClient::Errors::InvalidResponseError, "Invalid JSON response: #{e.message}"
+        end
+      end
+    end
+  end
+end

data/lib/act_as_api_client/clients/http/streaming_client.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "json"
+require "event_stream_parser"
+
+require "act_as_api_client/errors/invalid_response_error"
+require "act_as_api_client/errors/network_error"
+
+module ActAsApiClient
+  module Clients
+    module Http
+      class StreamingClient
+        include BaseClient
+
+        def post(url, headers: {}, **options) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+          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)
+
+          parser = EventStreamParser::Parser.new
+
+          Net::HTTP.start(uri.hostname, use_ssl: true) do |http|
+            http.request(request) do |response|
+              case response
+              when Net::HTTPSuccess, Net::HTTPBadRequest
+                response.read_body do |chunk|
+                  parser.feed(chunk) do |_type, data, _id, _reconnection_time|
+                    yield(::JSON.parse(data)) if block_given?
+                  end
+                end
+              when Net::HTTPNotFound, Net::HTTPUnprocessableEntity, Net::HTTPUnauthorized
+                response.read_body do |chunk|
+                  parser.feed(chunk) do |_type, data, _id, _reconnection_time|
+                    yield(::JSON.parse(data)) if block_given?
+                  end
+                end
+              end
+            end
+          end
+        rescue Net::OpenTimeout, Net::ReadTimeout, SocketError => e
+          raise ActAsApiClient::Errors::NetworkError, "Network error occurred: #{e.message}"
+        rescue JSON::ParserError => e
+          raise ActAsApiClient::Errors::InvalidResponseError, "Invalid JSON response: #{e.message}"
+        end
+      end
+    end
+  end
+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,10 +1,9 @@
 # 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
-
   class << self
     def act_as_api_client(**args)
       set_general_client(client_for: args.fetch(:for, nil))
@@ -16,26 +15,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,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: act_as_api_client
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Max Rukomoynikov
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-22 00:00:00.000000000 Z
+date: 2025-11-07 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: event_stream_parser
+  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: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -118,6 +132,7 @@ extra_rdoc_files: []
 files:
 - ".devcontainer.json"
 - ".github/workflows/main.yml"
+- ".github/workflows/update_docs.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -132,21 +147,38 @@ files:
 - act_as_api_client.gemspec
 - bin/console
 - bin/setup
-- demo.rb
 - docker-compose.yml
+- docs/.gitignore
+- docs/404.html
+- docs/Gemfile
+- docs/Gemfile.lock
+- docs/_config.yml
+- docs/_config_development.yml
+- docs/assets/thumbnail.jpg
+- docs/clients/anthropic.markdown
+- docs/docker-compose.yml
+- docs/index.markdown
+- 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/clients/http/base_client.rb
+- lib/act_as_api_client/clients/http/simple_client.rb
+- lib/act_as_api_client/clients/http/streaming_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
 metadata:
   source_code_uri: https://github.com/Rukomoynikov/act_as_api_client
   homepage_uri: https://rubygems.org/gems/act_as_api_client
-  documentation_uri: https://rubydoc.info/github/Rukomoynikov/act_as_api_client/main
+  documentation_uri: https://rukomoynikov.github.io/act_as_api_client/
   bug_tracker_uri: https://github.com/Rukomoynikov/act_as_api_client/issues
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -161,8 +193,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.3.27
+signing_key:
 specification_version: 4
 summary: Collection of predefined API clients
 test_files: []

data/demo.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/act_as_api_client"
-
-class GithubClient < ApiClient
-  act_as_api_client for: :github_repositories
-end
-
-p GithubClient.ancestors
-p GithubClient.new.method(:find).source_location
-
-GithubClient.new.find

data/lib/act_as_api_client/base_api_methods.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-module ActAsApiClient
-  module BaseApiMethods
-    def find
-      raise StandardError, "Should be defined in inherited class"
-    end
-
-    def where
-      raise StandardError, "Should be defined in inherited class"
-    end
-
-    def find_by
-      raise StandardError, "Should be defined in inherited class"
-    end
-
-    def delete
-      raise StandardError, "Should be defined in inherited class"
-    end
-
-    def create
-      raise StandardError, "Should be defined in inherited class"
-    end
-
-    def update
-      raise StandardError, "Should be defined in inherited class"
-    end
-  end
-end

data/lib/act_as_api_client/clients/http_client.rb

@@ -1,54 +0,0 @@
-# frozen_string_literal: true
-
-require "net/http"
-require "json"
-
-module ActAsApiClient
-  module Clients
-    module HttpClient
-      private
-
-      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)
-
-        # Response part
-        response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
-          http.request(request)
-        end
-
-        case response
-        when Net::HTTPNotFound, Net::HTTPSuccess, Net::HTTPUnprocessableEntity, Net::HTTPUnauthorized
-          ::JSON.parse(response.body)
-        end
-      end
-
-      def post
-        # HTTParty.post
-      end
-
-      def put
-        # HTTParty.put
-      end
-
-      def update
-        # HTTParty.update
-      end
-
-      def delete
-        # HTTParty.delete
-      end
-
-      def request_headers(headers:, request:)
-        headers.each do |key, value|
-          request[key] = value
-        end
-      end
-    end
-  end
-end