apps 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6567ec4200bd064433ef5002a6cab70a98760770d9a765355b963c952ece266a
-  data.tar.gz: e77e4e67936e3c8ae9de44f3e1391e789333d79f34ed33c427952a4636c5f2ca
+  metadata.gz: 6b23f1e570ff2fe9154e677f4ac4400ed38b15688a04f96c6c3bacf03bf37a9c
+  data.tar.gz: 9d7e953d209b24a18072870377506615248edc3851d6db2994331d05b4bdcac4
 SHA512:
-  metadata.gz: 604fe4bae4ef91ec735b7ab6a7eafed71e9655b4001c1211b94e090922f33258b43a5f374d09dfc180d9b65fc5757302cfb695d3d30354b02e0280fe5f0bb445
-  data.tar.gz: 8e5b56db99e84c88eeb90998d8f8e4ad1d4f2525072b54990273b85005dc668ed5ea1e1612ea56a354871428e32055cb554c3b33f5a778a802392b2eb2e37ba8
+  metadata.gz: b03cced80ee3d26790c915a33fe2106a743194860c0a78ee4d634d7b8c2c920814aa1f8b0631c2b956fb3b142eaecc0dc0c0df1f1d708d740f8990867da3fb7b
+  data.tar.gz: 7065dbcc46c911e8f45cc597371c4f43926499aa060cc39968b2f996da111242647aedd867447c4b0c21e0ad9cad668060a9f7e121b8376a1fbad0e0744aea5c

data/.rubocop

@@ -0,0 +1,12 @@
+--fail-fast
+--cache=true
+--debug
+--extra-details
+--color
+--rails
+--auto-correct
+app
+config
+lib
+spec
+vendor

data/.rubocop.yml

@@ -0,0 +1,34 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2017-11-29 01:07:29 -0500 using RuboCop version 0.51.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 13
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+AllCops:
+  TargetRubyVersion: 2.3.1
+  
+Metrics/LineLength:
+  Max: 120
+
+Metrics/ClassLength:
+  Max: 150
+
+Metrics/ModuleLength:
+  Max: 150
+
+Metrics/MethodLength:
+  Max: 50
+
+Documentation:
+  Enabled: false
+
+# Offense count: 1
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    apps (0.1.0)
+    apps (0.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,6 +1,23 @@
 # Apps
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/apps`. To experiment with that code, run `bin/console` for an interactive prompt.
+This is a toolkit to easily integrate into platform marketplaces and extension points. These tools help with various integration points and common boilerplate needed to get going.
+
+The Apps gem is currently under development, with the goal of facilitating the following:
+
+* Google
+  * [Gmail Add-ons](https://developers.google.com/gmail/add-ons/)
+  * [Gmail Email Markup](https://developers.google.com/gmail/markup/)
+  * AMP Pages
+* Microsoft Office 365
+  * [Outlook Add-ins](https://docs.microsoft.com/en-us/outlook/add-ins/)
+  * [Outlook Actionable Messages](https://docs.microsoft.com/en-us/outlook/actionable-messages/)
+* Slack
+  * Bots
+  * Commands
+* Heroku
+  * Addons Marketplace (SSO)
+* Facebook
+  * Instant Articles
 
 ## Installation
 
@@ -20,7 +37,28 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Coming Soon
+### Gmail Email Markup
+
+You can generate [schema.org](http://schema.org) markup for email in Gmail utilizing simple helper classes.
+
+* Use the helper methods in `Apps::Adapters::Gmail::Markup` to easily define your markup
+* Helper methods to generate an object model for you to "fill in":
+  * Confirm Action - `Apps::Adapters::Gmail::Markup#build_confirm_action`
+  * Save Action - `Apps::Adapters::Gmail::Markup#build_save_action`
+  * RSVP Action - `Apps::Adapters::Gmail::Markup#build_rsvp_action`
+  * View Action - `Apps::Adapters::Gmail::Markup#build_view_action`
+  * Track Action - `Apps::Adapters::Gmail::Markup#build_track_action`
+* Helper methods to serialize your object model:
+  * `as_json` generates a `Hash` represenation of metadata
+  * `to_json` generates a JSON string representation of metadata
+  * `to_script` generates a "pretty" JSON enclosed by `script` tags specifying `JSON-LD` type
+    * 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"
+
+#### TODO
+
+* Basic handler endpoints for "Actions" to interact with need to be facilitated (e.g. for RSVP Action)
+* Email Markup helpers for other Gmail-supported metadata need to be implemented
+* Additional Gmail integrations need to be developed
 
 ## Development
 
@@ -30,12 +68,8 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/apps. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/joelvh/apps. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the Apps project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/apps/blob/master/CODE_OF_CONDUCT.md).

data/lib/apps/adapters/gmail/markup/action.rb

@@ -0,0 +1,23 @@
+require_relative 'base'
+
+module Apps
+  module Adapters
+    module Gmail
+      module Markup
+        class Action < Base
+
+          attr_accessor :handler_url
+          
+          def as_json
+            prune super.merge(
+              "handler" => {
+                "@type" => "HttpActionHandler",
+                "url" => handler_url
+              }
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/apps/adapters/gmail/markup/base.rb

@@ -0,0 +1,33 @@
+require 'json'
+
+module Apps
+  module Adapters
+    module Gmail
+      module Markup
+        class Base
+          def initialize(**attrs)
+            attrs.each { |attr, value| instance_variable_set(:"@#{attr}", value) }
+          end
+
+          def type
+            @type ||= self.class.name.split('::')[-1]
+          end
+
+          def as_json
+            { "@type" => type }
+          end
+
+          def to_json(pretty: false)
+            pretty ? JSON.pretty_generate(as_json) : JSON.dump(as_json)
+          end
+        
+        protected
+
+          def prune(hash)
+            hash.reject { |_, value| value.nil? }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/apps/adapters/gmail/markup/base_context.rb

@@ -0,0 +1,23 @@
+require_relative 'base'
+
+module Apps
+  module Adapters
+    module Gmail
+      module Markup
+        class BaseContext < Base
+          def as_json
+            { "@context" => "http://schema.org" }.merge(super)
+          end
+
+          def to_script
+            buffer = []
+            buffer << %{<script type="application/ld+json">}
+            buffer << to_json(pretty: true)
+            buffer << %{</script>}
+            buffer.join("\n")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/apps/adapters/gmail/markup/confirm_action.rb

@@ -0,0 +1,23 @@
+require_relative 'action'
+
+module Apps
+  module Adapters
+    module Gmail
+      module Markup
+        # 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 as_json
+            prune super.merge(
+              "name" => name,
+              "confirmed" => confirmed&.as_json # Thing
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/apps/adapters/gmail/markup/email_message.rb

@@ -0,0 +1,22 @@
+require_relative 'base_context'
+
+module Apps
+  module Adapters
+    module Gmail
+      module Markup
+        class EmailMessage < BaseContext
+
+          attr_reader   :action
+          attr_accessor :description, :publisher
+          
+          def as_json
+            prune super.merge(
+              "potentialAction" => action&.as_json,
+              "publisher" => publisher&.as_json # Organization
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/apps/adapters/gmail/markup/event.rb

@@ -0,0 +1,38 @@
+require_relative 'base_context'
+require_relative 'rsvp_action'
+require_relative 'place'
+
+module Apps
+  module Adapters
+    module Gmail
+      module Markup
+        class Event < BaseContext
+
+          attr_accessor :name, :start_date, :end_date, :location
+          
+          def as_json
+            prune super.merge(
+              "name" => name,
+              "startDate" => start_date,
+              "endDate" => end_date,
+              "location" => location&.as_json,
+              "potentialAction" => actions.map(&:as_json)
+            )
+          end
+
+          def actions
+            @actions ||= []
+          end
+
+          def build_location(**attrs)
+            self.location = Place.new(**attrs)
+          end
+
+          def build_rsvp_actions
+            actions.clear.concat(%w[Yes No Maybe].map { |response| RsvpAction.new(response: response) })
+          end
+        end
+      end
+    end
+  end
+end

data/lib/apps/adapters/gmail/markup/parcel_delivery.rb

@@ -0,0 +1,47 @@
+require_relative 'base_context'
+require_relative 'postal_address'
+
+module Apps
+  module Adapters
+    module Gmail
+      module Markup
+        class ParcelDelivery < BaseContext
+
+          attr_reader   :action
+          attr_accessor :delivery_address, :expected_arrival_until, :carrier_name
+          attr_accessor :product_name, :order_number, :merchant_name
+          attr_accessor :tracking_url
+          
+          def as_json
+            prune super.merge(
+              "deliveryAddress" => delivery_address&.as_json,
+              "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,
+              "potentialAction" => action&.as_json
+            )
+          end
+
+          def build_delivery_address(**attrs)
+            self.delivery_address = PostalAddress.new(**attrs)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/apps/adapters/gmail/markup/place.rb

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

data/lib/apps/adapters/gmail/markup/postal_address.rb

@@ -0,0 +1,26 @@
+require_relative 'base'
+
+module Apps
+  module Adapters
+    module Gmail
+      module Markup
+        class PostalAddress < Base
+
+          attr_accessor :name, :street, :locality, :region, :po_box, :postal_code, :country
+          
+          def as_json
+            prune 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
+end

data/lib/apps/adapters/gmail/markup/rsvp_action.rb

@@ -0,0 +1,27 @@
+require_relative 'action'
+
+module Apps
+  module Adapters
+    module Gmail
+      module Markup
+        # 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 as_json
+            prune 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
+end

data/lib/apps/adapters/gmail/markup/save_action.rb

@@ -0,0 +1,22 @@
+require_relative 'action'
+
+module Apps
+  module Adapters
+    module Gmail
+      module Markup
+        # 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 as_json
+            prune super.merge(
+              "name" => name
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/apps/adapters/gmail/markup/track_action.rb

@@ -0,0 +1,24 @@
+require_relative 'base'
+
+module Apps
+  module Adapters
+    module Gmail
+      module Markup
+        # 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 as_json
+            prune super.merge(
+              "name" => name,
+              "target" => target,
+              "deliveryMethod" => delivery_method&.as_json # DeliveryMethod
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/apps/adapters/gmail/markup/view_action.rb

@@ -0,0 +1,24 @@
+require_relative 'base'
+
+module Apps
+  module Adapters
+    module Gmail
+      module Markup
+        # 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 as_json
+            prune super.merge(
+              "name" => name,
+              "target" => target,
+              "viewed" => viewed&.as_json # Thing
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/apps/adapters/gmail/markup.rb

@@ -0,0 +1,43 @@
+require_relative 'markup/event'
+require_relative 'markup/email_message'
+require_relative 'markup/parcel_delivery'
+require_relative 'markup/confirm_action'
+require_relative 'markup/save_action'
+require_relative 'markup/view_action'
+require_relative 'markup/track_action'
+
+module Apps
+  module Adapters
+    module Gmail
+      module Markup
+        class << self
+          def build_confirm_action(description: nil, **attrs)
+            EmailMessage.new(description: description, action: ConfirmAction.new(**attrs))
+          end
+
+          def build_save_action(description: nil, **attrs)
+            EmailMessage.new(description: description, action: SaveAction.new(**attrs))
+          end
+
+          def build_rsvp_action(**attrs)
+            Event.new(**attrs).tap do |event|
+              event.build_location         unless event.location
+              event.location.build_address unless event.location.address
+              event.build_rsvp_actions     unless event.actions.any?
+            end
+          end
+
+          def build_view_action(target: nil, **attrs)
+            EmailMessage.new(action: ViewAction.new(target: target), **attrs)
+          end
+
+          def build_track_action(target: nil, **attrs)
+            ParcelDelivery.new(action: TrackAction.new(target: target), **attrs).tap do |email|
+              email.build_delivery_address unless email.delivery_address
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/apps/version.rb

@@ -1,3 +1,3 @@
 module Apps
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apps
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Joel Van Horn
@@ -62,6 +62,8 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
@@ -73,6 +75,20 @@ files:
 - bin/setup
 - exe/apps
 - lib/apps.rb
+- lib/apps/adapters/gmail/markup.rb
+- lib/apps/adapters/gmail/markup/action.rb
+- lib/apps/adapters/gmail/markup/base.rb
+- lib/apps/adapters/gmail/markup/base_context.rb
+- lib/apps/adapters/gmail/markup/confirm_action.rb
+- lib/apps/adapters/gmail/markup/email_message.rb
+- lib/apps/adapters/gmail/markup/event.rb
+- lib/apps/adapters/gmail/markup/parcel_delivery.rb
+- lib/apps/adapters/gmail/markup/place.rb
+- lib/apps/adapters/gmail/markup/postal_address.rb
+- lib/apps/adapters/gmail/markup/rsvp_action.rb
+- lib/apps/adapters/gmail/markup/save_action.rb
+- lib/apps/adapters/gmail/markup/track_action.rb
+- lib/apps/adapters/gmail/markup/view_action.rb
 - lib/apps/version.rb
 homepage: https://github.com/joelvh/apps
 licenses: