GraphQL - Embeds

app/graphql/concerns/optional_embed_description.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module OptionalEmbedDescription
+  extend ActiveSupport::Concern
+
+  AUDIO_DESCRIPTION = 'A URL to an audio file to accompany this object.'
+  DESCRIPTION = 'A one to two sentence description of your object.'
+  DETERMINER_DESCRIPTION = %q[
+    The word that appears before this object's title in a sentence.
+    An enum of (a, an, the, "", auto). If auto is chosen,
+    the consumer of your data should chose between "a" or "an". Default is "" (blank).
+  ]
+  LOCALE_DESCRIPTION = %[
+    The locale these tags are marked up in.
+    Of the format language_TERRITORY. Default is en_US.
+  ]
+  LOCALE_ALTERNATIVE_DESCRIPTION = 'An array of other locales this page is available in.'
+  SITE_NAME_DESCRIPTION = %[
+    If your object is part of a larger web site,
+    the name which should be displayed for the overall site.
+  ]
+  VIDEO_DESCRIPTION = 'A URL to a video file that complements this object.'
+end

app/graphql/types/embed/website_embed.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+class Types::Embed::WebsiteEmbed < Types::BaseObject
+  include OptionalEmbedDescription
+  implements Types::Interface::RequiredEmbed
+
+  field :site_name, String,
+    description: SITE_NAME_DESCRIPTION,
+    null: false
+end

app/graphql/types/interface/required_embed.rb

@@ -0,0 +1,28 @@
+module Types::Interface::RequiredEmbed
+  include Types::Interface::Base
+  description 'Required fields for an Embed based off the Open Graph protocol'
+
+  field :title, String,
+  null: true,
+  description: ''
+
+  field :kind, String,
+    null: false,
+    description: ''
+
+  field :description, String,
+    null: true,
+    description: ''
+
+  field :site, String,
+    null: true,
+    description: ''
+
+  field :url, String,
+    null: true,
+    description: ''
+
+  # field :image, Types::EmbedImage,
+  #   null: true,
+  #   description: ''
+end

app/graphql/types/post.rb

@@ -44,6 +44,10 @@ class Types::Post < Types::BaseObject
     null: true,
     description: 'The reason why this post was locked.'
 
+  field :embed, Types::Union::EmbedItem,
+    null: true,
+    description: ''
+
   field :comments, Types::Comment.connection_type,
     null: false,
     description: 'All comments related to this post.'

app/graphql/types/union/embed_item.rb

@@ -0,0 +1,5 @@
+class Types::Union::EmbedItem < Types::Union::Base
+  description 'All the different Embed types'
+
+  possible_types Types::Embed::WebsiteEmbed
+end