A Ruby wrapper for the Zenodo API.
Add this line to your application's Gemfile:
gem 'zenodo'And then execute:
$ bundle
Or install it yourself as:
$ gem install zenodo
Due to the use of keyword arguments this gem requires Ruby 2.0 and above.
This gem uses VCR for testing. https://github.com/vcr/vcr
To run gem tests complete the following:
- Obtain a Zenodo API token from their site. https://zenodo.org.
- Create file gem_secret.yml in the gems config folder.
- Add the following to your gem_secret.yml file.
zenodo_api_key: '<YOUR API TOKEN>' - Run rspec as normal.
VCR will create fixtures in the spec/fixtures/vcr_cassettes folder.
Set the client API key.
Zenodo.api_key = <your API key>
Get depositions.
depositions = Zenodo.client.get_depositions
Get a deposition.
deposition = Zenodo.client.get_deposition(id: 1)
Create a deposition.
# Build JSON serialized attributes.
# The gem won't do this for you. You need to build a serializer that meets your needs."
deposition_attributes = {
'metadata' => {
'title' => 'My first upload',
'upload_type' => 'poster',
'description' => 'This is my first upload',
'creators' =>[{'name' => 'Doe, John','affiliation' => 'ZENODO'}]
}
}
# Create the deposition.
deposition = Zenodo.client.create_deposition(deposition: deposition_attributes)
Update a deposition.
# Build JSON serialized attributes.
# The gem won't do this for you. You need to build a serializer that meets your needs."
# deposition_attributes = <same as create>
# Update the deposition.
deposition = Zenodo.client.update_deposition(id: 1, deposition: deposition_attributes)
Delete a deposition.
Zenodo.client.delete_deposition(id: 1)
- Fork it ( https://github.com/sprotocols/zenodo/fork )
- 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 a new Pull Request
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent