apia 3.0.0

data/lib/apia/schema/error_schema_type.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'apia/object'
+require 'apia/schema/field_schema_type'
+
+module Apia
+  module Schema
+    class ErrorSchemaType < Apia::Object
+
+      no_schema
+
+      field :id, type: :string
+      field :name, type: :string, null: true
+      field :description, type: :string, null: true
+      field :code, type: :string, backend: proc { |s| s.code.to_s }
+      field :http_status, type: :integer, backend: :http_status_code
+      field :fields, type: [FieldSchemaType] do
+        backend { |e| e.fields.values }
+      end
+
+    end
+  end
+end

data/lib/apia/schema/field_schema_type.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'apia/object'
+require 'apia/schema/field_spec_options_schema_type'
+
+module Apia
+  module Schema
+    class FieldSchemaType < Apia::Object
+
+      no_schema
+
+      field :id, type: :string
+      field :name, type: :string
+      field :description, type: :string, null: true
+      field :type, type: :string do
+        backend { |f| f.type.id }
+      end
+      field :null, type: :boolean do
+        backend(&:null?)
+      end
+      field :array, type: :boolean do
+        backend(&:array?)
+      end
+
+      field :spec, type: FieldSpecOptionsSchemaType do
+        backend do |field|
+          hash = {}
+          hash[:all] = field.include.nil? || field.include == true
+          if field.include.is_a?(String)
+            hash[:spec] = field.include
+          end
+          hash
+        end
+      end
+
+    end
+  end
+end

data/lib/apia/schema/field_spec_options_schema_type.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'apia/object'
+
+module Apia
+  module Schema
+    class FieldSpecOptionsSchemaType < Apia::Object
+
+      no_schema
+
+      field :all, type: :boolean
+      field :spec, type: :string, null: true
+
+    end
+  end
+end

data/lib/apia/schema/lookup_argument_set_schema_type.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'apia/object'
+require 'apia/schema/argument_schema_type'
+
+module Apia
+  module Schema
+    class LookupArgumentSetSchemaType < Apia::Object
+
+      no_schema
+
+      field :id, type: :string
+      field :name, type: :string, null: true
+      field :description, type: :string, null: true
+      field :arguments, type: [ArgumentSchemaType] do
+        backend { |as| as.arguments.values }
+      end
+
+      field :potential_errors, type: [:string] do
+        backend { |a| a.potential_errors.map { |e| e.definition.id } }
+      end
+
+    end
+  end
+end

data/lib/apia/schema/object_schema_polymorph.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'apia/polymorph'
+require 'apia/schema/object_schema_type'
+require 'apia/schema/scalar_schema_type'
+require 'apia/schema/enum_schema_type'
+require 'apia/schema/polymorph_schema_type'
+require 'apia/schema/api_schema_type'
+require 'apia/schema/lookup_argument_set_schema_type'
+
+module Apia
+  module Schema
+    class ObjectSchemaPolymorph < Apia::Polymorph
+
+      no_schema
+
+      option :object, type: ObjectSchemaType, matcher: proc { |o| o.is_a?(Apia::Definitions::Object) }
+      option :scalar, type: ScalarSchemaType, matcher: proc { |o| o.is_a?(Apia::Definitions::Scalar) }
+      option :enum, type: EnumSchemaType, matcher: proc { |o| o.is_a?(Apia::Definitions::Enum) }
+      option :polymorph, type: PolymorphSchemaType, matcher: proc { |o| o.is_a?(Apia::Definitions::Polymorph) }
+      option :authenticator, type: AuthenticatorSchemaType, matcher: proc { |o| o.is_a?(Apia::Definitions::Authenticator) }
+      option :controller, type: ControllerSchemaType, matcher: proc { |o| o.is_a?(Apia::Definitions::Controller) }
+      option :endpoint, type: EndpointSchemaType, matcher: proc { |o| o.is_a?(Apia::Definitions::Endpoint) }
+      option :error, type: ErrorSchemaType, matcher: proc { |o| o.is_a?(Apia::Definitions::Error) }
+      option :lookup_argument_set, type: LookupArgumentSetSchemaType, matcher: proc { |o| o.is_a?(Apia::Definitions::LookupArgumentSet) }
+      option :argument_set, type: ArgumentSetSchemaType, matcher: proc { |o| o.is_a?(Apia::Definitions::ArgumentSet) }
+      option :api, type: APISchemaType, matcher: proc { |o| o.is_a?(Apia::Definitions::API) }
+
+    end
+  end
+end

data/lib/apia/schema/object_schema_type.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'apia/object'
+require 'apia/schema/field_schema_type'
+
+module Apia
+  module Schema
+    class ObjectSchemaType < Apia::Object
+
+      no_schema
+
+      field :id, type: :string
+      field :name, type: :string, null: true
+      field :description, type: :string, null: true
+      field :fields, type: [FieldSchemaType] do
+        backend { |e| e.fields.values }
+      end
+
+    end
+  end
+end

data/lib/apia/schema/polymorph_option_schema_type.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Apia
+  module Schema
+    class PolymorphOptionSchemaType < Apia::Object
+
+      no_schema
+
+      field :name, type: :string
+      field :type, type: :string do
+        backend { |a| a.type.id }
+      end
+
+    end
+  end
+end

data/lib/apia/schema/polymorph_schema_type.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'apia/schema/polymorph_option_schema_type'
+
+module Apia
+  module Schema
+    class PolymorphSchemaType < Apia::Object
+
+      no_schema
+
+      field :id, type: :string
+      field :name, type: :string, null: true
+      field :description, type: :string, null: true
+      field :options, type: [PolymorphOptionSchemaType] do
+        backend { |o| o.options.values }
+      end
+
+    end
+  end
+end

data/lib/apia/schema/request_method_enum.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'apia/route'
+
+module Apia
+  module Schema
+    class RequestMethodEnum < Apia::Enum
+
+      no_schema
+
+      Route::REQUEST_METHODS.each do |method|
+        value method.to_s.upcase
+      end
+
+      cast do |value|
+        value.to_s.upcase
+      end
+
+    end
+  end
+end

data/lib/apia/schema/route_group_schema_type.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'apia/schema/request_method_enum'
+
+module Apia
+  module Schema
+    class RouteGroupSchemaType < Apia::Object
+
+      no_schema
+
+      field :id, type: :string
+      field :name, type: :string, null: true
+      field :description, type: :string, null: true
+
+      field :groups, type: [RouteGroupSchemaType]
+
+    end
+  end
+end

data/lib/apia/schema/route_schema_type.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'apia/schema/request_method_enum'
+
+module Apia
+  module Schema
+    class RouteSchemaType < Apia::Object
+
+      no_schema
+
+      field :path, type: :string
+
+      field :request_method, type: RequestMethodEnum do
+        backend { |route| route.request_method }
+      end
+
+      field :controller, type: :string, null: true do
+        backend { |route| route.controller&.definition&.id }
+      end
+
+      field :endpoint, type: :string, null: true do
+        backend { |route| route.endpoint&.definition&.id }
+      end
+
+      field :group, type: :string, null: true do
+        backend { |route| route.group&.id }
+      end
+
+    end
+  end
+end

data/lib/apia/schema/route_set_schema_type.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'apia/schema/route_schema_type'
+require 'apia/schema/route_group_schema_type'
+module Apia
+  module Schema
+    class RouteSetSchemaType < Apia::Object
+
+      no_schema
+
+      field :routes, [RouteSchemaType] do
+        backend do |o|
+          o.routes.select { |r| r.endpoint&.definition&.schema? }
+        end
+      end
+      field :groups, [RouteGroupSchemaType]
+
+    end
+  end
+end

data/lib/apia/schema/scalar_schema_type.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Apia
+  module Schema
+    class ScalarSchemaType < Apia::Object
+
+      no_schema
+
+      field :id, type: :string
+      field :name, type: :string, null: true
+      field :description, type: :string, null: true
+
+    end
+  end
+end

data/lib/apia/schema/scope_type.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'apia/object'
+
+module Apia
+  module Schema
+    class ScopeType < Apia::Object
+
+      field :name, :string
+      field :description, :string
+
+    end
+  end
+end

data/lib/apia/version.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Apia
+
+  VERSION_FILE_ROOT = File.expand_path('../../VERSION', __dir__)
+  if File.file?(VERSION_FILE_ROOT)
+    VERSION = File.read(VERSION_FILE_ROOT).strip.sub(/\Av/, '')
+  else
+    VERSION = '0.0.0.dev'
+  end
+
+end

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification
+name: apia
+version: !ruby/object:Gem::Version
+  version: 3.0.0
+platform: ruby
+authors:
+- Adam Cooke
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-08-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  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: rack
+  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'
+description: A framework for building HTTP APIs.
+email:
+- adam@k.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- VERSION
+- lib/apia.rb
+- lib/apia/api.rb
+- lib/apia/argument_set.rb
+- lib/apia/authenticator.rb
+- lib/apia/callable_with_environment.rb
+- lib/apia/controller.rb
+- lib/apia/defineable.rb
+- lib/apia/definition.rb
+- lib/apia/definitions/api.rb
+- lib/apia/definitions/argument.rb
+- lib/apia/definitions/argument_set.rb
+- lib/apia/definitions/authenticator.rb
+- lib/apia/definitions/controller.rb
+- lib/apia/definitions/endpoint.rb
+- lib/apia/definitions/enum.rb
+- lib/apia/definitions/error.rb
+- lib/apia/definitions/field.rb
+- lib/apia/definitions/lookup_argument_set.rb
+- lib/apia/definitions/object.rb
+- lib/apia/definitions/polymorph.rb
+- lib/apia/definitions/polymorph_option.rb
+- lib/apia/definitions/scalar.rb
+- lib/apia/definitions/type.rb
+- lib/apia/dsl.rb
+- lib/apia/dsls/api.rb
+- lib/apia/dsls/argument.rb
+- lib/apia/dsls/argument_set.rb
+- lib/apia/dsls/authenticator.rb
+- lib/apia/dsls/concerns/has_fields.rb
+- lib/apia/dsls/controller.rb
+- lib/apia/dsls/endpoint.rb
+- lib/apia/dsls/enum.rb
+- lib/apia/dsls/error.rb
+- lib/apia/dsls/field.rb
+- lib/apia/dsls/lookup_argument_set.rb
+- lib/apia/dsls/object.rb
+- lib/apia/dsls/polymorph.rb
+- lib/apia/dsls/route_group.rb
+- lib/apia/dsls/route_set.rb
+- lib/apia/dsls/scalar.rb
+- lib/apia/dsls/scope_descriptions.rb
+- lib/apia/endpoint.rb
+- lib/apia/enum.rb
+- lib/apia/environment_error_handling.rb
+- lib/apia/error.rb
+- lib/apia/error_set.rb
+- lib/apia/errors/error_exception_error.rb
+- lib/apia/errors/field_spec_parse_error.rb
+- lib/apia/errors/invalid_argument_error.rb
+- lib/apia/errors/invalid_enum_option_error.rb
+- lib/apia/errors/invalid_helper_error.rb
+- lib/apia/errors/invalid_json_error.rb
+- lib/apia/errors/invalid_polymorph_value_error.rb
+- lib/apia/errors/invalid_scalar_value_error.rb
+- lib/apia/errors/manifest_error.rb
+- lib/apia/errors/missing_argument_error.rb
+- lib/apia/errors/null_field_value_error.rb
+- lib/apia/errors/parse_error.rb
+- lib/apia/errors/runtime_error.rb
+- lib/apia/errors/scope_not_granted_error.rb
+- lib/apia/errors/standard_error.rb
+- lib/apia/field_set.rb
+- lib/apia/field_spec.rb
+- lib/apia/helpers.rb
+- lib/apia/hook_set.rb
+- lib/apia/lookup_argument_set.rb
+- lib/apia/lookup_environment.rb
+- lib/apia/manifest_errors.rb
+- lib/apia/mock_request.rb
+- lib/apia/object.rb
+- lib/apia/object_set.rb
+- lib/apia/pagination_object.rb
+- lib/apia/polymorph.rb
+- lib/apia/rack.rb
+- lib/apia/rack_error.rb
+- lib/apia/request.rb
+- lib/apia/request_environment.rb
+- lib/apia/request_headers.rb
+- lib/apia/response.rb
+- lib/apia/route.rb
+- lib/apia/route_group.rb
+- lib/apia/route_set.rb
+- lib/apia/scalar.rb
+- lib/apia/scalars.rb
+- lib/apia/scalars/base64.rb
+- lib/apia/scalars/boolean.rb
+- lib/apia/scalars/date.rb
+- lib/apia/scalars/decimal.rb
+- lib/apia/scalars/integer.rb
+- lib/apia/scalars/string.rb
+- lib/apia/scalars/unix_time.rb
+- lib/apia/schema/api_controller_schema_type.rb
+- lib/apia/schema/api_schema_type.rb
+- lib/apia/schema/argument_schema_type.rb
+- lib/apia/schema/argument_set_schema_type.rb
+- lib/apia/schema/authenticator_schema_type.rb
+- lib/apia/schema/controller.rb
+- lib/apia/schema/controller_endpoint_schema_type.rb
+- lib/apia/schema/controller_schema_type.rb
+- lib/apia/schema/endpoint_schema_type.rb
+- lib/apia/schema/enum_schema_type.rb
+- lib/apia/schema/enum_value_schema_type.rb
+- lib/apia/schema/error_schema_type.rb
+- lib/apia/schema/field_schema_type.rb
+- lib/apia/schema/field_spec_options_schema_type.rb
+- lib/apia/schema/lookup_argument_set_schema_type.rb
+- lib/apia/schema/object_schema_polymorph.rb
+- lib/apia/schema/object_schema_type.rb
+- lib/apia/schema/polymorph_option_schema_type.rb
+- lib/apia/schema/polymorph_schema_type.rb
+- lib/apia/schema/request_method_enum.rb
+- lib/apia/schema/route_group_schema_type.rb
+- lib/apia/schema/route_schema_type.rb
+- lib/apia/schema/route_set_schema_type.rb
+- lib/apia/schema/scalar_schema_type.rb
+- lib/apia/schema/scope_type.rb
+- lib/apia/version.rb
+homepage: https://github.com/krystal/apia
+licenses: []
+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.1.6
+signing_key: 
+specification_version: 4
+summary: This gem provides a friendly DSL for constructing HTTP APIs.
+test_files: []