BibSonomy client for Ruby
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
test
.gitignore
.travis.yml
Gemfile
LICENSE
README.md
Rakefile
bibsonomy.gemspec

README.md

BibSonomy

BibSonomy client for Ruby

Gem Version Build Status Coverage Status

Installation

Add this line to your application's Gemfile:

gem 'bibsonomy'

And then execute:

$ bundle

Or install it yourself as:

$ gem install bibsonomy

Usage

Getting posts from BibSonomy:

require 'bibsonomy'
api = BibSonomy::API.new('yourusername', 'yourapikey', 'ruby')
posts = api.get_posts_for_user('jaeschke', 'publication', ['myown'], 0, 20)

Rendering posts with CSL:

require 'bibsonomy/csl'
csl = BibSonomy::CSL.new('yourusername', 'yourapikey')
html = csl.render('jaeschke', ['myown'], 100)
print html

A command line wrapper to the CSL renderer:

#!/usr/bin/ruby
require 'bibsonomy/csl'
print BibSonomy::main(ARGV)

Testing

Get an API-Key from http://www.bibsonomy.org/settings?selTab=1 and then run the following commands:

export BIBSONOMY_USER_NAME="yourusername"
export BIBSONOMY_API_KEY="yourapikey"
bundle exec rake test

Supported API Calls

Jekyll

This gem is used by the BibSonomy plugin for Jekyll to render post lists in Jekyll web sites. For an example output, have a look at my publication list.

Contributing

  1. Fork it ( https://github.com/rjoberon/bibsonomy-ruby/fork )
  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 a new Pull Request