brief 0.0.1 → 0.0.2

data/lib/brief/git.rb

@@ -0,0 +1,19 @@
+module Brief
+  module Git
+    def self.current_github_repository
+      return nil unless Pathname(Dir.pwd).join('.git').exist?
+
+      return @current_github_repository if @current_github_repository
+
+      github_remote = `git remote`.lines.to_a.detect do |remote_name|
+        `git remote show #{ remote_name }`.match(/github\.com/)
+      end
+
+      if github_remote
+        lines = `git remote show #{ github_remote }`.lines.to_a.map(&:strip)
+        line = lines.detect {|l| l.match(/Fetch URL/)}
+        @current_github_repository = line.split(':').last.gsub(/\.git$/,'')
+      end
+    end
+  end
+end

data/lib/brief/github/wiki.rb

@@ -0,0 +1,9 @@
+module Brief
+  module Github
+    module Wiki
+      def self.initialize!
+
+      end
+    end
+  end
+end

data/lib/brief/github.rb

@@ -0,0 +1,78 @@
+require 'brief/formatters/github_milestone_rollup'
+require 'brief/handlers/github_issue'
+require 'brief/handlers/github_milestone'
+require 'brief/handlers/github_wiki'
+
+module Brief
+  def self.github_nickname
+    (Brief.profile.github_nickname rescue nil) || Brief::Git.current_github_repository.try(:split, '/').try(:first)
+  end
+
+  def self.github_repository_name
+    (Brief.profile.github_repository_name rescue nil) || Brief::Git.current_github_repository.try(:split, '/').try(:last)
+  end
+
+  def self.repository_issues
+    @repository_issues ||= Brief::GithubClient::RepositoryIssues.new(user: github_nickname, repo: github_repository_name)
+  end
+
+  def self.repository_milestones
+    @repository_milestones ||= Brief::GithubClient::RepositoryMilestones.new(user: github_nickname, repo: github_repository_name)
+  end
+end
+
+Brief.define "Project Overview" do
+  aliases :overview, :project_overview
+
+  before(:write) do
+    require "brief/github_client"
+    !Brief.config.github_repository.nil?
+  end
+
+  before(:publish) do
+    require "brief/github_client"
+    !Brief.config.github_repository.nil?
+  end
+
+  sample <<-EOF
+  # This is a project overview
+
+  A body paragraph or two here will be the content for a cover page. You can supply whatever background
+  info, domain knowledge requirements, processes, file dependencies and links, whatever.
+
+  The content for the nested milestones and issues below will be transformed into raw markdown
+  which will generate a status summary of the milestones and issues as they get created in the Github API.
+
+  ## This is a milestone heading
+
+  A milestone is some logical way of grouping issues and attaching a date to them. You will write the body
+  of the individual issues and optionally assign them or label them by writing them below. When this brief
+  gets published, the issues will be created and added to the milestone.
+
+  ### This is an issue that belongs to the above milestone
+
+  The content of your issue goes here. Normal github flavored markdown is supported.
+  EOF
+
+  levels do
+    order(2,3,1)
+
+    level(1) do
+      desc "Wiki Page"
+      define_handler :publish, "Brief::Handlers::GithubWiki"
+      replaces_items_from_level 2, :with => "Brief::Formatters::GithubMilestoneRollup"
+    end
+
+    level(2) do
+      desc "Github Milestone"
+      define_handler :publish, "Brief::Handlers::GithubMilestone"
+      replaces_items_from_level 3, :with => nil
+    end
+
+    level(3) do
+      desc "Github Issue"
+      define_handler :publish, "Brief::Handlers::GithubIssue"
+    end
+  end
+end
+

data/lib/brief/github_client/authentication.rb

@@ -0,0 +1,32 @@
+module Brief::GithubClient
+  class Authentication
+    attr_accessor :github_token, :options
+
+    InvalidAuth = Class.new(Exception)
+
+    def initialize(options={})
+      options.symbolize_keys! if options.is_a?(Hash)
+      @options = options
+      fetch_token
+    end
+
+    protected
+
+    def fetch_token
+      @github_token = case
+      when options.respond_to?(:github_token)
+        options.github_token
+      when options.is_a?(Hash) && options.has_key?(:github_token)
+        options[:github_token]
+      when options.is_a?(Hash) && (options.has_key?(:username) && options.has_key?(:password))
+        raise "Not implemented. use personal access tokens."
+
+      when "#{ENV['GITHUB_TOKEN']}".length > 1
+        ENV['GITHUB_TOKEN']
+      else
+        raise InvalidAuth
+      end
+
+    end
+  end
+end

data/lib/brief/github_client/client.rb

@@ -0,0 +1,86 @@
+require 'typhoeus'
+
+class Brief::GithubClient::Client
+  attr_accessor :options, :cache
+
+  InvalidAuth = Class.new(Exception)
+
+  def initialize options={}
+    @options = options
+
+    if options[:auto]
+      options[:github_token] ||= Brief::GithubClient::Authentication.new.github_token
+    end
+  end
+
+  def request_wrapper_class
+    Brief::GithubClient::RequestWrapper
+  end
+
+  def fetch(request_type,*args)
+    fetch_request_object(request_type, *args).to_object
+  end
+
+  def fetch_request_object request_type, *args
+    options = args.extract_options!
+    request_type = request_type.to_s.camelize
+
+    if request_klass = Brief::GithubClient.const_get(request_type) rescue nil
+      request_klass.new(options)
+    end
+  end
+
+  def github_token
+    options.fetch(:github_token, impersonate_user.try(:github_token))
+  end
+
+  def impersonate_user
+    @impersonate_user ||= options.fetch(:user, nil)
+  end
+
+  def headers
+    base = {
+      "Authorization"   => "token #{ github_token }",
+      "Accepts"         => "application/json"
+    }
+
+    base.merge(options[:headers] || {}).stringify_keys
+  end
+
+  def anonymous?
+    !!(options[:public] || options[:anonymous])
+  end
+
+  def delete_request type, params={}
+    if !github_token.present? && !anonymous?
+      raise InvalidAuth
+    end
+
+    request_wrapper_class.new(type,params,headers).delete
+  end
+
+  def post_request type, params={}
+    if !github_token.present? && !anonymous?
+      raise InvalidAuth
+    end
+
+    request_wrapper_class.new(type,params,headers).post
+  end
+
+  def get_request type, params={}
+    if !github_token.present? && !anonymous?
+      raise InvalidAuth
+    end
+
+    request_wrapper_class.new(type,params,headers).get
+  end
+
+  def update_request type, params={}
+    if !github_token.present? && !anonymous?
+      raise InvalidAuth
+    end
+
+    request_wrapper_class.new(type,params,headers).update
+  end
+
+end

data/lib/brief/github_client/commands.rb

@@ -0,0 +1,5 @@
+module Brief::GithubClient
+  module Commands
+
+  end
+end

data/lib/brief/github_client/issue_labels.rb

@@ -0,0 +1,65 @@
+module Brief::GithubClient
+  class IssueLabels < Request
+
+    requires :org, :repo
+
+    def endpoint
+      "repos/#{ org }/#{ repo }/labels"
+    end
+
+    Defaults = {
+      # stage labels
+      "s:backlog"       => "c7def8",
+      "s:greenlit"      => "bfe5bf",
+      "s:review"        => "fef2c0",
+      "s:in_progress"   => "3ded58",
+
+      # priority labels
+      "p:1"             => "e11d21",
+      "p:2"             => "eb6420",
+
+      # type labels
+      "t:development"   => "bada55",
+      "t:design"        => "55adba",
+      "t:ux"            => "2234fe",
+      "t:project"       => "ae3498",
+
+      # acceptance labels
+      "a:approved"      => "339933",
+      "a:rejected"      => "993333"
+    }
+
+    def missing_defaults
+      current = all.collect(&:name)
+      @missing_defaults ||= Defaults.keys - current
+    end
+
+    def missing_defaults?
+      missing_defaults.length > 0
+    end
+
+    def create_status_sort_labels
+      Defaults.each do |name, color|
+        create_or_update(name, color)
+      end
+    end
+
+    def delete_github_defaults
+      %w{bug duplicate enhancement invalid wontfix question}.each do |name|
+        destroy(name)
+      end
+    end
+
+    def create_or_update name, color
+      existing = show(name)
+
+      unless existing.nil? || (existing.present? && existing.respond_to?(:message))
+        update(name, name: name, color: color)
+        return show(name)
+      end
+
+      create(name: name, color: color)
+    end
+
+  end
+end

data/lib/brief/github_client/issues.rb

@@ -0,0 +1,22 @@
+module Brief::GithubClient
+  class Issues < Request
+    requires :org, :repo
+
+    def endpoint
+      case
+      when supplied_org && repo
+        "#{ supplied_org }/#{ repo }/issues"
+      when user && repo
+        "repos/#{ user }/#{ repo }/issues"
+      when supplied_org
+        "orgs/#{ supplied_org }/issues"
+      when user
+        "users/#{ user }/issues"
+      end
+    end
+
+    def params
+      @params.merge(sort:"updated")
+    end
+  end
+end

data/lib/brief/github_client/milestone_issues.rb

@@ -0,0 +1,13 @@
+module Brief::GithubClient
+  class MilestoneIssues < RepositoryIssues
+    def params
+      p = @params
+
+      if options[:milestone] && milestone.respond_to?(:number)
+        p[:milestone_number] = milestone.number
+      end
+
+      p
+    end
+  end
+end

data/lib/brief/github_client/organization_activity.rb

@@ -0,0 +1,9 @@
+module Brief::GithubClient
+  class OrganizationActivity < Request
+    requires :supplied_org, :user
+
+    def endpoint
+      "users/#{ user }/events/orgs/#{ org }"
+    end
+  end
+end

data/lib/brief/github_client/organization_issues.rb

@@ -0,0 +1,13 @@
+module Brief::GithubClient
+  class OrganizationIssues < Request
+    requires :supplied_org
+
+    def endpoint
+      "orgs/#{ org }/issues"
+    end
+
+    def params
+      @params.merge(sort:"updated")
+    end
+  end
+end

data/lib/brief/github_client/organization_repositories.rb

@@ -0,0 +1,20 @@
+module Brief::GithubClient
+  class OrganizationRepositories < Request
+    requires :supplied_org
+
+    def endpoint
+      "orgs/#{ org }/repos"
+    end
+
+    def all
+      @all ||= self.result
+    end
+
+    def to_list
+      all.map do |repository|
+        repository.slice("id","name","html_url","description","ssh_url")
+      end
+    end
+
+  end
+end

data/lib/brief/github_client/organization_users.rb

@@ -0,0 +1,9 @@
+module Brief::GithubClient
+  class OrganizationUsers < Request
+    requires :supplied_org
+
+    def endpoint
+      "orgs/#{ org }/members"
+    end
+  end
+end

data/lib/brief/github_client/repository_events.rb

@@ -0,0 +1,8 @@
+module Brief::GithubClient
+  class RepositoryEvents < Request
+    requires :org, :repo
+    def endpoint
+      "repos/#{ org }/#{ repo }/events"
+    end
+  end
+end

data/lib/brief/github_client/repository_issue_events.rb

@@ -0,0 +1,9 @@
+module Brief::GithubClient
+  class RepositoryIssueEvents < Request
+    requires :org, :repo
+
+    def endpoint
+      "repos/#{ org }/#{ repo }/issues/events"
+    end
+  end
+end

data/lib/brief/github_client/repository_issues.rb

@@ -0,0 +1,8 @@
+module Brief::GithubClient
+  class RepositoryIssues < Request
+    requires :org, :repo
+    def endpoint
+      "repos/#{ org }/#{ repo }/issues"
+    end
+  end
+end

data/lib/brief/github_client/repository_labels.rb

@@ -0,0 +1,18 @@
+module Brief::GithubClient
+  class RepositoryLabels < Request
+    requires :org, :repo
+
+    def endpoint
+      "repos/#{ org }/#{ repo }/labels"
+    end
+
+    def stage_labels
+      @stage_labels ||= all.select {|label| label.name && label.name.match(/^s:/) }
+    end
+
+    def priority_labels
+      @priority_labels ||= all.select {|label| label.name && label.name.match(/^p:/) }
+    end
+
+  end
+end

data/lib/brief/github_client/repository_milestones.rb

@@ -0,0 +1,9 @@
+module Brief::GithubClient
+  class RepositoryMilestones < Request
+    requires :org, :repo
+
+    def endpoint
+      "repos/#{ org }/#{ repo }/milestones"
+    end
+  end
+end

data/lib/brief/github_client/request.rb

@@ -0,0 +1,181 @@
+require 'rubygems'
+require 'escape_utils'
+require 'uri_template'
+
+class Brief::GithubClient::Request
+
+  MissingArguments = Class.new(Exception)
+
+  attr_accessor :options, :user, :org, :repo, :params, :headers, :github_token
+
+  class << self
+    attr_accessor :_required_arguments
+  end
+
+  def self.requires *args
+    (self._required_arguments = args).uniq!
+  end
+
+  def self.required_arguments
+    Array(self._required_arguments).uniq
+  end
+
+  def initialize(options={}, &block)
+    @options = options.with_indifferent_access.dup
+    @client, @user, @org, @repo, @github_token = options.values_at(:client, :user,:org,:repo,:github_token)
+    @params   = options[:params] || {}
+    @headers  = options[:headers] || {}
+
+    instance_eval(&blk) if block_given?
+
+    assert_valid_arguments!
+  end
+
+  def required_arguments
+    Array(self.class._required_arguments)
+  end
+
+  def with_valid_arguments &blk
+    instance_eval(&blk) if block_given?
+    assert_valid_arguments!
+    self
+  end
+
+  def assert_valid_arguments!
+    return true if required_arguments.length > 0
+
+    valid = required_arguments.all? do |arg|
+      test = false
+      test = true if !!self.send(arg).present?
+      test = true if options.has_key?(arg)
+
+      test
+    end
+
+    raise MissingArguments unless valid
+  end
+
+  def to_object
+    req = self
+
+    response_wrapper = lambda do |r|
+      Brief::GithubClient::ResponseObject.new(r).with_request_object(req)
+    end
+
+    return object.map(&response_wrapper) if object.is_a?(Array)
+
+    response_wrapper.call(object)
+  end
+
+  def object
+    records
+  end
+
+  def refresh
+    @request = nil
+    self
+  end
+
+  def all
+    to_object
+  end
+
+  def create params={}
+    client.post_request(request_endpoint, params).request.run
+  end
+
+  def create_object params={}
+    resp = create(params)
+    Hashie::Mash.new(JSON.parse(resp.body))
+  end
+
+  def update record_id, params={}
+    client.update_request("#{ request_endpoint }/#{ record_id }", params).request.run
+  end
+
+  def update_object record_id, params={}
+    resp = update(record_id, params)
+    Hashie::Mash.new(JSON.parse(resp.body))
+  end
+
+  def destroy record_id, params={}
+    client.delete_request("#{ request_endpoint }/#{ record_id }").request.run
+  end
+
+  def show record_id, params={}
+    client.get_request("#{ request_endpoint }/#{ record_id }", params).to_object
+  end
+
+  def client
+    return @client if @client
+
+    if impersonate_user.present?
+      @client = Brief::GithubClient::Client.new(user: impersonate_user, headers: headers, github_token: github_token)
+    end
+
+    @client = Brief.github_client
+  end
+
+  def records
+    @records = request.records
+  end
+
+  def results
+    records
+  end
+
+  def result
+    records
+  end
+
+  def request_endpoint
+    options.fetch(:endpoint, endpoint)
+  end
+
+  def request refresh=false
+    @request = nil if refresh
+    @request ||= client.get_request(request_endpoint, params)
+  end
+
+  def organization_or_user
+    supplied_org || user
+  end
+
+  def user_or_organization
+    supplied_user || supplied_org
+  end
+
+  def org
+    organization_or_user
+  end
+
+  # The idea of 'supplied' means it was provided to the object
+  # and not calculated in any way.  This is used when determining
+  # the value for the endpoint, in the context of a github user vs github organization
+  def supplied_org
+    @org
+  end
+
+  def supplied_user
+    @user
+  end
+
+  def supplied_repo
+    @repo
+  end
+
+  protected
+    def github_token
+      @github_token || impersonate_user.try(:github_token) || Brief.config.github_token
+    end
+
+    def endpoint
+      "users/#{ user }"
+    end
+
+    def impersonate_user
+      if defined?(::User) && ::User.respond_to?(:find_by_github_nickname)
+        @impersonate_user ||= ::User.find_by_github_nickname(user)
+      end
+    end
+end