{"id":18328036,"url":"https://github.com/microwaves/ccu-tool","last_synced_at":"2025-04-09T16:51:25.102Z","repository":{"id":77633909,"uuid":"107288625","full_name":"microwaves/ccu-tool","owner":"microwaves","description":"Ruby bindings and CLI to interact with the Akamai CCU API","archived":false,"fork":false,"pushed_at":"2017-10-17T16:04:45.000Z","size":5,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-15T10:16:27.300Z","etag":null,"topics":["akamai","akamai-api","cdn","devops","ruby"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/microwaves.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"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":"2017-10-17T15:33:07.000Z","updated_at":"2017-10-17T16:01:30.000Z","dependencies_parsed_at":"2023-06-01T04:00:10.378Z","dependency_job_id":null,"html_url":"https://github.com/microwaves/ccu-tool","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microwaves%2Fccu-tool","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microwaves%2Fccu-tool/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microwaves%2Fccu-tool/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microwaves%2Fccu-tool/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/microwaves","download_url":"https://codeload.github.com/microwaves/ccu-tool/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248072932,"owners_count":21043335,"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":["akamai","akamai-api","cdn","devops","ruby"],"created_at":"2024-11-05T19:12:59.085Z","updated_at":"2025-04-09T16:51:25.077Z","avatar_url":"https://github.com/microwaves.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ccu-tool\n\nccu-tool provides ruby bindings and a CLI to easily interact with the Akamai CCU API(the API used for cache invalidation).\n\n## API\n\nCurrently there are bindings for the three methods provided by the CCU API v2.\n\n- POST `/ccu/v2/queues/\u003cqueue_name\u003e`: Sends a purge request to the queue, containing the desired objects in JSON format.\n- GET `/ccu/v2/queues/\u003cqueue_name\u003e`: Gets the length of the queue, informing the objects to be purged.\n- GET `/ccu/v2/purges/\u003cpurge_id\u003e`: Gets the status of a previous purge request.\n\n## Dependencies\n\nBefore start to use the Library or the CLI tool, it's necessary to install the required dependencies.\n\nInstall [httpie](https://github.com/jkbrzt/httpie), on Debian-based systems the following installation should satisfy the dependencies.\n\n```\n$ sudo apt-get install httpie\n```\n\nAnd on Red Hat-based systems:\n\n```\n$ sudo yum install httpie\n```\n\nAfter the system dependencies were installed, you may now proceed to the Akamai's httpie plugin installation.\n\n```\n$ pip install httpie-edgegrid\n```\n\n## Configuration\n\nCreate the `~/.edgerc` file containing the credentials for the API access(provided by Akamai).\n\n## CLI tool usage\n\nAs the `--help` option suggests:\n\n```\n$ ccu-tool --help\nUsage: ccu-tool [option] [argument]\n    -a, --arl-purge x,y,z            Send purge request for the desired objects based on ARL\n    -c, --cp-purge x,y,z             Send purge request for the desired objects based on CP codes\n    -l, --get-queue-length           Get the length of the queue for purge requests\n    -s, --get-purge-status id        Get the status of a previous purge request\n```\n\n## Library usage\n\n```\nrequire_relative 'src/ccu_tool'\n\nobjects = [\"http://www.example.com/graphics/picture.gif\", \"http://www.example.com/documents/brochure.pdf\"]\nCCUTool.purge(objects)\n\nCCUTool.get_queue_length\n\nCCUTool.get_purge_status(purge_id)\n```\n\n## Author\n\nStephano Zanzin - [@microwaves](https://github.com/microwaves)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicrowaves%2Fccu-tool","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmicrowaves%2Fccu-tool","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicrowaves%2Fccu-tool/lists"}