zenflow 0.8.11 → 0.8.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b67040a126c62ab1469ef2a30368d38de33c5fca
-  data.tar.gz: dcba8ef01d0261d39ee5d4f69c5c7f15a5bfda03
+  metadata.gz: 535021ad71ee3cd875c4678f99c3c27f8805f642
+  data.tar.gz: 68935fb8a30a1cf0eebcb3c64949ada99e050269
 SHA512:
-  metadata.gz: 2ad33edb69aa5f56bd4946c1c05f60e7dcf3618e94c9ec30e04af4043be80ff0097af464d939431d070377f95b06088abaa27a80b0356ec663928a26505b1104
-  data.tar.gz: 99c6641438d33951e12418443b125d86dd1a35b56904d553508e0c1f6a3d8c8f036402ae10f5274fdfd9423a5a112c2101490e5e86a0fd82465132d7d9e71cb3
+  metadata.gz: 2372fe27f75467045ebb30314d5647ca5595179d5242165f6476ffe100bb8255ec04ed45d76f313db15114f39dcf3dc06e31e0cb14f24654234570441c461fc9
+  data.tar.gz: d4758ca08c2ee5833eea692a50be68dfb4a57913fc94361b18bfe13ed05571a474a728297b83e8b8846357e1391fa074affae33c3d22ddd8e6184cccbd35a577

data/CHANGELOG.md

@@ -10,3 +10,6 @@ CHANGELOG
 
 ---- 0.8.11 / 2014-07-11 / merge-hotfixes-and-releases-into-master-and-production 
 * hotfixes should merge into the development branch as well as the source branch
+
+---- 0.8.12 / 2014-08-12 / updates-for-github-enterprise-support
+* updates for github enterprise support

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    zenflow (0.8.11)
+    zenflow (0.8.12)
       colored (~> 1.2)
       httparty (~> 0.13.0)
       terminal-table (~> 1.4.5)

data/README.markdown

@@ -12,6 +12,7 @@
 * [Usage](#usage)
 * [Commands Quick Reference](#commands)
 * [Requirements](#requirements)
+* [Enterprise Configuration](#enterprise)
 
 -------
 
@@ -89,6 +90,7 @@ To deploy to production, type `zenflow deploy production`. Hotfixes are not auto
     zenflow (feature|hotfix|release) review
     zenflow (feature|hotfix|release) finish
     zenflow deploy (qa|staging|production)
+    zenflow admin (list|current|describe|config|authorize)
 
 ### <a name="requirements"></a> Requirements/Assumptions
 
@@ -96,3 +98,9 @@ To deploy to production, type `zenflow deploy production`. Hotfixes are not auto
 * Ruby >= 1.9.3
 * Capistrano and cap-ext
 * A repository on GitHub
+
+### <a name="enterprise"></a> Enterpise Configuration
+
+Zenflow now supports repositories hosted on enterprise github servers.  `zenflow init` will automatically detect which server is hosting your repository by examining the remote string returned by `git remote -v`.  If it is an enterprise server, Zenflow will ask for additional configuration parameters including the API base URL of the enterprise server and an optional over-ride for the User-Agent header that Zenflow submits to the server.  All configuration parameters are stored in git config.
+
+Zenflow can handle any number of enterprise github servers in addition to working with the primary github server at github.com.  To examine the github server configurations of your Zenflow install use the `zenflow admin ...` set of commands.

data/VERSION.yml

@@ -1,5 +1,5 @@
 ---
 major: 0
 minor: 8
-patch: 11
+patch: 12
 pre: 

data/lib/zenflow.rb

@@ -26,10 +26,10 @@ require 'zenflow/helpers/branch_commands/review'
 require 'zenflow/helpers/branch_commands/start'
 require 'zenflow/helpers/branch_commands/update'
 require 'zenflow/helpers/branch_command'
+require 'zenflow/commands/admin'
 require 'zenflow/commands/deploy'
 require 'zenflow/commands/feature'
 require 'zenflow/commands/hotfix'
-require 'zenflow/commands/hubs'
 require 'zenflow/commands/release'
 require 'zenflow/commands/reviews'
 require 'zenflow/cli'

data/lib/zenflow/cli.rb

@@ -20,8 +20,8 @@ module Zenflow
       super
     end
 
-    desc "hubs SUBCOMMAND", "Manage Github server configurations."
-    subcommand "hubs", Zenflow::Hubs
+    desc "admin SUBCOMMAND", "Manage Github server configurations."
+    subcommand "admin", Zenflow::Admin
 
     desc "feature SUBCOMMAND", "Manage feature branches."
     subcommand "feature", Zenflow::Feature
@@ -54,29 +54,6 @@ module Zenflow
       end
     end
 
-    desc "set_up_github", "Set up GitHub user information"
-    def set_up_github
-      user = Zenflow::Github.user(Zenflow::Github::DEFAULT_HUB)
-      if user.to_s != ''
-        if Zenflow::Ask("Your GitHub user is currently #{user}. Do you want to use that?", :options => ["Y", "n"], :default => "y") == "n"
-          Zenflow::Github.set_user(Zenflow::Github::DEFAULT_HUB)
-        end
-      else
-        Zenflow::Github.set_user(Zenflow::Github::DEFAULT_HUB)
-      end
-    end
-
-    desc "authorize_github", "Get an auth token from GitHub"
-    def authorize_github
-      if Zenflow::Github.zenflow_token(Zenflow::Github::DEFAULT_HUB)
-        if Zenflow::Ask("You already have a token from GitHub. Do you want to set a new one?", :options => ["y", "N"], :default => "n") == "y"
-          Zenflow::Github.authorize(Zenflow::Github::DEFAULT_HUB)
-        end
-      else
-        Zenflow::Github.authorize(Zenflow::Github::DEFAULT_HUB)
-      end
-    end
-
     no_commands do
 
       def already_configured
@@ -90,14 +67,12 @@ module Zenflow
       end
 
       def configure_github
-        #TODO: consolidate these two paths
-        if Zenflow::Repo.is_default_hub?
-          set_up_github
-          authorize_github
+        if Zenflow::Github::CURRENT.is_default_hub?
+          Zenflow::Github::CURRENT.set_user
         else
-          Zenflow::Hubs.config
-          Zenflow::Hubs.authorize
+          Zenflow::Github::CURRENT.config
         end
+        Zenflow::Github::CURRENT.authorize
       end
 
       def configure_project

data/lib/zenflow/commands/admin.rb

@@ -0,0 +1,88 @@
+module Zenflow
+  class Admin < Thor
+
+    desc "list", "Show all configured hubs."
+    def list
+      Zenflow::Log("Recogized hubs")
+      Zenflow::Log(Terminal::Table.new(
+        headings: ['Hub'],
+        rows: get_list_of_hubs()
+      ).to_s, indent: false, arrows: false, color: false)
+    end
+
+    desc "current", "Show the current project's hub."
+    def current
+      Zenflow::Log("This project's hub is #{hub_label(Zenflow::Github::CURRENT.hub)}")
+    end
+
+    desc "describe [HUB]", "Show configuration details for HUB (current project hub if none specified, or default if no current project)."
+    def describe(hub=nil)
+      hub = resolve_hub(hub)
+
+      Zenflow::Log("Configuration details for hub #{hub_label(hub.hub)}")
+
+      Zenflow::Log(Terminal::Table.new(
+        headings: ["Parameter", "Github Config Key", "Github Config Value", "Value (with system defaults)"],
+        rows: hub.describe
+      ).to_s, indent: false, arrows: false, color: false)
+    end
+
+    desc "config [HUB]", "Configure the specified HUB (current project hub if none specified, or default hub if no current project)."
+    def config(hub=nil)
+      hub = resolve_hub(hub)
+
+      Zenflow::Log("Configuring #{hub_label(hub.hub)}")
+
+      hub.config
+    end
+
+    desc "authorize [HUB]", "Grab an auth token for HUB (current project hub if none specified, or default hub if no current project)."
+    def authorize(hub=nil)
+      hub = resolve_hub(hub)
+
+      Zenflow::Log("Authorizing #{hub_label(hub.hub)}")
+
+      hub.authorize
+    end
+
+    no_commands {
+      def resolve_hub(hub=nil)
+        hub = Zenflow::Github.new(hub) if hub
+        hub ||= Zenflow::Github::CURRENT
+      end
+
+      def get_list_of_hubs
+        hub_config_parameters = Zenflow::Shell.run("git config --get-regexp zenflow\.hub\..*", silent: true).split("\n")
+
+        # unique, sorted, list of hubs with at least one valid config key
+        configured_hubs = hub_config_parameters.inject([]) { |hubs, parameter|
+          if parameter =~ /^zenflow\.hub\.(.*)\.#{config_keys_regex}\s.*$/
+            hubs << [hub_label($1)]
+          end
+
+          hubs
+        }.sort.uniq
+
+        [
+          ["#{hub_label(Zenflow::Github::DEFAULT_HUB)}"]
+        ] + configured_hubs
+      end
+
+      def hub_label(hub)
+        "#{hub}#{default_hub_tag(hub)}#{current_hub_tag(hub)}"
+      end
+
+      def default_hub_tag(hub)
+        hub == Zenflow::Github::DEFAULT_HUB ? " [default]" : ""
+      end
+
+      def current_hub_tag(hub)
+        hub == Zenflow::Github::CURRENT.hub ? " [current]" : ""
+      end
+
+      def config_keys_regex
+        "(?:#{Zenflow::Github::CONFIG_KEYS.map { |s| s.gsub('.','\\.') }.join('|')})"
+      end
+    }
+  end
+end

data/lib/zenflow/helpers/github.rb

@@ -1,6 +1,6 @@
 module Zenflow
 
-  module Github
+  class Github
     DEFAULT_HUB = 'github.com'
 
     DEFAULT_API_BASE_URL = 'https://api.github.com'
@@ -18,105 +18,148 @@ module Zenflow
       USER_AGENT_BASE_KEY
     ]
 
-    def self.api_base_url(hub=nil,useDefaultValue=true)
-      api_base_url = get_config_for_hub(hub, API_BASE_URL_KEY)
-      api_base_url ||= DEFAULT_API_BASE_URL if useDefaultValue
+    @hub = nil
+    def hub
+      @hub
+    end
+
+    def initialize(hub)
+      @hub = hub
+    end
+
+    def self.current
+      Github.new(Zenflow::Repo.hub || DEFAULT_HUB)
+    end
+
+    CURRENT = current
+
+    def config
+      set_api_base_url
+      set_user
+      set_user_agent_base
+    end
+
+    def api_base_url(use_default_when_value_is_nil=true)
+      api_base_url = get_config(API_BASE_URL_KEY)
+      api_base_url ||= DEFAULT_API_BASE_URL if use_default_when_value_is_nil
       api_base_url
     end
 
-    def self.set_api_base_url(hub=nil)
-      api_base_url = Zenflow::Ask("What is the base URL of your Github API?", {:default => DEFAULT_API_BASE_URL})
-      set_config_for_hub(hub, API_BASE_URL_KEY, api_base_url)
+    def ask_should_update_base_api_url?
+      Zenflow::Ask("The GitHub API base URL for this hub is currently #{api_base_url(false)}. Do you want to use that?", :options => ["Y", "n"], :default => "y") == "n"
+    end
+
+    def set_api_base_url
+      if api_base_url(false).nil? || ask_should_update_base_api_url?
+        api_base_url = Zenflow::Ask("What is the base URL of your Github API?", {:default => DEFAULT_API_BASE_URL})
+        set_config(API_BASE_URL_KEY, api_base_url)
+      end
+    end
+
+    def user
+      get_config(USER_KEY)
+    end
+
+    def ask_should_update_user?
+      Zenflow::Ask("The GitHub user for this hub is currently #{user}. Do you want to use that?", :options => ["Y", "n"], :default => "y") == "n"
     end
 
-    def self.user(hub=nil)
-      get_config_for_hub(hub, USER_KEY)
+    def set_user
+      if user.nil? || ask_should_update_user?
+        username = Zenflow::Ask("What is your Github username?")
+        set_config(USER_KEY, username)
+      end
     end
 
-    def self.set_user(hub=nil)
-      username = Zenflow::Ask("What is your Github username?")
-      set_config_for_hub(hub, USER_KEY, username)
+    def zenflow_token
+      get_config(TOKEN_KEY)
     end
 
-    def self.zenflow_token(hub=nil)
-      get_config_for_hub(hub, TOKEN_KEY)
+    def ask_should_update_zenflow_token?
+      Zenflow::Ask("You already have a token from GitHub. Do you want to set a new one?", :options => ["y", "N"], :default => "n") == "y"
     end
 
-    def self.authorize(hub=nil)
-      Zenflow::Log("Authorizing with GitHub (#{user(hub)}@#{resolve_hub(hub)})... Enter your GitHub password.")
-      oauth_response = JSON.parse(Zenflow::Shell.run(%{curl -u "#{Zenflow::Github.user(hub)}" #{Zenflow::Github.api_base_url(hub)}/authorizations -d '{"scopes":["repo"], "note":"Zenflow"}' --silent}, silent: true))
-      if oauth_response['token']
-        set_config_for_hub(hub, TOKEN_KEY, oauth_response['token'])
-        Zenflow::Log("Authorized!")
-      else
-        Zenflow::Log("Something went wrong. Error from GitHub was: #{oauth_response['message']}")
-        return
+    def authorize
+      if zenflow_token.nil? || ask_should_update_zenflow_token?
+        Zenflow::Log("Authorizing with GitHub (#{user}@#{@hub})... Enter your GitHub password.")
+        oauth_response = JSON.parse(Zenflow::Shell.run(%{curl -u "#{user}" #{api_base_url}/authorizations -d '{"scopes":["repo"], "note":"Zenflow"}' --silent}, silent: true))
+        if oauth_response['token']
+          set_config(TOKEN_KEY, oauth_response['token'])
+          Zenflow::Log("Authorized!")
+        else
+          Zenflow::Log("Something went wrong. Error from GitHub was: #{oauth_response['message']}")
+          return
+        end
       end
     end
 
-    def self.user_agent_base(hub=nil,useDefaultValue=true)
-      user_agent_base = get_config_for_hub(hub, USER_AGENT_BASE_KEY)
-      user_agent_base ||= DEFAULT_USER_AGENT_BASE if useDefaultValue
+    def user_agent_base(use_default_when_value_is_nil=true)
+      user_agent_base = get_config(USER_AGENT_BASE_KEY)
+      user_agent_base ||= DEFAULT_USER_AGENT_BASE if use_default_when_value_is_nil
       user_agent_base
     end
 
-    def self.set_user_agent_base(hub=nil)
-      user_agent_base = Zenflow::Ask("What base string would you like to use for the User Agent header, 'User-Agent: [user-agent-base]/Zenflow-#{VERSION}?", {:default => DEFAULT_USER_AGENT_BASE})
-      set_config_for_hub(hub, USER_AGENT_BASE_KEY, user_agent_base)
+    def ask_should_update_user_agent_base?
+      Zenflow::Ask("The GitHub User Agent base for this hub is currently #{user_agent_base(false)}. Do you want to use that?", :options => ["Y", "n"], :default => "y") == "n"
     end
 
-    def self.resolve_hub(hub)
-      hub || Zenflow::Repo.hub || DEFAULT_HUB
+    def set_user_agent_base
+      if user_agent_base(false).nil? || ask_should_update_user_agent_base?
+        user_agent_base = Zenflow::Ask("What base string would you like to use for the User Agent header, 'User-Agent: [user-agent-base]/Zenflow-#{VERSION}?", {:default => DEFAULT_USER_AGENT_BASE})
+        set_config(USER_AGENT_BASE_KEY, user_agent_base)
+      end
     end
 
     # If this repo is not hosted on the default github, construct a key prefix containing the hub information
-    def self.construct_key_for_hub(hub, key)
+    def parameter_key_for_hub(key)
       default_hub_key_prefix = key == USER_KEY ? "" : "zenflow."  # preserves backwards compatibility
-      Zenflow::Repo.is_default_hub?(hub) ? "#{default_hub_key_prefix}#{key}" : "zenflow.hub.#{hub}.#{key}"
+      is_default_hub? ? "#{default_hub_key_prefix}#{key}" : "zenflow.hub.#{@hub}.#{key}"
     end
 
-    def self.get_config_for_hub(hub, key)
-      resolved_hub = resolve_hub(hub)
-      key_for_hub = construct_key_for_hub(resolved_hub, key)
-      get_global_config(key_for_hub)
+    def get_config(base_parameter_key)
+      parameter_key_for_hub = parameter_key_for_hub(base_parameter_key)
+      get_global_config(parameter_key_for_hub)
     end
 
-    def self.set_config_for_hub(hub, key, value)
-      resolved_hub = resolve_hub(hub)
-      key_for_hub = construct_key_for_hub(resolved_hub, key)
-      set_global_config(key_for_hub, value)
+    def set_config(base_parameter_key, value)
+      parameter_key_for_hub = parameter_key_for_hub(base_parameter_key)
+      set_global_config(parameter_key_for_hub, value)
     end
 
-    def self.get_global_config(key)
+    def get_global_config(key)
       config = Zenflow::Shell.run("git config --get #{key.to_s}", silent: true)
       config = config.chomp unless config.nil?
       config.to_s == '' ? nil : config
     end
 
-    def self.set_global_config(key, value)
+    def set_global_config(key, value)
       Zenflow::Shell.run("git config --global #{key} #{value}", silent: true)
     end
 
-    def self.describe_hub_parameter(name, hub, key, value)
-      [name, construct_key_for_hub(hub, key), get_config_for_hub(hub, key), value]
+    def is_default_hub?
+      @hub == DEFAULT_HUB
+    end
+
+    def describe_parameter(name, parameter_key, value)
+      [name, parameter_key_for_hub(parameter_key), get_config(parameter_key), value]
     end
 
-    def self.describe_hub(hub)
+    def describe
       [
-        describe_hub_parameter("API Base URL",    hub, API_BASE_URL_KEY,    api_base_url(hub)),
-        describe_hub_parameter("User",            hub, USER_KEY,            user(hub)),
-        describe_hub_parameter("Token",           hub, TOKEN_KEY,           zenflow_token(hub)),
-        describe_hub_parameter("User Agent Base", hub, USER_AGENT_BASE_KEY, user_agent_base(hub))
+        describe_parameter("API Base URL",    API_BASE_URL_KEY,    api_base_url),
+        describe_parameter("User",            USER_KEY,            user),
+        describe_parameter("Token",           TOKEN_KEY,           zenflow_token),
+        describe_parameter("User Agent Base", USER_AGENT_BASE_KEY, user_agent_base)
       ]
     end
   end
 
   class GithubRequest
     include HTTParty
-    base_uri "#{Zenflow::Github.api_base_url}/repos/#{Zenflow::Repo.slug}"
+    base_uri "#{Github::CURRENT.api_base_url}/repos/#{Zenflow::Repo.slug}"
     format :json
-    headers "Authorization" => "token #{Zenflow::Github.zenflow_token}"
-    headers "User-Agent" => "#{Zenflow::Github.user_agent_base}/Zenflow-#{VERSION}"
+    headers "Authorization" => "token #{Github::CURRENT.zenflow_token}"
+    headers "User-Agent" => "#{Github::CURRENT.user_agent_base}/Zenflow-#{VERSION}"
   end
 
 end

data/lib/zenflow/helpers/repo.rb

@@ -12,14 +12,5 @@ module Zenflow
     def self.slug
       (url && url[/:(.*?)\.git/, 1]) || nil
     end
-
-    def self.is_current_hub?(check)
-      hub == check
-    end
-
-    def self.is_default_hub?(check=nil)
-      (check ? check : hub) == Zenflow::Github::DEFAULT_HUB
-    end
-
   end
 end