threadfix-cli 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b742e971c8a8526553a028f6977d58f412ea8366279ddb691ec1359b924fb371
-  data.tar.gz: c08fabb6f96447287c261d5bd102cf6f76141842f3614e6fc0058af3b9067dc6
+  metadata.gz: 211f70bf2afa9eeb52ed00045e60efb66d579acdd555216be902f7b3aa63a89e
+  data.tar.gz: b225cc93ac012b25ef8125eb9eb77fc373ba0f342676e05d0e8f9d0ab9618888
 SHA512:
-  metadata.gz: 7263c301222945d2b3faed28fca1df0100a0b5310b66213b7557d3761dfd735ef3effcca67b7879e4a7b6bef99f93cb7b3b31b3a04facac4568633beefd725ee
-  data.tar.gz: 44ecd4264b54fc75276fd4ada4e9d2013b0a59faf0baa3c20e08b6bf0248d45c65f7a9688753a9bc0bfa292d5130b6b11e744684b1c697f0783e7f215cf38e2c
+  metadata.gz: f813b8519a5fffbb01e9860e8442bbc4593f5bd751f3b51215f9383edf594344220f8bbdfe288fb79a4b82856cc3307f9de33bd9eb9982edc592628fffa97939
+  data.tar.gz: 2455dfaae7f91fe92809370180d188d7b8c3664b0e0a9fc9bb54ad7b9cc2a04621eb5e46b005eb50af7a0b82f4b83189538244ce70450e4da141da7ead5780eb

data/lib/threadfix/cli/applications.rb

@@ -2,6 +2,27 @@ require "threadfix/client"
 module Threadfix
   module Cli
     class Applications < Thor
+      desc "get_id", "gets an application ID from a application name"
+      option :host
+      option :key, desc: "Authorisation key"
+      option :app_name, required: true
+      def get_id
+        Client.configure do |config|
+          config.host = options[:host] if options[:host]
+          config.key = options[:key] if options[:key]
+        end
+
+        begin
+          response =  Client::Applications.get_id(app_name: options[:app_name] )
+          if !response.nil?
+            puts response
+          end
+        rescue SocketError => e
+          puts "Error: Unable open connection to '#{Client.config.host}'"
+          exit 1
+        end
+      end
+
       desc "lookup", "lookup an application ID"
       option :host
       option :key, desc: "Authorisation key"

data/lib/threadfix/cli/scan.rb

@@ -15,7 +15,10 @@ module Threadfix
 
         begin
           response =  Client::Scans.upload(file_path: options[:file], app_id: options[:app_id] )
-          puts response['message']
+          message = response['message']
+          message = message + " (ID: #{response['object']['id']})" if response['object'] && response['object']['id']
+
+          puts message
         rescue Errno::ENOENT => e
           puts "Error: File or directory '#{options[:file]}' doesn't exist."
           exit 1

data/lib/threadfix/cli/version.rb

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

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

@@ -0,0 +1,54 @@
+module Threadfix
+  module Client
+    module Applications
+      class GetId
+        # https://denimgroup.atlassian.net/wiki/spaces/TDOC/pages/664567813/List+Applications+-+API
+        API_VERSION='2.7.5'
+
+        attr_reader :app_name
+
+        def initialize(options={})
+          @app_name = options[:app_name]
+        end
+
+        def perform!
+          begin
+            r = RestClient.get(
+              endpoint.to_s,
+              { :accept => "application/json", :Authorization => "APIKEY #{apiKey}" }
+            )
+            body = JSON.parse(r.body)
+
+            begin
+              body.fetch('object')
+                .find{ |a| a.fetch('name') == app_name}.fetch('id')
+            rescue => e
+              puts "App '#{app_name}' was not found."
+              nil # return nil if data not found
+            end
+          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")
+        end
+
+        def host
+          Client.config.host
+        end
+
+        def apiKey
+          Client.config.key
+        end
+      end
+
+    end
+  end
+end

data/lib/threadfix/client/applications.rb

@@ -1,16 +1,25 @@
 require "threadfix/client/applications/lookup"
+require "threadfix/client/applications/get_id"
 
 module Threadfix
   module Client
     module Applications
       class <<self
 
-        # @param file_path
+        # @param options[app_name]
+        # @param options[team_name]
         # @return Hash
         def lookup(options={})
           action = Lookup.new(options)
           action.perform!
         end
+
+        # @param options[app_name]
+        # @return Hash
+        def get_id(options={})
+          action = GetId.new(options)
+          action.perform!
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: threadfix-cli
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Dave Elliott
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-09 00:00:00.000000000 Z
+date: 2022-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -88,14 +88,6 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- CHANGE_LOG.md
-- Gemfile
-- Gemfile.lock
-- LICENSE
-- README.md
-- Rakefile
 - bin/console
 - bin/setup
 - bin/threadfix
@@ -105,10 +97,10 @@ files:
 - lib/threadfix/cli/version.rb
 - lib/threadfix/client.rb
 - lib/threadfix/client/applications.rb
+- lib/threadfix/client/applications/get_id.rb
 - lib/threadfix/client/applications/lookup.rb
 - lib/threadfix/client/scans.rb
 - lib/threadfix/client/scans/upload.rb
-- threadfix-cli.gemspec
 homepage: https://github.com/DDAZZA/threadfix-cli
 licenses: []
 metadata:
@@ -130,8 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.2.32
 signing_key: 
 specification_version: 4
 summary: CLI to upload scan report to ThreadFix

data/.gitignore

@@ -1,11 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/CHANGE_LOG.md

@@ -1,9 +0,0 @@
-# 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

@@ -1,6 +0,0 @@
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in threadfix-cli.gemspec
-gemspec
-
-gem 'pry'

data/Gemfile.lock

@@ -1,59 +0,0 @@
-PATH
-  remote: .
-  specs:
-    threadfix-cli (0.1.0)
-      rest-client (= 2.0.2)
-      thor (= 0.20.3)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    coderay (1.1.2)
-    diff-lcs (1.3)
-    domain_name (0.5.20180417)
-      unf (>= 0.0.5, < 1.0.0)
-    http-cookie (1.0.3)
-      domain_name (~> 0.5)
-    method_source (0.9.2)
-    mime-types (3.2.2)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2019.0331)
-    netrc (0.11.0)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    rake (10.5.0)
-    rest-client (2.0.2)
-      http-cookie (>= 1.0.2, < 2.0)
-      mime-types (>= 1.16, < 4.0)
-      netrc (~> 0.8)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    thor (0.20.3)
-    unf (0.1.4)
-      unf_ext
-    unf_ext (0.0.7.5)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 2.0)
-  pry
-  rake (~> 10.0)
-  rspec (~> 3.0)
-  threadfix-cli!
-
-BUNDLED WITH
-   2.0.1

data/LICENSE

@@ -1,9 +0,0 @@
-MIT License
-
-Copyright (c) 2019 David 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 (including the next paragraph) 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

@@ -1,37 +0,0 @@
-# Threadfix
-Command line tool that wraps the ThreadFix API
-
-## Installation
-
-Install with:
-
-```ruby
-$ gem install threadfix-cli
-```
-
-## Usage
-
-```ruby
-$ 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
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-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).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/DDAZZA/threadfix-cli.

data/Rakefile

@@ -1,6 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec

data/threadfix-cli.gemspec

@@ -1,44 +0,0 @@
-
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "threadfix/cli/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "threadfix-cli"
-  spec.version       = Threadfix::Cli::VERSION
-  spec.authors       = ["Dave Elliott"]
-  spec.email         = ["ddazza@gmail.com"]
-
-  spec.summary       = %q{CLI to upload scan report to ThreadFix}
-  spec.description   = %q{Command line tool to upload a static analysis report to ThreadFix}
-  spec.homepage      = "https://github.com/DDAZZA/threadfix-cli"
-
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-  if spec.respond_to?(:metadata)
-    # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
-
-    spec.metadata["homepage_uri"] = spec.homepage
-    spec.metadata["source_code_uri"] = "https://github.com/DDAZZA/threadfix-cli"
-    spec.metadata["changelog_uri"] = "https://github.com/DDAZZA/threadfix-cli/blob/master/CHANGE_LOG.md"
-  else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
-  end
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
-  spec.bindir        = "bin"
-  spec.executables   = "threadfix"
-  spec.require_paths = ["lib"]
-
-  spec.add_runtime_dependency "thor", '0.20.3'
-  spec.add_runtime_dependency "rest-client", '2.0.2'
-
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-end