github-grep 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c7dbab452ca85ef021446d8318c1293623ebbc17e9f2a6a3fd74b32aa2a5a0da
+  data.tar.gz: e5ccd15431cb9f46700aa7f336f68951e71f5b5269d0f97eb13e4a6904632316
+SHA512:
+  metadata.gz: 994f71f2cd15ca77611c094fb62300fea5446e21939e83e059ff4d15a5cb59bfaec58ecc39c150686dafed72ea4c70225f858c27cad5f7e66e88f233c4b8e3f6
+  data.tar.gz: 39a96320037e21bcfd77b2399733c4a0f15ce40a7a045cd6c2c7153cced54bff5e4d8d52960a9a8077276fc014cd1275e35bea81579cda0433d5cbdc331a62d6

data/MIT-LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (C) 2016 Michael Grosser <michael@grosser.it>
+
+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,20 @@
+makes github search grep and pipeable
+
+ - create a [application token](https://github.com/settings/applications) with read access
+ - clone repo
+ - follow script instructions
+
+```
+bundle
+
+export GITHUB_TOKEN=xxx
+# or: git config github.token xxx
+
+# search code:
+bin/github-grep 'user:grosser unicorn' | grep 'narrow-it-down' | grep -v 'something good'
+
+# search issues and PR comments:
+bin/github-grep 'repo:kubernetes/kubernetes network error' --issues | grep 'narrow-it-down' | grep -v 'something good'
+```
+
+NOTE: there are random 403 errors on the last page of a search (usually empty anyway), contacted github support about that :/

data/bin/github-grep

@@ -0,0 +1,91 @@
+#!/usr/bin/env ruby
+require 'cgi'
+require 'json'
+require 'shellwords'
+require 'open3'
+
+def usage
+  puts <<-TEXT.gsub(/^    /, "")
+    Setup
+    -----
+    # create a new token at https://github.com/settings/tokens/new with repo access
+    git config github.token NEW_TOKEN --local
+
+    Usage
+    -----
+    #{$0} 'something to search for'
+  TEXT
+  exit 1
+end
+
+def code_items_to_lines(items)
+  items.flat_map do |item|
+    file = item.fetch('repository').fetch('name') + ":" + item.fetch('path')
+    lines(item).map { |l| "#{file}: #{l}" }
+  end
+end
+
+def issue_items_to_lines(items)
+  items.flat_map do |item|
+    number = item.fetch("number")
+    lines(item).map { |l| "##{number}: #{l}" }
+  end
+end
+
+def lines(item)
+  item.fetch("text_matches").flat_map { |match| match.fetch('fragment').split("\n") }
+end
+
+def search(q, type)
+  per_page = 100
+  page = 1
+
+  loop do
+    response = page(q, type, page, per_page)
+    if page == 1
+      $stderr.puts "Found #{response.fetch("total_count")}"
+    else
+      $stderr.puts "Page #{page}"
+    end
+
+    items = response.fetch('items')
+    yield items
+
+    break if items.size < per_page
+    page += 1
+  end
+end
+
+def page(q, type, page, per_page)
+  github_token = ENV['GITHUB_TOKEN'] || `git config github.token`.strip # TODO: update docs
+  usage if github_token.empty?
+
+  # remove --fail and add -v to see response headers
+  # NOTE: github returns a 403 with a Retry-After: 60 on page 3+ ... talking with support atm but might have to handle it
+  url = "https://api.github.com/search/#{type}?per_page=#{per_page}&page=#{page}&q=#{CGI.escape(q)}"
+  command = ["curl", "-v", "-f", "-H", "Authorization: token #{github_token}", "-H", "Accept: application/vnd.github.v3.text-match+json", url]
+
+  out, err, status = Open3.capture3(*command)
+  if retry_after = err[/Retry-After: (\d+)/, 1] # 403 Abuse rate limit
+    warn "Sleeping #{retry_after} to avoid abuse rate-limit"
+    sleep Integer(retry_after)
+    out, err, status = Open3.capture3(*command)
+  end
+
+  raise "ERROR Request failed\n#{url}\n#{err}\n#{out}" unless status.success?
+
+  JSON.load(out)
+end
+
+type = (ARGV.delete('--issues') ? :issues : :code)
+
+q = ARGV.shift
+usage if ARGV.size != 0
+
+search(q, type) do |items|
+  if type == :issues
+    puts issue_items_to_lines(items)
+  else
+    puts code_items_to_lines(items)
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: github-grep
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Michael Grosser
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-10-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bump
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: michael@grosser.it
+executables:
+- github-grep
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE.txt
+- README.md
+- bin/github-grep
+homepage: https://github.com/grosser/github-grep
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.16
+signing_key: 
+specification_version: 4
+summary: Makes github search grep and pipeable
+test_files: []