{"id":15293343,"url":"https://github.com/renehernandez/camper","last_synced_at":"2025-04-13T13:31:48.829Z","repository":{"id":38848932,"uuid":"273237933","full_name":"renehernandez/camper","owner":"renehernandez","description":"Ruby API client for Basecamp 3 API","archived":false,"fork":false,"pushed_at":"2023-01-24T04:01:27.000Z","size":227,"stargazers_count":6,"open_issues_count":13,"forks_count":4,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-17T20:57:09.212Z","etag":null,"topics":["api","basecamp3","gem","ruby"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/renehernandez.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-06-18T12:55:01.000Z","updated_at":"2022-10-19T06:26:51.000Z","dependencies_parsed_at":"2023-02-13T16:31:11.148Z","dependency_job_id":null,"html_url":"https://github.com/renehernandez/camper","commit_stats":null,"previous_names":["renehernandez/camp3"],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/renehernandez%2Fcamper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/renehernandez%2Fcamper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/renehernandez%2Fcamper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/renehernandez%2Fcamper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/renehernandez","download_url":"https://codeload.github.com/renehernandez/camper/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247737787,"owners_count":20987735,"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":["api","basecamp3","gem","ruby"],"created_at":"2024-09-30T16:46:22.994Z","updated_at":"2025-04-13T13:31:43.820Z","avatar_url":"https://github.com/renehernandez.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# camper ![CI](https://github.com/renehernandez/camper/workflows/CI/badge.svg) [![Gem Version](https://badge.fury.io/rb/camper.svg)](https://badge.fury.io/rb/camper)\n\nCamper is a Ruby wrapper for the [Basecamp 3 API](https://github.com/basecamp/bc3-api).\n\nYou can check out the gem documentation at [https://www.rubydoc.org/gems/camper](https://www.rubydoc.org/gems/camper)\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'camper'\n```\n\nAnd then execute:\n\n```bash\n$ bundle\n```\n\nOr install it yourself as:\n\n```bash\n$ gem install camper\n```\n\n## Status of API endpoints\n\nThe up-to-date list of Basecamp API endpoints can be found at [here](https://github.com/basecamp/bc3-api#api-endpoints).\n\nCurrently, Camper supports the following endpoints:\n\n* [Comments](https://github.com/basecamp/bc3-api/blob/master/sections/comments.md): Implementation at [comments.rb](https://github.com/renehernandez/camper/blob/main/lib/camper/api/comments.rb) (Complete)\n* [Message Types](https://github.com/basecamp/bc3-api/blob/master/sections/message_types.md): Implementation at [messages.rb](https://github.com/renehernandez/camper/blob/main/lib/camper/api/message_types.rb) (Complete)\n* [Message Boards](https://github.com/basecamp/bc3-api/blob/master/sections/message_boards.md): Implementation at [message_boards.rb](https://github.com/renehernandez/camper/blob/main/lib/camper/api/message_boards.rb) (Complete)\n* [Messages](https://github.com/basecamp/bc3-api/blob/master/sections/messages.md): Implementation at [messages.rb](https://github.com/renehernandez/camper/blob/main/lib/camper/api/messages.rb) (Complete)\n* [People](https://github.com/basecamp/bc3-api/blob/master/sections/people.md): Implementation at [people.rb](https://github.com/renehernandez/camper/blob/main/lib/camper/api/people.rb) (Complete)\n* [Projects](https://github.com/basecamp/bc3-api/blob/master/sections/projects.md): Implementation at [projects.rb](https://github.com/renehernandez/camper/blob/main/lib/camper/api/projects.rb) (Complete)\n* [Recordings](https://github.com/basecamp/bc3-api/blob/master/sections/recordings.md): Implementation at [recordings.rb](https://github.com/renehernandez/camper/blob/main/lib/camper/api/recordings.rb) (Complete)\n* [To-do list](https://github.com/basecamp/bc3-api/blob/master/sections/todolists.md): Implementation at [todolists.rb](https://github.com/renehernandez/camper/blob/main/lib/camper/api/todolists.rb) (Complete)\n* [To-dos](https://github.com/basecamp/bc3-api/blob/master/sections/todos.md): Implementation at [todos.rb](https://github.com/renehernandez/camper/blob/main/lib/camper/api/todos.rb) (Complete)\n\n## Usage\n\n### Configuration\n\nGetting a `client` and configuring it:\n\n```ruby\nrequire 'camper'\n\nclient = Camper.client\n\nclient.configure do |config|\n  config.client_id = 'client_id'\n  config.client_secret = 'client_secret'\n  config.account_number = 'account_number'\n  config.refresh_token = 'refresh_token'\n  config.access_token = 'access_token'\nend\n```\n\nAlternatively, it is possible to invoke the top-level `#configure` method to get a `client`:\n\n```ruby\nrequire 'camper'\n\nclient = Camper.configure do |config|\n  config.client_id = 'client_id'\n  config.client_secret = 'client_secret'\n  config.account_number = 'account_number'\n  config.refresh_token = 'refresh_token'\n  config.access_token = 'access_token'\nend\n```\n\nAlso, the `client` can read directly the following environment variables:\n\n* `BASECAMP_CLIENT_ID`\n* `BASECAMP_CLIENT_SECRET`\n* `BASECAMP_ACCOUNT_NUMBER`\n* `BASECAMP_REFRESH_TOKEN`\n* `BASECAMP_ACCESS_TOKEN`\n\nthen the code would look like:\n\n```ruby\nrequire 'camper'\n\nclient = Camper.client\n```\n\n\n### Examples\n\nExample getting list of TODOs:\n\n```ruby\nrequire 'camper'\n\nclient = Camper.configure do |config|\n  config.client_id = ENV['BASECAMP_CLIENT_ID']\n  config.client_secret = ENV['BASECAMP_CLIENT_SECRET']\n  config.account_number = ENV['BASECAMP_ACCOUNT_NUMBER']\n  config.refresh_token = ENV['BASECAMP_REFRESH_TOKEN']\n  config.access_token = ENV['BASECAMP_ACCESS_TOKEN']\nend\n\n# gets a paginated response\nprojects = client.projects\n\n# iterate all projects\nprojects.auto_paginate do |p|\n  puts \"Project: #{p.inspect}\"\n\n  puts \"Todo set: #{p.todoset.inspect}\"\n\n  todoset = client.todoset(p)\n\n  # iterate over the first 5 todo lists\n  client.todolists(todoset).auto_paginate(5) do |list|\n    puts \"Todolist: #{list.title}\"\n\n    client.todos(list).auto_paginate do |todo|\n      puts todo.inspect\n    end\n  end\nend\n```\n\nFor more examples, check out the [examples](examples/) folder\n\n## Contributing\n\nCheck out the [Contributing](CONTRIBUTING.md) page.\n\n## Changelog\n\nFor inspecting the changes and tag releases, check the [Changelog](CHANGELOG.md) page\n\n## Appreciation\n\nThe gem code structure and documentation is based on the awesome [NARKOZ/gitlab gem](https://github.com/narkoz/gitlab)\n\n## License\n\nCheckout the [LICENSE](LICENSE) for details\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frenehernandez%2Fcamper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frenehernandez%2Fcamper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frenehernandez%2Fcamper/lists"}