threadfix-cli 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1e54acd08e9bb3fae80fc89232d76d1e2c2d57b3e94d4d640b687c61cace57f
-  data.tar.gz: 2269a7fb0d0b9ac1ab02072ce8d507a57383d385a0330655aa73400b9969771a
+  metadata.gz: b742e971c8a8526553a028f6977d58f412ea8366279ddb691ec1359b924fb371
+  data.tar.gz: c08fabb6f96447287c261d5bd102cf6f76141842f3614e6fc0058af3b9067dc6
 SHA512:
-  metadata.gz: 7b123e7c57c914c821cf434430c46310bd41cf46e5bce6bcab53c0ee882ae0b1742bcc9ba918aeb68a76f9d14058359b2ad7a0c061a79f6d8b2ae87fb02b0a68
-  data.tar.gz: af0c3b4df849907049b148f73c7d7ebacb6856f0e52ed87de12dcb52a911051413e81a5b737a70e38dae108789bda9ee6df02d541a6dd93b3d721674baa55376
+  metadata.gz: 7263c301222945d2b3faed28fca1df0100a0b5310b66213b7557d3761dfd735ef3effcca67b7879e4a7b6bef99f93cb7b3b31b3a04facac4568633beefd725ee
+  data.tar.gz: 44ecd4264b54fc75276fd4ada4e9d2013b0a59faf0baa3c20e08b6bf0248d45c65f7a9688753a9bc0bfa292d5130b6b11e744684b1c697f0783e7f215cf38e2c

data/CHANGE_LOG.md

@@ -1,3 +1,9 @@
 # v0.1.0
 
 - Initial release to upload scans
+
+# v0.2.0
+
+- Changed $HOST to $THREADFIX_HOST
+- Added $ threadfix version
+- Added $ threadfix applications lookup

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    threadfix (0.1.0)
-      rest-client
-      thor
+    threadfix-cli (0.1.0)
+      rest-client (= 2.0.2)
+      thor (= 0.20.3)
 
 GEM
   remote: https://rubygems.org/
@@ -53,7 +53,7 @@ DEPENDENCIES
   pry
   rake (~> 10.0)
   rspec (~> 3.0)
-  threadfix!
+  threadfix-cli!
 
 BUNDLED WITH
    2.0.1

data/README.md

@@ -1,18 +1,29 @@
 # Threadfix
-Command line tool to upload a static analysis report to ThreadFix
+Command line tool that wraps the ThreadFix API
 
 ## Installation
 
-Install it  with:
+Install with:
 
 ```ruby
- $ gem install threadfix
+$ gem install threadfix-cli
 ```
 
 ## Usage
 
 ```ruby
- $ threadfix scan upload --app-id <APP-ID> --host <Server> --key <Auth Key> --file ./repo/results.json
+$ export THREADFIX_TOKEN=<API key>
+
+$ threadfix applications lookup \
+    --app-name <Application Name> \
+    --team-name <Team Name> \
+#=> <Application ID>
+
+$ threadfix scan upload \
+    --app-id <Application ID> \
+    --host <Host Name> \
+    --file ./repo/results.json
+#=> <Upload Status>
 ```
 
 ## Development

data/lib/threadfix/cli.rb

@@ -1,6 +1,7 @@
 require 'thor'
 require "threadfix/cli/version"
 require "threadfix/cli/scan"
+require "threadfix/cli/applications"
 require "threadfix/client"
 
 module Threadfix
@@ -8,7 +9,15 @@ module Threadfix
 
     class Error < StandardError; end
 
+    desc "version", "print version"
+    def version
+      puts Cli::VERSION
+    end
+
     desc "scan <command>", "manage scans"
     subcommand "scan", Cli::Scan
+
+    desc "applications <command>", "manage applications"
+    subcommand "applications", Cli::Applications
   end
 end

data/lib/threadfix/cli/applications.rb

@@ -0,0 +1,30 @@
+require "threadfix/client"
+module Threadfix
+  module Cli
+    class Applications < Thor
+      desc "lookup", "lookup an application ID"
+      option :host
+      option :key, desc: "Authorisation key"
+      option :app_name, required: true
+      option :team_name, required: true
+      def lookup
+        Client.configure do |config|
+          config.host = options[:host] if options[:host]
+          config.key = options[:key] if options[:key]
+        end
+
+        begin
+          response =  Client::Applications.lookup(team_name: options[:team_name], app_name: options[:app_name] )
+          if response['message'] == ''
+            puts "ID: #{response['object']['id']}"
+          else
+            puts response['message']
+          end
+        rescue SocketError => e
+          puts "Error: Unable open connection to '#{Client.config.host}'"
+          exit 1
+        end
+      end
+    end
+  end
+end

data/lib/threadfix/cli/scan.rb

@@ -4,7 +4,7 @@ module Threadfix
     class Scan < Thor
       desc "upload", "Uploads a scan to ThreadFix"
       option :host
-      option 'app-id', required: true, type: :numeric
+      option :app_id, required: true, type: :numeric
       option :file, required: true, aliases: '-f', desc: "Report to upload"
       option :key, desc: "Authorisation key"
       def upload
@@ -14,7 +14,7 @@ module Threadfix
         end
 
         begin
-          response =  Client::Scans.upload(file_path: options[:file], app_id: options['app-id'] )
+          response =  Client::Scans.upload(file_path: options[:file], app_id: options[:app_id] )
           puts response['message']
         rescue Errno::ENOENT => e
           puts "Error: File or directory '#{options[:file]}' doesn't exist."

data/lib/threadfix/cli/version.rb

@@ -1,5 +1,5 @@
 module Threadfix
   module Cli
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/threadfix/client.rb

@@ -1,4 +1,5 @@
 require "threadfix/client/scans"
+require "threadfix/client/applications"
 
 module Threadfix
   module Client
@@ -15,7 +16,7 @@ module Threadfix
       attr_accessor :host, :key
 
       def initialize
-        @host = ENV['HOST']
+        @host = ENV['THREADFIX_HOST']
         @key = ENV['THREADFIX_TOKEN']
       end
     end

data/lib/threadfix/client/applications.rb

@@ -0,0 +1,17 @@
+require "threadfix/client/applications/lookup"
+
+module Threadfix
+  module Client
+    module Applications
+      class <<self
+
+        # @param file_path
+        # @return Hash
+        def lookup(options={})
+          action = Lookup.new(options)
+          action.perform!
+        end
+      end
+    end
+  end
+end

data/lib/threadfix/client/applications/lookup.rb

@@ -0,0 +1,46 @@
+module Threadfix
+  module Client
+    module Applications
+      class Lookup
+        API_VERSION='2.5.0.2'
+
+        attr_reader :team_name, :app_name
+
+        def initialize(options={})
+          @team_name = options[:team_name]
+          @app_name = options[:app_name]
+        end
+
+        def perform!
+          begin
+            r = RestClient.get(
+              endpoint.to_s,
+              { :accept => "application/json", :Authorization => "APIKEY #{apiKey}" }
+            )
+            JSON.parse(r.body)
+          rescue RestClient::NotFound => e
+            puts "Endpoint not found (using API version: #{API_VERSION})"
+            raise e
+          rescue RestClient::ExceptionWithResponse => e
+            raise e
+          end
+        end
+
+        private
+
+        def endpoint
+          URI("#{host}/rest/#{API_VERSION}/applications/#{team_name}/lookup?name=#{app_name}")
+        end
+
+        def host
+          Client.config.host
+        end
+
+        def apiKey
+          Client.config.key
+        end
+      end
+
+    end
+  end
+end

data/lib/threadfix/client/scans/upload.rb

@@ -1,12 +1,13 @@
 require 'rest-client'
 require 'json'
+require 'uri'
 
 module Threadfix
   module Client
     module Scans
       class Upload
         API_VERSION='2.5'
-        attr_accessor :file_path, :app_id
+        attr_reader :file_path, :app_id
 
         def initialize(options={})
           @file_path = options[:file_path]
@@ -16,7 +17,7 @@ module Threadfix
         def perform!
           begin
             r = RestClient.post(
-              "#{host}/rest/#{API_VERSION}/applications/#{app_id}/upload",
+              endpoint.to_s,
               { file: file },
               { :accept => "application/json", :Authorization => "APIKEY #{apiKey}" }
             )
@@ -31,6 +32,10 @@ module Threadfix
 
         private
 
+        def endpoint
+          URI("#{host}/rest/#{API_VERSION}/applications/#{app_id}/upload")
+        end
+
         def file
           File.new(file_path, 'rb')
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: threadfix-cli
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Dave Elliott
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-08 00:00:00.000000000 Z
+date: 2019-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -100,9 +100,12 @@ files:
 - bin/setup
 - bin/threadfix
 - lib/threadfix/cli.rb
+- lib/threadfix/cli/applications.rb
 - lib/threadfix/cli/scan.rb
 - lib/threadfix/cli/version.rb
 - lib/threadfix/client.rb
+- lib/threadfix/client/applications.rb
+- lib/threadfix/client/applications/lookup.rb
 - lib/threadfix/client/scans.rb
 - lib/threadfix/client/scans/upload.rb
 - threadfix-cli.gemspec