administrate-sdk 0.1.0

data/lib/administrate/resources/llm_projects.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Administrate
+  module Resources
+    class LlmProjects < BaseResource
+      def list(provider_id, page: nil, per_page: nil)
+        params = {}
+        params[:page] = page unless page.nil?
+        params[:per_page] = per_page unless per_page.nil?
+        list_resource(path: "llm_providers/#{provider_id}/llm_projects", model: Models::LlmProject, params: params)
+      end
+
+      def update(provider_id, project_id, client_id: nil)
+        body = {}
+        body[:client_id] = client_id unless client_id.nil?
+        update_resource("llm_providers/#{provider_id}/llm_projects/#{project_id}", Models::LlmProject, body)
+      end
+    end
+  end
+end

data/lib/administrate/resources/llm_providers.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Administrate
+  module Resources
+    class LlmProviders < BaseResource
+      def list(page: nil, per_page: nil)
+        params = {}
+        params[:page] = page unless page.nil?
+        params[:per_page] = per_page unless per_page.nil?
+        list_resource(path: 'llm_providers', model: Models::LlmProvider, params: params)
+      end
+
+      def get(provider_id)
+        get_resource("llm_providers/#{provider_id}", Models::LlmProvider)
+      end
+
+      def create(name:, provider_type:, api_key:, organization_id: nil, config: nil)
+        body = {
+          name: name,
+          provider_type: provider_type,
+          api_key: api_key
+        }
+        body[:organization_id] = organization_id unless organization_id.nil?
+        body[:config] = config unless config.nil?
+        create_resource('llm_providers', Models::LlmProvider, body)
+      end
+
+      def update(provider_id, name: nil, api_key: nil, organization_id: nil, config: nil)
+        body = {}
+        body[:name] = name unless name.nil?
+        body[:api_key] = api_key unless api_key.nil?
+        body[:organization_id] = organization_id unless organization_id.nil?
+        body[:config] = config unless config.nil?
+        update_resource("llm_providers/#{provider_id}", Models::LlmProvider, body)
+      end
+
+      def delete(provider_id)
+        delete_resource("llm_providers/#{provider_id}")
+      end
+
+      def sync(provider_id)
+        response = @transport.post("llm_providers/#{provider_id}/sync")
+        response.body
+      end
+    end
+  end
+end

data/lib/administrate/resources/sync_runs.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Administrate
+  module Resources
+    class SyncRuns < BaseResource
+      def list(instance_id: nil, client_id: nil, sync_type: nil, status: nil,
+               start_date: nil, end_date: nil, page: nil, per_page: nil)
+        params = {}
+        params[:instance_id] = instance_id unless instance_id.nil?
+        params[:client_id] = client_id unless client_id.nil?
+        params[:sync_type] = sync_type unless sync_type.nil?
+        params[:status] = status unless status.nil?
+        params[:start_date] = start_date unless start_date.nil?
+        params[:end_date] = end_date unless end_date.nil?
+        params[:page] = page unless page.nil?
+        params[:per_page] = per_page unless per_page.nil?
+        list_resource(path: 'sync_runs', model: Models::SyncRun, params: params)
+      end
+
+      def get(sync_run_id)
+        get_resource("sync_runs/#{sync_run_id}", Models::SyncRun)
+      end
+
+      def health
+        response = @transport.get('sync_health')
+        (response.body['data'] || []).map { |item| Models::SyncHealthEntry.new(item) }
+      end
+    end
+  end
+end

data/lib/administrate/resources/users.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Administrate
+  module Resources
+    class Users < BaseResource
+      def list(page: nil, per_page: nil)
+        params = {}
+        params[:page] = page unless page.nil?
+        params[:per_page] = per_page unless per_page.nil?
+        list_resource(path: 'users', model: Models::User, params: params)
+      end
+
+      def get(user_id)
+        get_resource("users/#{user_id}", Models::User)
+      end
+
+      def invite(email:, role: nil)
+        body = { email: email }
+        body[:role] = role unless role.nil?
+        response = @transport.post('users/invite', body)
+        Models::Invitation.new(response.body['data'])
+      end
+
+      def update(user_id, role:)
+        update_resource("users/#{user_id}", Models::User, { role: role })
+      end
+
+      def delete(user_id)
+        delete_resource("users/#{user_id}")
+      end
+    end
+  end
+end

data/lib/administrate/resources/webhooks.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Administrate
+  module Resources
+    class Webhooks < BaseResource
+      def list(page: nil, per_page: nil)
+        params = {}
+        params[:page] = page unless page.nil?
+        params[:per_page] = per_page unless per_page.nil?
+        list_resource(path: 'webhooks', model: Models::Webhook, params: params)
+      end
+
+      def get(webhook_id)
+        get_resource("webhooks/#{webhook_id}", Models::Webhook)
+      end
+
+      def create(url:, events:, description: nil, enabled: nil)
+        body = { url: url, events: events }
+        body[:description] = description unless description.nil?
+        body[:enabled] = enabled unless enabled.nil?
+        create_resource('webhooks', Models::Webhook, body)
+      end
+
+      def update(webhook_id, url: nil, events: nil, description: nil, enabled: nil)
+        body = {}
+        body[:url] = url unless url.nil?
+        body[:events] = events unless events.nil?
+        body[:description] = description unless description.nil?
+        body[:enabled] = enabled unless enabled.nil?
+        update_resource("webhooks/#{webhook_id}", Models::Webhook, body)
+      end
+
+      def delete(webhook_id)
+        delete_resource("webhooks/#{webhook_id}")
+      end
+
+      def regenerate_secret(webhook_id)
+        response = @transport.post("webhooks/#{webhook_id}/regenerate_secret")
+        Models::Webhook.new(response.body['data'])
+      end
+    end
+  end
+end

data/lib/administrate/resources/workflows.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Administrate
+  module Resources
+    class Workflows < BaseResource
+      def list(client_id: nil, instance_id: nil, active: nil, search: nil, page: nil, per_page: nil)
+        params = {}
+        params[:company_id] = client_id unless client_id.nil?
+        params[:instance_id] = instance_id unless instance_id.nil?
+        params[:active] = active.to_s unless active.nil?
+        params[:search] = search unless search.nil?
+        params[:page] = page unless page.nil?
+        params[:per_page] = per_page unless per_page.nil?
+        list_resource(path: 'workflows', model: Models::Workflow, params: params)
+      end
+
+      def get(workflow_id)
+        get_resource("workflows/#{workflow_id}", Models::Workflow)
+      end
+
+      def update(workflow_id, minutes_saved_per_success: nil, minutes_saved_per_failure: nil)
+        body = {}
+        body[:minutes_saved_per_success] = minutes_saved_per_success unless minutes_saved_per_success.nil?
+        body[:minutes_saved_per_failure] = minutes_saved_per_failure unless minutes_saved_per_failure.nil?
+        update_resource("workflows/#{workflow_id}", Models::Workflow, body)
+      end
+    end
+  end
+end

data/lib/administrate/transport.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday/retry'
+
+module Administrate
+  class Transport
+    def initialize(config)
+      @config = config
+      @base_url = "#{config.base_url.chomp('/')}/api/#{API_VERSION}"
+      @connection = build_connection
+    end
+
+    def get(path, params = {})
+      handle_request { @connection.get(url_for(path), params) }
+    end
+
+    def post(path, body = {})
+      handle_request { @connection.post(url_for(path), body) }
+    end
+
+    def patch(path, body = {})
+      handle_request { @connection.patch(url_for(path), body) }
+    end
+
+    def delete(path)
+      handle_request { @connection.delete(url_for(path)) }
+    end
+
+    private
+
+    def url_for(path)
+      "#{@base_url}/#{path.sub(%r{^/}, '')}"
+    end
+
+    def build_connection
+      Faraday.new do |f|
+        f.request :json
+        f.request :retry,
+                  max: @config.max_retries,
+                  interval: 0.5,
+                  backoff_factor: 2,
+                  retry_statuses: [429, 500, 502, 503, 504],
+                  retry_block: ->(**_) {}
+        f.response :json, content_type: /\bjson$/
+        f.headers = default_headers
+        f.options.timeout = @config.timeout
+        f.options.open_timeout = @config.timeout
+      end
+    end
+
+    def default_headers
+      {
+        'Authorization' => "Bearer #{@config.api_key}",
+        'User-Agent' => "administrate-ruby/#{VERSION}",
+        'Content-Type' => 'application/json',
+        'Accept' => 'application/json'
+      }
+    end
+
+    def handle_request
+      response = yield
+      handle_response(response)
+      response
+    rescue Faraday::TimeoutError => e
+      raise Administrate::TimeoutError, "Request timed out: #{e.message}"
+    rescue Faraday::ConnectionFailed => e
+      if e.cause.is_a?(::Timeout::Error) || e.cause.is_a?(Net::OpenTimeout)
+        raise Administrate::TimeoutError, "Request timed out: #{e.message}"
+      end
+
+      raise Administrate::ConnectionError, "Connection failed: #{e.message}"
+    end
+
+    def handle_response(response)
+      return if response.success?
+
+      body = response.body
+      message = if body.is_a?(Hash)
+                  body['error'] || response.reason_phrase
+                else
+                  body.to_s
+                end
+
+      status = response.status
+      exc_class = STATUS_CODE_MAP[status]
+
+      if exc_class == RateLimitError
+        retry_after = response.headers['Retry-After']
+        retry_after = retry_after.to_f if retry_after
+        raise RateLimitError.new(message, status_code: status, response: response, body: body, retry_after: retry_after)
+      elsif exc_class
+        raise exc_class.new(message, status_code: status, response: response, body: body)
+      elsif status >= 500
+        raise InternalServerError.new(message, status_code: status, response: response, body: body)
+      else
+        raise APIError.new(message, status_code: status, response: response, body: body)
+      end
+    end
+  end
+end

data/lib/administrate/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Administrate
+  VERSION = '0.1.0'
+end

data/lib/administrate-sdk.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'administrate'

data/lib/administrate.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative 'administrate/version'
+require_relative 'administrate/errors'
+require_relative 'administrate/configuration'
+require_relative 'administrate/base_model'
+require_relative 'administrate/page'
+require_relative 'administrate/models/pagination_meta'
+require_relative 'administrate/models/account'
+require_relative 'administrate/models/user'
+require_relative 'administrate/models/webhook'
+require_relative 'administrate/models/api_token'
+require_relative 'administrate/models/client_model'
+require_relative 'administrate/models/instance'
+require_relative 'administrate/models/workflow'
+require_relative 'administrate/models/execution'
+require_relative 'administrate/models/sync_run'
+require_relative 'administrate/models/llm_provider'
+require_relative 'administrate/models/llm_project'
+require_relative 'administrate/models/llm_cost'
+require_relative 'administrate/transport'
+require_relative 'administrate/cursor_iterator'
+require_relative 'administrate/resources/base_resource'
+require_relative 'administrate/resources/account'
+require_relative 'administrate/resources/users'
+require_relative 'administrate/resources/webhooks'
+require_relative 'administrate/resources/api_tokens'
+require_relative 'administrate/resources/clients'
+require_relative 'administrate/resources/instances'
+require_relative 'administrate/resources/workflows'
+require_relative 'administrate/resources/executions'
+require_relative 'administrate/resources/sync_runs'
+require_relative 'administrate/resources/llm_providers'
+require_relative 'administrate/resources/llm_projects'
+require_relative 'administrate/resources/llm_costs'
+require_relative 'administrate/client'
+
+module Administrate
+  def self.new(**kwargs)
+    Client.new(**kwargs)
+  end
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: administrate-sdk
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Administrate
+bindir: bin
+cert_chain: []
+date: 1980-01-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'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: faraday-retry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Typed Ruby client for the Administrate.dev API with auto-pagination,
+  retry, and typed exceptions.
+email:
+- support@administrate.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/administrate-sdk.rb
+- lib/administrate.rb
+- lib/administrate/base_model.rb
+- lib/administrate/client.rb
+- lib/administrate/configuration.rb
+- lib/administrate/cursor_iterator.rb
+- lib/administrate/errors.rb
+- lib/administrate/models/account.rb
+- lib/administrate/models/api_token.rb
+- lib/administrate/models/client_model.rb
+- lib/administrate/models/execution.rb
+- lib/administrate/models/instance.rb
+- lib/administrate/models/llm_cost.rb
+- lib/administrate/models/llm_project.rb
+- lib/administrate/models/llm_provider.rb
+- lib/administrate/models/pagination_meta.rb
+- lib/administrate/models/sync_run.rb
+- lib/administrate/models/user.rb
+- lib/administrate/models/webhook.rb
+- lib/administrate/models/workflow.rb
+- lib/administrate/page.rb
+- lib/administrate/resources/account.rb
+- lib/administrate/resources/api_tokens.rb
+- lib/administrate/resources/base_resource.rb
+- lib/administrate/resources/clients.rb
+- lib/administrate/resources/executions.rb
+- lib/administrate/resources/instances.rb
+- lib/administrate/resources/llm_costs.rb
+- lib/administrate/resources/llm_projects.rb
+- lib/administrate/resources/llm_providers.rb
+- lib/administrate/resources/sync_runs.rb
+- lib/administrate/resources/users.rb
+- lib/administrate/resources/webhooks.rb
+- lib/administrate/resources/workflows.rb
+- lib/administrate/transport.rb
+- lib/administrate/version.rb
+homepage: https://github.com/administrate-dev/administrate-ruby-sdk
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/administrate-dev/administrate-ruby-sdk
+  source_code_uri: https://github.com/administrate-dev/administrate-ruby-sdk
+  changelog_uri: https://github.com/administrate-dev/administrate-ruby-sdk/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.7.2
+specification_version: 4
+summary: Ruby client for the Administrate.dev REST API
+test_files: []