apps 0.2.1 → 0.3.0

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

@@ -0,0 +1,17 @@
+module Apps
+  module Outlook
+    module Schema
+      module Concerns
+        module SortedPotentialActions
+          def serialize_actions
+            # OpenUri action is supposed to be last
+            # See: https://docs.microsoft.com/en-us/outlook/actionable-messages/card-reference#openuri-action
+            actions.sort! { |a, b| a.class == b.class ? 0 : a.is_a?(OpenUri) ? -1 : 1 }
+
+            super
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+require_relative 'input'
+
+module Apps
+  module Outlook
+    module Schema
+      # See: https://docs.microsoft.com/en-us/outlook/actionable-messages/card-reference#dateinput
+      class DateInput < Input
+
+        attr_accessor :include_time # Boolean - whether to select time in addition to date
+
+        def serialize
+          super.merge("includeTime" => include_time)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+require_relative 'action'
+
+module Apps
+  module Outlook
+    module Schema
+      # See: https://docs.microsoft.com/en-us/outlook/actionable-messages/card-reference#httppost-action
+      class HttpPOST < Action
+        # CARD-ACTION-STATUS - include header in server HTTP POST response
+        # See: https://docs.microsoft.com/en-us/outlook/actionable-messages/card-reference#reporting-an-actions-execution-success-or-failure
+        # CARD-UPDATE-IN-BODY - `true` value indicates to client to refresh content with response body
+        # See: https://docs.microsoft.com/en-us/outlook/actionable-messages/card-reference#refresh-cards
+        RESPONSE_HEADERS = %w[
+          CARD-ACTION-STATUS
+          CARD-UPDATE-IN-BODY
+        ]
+        MIME_TYPES = %w[
+          application/json
+          application/x-www-form-urlencoded
+        ]
+
+        attr_accessor :target, # URL
+                      :body,   # body of the POST request
+                      :body_content_type # MIME type of body
+
+        def headers
+          @headers ||= {}
+        end
+
+        def serialize
+          super.merge(
+            "target" => target,
+            "headers" => serialize_hash(headers),
+            "body" => body,
+            "bodyContentType" => body_content_type
+          )
+        end
+
+        def add_header(name, value)
+          headers[name] = value
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module Apps
+  module Outlook
+    module Schema
+      # See: https://docs.microsoft.com/en-us/outlook/actionable-messages/card-reference#inputs
+      class Input < Base
+
+        attr_accessor :id,       # Uniquely identifies input in a form
+                      :required,
+                      :title,    # Placeholder text or label
+                      :value     # Initial value of input
+
+        def serialize
+          super.merge(
+            "id" => id,
+            "isRequired" => required,
+            "title" => title,
+            "value" => value
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+require_relative 'action'
+
+module Apps
+  module Outlook
+    module Schema
+      # See: https://docs.microsoft.com/en-us/outlook/actionable-messages/card-reference#invokeaddincommand-action
+      class InvokeAddInCommand < Action
+        
+        attr_accessor :add_in_id, # UUID from add-in's manifest
+                      # Specifies the ID of the add-in command button that opens
+                      # the required taskpane. The command button ID is found in
+                      # the id attribute of the Control element that defines the
+                      # button in the add-in's manifest. The specified Control element
+                      # MUST be defined inside a `MessageReadCommandSurface` extension point,
+                      # be of type Button, and the control's Action must be of type `ShowTaskPane`.
+                      :desktop_command_id,
+                      # Optional. Developers may specify any valid JSON object in
+                      # this field. The value is serialized into a string and made
+                      # available to the add-in when the action is executed. This
+                      # allows the action to pass initialization data to the add-in.
+                      :initialization_context
+
+        def serialize
+          super.merge(
+            "addInId" => add_in_id,
+            "desktopCommandId" => desktop_command_id,
+            "initializationContext" => initialization_context
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+require_relative 'concerns/sections'
+
+module Apps
+  module Outlook
+    module Schema
+      # See: https://docs.microsoft.com/en-us/outlook/actionable-messages/card-reference
+      class MessageCard < Base
+        include Schema::Concerns::Sections
+        include Schema::Concerns::PotentialAction
+        include Schema::Concerns::SortedPotentialActions
+
+        HEADER_NAMES = %w[Card-Correlation-Id Action-Request-Id]
+        
+        attr_accessor :correlation_id     # UUID to track actions originating in email message
+        attr_accessor :originator         # provider ID (required for actionable emails)
+        attr_accessor :hide_original_body # For email only (hide email content if message card is duplicate)
+        attr_accessor :summary, :title,
+                      :text               # Markdown
+        attr_accessor :theme_color
+
+        def context
+          'http://schema.org/extensions'
+        end
+
+        def serialize
+          super.merge(
+            "summary" => summary,
+            "themeColor" => theme_color,
+            "correlationId" => correlation_id,
+            "originator" => originator,
+            "hideOriginalBody" => hide_original_body,
+            "title" => title,
+            "text" => text
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+require_relative 'input'
+
+module Apps
+  module Outlook
+    module Schema
+      # See: https://docs.microsoft.com/en-us/outlook/actionable-messages/card-reference#multichoiceinput
+      class MultichoiceInput < Input
+        STYLES = %w[normal expanded].freeze
+
+        attr_accessor :multiple, # Boolean - whether to allow selecting multiple choices
+                      :style     # `normal` - dropdown
+                                 # `expanded` - radio button list
+
+        def choices
+          @choices ||= {}
+        end
+
+        def serialize
+          super.merge(
+            "isMultiSelect" => multiple,
+            "style" => style,
+            "choices" => serialize_hash(choices, key: 'display')
+          )
+        end
+
+        def add_choice(name, value)
+          choices[name] = value
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+require_relative 'action'
+
+module Apps
+  module Outlook
+    module Schema
+      # See: https://docs.microsoft.com/en-us/outlook/actionable-messages/card-reference#openuri-action
+      class OpenUri < Action
+        OPERATING_SYSTEMS = %w[default windows iOS android].freeze
+
+        def targets
+          @targets ||= {}
+        end
+
+        def serialize
+          super.merge("targets" => serialize_hash(targets, key: 'os', value: 'uri'))
+        end
+
+        def add_target(url, os: 'default')
+          targets[os] = url
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+module Apps
+  module Outlook
+    module Schema
+      # See: https://docs.microsoft.com/en-us/outlook/actionable-messages/card-reference#section-fields
+      class Section < Base
+        include Schema::Concerns::PotentialAction
+        include Schema::Concerns::SortedPotentialActions
+
+        attr_accessor :title,
+                      :text            # Markdown
+        attr_accessor :start_group     # boolean, used to separate sections with divider lines
+        attr_accessor :activity_title, # Markdown
+                      :activity_subtitle, :activity_text, :activity_image
+        attr_accessor :hero_image,     # url
+                      :hero_title
+
+        # Hash of key/value pairs displayed to call out specific points
+        def facts
+          @facts ||= {}
+        end
+
+        # Photo gallery (URL => title)
+        def images
+          @images ||= {}
+        end
+
+        def serialize
+          super.merge(
+            "title" => title,
+            "startGroup" => start_group,
+            "activityTitle" => activity_title,
+            "activitySubtitle" => activity_subtitle,
+            "activityText" => activity_text,
+            "activityImage" => activity_image,
+            "heroImage" => hero_image && serialize_image(hero_image => hero_title, key: 'image', value: 'title'),
+            "text" => text,
+            "facts" => serialize_hash(facts),
+            "images" => serialize_hash(images, key: 'image', value: 'title')
+          )
+        end
+
+        def add_fact(name, value)
+          facts[name] = value
+        end
+
+        def add_image(url, title: nil)
+          images[url] = title
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+require_relative 'input'
+
+module Apps
+  module Outlook
+    module Schema
+      # See: https://docs.microsoft.com/en-us/outlook/actionable-messages/card-reference#textinput
+      class TextInput < Input
+
+        attr_accessor :multiline, :max_length
+
+        def serialize
+          super.merge(
+            "isMultiline" => multiline,
+            "maxLength" => max_length
+          )
+        end
+      end
+    end
+  end
+end

data/lib/apps/version.rb

@@ -1,3 +1,6 @@
+require 'json'
+
 module Apps
-  VERSION = '0.2.1'
+  PACKAGE_PATH ||= File.expand_path('../../package.json', File.dirname(__FILE__))
+  VERSION ||= JSON.parse(File.read(PACKAGE_PATH)).fetch('version')
 end

data/lib/examples.rb

@@ -0,0 +1,121 @@
+
+def divide(char = '#')
+  puts ""
+  puts char * 72
+  puts ""
+end
+
+def show(caption, object)
+  puts caption
+  puts ""
+  
+  if object.is_a?(String)
+    puts object
+  else
+    pp object
+  end
+
+  puts ""
+end
+
+divide
+
+require_relative 'apps/gmail/markup'
+
+puts "GMAIL TESTS"
+
+# Confirm Action (takes additional keyword options)
+confirm_action = Apps::Gmail::Markup.confirm_action('Button Text', 'http://example.org/confirm/endpoint')
+
+show 'confirm_action.as_json', confirm_action.as_json
+# => {"@context"=>"http://schema.org", "@type"=>"EmailMessage", "potentialAction"=>{"@type"=>"ConfirmAction", "handler"=>{"@type"=>"HttpActionHandler", "url"=>"http://example.org/confirm/endpoint"}}}
+
+show 'confirm_action.to_json', confirm_action.to_json
+# => {"@context":"http://schema.org","@type":"EmailMessage","potentialAction":{"@type":"ConfirmAction","handler":{"@type":"HttpActionHandler","url":"http://example.org/confirm/endpoint"}}}
+
+# NOTE: `to_script` is only available on "context" objects that represent the root of the markup
+#       needed for embedding in emails. This is the object returned by each of the helper methods
+#       above for each "Action"
+show 'confirm_action.to_script', confirm_action.to_script
+# =>
+# <script type="application/ld+json">
+# {
+#   "@context": "http://schema.org",
+#   "@type": "EmailMessage",
+#   "potentialAction": {
+#     "@type": "ConfirmAction",
+#     "handler": {
+#       "@type": "HttpActionHandler",
+#       "url": "http://example.org/confirm/endpoint"
+#     }
+#   }
+# }
+# </script>
+
+# Save Action (takes additional keyword options)
+save_action = Apps::Gmail::Markup.save_action('Button Text', 'http://example.org/save/endpoint')
+
+show 'save_action', save_action.to_script
+
+# RSVP Action (takes additional keyword options)
+rsvp_action = Apps::Gmail::Markup.rsvp_action('Event Name',
+                yes_url:   'http://example.org/yes/endpoint',
+                no_url:    'http://example.org/no/endpoint',
+                maybe_url: 'http://example.org/maybe/endpoint'
+              )
+
+show 'rsvp_action', rsvp_action.to_script
+
+# View Action (takes additional keyword options)
+view_action = Apps::Gmail::Markup.view_action('Button Text', 'http://example.org/save/endpoint')
+
+show 'view_action', view_action.to_script
+
+# Track Action (takes additional keyword options)
+track_action = Apps::Gmail::Markup.track_action('Button Text', 'http://example.org/save/endpoint')
+
+show 'track_action', track_action.to_script
+
+divide
+
+require_relative 'apps/outlook/actionable_messages'
+
+puts "OUTLOOK TESTS"
+
+message_card = Apps::Outlook::ActionableMessages.message_card('Summary text', 'Title text')
+
+section = message_card.add_section('Section title', start_group: true, activity_image: 'http://img')
+section.add_fact('Username', 'joelvh')
+section.actions << Apps::Outlook::Schema::OpenUri.new(name: 'Section open uri action').tap { |s| s.add_target('http://target/section')}
+
+show "section.actions", section.actions
+
+pp message_card.serialize
+
+section2 = message_card.add_section('Section 2 title', start_group: false, activity_image: 'http://img2')
+section2.add_image('http://gallery1')
+section2.add_image('http://gallery2', title: 'Gallery 2 caption')
+
+message_card.actions << Apps::Outlook::Schema::OpenUri.new(name: 'Card open uri action')
+
+action_card = Apps::Outlook::Schema::ActionCard.new(name: 'Action card form')
+
+action_card.inputs << Apps::Outlook::Schema::DateInput.new(id: 'due_date', title: 'Due Date', value: '2008-01-01')
+action_card.inputs << Apps::Outlook::Schema::TextInput.new(id: 'username', title: 'Username', value: 'fakeuser')
+action_card.inputs << Apps::Outlook::Schema::MultichoiceInput.new(id: 'rating', title: 'Rating', value: '3').tap do |multi|
+  multi.add_choice('1 Star', '1')
+  multi.add_choice('3 Star', '3')
+  multi.add_choice('5 Star', '5')
+end
+
+section2.actions << action_card
+
+show "message_card.actions", message_card.actions
+
+pp message_card.serialize
+
+divide('-')
+
+puts message_card.to_script
+
+divide

data/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "apps",
+  "version": "0.3.0",
+  "description": "Easily integrate with multiple platform apps/add-ins/add-ons marketplaces.",
+  "main": "index.js",
+  "repository": "https://github.com/joelvh/apps",
+  "author": "Joel Van Horn <joel@joelvanhorn.com>",
+  "license": "MIT",
+  "dependencies": {
+    "generator-office": "^1.1.7"
+  }
+}