fue 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 61e751b27876661073781594e4e2453f29775ece
-  data.tar.gz: 2072ed4777de7041e92388e47b370a562743c10c
+  metadata.gz: bdf4e815c9a0ac53a054f3f8253b877910128fc4
+  data.tar.gz: 1d54bdfb1a79ae4709f3762a58599082826c5c8a
 SHA512:
-  metadata.gz: 7bb5e6dbe47b597282085d695d4b1da2a434f200425661ada1088d1dfac7e79899c04f02360931e1df08b14617e3ee98deb78626942bf6f315dcf2870966df95
-  data.tar.gz: 2e9a9fc434871489eb5d2ae86dfe9f2b8e42c91d52e1e9c278568001ab5ae9150289ca6927f301d656670b413ead461a35ac331168cb14e9a2088ded9aee520c
+  metadata.gz: 9d5a73a9249125d4fad2f69a0f0b54cc9af5a1ed5be94d635c13245f27d07357cd7b2b4b0b59315aaf1997d35c522c7c4e5f74516160b4a1823cca235ff677eb
+  data.tar.gz: 7f506c0f889ddd23e6817828a10358343895b0d73cd3780304a52cf414449ff2039eb12f7ae433170ea64167fc5e1cb1a0e24f3e3b45b7fe0fb443bdd530a4eb

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+### 0.2.1 (2018/8/23)
+
+* [#2](https://github.com/dblock/fue/issues/2): Prompt to authenticate with Github - [@dblock](https://github.com/dblock).
+* [#7](https://github.com/dblock/fue/issues/7): Display version - [@dblock](https://github.com/dblock).
+
 ### 0.2.0 (2018/8/22)
 
 * [#6](https://github.com/dblock/fue/issues/6): Configure max depth and breadth separately - [@dblock](https://github.com/dblock).

data/README.md

@@ -16,16 +16,12 @@ Fue is short for "Finding Unicorn Engineers".
 gem install fue
 ```
 
-#### Get a Github Access Token
-
-Obtain a Github access token from [here](https://github.com/settings/tokens) with `public_repo` permissions. See [help](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line) for more information. Set the token as `GITHUB_ACCESS_TOKEN`.
-
 #### Find Someone's Email
 
 The `find` command looks through user's initial repo commits.
 
 ```
-GITHUB_ACCESS_TOKEN=token fue find defunkt
+$ fue find defunkt
 
 Chris Wanstrath <chris@ozmm.org>
 Chris Wanstrath <chris@github.com>
@@ -36,7 +32,7 @@ Chris Wanstrath <chris@github.com>
 By default the code looks at 1 commit from the last 10 repos. You can look at more repositories (breadth) and more commits (depth). The maximum value for depth is 100, enforced by Github. Fue will iterate over a number of repositories larger than 100.
 
 ```
-GITHUB_ACCESS_TOKEN=token fue find --breadth=100 --depth=5 defunkt
+$ fue find --breadth=100 --depth=5 defunkt
 
 Chris Wanstrath <chris@ozmm.org>
 Chris Wanstrath <chris@github.com>
@@ -51,6 +47,21 @@ fue help
 
 Displays additional options.
 
+#### Access Tokens
+
+Fue will prompt you for Github credentials and 2FA, if enabled.
+
+```
+$ fue find defunkt
+Enter dblock's GitHub password (never stored): ******************
+Enter GitHub 2FA code: ******
+Token saved to keychain.
+```
+
+The access token will be generated with `public_repo` scope and stored in the keychain. It can be later deleted from [here](https://github.com/settings/tokens). You can also skip the prompts and use a previously obtained token with `-t` or by setting the `GITHUB_ACCESS_TOKEN` environment variable.
+
+See [Creating a Personal Access Token for the Command Line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line) for more information about personal tokens.
+
 ## Contributing
 
 There're [a few feature requests and known issues](https://github.com/dblock/fue/issues). Please contribute! See [CONTRIBUTING](CONTRIBUTING.md).

data/bin/fue

@@ -1,22 +1,23 @@
 #!/usr/bin/env ruby
 require 'gli'
 require 'fue'
-require 'graphlient'
 
 class App
   extend GLI::App
 
   program_desc "Find a Github user's e-mail address."
+  version Fue::VERSION
 
   switch %i[v verbose], desc: 'Produce verbose output.', default_value: false
   flag %i[t token], desc: 'Github access token.', default_value: ENV['GITHUB_ACCESS_TOKEN']
+  flag %i[u username], desc: 'Guthub username.', default_value: Fue::Auth.username
 
   arguments :strict
   subcommand_option_handling :normal
 
   pre do |global_options, _command, options, _args|
     options = global_options.dup
-    token = options.delete(:token)
+    token = options.delete(:token) || Fue::Auth.token
     $fue = Fue::Finder.new(token, options)
   end
 

data/lib/fue.rb

@@ -1,2 +1,9 @@
+require 'graphlient'
+require 'github_api'
+require 'open3'
+require 'English'
+
 require 'fue/version'
 require 'fue/finder'
+require 'fue/security'
+require 'fue/auth'

data/lib/fue/auth.rb

@@ -0,0 +1,97 @@
+module Fue
+  module Auth
+    class << self
+      def token
+        stored_options = { username: username, server: 'github.com', label: 'fue' }
+        stored_token = Fue::Security.get(stored_options)
+        unless stored_token
+          stored_token = github_token
+          Fue::Security.store!(stored_options.merge(password: stored_token))
+          puts 'Token saved to keychain.'
+        end
+        stored_token
+      end
+
+      def username
+        @username ||= begin
+          username = `git config github.user`.chomp
+          username = get_username if username.empty?
+          username
+        end
+      end
+
+      private
+
+      def github_token(code = nil)
+        github(code).auth.create(scopes: ['public_repo'], note: note).token
+      rescue Github::Error::Unauthorized => e
+        case e.response_headers['X-GitHub-OTP']
+        when /required/ then
+          github_token(get_code)
+        else
+          raise e
+        end
+      rescue Github::Error::UnprocessableEntity => e
+        raise e, 'A fue token already exists! Please revoke all previously-generated fue personal access tokens at https://github.com/settings/tokens.'
+      end
+
+      def password
+        @password ||= get_password
+      end
+
+      def note
+        "Fui (https://github.com/dblock/fue) on #{Socket.gethostname}"
+      end
+
+      def github(code = nil)
+        Github.new do |config|
+          config.basic_auth = [username, password].join(':')
+          if code
+            config.connection_options = {
+              headers: {
+                'X-GitHub-OTP' => code
+              }
+            }
+          end
+        end
+      end
+
+      def get_username
+        print 'Enter GithHub username: '
+        $stdin.gets.chomp
+      rescue Interrupt => e
+        raise e, 'ctrl + c'
+      end
+
+      def get_password
+        print "Enter #{username}'s GitHub password (never stored): "
+        get_secure
+      end
+
+      def get_code
+        print 'Enter GitHub 2FA code: '
+        get_secure
+      end
+
+      def get_secure
+        current_tty = `stty -g`
+        system 'stty raw -echo -icanon isig' if $CHILD_STATUS.success?
+        input = ''
+        while (char = $stdin.getbyte) && !((char == 13) || (char == 10))
+          if (char == 127) || (char == 8)
+            input[-1, 1] = '' unless input.empty?
+          else
+            $stdout.write '*'
+            input << char.chr
+          end
+        end
+        print "\r\n"
+        input
+      rescue Interrupt => e
+        raise e, 'ctrl + c'
+      ensure
+        system "stty #{current_tty}" unless current_tty.empty?
+      end
+    end
+  end
+end

data/lib/fue/security.rb

@@ -0,0 +1,46 @@
+module Fue
+  module Security
+    class << self
+      def store!(options)
+        system!(security('add', options))
+      end
+
+      def get(options)
+        system!(security('find', options))
+      rescue RuntimeError
+        nil
+      end
+
+      private
+
+      def security(command = nil, options = nil)
+        run = [security_path]
+        run << "#{command}-internet-password"
+        run << "-a #{options[:username]}"
+        run << "-s #{options[:server]}"
+        if command == 'add'
+          run << "-l #{options[:label]}"
+          run << '-U'
+          run << "-w #{options[:password]}" if options.key?(:password)
+        else
+          run << '-w'
+        end
+        run.join ' '
+      end
+
+      def security_path
+        @security_path ||= begin
+          `which security`.chomp
+        rescue StandardError
+          'security'
+        end
+      end
+
+      def system!(*cmd)
+        stdout, _, status = Open3.capture3(*cmd)
+        raise "failed with exit code #{status}" unless status.success?
+        stdout.slice!(0..-(1 + $INPUT_RECORD_SEPARATOR.size))
+      end
+    end
+  end
+end

data/lib/fue/version.rb

@@ -1,3 +1,3 @@
 module Fue
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.2.1'.freeze
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: fue
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Daniel Doubrovkine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-22 00:00:00.000000000 Z
+date: 2018-08-23 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: github_api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: gli
   requirement: !ruby/object:Gem::Requirement
@@ -51,7 +65,9 @@ files:
 - README.md
 - bin/fue
 - lib/fue.rb
+- lib/fue/auth.rb
 - lib/fue/finder.rb
+- lib/fue/security.rb
 - lib/fue/version.rb
 homepage: http://github.com/dblock/fue
 licenses: