glass-rails 0.0.1

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.rvmrc
+.config
+.yardoc
+.rspec
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in glass-rails.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Thirst Labs, Inc.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,172 @@
+# Glass::Rails
+
+  A DSL for building Google Glass apps using Ruby on Rails.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'glass-rails'
+
+And then execute:
+
+    $ bundle
+
+Or install locally by running the following command:
+
+    $ gem install glass-rails
+
+## Usage
+
+### Setting up
+
+We have a rails generator which will generate a 
+yaml file for your google api keys. The command for 
+the generator is: 
+
+    rails g glass:install
+
+This will generate a yaml file for your keys, an initializer for 
+setting up configuration details, and migrations for the appropriate
+tables.
+
+### Templates
+
+This gem includes a template generator, which provides a basic 
+set of default templates (derived directly from the recommended templates 
+which are shown in the glass playground). 
+
+To generate the default templates, you can run the command:
+
+    rails g glass:templates
+
+This will generate a basic series of templates under the path,
+`app/views/glass` though you may want to organize them more logically,
+depending on your use case
+
+### Glass Models - (Introduction)
+
+This gem also provides a glass model generator, which generates a timeline-item
+model for your use:
+
+For example, let's say you want to post a tweet to a user's glass timeline, 
+you may want to have a glass model which represents tweets. To generate that
+model, you can run this command: 
+
+    rails g glass:model tweet
+
+and you will find a model generated for you in the directory,
+`app/models/glass/<glassmodelname>.rb`. 
+
+It is primarly with Glass Models that you generate your glass application,
+so understanding the mechanisms by which we map out over the actual google
+api is probably a good idea. 
+
+If you want your timeline item to have a list of menu-items, you can specify 
+the menu-items in your glass model like so:
+
+```ruby
+ class Glass::Tweet < Glass::TimelineItem
+    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", 
+                  handles_with: :custom_action_handler
+ end
+```
+### Glass Models - Menu Items
+
+You can define a series of menu items for a glass model,
+using the helper method `has_menu_item`. This method takes the 
+following arguments:
+
+```ruby
+class Glass::ExampleCard < Glass::TimelineItem
+  has_menu_item <symbolized_name_of_action>, <options>
+  ## here options is a hash, and you can define here:
+  ## the displayed name of the action/menu item, 
+  ## i.e. 'like', as well as a url for an icon, and 
+  ## a callback method which gets executed when you
+  ## are notified of an event.
+end
+```
+
+Basically, the way that the google mirror api works, you
+are required to subscribe to notifications from a user to
+get updated on the status of a user action on a timeline 
+item. This gems aims to aid the subscription and notification 
+process, primarily to get the process bootstrapped and ready to
+go. 
+
+You will automatically be subscribed to notifications on a timeline
+item, and will get notified to your glass callback url, which we have 
+inserted into your routes for you if you have used the install 
+generator.
+
+Once you have generated a timeline item glass model:
+
+```ruby
+class Glass::Tweet < Glass::TimelineItem
+end
+```
+
+You can use the `has_menu_item` helper method in your
+glass model to define menu items. These menu items will them be
+applied uniformly for your entire class. 
+
+Once you've posted to the timeline item to the glass user's
+timeline, you are registered to listen for notifications 
+that the user has acted on your card. You can specify a callback method
+using the `has_menu_item` helper method, by passing in the
+
+
+
+### Glass Models - (Posting Content) 
+
+So using our Glass::Tweet class which we created above, we
+could instantiate a new instance of the class and assign it 
+an associated google account like so
+
+```ruby
+gt = Glass::Tweet.new(google_account_id: GoogleAccount.first)
+```
+Then, you can populate an erb template with instance variables by
+using the `serialize` method which is available to all subclasses 
+of Glass::TimelineItem (and yeah, to be clear, this includes Glass::Tweet).
+For example, let's say you have the following erb template:
+
+```erb
+<article>
+  <h1><%= @title %></h1>
+  <section>
+    <ul>
+      <%= @content %>
+    </ul>
+  </section>
+</article>
+```
+
+You can serialize the template for a glass::tweet instance like so:
+
+```ruby
+gt = Glass::Tweet.new(google_account_id: GoogleAccount.first)
+gt.serialize({template_variables: {content: "asdfasdfasdf", title: "title"}})
+```
+
+which will basically populate the `@content` and `@title` instance variables
+in the erb template, render it as a string, and get it prepped to send to the
+mirror api for insertion into the timeline.
+
+Then all you have to do is use the following command to actually insert the content:
+
+```ruby
+gt.client.insert
+```
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/glass-rails.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'glass/rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "glass-rails"
+  spec.version       = Glass::Rails::VERSION
+  spec.authors       = ["Kunal Modi", "Han Kang"]
+  spec.email         = ["kunal@thirstlabs.com", 'han@therubyists.org']
+  spec.description   = %q{ A framework for creating google glass applications using ruby on rails. }
+  spec.summary       = %q{ A framework for creating google glass applications using ruby on rails. 
+                          This probably isn't for everyone, but we did our best to make it suitable for
+                          as many cases as possible. }
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+
+  spec.add_dependency "railties", [">= 3.1"]
+  spec.add_dependency "google-api-client"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-rails"
+  spec.add_development_dependency "rspec", ">= 1.5.2"
+  spec.add_development_dependency "rspec-rails", '~> 2.11.0'
+
+end

data/lib/generators/glass.rb

@@ -0,0 +1,22 @@
+require 'rails/generators/base'
+
+module Glass
+  module Generators
+    class Base < Rails::Generators::Base #:nodoc:
+      def self.source_root
+        @_glass_source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'glass', generator_name, 'templates'))
+      end
+
+      def self.banner
+        "rails generate glass:#{generator_name} #{self.arguments.map{ |a| a.usage }.join(' ')} [options]"
+      end
+
+      private
+
+      def print_usage
+        self.class.help(Thor::Base.shell.new)
+        exit
+      end
+    end
+  end
+end

data/lib/generators/glass/install/install_generator.rb

@@ -0,0 +1,38 @@
+require 'generators/glass'
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module Glass
+  module Generators
+    class InstallGenerator < Base
+      include Rails::Generators::Migration
+      argument :user_model, type: :string, default: "User"
+
+      def create_configuration_file
+        copy_file("google-oauth.yml", "config/google-api-keys.yml")
+      end
+
+      def create_glass_account_migration
+        generate("model", "google_account token refresh_token expires_at:integer email name id_token verification_secret #{user_model.underscore.singularize}:references")
+        remove_file("app/models/google_account.rb")
+        template("google_account.rb", "app/models/google_account.rb")
+        insert_into_file("app/models/#{user_model.underscore.singularize}.rb", "\n\s\shas_one :google_account\n\n", after: "ActiveRecord::Base\n")
+      end
+      def self.next_migration_number(path)
+        (Time.now.utc.strftime("%Y%m%d%H%M%S").to_i + 1).to_s
+      end
+      def create_timeline_items_migration
+        migration_template "glass_timeline_item_migration.rb", "db/migrate/create_glass_timeline_items.rb"
+      end
+      def create_subscription_notifications_controller
+        generate("controller", "glass/notifications")
+        remove_file("app/controllers/glass/notifications_controller.rb")
+        template("notifications_controller.rb", "app/controllers/glass/notifications_controller.rb")
+        insert_into_file("config/routes.rb", "\n\s\spost 'glass/notifications', to: 'glass/notifications#callback', as: 'glass_notifications_callback'\n\n", after: "routes.draw\sdo\n")
+      end
+      def create_initializer
+        copy_file "initializer.rb", "config/initializers/glass.rb"
+      end
+    end
+  end
+end

data/lib/generators/glass/install/templates/glass_timeline_item_migration.rb

@@ -0,0 +1,21 @@
+class CreateGlassTimelineItems < ActiveRecord::Migration
+  def change
+    create_table :glass_timeline_items do |t|
+      t.string :type
+      t.references :google_account
+      t.string :glass_item_id
+      t.boolean :is_deleted
+      t.string :glass_etag
+      t.string :glass_self_link
+      t.string :glass_kind
+      t.datetime :glass_created_at
+      t.datetime :glass_updated_at
+      t.string :glass_content_type
+      t.text :glass_content
+      t.datetime :display_time
+
+      t.timestamps
+    end
+    add_index :glass_timeline_items, :google_account_id
+  end
+end

data/lib/generators/glass/install/templates/google-oauth.yml

@@ -0,0 +1,15 @@
+google_defaults: &google_defaults
+  scopes: [userinfo.email, userinfo.profile]
+  glass_scopes: [userinfo.email, userinfo.profile, glass.timeline]
+development:
+  client_id: CLIENT_ID
+  client_secret: CLIENT_SECRET
+  <<: *google_defaults
+test:
+  client_id: CLIENT_ID
+  client_secret: CLIENT_SECRET
+  <<: *google_defaults
+production:
+  client_id: CLIENT_ID
+  client_secret: CLIENT_SECRET
+  <<: *google_defaults

data/lib/generators/glass/install/templates/google_account.rb

@@ -0,0 +1,28 @@
+class GoogleAccount < ActiveRecord::Base
+  belongs_to :<%= user_model.underscore.singularize %>
+  attr_accessible :email, :expires_at, :name, :refresh_token, :token, :verification_secret
+  before_create :generate_verification_secret
+  after_create :subscribe_to_google_notifications
+  def token_expiry
+    Time.at(self.expires_at)
+  end
+  def has_expired_token?
+    token_expiry < Time.now
+  end
+  def update_google_tokens(google_auth_hash)
+    [:token, :id_token, :expires_at].each do |attribute|
+      self.send("#{attribute}=", google_auth_hash[attribute.to_s])
+    end
+    self.save
+  end
+
+  def subscribe_to_google_notifications
+    subscription = Glass::Subscription.new google_account: self
+    subscription.insert
+  end
+
+  private
+  def generate_verification_secret
+    self.verification_secret = SecureRandom.urlsafe_base64
+  end
+end

data/lib/generators/glass/install/templates/initializer.rb

@@ -0,0 +1,24 @@
+if Rails.env.development?
+  ##
+  ## if you've set this elsewhere you may want 
+  ## to comment this out. 
+  ##
+  ## Glass requires this to be defined for callback url 
+  ## purposes.
+  ##
+  Rails.application.routes.default_url_options[:host] = 'localhost:3000'
+elsif Rails.env.test?
+  
+  ## setup whatever you want for default url options for your test env.
+end
+
+Glass.setup do |config|
+  ## you can override the logo here
+  ## config.brandname = "examplename"
+
+
+
+  ## manually override your glass views path here.
+  config.glass_template_path = "app/views/glass"
+
+end

data/lib/generators/glass/install/templates/notifications_controller.rb

@@ -0,0 +1,7 @@
+class Glass::NotificationsController < ApplicationController
+  skip_before_filter :verify_authenticity_token
+  def callback
+    Glass::SubscriptionNotification.create(params)
+    render json: {success: true}
+  end
+end

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

@@ -0,0 +1,19 @@
+require 'generators/glass'
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module Glass
+  module Generators
+    class ModelGenerator < Base
+      argument :model_name, type: :string
+      def copy_glass_templates
+        unless File.directory?("app/models/glass/")
+          empty_directory("app/models/glass")
+        end
+      end
+      def create_glass_model
+        template("model.rb", "app/models/glass/#{model_name.underscore}.rb")
+      end
+    end
+  end
+end