GraphQL - Embeds

app/graphql/types/embed/audio_tag_embed.rb

@@ -0,0 +1,5 @@
+class Types::Embed::AudioTagEmbed < Types::BaseObject
+  implements Types::Interface::BaseEmbed
+
+  description 'Audio Properties'
+end

app/graphql/types/embed/image_tag_embed.rb

@@ -0,0 +1,17 @@
+class Types::Embed::ImageTagEmbed < Types::BaseObject
+  implements Types::Interface::BaseEmbed
+
+  description 'Image Properties'
+
+  field :width, String,
+    null: false,
+    description: 'The number of pixels wide.'
+
+  field :height, String,
+    null: false,
+    description: 'The number of pixels high.'
+
+  field :alt, String,
+    null: false,
+    description: 'A description of what is in the image (not a caption).'
+end

app/graphql/types/embed/profile_embed.rb

@@ -0,0 +1,22 @@
+class Types::Embed::WebsiteEmbed < Types::BaseObject
+  implements Types::Interface::BaseEmbed
+
+  field :first_name, String,
+    null: true,
+    description: 'A name normally given to an individual by a parent or self-chosen.'
+
+  field :last_name, String,
+    null: true,
+    description: <<~DESCRIPTION.squish
+      A name inherited from a family or marriage
+      and by which the individual is commonly known.
+    DESCRIPTION
+
+  field :username, String,
+    null: true,
+    description: 'A short unique string to identify them.'
+
+  field :gender, Types::Enum::Gender,
+    null: true,
+    description: 'Their gender.'
+end

app/graphql/types/embed/video_tag_embed.rb

@@ -0,0 +1,17 @@
+class Types::Embed::VideoTagEmbed < Types::BaseObject
+  implements Types::Interface::BaseEmbed
+
+  description 'Video Properties'
+
+  field :width, String,
+    null: false,
+    description: 'The number of pixels wide.'
+
+  field :height, String,
+    null: false,
+    description: 'The number of pixels high.'
+
+  field :alt, String,
+    null: false,
+    description: 'A description of what is in the video (not a caption).'
+end

app/graphql/types/embed/website_embed.rb

@@ -0,0 +1,3 @@
+class Types::Embed::WebsiteEmbed < Types::BaseObject
+  implements Types::Interface::BaseEmbed
+end

app/graphql/types/enum/gender.rb

@@ -0,0 +1,5 @@
+class Types::Enum::Gender < Types::Enum::Base
+  value 'MALE', value: 'male'
+  value 'FEMALE', value: 'female'
+  value 'OTHER', value: 'other'
+end

app/graphql/types/interface/base_embed.rb

@@ -0,0 +1,69 @@
+module Types::Interface::BaseEmbed
+  include Types::Interface::Base
+  description 'Required and Optional fields for an Embed based off the Open Graph protocol'
+
+  orphan_types Types::Embed::WebsiteEmbed
+
+  field :title, String,
+    null: false,
+    description: 'The title of your object as it should appear within the graph.'
+
+  field :kind, String,
+    null: false,
+    description: <<~DESCRIPTION.squish
+      The type of your object,
+      e.g., "video.movie".
+      Depending on the type you specify, other properties may also be required.
+    DESCRIPTION
+
+  field :site, String,
+    null: false,
+    description: ''
+
+  field :url, String,
+    null: false,
+    description: 'The canonical URL of your object that will be used as its permanent ID in the graph'
+
+  field :image, Types::ImageTagEmbed,
+    null: false,
+    description: 'An image URL which should represent your object within the graph.'
+
+  field :audio, Types::AudioTagEmbed,
+    null: true,
+    description: 'A URL to an audio file to accompany this object.'
+
+  field :description, String,
+    null: true,
+    description: 'A one to two sentence description of your object.'
+
+  field :determiner, String,
+    null: true,
+    description: <<~DESCRIPTION.squish
+      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).
+    DESCRIPTION
+
+  field :locale, String,
+    null: true,
+    default_value: 'en_us',
+    description: <<~DESCRIPTION.squish
+      The locale these tags are marked up in.
+      Of the format language_territory.
+    DESCRIPTION
+
+  field :locale_alternative, [String],
+    null: true,
+    description: 'An array of other locales this page is available in.'
+
+  field :site_name, String,
+    null: true,
+    description: <<~DESCRIPTION.squish
+      If your object is part of a larger web site,
+      the name which should be displayed for the overall site.
+    DESCRIPTION
+
+  field :video, Types::VideoTagEmbed,
+    null: true,
+    description: 'A URL to a video file that complements this object.'
+end

app/graphql/types/interface/base_tag_embed.rb

@@ -0,0 +1,17 @@
+module Types::Interface::BaseTagEmbed
+  include Types::Interface::Base
+
+  description 'Similar fields between Image, Audio, Video Tags.'
+
+  field :url, String,
+    null: false,
+    description: 'A url.'
+
+  field :secure_url, String,
+    null: true,
+    description: 'An alternate url to use if the webpage requires HTTPS.'
+
+  field :kind, String,
+    null: true,
+    description: 'A MIME type'
+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::Interface::BaseEmbed,
+    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