Livefyre Ruby Utility Classes
Livefyre's official library for common server-side tasks necessary for getting Livefyre apps (comments, reviews, etc.) working on your website.
Installation
Add this line to your application's Gemfile:
gem 'livefyre'
Or install it yourself:
$ gem install livefyre
Usage
Instantiating a network object:
network = Livefyre.get_network('network_name', 'network_key')
Building a Livefyre token:
network.build_livefyre_token
Building a user auth token:
network.build_user_auth_token('user_id', 'display_name', expires)
To validate a Livefyre token:
network.validate_livefyre_token('lf_token')
To send Livefyre a user sync url and then have Livefyre pull user data from that url:
network.set_user_sync_url('url_template')
network.sync_user('user_id')
Instantiating a site object:
site = network.get_site('site_id', 'site_key')
Building a collection meta token: The options argument is optional.
site.build_collection_meta_token('title', 'article_id', 'url', {options})
Building a checksum: The 'tags' argument is optional.
site.build_checksum('title', 'url', 'tags')
To retrieve content collection data:
site.get_collection_content('article_id')
To get a content collection's id:
site.get_collection_id('article_id')
Additional Documentation
Located here.
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request
Note: any feature update on any of Livefyre's libraries will need to be reflected on all language libraries. We will try and accommodate when we find a request useful, but please be aware of the time it may take.
License
MIT