dependagrab 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd35ef0ade298a293c34027c89bfdb351610bf2ccbaf2101492153b9e605b20a
-  data.tar.gz: 5645015e5ba4cb5ec457001cc9125e10f50c5fe9458b53b79b117b23f3549065
+  metadata.gz: 7e32432885a4421f53fc65a7ffca2b8fef05e8738088b437eb8e9aa9a98d8f0b
+  data.tar.gz: 8cbbc87b9c80d5a81a6f3fe36a9758e57d43e60ac2fb1aecc291ac11b712962a
 SHA512:
-  metadata.gz: d73f942dd1c05ef4b923e874917d5d3d7752e2a7e85755f431161d41d02a5d9e82d98dd60af6ad92cada4203dfd7433b474af5c7244ce0e386b899156c3a249b
-  data.tar.gz: a4a915c49803c23ab5a782d905833243f720070fc440a4e285f43386da9560a6db9358c112396e3c8e0895b782f18eaece6e3c68472ad81107677c2677489cae
+  metadata.gz: b41b50249738a6d4df018e21f4f64c69eb7e1f052be98d5cad399202e66e97a4734db2d3da359f43fe60b058b817b3cbb9c3483efad37ef70d6fc09c697d5b77
+  data.tar.gz: 0ba5284cde0e3291400001ae6137a50529da56ea758b8d309cfc48f6a7b4f6cad713b8f36234113209da5533b9e765e077811bceb83f2b877ba39970cbb9acfc

data/CHANGE_LOG.md

@@ -1,3 +1,7 @@
+# V0.1.6
+Handle interrupt and exceptions output nicer
+Change source name in json output to dependabot
+
 # V0.1.5
 Fix when there is no CWE present
 

data/Dockerfile

@@ -1,6 +1,6 @@
 FROM ruby:3.0.3-slim-bullseye
 
-COPY pkg/*.gem .
+COPY pkg/*.gem ./
 
 RUN gem install *.gem
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dependagrab (0.1.5)
+    dependagrab (0.1.6)
       graphql-client (= 0.17.0)
 
 GEM

data/README.md

@@ -1,26 +1,57 @@
 # Dependagrab
+Utility for extracting dependency warnings from GitHub
+
+[![Gem Version](https://badge.fury.io/rb/dependagrab.svg)](https://badge.fury.io/rb/dependagrab)
 
-Tool for extracting GitHub dependency warnings and converting it into a ThreadFix compatible file
 
 ## Installation
 
-Install it with:
+*with ruby*
+```bash
+$ gem install dependagrab
+#=> Fetching dependagrab-0.1.6.gem
+#=> Successfully installed dependagrab-0.1.6
+#=> 1 gem installed
+```
 
-    $ gem install dependagrab
+*with docker*
+```bash
+$ docker pull ddazza/dependagrab:latest
+```
+
+### Configure
+[Setup a GitHub access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)
+```bash
+export GITHUB_API_TOKEN=<token> 
+```
 
 ## Usage
 
-    `$ dependagrab --help`
+*with ruby*
+```bash
+# Usage: dependagrab <REPO> [Options]
+# e.g. dependagrab DDAZZA/foo
 
-    `$ export GITHUB_API_TOKEN=<TOKEN>`
-    `$ dependagrab DDAZZA/dependagrab`
+# or to write to a file
+dependagrab DDAZZA/foo --output ./foo.json
+#=> 3 dependency warnings written to './foo.json'
+
+```
+
+*with docker*
+```bash
+docker run --rm --env GITHUB_API_TOKEN --volume `pwd`:/output \
+  ddazza/dependagrab:latest DDAZZA/foo --output /output/foo.json
+  #=> 3 dependency warnings written to '/output/foo.json'
+```
 
 ## Development
 
 ```
 $ git clone https://github.com/DDAZZA/dependagrab.git
 $ bundle install
-$ ruby -Ilib ./bin/dependagrab --help
+$ bundle exec rake install
+$ dependagrab --help
 ```
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

data/Rakefile

@@ -4,3 +4,14 @@ require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
+
+desc 'build docker image'
+task :build_docker do
+  require './lib/dependagrab.rb'
+  system("docker build --tag ddazza/dependagrab:#{Dependagrab::VERSION} .")
+  system("docker tag ddazza/dependagrab:latest ddazza/dependagrab:#{Dependagrab::VERSION}")
+
+  puts
+  puts  "$ docker push ddazza/dependagrab:#{Dependagrab::VERSION}"
+  puts  "$ docker push ddazza/dependagrab:latest"
+end

data/bin/dependagrab

@@ -1,4 +1,11 @@
 #!/usr/bin/env ruby
 require "dependagrab/cli"
 
-Dependagrab::CLI.start
+begin
+  Dependagrab::CLI.start
+rescue SignalException => e
+  # exit
+rescue Exception => e
+  STDERR.puts "Error: Something went wrong (set DEBUG=true for detailed backtrace)"
+  STDERR.puts e.backtrace if ENV['DEBUG']
+end

data/lib/dependagrab/cli.rb

@@ -26,7 +26,10 @@ module Dependagrab
           end
         end
       rescue GetoptLong::Error => e
+        STDERR.puts "Error: #{e.message}  (set DEBUG=true for detailed backtrace)"
+        puts
         print_help
+        STDERR.puts e.backtrace if ENV['DEBUG']
         exit 1
       end
 
@@ -42,7 +45,13 @@ module Dependagrab
         exit 1
       end
 
-      run(options)
+      begin
+        run(options)
+      rescue => e
+        STDERR.puts "Error: #{e.message}  (set DEBUG=true for detailed backtrace)"
+        STDERR.puts e.backtrace if ENV['DEBUG']
+        exit 1
+      end
     end
 
     private
@@ -56,7 +65,7 @@ module Dependagrab
           puts "#{result[:alerts].count} dependency warnings written to '#{options.fetch(:output)}'"
         rescue => e
           STDERR.puts "Failed to write file '#{options.fetch(:output)}'"
-          STDERR.puts "#{e.message} (set DEBUG=true for detailed backtrace)"
+          STDERR.puts "Error: #{e.message} (set DEBUG=true for detailed backtrace)"
           STDERR.puts e.backtrace if ENV['DEBUG']
           exit 1
         end

data/lib/dependagrab/file_writer.rb

@@ -35,7 +35,7 @@ module Dependagrab
         id: SecureRandom.uuid,
         created: Time.now.strftime('%Y-%m-%dT%H:%M:%SZ'),
         exported: Time.now.strftime('%Y-%m-%dT%H:%M:%SZ'),
-        source: "AppSec Team",
+        source: "dependagrab",
         collectionType: "DEPENDENCY",
         findings: [],
       }

data/lib/dependagrab/version.rb

@@ -1,3 +1,3 @@
 module Dependagrab
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dependagrab
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Dave Elliott
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-06 00:00:00.000000000 Z
+date: 2021-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql-client