thoughtbot-enforcer 0.0.2

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 thoughtbot
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,42 @@
+= enforcer
+
+A simple way to manage permissions on GitHub.
+
+== usage
+
+Create an enforcer script and then run it with the "enforcer" executable.
+
+  enforcer my_enforcer_script.rb
+
+== howto
+
+The DSL should be formed like such:
+
+  Enforcer "your github account", "your github api key" do
+    project "some project", "user1", "user2", "user3"
+  end
+
+The users passed into the project are then set as the collaborators. Any
+users not listed are removed. You could use a GitHub API wrapper like
+Octopi to load up your projects as well. Here's a more complex example:
+
+  require 'octopi'
+  include Octopi
+  account = "thoughtbot"
+  token   = "deadbeef"
+
+  Enforcer account, token do
+    authenticated_with account, token do |github|
+      @projects = github.user.repositories.map { |repo| repo.name }.sort
+    end
+
+    users = %w[user1 user2 user3]
+
+    @projects.each do |name|
+      project name, *users
+    end
+  end
+
+== legal
+
+Copyright (c) 2009 thoughtbot. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,68 @@
+require 'rubygems'
+require 'rake'
+
+task :default => [:test, :features]
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "enforcer"
+    gem.summary = %Q{A simple way to manage permissions on GitHub}
+    gem.email = "nquaranto@thoughtbot.com"
+    gem.homepage = "http://github.com/thoughtbot/enforcer"
+    gem.authors = ["Nick Quaranto"]
+    gem.add_dependency("httparty")
+    gem.add_dependency("fcoury-octopi")
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "enforcer #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'cucumber/rake/task'
+
+  Cucumber::Rake::Task.new(:features) do |t|
+    t.cucumber_opts = "--format progress"
+  end
+rescue LoadError
+  desc 'Cucumber rake task not available'
+  task :features do
+    abort 'Cucumber rake task is not available. Be sure to install cucumber as a gem or plugin'
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/bin/enforcer

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
+help = <<HELP
+Enforcer is a simple way to manage permissions on GitHub.
+
+Basic usage:
+  enforcer my_enforcer_script.rb
+HELP
+
+if ARGV.size == 1 && File.exist?(ARGV[0])
+  require 'enforcer'
+  load ARGV[0]
+else
+  puts help
+end
+
+

data/enforcer.gemspec

@@ -0,0 +1,66 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{enforcer}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Nick Quaranto"]
+  s.date = %q{2009-08-24}
+  s.default_executable = %q{enforcer}
+  s.email = %q{nquaranto@thoughtbot.com}
+  s.executables = ["enforcer"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "bin/enforcer",
+     "enforcer.gemspec",
+     "features/manage_collaborators.feature",
+     "features/step_definitions/enforcer_steps.rb",
+     "features/support/env.rb",
+     "lib/enforcer.rb",
+     "lib/repository.rb",
+     "test/enforcer_test.rb",
+     "test/integration.rb",
+     "test/repository_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/thoughtbot/enforcer}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.4}
+  s.summary = %q{A simple way to manage permissions on GitHub}
+  s.test_files = [
+    "test/enforcer_test.rb",
+     "test/integration.rb",
+     "test/repository_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<httparty>, [">= 0"])
+      s.add_runtime_dependency(%q<fcoury-octopi>, [">= 0"])
+    else
+      s.add_dependency(%q<httparty>, [">= 0"])
+      s.add_dependency(%q<fcoury-octopi>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<httparty>, [">= 0"])
+    s.add_dependency(%q<fcoury-octopi>, [">= 0"])
+  end
+end

data/features/manage_collaborators.feature

@@ -0,0 +1,45 @@
+Feature: Manage collaborators
+  Background:
+    Given an account "thoughtbot" with an api key of "deadbeef"
+
+  Scenario: Adding a single collaborator for a specific project
+    When I execute the following code
+     """
+     Enforcer "thoughtbot", "deadbeef" do
+       project "shoulda", 'rmmt'
+     end
+     """
+    Then the GitHub API should have received a request to add "rmmt" as a collaborator for "shoulda"
+
+  Scenario: Adding a single collaborator for more than one project
+    When I execute the following code
+     """
+     Enforcer "thoughtbot", "deadbeef" do
+       project "shoulda", 'rmmt'
+       project "factory_girl", 'qrush'
+     end
+     """
+    Then the GitHub API should have received a request to add "rmmt" as a collaborator for "shoulda"
+    Then the GitHub API should have received a request to add "qrush" as a collaborator for "factory_girl"
+
+  Scenario: Adding more than one collaborators for a specific project
+    When I execute the following code
+     """
+     Enforcer "thoughtbot", "deadbeef" do
+       project "shoulda", 'rmmt', 'coreyhaines', 'qrush'
+     end
+     """
+    Then the GitHub API should have received a request to add "rmmt" as a collaborator for "shoulda"
+    And the GitHub API should have received a request to add "coreyhaines" as a collaborator for "shoulda"
+    And the GitHub API should have received a request to add "qrush" as a collaborator for "shoulda"
+
+  Scenario: Removing one collaborator from the project
+    Given "qrush" is a collaborator for "shoulda"
+    When I execute the following code
+     """
+     Enforcer "thoughtbot", "deadbeef" do
+       project "shoulda", 'coreyhaines'
+     end
+     """
+    Then the GitHub API should have received a request to add "coreyhaines" as a collaborator for "shoulda"
+    And the GitHub API should have received a request to remove "qrush" as a collaborator for "shoulda"

data/features/step_definitions/enforcer_steps.rb

@@ -0,0 +1,30 @@
+Before do
+  @repo = "repo"
+  @existing_collaborators = []
+
+  stub(Repository).new(anything, anything, anything) { @repo }
+  stub(@repo).add(anything)
+  stub(@repo).remove(anything)
+  stub(@repo).list { @existing_collaborators }
+end
+
+Given /^an account "(.*)" with an api key of "(.*)"$/ do |account, api_key|
+  @account = account
+  @api_key = api_key
+end
+
+Given /^"([^\"]*)" is a collaborator for "([^\"]*)"$/ do |user, repo|
+  @existing_collaborators << user
+end
+
+When /^I execute the following code$/ do |code|
+  eval(code)
+end
+
+Then /^the GitHub API should have received a request to add "(.*)" as a collaborator for "(.*)"$/ do |user, repo|
+  assert_received(@repo) { |subject| subject.add(user) }
+end
+
+Then /^the GitHub API should have received a request to remove "([^\"]*)" as a collaborator for "([^\"]*)"$/ do |user, repo|
+  assert_received(@repo) { |subject| subject.remove(user) }
+end

data/features/support/env.rb

@@ -0,0 +1,24 @@
+require 'fileutils'
+require 'rr'
+require 'test/unit'
+require 'enforcer'
+require 'fakeweb'
+
+FakeWeb.allow_net_connect = false
+
+World(Test::Unit::Assertions)
+World(RR::Adapters::TestUnit)
+
+Before do
+  RR.reset
+  stub(STDOUT).puts
+end
+
+After do
+  begin
+    RR.verify
+  ensure
+    RR.reset
+  end
+end
+

data/lib/enforcer.rb

@@ -0,0 +1,40 @@
+$:.unshift(File.dirname(__FILE__))
+
+require 'rubygems'
+require 'httparty'
+require 'json'
+
+require 'repository'
+
+class Enforcer
+  def initialize(account_name, api_key)
+    @account_name = account_name
+    @api_key = api_key
+  end
+
+  def project(project_name, *collaborators)
+    return if collaborators.nil?
+
+    STDOUT.puts "Enforcing settings for #{project_name}"
+    repo = Repository.new(@account_name, @api_key, project_name)
+
+    existing_collaborators = repo.list
+
+    if existing_collaborators.nil?
+      STDOUT.puts ">> Can't find existing collaborators for this project"
+      return
+    end
+
+    { :add => collaborators - existing_collaborators,
+      :remove => existing_collaborators - collaborators}.each_pair do |action, group|
+        group.each do |collaborator|
+          repo.send(action, collaborator)
+        end
+      end
+  end
+end
+
+def Enforcer(account_name, api_key, &block)
+  enforcer = Enforcer.new(account_name, api_key)
+  enforcer.instance_eval(&block)
+end

data/lib/repository.rb

@@ -0,0 +1,41 @@
+class Repository
+  include HTTParty
+  base_uri 'http://github.com/api/v2/json/repos'
+
+  HTTP_ERRORS = [Timeout::Error,
+                 Errno::EINVAL,
+                 Errno::ECONNRESET,
+                 EOFError,
+                 Net::HTTPBadResponse,
+                 Net::HTTPHeaderSyntaxError,
+                 Net::ProtocolError]
+
+  def initialize(account, api_key, project)
+    @account = account
+    @project = project
+    @api_key = api_key
+  end
+
+  def request(method, path)
+    begin
+      response = self.class.send(method, path, :body => { :login => @account, :token => @api_key })
+      response['collaborators']
+    rescue *HTTP_ERRORS => ex
+      STDOUT.puts ">> There was a problem contacting GitHub: #{ex}"
+    end
+  end
+
+  def list
+    request(:get, "/show/#{@account}/#{@project}/collaborators")
+  end
+
+  def add(collaborator)
+    STDOUT.puts ">> Adding #{collaborator}"
+    request(:post, "/collaborators/#{@project}/add/#{collaborator}")
+  end
+
+  def remove(collaborator)
+    STDOUT.puts ">> Removing #{collaborator}"
+    request(:post, "/collaborators/#{@project}/remove/#{collaborator}")
+  end
+end

data/test/enforcer_test.rb

@@ -0,0 +1,89 @@
+require 'test_helper'
+
+class EnforcerTest < Test::Unit::TestCase
+  context "with an enforcer" do
+    setup do
+      @existing_collaborators = []
+      @repo = "repo"
+      @project = "project"
+      @account = "user"
+      @api_key = "api key"
+
+      stub(@repo).add(anything)
+      stub(@repo).list { @existing_collaborators }
+      mock(Repository).new(@account, @api_key, @project) { @repo }
+
+      @enforcer = Enforcer.new(@account, @api_key)
+    end
+
+    should "totally skip adding/removing collaborators if the existing collaborators can't be found" do
+      @existing_collaborators = nil
+
+      assert_nothing_raised do
+        @enforcer.project @project, 'chaines'
+      end
+
+      assert_received(@repo) do |subject|
+        subject.add('chaines').never
+      end
+    end
+
+    should "add a collaborator to the project" do
+      @enforcer.project @project, 'chaines'
+
+      assert_received(@repo) do |subject|
+        subject.add('chaines')
+      end
+    end
+
+    should "add collaborators to the project" do
+      @enforcer.project @project, 'chaines', 'qrush'
+
+      assert_received(@repo) do |subject|
+        subject.add('chaines')
+        subject.add('qrush')
+      end
+    end
+
+    context "with an existing user" do
+      setup do
+        @existing_user = "ralph"
+        stub(@repo).remove(anything)
+        @existing_collaborators << "ralph"
+      end
+
+      should "not add existing user to the project" do
+        @enforcer.project @project, 'ralph'
+
+        assert_received(@repo) do |subject|
+          subject.add('ralph').never
+        end
+      end
+
+      should "remove existing user from the project if not in collaborators" do
+        @enforcer.project @project, 'qrush'
+
+        assert_received(@repo) do |subject|
+          subject.add('qrush')
+          subject.remove(@existing_user)
+        end
+      end
+    end
+  end
+
+  context "setting up enforcer dsl" do
+    setup do
+      @enforcer = "enforcer"
+      stub(@enforcer).project(anything, anything)
+
+      @account = "thoughtbot"
+      @api_key  = "api key"
+      mock(Enforcer).new(@account, @api_key) { @enforcer }
+    end
+
+    should "be there and take a string and block" do
+      Enforcer(@account, @api_key) { project("shoulda", "corey") {} }
+      assert_received(@enforcer) { |subject| subject.project("shoulda", "corey") }
+    end
+  end
+end

data/test/integration.rb

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'lib/enforcer'
+
+token = `git config github.token`
+
+Enforcer "qrush", token.chomp do
+  project "aquinas", "qrush", "mittens"
+end

data/test/repository_test.rb

@@ -0,0 +1,84 @@
+require 'test_helper'
+
+class RepositoryTest < Test::Unit::TestCase
+  context "with github api credentials" do
+    setup do
+      @account = "thoughtbot"
+      @api_key = "deadbeef"
+      @project = "project"
+      @user    = "coreyhaines" + rand(10).to_s
+      @repo    = Repository.new(@account, @api_key, @project)
+    end
+
+    should "set base uri" do
+      assert_equal "http://github.com/api/v2/json/repos", Repository.base_uri
+    end
+
+    context "github is down" do
+      should "not fail" do
+        stub(Repository).get(anything, anything) { raise TimeoutError }
+        assert_nothing_raised do
+          @repo.list
+        end
+      end
+    end
+
+    context "listing collaborators" do
+      setup do
+        @collaborators = ["qrush", "coreyhaines"]
+        stub(Repository).get(anything, anything) { {'collaborators' => @collaborators} }
+        @result = @repo.list
+      end
+
+      should "return just the usernames" do
+        assert_equal @collaborators, @result
+      end
+
+      should "hit the github api" do
+        assert_received(Repository) do |subject|
+          subject.get("/show/#{@account}/#{@project}/collaborators", 
+           :body => {:login => @account, :token => @api_key}) { { 'collaborators' => @collaborators } }
+        end
+      end
+    end
+
+    context "adding a collaborator" do
+      setup do
+        @collaborators = ["qrush", @user]
+        stub(Repository).post(anything, anything) { {'collaborators' => @collaborators }}
+        @collaborators = @repo.add(@user)
+      end
+
+      should "hit the github api" do
+        assert_received(Repository) do |subject|
+          subject.post("/collaborators/#{@project}/add/#{@user}", :body => {
+            :login => @account,
+            :token => @api_key})
+        end
+      end
+
+      should "return the new collaborators" do
+        assert_equal ["qrush", @user], @collaborators
+      end
+    end
+    context "removing a collaborator" do
+      setup do
+        @collaborators = ["qrush"]
+        stub(Repository).post(anything, anything) { {'collaborators' => @collaborators }}
+        @result = @repo.remove(@user)
+      end
+
+      should "hit the github api" do
+        assert_received(Repository) do |subject|
+          subject.post("/collaborators/#{@project}/remove/#{@user}", :body => {
+            :login => @account,
+            :token => @api_key})
+        end
+      end
+
+      should "return the new collaborators" do
+        assert_equal ["qrush"], @result
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,30 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'rr'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'enforcer'
+
+begin
+  require 'redgreen'
+rescue LoadError
+end
+
+class Test::Unit::TestCase
+  include RR::Adapters::TestUnit
+
+  def setup
+    RR.reset
+    stub(STDOUT).puts
+  end
+
+  def teardown
+    begin
+      RR.verify
+    ensure
+      RR.reset
+    end
+  end
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: thoughtbot-enforcer
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Nick Quaranto
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-24 00:00:00 -07:00
+default_executable: enforcer
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: fcoury-octopi
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: nquaranto@thoughtbot.com
+executables: 
+- enforcer
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/enforcer
+- enforcer.gemspec
+- features/manage_collaborators.feature
+- features/step_definitions/enforcer_steps.rb
+- features/support/env.rb
+- lib/enforcer.rb
+- lib/repository.rb
+- test/enforcer_test.rb
+- test/integration.rb
+- test/repository_test.rb
+- test/test_helper.rb
+has_rdoc: false
+homepage: http://github.com/thoughtbot/enforcer
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A simple way to manage permissions on GitHub
+test_files: 
+- test/enforcer_test.rb
+- test/integration.rb
+- test/repository_test.rb
+- test/test_helper.rb