{"id":19351707,"url":"https://github.com/operable/cog-api-client","last_synced_at":"2025-07-15T10:45:56.532Z","repository":{"id":78638140,"uuid":"53512499","full_name":"operable/cog-api-client","owner":"operable","description":null,"archived":false,"fork":false,"pushed_at":"2017-03-28T14:11:48.000Z","size":563,"stargazers_count":1,"open_issues_count":1,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-24T10:36:47.557Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Elixir","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/operable.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":"2016-03-09T16:19:17.000Z","updated_at":"2020-01-12T04:02:18.000Z","dependencies_parsed_at":null,"dependency_job_id":"a672cca7-5b7f-41fd-8079-cf2741a0f4b1","html_url":"https://github.com/operable/cog-api-client","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"purl":"pkg:github/operable/cog-api-client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/operable%2Fcog-api-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/operable%2Fcog-api-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/operable%2Fcog-api-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/operable%2Fcog-api-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/operable","download_url":"https://codeload.github.com/operable/cog-api-client/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/operable%2Fcog-api-client/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265429326,"owners_count":23763729,"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":"2024-11-10T04:36:59.649Z","updated_at":"2025-07-15T10:45:56.485Z","avatar_url":"https://github.com/operable.png","language":"Elixir","funding_links":[],"categories":[],"sub_categories":[],"readme":"# CogApi\n\n[![Build Status](https://travis-ci.org/operable/cog-api-client.svg?branch=master)](https://travis-ci.org/operable/cog-api-client)\n[![Coverage Status](https://coveralls.io/repos/github/operable/cog-api-client/badge.svg?branch=master)](https://coveralls.io/github/operable/cog-api-client?branch=master)\n\n## Installation\n1. Add cog_api to your list of dependencies in `mix.exs`:\n\n```elixir\n  {:cog_api, github: \"operable/cog-api-client\"},\n```\n\n2. Ensure cog_api is started before your application:\n\n```elixir\n  def application do\n    [applications: [:cog_api]]\n  end\n```\n\n## Stucture\n\nThere are two main areas of CogApi.\n\n### CogApi.HTTP.Client\n\nThis is the primary client that is recommended for usage. This is being tested\nas it is updated.\n\nAlongside this, there is a `CogApi.Fake.Client`.\nThis is designed for testing\nand local development purposes.\nThe API for `Fake.Client`\nand `HTTP.Client`\nare designed to be identical.\nIf it functions in `Fake`\nit should function the same in `HTTP`.\n\nWhen adding anything to `HTTP.Client` and `HTTP.Fake`, please:\n\n* Ensure that there are tests for the functionality\n* Update the CHANGELOG.md with any changes\n* Ensure that `CogApi.Client` is updated with the proper `@callback` so that we\n  can ensure that the `Fake` and `HTTP` are in sync.\n\n### CogApi.HTTP.Internal\n\nThis client is for use only in `cogctl`.\nDo not touch this!\nIt is also not recommended for external users to use this module.\n\nEventually `cogctl` will switch to using the `HTTP.Client`\nand `Internal` will be removed.\n\n## Tests\n\nTests and static analysis can be run with:\n\n```\nbin/test_suite\n```\n\nIf tests fail, the script will not perform static analysis.\n\nRun only tests with: `mix test`\n\nExVcr tests are executed against a local installation of Cog using user \"admin\"\nwith the password set to \"password\". When making a change to the API, you can\nrecord new cassettes by deleting the files you wish to regenerate and run the tests.\nBe sure to bootstrap a clean instance of Cog when doing so.\n\n## Static Analysis\n\nRun `mix dialyzer` to run analysis. If your dependencies or your elixir version\nchange, run `bin/rebuild_plt`.\n\nNote: `dialyzer` requires Elixir v1.2.3 to work properly.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foperable%2Fcog-api-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foperable%2Fcog-api-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foperable%2Fcog-api-client/lists"}