gerd 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 983d8728d4f0012f08c44ed368b666c4d1bc6dac
+  data.tar.gz: 6462bf63921e00b4cd299ae3ee2c58e96ab3a431
+SHA512:
+  metadata.gz: 87930548690f0c3ecff8027ab358377be85979e4ee8f59de9ebfb37296cb1fe24a3f06d4483439aead3e47717ecf37d0c59a6fc0604b7a0704c8aeef50acd37c
+  data.tar.gz: 2ecad588ed161cec9ce1cabc03d9f92b83a0486431566d7befa8e000bcd959eb6d169b91048d3ce6e965c3142b77fb0fd55b3dbe5deb443fa8de9115dea93f35

data/.gitignore

@@ -0,0 +1,3 @@
+pkg
+*.json
+script.rb

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.6

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,115 @@
+PATH
+  remote: .
+  specs:
+    gerd (0.0.1)
+      require_all
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.4.0)
+    aruba (0.13.0)
+      childprocess (~> 0.5.6)
+      contracts (~> 0.9)
+      cucumber (>= 1.3.19)
+      ffi (~> 1.9.10)
+      rspec-expectations (>= 2.99)
+      thor (~> 0.19)
+    builder (3.2.2)
+    childprocess (0.5.9)
+      ffi (~> 1.0, >= 1.0.11)
+    coderay (1.1.0)
+    contracts (0.13.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    cucumber (2.3.2)
+      builder (>= 2.1.2)
+      cucumber-core (~> 1.4.0)
+      cucumber-wire (~> 0.0.1)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 3.2.0)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.1.2)
+    cucumber-core (1.4.0)
+      gherkin (~> 3.2.0)
+    cucumber-wire (0.0.1)
+    diff-lcs (1.2.5)
+    ffi (1.9.10)
+    formatador (0.2.5)
+    gherkin (3.2.0)
+    guard (2.13.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, <= 4.0)
+      lumberjack (~> 1.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.6.4)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    hashdiff (0.3.0)
+    listen (3.0.6)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9.7)
+    lumberjack (1.0.10)
+    method_source (0.8.2)
+    multi_json (1.11.2)
+    multi_test (0.1.2)
+    nenv (0.3.0)
+    notiffany (0.0.8)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.5.0)
+    rb-fsevent (0.9.7)
+    rb-inotify (0.9.7)
+      ffi (>= 0.5.0)
+    require_all (1.3.3)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.2)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    safe_yaml (1.0.4)
+    shellany (0.0.1)
+    slop (3.6.0)
+    thor (0.19.1)
+    vcr (3.0.1)
+    webmock (1.22.6)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aruba
+  bundler
+  cucumber
+  gerd!
+  guard
+  guard-rspec
+  rake
+  rspec
+  vcr
+  webmock
+
+BUNDLED WITH
+   1.11.2

data/Guardfile

@@ -0,0 +1,43 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+#directories %w(lib spec) \
+# .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec --color" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+end

data/README.md

@@ -0,0 +1,83 @@
+[![Build Status](https://travis-ci.org/georgecodes/gerd.png?branch=master)](https://travis-ci.org/georgecodes/gerd)
+
+# Gerd - Github Herder
+
+Declaratively manage your Github estate using gerd.
+
+## Introduction
+
+Gerd is a tool which declaratively manages your GitHub estate. In a nutshell, it will create a metadata file for you which models a GitHub organisation, and will let you make changes to that organisation in the file, which will then be reflected in GitHub. 
+
+Currently, the only support is for the creation and deletion of repositories, but new features will be added.
+
+## Usage
+
+### Installation
+
+Gerd is a Ruby gem. Install it using
+
+    $ gem install gerd
+
+### Configuration
+
+Gerd needs a GitHub API token to work. You can provide this on the command line 
+
+    $ gerd -t wpergih3409gihjp2g4brjep
+    $ gerd --token wpergih3409gihjp2g4brjep
+
+Or as an environment variable
+
+    $ export GERD_TOKEN=wpergih3409gihjp2g4brjep
+
+Or in a .gerd file in the local directory
+
+    {
+      "token": "wpergih3409gihjp2g4brjep"
+    }
+
+Or in a .gerd file in your home directory. 
+
+Gerd will look for a token in these places, in order.
+
+### Commands
+
+#### gerd audit
+
+First steps are to create a snapshot of your organisation
+
+    $ gerd audit meet-gerd -f gerd.json
+
+This captures the data in a file which now models your organisation. It will look like this
+ ```
+   {
+     "organisation": "meet-gerd",
+     "teams": {
+     },
+     "repositories": {
+     },
+     "members": {
+       "georgecodes": {
+         "id": 99999
+       }
+    }
+  }
+```
+#### gerd validate
+
+At any point, you can see if your model file matches reality
+
+    $ gerd validate meet-gerd --expected gerd.json
+
+You will get a short report on the recognised differences
+
+#### gerd sync
+
+This is what will propagate changes in your gerd model to GitHub.
+
+    $ gerd sync meet-gerd --file gerd.json
+
+Note that as a layer of protection, destructive behaviour - deleting repos - requires an explicit flag to perform
+
+    $ gerd sync meet-gerd --file gerd.json --delete
+
+  

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec) do | t |
+    t.rspec_opts = "--color"
+  end
+rescue LoadError
+end
+
+task :default => [:spec]

data/bin/gerd

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'gerd'
+
+Gerd::CLI.start(ARGV)

data/gerd.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gerd/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gerd"
+  spec.version       = Gerd::VERSION
+  spec.authors       = ["George McIntosh"]
+  spec.email         = ["george@elevenware.com"]
+  spec.description   = %q{Githur hErd: manage GitHub repositories declaratively}
+  spec.summary       = %q{Manage your GitHub estate declaratively}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "cucumber"
+  spec.add_development_dependency "aruba"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+
+  spec.add_dependency "thor"
+  spec.add_dependency "require_all"
+end

data/lib/gerd.rb

@@ -0,0 +1,6 @@
+require "gerd/version"
+require "gerd/cli"
+
+module Gerd
+  # Your code goes here...
+end

data/lib/gerd/audit/audit.rb

@@ -0,0 +1,79 @@
+require 'octokit'
+require 'octokit/repository'
+require 'json'
+
+module Gerd
+  class Audit
+
+    def initialize(client, org)
+      @org = org
+      @client = client
+    end
+
+    def full_audit
+      audit = {}
+      members = find_members
+      teams = find_teams
+      repositories = find_repos
+      audit['organisation'] = @org
+      audit['teams'] = teams
+      audit['repositories'] = repositories
+      audit['members'] = members
+      audit
+    end
+  
+    def find_repos
+      repos = @client.org_repos @org
+      repositories = {}
+      
+      repos.each do | repo |
+        repo_conf = {
+          :private => repo.private
+        }
+        repositories[repo.name] = repo_conf
+      end
+      repositories
+    end
+
+    def find_teams
+      teams = @client.org_teams @org
+      team_conf = {}
+      teams.each do | team |
+        members = @client.team_members(team.id)
+        team_members = []
+        members.each do | member |
+          team_members << member.login
+          
+        end
+        repos = @client.team_repos(team.id)
+        team_repos = []
+        repos.each do | repo |
+          team_repos << {
+            :id => repo.id,
+            :name => repo.name
+          }
+        end
+        team_conf[team.name] = {
+          :id => team.id,
+          :description => team.description,
+          :privacy => team.privacy,
+          :members => team_members,
+          :repos => team_repos
+        }
+      end
+      team_conf
+    end
+
+    def find_members
+      members = @client.org_members @org
+      members_conf = {}
+      members.each do | member |
+        members_conf[member.login] = {
+          :id => member.id
+        }
+      end
+      members_conf
+    end
+
+  end
+end

data/lib/gerd/cli.rb

@@ -0,0 +1,74 @@
+require 'thor'
+require 'open-uri'
+require 'json'
+require 'gerd/audit/audit'
+require 'gerd/github_client'
+require 'gerd/formatters'
+require 'gerd/validators'
+require 'gerd/model/model'
+require 'gerd/invoke'
+
+module Gerd
+  class CLI < Thor
+
+    desc "audit <organization>", "Introspects the GitHub environment for the given organisation"
+    option :token, :type => :string, :aliases => ['t']
+    option :file, :type => :string, :aliases => ['f']
+    option :overwrite, :type => :boolean, :aliases => ['o']
+    def audit(organisation)
+      token = options[:token] if options[:token]
+      client = Gerd::GHClient.create(token)
+      auditor = Gerd::Audit.new(client, organisation)
+      content = auditor.full_audit
+      formatter = Gerd::Formatters.find_formatter(options[:file])
+      formatter.print(content, options)
+    end
+
+    desc "validate <organisation>", "Checks whether the organisation actually has the configuration supplied"
+    option :expected, :type => :string, :aliases => ['e'], :required => true
+    option :token, :type => :string, :aliases => ['t']
+    option :file, :type => :string, :aliases => ['f']
+    def validate(organisation)
+      token = options[:token] if options[:token]
+      client = Gerd::GHClient.create(token)
+      auditor = Gerd::Audit.new(client, organisation)
+      expected_state = Gerd::Model::GithubState.from_json(File.read(options[:expected]))
+      actual_state = Gerd::Model::GithubState.new(auditor.full_audit)
+      validator = Gerd::Validation::Validator.new(expected_state, actual_state)
+      content = validator.validate
+      formatter = Gerd::Formatters.find_formatter(options[:file])
+      formatter.print(content, options)
+    end
+
+    desc "apply <organisation>", "Applies supplied model to GitHub"
+    option :file, :type => :string, :aliases => ['f'], :required => true
+    option :token, :type => :string, :aliases => ['t']
+    option :delete, :type => :boolean
+    def apply(organisation)
+      token = options[:token] if options[:token]
+      client = Gerd::GHClient.create(token)
+      auditor = Gerd::Audit.new(client, organisation)
+      expected_state = Gerd::Model::GithubState.from_json(File.read(options[:file]))
+      actual_state = Gerd::Model::GithubState.new(auditor.full_audit)
+      validator = Gerd::Validation::Validator.new(expected_state, actual_state)
+      actions = validator.collect_actions.flatten
+      actions.each do | action |
+        action.invoke(client, options)
+      end
+    end
+
+    desc "exec <script>", "Runs arbitrary scripts against your audit file"
+    option :input, :type => :string, :aliases => ['i'], :required => true
+    option :output, :type => :string, :aliases => ['o']
+    def exec(script)
+      current_state = Gerd::Model::GithubState.from_json(File.read(options[:input]))
+      script = File.read(script)
+      exec_helper = Gerd::Helpers::Exec.new(script)
+      exec_helper.exec(current_state)
+      formatter = Gerd::Formatters.find_formatter(options[:output])
+      formatter.print(current_state.serialize, options)
+      
+    end
+
+  end
+end