Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Simple Mirror API Ruby client for Google Glass
Ruby
Branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
example
lib
spec
.coveralls.yml
.gitignore
.rspec
.travis.yml
Gemfile
LICENSE.txt
README.md
Rakefile
mirror-api.gemspec

README.md

Travis-ci

Code Climate

Mirror::Api

Simple Mirror Api client library.

Benefits

  • Robust error handling. You can choose whether to bubble errors or not.
  • Snake case(ruby friendly) notation for requests and responses

Installation

Add this line to your application's Gemfile:

gem 'mirror-api'

And then execute:

$ bundle

Or install it yourself as:

$ gem install mirror-api

Usage

Getting Started

Require the mirror-api gem.

require "mirror-api"

Authenticating your client

token = Mirror::Api::OAuth.new(client_id, client_secret, refresh_token)

api = Mirror::Api::Client.new(token)

Timeline

Listing Timeline items

items = api.timeline.list

Inserting a Timeline item

item_1 = api.timeline.insert({text: "What up WORLD?!?!"})

Inserting a Timeline item with reply actions

item_2 = api.timeline.insert({text: "Do you like tacos?", menu_items:[{action: "REPLY"}]})

Updating a Timeline item

txt = "Seriously, do you like tacos? This is the second time I had to ask you."
item_2 = api.timeline.update(item_2.id, {text: txt, menu_items:[{action: "REPLY"}]})

Patching a Timeline item

item_2 = api.timeline.patch(item_2.id, {text: "You realize you are a bad friend right?", menu_items:[{action: "REPLY"}]})

Getting a Timeline item

api.timeline.get(item_2.id)

Deleting a Timeline item

api.timeline.delete(item_2.id)

Timeline Attachments

Listing Timeline Attachments

attachments = api.timeline.list(item_1.id, {attachments:{}})

Getting a Timeline Attachment

#for the sake of getting an id...
attachment = attachments.items.first
api.timeline.get(item_2.id, {attachments:{id: attachment.id}})

Deleting a Timeline Attachment

api.timeline.delete(item_2.id, {attachments:{id: attachment.id}})

Subscriptions

Listing Subscriptions

subscriptions = api.subscriptions.list

Inserting a Subscription

subscription = api.subscriptions.insert({collection: "timeline", userToken:"user_1", operation: ["UPDATE"], callbackUrl: "https://yourawesomewebsite.com/callback"})

Updating a Subscription

item_2 = api.subscriptions.update(subscription.id, {collection: "timeline", operation: ["UPDATE", "INSERT", "DELETE"], callbackUrl: "https://yourawesomewebsite.com/callback"})

Deleting a Subscription

api.subscriptions.delete(item_2.id)

Locations

Listing Locations

locations = api.locations.list

Getting a Location

#for the sake of getting an id...
location = locations.items.first
api.locations.get(location.id)

Contacts

Listing Contacts

items = api.contacts.list

Inserting a Contact

contact = api.contacts.insert({id: '1234', displayName: 'Troll', imageUrls: ["http://pixelr3ap3r.com/wp-content/uploads/2012/08/357c6328ee4b11e1bfbf22000a1c91a7_7.jpg"]})

Updating a Contact

contact = api.contacts.update(contact.id, {displayName: 'Unicorn'})

Patching a Contact

contact = api.contacts.patch(contact.id, {displayName: 'Grumpy Cat', imageUrls: ["http://blog.catmoji.com/wp-content/uploads/2012/09/grumpy-cat.jpeg"]})

Getting a Contact

api.contacts.get(contact.id)

Deleting a Contact

api.contacts.delete(contact.id)

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
Something went wrong with that request. Please try again.