bullet_train-api 1.0.12 → 1.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27ca15eddb9b29b85afaba362068e42a8c7d844226d1aa5b37c37b11ba3f356f
-  data.tar.gz: 6e5ae250fddaa6b461e867e006abf9d30fe9fcde8f846eaf120a12130396edcf
+  metadata.gz: 766d45178150439d1076f0330084c75f25f6349943a6cd90ae55061a9900cd08
+  data.tar.gz: 578914d5271157d1a3709174464e7fcd15441c6391a3fcc5ee9c9dd997decb06
 SHA512:
-  metadata.gz: 1326b4449fb8f96c87377cd5cc5cd35921234e9b7ed28926bd7dd49ca4ea73db401d59fd95c2e847f1c709bbfb606a1a0a01e3f46fd8bb6d983e51d3c6b03237
-  data.tar.gz: 530412b77a184ca0c271e50b2678f4427513f53d3dc2ab45457661586fa7f55846ac1cf0db62391a321aadeef1c393d1b4e48eead90b7aff5211398f29597f7f
+  metadata.gz: 9f56d8880d393c5d9eb568b345328cca556fb5d6592187833395959fbf8b2cfd8a78cb9f9cf6a53b695b1c5491279ba69eb72d168ff7c6611437d4db96e868e5
+  data.tar.gz: 5e199bab324f5f1d6f6d28b0ffee43d5c0f649b46b019257760a5b05a2de0e325d1e8c387385bcb6402e21bb2f50bbdc69a54640ab96d97750fed5b17cef88dd

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2022 Andrew Culver
+Copyright 2022 Bullet Train, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/app/controllers/api/base.rb

@@ -8,19 +8,24 @@ class Api::Base < Grape::API
   format :jsonapi
   default_error_formatter :json
 
-  # TODO Shouldn't this be in V1 or not versioned?
-  include Api::V1::ExceptionsHandler
-
   mount Api::V1::Root
 
-  # Swagger docs are available at `/api/swagger_doc.json`.
+  # Swagger docs are available at `/api/docs/swagger.json`.
   add_swagger_documentation \
-    hide_documentation_path: true,
-    array_use_braces: true,
     api_version: "v1",
+    array_use_braces: true,
+    base_path: "/api",
+    doc_version: "1.0",
+    endpoint_auth_wrapper: ::WineBouncer::OAuth2,
+    hide_documentation_path: true,
     info: {
       title: I18n.t("application.name"),
       description: I18n.t("application.description")
     },
-    endpoint_auth_wrapper: WineBouncer::OAuth2
+    mount_path: "/docs/swagger"
+
+  # TODO Reintroduce this once we've got `context` in current attributes.
+  # before do
+  #   Current.context = :api
+  # end
 end

data/app/controllers/api/model_parser.rb

@@ -0,0 +1,42 @@
+class Api::ModelParser < GrapeSwagger::Jsonapi::Parser
+  attr_reader :model, :endpoint
+
+  alias_method :schema, :call
+
+  def initialize(model, endpoint)
+    @model = model
+    @endpoint = endpoint
+  end
+
+  def call
+    # first let's grab the schema generated by the JSON:API parser
+    schema_json = schema.to_json
+
+    # From Nick Schneble:
+
+    # we can easily override these types for our API endpoints in the documentation
+    # but we can't do the same thing for the relationship objects that are auto-generated
+    # thus the fancy affair below
+
+    # if you want to learn more about what's happening here, read these:
+    # https://stackoverflow.com/a/17918118/1322386
+    # https://swagger.io/docs/specification/data-models/data-types/
+
+    # Swagger 3.0 only supports a subset of Ruby data types
+    schema_json.gsub!("\"type\":\"binary\"", "\"type\":\"string\", \"format\":\"binary\"")
+    schema_json.gsub!("\"type\":\"date\"", "\"type\":\"string\", \"format\":\"date\"")
+    schema_json.gsub!("\"type\":\"datetime\"", "\"type\":\"string\", \"format\":\"date-time\"")
+    schema_json.gsub!("\"type\":\"decimal\"", "\"type\":\"number\", \"format\":\"double\"")
+    schema_json.gsub!("\"type\":\"float\"", "\"type\":\"number\", \"format\":\"float\"")
+    schema_json.gsub!("\"type\":\"bigint\"", "\"type\":\"integer\", \"format\":\"int64\"")
+    schema_json.gsub!("\"type\":\"primary_key\"", "\"type\":\"integer\", \"format\":\"int64\"")
+    schema_json.gsub!("\"type\":\"references\"", "\"type\":\"object\"")
+    schema_json.gsub!("\"type\":\"text\"", "\"type\":\"string\"")
+    schema_json.gsub!("\"type\":\"time\"", "\"type\":\"string\", \"format\":\"time\"")
+    schema_json.gsub!("\"type\":\"timestamp\"", "\"type\":\"string\", \"format\":\"timestamp\"")
+    schema_json.gsub!("\"type\":\"json\"", "\"type\":\"array\", \"items\":{\"type\":\"string\"}")
+
+    # returns a Hash as if nothing fancy happened
+    JSON.parse(schema_json)
+  end
+end

data/app/controllers/concerns/api/v1/base.rb

@@ -4,9 +4,11 @@ module Api::V1::Base
   included do
     include Api::V1::Defaults
     include Api::V1::LoadsAndAuthorizesApiResource
+    include Api::V1::ExceptionsHandler
 
     version "v1"
-    use ::WineBouncer::OAuth2
+
+    use ::WineBouncer::OAuth2, message: "Doorkeeper OAuth2 Authentication"
 
     rescue_from :all do |error|
       handle_api_error(error)
@@ -15,6 +17,11 @@ module Api::V1::Base
     BulletTrain::Api.endpoints.each do |endpoint_class|
       mount endpoint_class.constantize
     end
+
+    after_validation do
+      # Ensure responses never get cached.
+      header "Cache-Control", "no-store"
+    end
   end
 
   class_methods do

data/app/controllers/concerns/api/v1/teams/endpoint_base.rb

@@ -16,7 +16,7 @@ module Api::V1::Teams::EndpointBase
         # `Api::V1::TeamsEndpoint`, but since we can get the latter, we'll use that to fetch whatever proc is defined
         # in ADDITIONAL_PARAMS.
         if defined?(@api.to_s.constantize::PARAMS)
-          instance_eval &@api.to_s.constantize::PARAMS
+          instance_eval(&@api.to_s.constantize::PARAMS)
         end
       end
     end

data/lib/bullet_train/api/version.rb

@@ -1,5 +1,5 @@
 module BulletTrain
   module Api
-    VERSION = "1.0.12"
+    VERSION = "1.0.13"
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: bullet_train-api
 version: !ruby/object:Gem::Version
-  version: 1.0.12
+  version: 1.0.13
 platform: ruby
 authors:
 - Andrew Culver
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-04 00:00:00.000000000 Z
+date: 2022-04-07 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -164,6 +178,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: bullet_train
+  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: Bullet Train API
 email:
 - andrew.culver@gmail.com
@@ -178,6 +206,7 @@ files:
 - app/controllers/account/platform/applications_controller.rb
 - app/controllers/api.rb
 - app/controllers/api/base.rb
+- app/controllers/api/model_parser.rb
 - app/controllers/api/v1.rb
 - app/controllers/api/v1/defaults.rb
 - app/controllers/api/v1/exceptions_handler.rb