faf 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9891acf05f5536961bacc63ba7eebf9d3e776c53e4ec4acbe12f282292514de4
+  data.tar.gz: ca5ae0e56664c71ce79266ef9a157425ae925eaaa43cd3aa0990fd6fc501a99f
+SHA512:
+  metadata.gz: ced0850a182bb36a39d947cd482cf51df80bb698fcb001284170b9d0e685677c154de19b64acb82b86e1eacb66a5787217f869b79a96f1c6d468b3f98be0ca44
+  data.tar.gz: d3ded6c244bd2cf1f7fab2d0d27f477f2eeaefd0a1db89210177885590459079e9ca27f3c5ac2d4549838a4ea25102ee0d4ef174fa62c090c956337ef6f88851

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+### 0.1.0 (2019/3/21)
+
+* Initial public release - [@dblock](https://github.com/dblock).

data/CONTRIBUTING.md

@@ -0,0 +1,125 @@
+# Contributing to Faf
+
+This project is work of [many contributors](https://github.com/dblock/faf/graphs/contributors).
+
+You're encouraged to submit [pull requests](https://github.com/dblock/faf/pulls), [propose features and discuss issues](https://github.com/dblock/faf/issues).
+
+In the examples below, substitute your GitHub username for `contributor` in URLs.
+
+### Fork the Project
+
+Fork the [project on GitHub](https://github.com/dblock/faf) and check out your copy.
+
+```
+git clone https://github.com/contributor/faf.git
+cd faf
+git remote add upstream https://github.com/dblock/faf.git
+```
+
+### Bundle Install and Test
+
+Ensure that you can build the project and run tests.
+
+```
+bundle install
+bundle exec rake
+```
+
+## Contribute Code
+
+### Create a Topic Branch
+
+Make sure your fork is up-to-date and create a topic branch for your feature or bug fix.
+
+```
+git checkout master
+git pull upstream master
+git checkout -b my-feature-branch
+```
+
+### Write Tests
+
+Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build. Add tests to [spec](spec).
+
+We definitely appreciate pull requests that highlight or reproduce a problem, even without a fix.
+
+### Write Code
+
+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 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.
+
+### Write Documentation
+
+Document any external behavior in the [README](README.md).
+
+### Update Changelog
+
+Add a line to [CHANGELOG](CHANGELOG.md) under *Next Release*. Don't remove *Your contribution here*.
+
+Make it look like every other line, including a link to the issue being fixed, your name and link to your Github account.
+
+### Commit Changes
+
+Make sure git knows your name and email address:
+
+```
+git config --global user.name "Your Name"
+git config --global user.email "contributor@example.com"
+```
+
+Writing good commit logs is important. A commit log should describe what changed and why.
+
+```
+git add ...
+git commit
+```
+
+### Push
+
+```
+git push origin my-feature-branch
+```
+
+### Make a Pull Request
+
+Go to https://github.com/contributor/faf and select your feature branch. Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.
+
+### Update CHANGELOG Again
+
+Update the [CHANGELOG](CHANGELOG.md) with the pull request number. A typical entry looks as follows.
+
+```
+* [#123](https://github.com/dblock/faf/pull/123): Reticulated splines - [@contributor](https://github.com/contributor).
+```
+
+Amend your previous commit and force push the changes.
+
+```
+git commit --amend
+git push origin my-feature-branch -f
+```
+
+### Rebase
+
+If you've been working on a change for a while, rebase with upstream/master.
+
+```
+git fetch upstream
+git rebase upstream/master
+git push origin my-feature-branch -f
+```
+
+### Check on Your Pull Request
+
+Go back to your pull request after a few minutes and see whether it passed muster with Travis-CI. Everything should look green, otherwise fix issues and amend your commit as described above.
+
+### Be Patient
+
+It's likely that your change will not be merged and that the nitpicky maintainers will ask you to do more, or fix seemingly benign problems. Hang on there!
+
+## Thank You
+
+Please do know that we really appreciate and value your time and work. We love you, really.

data/LICENSE.md

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2019 Daniel Doubrovkine.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,67 @@
+Faf
+===
+
+[![Gem Version](https://badge.fury.io/rb/faf.svg)](https://badge.fury.io/rb/faf)
+[![Build Status](https://travis-ci.org/dblock/faf.svg)](https://travis-ci.org/dblock/faf)
+
+Find Active (Github) Forks.
+
+## Usage
+
+```
+gem install faf
+```
+
+#### Show Github Forks
+
+The `forks` command shows github forks.
+
+```bash
+$ faf forks dblock/fue
+
+https://github.com/zacklayton/fue (21 days and 7 hours ago)
+https://github.com/lhmzhou/fue (25 days and 4 hours ago)
+```
+
+Limit the number of forks with `--max`.
+
+```bash
+$ faf forks --max=3 dblock/slack-gamebot
+
+https://github.com/tarikstafford/slack-gamebot (18 days ago)
+https://github.com/dersam/slack-gamebot (30 days and 4 hours ago)
+https://github.com/ccadoret/slack-gamebot (50 days and 3 hours ago)
+```
+
+#### Get Help
+
+```
+faf help
+```
+
+Displays additional options.
+
+#### Access Tokens
+
+Faf will prompt you for Github credentials and 2FA, if enabled.
+
+```
+$ faf forks dblock/fue
+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 are [a few feature requests and known issues](https://github.com/dblock/faf/issues). Please contribute! See [CONTRIBUTING](CONTRIBUTING.md).
+
+## Copyright and License
+
+Copyright (c) 2019, Daniel Doubrovkine.
+
+This project is licensed under the [MIT License](LICENSE.md).

data/bin/faf

@@ -0,0 +1,53 @@
+#!/usr/bin/env ruby
+require 'gli'
+require 'faf'
+
+class App
+  extend GLI::App
+
+  program_desc 'Find active GitHub forks.'
+  version Faf::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: 'GitHub username.', default_value: Faf::Auth.instance.username
+
+  arguments :strict
+  subcommand_option_handling :normal
+
+  pre do |global_options, _command, options, _args|
+    options = global_options.dup
+    token = options.delete(:token) || Faf::Auth.instance.token
+    $verbose = global_options[:verbose]
+    puts "Using token '#{token}'" if $verbose
+    $connection = Faf::Connection.initialize!(token, options)
+  end
+
+  default_command :help
+
+  desc 'Show active GitHub forks.'
+  arg 'repo'
+  command :forks do |c|
+    c.flag %i[m max], desc: 'Maximum number of forks to show.'
+    c.action do |_global_options, options, args|
+      repo = args.first
+      puts "Exploring forks of '#{repo}' ..." if $verbose
+      github_repo = Faf::Repo.new(repo, options)
+      puts "Found #{github_repo.fork_count} forks ..." if $verbose
+      github_forks = github_repo.forks
+      github_forks = github_forks.take(options[:max].to_i) if options[:max]
+      github_forks.each do |f|
+        puts f
+      end
+      exit_now! nil, 0
+    end
+  end
+
+  on_error do |e|
+    warn "Error: #{e.message}"
+    warn '  ' + e.backtrace.join("\n  ") if $verbose
+    false
+  end
+end
+
+exit App.run(ARGV)

data/lib/faf.rb

@@ -0,0 +1,13 @@
+require 'graphlient'
+require 'github_api'
+require 'open3'
+require 'English'
+require 'time_ago_in_words'
+
+require 'faf/version'
+require 'faf/connection'
+require 'faf/repo'
+require 'faf/forks'
+require 'faf/shell'
+require 'faf/security'
+require 'faf/auth'

data/lib/faf/auth.rb

@@ -0,0 +1,108 @@
+module Faf
+  class Auth
+    def self.instance
+      @instance ||= new
+    end
+
+    def token
+      stored_options = { username: username, server: 'github.com', label: 'faf' }
+      stored_token = Faf::Security.get(stored_options)
+      unless stored_token
+        stored_token = github_token
+        Faf::Security.store!(stored_options.merge(password: stored_token))
+        puts 'Token saved to keychain.'
+      end
+      stored_token
+    end
+
+    def username
+      @username ||= begin
+        username = get_git_username
+        username.chomp! if username
+        username = get_username if username.nil? || username.empty?
+        username
+      end
+    end
+
+    private
+
+    def get_git_username
+      Faf::Shell.system!('git config github.user')
+    rescue RuntimeError
+      nil
+    end
+
+    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 faf token already exists! Please revoke all previously-generated faf personal access tokens at https://github.com/settings/tokens.'
+    end
+
+    def password
+      @password ||= get_password
+    end
+
+    def note
+      "Fui (https://github.com/dblock/faf) 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 GitHub username: '
+      username = $stdin.gets
+      username.chomp! if username
+      username
+    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

data/lib/faf/connection.rb

@@ -0,0 +1,42 @@
+module Faf
+  class Connection
+    class << self
+      attr_reader :instance
+
+      def initialize!(token, options = {})
+        @instance ||= new(token, options)
+      end
+
+      def reset!
+        @instance = nil
+      end
+
+      def query(query, options = {})
+        raise 'Not Initialized' unless instance
+        instance.query(query, options)
+      end
+    end
+
+    attr_reader :token
+
+    def initialize(token, _options = {})
+      @token = token
+    end
+
+    def query(query, options)
+      graphql_client.query(query, options)
+    end
+
+    private
+
+    def graphql_client
+      @graphql_client ||= Graphlient::Client.new(
+        'https://api.github.com/graphql',
+        headers: {
+          'Authorization' => "Bearer #{token}",
+          'Content-Type' => 'application/json'
+        }
+      )
+    end
+  end
+end

data/lib/faf/forks.rb

@@ -0,0 +1,61 @@
+module Faf
+  class Forks
+    include Enumerable
+
+    attr_reader :repo
+
+    def initialize(repo, _options = {})
+      @repo = repo
+    end
+
+    def each
+      forks.each do |f|
+        yield(f)
+      end
+    end
+
+    private
+
+    def forks
+      @forks ||= get_forks
+    end
+
+    def get_forks(_options = {})
+      query = <<-GRAPHQL
+        query($owner: String!, $name: String!, $cursor: String) {
+          repository(owner: $owner, name: $name) {
+            forks(first: 100, after: $cursor, orderBy: { field: PUSHED_AT, direction: DESC }) {
+              edges {
+                cursor
+                node {
+                  nameWithOwner
+                  pushedAt
+                }
+              }
+            }
+          }
+        }
+      GRAPHQL
+
+      query_options = {
+        owner: repo.owner,
+        name: repo.name
+      }
+
+      forks = []
+
+      loop do
+        response = Faf::Connection.query(query, query_options)
+        edges = response.data.repository.forks.edges if response
+        break unless edges && edges.any?
+        edges.each do |edge|
+          query_options[:cursor] = edge.cursor
+          node = edge.node
+          forks << Faf::Repo.new(node.name_with_owner, pushed_at: Time.parse(node.pushed_at))
+        end
+      end
+
+      forks
+    end
+  end
+end

data/lib/faf/repo.rb

@@ -0,0 +1,56 @@
+module Faf
+  class Repo
+    attr_reader :owner
+    attr_reader :name
+    attr_reader :pushed_at
+
+    def initialize(url, options = {})
+      @owner, @name = url.split('/', 2)
+      @pushed_at = options[:pushed_at]
+    end
+
+    def forks
+      @forks ||= Faf::Forks.new(self)
+    end
+
+    def fork_count
+      repository.fork_count
+    end
+
+    def repository
+      data.repository
+    end
+
+    def url
+      "https://github.com/#{owner}/#{name}"
+    end
+
+    def to_s
+      "#{url} (#{pushed_at.ago_in_words})"
+    end
+
+    private
+
+    def data
+      @data ||= get_data.data
+    end
+
+    def get_data
+      query = <<-GRAPHQL
+        query($owner: String!, $name: String!) {
+          repository(owner: $owner, name: $name) {
+            name
+            forkCount
+          }
+        }
+      GRAPHQL
+
+      query_options = {
+        owner: owner,
+        name: name
+      }
+
+      Faf::Connection.query(query, query_options)
+    end
+  end
+end

data/lib/faf/security.rb

@@ -0,0 +1,40 @@
+module Faf
+  module Security
+    class << self
+      def store!(options)
+        Faf::Shell.system!(security('add', options))
+      end
+
+      def get(options)
+        Faf::Shell.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
+    end
+  end
+end

data/lib/faf/shell.rb

@@ -0,0 +1,11 @@
+module Faf
+  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/faf/version.rb

@@ -0,0 +1,3 @@
+module Faf
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: faf
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Doubrovkine
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-21 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.18.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.2
+- !ruby/object:Gem::Dependency
+  name: gli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.17'
+- !ruby/object:Gem::Dependency
+  name: graphlient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+- !ruby/object:Gem::Dependency
+  name: time_ago_in_words
+  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'
+description: 
+email: dblock@dblock.org
+executables:
+- faf
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTING.md
+- LICENSE.md
+- README.md
+- bin/faf
+- lib/faf.rb
+- lib/faf/auth.rb
+- lib/faf/connection.rb
+- lib/faf/forks.rb
+- lib/faf/repo.rb
+- lib/faf/security.rb
+- lib/faf/shell.rb
+- lib/faf/version.rb
+homepage: http://github.com/dblock/faf
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Find active GitHub forks.
+test_files: []