glass-rails 0.0.1

data/lib/glass/template.rb

@@ -0,0 +1,45 @@
+require "rails/all"
+require 'action_view'
+module Glass
+  class Template < ActionView::Base
+    attr_accessor :timeline_item, :template_name
+
+    ## basically, any thing passed in the hash here gets instantiated as
+    ## an instance variable in the view, except :template_name
+    ##
+    ## the [:template_name] key will be reserved for specifying the relative
+    ## path (to the glass_template_path) to your template.
+
+    ## For example,
+
+    ## if your glass_template_path is set to:
+    ## "app/views/glass-templates"
+
+    ## and you have a file in a folder 
+    ## "app/views/glass-templates/tweets/blue.html.erb"
+
+    ## then your template name would be:
+    ## "tweets/blue.html.erb"
+    def initialize(opts={})
+      self.template_name = opts.delete(:template_name) || "simple.html.erb"
+      set_template_instance_variables(opts)
+      super(glass_template_path)
+    end
+    def render_self
+      self.render template: self.template_name
+    end
+    private
+
+    ##
+    ## substantiate the instance variables needed by action view for rendering
+    ## in the erb templates.
+    ## 
+    def set_template_instance_variables(opts)
+      opts.each {|k,v| self.instance_variable_set("@#{k}", v) }
+    end
+    ## just for convenience.
+    def glass_template_path
+      ::Glass.glass_template_path
+    end
+  end  
+end

data/lib/glass/timeline_item.rb

@@ -0,0 +1,259 @@
+require 'active_record'
+require "glass/menu_item"
+## this is an abstract class, not intended to be
+## used directly
+
+module Glass
+  class TimelineItem < ::ActiveRecord::Base
+    class GoogleAccountNotSpecifiedError < StandardError;end;
+    class UnserializedTemplateError < StandardError; end;
+    class MenuItemHandlerIsNotDefinedError < StandardError; end;
+    class TimelineInsertionError < StandardError; end;
+
+    self.table_name = :glass_timeline_items
+
+    belongs_to :google_account
+
+    attr_accessible :display_time,      :glass_content,     :glass_content_type, 
+                    :glass_created_at,  :glass_etag,        :glass_item_id, 
+                    :glass_kind,        :glass_self_link,   :glass_updated_at, 
+                    :is_deleted,        :google_account_id
+
+
+
+    ## i'd use cattr_accessor, but unfortunately
+    ## ruby has some very crappy class variables, which
+    ## are nonsensically over-written across sub-classes.
+    ## so use the rails class_attribute helpers instead.
+
+    class_attribute :actions
+    class_attribute :menu_items
+    class_attribute :default_template 
+
+    attr_accessor :template_type, :to_json
+
+
+
+    ## only a writer for these two
+    ## because I want to hook an error 
+    ## message to each of these if they haven't 
+    ## had there values set yet.
+    attr_writer :client, :mirror_content, :template_name
+
+
+
+
+
+
+
+
+    ### a couple custom attr_readers which raise a
+    ### helpful error message if the value is nil;
+    ### i.e. error flow handling.
+    def mirror_content
+      raise UnserializedTemplateError unless @mirror_content
+      @mirror_content
+    end 
+    def client
+      raise UnserializedTemplateError unless @client
+      @client
+    end
+
+
+
+
+
+
+
+
+
+    ## this methods sets the default template for
+    ## all instances of the class. 
+
+    ## Usage: 
+    ##   class Glass::Tweet < Glass::TimelineItem
+
+    ##     defaults_template "table.html.erb" 
+                ## this defaults to the glass_template_path
+                ## which you set in your glass initializer.
+
+    ##   end
+    def self.defaults_template(opts={})
+      self.default_template = opts[:with] if opts[:with]
+    end
+
+
+
+
+
+
+
+
+    ## this methods sets the default template for
+    ## all instances of the class. 
+
+    ## Usage: 
+    ##   class Glass::Tweet < Glass::TimelineItem
+
+    ##     manages_templates :template_manager_name
+                ## this will set your template manager
+                ## for this class. this will override
+                ## defaults_template path if it is 
+                ## defined.
+
+    ##   end
+    def self.manages_templates(opts={})
+      self.template_manager = opts[:with] if opts[:with]
+    end
+
+
+
+
+
+    ## this methods sets the default template for
+    ## all instances of the class. 
+
+    ## Usage: 
+    ##   class Glass::Tweet < Glass::TimelineItem
+
+    ##     has_menu_item :my_custom_action,
+    ##       display_name: "Displayed Name",
+    ##       icon_url: "url for icon",
+    ##       handles_with: :custom_handler_methodname
+
+    ##       def custom_handler_methodname
+    ##         # this gets executed when this
+    ##         # action occurs.
+    ##       end
+    ##   end
+    def self.has_menu_item(action_sym, opts={}) 
+      self.actions ||= []
+      self.menu_items ||= []
+      unless self.actions.include?(action_sym)
+        self.actions += [action_sym] 
+        defines_callback_methods(action_sym, opts)
+        menu_item = ::Glass::MenuItem.create(action_sym, opts)
+        self.menu_items += [menu_item]
+      end
+    end
+
+
+
+    ## this is really just a little meta-programming
+    ## trick which basically forces a call to the method 
+    ## specified by with parameter in the has_menu_item method.
+    ## 
+    ## it allows you to put the callback logic right 
+    ## there in the model. 
+
+    def self.defines_callback_methods(action, opts)
+      self.send(:define_method, "handles_#{action.to_s.underscore}") do
+        if self.respond_to?(opts[:handled_by])
+          self.send(opts[:handled_by])
+        else 
+          raise MenuItemHandlerIsNotDefinedError
+        end
+      end
+    end
+
+
+
+    ## not meant to be a part of the public api.
+    def self.menu_items_hash
+      {menuItems: self.menu_items.map(&:serialize) }
+    end
+
+    ## not meant to be a part of the public api.
+    def menu_items_hash
+      self.class.menu_items_hash
+    end
+
+
+
+
+
+    ## this method will instantiate instance variables 
+    ## in the erb template with the values you specify
+    ## in a hash parameter under the key [:template_variables]
+
+    ## For example,
+    ## @google_account = GoogleAccount.first
+    ## @timeline_object =  TimelineObject.new(google_account_id: @google_account.id)
+    ## @timeline_object.serialize({template_variables: {content: "this is the content
+    ##                                                            i've pushed to glass"}})
+    ## 
+    ## would render this erb template:
+
+
+    ## <article> 
+    ##   <%= @content %>
+    ## </article>
+
+    ## into this:
+  
+    ## '<article> \n    this is the content i've pushed to glass \n  </article>'
+    ##
+    ##
+    ## an html serialization of your timeline object, which glass
+    ## requests you send with your push.
+
+
+    ## 
+    def serialize(opts={})
+      raise GoogleAccountNotSpecifiedError unless self.google_account.present?
+      type = self.template_type || :html
+      json_hash = {}
+      json_hash[type] = self.setup_template(opts.delete(:template_variables).merge({template_name: opts.delete(:template_name) }))
+      json_hash = json_hash.merge(self.menu_items_hash)
+      json_hash.merge(opts)
+      self.to_json = json_hash
+      self.client = Glass::Client.create(self)
+      return self
+    end
+
+    def insert(opts={})
+      result = client.insert(opts)
+      if result.error? 
+        raise TimelineInsertionError
+      else
+        data = result.data
+        result_data_type = :html #default
+        [:html, :text].each do |result_type|
+          result_data_type = result_type if data.send(result_type).present?
+        end
+        self.update_attributes(glass_item_id: data.id, 
+                                glass_etag: data.etag,
+                                glass_self_link: data.self_link,
+                                glass_kind: data.kind,
+                                glass_created_at: data.created,
+                                glass_updated_at: data.updated,
+                                glass_content_type: result_data_type,
+                                glass_content: data.send(result_data_type))
+      end
+    end
+    def patch(opts={})
+      
+    end
+    # def update(opts={})
+
+    # end
+
+
+
+    ## this is not intended to be a part of the public api
+    def template_name
+      @template_name = self.class.default_template || "simple.html.erb"
+    end
+
+    ## this is not intended to be a part of the public api
+    def setup_template(variables={})
+      glass_template_path = variables[:template_name] || self.template_name
+      Glass::Template.new({template_name: glass_template_path}.merge(variables)).render_self
+    end
+
+    ## this is not intended to be a part of the public api
+    def has_default_template?
+      self.class.default_template
+    end
+  end
+end

data/spec/models/glass/template_spec.rb

@@ -0,0 +1,12 @@
+require "glass"
+require "glass/template"
+describe "Glass::Template" do 
+  context "HTML" do 
+    before :each do 
+      @template = Glass::Template.new
+    end
+    it "should not convert to an empty string on to_s" do 
+      
+    end
+  end
+end

data/spec/models/glass/timeline_item_spec.rb

@@ -0,0 +1,9 @@
+# require "glass/timeline_item"
+describe "Glass::TimelineItem" do 
+  context "class" do 
+
+    it "should have be able to " do 
+      
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,55 @@
+if $LOADED_FEATURES.grep(/spec\/spec_helper\.rb/).any?
+  begin
+    raise "foo"
+  rescue => e
+    puts <<-MSG
+  ===================================================
+  It looks like spec_helper.rb has been loaded
+  multiple times. Normalize the require to:
+
+    require "spec/spec_helper"
+
+  Things like File.join and File.expand_path will
+  cause it to be loaded multiple times.
+
+  Loaded this time from:
+
+    #{e.backtrace.join("\n    ")}
+  ===================================================
+    MSG
+  end
+end
+
+require 'rubygems'
+
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+ENV["RAILS_ENV"] ||= 'test'
+require 'rspec'
+
+# ActiveRecord::Base.shared_connection = ActiveRecord::Base.connection
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+RSpec.configure do |config|
+  # ## Mock FrameworkRSpec.configure do |config|
+  # config.include FactoryGirl::Syntax::Methods
+  
+  # #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  # config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # # instead of true.
+  # config.use_transactional_fixtures = true
+
+  # # If true, the base class of anonymous controllers will be inferred
+  # # automatically. This will be the default behavior in future versions of
+  # # rspec-rails.
+  # config.infer_base_class_for_anonymous_controllers = false
+end

metadata

@@ -0,0 +1,226 @@
+--- !ruby/object:Gem::Specification
+name: glass-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Kunal Modi
+- Han Kang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: google-api-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+description: ' A framework for creating google glass applications using ruby on rails. '
+email:
+- kunal@thirstlabs.com
+- han@therubyists.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .DS_Store
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- glass-rails.gemspec
+- lib/.DS_Store
+- lib/generators/.DS_Store
+- lib/generators/glass.rb
+- lib/generators/glass/.DS_Store
+- lib/generators/glass/install/install_generator.rb
+- lib/generators/glass/install/templates/glass_timeline_item_migration.rb
+- lib/generators/glass/install/templates/google-oauth.yml
+- lib/generators/glass/install/templates/google_account.rb
+- lib/generators/glass/install/templates/initializer.rb
+- lib/generators/glass/install/templates/notifications_controller.rb
+- lib/generators/glass/model/model_generator.rb
+- lib/generators/glass/model/templates/model.rb
+- lib/generators/glass/templates/.DS_Store
+- lib/generators/glass/templates/templates/image_full.html.erb
+- lib/generators/glass/templates/templates/image_left_with_section_right.html.erb
+- lib/generators/glass/templates/templates/image_left_with_table_right.html.erb
+- lib/generators/glass/templates/templates/list.html.erb
+- lib/generators/glass/templates/templates/simple.html.erb
+- lib/generators/glass/templates/templates/table.html.erb
+- lib/generators/glass/templates/templates/two_column.html.erb
+- lib/generators/glass/templates/templates/two_column_with_emphasis_left.html.erb
+- lib/generators/glass/templates/templates_generator.rb
+- lib/glass-rails.rb
+- lib/glass.rb
+- lib/glass/.DS_Store
+- lib/glass/api_keys.rb
+- lib/glass/client.rb
+- lib/glass/engine.rb
+- lib/glass/menu_item.rb
+- lib/glass/rails/version.rb
+- lib/glass/subscription.rb
+- lib/glass/subscription_notification.rb
+- lib/glass/template.rb
+- lib/glass/timeline_item.rb
+- spec/models/glass/template_spec.rb
+- spec/models/glass/timeline_item_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: 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.
+test_files:
+- spec/models/glass/template_spec.rb
+- spec/models/glass/timeline_item_spec.rb
+- spec/spec_helper.rb