{"id":19716373,"url":"https://github.com/computestacks/whmcs-ruby","last_synced_at":"2025-09-03T23:42:07.016Z","repository":{"id":152867871,"uuid":"255724150","full_name":"ComputeStacks/whmcs-ruby","owner":"ComputeStacks","description":"WHMCS ruby gem","archived":false,"fork":false,"pushed_at":"2023-05-08T18:19:18.000Z","size":130,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-27T22:04:21.746Z","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/ComputeStacks.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2020-04-14T20:55:55.000Z","updated_at":"2022-04-07T04:44:25.000Z","dependencies_parsed_at":null,"dependency_job_id":"ff994dc8-22ed-4cbc-9461-05768bc120a9","html_url":"https://github.com/ComputeStacks/whmcs-ruby","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/ComputeStacks/whmcs-ruby","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ComputeStacks%2Fwhmcs-ruby","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ComputeStacks%2Fwhmcs-ruby/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ComputeStacks%2Fwhmcs-ruby/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ComputeStacks%2Fwhmcs-ruby/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ComputeStacks","download_url":"https://codeload.github.com/ComputeStacks/whmcs-ruby/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ComputeStacks%2Fwhmcs-ruby/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273529240,"owners_count":25121823,"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-09-03T02:00:09.631Z","response_time":76,"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":[],"created_at":"2024-11-11T22:41:55.527Z","updated_at":"2025-09-03T23:42:06.976Z","avatar_url":"https://github.com/ComputeStacks.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# WHMCS Billing Plugin for ComputeStacks\n\n## Overview\n\n* `User.external_id` = `serviceid` in WHMCS\n* Uses the following labels:\n    * `{ 'whmcs' =\u003e { 'client_id' =\u003e '', 'service_id' =\u003e '' } }`\n* 1 account in CS = 1 account in WHMCS\n* When enabling, it will automatically disable user registration. However, you can manually re-enable that.\n\n## WHMCS API Credentials\n\nWhen generating API Credentials, here are a list of all the required actions:\n\n* `Billing -\u003e AddBillableItem`\n* `Client -\u003e GetClients`\n* `Client -\u003e GetClientsDetails`\n* `Client -\u003e GetClientsProducts`\n* `Products -\u003e GetProducts`\n* `Products -\u003e UpdateClientProduct`\n* `Servers -\u003e GetHealthStatus`\n* `Servers -\u003e WhmcsDetails`\n\n## Development\n\nAfter checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.\n\nTo install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).\n\n### Environmental Variables\n\nWe use [direnv](https://direnv.net/) to manage our env file, alternatively you can manually export the variables. See `envrc.sample` for details.\n\nUsing _direnv_, you can:\n\n* `mv envrc.sample .envrc` and adjust accordingly\n* run `direnv allow .`\n\n### Running Tests\n\n`bundle exec rake test`\n\n#### WHMCS Test Setup\n\n1. Create cpanel server with hostname: `mycpanelserver.net` -- doesn't have to actually exist.\n\n2. Create server group and assign server\n\n3. Create product assigned to previously created server group (under modules)\n\n4. Create user with email jane.doe@example.com. Record `userid` as `WHMCS_TEST_USER_ID`.\n\n5. Add new order for user (skip invoice, emails, etc) and accept order. Set username to `jane.doe3-10@demo.computestacks.net`.\n\n6. Record `serviceid` in your `.env` file for `WHMCS_TEST_SERVICE_ID`.\n\n_Be sure to delete the billable items after you run the tests. There is no WHMCS api to do that automatically._\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcomputestacks%2Fwhmcs-ruby","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcomputestacks%2Fwhmcs-ruby","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcomputestacks%2Fwhmcs-ruby/lists"}