apps 0.2.1 → 0.3.0

data/lib/apps/gmail/schema.rb

@@ -0,0 +1,21 @@
+require_relative '../common/schema'
+require_relative '../common/schema/concerns'
+
+module Apps
+  module Gmail
+    module Schema
+      include ::Apps::Common::Schema
+    end
+  end
+end
+
+require_relative 'schema/confirm_action'
+require_relative 'schema/email_message'
+require_relative 'schema/event'
+require_relative 'schema/parcel_delivery'
+require_relative 'schema/place'
+require_relative 'schema/postal_address'
+require_relative 'schema/rsvp_action'
+require_relative 'schema/save_action'
+require_relative 'schema/track_action'
+require_relative 'schema/view_action'

data/lib/apps/gmail/schema/action.rb

@@ -0,0 +1,19 @@
+module Apps
+  module Gmail
+    module Schema
+      class Action < Base
+
+        attr_accessor :url
+        
+        def serialize
+          super.merge(
+            "handler" => {
+              "@type" => "HttpActionHandler",
+              "url" => url
+            }
+          )
+        end
+      end
+    end
+  end
+end

data/lib/apps/gmail/schema/confirm_action.rb

@@ -0,0 +1,21 @@
+require_relative 'action'
+
+module Apps
+  module Gmail
+    module Schema
+      # See: https://developers.google.com/gmail/markup/reference/one-click-action
+      # See: https://developers.google.com/gmail/markup/reference/types/ConfirmAction
+      class ConfirmAction < Action
+
+        attr_accessor :name, :confirmed
+        
+        def serialize
+          super.merge(
+            "name" => name,
+            "confirmed" => confirmed&.serialize # Thing
+          )
+        end
+      end
+    end
+  end
+end

data/lib/apps/gmail/schema/email_message.rb

@@ -0,0 +1,15 @@
+module Apps
+  module Gmail
+    module Schema
+      class EmailMessage < Base
+        include Schema::Concerns::PotentialAction
+        
+        attr_accessor :description, :publisher
+        
+        def serialize
+          super.merge("publisher" => publisher&.serialize) # Organization
+        end
+      end
+    end
+  end
+end

data/lib/apps/gmail/schema/event.rb

@@ -0,0 +1,41 @@
+require_relative 'rsvp_action'
+require_relative 'place'
+
+module Apps
+  module Gmail
+    module Schema
+      class Event < Base
+        include Schema::Concerns::PotentialAction
+        
+        attr_accessor :name, :start_date, :end_date, :location
+        
+        def serialize
+          super.merge(
+            "name" => name,
+            "startDate" => start_date,
+            "endDate" => end_date,
+            "location" => location&.serialize
+          )
+        end
+
+        def build_location(**attrs)
+          self.location = Place.new(**attrs).tap do |place|
+            place.build_address unless place.address
+          end
+        end
+
+        def build_rsvp_actions
+          actions.clear
+          
+          %w[Yes No Maybe].map { |response| add_action_for(response) }
+        end
+        
+        def add_action_for(response, **attrs)
+          RsvpAction.new(response: response, **attrs).tap do |action|
+            actions << action
+          end
+        end
+      end
+    end
+  end
+end

data/lib/apps/gmail/schema/parcel_delivery.rb

@@ -0,0 +1,43 @@
+require_relative 'postal_address'
+
+module Apps
+  module Gmail
+    module Schema
+      class ParcelDelivery < Base
+        include Schema::Concerns::PotentialAction
+        
+        attr_accessor :delivery_address, :expected_arrival_until, :carrier_name
+        attr_accessor :product_name, :order_number, :merchant_name
+        attr_accessor :tracking_url
+        
+        def serialize
+          super.merge(
+            "deliveryAddress" => delivery_address&.serialize,
+            "expectedArrivalUntil" => expected_arrival_until,
+            "carrier" => {
+              "@type" => "Organization",
+              "name" => carrier_name
+            },
+            "itemShipped" => {
+              "@type" => "Product",
+              "name" => product_name
+            },
+            "partOfOrder" => {
+              "@type" => "Order",
+              "orderNumber" => order_number,
+              "merchant" => {
+                "@type" => "Organization",
+                "name" => merchant_name
+              }
+            },
+            "trackingUrl" => tracking_url
+          )
+        end
+
+        def build_delivery_address(**attrs)
+          self.delivery_address = PostalAddress.new(**attrs)
+        end
+      end
+    end
+  end
+end

data/lib/apps/gmail/schema/place.rb

@@ -0,0 +1,24 @@
+require_relative 'postal_address'
+
+module Apps
+  module Gmail
+    module Schema
+      class Place < Base
+
+        attr_accessor :name, :same_as, :address
+        
+        def serialize
+          super.merge(
+            "sameAs" => same_as,
+            "name" => name,
+            "address" => address&.serialize
+          )
+        end
+
+        def build_address(**attrs)
+          self.address = PostalAddress.new(**attrs)
+        end
+      end
+    end
+  end
+end

data/lib/apps/gmail/schema/postal_address.rb

@@ -0,0 +1,22 @@
+module Apps
+  module Gmail
+    module Schema
+      class PostalAddress < Base
+
+        attr_accessor :name, :street, :locality, :region, :po_box, :postal_code, :country
+        
+        def serialize
+          super.merge(
+            "name" => name,
+            "streetAddress" => street,       # street address
+            "addressLocality" => locality,   # city
+            "addressRegion" => region,       # state (abbr)
+            "postOfficeBoxNumber" => po_box,
+            "postalCode" => postal_code,     # zip code
+            "addressCountry" => country
+          )
+        end
+      end
+    end
+  end
+end

data/lib/apps/gmail/schema/rsvp_action.rb

@@ -0,0 +1,25 @@
+require_relative 'action'
+
+module Apps
+  module Gmail
+    module Schema
+      # See: https://developers.google.com/gmail/markup/reference/rsvp-action
+      class RsvpAction < Action
+
+        attr_accessor :response, :additional_number_of_guests, :bringing_kids, :bringing_other_people
+        
+        def serialize
+          super.merge(
+            "rsvpResponse" => response.downcase,
+            "additionalNumberOfGuests" => additional_number_of_guests&.to_i,
+            "bringingKids" => bringing_kids&.to_i,
+            "bringingOtherPeople" => bringing_other_people&.to_i,
+            # "comment" => {},
+            # "event" => {},
+            "attendance" => "http://schema.org/RsvpAttendance/#{response.capitalize}"
+          )
+        end
+      end
+    end
+  end
+end

data/lib/apps/gmail/schema/save_action.rb

@@ -0,0 +1,20 @@
+require_relative 'action'
+
+module Apps
+  module Gmail
+    module Schema
+      # See: https://developers.google.com/gmail/markup/reference/one-click-action
+      # See: https://developers.google.com/gmail/markup/reference/types/SaveAction
+      class SaveAction < Action
+
+        attr_accessor :name
+        
+        def serialize
+          super.merge(
+            "name" => name
+          )
+        end
+      end
+    end
+  end
+end

data/lib/apps/gmail/schema/track_action.rb

@@ -0,0 +1,20 @@
+module Apps
+  module Gmail
+    module Schema
+      # See: https://developers.google.com/gmail/markup/reference/go-to-action
+      # See: https://developers.google.com/gmail/markup/reference/types/TrackAction
+      class TrackAction < Base
+
+        attr_accessor :name, :target, :delivery_method
+        
+        def serialize
+          super.merge(
+            "name" => name,
+            "target" => target,
+            "deliveryMethod" => delivery_method&.serialize # DeliveryMethod
+          )
+        end
+      end
+    end
+  end
+end

data/lib/apps/gmail/schema/view_action.rb

@@ -0,0 +1,20 @@
+module Apps
+  module Gmail
+    module Schema
+      # See: https://developers.google.com/gmail/markup/reference/go-to-action
+      # See: https://developers.google.com/gmail/markup/reference/types/ViewAction
+      class ViewAction < Base
+
+        attr_accessor :name, :target, :viewed
+        
+        def serialize
+          super.merge(
+            "name" => name,
+            "target" => target,
+            "viewed" => viewed&.serialize # Thing
+          )
+        end
+      end
+    end
+  end
+end

data/lib/apps/outlook/actionable_messages.rb

@@ -0,0 +1,13 @@
+require_relative 'schema'
+
+module Apps
+  module Outlook
+    module ActionableMessages
+      class << self
+        def message_card(summary, title, **attrs)
+          Schema::MessageCard.new(summary: summary, title: title, **attrs)
+        end
+      end
+    end
+  end
+end

data/lib/apps/outlook/schema.rb

@@ -0,0 +1,20 @@
+require_relative '../common/schema'
+
+module Apps
+  module Outlook
+    module Schema
+      include ::Apps::Common::Schema
+    end
+  end
+end
+
+require_relative 'schema/concerns'
+require_relative 'schema/action_card'
+require_relative 'schema/date_input'
+require_relative 'schema/http_post'
+require_relative 'schema/invoke_add_in_command'
+require_relative 'schema/message_card'
+require_relative 'schema/multichoice_input'
+require_relative 'schema/open_uri'
+require_relative 'schema/section'
+require_relative 'schema/text_input'

data/lib/apps/outlook/schema/action.rb

@@ -0,0 +1,14 @@
+module Apps
+  module Outlook
+    module Schema
+      # See: https://docs.microsoft.com/en-us/outlook/actionable-messages/card-reference#actions
+      class Action < Base
+        attr_accessor :name # Button text
+
+        def serialize
+          super.merge("name" => name)
+        end
+      end
+    end
+  end
+end

data/lib/apps/outlook/schema/action_card.rb

@@ -0,0 +1,42 @@
+require_relative 'action'
+require_relative 'http_post'
+require_relative 'open_uri'
+
+module Apps
+  module Outlook
+    module Schema
+      # See: https://docs.microsoft.com/en-us/outlook/actionable-messages/card-reference#actioncard-action
+      class ActionCard < Action
+        ACTIONS = [
+          Schema::OpenUri,
+          Schema::HttpPOST
+        ].freeze
+
+        def inputs
+          @inputs ||= []
+        end
+
+        # OpenUriAction and HttpPostAction allowed
+        def actions
+          @actions ||= []
+        end
+
+        def serialize
+          super.merge(
+            "inputs" => inputs.map(&:serialize),
+            "actions" => actions.select { |action| ACTIONS.include?(action.class) }.map(&:serialize)
+          )
+        end
+
+        # See: https://docs.microsoft.com/en-us/outlook/actionable-messages/card-reference#input-value-substitution
+        def input_value_substitutions(formatted: true)
+          inputs.map do |input|
+            key = "#{input.id}.value"
+            
+            formatted ? "{{#{key}}}" : key
+          end
+        end
+      end
+    end
+  end
+end

data/lib/apps/outlook/schema/concerns.rb

@@ -0,0 +1,14 @@
+require_relative '../../common/schema/concerns'
+
+module Apps
+  module Outlook
+    module Schema
+      module Concerns
+        include ::Apps::Common::Schema::Concerns
+      end
+    end
+  end
+end
+
+require_relative 'concerns/sections'
+require_relative 'concerns/sorted_potential_action'

data/lib/apps/outlook/schema/concerns/sections.rb

@@ -0,0 +1,27 @@
+module Apps
+  module Outlook
+    module Schema
+      module Concerns
+        module Sections
+          def sections
+            @sections ||= []
+          end
+
+          def serialize
+            if sections.any?
+              super.merge("sections" => sections.map(&:serialize))
+            else
+              super
+            end
+          end
+
+          def add_section(title, **attrs)
+            Section.new(title: title, **attrs).tap do |section|
+              sections << section
+            end
+          end
+        end
+      end
+    end
+  end
+end