apia-schema-parser 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b3e42e725c2a89060d290b451c8adff18274bc63b74a7b0f5ee3bff57d8556e3
+  data.tar.gz: a90d656b05c35bb6a9490b114110c072bc4f5d68e2475f62b09dff5a45f42ff7
+SHA512:
+  metadata.gz: ab8988054e80cf46b1b246d8f1e26848195720690b9d6b9c6e605cb66a3a94b8fa7fe9e4068ee8d9cded5e0f20a60adee37d0b0ee439b4b498a3e5cbc0004f91
+  data.tar.gz: a23a1fac9bb197e25945ed6c7a4931e689a529cc2b7fbdb89df66158edc186d232bf18336c7a8ea163844f7eb3bb84a413dbaa5eec4db592d35e081a485c48b0

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/apia_schema-parser.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'apia_schema_parser'

data/lib/apia_schema_parser.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'apia_schema_parser/schema'
+
+module ApiaSchemaParser
+
+  def self.load_from_file(path)
+    contents = File.read(path)
+    json = JSON.parse(contents)
+    Schema.new(json)
+  end
+
+end

data/lib/apia_schema_parser/api.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'apia_schema_parser/simple_object'
+require 'apia_schema_parser/authenticator'
+require 'apia_schema_parser/controller'
+require 'apia_schema_parser/route_set'
+require 'apia_schema_parser/scope'
+
+module ApiaSchemaParser
+  class API < SimpleObject
+
+    def authenticator
+      @authenticator ||= schema.objects[@raw['authenticator']]
+    end
+
+    def route_set
+      @route_set ||= RouteSet.new(schema, @raw['route_set'])
+    end
+
+    def scopes
+      @scopes ||= @raw['scopes'].map { |s| Scope.new(s) }.sort_by { |s| s.name.upcase }
+    end
+
+  end
+end

data/lib/apia_schema_parser/argument.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'apia_schema_parser/simple_object'
+
+module ApiaSchemaParser
+  class Argument
+
+    def initialize(set, raw)
+      @set = set
+      @schema = set.schema
+      @raw = raw
+    end
+
+    def name
+      @raw['name']
+    end
+
+    def description
+      @raw['description']
+    end
+
+    def type
+      return nil if @raw['type'].nil?
+
+      @schema.objects[@raw['type']]
+    end
+
+    def required?
+      @raw['required'] == true
+    end
+
+    def array?
+      @raw['array'] == true
+    end
+
+    def default
+      @raw['default']
+    end
+
+  end
+end

data/lib/apia_schema_parser/argument_set.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'apia_schema_parser/simple_object'
+require 'apia_schema_parser/argument'
+
+module ApiaSchemaParser
+  class ArgumentSet < SimpleObject
+
+    def arguments
+      @arguments ||= @raw['arguments'].each_with_object({}) do |a, hash|
+        arg = Argument.new(self, a)
+        hash[arg.name] = arg
+      end
+    end
+
+    def all_potential_errors
+      errors = respond_to?(:potential_errors) ? potential_errors : []
+      arguments.values.each do |arg|
+        next unless arg.type.is_a?(ArgumentSet)
+
+        errors |= arg.type.all_potential_errors
+      end
+      errors
+    end
+
+  end
+end

data/lib/apia_schema_parser/authenticator.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'apia_schema_parser/simple_object'
+require 'apia_schema_parser/has_potential_errors'
+
+module ApiaSchemaParser
+  class Authenticator < SimpleObject
+
+    include HasPotentialErrors
+
+    def type
+      @raw['type']
+    end
+
+  end
+end

data/lib/apia_schema_parser/controller.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'apia_schema_parser/simple_object'
+
+module ApiaSchemaParser
+  class Controller < SimpleObject
+
+    def authenticator
+      return nil if @raw['authenticator'].nil?
+
+      @authenticator ||= schema.objects[@raw['authenticator']]
+    end
+
+    def endpoints
+      @endpoints ||= @raw['endpoints'].each_with_object({}) do |endpoint, hash|
+        hash[endpoint['name']] = schema.objects[endpoint['endpoint']]
+      end
+    end
+
+  end
+end

data/lib/apia_schema_parser/endpoint.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'apia_schema_parser/simple_object'
+require 'apia_schema_parser/has_fields'
+require 'apia_schema_parser/has_potential_errors'
+require 'apia_schema_parser/argument_set'
+
+module ApiaSchemaParser
+  class Endpoint < SimpleObject
+
+    include HasFields
+    include HasPotentialErrors
+
+    def authenticator
+      return nil if @raw['authenticator'].nil?
+
+      @authenticator ||= schema.objects[@raw['authenticator']]
+    end
+
+    def routes
+      schema.api.route_set.routes_by_endpoint[id]
+    end
+
+    def argument_set
+      @argument_set ||= ArgumentSet.new(schema, @raw['argument_set'])
+    end
+
+    def http_status
+      @raw['http_status']
+    end
+
+    def http_method
+      @raw['http_method']
+    end
+
+    def scopes
+      @raw['scopes']
+    end
+
+    def all_potential_errors
+      (potential_errors + argument_set.all_potential_errors).uniq
+    end
+
+  end
+end

data/lib/apia_schema_parser/enum.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'apia_schema_parser/simple_object'
+require 'apia_schema_parser/enum_value'
+
+module ApiaSchemaParser
+  class Enum < SimpleObject
+
+    def values
+      @values ||= @raw['values'].map { |e| EnumValue.new(e) }
+    end
+
+  end
+end

data/lib/apia_schema_parser/enum_value.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module ApiaSchemaParser
+  class EnumValue
+
+    def initialize(raw)
+      @raw = raw
+    end
+
+    def name
+      @raw['name']
+    end
+
+    def description
+      @raw['description']
+    end
+
+  end
+end

data/lib/apia_schema_parser/error.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'apia_schema_parser/simple_object'
+require 'apia_schema_parser/has_fields'
+
+module ApiaSchemaParser
+  class Error < SimpleObject
+
+    include HasFields
+
+    def code
+      @raw['code']
+    end
+
+    def http_status
+      @raw['http_status']
+    end
+
+  end
+end

data/lib/apia_schema_parser/field.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'apia/field_spec'
+require 'apia_schema_parser/simple_object'
+
+module ApiaSchemaParser
+  class Field < SimpleObject
+
+    def type
+      schema.objects[@raw['type']]
+    end
+
+    def null?
+      @raw['null'] == true
+    end
+
+    def array?
+      @raw['array'] == true
+    end
+
+    def spec
+      return :all if @raw['spec']['all'] == true
+      return Apia::FieldSpec.parse(@raw['spec']['spec']) if @raw['spec']['spec']
+
+      nil
+    end
+
+  end
+end

data/lib/apia_schema_parser/has_fields.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'apia_schema_parser/field'
+
+module ApiaSchemaParser
+  module HasFields
+
+    def fields
+      @fields ||= @raw['fields'].map { |field| Field.new(schema, field) }
+    end
+
+  end
+end

data/lib/apia_schema_parser/has_potential_errors.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'apia_schema_parser/error'
+
+module ApiaSchemaParser
+  module HasPotentialErrors
+
+    def potential_errors
+      @potential_errors ||= @raw['potential_errors'].map { |id| schema.objects[id] }
+    end
+
+  end
+end

data/lib/apia_schema_parser/lookup_argument_set.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'apia_schema_parser/argument_set'
+require 'apia_schema_parser/has_potential_errors'
+
+module ApiaSchemaParser
+  class LookupArgumentSet < ArgumentSet
+
+    include HasPotentialErrors
+
+  end
+end

data/lib/apia_schema_parser/object.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'apia_schema_parser/simple_object'
+require 'apia_schema_parser/has_fields'
+
+module ApiaSchemaParser
+  class Object < SimpleObject
+
+    include HasFields
+
+  end
+end

data/lib/apia_schema_parser/polymorph.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'apia_schema_parser/simple_object'
+require 'apia_schema_parser/polymorph_option'
+
+module ApiaSchemaParser
+  class Polymorph < SimpleObject
+
+    def options
+      @options ||= @raw['options'].map { |o| PolymorphOption.new(schema, o) }
+    end
+
+  end
+end

data/lib/apia_schema_parser/polymorph_option.rb

@@ -0,0 +1,18 @@
+module ApiaSchemaParser
+  class PolymorphOption
+
+    def initialize(schema, raw)
+      @schema = schema
+      @raw = raw
+    end
+
+    def name
+      @raw['name']
+    end
+
+    def type
+      @schema.objects[@raw['type']]
+    end
+
+  end
+end

data/lib/apia_schema_parser/route.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module ApiaSchemaParser
+  class Route
+
+    def initialize(set, raw)
+      @route_set = set
+      @raw = raw
+    end
+
+    def url
+      "#{@route_set.schema.url}/#{path}"
+    end
+
+    def path
+      @raw['path']
+    end
+
+    def request_method
+      @raw['request_method']
+    end
+
+    def group
+      return nil if @raw['group'].nil?
+
+      parts = @raw['group'].split('.')
+      source = @route_set.groups
+      parts.size.times do |i|
+        part = parts[0, i + 1].join('.')
+
+        source = source[part]
+        return nil if source.nil?
+        return source if i == parts.size - 1
+
+        source = source.groups
+      end
+      nil
+    end
+
+    def controller
+      return if @raw['controller'].nil?
+
+      @route_set.schema.objects[@raw['controller']]
+    end
+
+    def endpoint
+      return if @raw['endpoint'].nil?
+
+      @route_set.schema.objects[@raw['endpoint']]
+    end
+
+  end
+end

data/lib/apia_schema_parser/route_group.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module ApiaSchemaParser
+  class RouteGroup
+
+    def initialize(set, raw)
+      @route_set = set
+      @raw = raw
+    end
+
+    def id
+      @raw['id']
+    end
+
+    def name
+      @raw['name']
+    end
+
+    def description
+      @raw['description']
+    end
+
+    def routes
+      @route_set.routes_by_group[id]
+    end
+
+    def group_path
+      @group_path ||= begin
+        parts = @raw['id'].split('.')
+        last_group = @route_set
+        groups = []
+        parts.size.times do |i|
+          inner_parts = parts[0, i + 1]
+          id = inner_parts.join('.')
+          group = last_group.groups[id]
+          groups << group
+          last_group = group
+        end
+        groups
+      end
+    end
+
+    def group
+      return @group if instance_variable_defined?('@group')
+
+      @group = group_path[group_path.size - 2]
+    end
+
+    def groups
+      @groups ||= @raw['groups'].each_with_object({}) do |group_hash, hash|
+        group = RouteGroup.new(@route_set, group_hash)
+        hash[group.id] = group
+      end
+    end
+
+  end
+end

data/lib/apia_schema_parser/route_set.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'apia_schema_parser/route_set'
+require 'apia_schema_parser/route_group'
+require 'apia_schema_parser/route'
+
+module ApiaSchemaParser
+  class RouteSet < SimpleObject
+
+    def routes
+      @routes ||= @raw['routes'].map do |route_hash|
+        next if route_hash['controller'] =~ /\AApia\//
+
+        Route.new(self, route_hash)
+      end.compact
+    end
+
+    def routes_by_group
+      @routes_by_group ||= routes.each_with_object({}) do |route, hash|
+        hash[route.group&.id] ||= []
+        hash[route.group&.id] << route
+      end
+    end
+
+    def routes_by_endpoint
+      @routes_by_endpoint ||= routes.each_with_object({}) do |route, hash|
+        hash[route.endpoint&.id] ||= []
+        hash[route.endpoint&.id] << route
+      end
+    end
+
+    def groups
+      @groups ||= @raw['groups'].each_with_object({}) do |group_hash, hash|
+        group = RouteGroup.new(self, group_hash)
+        hash[group.id] = group
+      end
+    end
+
+  end
+end

data/lib/apia_schema_parser/scalar.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'apia_schema_parser/simple_object'
+
+module ApiaSchemaParser
+  class Scalar < SimpleObject
+
+  end
+end

data/lib/apia_schema_parser/schema.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'apia_schema_parser/api'
+require 'apia_schema_parser/controller'
+require 'apia_schema_parser/endpoint'
+require 'apia_schema_parser/argument_set'
+require 'apia_schema_parser/authenticator'
+require 'apia_schema_parser/error'
+require 'apia_schema_parser/object'
+require 'apia_schema_parser/enum'
+require 'apia_schema_parser/scalar'
+require 'apia_schema_parser/polymorph'
+require 'apia_schema_parser/lookup_argument_set'
+
+module ApiaSchemaParser
+  class Schema
+
+    OBJECT_MAP = {
+      'api' => API,
+      'authenticator' => Authenticator,
+      'controller' => Controller,
+      'argument_set' => ArgumentSet,
+      'endpoint' => Endpoint,
+      'error' => Error,
+      'object' => Object,
+      'enum' => Enum,
+      'scalar' => Scalar,
+      'polymorph' => Polymorph,
+      'lookup_argument_set' => LookupArgumentSet
+    }.freeze
+
+    def initialize(raw)
+      @raw = raw
+    end
+
+    def inspect
+      "#<ApiaSchemaParser::Schema[#{@raw['api']}] #{@raw['objects'].size} objects>"
+    end
+
+    def host
+      @raw['host']
+    end
+
+    def namespace
+      @raw['namespace']
+    end
+
+    def url
+      "https://#{host}#{namespace}"
+    end
+
+    def api
+      objects[@raw['api']]
+    end
+
+    def objects
+      @raw['objects'].each_with_object({}) do |object, hash|
+        klass = OBJECT_MAP[object['type']]
+        next if klass.nil?
+
+        hash[object['value']['id']] = klass.new(self, object['value'])
+      end
+    end
+
+  end
+end

data/lib/apia_schema_parser/scope.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module ApiaSchemaParser
+  class Scope
+
+    def initialize(raw)
+      @raw = raw
+    end
+
+    def name
+      @raw['name']
+    end
+
+    def description
+      @raw['description']
+    end
+
+  end
+end

data/lib/apia_schema_parser/simple_object.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module ApiaSchemaParser
+  class SimpleObject
+
+    attr_reader :schema
+
+    def initialize(schema, raw)
+      @schema = schema
+      @raw = raw
+    end
+
+    def id
+      @raw['id']
+    end
+
+    def name
+      @raw['name'] || id.split('/').last
+    end
+
+    def description
+      @raw['description']
+    end
+
+  end
+end

data/lib/apia_schema_parser/version.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module ApiaSchemaParser
+
+  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,103 @@
+--- !ruby/object:Gem::Specification
+name: apia-schema-parser
+version: !ruby/object:Gem::Version
+  version: 1.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: apia
+  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: 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'
+description: A little library for reading Apia Schema files.
+email:
+- adam@k.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- VERSION
+- lib/apia_schema-parser.rb
+- lib/apia_schema_parser.rb
+- lib/apia_schema_parser/api.rb
+- lib/apia_schema_parser/argument.rb
+- lib/apia_schema_parser/argument_set.rb
+- lib/apia_schema_parser/authenticator.rb
+- lib/apia_schema_parser/controller.rb
+- lib/apia_schema_parser/endpoint.rb
+- lib/apia_schema_parser/enum.rb
+- lib/apia_schema_parser/enum_value.rb
+- lib/apia_schema_parser/error.rb
+- lib/apia_schema_parser/field.rb
+- lib/apia_schema_parser/has_fields.rb
+- lib/apia_schema_parser/has_potential_errors.rb
+- lib/apia_schema_parser/lookup_argument_set.rb
+- lib/apia_schema_parser/object.rb
+- lib/apia_schema_parser/polymorph.rb
+- lib/apia_schema_parser/polymorph_option.rb
+- lib/apia_schema_parser/route.rb
+- lib/apia_schema_parser/route_group.rb
+- lib/apia_schema_parser/route_set.rb
+- lib/apia_schema_parser/scalar.rb
+- lib/apia_schema_parser/schema.rb
+- lib/apia_schema_parser/scope.rb
+- lib/apia_schema_parser/simple_object.rb
+- lib/apia_schema_parser/version.rb
+homepage: https://github.com/krystal/apia-schema-parser
+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 tools for reading Apia schema definitions.
+test_files: []