thegarage-gitx 2.10.2 → 2.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c2e6a260e0bd7f13a9f8b2370fc820c12f38305d
-  data.tar.gz: 4f3cbe2290e5028707095755d9c724eca482e52b
+  metadata.gz: 8d556d4767bbd711d406930510b698a1811e063c
+  data.tar.gz: 4b71eb5f631cf5b9d134ab842df9136321ca2601
 SHA512:
-  metadata.gz: ebb0db12d2acb6f3524e106441ea11cf5c9894871d86e0a2f762f4bceaf64007ab32ec5709ee21117dc5ea18dc7bc8ad5bb4b9051a95305c1e809dc30b70d3de
-  data.tar.gz: 6e3271a045068dadaaf5c015c4afd7ef447c5ac821305de953750435d0cb88e8d03257877cb9644f121b26f081ab6f9f07de586c8ba343da457ac5fd6c922cf8
+  metadata.gz: 3baa98bde329c5ef4d7aa54610aa5393ef4899d7ed28e4558bad31df5d135f918983974947acea1f0a2f3db56d57506f2cf3696aaf7c44fae7095f9e9c90e0b0
+  data.tar.gz: 1d16107432222b84b7942a9be5af7be1875c15bd794432221667daaf0a8738155b740ab671cb13d9ea0488b9edcec0e35b5b069dd9fd757b6addbf412fec9348

data/.gitignore

@@ -23,3 +23,6 @@ pkg
 
 ## bundler
 Gemfile.lock
+
+## RSpec temp files
+spec/tmp

data/lib/thegarage/gitx/github.rb

@@ -1,8 +1,11 @@
 require 'octokit'
+require 'fileutils'
+require 'yaml'
 
 module Thegarage
   module Gitx
     module Github
+      GLOBAL_CONFIG_FILE = '~/.config/gitx/github.yml'
       REVIEW_CONTEXT = 'peer_review'
       CLIENT_URL = 'https://github.com/thegarage/thegarage-gitx'
       PULL_REQUEST_FOOTER = <<-EOS.dedent
@@ -79,42 +82,41 @@ module Thegarage
         body.gsub(PULL_REQUEST_FOOTER, '').chomp.strip
       end
 
-      # token is cached in local git config for future use
+      # authorization token used for github API calls
+      # the token is cached on the filesystem for future use
       # @return [String] auth token stored in git (current repo, user config or installed global settings)
       # @see http://developer.github.com/v3/oauth/#scopes
       # @see http://developer.github.com/v3/#user-agent-required
       def authorization_token
-        auth_token = repo.config['thegarage.gitx.githubauthtoken']
-        return auth_token unless auth_token.to_s.blank?
-
-        auth_token = create_authorization
-        repo.config['thegarage.gitx.githubauthtoken'] = auth_token
+        auth_token = global_config['token']
+        auth_token ||= begin
+          new_token = create_authorization
+          save_global_config('token' => new_token)
+          new_token
+        end
         auth_token
       end
 
       def create_authorization
-        password = ask("Github password for #{username}: ", :echo => false)
-        say ''
+        password = ask_without_echo("Github password for #{username}: ")
         client = Octokit::Client.new(login: username, password: password)
-        response = client.create_authorization(authorization_request_options)
+        options = {
+          :scopes => ['repo'],
+          :note => github_client_name,
+          :note_url => CLIENT_URL
+        }
+        two_factor_auth_token = ask_without_echo("Github two factor authorization token (if enabled): ")
+        options[:headers] = {'X-GitHub-OTP' => two_factor_auth_token} if two_factor_auth_token
+        response = client.create_authorization(options)
         response.token
       rescue Octokit::ClientError => e
         say "Error creating authorization: #{e.message}", :red
         retry
       end
 
-      def authorization_request_options
-        timestamp = Time.now.utc.strftime('%Y-%m-%dT%H:%M:%S%z')
-        client_name = "The Garage Git eXtensions - #{github_slug} #{timestamp}"
-        options = {
-          :scopes => ['repo'],
-          :note => client_name,
-          :note_url => CLIENT_URL
-        }
-        two_factor_auth_token = ask("Github two factor authorization token (if enabled): ", :echo => false)
-        say ''
-        options[:headers] = {'X-GitHub-OTP' => two_factor_auth_token} if two_factor_auth_token
-        options
+      def github_client_name
+        timestamp = Time.now.utc.strftime('%FT%R:%S%z')
+        client_name = "The Garage Git eXtensions #{timestamp}"
       end
 
       def github_client
@@ -142,6 +144,34 @@ module Thegarage
       def github_organization
         github_slug.split('/').first
       end
+
+      def global_config_file
+        File.expand_path(GLOBAL_CONFIG_FILE)
+      end
+
+      def global_config
+        @config ||= begin
+          File.exists?(global_config_file) ? YAML.load_file(global_config_file) : {}
+        end
+      end
+
+      def save_global_config(options)
+        config_dir = File.dirname(global_config_file)
+        ::FileUtils.mkdir_p(config_dir, mode: 0700) unless File.exists?(config_dir)
+
+        @config = global_config.merge(options)
+        File.open(global_config_file, "a+") do |file|
+          file.truncate(0)
+          file.write(@config.to_yaml)
+        end
+        File.chmod(0600, global_config_file)
+      end
+
+      def ask_without_echo(message)
+        value = ask(message, echo: false)
+        say ''
+        value
+      end
     end
   end
 end

data/lib/thegarage/gitx/version.rb

@@ -1,5 +1,5 @@
 module Thegarage
   module Gitx
-    VERSION = '2.10.2'
+    VERSION = '2.11.0'
   end
 end

data/spec/support/global_config.rb

@@ -0,0 +1,21 @@
+# helper for reading global config file
+module GlobalConfig
+  def global_config_file
+    config_dir = File.join(__dir__, '../tmp/.config/gitx')
+    config_file = File.join(config_dir, 'github.yml')
+    FileUtils.mkdir_p(config_dir) unless File.exists?(config_dir)
+    config_file
+  end
+  def global_config
+    YAML.load_file(global_config_file)
+  end
+end
+
+RSpec.configure do |config|
+  config.include GlobalConfig
+
+  config.before do
+    tmp_dir = File.join(__dir__, '../tmp')
+    FileUtils.rm_rf(tmp_dir)
+  end
+end

data/spec/support/home_env.rb

@@ -0,0 +1,11 @@
+# Swap home directory to current project spec/tmp
+# to allow for writing files + cleanup
+RSpec.configure do |config|
+  config.before do
+    @old_home = ENV['HOME']
+    ENV['HOME'] = File.join(__dir__, '../tmp')
+  end
+  config.after do
+    ENV['HOME'] = @old_home
+  end
+end

data/spec/thegarage/gitx/cli/review_command_spec.rb

@@ -209,7 +209,7 @@ describe Thegarage::Gitx::Cli::ReviewCommand do
         end.to raise_error(/Github user not configured/)
       end
     end
-    context 'when config.authorization_token is nil' do
+    context 'when global config token is nil' do
       let(:repo_config) do
         {
           'remote.origin.url' => 'https://github.com/thegarage/thegarage-gitx',
@@ -227,12 +227,12 @@ describe Thegarage::Gitx::Cli::ReviewCommand do
 
         @auth_token = cli.send(:authorization_token)
       end
-      it 'stores authorization_token in git config' do
-        expect(repo_config).to include('thegarage.gitx.githubauthtoken' => authorization_token)
+      it 'stores authorization_token in global config' do
+        expect(global_config).to include('token' => authorization_token)
       end
       it { expect(@auth_token).to eq authorization_token }
     end
-    context 'when config.authorization_token is nil and first request fails' do
+    context 'when global authorization_token is nil and first request fails' do
       let(:repo_config) do
         {
           'remote.origin.url' => 'https://github.com/thegarage/thegarage-gitx',
@@ -252,21 +252,28 @@ describe Thegarage::Gitx::Cli::ReviewCommand do
 
         @auth_token = cli.send(:authorization_token)
       end
-      it 'stores authorization_token in git config' do
-        expect(repo_config).to include('thegarage.gitx.githubauthtoken' => authorization_token)
+      it 'stores authorization_token in global config' do
+        expect(global_config).to include('token' => authorization_token)
       end
       it { expect(@auth_token).to eq authorization_token }
     end
-    context 'when there is an existing authorization_token' do
+    context 'when the global config has an existing token' do
       let(:authorization_token) { '123981239123' }
       let(:repo_config) do
         {
           'remote.origin.url' => 'https://github.com/thegarage/thegarage-gitx',
-          'github.user' => 'ryan@codecrate.com',
-          'thegarage.gitx.githubauthtoken' => authorization_token
+          'github.user' => 'ryan@codecrate.com'
+        }
+      end
+      let(:config) do
+        {
+          'token' => authorization_token
         }
       end
       before do
+        File.open(global_config_file, 'w') do |file|
+          file.write(config.to_yaml)
+        end
         @auth_token = cli.send(:authorization_token)
       end
       it { expect(@auth_token).to eq authorization_token }
@@ -291,8 +298,8 @@ describe Thegarage::Gitx::Cli::ReviewCommand do
 
         @auth_token = cli.send(:authorization_token)
       end
-      it 'stores authorization_token in git config' do
-        expect(repo_config).to include('thegarage.gitx.githubauthtoken' => authorization_token)
+      it 'stores authorization_token in global config' do
+        expect(global_config).to include('token' => authorization_token)
       end
       it { expect(@auth_token).to eq authorization_token }
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: thegarage-gitx
 version: !ruby/object:Gem::Version
-  version: 2.10.2
+  version: 2.11.0
 platform: ruby
 authors:
 - Ryan Sonnek
@@ -279,6 +279,8 @@ files:
 - spec/fixtures/vcr_cassettes/pull_request_does_exist_with_success_status.yml
 - spec/fixtures/vcr_cassettes/pull_request_does_not_exist.yml
 - spec/spec_helper.rb
+- spec/support/global_config.rb
+- spec/support/home_env.rb
 - spec/support/matchers/meet_expectations_matcher.rb
 - spec/support/pry.rb
 - spec/support/stub_execution.rb
@@ -325,6 +327,8 @@ test_files:
 - spec/fixtures/vcr_cassettes/pull_request_does_exist_with_success_status.yml
 - spec/fixtures/vcr_cassettes/pull_request_does_not_exist.yml
 - spec/spec_helper.rb
+- spec/support/global_config.rb
+- spec/support/home_env.rb
 - spec/support/matchers/meet_expectations_matcher.rb
 - spec/support/pry.rb
 - spec/support/stub_execution.rb