find-circle-yml 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ad3e5216155d142793a5985488898882306bea77
+  data.tar.gz: 77b09f85bcdefff11c3ab35e48446d51cfe801f0
+SHA512:
+  metadata.gz: d63eefc0c6a60da841c4c9a588d5dd37efecd324fa915828be9a92d42b9aea811080b88f854d1910770420012ddb5310abc35bc2f73eb632b8e5b836df038e35
+  data.tar.gz: 843965e38d1edf5440fe9dc0890f1d31f45def0ac47e94090462b694134996b352fcf0179be6495c9c2aad87ae6a76f3f9b690783786e1675dd1eb317adad9d3

data/README.md

@@ -0,0 +1,53 @@
+# find-circle-yml
+
+A command-line tool for finding which repositories in your GitHub organization or Bitbucket team have `circle.yml` configuration files.
+
+## Installation
+
+    $ gem install find-circle-yml
+
+## Usage
+
+**GitHub**
+
+    $ GITHUB_ORGANIZATION=<your github org> GITHUB_USER=<your github user> GITHUB_ACCESS_TOKEN=<your personal access token> find-circle-yml
+    https://github.com/your-org/your-repo/blob/master/circle.yml
+    https://github.com/your-org/another-repo/blob/master/circle.yml
+
+**Bitbucket**
+
+    $ BITBUCKET_TEAM=<your bitbucket team> BITBUCKET_USER=<your bitbucket user> BITBUCKET_APP_PASSWORD=<your bitbucket password> find-circle-yml
+    https://bitbucket.org/your-team/your-repo/src/bb030e9dcee6218d0ce521b7312e60e5cc5db4a3/circle.yml
+    https://bitbucket.org/your-team/another-repo/src/cf9f1078be258dd902ff49718e5ee5422e2dd08f/circle.yml
+
+Writes a list of repositories that contain a `circle.yml` to standard out.
+
+## Authorization
+
+Authorization requires creating an app-specific password for your platform:
+
+**GitHub**
+
+See [the docs for creating a personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/). Ensure that the token has the **repo** and **read:org** scope.  Use the token as the value of `GITHUB_ACCESS_TOKEN` environment variable.
+
+**Bitbucket**
+
+See [the docs for creating an app password](https://confluence.atlassian.com/bitbucket/app-passwords-828781300.html). Ensure that the app password has the **Team membership Read** and **Repositories Read** permissions. Use the app password as the value of `BITBUCKET_APP_PASSWORD` environment variable.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/circleci/find-circle-yml. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the circleci-audit project is expected to follow the [code of conduct](https://github.com/CircleCI-Public/find-circle-yml/blob/master/CODE_OF_CONDUCT.md).

data/exe/find-circle-yml

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'find_circle_yml'
+
+provided_configurations = [
+  FindCircleYml::Bitbucket::Configuration.new(ENV),
+  FindCircleYml::GitHub::Configuration.new(ENV)
+].select(&:provided?)
+
+if provided_configurations.empty?
+  STDERR.puts 'Provide a Bitbucket or GitHub configuration'
+  exit 1
+end
+
+provided_configurations.each do |configuration|
+  if configuration.valid?
+    service = configuration.service
+    service.repositories.each do |repository|
+      if (configuration_file = service.configuration_file(repository))
+        puts configuration_file.url
+      end
+    end
+  else
+    STDERR.puts configuration.error_message
+    exit 1
+  end
+end

data/lib/find_circle_yml.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'octokit'
+require 'net/http'
+require 'uri'
+require 'json'
+
+require 'find_circle_yml/repository'
+require 'find_circle_yml/configuration_file'
+require 'find_circle_yml/github/service'
+require 'find_circle_yml/github/configuration'
+require 'find_circle_yml/bitbucket/configuration'
+require 'find_circle_yml/bitbucket/service'

data/lib/find_circle_yml/bitbucket/configuration.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module FindCircleYml
+  module Bitbucket
+    class Configuration
+      ENVIRONMENT_VARIABLES = %w[
+        BITBUCKET_USER
+        BITBUCKET_APP_PASSWORD
+        BITBUCKET_TEAM
+      ].freeze
+
+      attr_reader :environment
+
+      def initialize(environment)
+        @environment = environment
+      end
+
+      def provided?
+        ENVIRONMENT_VARIABLES.any? do |environment_variable|
+          environment.key?(environment_variable)
+        end
+      end
+
+      def valid?
+        missing.empty?
+      end
+
+      def error_message
+        "Set environment variables: #{missing.join(', ')}"
+      end
+
+      def service
+        Bitbucket::Service.new(
+          environment.fetch('BITBUCKET_USER'),
+          environment.fetch('BITBUCKET_APP_PASSWORD'),
+          environment.fetch('BITBUCKET_TEAM')
+        )
+      end
+
+      private
+
+      def missing
+        ENVIRONMENT_VARIABLES.reject do |environment_variable|
+          environment.key?(environment_variable)
+        end
+      end
+    end
+  end
+end

data/lib/find_circle_yml/bitbucket/service.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module FindCircleYml
+  module Bitbucket
+    class Service
+      attr_reader :user, :password, :team
+
+      def initialize(user, password, team)
+        @user = user
+        @password = password
+        @team = team
+      end
+
+      def repositories
+        Enumerator.new do |y|
+          url = "/repositories/#{team}"
+          loop do
+            response = request(url)
+            parsed_response = JSON.parse(response.body)
+            parsed_response.fetch('values', []).each do |value|
+              y << Repository.new(
+                value.fetch('full_name'),
+                value.dig('mainbranch', 'branch') || 'master',
+                value.fetch('links').fetch('html').fetch('href')
+              )
+            end
+            break unless parsed_response.key?('next')
+            url = parsed_response.fetch('next')
+          end
+        end
+      end
+
+      def configuration_file(repository)
+        response = request("/repositories/#{repository.name}/src/#{repository.main_branch}/circle.yml?format=meta")
+        return unless response.code == '200'
+        parsed_response = JSON.parse(response.body)
+        commit = parsed_response.fetch('commit', {}).fetch('hash', repository.main_branch)
+        path = parsed_response.fetch('path')
+        ConfigurationFile.new("#{repository.url}/src/#{commit}/#{path}")
+      end
+
+      private
+
+      def request(path)
+        uri = URI("https://api.bitbucket.org/2.0#{path}")
+        Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
+          request = Net::HTTP::Get.new(uri)
+          request.basic_auth(user, password)
+          http.request request
+        end
+      end
+    end
+  end
+end

data/lib/find_circle_yml/configuration_file.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module FindCircleYml
+  ConfigurationFile = Struct.new(:url)
+end

data/lib/find_circle_yml/github/configuration.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module FindCircleYml
+  module GitHub
+    class Configuration
+      ENVIRONMENT_VARIABLES = %w[
+        GITHUB_USER
+        GITHUB_ACCESS_TOKEN
+        GITHUB_ORGANIZATION
+      ].freeze
+
+      attr_reader :environment
+
+      def initialize(environment)
+        @environment = environment
+      end
+
+      def provided?
+        ENVIRONMENT_VARIABLES.any? do |environment_variable|
+          environment.key?(environment_variable)
+        end
+      end
+
+      def valid?
+        missing.empty?
+      end
+
+      def error_message
+        "Set environment variables: #{missing.join(', ')}"
+      end
+
+      def service
+        GitHub::Service.new(
+          environment.fetch('GITHUB_USER'),
+          environment.fetch('GITHUB_ACCESS_TOKEN'),
+          environment.fetch('GITHUB_ORGANIZATION')
+        )
+      end
+
+      private
+
+      def missing
+        ENVIRONMENT_VARIABLES.reject do |environment_variable|
+          environment.key?(environment_variable)
+        end
+      end
+    end
+  end
+end

data/lib/find_circle_yml/github/service.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module FindCircleYml
+  module GitHub
+    class Service
+      attr_reader :user, :access_token, :organization
+
+      def initialize(user, access_token, organization)
+        @user = user
+        @access_token = access_token
+        @organization = organization
+      end
+
+      def repositories
+        client.organization_repositories(organization).map do |response|
+          Repository.new(
+            response[:full_name],
+            response[:default_branch],
+            response[:html_url]
+          )
+        end
+      end
+
+      def configuration_file(repository)
+        ConfigurationFile.new(
+          client.contents(repository.name, path: 'circle.yml')[:html_url]
+        )
+      rescue Octokit::NotFound
+        nil
+      end
+
+      private
+
+      def client
+        Octokit.auto_paginate = true
+        Octokit::Client.new(login: user, password: access_token)
+      end
+    end
+  end
+end

data/lib/find_circle_yml/repository.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module FindCircleYml
+  Repository = Struct.new(:name, :main_branch, :url)
+end

data/lib/find_circle_yml/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module FindCircleYml
+  VERSION = '0.1.0'
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
+require 'find_circle_yml'
+
+require 'minitest/autorun'

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: find-circle-yml
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- nwjsmith
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.11.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 12.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 12.3.0
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2
+      A command-line tool for finding which repositories in your GitHub
+      organization or Bitbucket team have circle.yml configuration files.
+email:
+- sayhi@circleci.com
+executables:
+- find-circle-yml
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- exe/find-circle-yml
+- lib/find_circle_yml.rb
+- lib/find_circle_yml/bitbucket/configuration.rb
+- lib/find_circle_yml/bitbucket/service.rb
+- lib/find_circle_yml/configuration_file.rb
+- lib/find_circle_yml/github/configuration.rb
+- lib/find_circle_yml/github/service.rb
+- lib/find_circle_yml/repository.rb
+- lib/find_circle_yml/version.rb
+- test/test_helper.rb
+homepage: https://github.com/CircleCI-Public/find-circle-yml
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Finds circle.yml files
+test_files:
+- test/test_helper.rb