{"id":20566170,"url":"https://github.com/aces/zenodo-client-gem","last_synced_at":"2025-03-06T08:46:37.248Z","repository":{"id":139175347,"uuid":"211143483","full_name":"aces/zenodo-client-gem","owner":"aces","description":"A Ruby gem implementing the Zenodo API.","archived":false,"fork":false,"pushed_at":"2024-06-05T15:00:50.000Z","size":52,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-01-16T20:18:47.593Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aces.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-09-26T17:19:56.000Z","updated_at":"2024-06-05T15:00:55.000Z","dependencies_parsed_at":null,"dependency_job_id":"97861650-e3ec-4608-92f6-885123e6c87f","html_url":"https://github.com/aces/zenodo-client-gem","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aces%2Fzenodo-client-gem","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aces%2Fzenodo-client-gem/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aces%2Fzenodo-client-gem/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aces%2Fzenodo-client-gem/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aces","download_url":"https://codeload.github.com/aces/zenodo-client-gem/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242179256,"owners_count":20084940,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-16T04:40:18.540Z","updated_at":"2025-03-06T08:46:37.221Z","avatar_url":"https://github.com/aces.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# zenodo_client\n\nZenodoClient - the Ruby gem for the Zenodo API\n\nThis is for the zenodo API http://developers.zenodo.org/#rest-api\n\nThis SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:\n\n- API version: 1.0.0\n- Package version: 1.0.0\n- Build package: io.swagger.codegen.languages.RubyClientCodegen\nFor more information, please visit [https://github.com/aces/zenodo-client-gem](https://github.com/aces/zenodo-client-gem)\n\nThe Swagger 2.0 API description was created by Pierre Rioux (pierre.rioux@mcgill.ca); the\ndescription is available on [SwaggerHub](https://app.swaggerhub.com/apis/prioux/Zenodo/1.0.0)\nand is also available in this repo in the file [zenodo_1.0.0.yaml](https://github.com/aces/zenodo-client-gem/blob/master/zenodo_1.0.0.yaml)\n\n## Installation\n\n### Build a gem\n\nTo build the Ruby code into a gem:\n\n```shell\ngem build zenodo_client.gemspec\n```\n\nThen either install the gem locally:\n\n```shell\ngem install ./zenodo_client-1.0.0.gem\n```\n(for development, run `gem install --dev ./zenodo_client-1.0.0.gem` to install the development dependencies)\n\nor publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).\n\nFinally add this to the Gemfile:\n\n    gem 'zenodo_client', '~\u003e 1.0.0'\n\n### Install from Git\n\nIf the Ruby gem is hosted at a git repository: https://github.com/aces/zenodo-client-gem, then add the following in the Gemfile:\n\n    gem 'zenodo_client', :git =\u003e 'https://github.com/aces/zenodo-client-gem.git'\n\n### Include the Ruby code directly\n\nInclude the Ruby code directly using `-I` as follows:\n\n```shell\nruby -Ilib script.rb\n```\n\n## Getting Started\n\nPlease follow the [installation](#installation) procedure and then run the following code:\n```ruby\n# Load the gem\nrequire 'zenodo_client'\n\n# Setup authorization\nZenodoClient.configure do |config|\n  # Configure API key authorization: access_token\n  config.api_key['access_token'] = 'YOUR API KEY'\n  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)\n  #config.api_key_prefix['access_token'] = 'Bearer'\nend\n\napi_instance = ZenodoClient::ActionsApi.new\n\ndeposit_id = 56 # Integer | \n\n\nbegin\n  #Discard changes in the current editing session.\n  result = api_instance.discard_deposit(deposit_id)\n  p result\nrescue ZenodoClient::ApiError =\u003e e\n  puts \"Exception when calling ActionsApi-\u003ediscard_deposit: #{e}\"\nend\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://sandbox.zenodo.org/api*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*ZenodoClient::ActionsApi* | [**discard_deposit**](docs/ActionsApi.md#discard_deposit) | **POST** /deposit/depositions/{depositId}/actions/discard | Discard changes in the current editing session.\n*ZenodoClient::ActionsApi* | [**edit_deposit**](docs/ActionsApi.md#edit_deposit) | **POST** /deposit/depositions/{depositId}/actions/edit | Unlock already submitted deposition for editing.\n*ZenodoClient::ActionsApi* | [**new_deposit_version**](docs/ActionsApi.md#new_deposit_version) | **POST** /deposit/depositions/{depositId}/actions/newversion | Create a new version of a deposition.\n*ZenodoClient::ActionsApi* | [**publish_deposit**](docs/ActionsApi.md#publish_deposit) | **POST** /deposit/depositions/{depositId}/actions/publish | Publish a deposition. Note, once a deposition is published, you can no longer delete it.\n*ZenodoClient::DepositsApi* | [**create_deposit**](docs/DepositsApi.md#create_deposit) | **POST** /deposit/depositions | Create a new deposit\n*ZenodoClient::DepositsApi* | [**delete_deposit**](docs/DepositsApi.md#delete_deposit) | **DELETE** /deposit/depositions/{depositId} | Delete deposit\n*ZenodoClient::DepositsApi* | [**get_deposit**](docs/DepositsApi.md#get_deposit) | **GET** /deposit/depositions/{depositId} | Get deposit\n*ZenodoClient::DepositsApi* | [**list_deposits**](docs/DepositsApi.md#list_deposits) | **GET** /deposit/depositions | List of deposits\n*ZenodoClient::DepositsApi* | [**put_deposit**](docs/DepositsApi.md#put_deposit) | **PUT** /deposit/depositions/{depositId} | Put deposit\n*ZenodoClient::FilesApi* | [**create_file**](docs/FilesApi.md#create_file) | **POST** /deposit/depositions/{depositId}/files | Create a new file\n*ZenodoClient::FilesApi* | [**delete_file**](docs/FilesApi.md#delete_file) | **DELETE** /deposit/depositions/{depositId}/files/{fileId} | Delete an existing deposition file resource. Note, only deposition files for unpublished depositions may be deleted.\n*ZenodoClient::FilesApi* | [**get_file**](docs/FilesApi.md#get_file) | **GET** /deposit/depositions/{depositId}/files/{fileId} | Retrieve a single deposition file.\n*ZenodoClient::FilesApi* | [**list_files_for_deposit**](docs/FilesApi.md#list_files_for_deposit) | **GET** /deposit/depositions/{depositId}/files | List of files for deposit\n*ZenodoClient::FilesApi* | [**sort_files**](docs/FilesApi.md#sort_files) | **PUT** /deposit/depositions/{depositId}/files | Sort the files for a deposit\n*ZenodoClient::FilesApi* | [**update_file**](docs/FilesApi.md#update_file) | **PUT** /deposit/depositions/{depositId}/files/{fileId} | Update a deposition file resource. Currently the only use is renaming an already uploaded file. If you want to replace the actual file, please delete the file and upload a new file.\n*ZenodoClient::PreviewApi* | [**list_communities**](docs/PreviewApi.md#list_communities) | **GET** /communities | List of communities\n*ZenodoClient::PreviewApi* | [**list_funders**](docs/PreviewApi.md#list_funders) | **GET** /funders | List of funders\n*ZenodoClient::PreviewApi* | [**list_grants**](docs/PreviewApi.md#list_grants) | **GET** /grants | List of grants\n*ZenodoClient::PreviewApi* | [**list_licenses**](docs/PreviewApi.md#list_licenses) | **GET** /licenses | List of licenses\n*ZenodoClient::PreviewApi* | [**list_records**](docs/PreviewApi.md#list_records) | **GET** /records | List of records\n\n\n## Documentation for Models\n\n - [ZenodoClient::Author](docs/Author.md)\n - [ZenodoClient::Community](docs/Community.md)\n - [ZenodoClient::Contributor](docs/Contributor.md)\n - [ZenodoClient::Deposit](docs/Deposit.md)\n - [ZenodoClient::DepositMetadata](docs/DepositMetadata.md)\n - [ZenodoClient::DepositionFile](docs/DepositionFile.md)\n - [ZenodoClient::Grant](docs/Grant.md)\n - [ZenodoClient::NestedDepositMetadata](docs/NestedDepositMetadata.md)\n - [ZenodoClient::RelatedIdentifier](docs/RelatedIdentifier.md)\n - [ZenodoClient::Subject](docs/Subject.md)\n\n\n## Documentation for Authorization\n\n\n### access_token\n\n- **Type**: API key\n- **API key parameter name**: access_token\n- **Location**: URL query string\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faces%2Fzenodo-client-gem","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faces%2Fzenodo-client-gem","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faces%2Fzenodo-client-gem/lists"}