{"id":26662858,"url":"https://github.com/speciesfilegroup/bark","last_synced_at":"2025-03-25T14:18:45.431Z","repository":{"id":20437226,"uuid":"23714007","full_name":"SpeciesFileGroup/bark","owner":"SpeciesFileGroup","description":"A Ruby Gem wrapper on the Open Tree of Life API.","archived":false,"fork":false,"pushed_at":"2017-06-23T18:55:29.000Z","size":34,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-04-26T09:46:32.900Z","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":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SpeciesFileGroup.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-09-05T18:34:02.000Z","updated_at":"2017-06-23T18:55:31.000Z","dependencies_parsed_at":"2022-07-31T19:48:09.424Z","dependency_job_id":null,"html_url":"https://github.com/SpeciesFileGroup/bark","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/SpeciesFileGroup%2Fbark","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpeciesFileGroup%2Fbark/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpeciesFileGroup%2Fbark/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpeciesFileGroup%2Fbark/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SpeciesFileGroup","download_url":"https://codeload.github.com/SpeciesFileGroup/bark/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245476707,"owners_count":20621699,"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":"2025-03-25T14:18:44.864Z","updated_at":"2025-03-25T14:18:45.403Z","avatar_url":"https://github.com/SpeciesFileGroup.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"bark\n====\n\n[![Continuous Integration Status][6]][7]\n[![Dependency Status][8]][9]\n[rubydoc][1]\n\nBark is a Ruby Gem wrapper on the [Open Tree of Life API][3]. It was written over the course of the [OpenTree hackathon][2]  At present it seeks to provide a simple (level 1 in terms of hackathon speak) wrapper over all of the API calls available, returning a native json object for each response. It also acts as a sanity checker on the API calls themselves, running a suite of unit tests shared by related wrappers in [Python][5] and [R][4].\n\n## Installation\n\nBark is written targetting Ruby 2.1.x.\n\nAdd this line to your application's Gemfile:\n\n    gem 'bark'\n\nAnd then execute:\n\n    $ bundle\n\nOr install it yourself as:\n\n    $ gem install bark\n\n## Usage\n\nBark is broken down into Request and Response objects.  These are additionally wrapped with a set of helper methods that map 1:1 with the [Open Tree URLs][3].  Binding method names [follow a convention][10] adopted by the related Python and R frameworks.\n\nIn your script:\n\n```\n  require 'bark'  # =\u003e true\n```\n\n### Simple usage\n\n```ruby\n  Bark.tol_about  # =\u003e { big hash }\n```\n\nPass parameters like so:\n\n```ruby\n  Bark.get_study(params: {:study_id =\u003e '2113'})   # =\u003e {big json response}\n```\n\nParameter keys can be symbols or strings. Available methods [are listed here][10].\n\n### Request/Response style\n\n```ruby\n    request = Bark::Request::Studies.new(method: :get_study, params: {study_id: '2113'})  # =\u003e #\u003cBark::Request::Studies:0x0000010310d340 @method=:get_study, @params={:study_id=\u003e\"2113\"}, @uri=#\u003cURI::HTTP:0x0000010310c508 URL:https://devapi.opentreeoflife.org/v2/study/2113\u003e\u003e \n```\n\nPre-check the validity of the requst (NOTE: mapping/checking is in development)\n\n```ruby\n    request.valid? # =\u003e true \n```\n\nGet a response:\n\n```ruby\n    response = Bark::Response.new(request: request)  # =\u003e  #\u003cBark::Response:0x0000010334c138 @json={ ... big response ... }\n    response.json   # =\u003e  { ... big response ... }\n``` \n\n## Documentation\n\nDocumentation is autogenerated at [RubyDoc.info][1]\n\n## Contributing\n\n1. Fork it ( http://github.com/SpeciesFileGroup/bark/fork )\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create new Pull Request\n\n## Licence\n\nBark is open source, it is available under the BSD licence.\n\n[1]: http://rubydoc.info/github/SpeciesFileGroup/bark/frames\n[2]: https://github.com/OpenTreeOfLife/hackathon  \n[3]: https://github.com/OpenTreeOfLife/opentree/wiki/Open-Tree-of-Life-APIs\n[4]: https://github.com/fmichonneau/rotl\n[5]: https://github.com/OpenTreeOfLife/opentree-interfaces\n[6]: https://secure.travis-ci.org/SpeciesFileGroup/bark.png?branch=master\n[7]: http://travis-ci.org/SpeciesFileGroup/bark?branch=master\n[8]: https://gemnasium.com/SpeciesFileGroup/bark.png?branch=master\n[9]: https://gemnasium.com/SpeciesFileGroup/bark?branch=master\n[10]: https://github.com/OpenTreeOfLife/opentree/wiki/Libraries-for-working-with-opentree-in-various-languages-%28service-bindings-and-wrappers,-etc.%29\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspeciesfilegroup%2Fbark","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fspeciesfilegroup%2Fbark","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspeciesfilegroup%2Fbark/lists"}