{"id":39301544,"url":"https://github.com/vhx/vhx-ruby","last_synced_at":"2026-01-18T01:30:29.831Z","repository":{"id":30791493,"uuid":"34348484","full_name":"vhx/vhx-ruby","owner":"vhx","description":"VHX API Client – Ruby","archived":false,"fork":false,"pushed_at":"2020-04-21T17:31:36.000Z","size":149,"stargazers_count":2,"open_issues_count":1,"forks_count":3,"subscribers_count":38,"default_branch":"master","last_synced_at":"2024-03-26T02:56:17.639Z","etag":null,"topics":["ruby","vhx","vhx-api"],"latest_commit_sha":null,"homepage":"","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/vhx.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}},"created_at":"2015-04-21T19:43:30.000Z","updated_at":"2024-03-26T02:56:17.640Z","dependencies_parsed_at":"2022-08-27T13:10:56.745Z","dependency_job_id":null,"html_url":"https://github.com/vhx/vhx-ruby","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/vhx/vhx-ruby","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vhx%2Fvhx-ruby","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vhx%2Fvhx-ruby/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vhx%2Fvhx-ruby/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vhx%2Fvhx-ruby/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vhx","download_url":"https://codeload.github.com/vhx/vhx-ruby/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vhx%2Fvhx-ruby/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28526549,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-18T00:39:45.795Z","status":"ssl_error","status_checked_at":"2026-01-18T00:39:39.467Z","response_time":85,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["ruby","vhx","vhx-api"],"created_at":"2026-01-18T01:30:29.054Z","updated_at":"2026-01-18T01:30:29.820Z","avatar_url":"https://github.com/vhx.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# VHX Ruby API Client\n\nThe VHX API is currently Private Beta.\n\n### Installation\n\n`gem install vhx-ruby`\n\n#### Building Locally\n\n```shell\n$ gem build vhx.gemspec\nSuccessfully built RubyGem\nName: vhx\nVersion: 0.0.0\nFile: vhx-0.0.0.gem\n\n$ gem install vhx-0.0.0.gem\nSuccessfully installed vhx-0.0.0\n1 gem installed\n\n$ irb\nirb(main)\u003e require 'vhx'\n```\n\n#### Running Specs\n\n```shell\nrspec .\n```\n\n#### Publishing to RubyGems\n```shell\ngem push vhx-ruby-#.#.#.gem\n```\n\n### Documentation\n\nFull API reference is available at http://dev.vhx.tv/docs/api?ruby.\n\n## Getting Started\n\nBefore requesting your first resource, you must setup an instance of the Vhx Client:\n\n```ruby\nvhx = Vhx.setup({ api_key: 'your VHX API key' })\n```\n\nHere's an example of creating a Vhx resource with payload options. You can handle errors by rescuing Vhx::VhxError.\n\n```ruby\nbegin\n  # Example Customer Create\n  customer = Vhx::Customer.create({\n    email: 'customer@email.com',\n    name: 'First Last',\n    subscription: 'https://api.vhx.tv/subscriptions/1'\n  })\nrescue Vhx::VhxError\n  # Handle error\nend\n```\n\n### Resources \u0026 methods\n\n customers\n  * [`create`](http://dev.vhx.tv/docs/api?ruby#create_customer)\n  * [`update`](http://dev.vhx.tv/docs/api?ruby#update_customer)\n  * [`retrieve`](http://dev.vhx.tv/docs/api?ruby#retrieve_customer)\n  * [`list`](http://dev.vhx.tv/docs/api?ruby#list_customers)\n\nauthorizations\n  * [`create`](http://dev.vhx.tv/docs/api?ruby#create_authorization)\n\nvideos\n  * [`create`](http://dev.vhx.tv/docs/api?ruby#create_customer)\n  * [`update`](http://dev.vhx.tv/docs/api?ruby#update_customer)\n  * [`retrieve`](http://dev.vhx.tv/docs/api?ruby#retrieve_customer)\n  * [`list`](http://dev.vhx.tv/docs/api?ruby#list_customers)\n\ncollections\n  * [`create`](http://dev.vhx.tv/docs/api?ruby#create_collection)\n  * [`update`](http://dev.vhx.tv/docs/api?ruby#update_collection)\n  * [`retrieve`](http://dev.vhx.tv/docs/api?ruby#retrieve_collection)\n  * [`list`](http://dev.vhx.tv/docs/api?ruby#list_collections)\n  * [`items`](http://dev.vhx.tv/docs/api?ruby#list_collection_items)\n\nanalytics\n  * [`report`](http://dev.vhx.tv/docs/api/?ruby#analytics)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvhx%2Fvhx-ruby","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvhx%2Fvhx-ruby","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvhx%2Fvhx-ruby/lists"}