{"id":15284477,"url":"https://github.com/ikemtz/pubeler","last_synced_at":"2025-05-07T03:26:00.851Z","repository":{"id":35157330,"uuid":"213945773","full_name":"ikemtz/pubeler","owner":"ikemtz","description":"A utility to post data contained in flat files to RESTful apis.","archived":false,"fork":false,"pushed_at":"2024-03-16T23:31:55.000Z","size":146,"stargazers_count":3,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-31T05:51:08.188Z","etag":null,"topics":["auth0","device-workflow","flat-files","oauth2"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/ikemtz.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":"2019-10-09T14:50:28.000Z","updated_at":"2023-01-12T13:01:38.000Z","dependencies_parsed_at":"2024-10-14T15:01:04.772Z","dependency_job_id":null,"html_url":"https://github.com/ikemtz/pubeler","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/ikemtz%2Fpubeler","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ikemtz%2Fpubeler/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ikemtz%2Fpubeler/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ikemtz%2Fpubeler/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ikemtz","download_url":"https://codeload.github.com/ikemtz/pubeler/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252805571,"owners_count":21807028,"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":["auth0","device-workflow","flat-files","oauth2"],"created_at":"2024-09-30T14:57:08.613Z","updated_at":"2025-05-07T03:26:00.834Z","avatar_url":"https://github.com/ikemtz.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# pubeler\n\npronounced pyüb-lər\n\nA utility to automate the publishing of data contained in flat files to resful APIs. At this time this is setup to use device OAuth workflow.\n\n## installation\n\n```\nnpm install --global pubeler\n```\n\nor\n\n```\nnpm i -g pubeler\n```\n\n## running it\n\n`pubeler --configFile \u003cconfig-file --required\u003e --dataFile \u003cdata-file --required\u003e`\n\n#### Note: This application uses the device workflow, so you will need to complete the authentication process with your identity provider.\n\n## getting help\n\n`pubeler --help`\n\nIf this doesn't provide what you need, feel free to submit a new issue ticket [here](https://github.com/ikemtz/pubeler/issues/new).\n\n## enabling OAuth debugging (--oauthDebug)\n\n`pubeler --configFile \u003cconfig-file --required\u003e --dataFile \u003cdata-file --required\u003e --oauthDebug`\n\nThis will write out the aquired jwt from the oauth provider to the console.\n\n## config file\n\nThis is a JSON file that will inform Pubeler on how to authenticate with your identity provider and communicate with your APIs.\n\nHere's a sample:\n\n```\n{\n  \"textDelimeter\": \"\\t\",\n  \"postDestinationUrl\": \"https://my-post-url.com/api/myrecords.json\",\n  \"oauth_client_id\": \"my-client-id\",\n  \"oauth_device_code_url\": \"https://{tenant-name}.auth0.com/oauth/token\",\n  \"oauth_token_url\": \"https://{tenant-name}.auth0.com/oauth/token\",\n  \"oauth_audience\": \"{your-audience}\",\n  \"oauth_scope\": \"openid\",\n  // This is an optional setting, only to be used when absolutely necessary\n  \"skip_ssl_validation\": false,\n}\n```\n\n#### Note: Your identity provider has to support the device workflow. I recommend using [Auth0](https://auth0.com/docs/flows/concepts/device-auth) as they have an easy to use implementation of this workflow.\n\n## error handling\n\nIf a post related error occurs, a new txt file will be created containing the records that caused an error response (HTTP 400-500 response codes.) This file will allow you to easily retry failed records in a subsequent run. The generated text file name will be named: `{url pathinfo}.{timestamp (yyMMddHHmmss)}.failures.txt`. An example of this would be: myrecords.json.221208011433.failures.txt.\n\nThe server response which typically indicates why the post request failed will be logged to the console. Additionally, authentication/OAuth related errors will be logged to the console as well.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fikemtz%2Fpubeler","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fikemtz%2Fpubeler","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fikemtz%2Fpubeler/lists"}