fue 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: bdf4e815c9a0ac53a054f3f8253b877910128fc4
-  data.tar.gz: 1d54bdfb1a79ae4709f3762a58599082826c5c8a
+SHA256:
+  metadata.gz: db5d73f68b7c73685841e8e2cf7a677ebaea651d4d900fba9ed4986ab16a1ca1
+  data.tar.gz: 1493b9161cc0a613349cb02901231bbf58dbb2bfb4df67e0773eba3ff0f845dc
 SHA512:
-  metadata.gz: 9d5a73a9249125d4fad2f69a0f0b54cc9af5a1ed5be94d635c13245f27d07357cd7b2b4b0b59315aaf1997d35c522c7c4e5f74516160b4a1823cca235ff677eb
-  data.tar.gz: 7f506c0f889ddd23e6817828a10358343895b0d73cd3780304a52cf414449ff2039eb12f7ae433170ea64167fc5e1cb1a0e24f3e3b45b7fe0fb443bdd530a4eb
+  metadata.gz: 06cc2b6d34d6d3b0b04526034d87a8b2d588f1018d346da6fbd895b8c7816845194a62096eb1f158994b076b43ca68be08f40e5acde9be9a5e818f3e5422d7a0
+  data.tar.gz: ce802803afc1595a9eff8ec0bcdbf1ec4a017aa97dc93269c5f5382b870ef6a2eca86576f4cb4a92dc6360d7255292b2dcf933942d1a32af4eb2a5684a4e35ec

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+### 0.3.0 (2020/05/22)
+
+* [#25](https://github.com/dblock/fue/pull/25): Added `contributors`, find repo contributors' e-mails - [@dblock](https://github.com/dblock).
+* [#12](https://github.com/dblock/fue/issues/12): Added explicit ruby call to run fue - [@SYNstack](https://github.com/SYNstack).
+* [#13](https://github.com/dblock/fue/issues/13): Changed shell tests to be OS-neutral - [@SYNstack](https://github.com/SYNstack).
+* [#16](https://github.com/dblock/fue/issues/16): Setup Windows CI - [@SYNstack](https://github.com/synstack).
+* [#17](https://github.com/dblock/fue/issues/19): Fix open-ended dependencies in gemspec - [@SYNstack](https://github.com/synstack).
+
 ### 0.2.1 (2018/8/23)
 
 * [#2](https://github.com/dblock/fue/issues/2): Prompt to authenticate with Github - [@dblock](https://github.com/dblock).

data/CONTRIBUTING.md

@@ -4,11 +4,11 @@ This project is work of [many contributors](https://github.com/dblock/fue/graphs
 
 You're encouraged to submit [pull requests](https://github.com/dblock/fue/pulls), [propose features and discuss issues](https://github.com/dblock/fue/issues).
 
-In the examples below, substitute your Github username for `contributor` in URLs.
+In the examples below, substitute your GitHub username for `contributor` in URLs.
 
 ### Fork the Project
 
-Fork the [project on Github](https://github.com/dblock/fue) and check out your copy.
+Fork the [project on GitHub](https://github.com/dblock/fue) and check out your copy.
 
 ```
 git clone https://github.com/contributor/fue.git
@@ -47,7 +47,7 @@ We definitely appreciate pull requests that highlight or reproduce a problem, ev
 
 Implement your feature or bug fix.
 
-Ruby style is enforced with [Rubocop](https://github.com/bbatsov/rubocop). Run `bundle exec rubocop` and fix any style issues highlighted, auto-correct issues when possible with `bundle exec rubocop -a`. To silence generally ingored issues, including line lengths or code complexity metrics, run `bundle exec rubocop --auto-gen-config`.
+Ruby style is enforced with [Rubocop](https://github.com/bbatsov/rubocop). Run `bundle exec rubocop` and fix any style issues highlighted, auto-correct issues when possible with `bundle exec rubocop -a`. To silence generally ignored issues, including line lengths or code complexity metrics, run `bundle exec rubocop --auto-gen-config`.
 
 Make sure that `bundle exec rake` completes without errors.
 

data/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 Daniel Doubrovkine.
+Copyright (c) 2018-2020 Daniel Doubrovkine.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -3,8 +3,9 @@ Fue
 
 [![Gem Version](https://badge.fury.io/rb/fue.svg)](https://badge.fury.io/rb/fue)
 [![Build Status](https://travis-ci.org/dblock/fue.svg)](https://travis-ci.org/dblock/fue)
+[![Build status](https://ci.appveyor.com/api/projects/status/github/dblock/fue?branch=master&svg=true)](https://ci.appveyor.com/project/dblock/fue)
 
-Find an e-mail address of a Github user from their commit log.
+Find e-mail addresses of a Github users from their commit logs.
 
 Fue is short for "Finding Unicorn Engineers".
 
@@ -16,20 +17,35 @@ Fue is short for "Finding Unicorn Engineers".
 gem install fue
 ```
 
+### Commands
+
 #### Find Someone's Email
 
-The `find` command looks through user's initial repo commits.
+The `find` command looks through user's initial repository commits.
 
 ```
-$ fue find defunkt
+$ fue --verbose find defunkt
 
 Chris Wanstrath <chris@ozmm.org>
 Chris Wanstrath <chris@github.com>
 ```
 
+#### Find All Repo Contributors' Emails
+
+The `contributors` command looks through a git log of contributors, then fetches their e-mails.
+
+```
+$ fue --verbose contributors defunkt/colored
+
+defunkt: Chris Wanstrath <chris@ozmm.org>
+kch: Caio Chassot <kch@users.noreply.github.com>
+```
+
+### Options
+
 #### Specify More Depth
 
-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.
+By default the code looks at 1 commit from the last 10 repositories. 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.
 
 ```
 $ fue find --breadth=100 --depth=5 defunkt
@@ -39,7 +55,7 @@ Chris Wanstrath <chris@github.com>
 defunkt <chris@ozmm.org>
 ```
 
-#### Get Help
+### Get Help
 
 ```
 fue help
@@ -47,7 +63,7 @@ fue help
 
 Displays additional options.
 
-#### Access Tokens
+### Access Tokens
 
 Fue will prompt you for Github credentials and 2FA, if enabled.
 
@@ -64,10 +80,10 @@ See [Creating a Personal Access Token for the Command Line](https://help.github.
 
 ## Contributing
 
-There're [a few feature requests and known issues](https://github.com/dblock/fue/issues). Please contribute! See [CONTRIBUTING](CONTRIBUTING.md).
+There are [a few feature requests and known issues](https://github.com/dblock/fue/issues). Please contribute! See [CONTRIBUTING](CONTRIBUTING.md).
 
 ## Copyright and License
 
-Copyright (c) 2018, Daniel Doubrovkine, [Artsy](http://artsy.github.io), with help from [Orta](https://github.com/orta).
+Copyright (c) 2018-2020, Daniel Doubrovkine, [Artsy](http://artsy.github.io), with help from [Orta](https://github.com/orta).
 
 This project is licensed under the [MIT License](LICENSE.md).

data/bin/fue

@@ -1,29 +1,31 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 require 'gli'
 require 'fue'
 
 class App
   extend GLI::App
 
-  program_desc "Find a Github user's e-mail address."
+  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
+  flag %i[t token], desc: 'GitHub access token.', default_value: ENV['GITHUB_ACCESS_TOKEN']
+  flag %i[u username], desc: 'GitHub username.', default_value: Fue::Auth.instance.username
 
   arguments :strict
   subcommand_option_handling :normal
 
   pre do |global_options, _command, options, _args|
     options = global_options.dup
-    token = options.delete(:token) || Fue::Auth.token
+    token = options.delete(:token) || Fue::Auth.instance.token
     $fue = Fue::Finder.new(token, options)
   end
 
   default_command :help
 
-  desc "Find a Github user's e-mail address."
+  desc "Find a GitHub user's e-mail address."
   arg 'username'
   command :find do |c|
     c.flag %i[d depth], desc: 'Maximum search depth in each repository.', default_value: 1
@@ -37,7 +39,29 @@ class App
              "in the first #{options[:depth].to_i > 1 ? "#{options[:depth]} commits" : 'commit'} " \
              "of #{options[:breadth]} most recent repositor#{options[:breadth] == 1 ? 'y' : 'ies'} ..."
       end
-      puts $fue.emails(options.merge(username: username))
+      puts $fue.emails(options.merge(username: username, verbose: global_options[:verbose]))
+      exit_now! nil, 0
+    end
+  end
+
+  desc "Find a GitHub repo contributors' e-mail addresses."
+  arg 'repo'
+  command :contributors do |c|
+    c.flag %i[d depth], desc: 'Maximum search depth in each repository for a given user.', default_value: 1
+    c.flag %i[b breadth], desc: 'Maximum number of repositories to search.', default_value: 10
+    c.action do |global_options, options, args|
+      repo = args.first
+      options[:depth] = options[:depth].to_i
+      options[:breadth] = options[:breadth].to_i
+      if global_options[:verbose]
+        puts "Searching for contributors' e-mail addresses in '#{repo}' " \
+             "in the first #{options[:depth].to_i > 1 ? "#{options[:depth]} commits" : 'commit'} " \
+             "of #{options[:breadth]} most recent repositor#{options[:breadth] == 1 ? 'y' : 'ies'} ..."
+      end
+      contributor_emails = $fue.contributors(options.merge(repo: repo, verbose: global_options[:verbose]))
+      contributor_emails.each_pair do |username, emails|
+        puts "#{username}: #{emails.join(', ')}"
+      end
       exit_now! nil, 0
     end
   end

data/lib/fue.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 require 'graphlient'
 require 'github_api'
 require 'open3'
 require 'English'
 
 require 'fue/version'
+require 'fue/shell'
 require 'fue/finder'
 require 'fue/security'
 require 'fue/auth'

data/lib/fue/auth.rb

@@ -1,97 +1,108 @@
+# frozen_string_literal: true
+
 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
+  class Auth
+    def self.instance
+      @instance ||= new
+    end
+
+    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
+    def username
+      @username ||= begin
+        username = get_git_username&.chomp
+        username = get_username if username.nil? || username.empty?
+        username
       end
+    end
 
-      private
+    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 get_git_username
+      Fue::Shell.system!('git config github.user')
+    rescue RuntimeError
+      nil
+    end
 
-      def password
-        @password ||= get_password
+    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/
+        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 note
-        "Fui (https://github.com/dblock/fue) on #{Socket.gethostname}"
-      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
-              }
+    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
+    end
 
-      def get_username
-        print 'Enter GithHub username: '
-        $stdin.gets.chomp
-      rescue Interrupt => e
-        raise e, 'ctrl + c'
-      end
+    def get_username
+      print 'Enter GitHub username: '
+      username = $stdin.gets
+      username&.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_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_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
+    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
-        print "\r\n"
-        input
-      rescue Interrupt => e
-        raise e, 'ctrl + c'
-      ensure
-        system "stty #{current_tty}" unless current_tty.empty?
       end
+      print "\r\n"
+      input
+    rescue Interrupt => e
+      raise e, 'ctrl + c'
+    ensure
+      system "stty #{current_tty}" unless current_tty.empty?
     end
   end
 end

data/lib/fue/finder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fue
   class Finder
     attr_reader :token
@@ -19,21 +21,18 @@ module Fue
 
     def emails(options = {})
       query = <<-GRAPHQL
-        query($login: String!, $author_id: ID!, $depth: Int!, $breadth: Int!, $breadthCursor: String) {
+        query($login: String!, $author_id: ID!, $depth: Int!, $breadth: Int!, $cursor: String) {
           user(login: $login) {
-            repositories(last: $breadth, after: $breadthCursor, isFork:false, privacy: PUBLIC) {
-              edges {
-                cursor
-                node {
-                  defaultBranchRef {
-                    target {
-                      ... on Commit {
-                        history(first: $depth, author: { id: $author_id }) {
-                          nodes {
-                            author {
-                              email
-                              name
-                            }
+            repositories(last: $breadth, after: $cursor, isFork:false, privacy: PUBLIC) {
+              nodes {
+                defaultBranchRef {
+                  target {
+                    ... on Commit {
+                      history(first: $depth, author: { id: $author_id }) {
+                        nodes {
+                          author {
+                            email
+                            name
                           }
                         }
                       }
@@ -41,42 +40,112 @@ module Fue
                   }
                 }
               }
+              pageInfo {
+                startCursor
+              }
             }
           }
         }
       GRAPHQL
 
+      # max number of repositories to search
       max_breadth = options[:breadth] || 10
 
       query_options = {
         login: options[:username],
         author_id: author_id(options[:username]),
+        # max number of commits to look into
         depth: options[:depth] || 1
       }
 
+      STDOUT.write "Searching for emails for #{options[:username]} ." if options[:verbose]
+
       emails = Set.new
 
       loop do
         query_options[:breadth] = [max_breadth, 100].min
         response = graphql_client.query(query, query_options)
-        edges = response.data.user.repositories.edges if response
-        if edges
-          edges.each do |edge|
-            query_options[:breadthCursor] = edge.cursor
-            branch_ref = edge.node.default_branch_ref
-            next unless branch_ref
-            branch_ref.target.history.nodes.each do |node|
-              emails << "#{node.author.name} <#{node.author.email}>"
-            end
+        repositories = response&.data&.user&.repositories
+        repositories&.nodes&.each do |history|
+          master_history = history.default_branch_ref&.target&.history
+          master_history&.nodes&.each do |node|
+            emails << "#{node.author.name} <#{node.author.email}>"
           end
         end
+        query_options[:cursor] = repositories&.page_info&.start_cursor
+        break unless query_options[:cursor]
+
         max_breadth -= 100
         break if max_breadth <= 0
+
+        STDOUT.write '.' if options[:verbose]
       end
 
+      puts " found #{emails.size} email address#{emails.size == 1 ? '' : 'es'}." if options[:verbose]
+
       emails.to_a
     end
 
+    def contributors(options = {})
+      query = <<-GRAPHQL
+        query($owner: String!, $name: String!, $cursor: String) {
+          repository(owner: $owner, name: $name) {
+            defaultBranchRef {
+              target {
+                ... on Commit {
+                  history(first: 100, after: $cursor) {
+                    nodes {
+                      author {
+                        user {
+                          login
+                        }
+                      }
+                    }
+                    pageInfo {
+                      endCursor
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      GRAPHQL
+
+      repo_owner, repo_name = options[:repo].split('/', 2)
+
+      query_options = {
+        owner: repo_owner,
+        name: repo_name
+      }
+
+      logins = Set.new
+
+      STDOUT.write 'Fetching contributors .' if options[:verbose]
+
+      loop do
+        response = graphql_client.query(query, query_options)
+        history = response&.data&.repository&.default_branch_ref&.target&.history
+        history&.nodes&.each do |node|
+          login = node.author.user&.login
+          logins << login if login
+        end
+        query_options[:cursor] = history&.page_info.end_cursor
+        STDOUT.write '.' if options[:verbose]
+        break unless query_options[:cursor]
+      end
+
+      puts " found #{logins.size} contributor#{logins.size == 1 ? '' : 's'}." if options[:verbose]
+
+      Hash[logins.map do |login|
+        begin
+          [login, emails(options.merge(username: login))]
+        rescue StandardError => e
+          warn e.to_s
+        end
+      end.compact]
+    end
+
     private
 
     def graphql_client

data/lib/fue/security.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 module Fue
   module Security
     class << self
       def store!(options)
-        system!(security('add', options))
+        Fue::Shell.system!(security('add', options))
       end
 
       def get(options)
-        system!(security('find', options))
+        Fue::Shell.system!(security('find', options))
       rescue RuntimeError
         nil
       end
@@ -31,16 +33,10 @@ module Fue
       def security_path
         @security_path ||= begin
           `which security`.chomp
-        rescue StandardError
-          'security'
+                           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/shell.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Fue
+  module Shell
+    class << self
+      def system!(*cmd)
+        stdout, stderr, status = Open3.capture3(*cmd)
+        raise ["exit code #{status}", stderr].compact.join("\n") unless status.success?
+
+        stdout.slice!(0..-(1 + $INPUT_RECORD_SEPARATOR.size))
+      end
+    end
+  end
+end

data/lib/fue/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fue
-  VERSION = '0.2.1'.freeze
+  VERSION = '0.3.0'
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: fue
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Daniel Doubrovkine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-23 00:00:00.000000000 Z
+date: 2020-05-22 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'
+        version: 0.18.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.18.2
 - !ruby/object:Gem::Dependency
   name: gli
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.17'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.17'
 - !ruby/object:Gem::Dependency
   name: graphlient
   requirement: !ruby/object:Gem::Requirement
@@ -68,6 +68,7 @@ files:
 - lib/fue/auth.rb
 - lib/fue/finder.rb
 - lib/fue/security.rb
+- lib/fue/shell.rb
 - lib/fue/version.rb
 homepage: http://github.com/dblock/fue
 licenses:
@@ -88,9 +89,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 3.1.3
 signing_key: 
 specification_version: 4
-summary: Find an e-mail address of a Github user.
+summary: Find an e-mail address of a GitHub user.
 test_files: []