apia 3.0.0

data/lib/apia/scalars/decimal.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'apia/scalars'
+require 'apia/scalar'
+
+module Apia
+  module Scalars
+    class Decimal < Apia::Scalar
+
+      Scalars.register :decimal, self
+
+      name 'Decimal'
+
+      cast do |value|
+        value.to_f
+      end
+
+      validator do |value|
+        value.is_a?(::Float)
+      end
+
+      parse do |value|
+        if value.is_a?(::String) && value =~ /\A-?\d+(\.\d+)?\z/
+          value.to_f
+        elsif value.is_a?(::Float)
+          value
+        elsif value.is_a?(::Integer)
+          value.to_i
+        else
+          raise Apia::ParseError, 'Decimal must be provided as a decimal, integer or a string only containing numbers'
+        end
+      end
+
+    end
+  end
+end

data/lib/apia/scalars/integer.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'apia/scalars'
+require 'apia/scalar'
+
+module Apia
+  module Scalars
+    class Integer < Apia::Scalar
+
+      Scalars.register :integer, self
+
+      name 'Integer'
+
+      cast do |value|
+        value.to_i
+      end
+
+      validator do |value|
+        value.is_a?(::Integer)
+      end
+
+      parse do |value|
+        if value.is_a?(::String) && value =~ /\A-?\d+\z/
+          value.to_i
+        elsif value.is_a?(::Integer)
+          value
+        else
+          raise Apia::ParseError, 'Integer must be provided as an integer or a string only containing numbers'
+        end
+      end
+
+    end
+  end
+end

data/lib/apia/scalars/string.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'apia/scalars'
+require 'apia/scalar'
+
+module Apia
+  module Scalars
+    class String < Apia::Scalar
+
+      Scalars.register :string, self
+
+      name 'String'
+
+      cast do |value|
+        value.to_s
+      end
+
+      validator do |value|
+        value.is_a?(::String) || value.is_a?(::Symbol)
+      end
+
+    end
+  end
+end

data/lib/apia/scalars/unix_time.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'time'
+require 'apia/scalars'
+require 'apia/scalar'
+require 'apia/errors/parse_error'
+
+module Apia
+  module Scalars
+    class UnixTime < Apia::Scalar
+
+      Scalars.register :unix_time, self
+
+      name 'Unix Timestamp'
+
+      cast do |time|
+        time.to_i
+      end
+
+      validator do |value|
+        value.is_a?(::Time)
+      end
+
+      parse do |integer|
+        next integer if integer.is_a?(::Time)
+
+        unless integer.is_a?(::Integer)
+          raise Apia::ParseError, 'Time must be provided as an integer'
+        end
+
+        if integer.negative?
+          raise Apia::ParseError, 'Integer must be positive or zero'
+        end
+
+        Time.at(integer).utc
+      end
+
+    end
+  end
+end

data/lib/apia/schema/api_controller_schema_type.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'apia/object'
+require 'apia/schema/controller_schema_type'
+
+module Apia
+  module Schema
+    class APIControllerSchemaType < Apia::Object
+
+      no_schema
+
+      field :name, type: :string
+      field :controller, type: :string
+
+    end
+  end
+end

data/lib/apia/schema/api_schema_type.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'apia/object'
+require 'apia/schema/authenticator_schema_type'
+require 'apia/schema/api_controller_schema_type'
+require 'apia/schema/object_schema_polymorph'
+require 'apia/schema/route_set_schema_type'
+require 'apia/schema/scope_type'
+
+module Apia
+  module Schema
+    class APISchemaType < Apia::Object
+
+      no_schema
+
+      condition { |api| api.schema? }
+
+      field :id, type: :string do
+        backend { |api| api.id }
+      end
+
+      field :name, type: :string, null: true do
+        backend { |api| api.name }
+      end
+
+      field :description, type: :string, null: true do
+        backend { |api| api.description }
+      end
+
+      field :authenticator, type: :string, null: true do
+        backend { |api| api.authenticator&.definition&.id }
+      end
+
+      field :route_set, type: RouteSetSchemaType
+      field :scopes, type: [ScopeType] do
+        backend do |api|
+          api.scopes.map { |k, v| v.merge(name: k) }
+        end
+      end
+
+    end
+  end
+end

data/lib/apia/schema/argument_schema_type.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'apia/object'
+
+module Apia
+  module Schema
+    class ArgumentSchemaType < Apia::Object
+
+      no_schema
+
+      field :name, type: :string
+      field :description, type: :string, null: true
+      field :type, type: :string do
+        backend { |f| f.type.id }
+      end
+      field :required, type: :boolean do
+        backend(&:required?)
+      end
+      field :array, type: :boolean do
+        backend(&:array?)
+      end
+      field :default, type: :string, null: true do
+        backend { |o| o.default&.to_s }
+      end
+
+    end
+  end
+end

data/lib/apia/schema/argument_set_schema_type.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'apia/object'
+require 'apia/schema/argument_schema_type'
+
+module Apia
+  module Schema
+    class ArgumentSetSchemaType < 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
+
+    end
+  end
+end

data/lib/apia/schema/authenticator_schema_type.rb

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

data/lib/apia/schema/controller.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'apia/controller'
+require 'apia/authenticator'
+require 'apia/schema/object_schema_polymorph'
+require 'apia/schema/route_set_schema_type'
+
+module Apia
+  module Schema
+    class Controller < Apia::Controller
+
+      no_schema
+
+      authenticator do
+        type :anonymous
+      end
+
+      name 'API Schema'
+      description 'Provides endpoint to interrogate the API schema'
+      endpoint :schema do
+        no_schema
+        description 'Returns a payload outlining the full schema of the API'
+        field :schema_version, type: :integer
+        field :host, type: :string
+        field :namespace, type: :string
+        field :api, type: :string
+        field :objects, type: [ObjectSchemaPolymorph]
+        action do
+          response.add_field :schema_version, 1
+          response.add_field :objects, request.api.objects.map(&:definition).select(&:schema?)
+          response.add_field :api, request.api.definition.id
+          response.add_field :namespace, request.namespace
+          response.add_field :host, request.host
+        end
+      end
+
+    end
+  end
+end

data/lib/apia/schema/controller_endpoint_schema_type.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'apia/object'
+require 'apia/schema/endpoint_schema_type'
+
+module Apia
+  module Schema
+    class ControllerEndpointSchemaType < Apia::Object
+
+      no_schema
+
+      field :name, type: :string
+      field :endpoint, type: :string
+
+    end
+  end
+end

data/lib/apia/schema/controller_schema_type.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'apia/object'
+require 'apia/schema/authenticator_schema_type'
+require 'apia/schema/controller_endpoint_schema_type'
+
+module Apia
+  module Schema
+    class ControllerSchemaType < Apia::Object
+
+      no_schema
+
+      field :id, type: :string
+      field :name, type: :string, null: true
+      field :description, type: :string, null: true
+      field :authenticator, type: :string, null: true do
+        backend { |c| c.authenticator&.definition&.id }
+      end
+      field :endpoints, type: [ControllerEndpointSchemaType] do
+        backend do |c|
+          c.endpoints.map do |key, endpoint|
+            {
+              name: key.to_s,
+              endpoint: endpoint.definition.id
+            }
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/apia/schema/endpoint_schema_type.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'apia/object'
+require 'apia/schema/authenticator_schema_type'
+require 'apia/schema/field_schema_type'
+require 'apia/schema/argument_set_schema_type'
+require 'apia/schema/error_schema_type'
+
+module Apia
+  module Schema
+    class EndpointSchemaType < Apia::Object
+
+      no_schema
+
+      field :id, type: :string
+      field :name, type: :string, null: true
+      field :description, type: :string, null: true
+      field :http_status, type: :integer, backend: :http_status_code
+      field :authenticator, type: :string, null: true do
+        backend { |e| e.authenticator&.definition&.id }
+      end
+      field :argument_set, type: ArgumentSetSchemaType do
+        backend { |e| e.argument_set.definition }
+      end
+      field :fields, type: [FieldSchemaType] do
+        backend { |e| e.fields.values }
+      end
+      field :potential_errors, type: [:string] do
+        backend { |a| a.potential_errors.map { |e| e.definition.id } }
+      end
+      field :scopes, type: [:string]
+
+    end
+  end
+end

data/lib/apia/schema/enum_schema_type.rb

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

data/lib/apia/schema/enum_value_schema_type.rb

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