{"id":18469938,"url":"https://github.com/civo/client-rubygem","last_synced_at":"2025-10-07T01:55:57.398Z","repository":{"id":2513968,"uuid":"46556190","full_name":"civo/client-rubygem","owner":"civo","description":"Ruby gem to interact with Civo's API","archived":false,"fork":false,"pushed_at":"2025-03-25T21:05:21.000Z","size":243,"stargazers_count":4,"open_issues_count":0,"forks_count":4,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-08-20T04:46:19.986Z","etag":null,"topics":["civo-api","cloud","rails","ruby","rubygem"],"latest_commit_sha":null,"homepage":"https://www.civo.com/","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/civo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"MIT-LICENSE","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":"2015-11-20T10:44:04.000Z","updated_at":"2025-03-25T21:05:26.000Z","dependencies_parsed_at":"2024-01-12T20:53:38.820Z","dependency_job_id":"4a26ccd2-a928-4c45-aaa5-a5dfe71b618d","html_url":"https://github.com/civo/client-rubygem","commit_stats":{"total_commits":226,"total_committers":9,"mean_commits":25.11111111111111,"dds":"0.26991150442477874","last_synced_commit":"b02f913c86efcc190092162144786f64f00abce7"},"previous_names":["absolutedevops/civo-ruby"],"tags_count":59,"template":false,"template_full_name":null,"purl":"pkg:github/civo/client-rubygem","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/civo%2Fclient-rubygem","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/civo%2Fclient-rubygem/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/civo%2Fclient-rubygem/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/civo%2Fclient-rubygem/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/civo","download_url":"https://codeload.github.com/civo/client-rubygem/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/civo%2Fclient-rubygem/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278708025,"owners_count":26031932,"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","status":"online","status_checked_at":"2025-10-06T02:00:05.630Z","response_time":65,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["civo-api","cloud","rails","ruby","rubygem"],"created_at":"2024-11-06T10:12:11.732Z","updated_at":"2025-10-07T01:55:57.366Z","avatar_url":"https://github.com/civo.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Civo Ruby API Library\n\nThis project is the Ruby API library for using in Rails projects.\n\n## Command-Line Interface\n\nIf you are wanting to use the [Civo command line interface](https://github.com/civo/cli), that's a separate project. However, as a brief quick-start, all you need to do is [install it](http://rubygems.org/gems/civo_cli), configure it with the token supplied when you signed up for your Civo account and you're ready to go:\n\n```sh\ngem install civo_cli\ncivo tokens:save default my_api_key_from_api_dot_civo_dot_com_goes_here\n```\n\n## API Library\n\nTo use the library in your own Rails (or Sinatra, etc) projects you can just add it to the Gemfile:\n\n```ruby\ngem 'civo'\n```\n\nInstall the gem:\n\n```sh\nbundle install\n```\n\nYou need to define in an intializer, Heroku config or `.env` file `ENV[\"CIVO_TOKEN\"]` and `ENV[\"CIVO_URL\"]` and these will be picked up by the classes.\n\nThen you can use classes like this:\n\n```ruby\nsize = Civo::Size.all.first\nregion = Civo::Region.all.first.code\ntemplate = Civo::Template.all.first.id\nCivo::SshKey.create(name: \"default\", public_key: File.read(\"~/.ssh/id_dsa.pub\"))\n\ninstance = Civo::Instance.create(hostname: \"text.example.com\", size: size, region: region,\n  template: template, public_ip: true, ssh_key: \"default\")\n```\n\nThe API library consists of a handful of [Flexirest](https://github.com/andyjeffries/flexirest) classes that implement the Civo API. There is full documentation on the API available at https://api.civo.com/.\n\n## API Version 1\n\nIf you are hitting an old legacy v1 API (i.e. not running against api.civo.com), you'd need to make the following changes:\n\n1. Set `ENV[\"CIVO_API_VERSION\"]` to be `1` in your initializer\n2. While legacy tokens are usable in v1 API servers at the moment, in the future this will change to be an administrator API key and secret.  More to follow...\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcivo%2Fclient-rubygem","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcivo%2Fclient-rubygem","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcivo%2Fclient-rubygem/lists"}