bullet_train-api 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1a328cffebe8bbf05bf9d14df56afe1142c64cae544f63cc2a306fa1b999cd8
-  data.tar.gz: 6e0d56ea3c25db247665f92b2c443ab027ad2a14540307ae0e938b4a9ad890cd
+  metadata.gz: 9e0f1c01d87b93a40a16d82907bf84068a03842fb085b4a95b984d70512f0bde
+  data.tar.gz: 60a82c00ed0fed7accc7de60fe4e294fb09ac2cdd644f4257e3013a8086d13cd
 SHA512:
-  metadata.gz: 417fb8b614b5a43313c63f1c12572a5ce26eb604412d04deccade31ba27b22974dd32c08791cb1aba0b5397ddba59d94874a131af11e77ea61080875dc85442c
-  data.tar.gz: dc17c6b4d31ef02c167da2f69262794960e7cd4e1d8bc96142109262c9326a73f7e0cb77998a6854df0eb0cb2c87f1119f4a6ba257c9675beed3a2b487997ca7
+  metadata.gz: abed93cb81502188395b8571f50c3f0e60b7704ed2b83d958006d0bd152cd24023b8563601be5506e47ab6278abf7154d5f27d2f545faaa6f1012399b3f22b87
+  data.tar.gz: 52962a262499e9ea63ba67ce6bd83853375d82bb1caabdbb128a7b4cb07998597ae3dd0d662a46f1781005177bc41c837f03499c2dfdfbc324a1dd4363219a99

data/app/controllers/api/base.rb

@@ -0,0 +1,26 @@
+require "grape-swagger"
+require_relative "../api"
+
+class Api::Base < Grape::API
+  content_type :jsonapi, "application/vnd.api+json"
+  formatter :json, Grape::Formatter::Jsonapi
+  formatter :jsonapi, Grape::Formatter::Jsonapi
+  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`.
+  add_swagger_documentation \
+    hide_documentation_path: true,
+    array_use_braces: true,
+    api_version: "v1",
+    info: {
+      title: I18n.t("application.name"),
+      description: I18n.t("application.description")
+    },
+    endpoint_auth_wrapper: WineBouncer::OAuth2
+end

data/app/controllers/api.rb

@@ -0,0 +1,93 @@
+# We have to do this because there are a couple of different Grape contexts where you're trying to define something
+# for a model's API representation, but the execution context doesn't have access to the endpoint object you're
+# defining things for. I understand the design thinking that caused that situation, but unfortunately for us we just
+# have to brute force our way around it for now. In doing so, we're implementing something not unlike the magic of the
+# `t` helper in Rails views.
+
+module Api
+  def self.topic
+    path = caller.find { |path| path.include?("controllers/api") && !path.include?("app/controllers/api.rb") }
+    path.gsub!(/^#{Rails.root}\/app\/controllers\/api\/v\d+\//, "")
+    path.split("_endpoint.").first
+  end
+
+  def self.serializer
+    # TODO This could be smart enough to figure out if `V1` is accurate, as well.
+    "Api::V1::#{Api.topic.classify}Serializer"
+  end
+
+  def self.status(code)
+    I18n.t("api.statuses.#{code}")
+  end
+
+  def self.title(path)
+    I18n.t("#{topic}.api.#{path}")
+  end
+
+  def self.heading(path)
+    I18n.t("#{topic}.api.fields.#{path}.heading")
+  end
+
+  def self.show_desc
+    proc do
+      success code: 200, model: Api.serializer, message: Api.status(200)
+      failure [
+        {code: 401, message: Api.status(401)}, # unauthorized
+        {code: 403, message: Api.status(403)}, # forbidden
+        {code: 404, message: Api.status(404)}, # not found
+        {code: 429, message: Api.status(429)} # too many requests
+      ]
+      produces ["application/vnd.api+json"]
+    end
+  end
+
+  def self.index_desc
+    proc do
+      success code: 200, model: Api.serializer, message: Api.status(200)
+      failure [
+        {code: 401, message: Api.status(401)}, # unauthorized
+        {code: 429, message: Api.status(429)} # too many requests
+      ]
+      produces ["application/vnd.api+json"]
+      is_array true
+    end
+  end
+
+  def self.create_desc
+    proc do
+      success code: 201, model: Api.serializer, message: Api.status(201)
+      failure [
+        {code: 400, message: Api.status(400)}, # bad request
+        {code: 401, message: Api.status(401)}, # unauthorized
+        {code: 403, message: Api.status(403)}, # forbidden
+        {code: 406, message: Api.status(406)}, # not acceptable
+        {code: 422, message: Api.status(422)}, # unprocessable entity
+        {code: 429, message: Api.status(429)} # too many requests
+      ]
+      consumes ["application/json", "multipart/form-data"]
+      produces ["application/vnd.api+json"]
+    end
+  end
+
+  def self.update_desc
+    proc do
+      success code: 200, model: Api.serializer, message: Api.status(200)
+      failure [
+        {code: 400, message: Api.status(400)}, # bad request
+        {code: 401, message: Api.status(401)}, # unauthorized
+        {code: 403, message: Api.status(403)}, # forbidden
+        {code: 404, message: Api.status(404)}, # not found
+        {code: 406, message: Api.status(406)}, # not acceptable
+        {code: 422, message: Api.status(422)}, # unprocessable entity
+        {code: 429, message: Api.status(429)} # too many requests
+      ]
+      consumes ["application/json", "multipart/form-data"]
+      produces ["application/vnd.api+json"]
+    end
+  end
+
+  def self.destroy_desc
+    # TODO We don't have anything for this, but we want to make sure it's easy to roll out updates going forward.
+    proc {}
+  end
+end

data/lib/bullet_train/api/version.rb

@@ -1,5 +1,5 @@
 module BulletTrain
   module Api
-    VERSION = "1.0.0"
+    VERSION = "1.0.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bullet_train-api
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Andrew Culver
@@ -36,6 +36,8 @@ files:
 - Rakefile
 - app/assets/config/bullet_train_api_manifest.js
 - app/controllers/account/platform/applications_controller.rb
+- app/controllers/api.rb
+- app/controllers/api/base.rb
 - app/controllers/api/v1.rb
 - app/controllers/api/v1/defaults.rb
 - app/controllers/api/v1/exceptions_handler.rb