apia 3.0.0

data/lib/apia/dsl.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Apia
+  class DSL
+
+    def initialize(definition)
+      @definition = definition
+    end
+
+    def name(name)
+      @definition.name = name
+    end
+
+    def description(description)
+      @definition.description = description
+    end
+
+    def no_schema
+      @definition.schema = false
+    end
+
+  end
+end

data/lib/apia/dsls/api.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'apia/dsl'
+require 'apia/helpers'
+require 'apia/dsls/scope_descriptions'
+
+module Apia
+  module DSLs
+    class API < DSL
+
+      def authenticator(klass = nil, &block)
+        if block_given?
+          id = "#{@definition.id}/#{Helpers.camelize(klass) || 'Authenticator'}"
+          klass = Apia::Authenticator.create(id, &block)
+        end
+
+        @definition.authenticator = klass
+      end
+
+      def exception_handler(block_var = nil, &block)
+        @definition.exception_handlers.add(block_var, &block)
+      end
+
+      def routes(&block)
+        @definition.route_set.dsl.instance_eval(&block) if block_given?
+      end
+
+      def scopes(&block)
+        return unless block_given?
+
+        dsl = DSLs::ScopeDescriptions.new(@definition)
+        dsl.instance_eval(&block)
+      end
+
+    end
+  end
+end

data/lib/apia/dsls/argument.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'apia/dsl'
+
+module Apia
+  module DSLs
+    class Argument < DSL
+
+      def validation(name, &block)
+        @definition.validations << { name: name, block: block }
+      end
+
+      def required(value)
+        @definition.required = value
+      end
+
+      def array(value)
+        @definition.array = value
+      end
+
+      def default(value)
+        @definition.default = value
+      end
+
+    end
+  end
+end

data/lib/apia/dsls/argument_set.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'apia/dsl'
+require 'apia/definitions/argument'
+require 'apia/helpers'
+
+module Apia
+  module DSLs
+    class ArgumentSet < DSL
+
+      def argument(name, *args, type: nil, **options, &block)
+        type = args[0] if type.nil?
+
+        argument = Definitions::Argument.new(name, id: "#{@definition.id}/#{Helpers.camelize(name.to_s)}Argument")
+
+        if type.is_a?(Array)
+          argument.type = type[0]
+          argument.array = true
+        else
+          argument.type = type
+          argument.array = false
+        end
+
+        argument.required = options[:required] if options.key?(:required)
+        argument.default = options[:default] if options.key?(:default)
+        argument.description = options[:description] if options.key?(:description)
+
+        argument.dsl.instance_eval(&block) if block_given?
+
+        @definition.arguments[name.to_sym] = argument
+      end
+
+    end
+  end
+end

data/lib/apia/dsls/authenticator.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'apia/dsl'
+require 'apia/helpers'
+require 'apia/errors/scope_not_granted_error'
+
+module Apia
+  module DSLs
+    class Authenticator < DSL
+
+      def type(type)
+        @definition.type = type
+      end
+
+      def potential_error(klass, &block)
+        if block_given? && klass.is_a?(String)
+          id = "#{@definition.id}/#{Helpers.camelize(klass)}"
+          klass = Apia::Error.create(id, &block)
+        end
+
+        @definition.potential_errors << klass
+      end
+
+      def action(&block)
+        @definition.action = block
+      end
+
+      def scope_validator(&block)
+        unless @definition.potential_errors.include?(Apia::ScopeNotGrantedError)
+          potential_error Apia::ScopeNotGrantedError
+        end
+
+        @definition.scope_validator = block
+      end
+
+    end
+  end
+end

data/lib/apia/dsls/concerns/has_fields.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'apia/definitions/field'
+require 'apia/helpers'
+
+module Apia
+  module DSLs
+    module Concerns
+      module HasFields
+
+        def field(name, *args, type: nil, **options, &block)
+          type = args[0] if type.nil?
+
+          field = Definitions::Field.new(name, id: "#{@definition.id}/#{Helpers.camelize(name)}Field")
+
+          if type.is_a?(Array)
+            field.type = type[0]
+            field.array = true
+          else
+            field.type = type
+            field.array = false
+          end
+
+          field.null = options[:null] if options.key?(:null)
+          field.array = options[:array] if options.key?(:array)
+          field.include = options[:include] if options.key?(:include)
+          field.backend = options[:backend] if options.key?(:backend)
+          field.description = options[:description] if options.key?(:description)
+
+          field.dsl.instance_eval(&block) if block_given?
+
+          @definition.fields.add(field)
+        end
+
+      end
+    end
+  end
+end

data/lib/apia/dsls/controller.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'apia/dsl'
+require 'apia/endpoint'
+
+module Apia
+  module DSLs
+    class Controller < DSL
+
+      def authenticator(klass = nil, &block)
+        if block_given?
+          id = "#{@definition.id}/#{Helpers.camelize(klass) || 'Authenticator'}"
+          klass = Apia::Authenticator.create(id, &block)
+        end
+
+        @definition.authenticator = klass
+      end
+
+      def endpoint(name, klass = nil, &block)
+        if block_given?
+          id = "#{@definition.id}/#{klass || Helpers.camelize(name) + 'Endpoint'}"
+          klass = Apia::Endpoint.create(id, &block)
+        end
+
+        @definition.endpoints[name.to_sym] = klass
+      end
+
+      def helper(name, &block)
+        @definition.helpers[name] = block
+      end
+
+    end
+  end
+end

data/lib/apia/dsls/endpoint.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require 'apia/dsl'
+require 'apia/dsls/concerns/has_fields'
+require 'apia/pagination_object'
+
+module Apia
+  module DSLs
+    class Endpoint < DSL
+
+      include DSLs::Concerns::HasFields
+
+      def authenticator(klass = nil, &block)
+        if block_given?
+          id = "#{@definition.id}/#{Helpers.camelize(klass) || 'Authenticator'}"
+          klass = Apia::Authenticator.create(id, &block)
+        end
+
+        @definition.authenticator = klass
+      end
+
+      def potential_error(klass, &block)
+        if block_given? && klass.is_a?(String)
+          id = "#{@definition.id}/#{Helpers.camelize(klass)}"
+          klass = Apia::Error.create(id, &block)
+        end
+
+        @definition.potential_errors << klass
+      end
+
+      def argument(*args, **kwargs, &block)
+        @definition.argument_set.argument(*args, **kwargs, &block)
+      end
+
+      def action(&block)
+        @definition.action = block
+      end
+
+      def http_status(status)
+        @definition.http_status = status
+      end
+
+      def field(name, *args, type: nil, **options, &block)
+        if pagination_options = options.delete(:paginate)
+
+          unless @definition.paginated_field.nil?
+            raise Apia::RuntimeError, 'Cannot define more than one paginated field per endpoint'
+          end
+
+          pagination_options = {} if pagination_options == true
+          @definition.paginated_field = name
+
+          argument :page, type: Scalars::Integer, default: 1 do
+            validation(:greater_than_zero) { |o| o.positive? }
+          end
+
+          argument :per_page, type: Scalars::Integer, default: 30 do
+            validation(:greater_than_zero) { |o| o.positive? }
+            validation(:less_than_or_equal_to_100) { |o| o <= (pagination_options[:maximum_per_page]&.to_i || 200) }
+          end
+
+          field :pagination, type: PaginationObject
+        end
+        super(name, *args, type: type, **options, &block)
+      end
+
+      def scopes(*names)
+        names.each { |name| scope(name) }
+      end
+
+      def scope(name)
+        return if @definition.scopes.include?(name.to_s)
+
+        @definition.scopes << name.to_s
+      end
+
+    end
+  end
+end

data/lib/apia/dsls/enum.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'apia/dsl'
+
+module Apia
+  module DSLs
+    class Enum < DSL
+
+      def value(name, description = nil)
+        @definition.values[name.to_s] = { name: name.to_s, description: description }
+      end
+
+      def cast(&block)
+        @definition.cast = block
+      end
+
+    end
+  end
+end

data/lib/apia/dsls/error.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'apia/dsl'
+require 'apia/dsls/concerns/has_fields'
+
+module Apia
+  module DSLs
+    class Error < DSL
+
+      include DSLs::Concerns::HasFields
+
+      def code(code)
+        @definition.code = code
+      end
+
+      def http_status(http_status)
+        @definition.http_status = http_status
+      end
+
+      def catch_exception(klass, &block)
+        @definition.catchable_exceptions[klass] = block
+      end
+
+    end
+  end
+end

data/lib/apia/dsls/field.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'apia/dsl'
+
+module Apia
+  module DSLs
+    class Field < DSL
+
+      def backend(&block)
+        @definition.backend = block
+      end
+
+      def null(value)
+        @definition.null = value
+      end
+
+      def array(value)
+        @definition.array = value
+      end
+
+      def condition(&block)
+        @definition.condition = block
+      end
+
+    end
+  end
+end

data/lib/apia/dsls/lookup_argument_set.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'apia/dsls/argument_set'
+
+module Apia
+  module DSLs
+    class LookupArgumentSet < ArgumentSet
+
+      def potential_error(klass, &block)
+        if block_given? && klass.is_a?(String)
+          id = "#{@definition.id}/#{Helpers.camelize(klass)}"
+          klass = Apia::Error.create(id, &block)
+        end
+
+        @definition.potential_errors << klass
+      end
+
+      def resolver(&block)
+        @definition.resolver = block
+      end
+
+    end
+  end
+end

data/lib/apia/dsls/object.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'apia/dsl'
+require 'apia/definitions/field'
+require 'apia/dsls/concerns/has_fields'
+
+module Apia
+  module DSLs
+    class Object < DSL
+
+      include DSLs::Concerns::HasFields
+
+      def condition(&block)
+        @definition.conditions << block
+      end
+
+    end
+  end
+end