graphiti-openapi 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e72f28f72e39813ba6776fa40544279bbf842fed200b5be56678aa40495981d
-  data.tar.gz: ebe5f2fd5206ad29590fec6b6336003e34b3433092a813f47d6caf7cd2c87b4a
+  metadata.gz: 2070008985f65464531c93f438aaa275db413c0d1daf0b933f6b86296063384a
+  data.tar.gz: 115f94a0a40844d56d46737be9e63880c81fe40e4273ec7df0aaeeceb0bbe4c4
 SHA512:
-  metadata.gz: 706bbdd8b08e6983b576d806e0af2dd23058ba1cc0a90a56be5a4591cf6d341e86ebbd06e137e001aa1525e358b4770f78e3c96abf3e212f411127330f5815dc
-  data.tar.gz: 4ba0e5eb35b63240bc917f1cd0984787d20218e47afcf65a5c449943bc40a17dec1aa486969926caf6a1b57515c36f9ea8cfe3c081e97876f916d64a2881948b
+  metadata.gz: 58105cea097503a9ae1ba7669771a21f414c32bebbb0870bd17f824092349c5f88f19018cf0c9d305d8e2e303f2fe9f617e3a81044b59b731e26557b08cf007c
+  data.tar.gz: 0cf2572e4a4ba8e6600beac1271650fcca1897439e1a2e60d2a15161ca27941201c334bb5ecbd0b3a002fe38f73d267e7b596cf59a1a2c7496b564d0e4100399

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

@@ -17,10 +17,6 @@ module Graphiti::OpenAPI
     attribute :schema, Types::Any
     attribute :path, Types::Coercible::String
 
-    def path
-      __attributes__[:path].gsub(/^#{Regexp.escape(ApplicationResource.endpoint_namespace)}/, '')
-    end
-
     def resource_path
       File.join(path.to_s, "{id}")
     end
@@ -63,7 +59,7 @@ module Graphiti::OpenAPI
       actions.select(&:collection?)
     end
 
-    memoize :path, :resource_path, :paths, :parameters, :resource, :resource_actions, :collection_actions
+    memoize :resource_path, :paths, :parameters, :resource, :resource_actions, :collection_actions
   end
 
   class Endpoints < Hash

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

@@ -77,7 +77,7 @@ module Graphiti::OpenAPI
     private
 
     def servers
-      [{url: "#{root_url}#{ApplicationResource.endpoint_namespace}", description: "#{Rails.env} server"}]
+      [{url: root_url, description: "#{Rails.env} server"}]
     end
 
     def root_url
@@ -160,6 +160,7 @@ module Graphiti::OpenAPI
 
       # Use real resources in examples
       defs[:resource] = {
+        type: :object,
         oneOf: resources.values.map { |resource| {'$ref': "#/components/schemas/#{resource.type}_resource"} },
       }
 

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

@@ -174,30 +174,50 @@ module Graphiti::OpenAPI
       {
         "#{type}_single" => {
           type: :object,
-          allOf: [
-            {'$ref': "#/components/schemas/jsonapi_success"},
-            {
-              type: :object,
-              properties: {
-                data: {'$ref': "#/components/schemas/#{type}_resource"},
-              },
+          properties: {
+            data: {'$ref': "#/components/schemas/#{type}_resource"},
+            included: {
+              description: "To reduce the number of HTTP requests, servers **MAY** allow responses that include related resources along with the requested primary resources. Such responses are called \"compound documents\".",
+              type: "array",
+              items: {'$ref': "#/components/schemas/jsonapi_resource"},
+              uniqueItems: true
             },
-          ],
+            meta: {'$ref': "#/components/schemas/jsonapi_meta"},
+            links: {
+              description: "Link members related to the primary data.",
+              allOf: [
+                {"$ref": "#/components/schemas/jsonapi_links"},
+                {"$ref": "#/components/schemas/jsonapi_pagination"},
+              ]
+            },
+            "jsonapi": {"$ref": "#/components/schemas/jsonapi_jsonapi"},
+          },
+          additionalProperties: false
         },
         "#{type}_collection" => {
           type: :object,
-          allOf: [
-            {'$ref': "#/components/schemas/jsonapi_success"},
-            {
-              type: :object,
-              properties: {
-                data: {
-                  type: :array,
-                  items: {"$ref" => "#/components/schemas/#{type}_resource"},
-                },
-              },
+          properties: {
+            data: {
+              type: "array",
+              items: {'$ref': "#/components/schemas/#{type}_resource"},
+            },
+            included: {
+              description: "To reduce the number of HTTP requests, servers **MAY** allow responses that include related resources along with the requested primary resources. Such responses are called \"compound documents\".",
+              type: "array",
+              items: {'$ref': "#/components/schemas/jsonapi_resource"},
+              uniqueItems: true
             },
-          ],
+            meta: {'$ref': "#/components/schemas/jsonapi_meta"},
+            links: {
+              description: "Link members related to the primary data.",
+              allOf: [
+                {"$ref": "#/components/schemas/jsonapi_links"},
+                {"$ref": "#/components/schemas/jsonapi_pagination"},
+              ]
+            },
+            "jsonapi": {"$ref": "#/components/schemas/jsonapi_jsonapi"},
+          },
+          additionalProperties: false
         },
       }
     end
@@ -209,7 +229,7 @@ module Graphiti::OpenAPI
           properties: {
             data: {'$ref': "#/components/schemas/#{type}_resource"},
           },
-        # xml: {name: :data},
+          # xml: {name: :data},
         },
       }
     end
@@ -252,7 +272,7 @@ module Graphiti::OpenAPI
           description: "OK: #{human} resource",
           content: {
             "application/vnd.api+json" => {schema: {"$ref": "#/components/schemas/#{type}_single"}},
-          # "application/xml" => {schema: {"$ref": "#/components/schemas/#{type}_single"}},
+            # "application/xml" => {schema: {"$ref": "#/components/schemas/#{type}_single"}},
           },
           links: link_refs,
         },
@@ -260,14 +280,14 @@ module Graphiti::OpenAPI
           description: "OK: #{plural_human} collection",
           content: {
             "application/vnd.api+json" => {schema: {"$ref": "#/components/schemas/#{type}_collection"}},
-          # "application/xml" => {schema: {"$ref": "#/components/schemas/#{type}_collection"}},
+            # "application/xml" => {schema: {"$ref": "#/components/schemas/#{type}_collection"}},
           },
         },
         "#{type}_201" => {
           description: "Created",
           content: {
             "application/vnd.api+json" => {schema: {"$ref": "#/components/schemas/#{type}_single"}},
-          # "application/xml" => {schema: {"$ref": "#/components/schemas/#{type}_single"}},
+            # "application/xml" => {schema: {"$ref": "#/components/schemas/#{type}_single"}},
           },
           links: link_refs,
         },

data/config/openapi.yml

@@ -9,13 +9,42 @@ info:
     name: Developer Example
     # url: 'https://developer.example.test/'
 security:
-  - bearerAuth: []
+  - Basic: []
+  - BearerJWT: []
+  - OAuth2:
+    - manage
+    - read
+      write
+    - read
+      create
+      update
+      delete
 components:
   securitySchemes:
-    bearerAuth:
+    Basic:
+      type: http
+      scheme: basic
+    BearerJWT:
       type: http
       scheme: bearer
       bearerFormat: JWT
+    OAuth2:
+      type: oauth2
+      description: |
+        [OAuth 2.0 protocol](http://oauth.net/2/)
+        See /oauth/requests
+      flows:
+        password:
+          tokenUrl: /oauth/token
+          scopes:
+            public: Grant read-only access to all public data
+            read: Grant read-only access to all your data
+            write: Grant write-only access to all your data except for the account and user info
+            create: Grant write-only access to create anything
+            update: Grant write-only access to update all your data
+            delete: Grant write-only access to delete any of your data
+            manage: Grant read and write access to all your data
+            profile: Grant read-only access to the account and user info only
   responses:
     '200':
       description: OK
@@ -63,4 +92,169 @@ components:
         application/vnd.api+json:
           schema:
             $ref: '#/components/schemas/jsonapi_failure'
+  schemas:
+    OAuth2Scope:
+      type: string
+      enum: [public, read, write, create, update, delete, manage]
+      default: public
+    OAuth2Scopes:
+      type: array
+      items:
+        $ref: "#/components/schemas/OAuth2Scope"
+      default: [public]
+    OAuth2GrantType:
+      type: string
+      enum: [password, authorization_code]
+    OAuth2TokenRequest:
+      type: object
+      required:
+        - grant_type
+      properties:
+        grant_type:
+          $ref: "#/components/schemas/OAuth2GrantType"
+        scope:
+          $ref: "#/components/schemas/OAuth2Scopes"
+        username:
+          description: (when `grant_type="password"`)
+          type: string
+          format: email
+        password:
+          description: (when `grant_type="password"`)
+          type: string
+          format: password
+        client_id:
+          description: (when `grant_type="authorization_code"`)
+          type: string
+        client_secret:
+          description: (when `grant_type="authorization_code"`)
+          type: string
+        code:
+          description: (when `grant_type="authorization_code"`)
+          type: string
+        redirect_uri:
+          description: (when `grant_type="authorization_code"`)
+          type: string
+          format: uri
+          default: "urn:ietf:wg:oauth:2.0:oob"
+      additionalProperties: false
+    OAuth2Response:
+      type: object
+      properties:
+        access_token:
+          type: string
+          example: "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOjEsImlhdCI6MTU0ODU1OTMwNiwianRpIjoiZTc4MWZlYjUtNWYxNi00YzRlLWFjOWMtOTBlYTA2YWMwZWVjIiwiaW5mIjp7ImVtYWlsIjoiYWxleEBjZXJlYmVsby5zcGFjZSJ9fQ."
+        created_at:
+          type: integer
+          example: 1548559306
+        expires_in:
+          type: integer
+          example: 7200
+        scope:
+          type: string
+          example: "manage"
+        token_type:
+          type: string
+          enum: [Bearer]
+
+  examples:
+    OAuth2AuthorizationCodeRequest:
+      summary: Authorization Code Flow Request Body
+      value:
+        grant_type: authorization_code
+        code: "eyJhbGciOiJIUzUxMiJ9"
+        client_id: "123"
+        client_secret: "very-secret"
+        redirect_uri: "https://example.test/oauth/redirect"
+    OAuth2PasswordRequest:
+      summary: Resource Owner Password Credentials Flow Request Body
+      value:
+        grant_type: password
+        username: user@example.test
+        password: password
+    invalid_request:
+      summary: Missing required parameter
+      value:
+        error: invalid_request
+        error_description: The request is missing a required parameter, includes an unsupported parameter value, or is otherwise malformed.
+    authentication:
+      summary: Invalid credentials
+      value:
+        error: Invalid Email or password.
+
+  requestBodies:
+    OAuth2Request:
+      required: true
+      content:
+        application/x-www-form-urlencoded:
+          schema:
+            $ref: "#/components/schemas/OAuth2TokenRequest"
+          encoding:
+            scope:
+              style: spaceDelimited
+              explode: false
+          examples:
+            OAuth2AuthorizationCodeRequest:
+              $ref: "#/components/examples/OAuth2AuthorizationCodeRequest"
+            OAuth2PasswordRequest:
+              $ref: "#/components/examples/OAuth2PasswordRequest"
+
 paths:
+  /oauth/token:
+    post:
+      operationId: getOAuth2Token
+      tags:
+        - OAuth2.0
+      description: REtrieve OAuth 2.0 AccessToken
+      requestBody:
+        $ref: "#/components/requestBodies/OAuth2Request"
+      responses:
+        '200':
+          description: OAuth 2.0 Access Token
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/OAuth2Response"
+        '401':
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                type: object
+                required:
+                  - error
+                properties:
+                  error:
+                    type: string
+                  error_description:
+                    type: string
+              examples:
+                invalid_request:
+                  $ref: "#/components/examples/invalid_request"
+                authentication:
+                  $ref: "#/components/examples/authentication"
+  # /oauth/revoke:
+  #   post:
+  #     tags:
+  #       - OAuth2.0
+  #     description: |
+  #       [OAuth 2.0 Token Revocation](http://tools.ietf.org/html/rfc7009)
+  #     responses:
+  # /oauth/introspect:
+  #   post:
+  #     tags:
+  #       - OAuth2.0
+  #     description: |
+  #       [OAuth 2.0 Token Introspection](http://tools.ietf.org/html/rfc7662)
+  #     parameters:
+  #       - name: token
+  #         in: body
+  #         required: true
+  #         schema:
+  #           type: string
+  #       - name: token_type_hint
+  #         in: body
+  #     responses:
+tags:
+  - name: OAuth2.0
+    description: |
+      [OAuth 2.0 protocol](http://oauth.net/2/)

data/config/routes.rb

@@ -1,6 +1,6 @@
 Graphiti::OpenAPI::Engine.routes.draw do
   resources :specifications, only: :index, defaults: {format: :html}
 
-  get "openapi.:format" => "specifications#index", defaults: {format: :json}
+  get "openapi.:format" => "specifications#index", defaults: {format: :json}, as: :openapi
   root to: "specifications#index", defaults: {format: :html}
 end

data/graphiti-openapi.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "activemodel"
   spec.add_runtime_dependency "responders"
   spec.add_runtime_dependency "kaminari"
-  spec.add_runtime_dependency "graphiti", "~> 1.0.beta.8"
+  spec.add_runtime_dependency "graphiti", "~> 1.0.rc.7"
   spec.add_runtime_dependency "dry-struct", "~> 0.6.0"
   spec.add_runtime_dependency "transproc"
   spec.add_runtime_dependency "webpacker"

data/lib/graphiti/open_api/version.rb

@@ -1,5 +1,5 @@
 module Graphiti
   module OpenAPI
-    VERSION = "0.1.5"
+    VERSION = "0.1.6"
   end
 end

data/lib/tasks/graphiti_openapi.rake

@@ -14,6 +14,7 @@ namespace :graphiti do
       system "#{RbConfig.ruby} ./bin/rails app:template LOCATION=#{installer_template}"
     end
 
+    desc "Generate OpenAPI files in public/"
     task generate: %W[environment #{jsonapi_schema}] do
       generator = Graphiti::OpenAPI::Generator.new
       api = Rails.root.join("public#{ApplicationResource.endpoint_namespace}")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphiti-openapi
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Alex Semyonov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-25 00:00:00.000000000 Z
+date: 2019-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.beta.8
+        version: 1.0.rc.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.beta.8
+        version: 1.0.rc.7
 - !ruby/object:Gem::Dependency
   name: dry-struct
   requirement: !ruby/object:Gem::Requirement