glass-rails 0.0.1

data/lib/generators/glass/model/templates/model.rb

@@ -0,0 +1,28 @@
+class Glass::<%= model_name.camelize %> < Glass::TimelineItem
+
+
+  defaults_template with: "table.html.erb"
+
+
+
+  ## this feature is experimental and not yet ready
+  ## for use:
+  # manages_template with: :template_manager
+
+
+  #### these are your menu items which you define 
+  #### for the timeline object.
+  #### 
+
+  has_menu_item :custom_action_name, display_name: "this is displayed", 
+                                     icon_url: "http://icons.iconarchive.com/icons/enhancedlabs/lha-objects/128/Filetype-URL-icon.png", 
+                                     handled_by: :custom_action_handler
+
+
+
+
+  def custom_action_handler
+    ## logic for handling custom action
+  end
+
+end

data/lib/generators/glass/templates/templates/image_full.html.erb

@@ -0,0 +1,9 @@
+<article class="photo">
+  <img src="<%= @image_url %>" style="max-width:100%;">
+  <div class="photo-overlay" />
+  <section style="height:180px;top:130px;">
+    <p>
+      <%= @content %>
+    </p>
+  </section>
+</article>

data/lib/generators/glass/templates/templates/image_left_with_section_right.html.erb

@@ -0,0 +1,8 @@
+<article>
+  <figure>
+    <img src="<%= @image_url %>">
+  </figure>
+  <section>
+    <%= @content %>
+  </section>
+</article>

data/lib/generators/glass/templates/templates/image_left_with_table_right.html.erb

@@ -0,0 +1,11 @@
+<article>
+  <figure>
+    <img src="<%= @image_url %>">
+  </figure>
+  <section>
+    <table> 
+      <%= @table_header %>
+      <%= @table_body %>
+    </table>
+  </section>
+</article>

data/lib/generators/glass/templates/templates/list.html.erb

@@ -0,0 +1,7 @@
+<article>
+  <section>
+    <ul>
+      <%= @content %>
+    </ul>
+  </section>
+</article>

data/lib/generators/glass/templates/templates/simple.html.erb

@@ -0,0 +1,7 @@
+<article>
+  <section>
+    <p>
+      <%= @content %>
+    </p>
+  </section>
+</article>

data/lib/generators/glass/templates/templates/table.html.erb

@@ -0,0 +1,8 @@
+<article>
+  <section>
+    <table> 
+      <%= @table_header %>
+      <%= @table_rows %>
+    </table>
+  </section>
+</article>

data/lib/generators/glass/templates/templates/two_column.html.erb

@@ -0,0 +1,12 @@
+<article>
+  <section>
+    <div class="layout-two-column">
+      <div class="align-center">
+        <%= @left_content %>
+      </div>
+      <div class="align-center">
+        <%= @right_content %>
+      </div>
+    </div>
+  </section>
+</article>

data/lib/generators/glass/templates/templates/two_column_with_emphasis_left.html.erb

@@ -0,0 +1,14 @@
+<article>
+  <section>
+    <div class="layout-figure">
+      <div class="align-center">
+        <%= @left_content %>
+      </div>
+      <div>
+        <div class="text-normal">
+          <%= @right_content %>
+        </div>
+      </div>
+    </div>
+  </section>
+</article>

data/lib/generators/glass/templates/templates_generator.rb

@@ -0,0 +1,16 @@
+require 'generators/glass'
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module Glass
+  module Generators
+    class TemplatesGenerator < Base
+      include Rails::Generators::Migration
+
+      def copy_glass_templates
+        directory("", "app/views/glass")
+      end
+    end
+    private
+  end
+end

data/lib/glass-rails.rb

@@ -0,0 +1,7 @@
+require "glass"
+require "glass/engine"
+require "glass/timeline_item"
+require "glass/subscription_notification"
+require "glass/template"
+require "glass/client"
+require 'glass/subscription'

data/lib/glass.rb

@@ -0,0 +1,24 @@
+require "rails/all"
+require 'active_support/core_ext/numeric/time'
+require 'active_support/dependencies'
+
+
+module Glass
+
+  mattr_accessor :brandname
+  @@brandname = "example"
+
+  mattr_accessor :brandname_styles
+  @@brandname_styles = {color: "#8BCDF8", 
+                        font_size: "30px"}
+
+  mattr_accessor :glass_template_path
+  @@glass_template_path = "app/views/glass" 
+
+
+  ## devise trick
+  def self.setup
+    yield self
+  end
+
+end

data/lib/glass/api_keys.rb

@@ -0,0 +1,29 @@
+require "yaml"
+module Glass
+  ## just a small class to organize the api key logic info
+  ## from the yml file in config. 
+  class ApiKeys
+    class APIKeyConfigurationError < StandardError; end;
+    attr_accessor :client_id, :client_secret, :google_api_keys
+    def initialize
+      self.google_api_keys = load_yaml_file
+      load_keys
+      self
+    end
+    private
+    def load_keys
+      if google_api_keys["client_id"].nil? or google_api_keys["client_secret"].nil?
+        raise APIKeyConfigurationError
+      else
+        set_client_keys
+      end
+    end
+    def load_yaml_file
+      ::YAML.load(File.read("#{::Rails.root}/config/google-api-keys.yml"))[::Rails.env]
+    end
+    def set_client_keys
+      self.client_id = google_api_keys["client_id"]
+      self.client_secret = google_api_keys["client_secret"]
+    end
+  end
+end

data/lib/glass/client.rb

@@ -0,0 +1,95 @@
+require "glass/api_keys"
+require "google/api_client"
+module Glass
+  class Client
+    attr_accessor :access_token,          :google_client,           :mirror_api, 
+                  :google_account,        :refresh_token,          :content,
+                  :mirror_content_type,   :timeline_item,           :has_expired_token
+
+
+
+
+    def self.create(timeline_item, opts={})
+      client = new(opts.merge({google_account: timeline_item.google_account}))
+      client.set_timeline_item(timeline_item)
+      client
+    end
+
+
+    def initialize(opts)
+      self.google_client = ::Google::APIClient.new
+      self.mirror_api = google_client.discovered_api("mirror", "v1")
+      self.google_account = opts[:google_account]
+
+      ### this isn't functional yet but this is an idea for 
+      ### an api for those who wish to opt out of passing in a
+      ### google account, by passing in a hash of options
+      ###
+      ### the tricky aspect of this is how to handle the update
+      ### of the token information if the token is expired.
+
+      self.access_token = opts[:access_token] || google_account.try(:token) 
+      self.refresh_token = opts[:refresh_token] || google_account.try(:refresh_token)
+      self.has_expired_token = opts[:has_expired_token] || google_account.has_expired_token?
+
+      
+      setup_with_our_access_tokens
+      setup_with_user_access_token
+      self
+    end
+    def set_timeline_item(timeline_object)
+      self.timeline_item = timeline_object
+      self
+    end
+    def json_content
+      mirror_api.timeline.insert.request_schema.new(self.timeline_item.to_json)
+    end
+
+    ## optional parameter is merged into the content hash 
+    ## before sending. good for specifying more application
+    ## specific stuff like speakableText parameters. 
+
+    def insert(options={})
+      body_object = options[:content] || json_content
+      inserting_content = { api_method: mirror_api.timeline.insert, 
+                            body_object: body_object }.merge(options)
+      google_client.execute(inserting_content)
+    end
+
+    def delete(options={})
+      deleting_content = { api_method: mirror_api.timeline.delete,
+                           parameters: options }
+      google_client.execute(deleting_content)
+    end
+
+    private
+    def setup_with_our_access_tokens
+      api_keys = Glass::ApiKeys.new
+      ["client_id", "client_secret"].each do |meth| 
+        google_client.authorization.send("#{meth}=", api_keys.send(meth)) 
+      end
+    end
+    def setup_with_user_access_token
+      google_client.authorization.update_token!(access_token: access_token, 
+                                                refresh_token: refresh_token)
+      update_token_if_necessary
+    end
+
+    def update_token_if_necessary
+      if self.has_expired_token
+        google_account.update_google_tokens(convert_user_data(google_client.authorization.fetch_access_token!))
+      end
+    end
+
+    def to_google_time(time)
+      Time.now.to_i + time
+    end
+    def convert_user_data(google_data_hash)
+      ea_data_hash = {}
+      ea_data_hash["token"] = google_data_hash["access_token"]
+      ea_data_hash["expires_at"] = to_google_time(google_data_hash["expires_in"])
+      ea_data_hash["id_token"] = google_data_hash["id_token"]
+      ea_data_hash
+    end
+  end
+end

data/lib/glass/engine.rb

@@ -0,0 +1,5 @@
+module Glass
+  class Engine < ::Rails::Engine
+    config.glass = Glass
+  end
+end

data/lib/glass/menu_item.rb

@@ -0,0 +1,33 @@
+module Glass
+  class MenuItem
+    attr_accessor :action, :id, :display_name, :icon_url
+    BUILT_IN_ACTIONS = [:reply,         :reply_all,       :delete, 
+                        :share,         :read_aloud,      :voice_call, 
+                        :navigate,      :toggle_pinned]
+
+
+    def self.create(action_sym, args)
+      args = BUILT_IN_ACTIONS.include?(action_sym) ? args : args.merge({id: action_sym})
+      new(args)
+    end
+
+    def initialize(opts={})
+      self.action           = opts[:action] || "CUSTOM"
+      self.id               = opts[:id]
+      self.display_name     = opts[:display_name]
+      self.icon_url         = opts[:icon_url]
+    end
+
+    def action
+      @action ||= "CUSTOM"
+    end
+
+    def serialize
+      hash = {action: action}
+      hash.merge!({id: id, 
+                   values: [{ displayName: display_name, 
+                              iconUrl: icon_url}]}) if action == "CUSTOM"
+      hash
+    end
+  end
+end

data/lib/glass/rails/version.rb

@@ -0,0 +1,5 @@
+module Glass
+  module Rails
+    VERSION="0.0.1"
+  end
+end

data/lib/glass/subscription.rb

@@ -0,0 +1,46 @@
+module Glass
+  class Subscription
+    DEFAULT_COLLECTION = :timeline
+    DEFAULT_OPERATIONS = %w(UPDATE INSERT DELETE)#['UPDATE', 'INSERT', 'DELETE']
+
+    attr_accessor :google_account, :client, :google_client, :mirror_api
+
+    def initialize(opts)
+      self.google_account = opts[:google_account]
+      self.client = Glass::Client.new google_account: google_account
+      self.google_client = client.google_client
+      self.mirror_api = client.mirror_api
+    end
+
+    ## Insert a subscription
+    ## optional parameters:
+    ##  collection can be :timeline or :locations
+    ##  operation is an array of operations subscribed to. Valid values are 'UPDATE', 'INSERT', 'DELETE'
+    def insert(opts={})
+      subscription = mirror_api.subscriptions.insert.request_schema.new(
+        collection:   opts[:collection] || DEFAULT_COLLECTION,
+        userToken:    user_token,
+        verifyToken:  verification_secret,
+        callbackUrl:  callback_url,
+        operation:    opts[:operations] || DEFAULT_OPERATIONS)
+      result = google_client.execute(api_method: mirror_api.subscriptions.insert,
+                                     body_object: subscription)
+      result
+    end
+
+    ## Must be HTTPS
+    def callback_url
+      Rails.application.routes.url_helpers.glass_notifications_callback_url(protocol: 'https')
+    end
+
+    ## Token string used to identify user in the callback
+    def user_token
+      google_account.id.to_s
+    end
+
+    ## Secret string used to verify that the callback is by Google
+    def verification_secret
+      google_account.verification_secret
+    end
+  end
+end

data/lib/glass/subscription_notification.rb

@@ -0,0 +1,75 @@
+module Glass
+  class SubscriptionNotification
+    attr_accessor :google_account,    :params,    :collection,
+                  :user_actions
+
+    class VerificationError < StandardError; end
+
+    def self.create(params)
+      notification = new(params)
+      notification.handle!
+    end
+    def initialize(params)
+      self.params = params
+      self.collection = params[:collection]
+      self.user_actions = params[:userActions]
+      self.google_account = find_google_account(params)
+      verify_authenticity!
+    end
+
+    ## Perform the corresponding notification actions
+    def handle!
+      if collection == "locations"
+        # TODO: This is a location update - should the GoogleAccount handle these updates?
+        # When your Glassware receives a location update, send a request to the glass.locations.get endpoint to retrieve the latest known location.
+        # Something like: google_account.handle_location_update
+      else
+        if has_user_action? :share
+          # TODO: Someone shared a card with this user's glassware. Who should handle this?
+          # The actual reply with attachments with itemId, so we need to fetch that
+          # Something like google_account.handle_shared_item(params)
+        elsif has_user_action? :reply
+          # TODO: Someone replied to a card.
+          # itemId => TimelineItem which contains at least: inReplyTo (original item),
+          # text (text transcription of reply), and attachments
+        else # Custom Action or DELETE
+          handle_action(params[:itemId])
+        end
+      end
+    end
+
+    private
+    def has_user_action?(action)
+      user_actions.select{|user_action| user_action["type"].downcase == action.to_s}.first
+    end
+
+    ## Handle actions on a timeline_item with a given id (custom actions, delete, etc.)
+    def handle_action(item_id)
+      timeline_item = find_timeline_item(item_id)
+
+      # TODO: Should we uniq these? When glass doesn't have connection, it will queue up
+      # actions, so users might press the same one multiple times.
+      user_actions.uniq.each do |user_action|
+        type = user_action[:type] == "CUSTOM" ? user_action[:payload] : user_action[:type]
+        timeline_item.send("handles_#{type.downcase}")
+      end if user_actions
+    end
+
+    ## Find the associated user from userToken
+    def find_google_account(params)
+      GoogleAccount.find params[:userToken]
+    end
+
+    ## Find a given timeline item owned by the user
+    def find_timeline_item(item_id)
+      Glass::TimelineItem.find_by_glass_item_id_and_google_account_id(item_id, google_account.id)
+    end
+
+    ## Verify authenticity of callback before doing anything
+    def verify_authenticity!
+      unless params[:verifyToken] == google_account.verification_secret
+        raise VerificationError.new("received: #{params[:verifyToken]}")
+      end
+    end
+  end
+end