gh-search 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a300dcaf4a8dc6474fe1478e29eec71b0729447385d56cb1c6827b56b7936d81
+  data.tar.gz: 646036281be686eb397262d9eb3ecaf7cb0e5a1554af01a7df3eaa3466920cf7
+SHA512:
+  metadata.gz: c2680949249fa38fa5aa89f6206b3c181f5cd4bdb564ce8a85095ba4829ecadd28301bf31203674f248e973b500e63b80664c91dfaddfce4a2872864868e65b3
+  data.tar.gz: be7281c5d48a213e420237cd7b7c574bcba9826e3a75fcafe4be9b23154d2163306aeecf08ba00fcb1cffb28b401003be3d579e42e2295b390414d74f8d40bcc

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Dave Elliott
+
+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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "gh_search"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/gh-search

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+require "gh_search/cli"
+
+# ARGV.unshift(GhSearch::CLI.default_task) unless GhSearch::CLI.all_tasks.has_key?(ARGV[0]) || GhSearch::CLI.instance_variable_get(:@map).has_key?(ARGV[0])
+# GhSearch::CLI.new(ARGV).search
+GhSearch::CLI.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/gh_search.rb

@@ -0,0 +1,17 @@
+require "gh_search/version"
+require "gh_search/github_client"
+require "gh_search/formatters"
+
+module GhSearch
+  class Error < StandardError; end
+
+  def self.run(search_text, options={})
+    client = GithubClient.new(search_text, options)
+
+    Formatters.with(options.fetch(:format, 'plain')) do |formatter|
+      client.each do |match|
+        formatter.write(match)
+      end
+    end
+  end
+end

data/lib/gh_search/cli.rb

@@ -0,0 +1,89 @@
+require 'gh_search'
+require 'getoptlong'
+
+module GhSearch
+  class CLI
+    def self.start
+      opts = GetoptLong.new(
+        [ '--help', '-h', GetoptLong::NO_ARGUMENT ],
+        [ '--version', '-v', GetoptLong::NO_ARGUMENT ],
+        [ '--org', GetoptLong::REQUIRED_ARGUMENT ],
+        [ '--format', '-f', GetoptLong::REQUIRED_ARGUMENT ],
+        [ '--file', GetoptLong::REQUIRED_ARGUMENT ],
+        [ '--lang', GetoptLong::REQUIRED_ARGUMENT ],
+        [ '--output', '-o', GetoptLong::REQUIRED_ARGUMENT ],
+      )
+
+
+      options = {}
+
+      begin
+        opts.each do |opt, arg|
+          case opt
+          when '--help'
+            print_help
+            exit 0
+          when '--version'
+            puts "gh-search #{GhSearch::VERSION}"
+            exit 0
+          when '--org'
+            options[:org] = arg
+          when '--lang'
+            options[:lang] = arg
+          when '--file'
+            options[:file] = arg
+          when '--format'
+            options[:format ]= arg
+          when '--output'
+            options[:output] = arg
+          end
+        end
+      rescue GetoptLong::Error => e
+        print_help
+        exit 1
+      end
+      if ARGV.length != 1
+        puts "Missing SEARCH_TEXT argument (try --help)"
+        puts
+        print_help
+        exit 0
+      end
+
+      search_text = ARGV.shift
+
+      GhSearch.run(search_text, options)
+    end
+
+
+    private
+
+    def self.print_usage
+      puts "Usage: gh-search SEARCH_TEXT [OPTIONS]"
+      puts
+    end
+
+    def self.print_help
+      print_usage
+      puts <<-EOF
+SEARCH_TEXT:      The alphanumeric text to find matches of.
+
+Search Options:
+  --org           GitHub Organisation
+  --file          Filename to search (e.g. package.json)
+  --lang          Language type to search (e.g. yml)
+
+Output Options:
+  --output        Destination to write file
+  --format        Output format (e.g. json, csv)
+
+Misc Options:
+  -v, --version   Prints version
+  -h, --help      Prints this message
+
+For searching private repositories you will need to set the GITHUB_API_TOKEN environment variable.
+The GitHub documentation provides steps for this (https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token).
+      EOF
+    end
+  end
+end
+

data/lib/gh_search/formatters.rb

@@ -0,0 +1,30 @@
+module GhSearch
+  module Formatters
+    require "gh_search/formatters/base"
+    require "gh_search/formatters/plain"
+    require "gh_search/formatters/json"
+    require "gh_search/formatters/csv"
+
+    def self.with(type, options={})
+      formatter_class = case type
+                  when 'plain'
+                    Formatters::Plain
+                  when 'csv'
+                    Formatters::Csv
+                  when 'json'
+                    Formatters::Json
+                  when 'stdout'
+                    Formatters::Stdout
+                  else
+                    raise 'unknown format type'
+                  end
+
+      # puts "[DEBUG] Loaded #{formatter_class.name}"
+      formatter = formatter_class.new(options)
+      yield formatter
+
+      formatter.write_file!
+      puts
+    end
+  end
+end

data/lib/gh_search/formatters/base.rb

@@ -0,0 +1,26 @@
+module GhSearch
+  module Formatters
+    class Base
+      attr_reader :output_file
+      def initialize(options={})
+        @output_file = options[:output]
+      end
+
+      def write!(match)
+        raise NotImplementedError
+      end
+
+      def write_file!
+        # used for writing out a file
+      end
+
+      protected
+
+      def print_and_flush(str)
+        print str
+        $stdout.flush
+      end
+
+    end
+  end
+end

data/lib/gh_search/formatters/csv.rb

@@ -0,0 +1,31 @@
+require 'csv'
+
+module GhSearch
+  module Formatters
+    class Csv < Base
+      def write(match)
+
+        if output_file
+          @file ||= CSV.open(output_file, "w")
+          unless @headers
+            @headers = match.keys
+            @file << @headers
+          end
+
+          @file << match.values
+          print_and_flush('.')
+        else
+          unless @headers
+            @headers = match.keys
+            puts @headers.join(',')
+          end
+          puts match.values.join(',')
+        end
+      end
+
+      def write_file!
+        @file.close if @file
+      end
+    end
+  end
+end

data/lib/gh_search/formatters/json.rb

@@ -0,0 +1,23 @@
+require 'json'
+
+module GhSearch
+  module Formatters
+    class Json < Base
+      def write(match)
+        @data ||= []
+        @data << match
+        print_and_flush('.') if output_file
+      end
+
+      def write_file!
+        if output_file
+          @file ||= File.open(output_file, "w")
+          @file.write @data.to_json
+          @file.close
+        else
+          puts @data
+        end
+      end
+    end
+  end
+end

data/lib/gh_search/formatters/plain.rb

@@ -0,0 +1,21 @@
+module GhSearch
+  module Formatters
+    class Plain < Base
+      def write(match)
+        text = [match[:repo_name], match[:path], match[:linenumber], match[:text], "\n"].join(' ')
+
+        if output_file
+          @file ||= File.open(output_file, "w")
+          @file.write text
+          print_and_flush('.')
+        else
+          puts text
+        end
+      end
+
+      def write_file!
+        @file.close if @file
+      end
+    end
+  end
+end

data/lib/gh_search/github_client.rb

@@ -0,0 +1,116 @@
+#!/usr/bin/ruby
+# Simple utilitiy that uses the GitHub API for search
+#
+#  Example endpoint it uses: https://api.github.com/search/code?q=HACK+in:file+org:Sage
+
+module GhSearch
+  require 'net/http'
+  require "base64"
+  require 'json'
+
+  class GithubClient
+    GITHUB_URL = "https://api.github.com"
+    ENDPOINT = "/search/code"
+
+    attr_reader :org, :search_text, :filename
+
+    attr_accessor :pagenum
+
+    def initialize(search_text, options={})
+      @search_text = search_text
+      @org = options[:org]
+      @filename = options[:file]
+      @pagenum = 1
+    end
+
+    def each
+      has_results = true
+
+      while has_results do
+        json_response = make_request(uri)['items']
+
+        if has_results = json_response.any?
+          json_response.each do |item|
+            each_match(URI(item['url'])) do |match|
+
+              result = match.merge({
+                repo_name: item['repository']['full_name'],
+                html_url: item['html_url'],
+              })
+
+              yield result
+            end
+          end
+        end
+
+        @pagenum += 1
+      end
+    end
+
+    private
+
+    def make_request(request_uri)
+      # puts uri # debug
+      req = Net::HTTP::Get.new(request_uri)
+
+      if ENV['GITHUB_API_TOKEN']
+        req['AUTHORIZATION'] = "token #{github_token}"
+      else
+        puts "[WARN] unauthenticated"
+      end
+
+      http = Net::HTTP.new(request_uri.hostname, request_uri.port)
+      http.use_ssl = true
+
+      response = http.request(req)
+
+      if response.code != "200"
+        puts "[ERROR]: #{response.code}"
+        puts "[DEBUG] failed to call #{request_uri}"
+        puts response.body
+        exit 1
+      end
+
+      JSON.parse(response.body)
+    end
+
+    def each_match(request_uri)
+      response = make_request(request_uri)
+
+      raise 'Error dont know how to decode content' if response['encoding'] != "base64"
+      plain = Base64.decode64(response['content'])
+
+      begin
+        # TODO get line number
+        plain.match(/(.*#{search_text}.*)/i).captures.each do |capture|
+          match = {
+            text: capture,
+            path: response['path'],
+            commit_sha: response['sha'],
+          }
+          yield match
+        end
+      rescue
+        # could not find match
+        return nil
+      end
+    end
+
+    def github_token
+      ENV.fetch('GITHUB_API_TOKEN')
+    end
+
+    def uri
+      query = "q=#{search_text}"
+      query += "+in:file"
+      query += "+org:#{org}" if org
+      query += "+filename:#{filename}" if filename
+
+      url = [GITHUB_URL, ENDPOINT, "?page=#{@pagenum}&", query].join
+      # puts "[DEBUG] url: '#{url}'"
+
+      URI(url)
+    end
+
+  end
+end

data/lib/gh_search/version.rb

@@ -0,0 +1,3 @@
+module GhSearch
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: gh-search
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dave Elliott
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-03-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Uses the GitHub API to perform searches for given string
+email:
+- ddazza@gmail.com
+executables:
+- gh-search
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- bin/console
+- bin/gh-search
+- bin/setup
+- lib/gh_search.rb
+- lib/gh_search/cli.rb
+- lib/gh_search/formatters.rb
+- lib/gh_search/formatters/base.rb
+- lib/gh_search/formatters/csv.rb
+- lib/gh_search/formatters/json.rb
+- lib/gh_search/formatters/plain.rb
+- lib/gh_search/github_client.rb
+- lib/gh_search/version.rb
+homepage: https://github.com/DDAZZA/gh-search/blob/master/README.md
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/DDAZZA/gh-search/blob/master/README.md
+  source_code_uri: https://github.com/DDAZZA/gh-search
+  changelog_uri: https://github.com/DDAZZA/gh-search/blob/master/CHANGE_LOG.md
+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: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Tool to search GitHub for matching text
+test_files: []