one_doc 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9c3b61eb7ce634a89803c4152ba9caf7d8caae0292d22b77586245e0e5dfdda8
+  data.tar.gz: 160026145927a3e9550a8b8a1e99bd3645eff975eba4d253162a382e39f5154b
+SHA512:
+  metadata.gz: 831e7b0508c78cb9c9548a2c56d034a1c6f423f281a98d7cc123e32011e2648d4173137d104db738f4ab575927e0ad827ac84b4a660be6e1ea80890d41e0f386
+  data.tar.gz: 0ee23781314bc38fcf2e4b448f7c851850258964850be70bdce66a4fff8b189addd3272df937cee712530cfd11fe94be34b924b6dd59df65a52418c2228fdb37

data/lib/one_doc.rb

@@ -0,0 +1,209 @@
+# Generated by Sideko (sideko.dev)
+# frozen_string_literal: true
+require 'json'
+require 'http'
+
+class RequestError < StandardError
+  attr_reader :status_code, :method, :url, :data, :response
+
+  def initialize(method, url, response)
+    @status_code = response.status
+    @method = method
+    @url = url
+    begin
+      @data = response.parse
+    rescue
+      @data = nil
+    end
+    @response = response
+
+    super("received #{status_code} from #{method} #{url} with #{message}")
+  end
+end
+
+module AuthProvider
+  def add_auth(http_client, req_kwargs)
+    raise NotImplementedError, "You must implement the 'add_auth' method"
+  end
+end
+
+class AuthBasic
+  include AuthProvider
+
+  attr_accessor :username, :password
+
+  def initialize(username: nil, password: nil)
+    @username = username
+    @password = password
+  end
+
+  def add_auth(http_client, req_kwargs)
+    if !@username.nil? && !@password.nil?
+      http_client = http_client.basic_auth(user: @username, pass: @password)
+    end
+
+    return http_client, req_kwargs
+  end
+end
+
+class AuthBearer
+  include AuthProvider
+
+  attr_accessor :val
+
+  def initialize(val: nil)
+    @val = val
+  end
+
+  def add_auth(http_client, req_kwargs)
+    if !@val.nil?
+      headers = req_kwargs.fetch(:headers, {})
+      headers["Authorization"] = "Bearer " + @val
+      req_kwargs[:headers] = headers
+    end
+
+    return http_client, req_kwargs
+  end
+end
+
+class AuthKeyQuery
+  include AuthProvider
+
+  attr_accessor :query_name, :val
+
+  def initialize(query_name: nil, val: nil)
+    @query_name = query_name
+    @val = val
+  end
+
+  def add_auth(http_client, req_kwargs)
+    if !val.nil?
+      params = req_kwargs.fetch(:params, {})
+      params[query_name] = val
+      req_kwargs[:params] = params
+    end
+
+    return http_client, req_kwargs
+  end
+end
+
+class AuthKeyHeader
+  include AuthProvider
+
+  attr_accessor :header_name, :val
+
+  def initialize(header_name: nil, val: nil)
+    @header_name = header_name
+    @val = val
+  end
+
+  def add_auth(http_client, req_kwargs)
+    if !@val.nil?
+      headers = req_kwargs.fetch(:headers, {})
+      headers[@header_name] = @val
+      req_kwargs[:headers] = headers
+    end
+
+    return http_client, req_kwargs
+  end
+end
+
+class AuthKeyCookie
+  include AuthProvider
+
+  attr_accessor :cookie_name, :val
+
+  def initialize(cookie_name: nil, val: nil)
+    @cookie_name = cookie_name
+    @val = val
+  end
+
+  def add_auth(http_client, req_kwargs)
+    if !@val.nil?
+      http_client = http_client.cookies(@cookie_name => @val)
+    end
+
+    return http_client, req_kwargs
+  end
+end
+
+class SidekoClient
+  def initialize(api_key_auth: nil, base_url: 'https://app.onedoclabs.com')
+    @_base_url = base_url
+    # register auth providers
+    @_auth = {}
+    @_auth[:"ApiKeyAuth"] = AuthKeyHeader.new(header_name: "x-api-key", val: api_key_auth)
+  end
+
+  def _client_with_auth(auth_names, **req_kwargs)
+    http_client = HTTP
+    auth_names.each do |auth_name|
+      provider = @_auth[auth_name]
+      http_client, req_kwargs = provider.add_auth(http_client, req_kwargs) if provider
+    end
+    
+    return http_client, req_kwargs
+  end
+
+
+  # This route is responsible for generating a PDF from a bucket.  It expects a JSON body with details of the bucket, user credentials, and PDF generation options.
+  def post_api_docs_generate(data)
+    _url = @_base_url + "/api/docs/generate"
+    _kwargs = {
+      params: {}
+    }
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"ApiKeyAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.post(
+      _url,
+      json: data,
+      **_req_kwargs
+    )
+
+    # Raise if not expected success code
+    if _response.status != 200
+      raise RequestError.new(
+        method="post",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response
+  end
+
+  # This endpoint creates a bucket for the html and all specified assets. It returns signed urls to the buckets.
+  def post_api_docs_initiate(data)
+    _url = @_base_url + "/api/docs/initiate"
+    _kwargs = {
+      params: {}
+    }
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"ApiKeyAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.post(
+      _url,
+      json: data,
+      **_req_kwargs
+    )
+
+    # Raise if not expected success code
+    if _response.status != 200
+      raise RequestError.new(
+        method="post",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: one_doc
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sideko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-02-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.1
+description: Onedoc is the document API for developers.
+email: team@sideko.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/one_doc.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.5
+signing_key: 
+specification_version: 4
+summary: one_doc 0.1.0
+test_files: []