codeunion 0.0.2 → 0.0.3

data/lib/codeunion/feedback_request.rb

@@ -0,0 +1,97 @@
+require "uri"
+require "codeunion/github_api"
+require "addressable/uri"
+
+module CodeUnion
+  # Sends feedback requests to CodeUnion for review
+  class FeedbackRequest
+    WEB_URL_REGEX = /\A#{URI.regexp(['http', 'https'])}\z/
+
+    GIT_URL_REGEX = %r{\A(git://)?git@github.com:(.*)(.git)?\z}
+    REPO_CAPTURE_INDEX = 1
+
+    MISSING_ARTIFACT = "You must provide something to provide feedback on"
+    INVALID_ARTIFACT = "The artifact provided was not a web URL. We only provide feedback on code hosted online."
+
+    ISSUE_TITLE = "Please give my code feedback. Submitted #{Time.now}"
+
+    attr_reader :artifact
+
+    def initialize(artifact, github_token, feedback_repository, options = {})
+      @github_api = options.fetch(:github_api, GithubAPI).new(github_token)
+      @artifact = artifact
+      @feedback_repository = FeedbackRepository.coerce_to_proper_url(feedback_repository)
+    end
+
+    def send!
+      @github_api.create_issue(ISSUE_TITLE, @artifact, @feedback_repository)
+    end
+
+    def valid?
+      errors.empty?
+    end
+
+    def errors
+      errors = []
+      errors.push(MISSING_ARTIFACT) if artifact.empty?
+      errors.push(INVALID_ARTIFACT) unless url?(artifact)
+
+      errors.join("\n")
+    end
+
+    private
+
+    def url?(url)
+      url =~ WEB_URL_REGEX
+    end
+
+    # Ensures a feedback repository location string is usable via the github api
+    class FeedbackRepository
+      DEFAULT_OWNER = "codeunion"
+
+      def self.coerce_to_proper_url(location)
+        new(location).to_s
+      end
+
+      def initialize(location)
+        @location = CLEAN.call(location)
+      end
+
+      def to_s
+        extract_owner_and_repo
+      end
+
+      private
+
+      CLEAN = ->(location) { location.gsub(/^\//, "").gsub(".git", "") }
+      EXTRACTORS = [
+        {
+          :match => ->(location) { location =~ GIT_URL_REGEX },
+          :extract => lambda do |location|
+            match = location.match(GIT_URL_REGEX)
+            CLEAN.call(match.captures[REPO_CAPTURE_INDEX])
+          end
+        },
+        {
+          :match => ->(location) { location =~ WEB_URL_REGEX },
+          :extract => ->(location) { CLEAN.call(URI(location).path) }
+        },
+        {
+          :match => ->(location) { location.split(/\//).length == 2 },
+          :extract => ->(location) { location }
+        },
+        {
+          :match => ->(_) { true },
+          :extract => ->(location) { "#{DEFAULT_OWNER}/#{location}" }
+        }
+      ]
+      def extract_owner_and_repo
+        EXTRACTORS.each do |extractor|
+          if extractor[:match].call(@location)
+            return extractor[:extract].call(@location)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/codeunion/github_api.rb

@@ -0,0 +1,19 @@
+require "codeunion/http_client"
+
+module CodeUnion
+  # Intent-revealing methods for interacting with Github with interfaces
+  # that aren't tied to the api calls.
+  class GithubAPI
+    def initialize(access_token)
+      @access_token = access_token
+      @http_client = HTTPClient.new("https://api.github.com")
+    end
+
+    def create_issue(title, content, repository)
+      @http_client.post("repos/#{repository}/issues", {
+        "title" => title,
+        "body" => content
+      }, { "access_token" => @access_token })
+    end
+  end
+end

data/lib/codeunion/helpers/text.rb

@@ -0,0 +1,38 @@
+require "codeunion"
+require "io/console"
+
+module CodeUnion
+  module Helpers
+    # Formats text for presenting to a  console
+    module Text
+      def format_output(text)
+        _rows, cols  = IO.console.winsize
+        line_length = [cols, 80].min
+
+        indent(wrap(text, line_length))
+      end
+
+      def wrap(text, max_width = IO.console.winsize.last)
+        return "" if text.empty?
+
+        words = text.split(/\s+/)
+        output = words.shift
+        chars_left = max_width - output.length
+
+        words.inject(output) do |output_builder, word|
+          if word.length + 1 > chars_left
+            chars_left = max_width - word.length
+            output_builder << "\n" + word
+          else
+            chars_left -= word.length + 1
+            output_builder << " " + word
+          end
+        end
+      end
+
+      def indent(lines, level = 1)
+        lines.split("\n").map { |line| ("  " * level) + line }.join("\n")
+      end
+    end
+  end
+end

data/lib/codeunion/http_client.rb

@@ -0,0 +1,55 @@
+require "faraday"
+require "faraday_middleware"
+require "multi_json"
+require "addressable/template"
+
+module CodeUnion
+  # More friendly RESTful interactions via Faraday and Addressable
+  class HTTPClient
+    def initialize(api_host)
+      @api_host = api_host
+    end
+
+    def get(endpoint, params = {})
+      connection.get(request_url(endpoint, params)).body
+    end
+
+    def post(endpoint, body = {}, params = {})
+      response = connection.post do |req|
+        req.url request_url(endpoint, params)
+        req.headers["Content-Type"] = "application/json"
+        req.body = body.to_json
+      end
+
+      unless (200..300).cover?(response.status)
+        message = "POST to #{request_url(endpoint, params)} with " +
+                  "#{body} responded with #{response.status} and " +
+                  "#{response.body}"
+        fail(HTTPClient::RequestError, message)
+      end
+      response.body
+    end
+
+    def request_url(endpoint, params = {})
+      expand_url({ :endpoint => endpoint, :params => params })
+    end
+
+    private
+
+    def expand_url(options = {})
+      template.expand(options)
+    end
+
+    def template
+      @template ||= Addressable::Template.new("{+endpoint}{?params*}")
+    end
+
+    def connection
+      @connection ||= Faraday.new(@api_host) do |conn|
+        conn.response :json
+        conn.adapter Faraday.default_adapter
+      end
+    end
+    class RequestError < StandardError; end
+  end
+end

data/lib/codeunion/search.rb

@@ -0,0 +1,51 @@
+require "rainbow"
+require "codeunion/helpers/text"
+
+module CodeUnion
+  class Search
+    # Prepares a search result for presentation in the CLI
+    class ResultPresenter
+      include CodeUnion::Helpers::Text
+      EXCERPT_REGEX = /<match>([^<]*)<\/match>/
+
+      def initialize(result)
+        @result = result
+      end
+
+      def to_s
+        [:name, :description, :url, :tags, :excerpt].map do |attribute|
+          format_output(send(attribute))
+        end.join("\n")
+      end
+
+      private
+
+      def name
+        "#{category}: " + Rainbow(@result["name"]).color(:blue)
+      end
+
+      def category
+        Rainbow(@result["category"].gsub(/s$/, "").capitalize).color(:red)
+      end
+
+      def description
+        Rainbow(@result["description"]).color(:yellow)
+      end
+
+      def excerpt
+        "Excerpt: " + @result["excerpt"].gsub(EXCERPT_REGEX) do
+          query_term = Regexp.last_match[1]
+          Rainbow(query_term).color(:blue)
+        end + "..."
+      end
+
+      def url
+        Rainbow(@result["url"]).color(:green)
+      end
+
+      def tags
+        "tags: " + @result["tags"].sort.join(", ")
+      end
+    end
+  end
+end

data/lib/codeunion/version.rb

@@ -1,3 +1,3 @@
 module CodeUnion
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/libexec/codeunion-config

@@ -0,0 +1,116 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+# Resolve the pathname for this executable
+require "pathname"
+bin_file = Pathname.new(__FILE__).realpath
+
+# Add the gem's "lib" directory to library path
+$LOAD_PATH.unshift File.expand_path("../../lib", bin_file)
+
+require "codeunion/command/config"
+require "optparse"
+
+options = {}
+subtext = <<HELP
+Commands are:
+  get NAME       - Retrieves and prints the named configuration value.
+  set NAME VALUE - Sets the named configuration to the given value.
+  unset NAME     - Removes the named configuration value.
+
+See 'codeunion config COMMAND --help' for more information on a specific command.
+HELP
+parser = OptionParser.new do |opts|
+  opts.instance_exec do
+    self.banner = "Usage: codeunion config COMMAND"
+    separator ""
+
+    separator subtext
+    separator ""
+
+    separator "Global options:"
+    on_tail("-d", "--[no-]debug", "Adds debug output.") do |debug|
+      options[:debug] = debug
+    end
+
+    on_tail("-h", "--help", "Print this help message") do
+      puts self
+      exit
+    end
+  end
+end
+
+commands = {}
+get_subtext = <<HELP
+Displays config variable NAME.  NAME may be a top-level key (i.e.  'codeunion')
+or nested, (i.e.  'codeunion.slack.username')
+HELP
+commands["get"] = OptionParser.new do |opts|
+  opts.instance_exec do
+    self.banner = "Usage: codeunion config get NAME"
+
+    separator ""
+    separator get_subtext
+    separator ""
+
+    separator "Options:"
+    on_tail("-h", "--help", "Print this help message") do
+      puts self
+      exit
+    end
+  end
+end
+
+set_subtext = <<HELP
+Sets config variable NAME to VALUE. NAME may be a top-level key (i.e.  'codeunion')
+or nested, (i.e.  'codeunion.slack.username').
+HELP
+
+commands["set"] = OptionParser.new do |opts|
+  opts.instance_exec do
+    self.banner = "Usage: codeunion config set NAME VALUE"
+
+    separator ""
+    separator set_subtext
+    separator ""
+
+    separator "Options:"
+    on_tail("-h", "--help", "Print this help message") do
+      puts self
+      exit
+    end
+  end
+end
+
+unset_subtext = <<HELP
+Unsets config variable NAME. NAME may be a top-level key (i.e.  'codeunion') or
+nested, (i.e.  'codeunion.slack.username').
+HELP
+commands["unset"] = OptionParser.new do |opts|
+  opts.instance_exec do
+    self.banner = "Usage: codeunion config unset NAME"
+
+    separator ""
+    separator unset_subtext
+    separator ""
+
+    separator "Options:"
+    on_tail("-h", "--help", "Print this help message") do
+      puts self
+      exit
+    end
+  end
+end
+
+parser.order!
+command = ARGV.shift
+if !command || !commands[command]
+  puts parser
+  exit
+else
+  commands[command].order!
+  options[:command] = command
+  options[:input] = ARGV
+  result = CodeUnion::Command::Config.new(options).run
+  puts result if result
+end

data/libexec/codeunion-examples

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+# Resolve the pathname for this executable
+require "pathname"
+bin_file = Pathname.new(__FILE__).realpath
+
+# Add the gem's "lib" directory to library path
+$LOAD_PATH.unshift File.expand_path("../../lib", bin_file)
+
+require "codeunion/command/search"
+require "optparse"
+
+options = {}
+parser = OptionParser.new do |opts|
+  opts.instance_exec do
+    self.banner = "Usage: codeunion examples <terms>"
+
+    on_tail("-h", "--help", "Print this help message") do
+      puts self
+      exit
+    end
+  end
+end
+
+if ARGV.empty?
+  puts parser
+  exit
+else
+  parser.parse!(ARGV)
+end
+
+options[:category] = "examples"
+options[:query] = ARGV
+
+result = CodeUnion::Command::Search.new(options).run
+puts result if result

data/libexec/codeunion-feedback

@@ -0,0 +1,98 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+# Resolve the pathname for this executable
+require "pathname"
+bin_file = Pathname.new(__FILE__).realpath
+
+# Add the gem's "lib" directory to library path
+$LOAD_PATH.unshift File.expand_path("../../lib", bin_file)
+
+require "codeunion/command/feedback"
+require "optparse"
+
+options = {}
+commands = {}
+subtext = <<HELP
+Commonly used command are:
+  request URL - (Default) - Sends a request for feedback to codeunion.
+
+See 'codeunion feedback COMMAND --help' for more information on a specific command.
+
+Make sure you `codeunion config set` the following:
+  github.access_token - Allows codeunion-client to interact with Github as you.
+                        See: https://help.github.com/articles/creating-an-access-token-for-command-line-use/
+
+  feedback.repository - The github repository to submit feedback requests in.
+                        (I.e. codeunion/feedback-requests-web-fundamentals)
+HELP
+
+top_level_parser = OptionParser.new do |opts|
+  opts.instance_exec do
+    self.banner = "Usage: codeunion feedback COMMAND"
+
+    separator ""
+    separator subtext
+
+    separator ""
+    separator "Global options:"
+    on_tail("-d", "--[no-]debug", "Adds debug output.") do |debug|
+      options[:debug] = debug
+    end
+
+    on_tail("-h", "--help", "Print this help message") do
+      puts self
+      exit
+    end
+  end
+end
+
+request_subtext = <<HELP
+URL should be a pull request or a specific commit.
+
+* How to get the URL for a commit: http://andrew.yurisich.com/work/2014/07/16/dont-link-that-line-number/
+* How to create a pull request: https://help.github.com/articles/creating-a-pull-request/
+HELP
+
+commands["request"] = OptionParser.new do |opts|
+  opts.instance_exec do
+    self.banner = "Usage: codeunion feedback request URL"
+
+    separator ""
+    separator request_subtext
+
+    separator ""
+    separator "Options:"
+
+    on_tail("-h", "--help", "Print this help message") do
+      puts self
+      exit
+    end
+  end
+end
+
+top_level_parser.order!
+command = ARGV.shift
+
+unless command
+  puts top_level_parser
+  exit
+end
+
+if command && !commands[command]
+  options[:input] = [command]
+  command = "request"
+else
+  commands[command].order!
+  options[:input] = ARGV
+end
+begin
+  CodeUnion::Command::Feedback.new(options).run
+rescue CodeUnion::Command::InvalidInput => e
+  puts "Woops! Error(s) found!"
+  puts e.message
+  puts commands[command]
+rescue CodeUnion::Command::MissingConfig => e
+  puts "Woops! You need to configure this command"
+  puts e.message
+end