graphiti-openapi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cc40de5f023004fe21eb92c3383093e90399e5eb1e92d67a59649f95e6a67863
+  data.tar.gz: 132360a5661e4d95c240f2959458ebe35e624f63bd2f7789d2875587f2849cd8
+SHA512:
+  metadata.gz: 31932fcb30dc90a2d9213f5fd7b3fa3a11bdf638daab93043325bcf8b134fb9ab7a791ddbedfeb92dd74e1f188beaf012034db60bf41c2ed84739af72465f45a
+  data.tar.gz: 99020af2ba89588ddabccaefdc02762d86253260ab710f3d4b908eb2486ee8e040ee2b2c2c98ff731e7724b2a4584bba78f5d291baf569d93d7a41873a79f8c3

data/.editorconfig

@@ -0,0 +1,10 @@
+[*]
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+
+[*.{diff,md}]
+trim_trailing_whitespace = false

data/.gitignore

@@ -0,0 +1,20 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/log/*.log
+/spec/dummy/log/*.log
+/spec/dummy/node_modules/
+/spec/dummy/yarn-error.log
+/spec/dummy/tmp/
+/spec/dummy/public/packs/
+/spec/dummy/public/packs-test/
+
+# rspec failure tracking
+/spec/examples.txt
+Gemfile.lock
+.ruby-version

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.0
+before_install: gem install bundler -v 2.0.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at alex@semyonov.us. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,16 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in graphiti-openapi.gemspec
+gemspec
+
+gem "webpacker"
+gem "responders"
+gem "kaminari"
+gem "graphiti"
+
+group :development, :test do
+  gem "rspec-rails"
+  gem "rspec-its"
+  gem "factory_bot_rails"
+  gem "database_cleaner"
+end

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Alex Semyonov
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+# Graphiti::OpenAPI
+
+OpenAPI 3.0 specification for your ([Graphiti](https://github.com/graphiti-api/graphiti)) JSON:API
+
+## Installation
+
+Add this line to your Rails application's Gemfile:
+
+```ruby
+gem 'graphiti-openapi'
+```
+
+And then execute:
+
+```bash
+bundle
+```
+
+Set up environment running
+
+```bash
+bin/rails graphiti:openapi:install
+```
+
+Configure OpenAPI template in `config/openapi.yml` and Graphiti::OpenAPI will pick your resources schema and
+translate it to OpenAPI 3.0 JSON and YAML files, providing Swagger UI with live API documentation.
+
+## Usage
+
+Edit template in `config/openapi.yml` to customize your OpenAPI output. This file will be used as base for resulting
+document.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/alsemyonov/graphiti-openapi. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Code of Conduct
+
+Everyone interacting in the Graphiti::OpenAPI project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/alsemyonov/graphiti-openapi/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,20 @@
+require "bundler/setup"
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require 'rdoc/task'
+
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+task environment: "app:yarn:install"
+load 'rails/tasks/statistics.rake'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Graphiti::OpenAPI'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/app/assets/packs/api.js

@@ -0,0 +1,27 @@
+/* eslint no-console:0 */
+// This file is automatically compiled by Webpack, along with any other files
+// present in this directory. You're encouraged to place your actual application logic in
+// a relevant structure within app/javascript and only use these pack files to reference
+// that code so it'll be compiled.
+//
+// To reference this file, add <%= javascript_pack_tag 'api' %> to the appropriate
+// layout file, like app/views/layouts/application.html.erb
+
+import SwaggerUI, { plugins, presets } from "swagger-ui"
+import "swagger-ui/dist/swagger-ui.css"
+
+window.addEventListener("load", function () {
+  SwaggerUI({
+    url: `/api/v1/openapi.json`,
+    dom_id: "#GraphitiOpenAPI",
+    presets: [
+      presets.apis,
+      SwaggerUI.SwaggerUIStandalonePreset
+    ],
+    plugins: [
+      plugins.SpecIndex,
+      plugins.LayoutIndex
+    ],
+    deepLinking: true,
+  });
+});

data/app/controllers/graphiti/open_api/application_controller.rb

@@ -0,0 +1,7 @@
+module Graphiti
+  module OpenAPI
+    class ApplicationController < ::ApplicationController
+      # protect_from_forgery with: :exception
+    end
+  end
+end

data/app/controllers/graphiti/open_api/specifications_controller.rb

@@ -0,0 +1,21 @@
+require_dependency "graphiti/open_api/application_controller"
+
+module Graphiti::OpenAPI
+  class SpecificationsController < ApplicationController
+    def index
+      respond_to do |format|
+        format.html
+        format.json { render json: generator.to_openapi }
+        format.yaml { render text: generator.to_openapi(format: :yaml) }
+      end
+    end
+
+    private
+
+    def generator
+      @generator ||= Generator.new
+    end
+
+    helper_method :generator
+  end
+end

data/app/helpers/graphiti/open_api/application_helper.rb

@@ -0,0 +1,6 @@
+module Graphiti
+  module OpenAPI
+    module ApplicationHelper
+    end
+  end
+end

data/app/models/graphiti/open_api/action.rb

@@ -0,0 +1,130 @@
+require "graphiti/open_api"
+require_relative "struct"
+require_relative "parameters"
+
+module Graphiti::OpenAPI
+  class ActionData < Struct
+    attribute :resource, Types::String
+  end
+
+  class Action < ActionData
+    include Parameters
+
+    METHODS_MAP = Hash.new do |hash, key|
+      hash[key] = key
+    end.merge(
+      index: :get,
+      show: :get,
+      create: :post,
+      update: :put,
+      destroy: :delete,
+    )
+
+    SUMMARIES_MAP = Hash.new do |hash, key|
+      hash[key] = "#{key.capitalize} resource"
+    end.merge(
+      index: "List resources",
+      show: "Fetch resource",
+      create: "Create resource",
+      update: "Update resource",
+      destroy: "Destroy resource",
+    )
+
+    OPERATIONS_MAP = Hash.new do |hash, key|
+      hash[key] = key
+    end.merge(
+      index: :list,
+      show: :get,
+      destroy: :delete,
+    )
+
+    attribute :endpoint, Types::Any
+    attribute :action, Types::Symbol
+
+    def_instance_delegators :endpoint, :schema
+
+    def resource
+      schema.resources[attributes[:resource]]
+    end
+
+    def_instance_delegators :resource, :type, :model_name
+
+    def collection?
+      %i[index create].include?(action)
+    end
+
+    def resource?
+      !collection?
+    end
+
+    def read?
+      %i[index show].include?(action)
+    end
+
+    def modify?
+      %i[create update].include?(action)
+    end
+
+    def method
+      METHODS_MAP[action]
+    end
+
+    def summary
+      SUMMARIES_MAP[action].gsub(/\bresources\b/, type.humanize).gsub(/\bresource\b/, type.singularize.humanize)
+    end
+
+    def operation_id
+      "#{OPERATIONS_MAP[action]}_#{action == :index ? model_name.plural : model_name.singular}".camelize(:lower)
+    end
+
+    def operation
+      {method => operation_description}
+    end
+
+    def operation_description
+      {
+        operationId: operation_id,
+        summary: summary,
+        tags: tags,
+        responses: responses,
+      }.tap do |desc|
+        desc[:requestBody] = {'$ref': "#/components/requestBodies/#{resource.type}"} if modify?
+      end
+    end
+
+    def delete?
+      action == :destroy
+    end
+
+    memoize :collection?, :method, :resource, :operation
+
+    private
+
+    def tags
+      [type]
+    end
+
+    def responses
+      {}.tap do |result|
+        result[200] = {'$ref': "#/components/responses/#{resource.type}_200#{"_collection" if collection?}"} if %i[index show update].include?(action)
+        result[200] = {'$ref': "#/components/responses/200"} if delete?
+        result[201] = {'$ref': "#/components/responses/#{resource.type}_201"} if action == :create
+        result[202] = {'$ref': "#/components/responses/202"} if modify? || delete?
+        result[204] = {'$ref': "#/components/responses/204"} if modify? || delete?
+        result[401] = {"$ref": "#/components/responses/401"} # if authentication?
+        result[403] = {"$ref": "#/components/responses/403"} # if authorization?
+        result[404] = {"$ref": "#/components/responses/404"} unless collection?
+        result[403] = {"$ref": "#/components/responses/409"} if modify?
+        result[422] = {"$ref": "#/components/responses/422"} if modify?
+      end
+    end
+  end
+
+  class Actions < Hash
+    def self.load(endpoint, data: endpoint.__attributes__[:actions])
+      data.map do |action, data|
+        Action.new(data.to_hash.merge(endpoint: endpoint, action: action))
+      end
+    end
+  end
+end

data/app/models/graphiti/open_api/attribute.rb

@@ -0,0 +1,40 @@
+require "graphiti/open_api"
+require_relative "struct"
+
+module Graphiti::OpenAPI
+  class AttributeData < Struct
+    attribute :type, Types::String
+    attribute :readable, Types::Bool
+    attribute :writable, Types::Bool
+    attribute :description, Types::String.optional
+  end
+
+  class Attribute < AttributeData
+    attribute :name, Types::Symbol
+    attribute :resource, Types::Any
+
+    def_instance_delegators :resource, :schema
+
+    def type
+      schema.types[__attributes__[:type].to_sym]
+    end
+
+    def to_property
+      return {} unless readable || writable
+
+      definition = type.to_schema
+      definition[:description] = description if description
+      definition[:readOnly] = readable unless writable
+      definition[:writeOnly] = writable unless readable
+      {name => definition}
+    end
+  end
+
+  class Attributes < Hash
+    def self.load(resource, data = resource.__attributes__[:attributes])
+      data.each_with_object(new) do |(name, data), result|
+        result[name] = Attribute.new(data.to_hash.merge(name: name, resource: resource))
+      end
+    end
+  end
+end