rubst_api 0.1.0

data/lib/rubst_api/test_client.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module RubstApi
+  class TestResponse
+    attr_reader :status, :headers, :body
+    def initialize(status, headers, body)
+      @status, @headers = status, Headers.new(headers)
+      @body = body.respond_to?(:each) ? body.to_a.join : body.to_s
+      body.close if body.respond_to?(:close)
+    end
+    alias status_code status
+    def json = JSON.parse(body)
+    def text = body
+    def success? = status.between?(200, 299)
+  end
+
+  class TestClient
+    def initialize(app, base_url: "http://testserver")
+      @app, @base_url = app, base_url
+    end
+
+    %i[get post put patch delete options head].each do |method|
+      define_method(method) { |path, **options| request(method, path, **options) }
+    end
+
+    def request(method, path, params: nil, json: UNDEFINED, data: nil, headers: {}, cookies: {})
+      uri = URI.join(@base_url, path)
+      query = URI.decode_www_form(uri.query.to_s)
+      query.concat(params.flat_map { |key, value| Array(value).map { |item| [key.to_s, item.to_s] } }) if params
+      body = if !json.equal?(UNDEFINED)
+               headers = { "Content-Type" => "application/json" }.merge(headers)
+               JSON.generate(json)
+             elsif data
+               headers = { "Content-Type" => "application/x-www-form-urlencoded" }.merge(headers)
+               URI.encode_www_form(data)
+             else ""
+             end
+      headers["Cookie"] = cookies.map { |key, value| "#{key}=#{value}" }.join("; ") unless cookies.empty?
+      env = {
+        "REQUEST_METHOD" => method.to_s.upcase, "PATH_INFO" => uri.path,
+        "QUERY_STRING" => URI.encode_www_form(query), "rack.input" => StringIO.new(body),
+        "rack.url_scheme" => uri.scheme, "HTTP_HOST" => uri.host,
+        "CONTENT_LENGTH" => body.bytesize.to_s
+      }
+      headers.each do |key, value|
+        env[key.to_s.downcase == "content-type" ? "CONTENT_TYPE" : "HTTP_#{key.to_s.upcase.tr("-", "_")}"] = value
+      end
+      TestResponse.new(*@app.call(env))
+    end
+  end
+end

data/lib/rubst_api/version.rb

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

data/lib/rubst_api/websocket.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module RubstApi
+  class WebSocket
+    attr_reader :env, :path_params, :state
+    def initialize(env, path_params: {})
+      @env, @path_params, @state = env, path_params, {}
+      @socket = env["rack.websocket"]
+    end
+    def accept(subprotocol: nil, headers: {}) = @socket&.accept(subprotocol:, headers:)
+    def receive = @socket&.receive
+    def receive_text = receive.to_s
+    def receive_json = JSON.parse(receive_text)
+    def send_text(data) = @socket&.send(data.to_s)
+    def send_json(data) = send_text(JSON.generate(Serializer.dump(data)))
+    def close(code: 1000, reason: nil) = @socket&.close(code, reason)
+    def query_params = Request.new(env).query_params
+    def headers = Request.new(env).headers
+    def cookies = Request.new(env).cookies
+  end
+end

data/lib/rubst_api.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "rubst_api/version"
+require_relative "rubst_api/errors"
+require_relative "rubst_api/params"
+require_relative "rubst_api/model"
+require_relative "rubst_api/http"
+require_relative "rubst_api/responses"
+require_relative "rubst_api/dependencies"
+require_relative "rubst_api/security"
+require_relative "rubst_api/routing"
+require_relative "rubst_api/openapi"
+require_relative "rubst_api/middleware"
+require_relative "rubst_api/background_tasks"
+require_relative "rubst_api/websocket"
+require_relative "rubst_api/static_files"
+require_relative "rubst_api/sse"
+require_relative "rubst_api/status"
+require_relative "rubst_api/app"
+require_relative "rubst_api/test_client"
+
+module RubstApi
+  class << self
+    def Query(type = String, **options) = Param.new(:query, type:, **options)
+    def Path(type = String, **options) = Param.new(:path, type:, required: true, **options)
+    def Header(type = String, **options) = Param.new(:header, type:, **options)
+    def Cookie(type = String, **options) = Param.new(:cookie, type:, **options)
+    def Body(type = Hash, **options) = Param.new(:body, type:, **options)
+    def Form(type = String, **options) = Param.new(:form, type:, **options)
+    def File(**options) = Param.new(:file, type: UploadFile, **options)
+    def Depends(callable = nil, **options, &block) = Dependency.new(callable || block, **options)
+    def Security(callable = nil, scopes: [], **options, &block)
+      SecurityDependency.new(callable || block, scopes:, **options)
+    end
+
+    def jsonable_encoder(value, **)
+      Serializer.dump(value)
+    end
+  end
+end

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification
+name: rubst_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jory Leech
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rackup
+  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: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '14.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '14.0'
+description: |-
+  RubstAPI is a FastAPI-inspired, Rack-compatible framework for building
+  typed Ruby REST APIs. It provides request and response validation,
+  dependency injection, OpenAPI 3.1 schemas, Swagger UI, ReDoc, security
+  helpers, middleware, routing, background tasks, and testing utilities.
+email:
+- joryleech@gmail.com
+executables:
+- rubst_api
+extensions: []
+extra_rdoc_files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- THIRD_PARTY_NOTICES.md
+files:
+- CHANGELOG.md
+- LICENSE
+- LICENSES/FASTAPI-MIT.txt
+- README.md
+- SECURITY.md
+- THIRD_PARTY_NOTICES.md
+- exe/rubst_api
+- lib/rubst_api.rb
+- lib/rubst_api/app.rb
+- lib/rubst_api/background_tasks.rb
+- lib/rubst_api/dependencies.rb
+- lib/rubst_api/errors.rb
+- lib/rubst_api/http.rb
+- lib/rubst_api/middleware.rb
+- lib/rubst_api/model.rb
+- lib/rubst_api/openapi.rb
+- lib/rubst_api/params.rb
+- lib/rubst_api/responses.rb
+- lib/rubst_api/routing.rb
+- lib/rubst_api/security.rb
+- lib/rubst_api/sse.rb
+- lib/rubst_api/static_files.rb
+- lib/rubst_api/status.rb
+- lib/rubst_api/test_client.rb
+- lib/rubst_api/version.rb
+- lib/rubst_api/websocket.rb
+homepage: https://github.com/joryleech/RubstApi
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  bug_tracker_uri: https://github.com/joryleech/RubstApi/issues
+  changelog_uri: https://github.com/joryleech/RubstApi/blob/main/CHANGELOG.md
+  documentation_uri: https://github.com/joryleech/RubstApi#readme
+  homepage_uri: https://github.com/joryleech/RubstApi
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/joryleech/RubstApi/tree/main
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+requirements: []
+rubygems_version: 4.0.16
+specification_version: 4
+summary: Build typed Ruby APIs with validation and automatic OpenAPI docs
+test_files: []