{"id":21202435,"url":"https://github.com/infrablocks/ruby_fly","last_synced_at":"2025-08-02T15:34:03.605Z","repository":{"id":18892881,"uuid":"85435438","full_name":"infrablocks/ruby_fly","owner":"infrablocks","description":"A simple Ruby wrapper for invoking fly commands.","archived":false,"fork":false,"pushed_at":"2025-07-24T13:03:22.000Z","size":396,"stargazers_count":2,"open_issues_count":3,"forks_count":1,"subscribers_count":11,"default_branch":"main","last_synced_at":"2025-07-28T14:16:54.041Z","etag":null,"topics":["command-line","concourse-ci","fly","ruby","ruby-gem","ruby-library","rubygem"],"latest_commit_sha":null,"homepage":null,"language":"Ruby","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/infrablocks.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","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,"zenodo":null}},"created_at":"2017-03-18T22:15:09.000Z","updated_at":"2025-06-04T13:33:33.000Z","dependencies_parsed_at":"2023-02-11T00:25:32.335Z","dependency_job_id":"0a148ff2-1af3-41d0-a66f-6a917c9e7fda","html_url":"https://github.com/infrablocks/ruby_fly","commit_stats":null,"previous_names":[],"tags_count":60,"template":false,"template_full_name":null,"purl":"pkg:github/infrablocks/ruby_fly","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/infrablocks%2Fruby_fly","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/infrablocks%2Fruby_fly/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/infrablocks%2Fruby_fly/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/infrablocks%2Fruby_fly/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/infrablocks","download_url":"https://codeload.github.com/infrablocks/ruby_fly/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/infrablocks%2Fruby_fly/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268213634,"owners_count":24214348,"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-08-01T02:00:08.611Z","response_time":67,"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":["command-line","concourse-ci","fly","ruby","ruby-gem","ruby-library","rubygem"],"created_at":"2024-11-20T20:15:57.064Z","updated_at":"2025-08-02T15:34:03.547Z","avatar_url":"https://github.com/infrablocks.png","language":"Ruby","readme":"# RubyFly\n\nWraps the concourse fly CLI so that fly can be invoked from a Ruby script or \nRakefile.\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'ruby_fly'\n```\n\nAnd then execute:\n\n    $ bundle\n\nOr install it yourself as:\n\n    $ gem install ruby_fly\n\n## Usage\n\n### Binary Location\n\nRubyFly needs to know where the fly binary is located before it can do anything.\nBy default, RubyFly looks on the path however this can be configured with:\n\n```ruby\nRubyFly.configure do |config|\n  config.binary = 'vendor/fly/bin/fly'\nend\n```\n\nIn addition, each command takes a `binary` keyword argument at initialisation\nthat overrides the global configuration value.\n\n### Login\n\nCurrently the library doesn't support logging in to a Concourse instance so if\nthe target instance requires authentication, a session must be manually \nestablished before any commands are executed. If there are recommendations for\na good approach to automatic login, please raise an issue or a pull request.\n\n### Commands\n\nCurrently, there is partial support for the following commands:\n* `RubyFly::Commands::GetPipeline`: fetches the current configuration of a \n  pipeline from a target Concourse (`fly get-pipeline`)\n* `RubyFly::Commands::SetPipeline`: submits a pipeline configuration to\n  a target Concourse (`fly set-pipeline`)\n* `RubyFly::Commands::UnpausePipeline`: unpauses a pipeline on a target\n  Concourse (`fly unpause-pipeline`)\n* `RubyFly::Commands::Version`: returns the version of the fly binary\n\n#### `RubyFly::Commands::GetPipeline`\n\nThe get-pipeline command can be called in the following ways:\n\n```ruby\nRubyFly.get_pipeline(\n    target: 'supercorp-ci', \n    pipeline: 'supercorp-service')\nRubyFly::Commands::GetPipeline.new.execute(\n    target: 'supercorp-ci',\n    pipeline: 'supercorp-service')\n```\n\nThe get-pipeline command supports the following options passed as keyword \narguments (as in the example above):\n* `target`: the Concourse instance to target\n* `pipeline`: the pipeline for which to get configuration\n\n#### `RubyFly::Commands::SetPipeline`\n\nThe set-pipeline command can be called in the following ways:\n\n```ruby\nRubyFly.set_pipeline(\n    target: 'supercorp-ci', \n    pipeline: 'supercorp-service',\n    config: 'ci/pipeline.yml')\nRubyFly::Commands::SetPipeline.new.execute(\n    target: 'supercorp-ci',\n    pipeline: 'supercorp-service',\n    config: 'ci/pipeline.yml')\n```\n\nThe set-pipeline command supports the following options passed as keyword \narguments (as in the example above):\n* `target`: the Concourse instance to target\n* `pipeline`: the pipeline for which to set configuration\n* `config`: the local file containing the pipeline configuration\n* `vars`: an hash of variables to be accessible as interpolations\n* `var_files`: an array of paths to files containing variables to be accessible\n  as interpolations\n* `non_interactive`: if `false`, any missing variables will be prompted for,\n  if `true`, any missing variables will cause the command to fail\n\n#### `RubyFly::Commands::UnpausePipeline`\n\nThe unpause-pipeline command can be called in the following ways:\n\n```ruby\nRubyFly.unpause_pipeline(\n    target: 'supercorp-ci', \n    pipeline: 'supercorp-service')\nRubyFly::Commands::UnpausePipeline.new.execute(\n    target: 'supercorp-ci',\n    pipeline: 'supercorp-service')\n```\n\nThe get-pipeline command supports the following options passed as keyword \narguments (as in the example above):\n* `target`: the Concourse instance to target\n* `pipeline`: the pipeline to unpause\n\n#### `RubyFly::Commands::Version`\n\nThe version command can be called in the following ways:\n\n```ruby\nversion = RubyFly.version\nversion = RubyFly::Commands::Version.new.execute\n```\n\n## Development\n\nAfter checking out the repo, run `bin/setup` to install dependencies. Then, run\n`rake spec` to run the tests. You can also run `bin/console` for an interactive\nprompt that will allow you to experiment.\n\nTo install this gem onto your local machine, run `bundle exec rake install`. To\nrelease a new version, update the version number in `version.rb`, and then run\n`bundle exec rake release`, which will create a git tag for the version, push\ngit commits and tags, and push the `.gem` file to \n[rubygems.org](https://rubygems.org).\n\n### Managing CircleCI keys\n\nTo encrypt a GPG key for use by CircleCI:\n\n```bash\nopenssl aes-256-cbc \\\n  -e \\\n  -md sha1 \\\n  -in ./config/secrets/ci/gpg.private \\\n  -out ./.circleci/gpg.private.enc \\\n  -k \"\u003cpassphrase\u003e\"\n```\n\nTo check decryption is working correctly:\n\n```bash\nopenssl aes-256-cbc \\\n  -d \\\n  -md sha1 \\\n  -in ./.circleci/gpg.private.enc \\\n  -k \"\u003cpassphrase\u003e\"\n```\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at \nhttps://github.com/infrablocks/ruby_fly. This project is intended to be a safe,\nwelcoming space for collaboration, and contributors are expected to adhere to\nthe [Contributor Covenant](http://contributor-covenant.org) code of conduct.\n\n\n## License\n\nThe gem is available as open source under the terms of the \n[MIT License](http://opensource.org/licenses/MIT).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finfrablocks%2Fruby_fly","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finfrablocks%2Fruby_fly","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finfrablocks%2Fruby_fly/lists"}