dblock / fue Goto Github PK

View Code? Open in Web Editor NEW

19.0 4.0 1.0 445 KB

Find an e-mail addresses of Github users.

License: MIT License

Ruby 100.00%

github graphql github-graphql

fue's Introduction

Fue

Find e-mail addresses of a Github users from their commit logs.

Fue is short for "Finding Unicorn Engineers".

Usage
Debugging
Contributing
Copyright and License

Usage

gem install fue

Commands

Find Someone's Email

The find command looks through user's initial repository commits.

$ fue --verbose find defunkt

Chris Wanstrath <[email protected]>
Chris Wanstrath <[email protected]>

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 <[email protected]>
kch: Caio Chassot <[email protected]>

Options

Specify More Depth

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

Chris Wanstrath <[email protected]>
Chris Wanstrath <[email protected]>
defunkt <[email protected]>

Get Help

fue help

Displays additional options.

Access Tokens

Fue will ask you to create a personal access token and will store it in the keychain. The access token should be created with public_repo scope here. 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 for more information about personal tokens.

Debugging

If you run into an unexpected error, try getting a stack trace with GLI_DEBUG=true.

$ GLI_DEBUG=true fue find dblock

FrozenError: can't modify frozen String
  /Users/dblock/source/dblock/fue/lib/fue/auth.rb:97:in `get_secure'
  /Users/dblock/source/dblock/fue/lib/fue/auth.rb:80:in `get_password'
  /Users/dblock/source/dblock/fue/lib/fue/auth.rb:50:in `password'
  /Users/dblock/source/dblock/fue/lib/fue/auth.rb:59:in `block in github'

Contributing

There are a few feature requests and known issues. Please contribute! See CONTRIBUTING.

Copyright and License

This project is licensed under the MIT License.

fue's People

Contributors

Stargazers

Watchers

Forkers

arlindnocaj

fue's Issues

Support saving credentials on Windows

Similar for #10, but for Windows.

Output @names

Provide a separate output with just the @NAMEs so they can be @mentioned.

OSX Keychain storage conflicts with ghi

See stephencelis/ghi#370

If ghi was configured first, fue works, because it doesn't include the label in search - it will use ghi's token.

Look through all commits, not just up to 100

That loop became hairy when I tried to implement it.

fue find lundefugl

Check why we're not finding anything for fue find lundefugl, there's a commit or two.

error: can't modify frozen String

osx ~/source/dblock/lost-robbies (master)$ fue find kanew071
Enter GitHub username: dblock
Enter dblock's GitHub password (never stored): *error: can't modify frozen String

Sort name/email by volume or date

We're returning a set of name/emails, but some may be better than others. Sort by date, volume, alphabetically, etc.

Don't require a github token, ask to authenticate

Notably ghi does that, https://github.com/stephencelis/ghi, find out how and where these credentials are stored.

Support saving credentials on Linux

What happens to auth on Linux. Don't have a linux box to track this down, but I am going to imagine that prompting for credentials works, but saving them does not.

Display name/email stats

Related to #8, show stats such as how many commits we saw with a given email, when it was first/last used, etc.

Windows doesn't know how to execute 'fue'

On Windows, 'bundle exec rake' fails with:

2) Fue find default displays version
     Failure/Error: stdout, stderr, status = Open3.capture3(*cmd)

     Errno::ENOEXEC:
       Exec format error - D:/fue/bin/fue
     # ./lib/fue/shell.rb:5:in `system!'
     # ./spec/fue/fue_spec.rb:8:in `block (4 levels) in <top (required)>'
     # ./spec/fue/fue_spec.rb:14:in `block (4 levels) in <top (required)>'

Token caching/GitHub authentication dependent on Mac keychain

The current setup for creating and storing a token, or depending on one existing in the keychain, doesn't work cross-platform. If we skip the keychain checks, github_token doesn't work if a token already exists.

The convenience for Mac users is nice, but is there a way we can find an abstraction for cross-platform keychains, or some other alternative? Not being able to create a token when one exists also makes this difficult. Also, all of the current tests passed despite this critical issue.

Maybe we can scale back to manual token authentication, write more rigorous tests, and make things less platform-dependent?

Personal suggestion for simplifying password input:

def get_secure
  require 'highline'
  cli = HighLine.new
  input = cli.ask("Enter #{username}'s GitHub password (never stored):" { |q| q.echo = false } # alt. q.echo = "*"
  input
end

Cutting out the dependence on stty

Eager to hear your thoughts!

remove email addresses to <github alias> @users.noreply.github.com

Set up Appveyor for Windows CI

Configure appveyor.yml for Ruby building, and point Appveyor to the repo via Github account

fue_spec fails on Windows when path includes a space

Falsely states that the file doesn't exist, when run from a path with a space. Test passes when run from a path without a space, eg. 'D:\fue"

Failures:

  1) Fue find default displays help
     Failure/Error: stdout, stderr, status = Open3.capture3(*cmd)

     Errno::ENOENT:
       No such file or directory - C:/Users/Zack Layton/Documents/Projects/fue/bin/fue
     # ./lib/fue/shell.rb:5:in `system!'
     # ./spec/fue/fue_spec.rb:8:in `block (4 levels) in <top (required)>'
     # ./spec/fue/fue_spec.rb:11:in `block (4 levels) in <top (required)>'

  2) Fue find default displays version
     Failure/Error: stdout, stderr, status = Open3.capture3(*cmd)

     Errno::ENOENT:
       No such file or directory - C:/Users/Zack Layton/Documents/Projects/fue/bin/fue
     # ./lib/fue/shell.rb:5:in `system!'
     # ./spec/fue/fue_spec.rb:8:in `block (4 levels) in <top (required)>'
     # ./spec/fue/fue_spec.rb:14:in `block (4 levels) in <top (required)>'

  3) Fue find help displays help
     Failure/Error: stdout, stderr, status = Open3.capture3(*cmd)

     Errno::ENOENT:
       No such file or directory - C:/Users/Zack Layton/Documents/Projects/fue/bin/fue help
     # ./lib/fue/shell.rb:5:in `system!'
     # ./spec/fue/fue_spec.rb:19:in `block (4 levels) in <top (required)>'
     # ./spec/fue/fue_spec.rb:22:in `block (4 levels) in <top (required)>'

Github returns 401 on authorizations

Did an API get deprecated?

$ fue find dblock
Resolving dependencies...
Enter dblock's GitHub password (never stored): ******
error: POST https://api.github.com/authorizations: 404 - Not Found
See: https://docs.github.com/rest

Workaround is to use a token with -t.

Iterate over repositories to raise the limit over 100 enforced by Github

Works fine when the depth is 100, but a GraphQL error is thrown when depth is 1000.

ruby 2.5.1p57 (2018-03-29 revision 63029) [x64-mingw32]

Configure depth and breadth

Breadth = how many repositories to look at
Depth = how many commits to look at

Display version

Gem build complains "open-ended dependency"

D:\fue>gem build fue
WARNING:  open-ended dependency on github_api (>= 0) is not recommended
  if github_api is semantically versioned, use:
    add_runtime_dependency 'github_api', '~> 0'
WARNING:  open-ended dependency on gli (>= 0) is not recommended
  if gli is semantically versioned, use:
    add_runtime_dependency 'gli', '~> 0'
WARNING:  See http://guides.rubygems.org/specification-reference/ for help
  Successfully built RubyGem
  Name: fue
  Version: 0.2.2
  File: fue-0.2.2.gem

fue exitstatus tests don't work on Windows

Fue::Shell#system! tests fail on Windows because 'echo' prints the entire line. Eg output:
*nix => OK
Windows => OK ; exit 0

Failures:

  1) Fue::Shell#system! returns a zero error code
     Failure/Error: expect(Fue::Shell.system!('echo OK ; exit 0')).to eq 'OK'

       expected: "OK"
            got: "OK ; exit 0"

       (compared using ==)
     # ./spec/fue/shell_spec.rb:6:in `block (3 levels) in <top (required)>'

  2) Fue::Shell#system! returns a non zero error code
     Failure/Error:
       expect do
         Fue::Shell.system!('echo OK ; exit 1')
       end.to raise_error RuntimeError, /exit code pid \d* exit 1/

       expected RuntimeError with message matching /exit code pid \d* exit 1/ but nothing was raised
     # ./spec/fue/shell_spec.rb:9:in `block (3 levels) in <top (required)>'

Add more verbose output

Add a lot more detail with --verbose.

For example how many repos have been retrieved, what queries are being made, how many commits are being checked, credentials being loaded and from where, etc.

Configure whether to display names

Sometimes you just want the email, no need for a name. Add an option to display just the email or the name and the email.