glass-rails 0.0.6 → 0.0.7

data/README.md

@@ -119,7 +119,54 @@ 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 - Menu Item Callbacks
 
+This framework does most of the heavy lifting for you for subscribing
+to notifications to your timeline items. If a glass-user 'acts' on a menu-item
+which you have specified on your card, you will generally be alerted of 
+that action (with the exception of a few built-in actions, like 'read-aloud').
+
+You may want to perform actions when certain actions are performed. For
+example, if you have an 'email me' menu-item defined, you may want to 
+perform a back-end task which emails some content to a glass-user. 
+
+The helper method `has_menu_item` therefore takes an options hash: if you specify
+a key called "handles_with", then we will automatically invoke the value as an
+instance method when the callback is triggered. 
+
+For example, in the code sample below:
+
+```ruby
+class Glass::Tweet < Glass::TimelineItem
+  has_menu_item :email, handles_with: :respond_to_email_request
+  def respond_to_email_request
+
+  end
+end
+```
+
+.. whenever you receive a notification from google that an "email" action has
+been performed, the method "respond_to_email_request" will be automatically
+executed for you.
+
+For greater control over handling the callback from google, if you 
+define your callback method as accepting a parameter, then we will pass 
+the response hash from google into the callback method.
+
+For instance:
+
+```ruby
+class Glass::Tweet < Glass::TimelineItem
+  has_menu_item :email, handles_with: :respond_to_email_request
+  def respond_to_email_request(response)
+    ### we will pass the response object
+    ### into the callback method, if you
+    ### have allowed the callback
+    ### to accept a parameter. This is done
+    ### via a method arity check. 
+  end
+end
+```
 
 ### Glass Models - (Posting Content) 
 
@@ -160,9 +207,21 @@ 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
+gt.insert()
 ```
 
+Additionally, if you would like to merge in attributes into the hash before it is 
+posted to the mirror-api, then you can optionally pass in a hash of attributes 
+to the insert() method call, and the hash will be merged into the body_object that
+is posted to the mirror api.
+
+This last point is relevant, for example, in the case of reading aloud text. 
+To do so, you need to specify a speakableText: "some text to be read aloud" attribute 
+in the body object when it gets posted. You can therefore do something like this:
+
+```ruby
+gt.insert(speakableText: "some text to be read aloud")
+```
 
 ## Contributing
 

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

@@ -16,7 +16,7 @@ class Glass::<%= model_name.camelize %> < 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", 
-                                     handled_by: :custom_action_handler
+                                     handles_with: :custom_action_handler
 
 
 

data/lib/glass/rails/version.rb

@@ -1,5 +1,5 @@
 module Glass
   module Rails
-    VERSION="0.0.6"
+    VERSION="0.0.7"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: glass-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-24 00:00:00.000000000 Z
+date: 2013-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties