veracodecli 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0d86671ebe7e7e93e6b99fa5f5721077f83bc914
-  data.tar.gz: 0302d869bf676c5a9a13c80f1b9b824c5aa036f4
+  metadata.gz: 74b3b2fddb38344c96cd938c9f27ec1ba5642125
+  data.tar.gz: 3d2934ffea90f22732d1be2d5861e3e371d41993
 SHA512:
-  metadata.gz: cce72b0d8a252b2871740809e137cda2f59c55f74ab0a416f69ca53e25d820ddc95c302d7018115f878968b4cb745709a6483172ed8f675e33fc3ca05ecce661
-  data.tar.gz: 4fd15c923437ede2bd593d88ad9402ee428752ef6b634e086698426da319079f36a78f666ce695452fea6f11cab8b01e22f1bd51f42b5e1b1cb83d56b7bc61ae
+  metadata.gz: 4a97bfed947f96df61ca3f142243fc7861ffbcdd248e846d3832c08ee7903a2314052d81df6880b4a20a23696c700be9ce4738fde91c995f2cb81688179104ce
+  data.tar.gz: fe856103bdbd2a8946710fec5ecb6209146de7770f3fe68bae41f7fb7b0fcfb6ee9d7f92f53196018a3421eb82792fa1cdf3b5eb4244b262a19b3793faea405a

data/README.md

@@ -33,6 +33,11 @@ This gem uses [jeweler](https://github.com/technicalpickles/jeweler) for develop
 * Commit and push until you are happy with your contribution.
 * Make a pull request to this repo.
 
+## Roadmap
+Ideas for future development.
+
+* Config file: Make this cli scanner/tool agnostic. Should work with rest api services from other tools
+
 ## License
 
 [MIT](https://tldrlegal.com/license/mit-license)

data/bin/veracodecli

@@ -3,6 +3,8 @@
 require 'commander'
 require 'veracodecli'
 include VeracodeApiResults
+include VeracodeApiScan
+include VeracodeApiBase
 
 Commander.configure do
   program :name, 'veracodecli'
@@ -10,9 +12,8 @@ Commander.configure do
   program :description, 'CLI for automating veracode api requests'
   program :help, 'Author', 'Isaiah Thiessen <isaiah.thiessen@telus.com>'
 
-
   command :scan do |c|
-    c.syntax = 'veracodecli scan [hostname] [archive_path]'
+    c.syntax = 'veracodecli scan [app_name] [archive_path]'
     c.description = 'Submits a scan request to Veracode.'
     c.action do |args|
       fail 'Specify application Name.' if args.first.nil?
@@ -32,7 +33,7 @@ Commander.configure do
 
   command :get_status do |c|
     c.syntax = 'veracodecli get-status [app_id]'
-    c.description = 'Gets scan state of current build from Veracode.'
+    c.description = 'Gets scan state from Veracode.'
     c.action do |args|
       fail 'Specify app_id.' if args.first.nil?
       VeracodeApiResults.get_build_status args.first

data/lib/veracodecli/api.rb

@@ -9,22 +9,9 @@ module VeracodeApiBase
 
   def veracode_api_request(api_call, api_version: '4.0', **params)
     check_environment_login_variables
-    # puts "Making call to #{api_call}"
     response = RestClient.get "https://#{ENV['VERACODE_USERNAME']}:#{ENV['VERACODE_PASSWORD']}@analysiscenter.veracode.com/api/#{api_version}/#{api_call}", { params: params }
     response.body
   end
-
-  def xml_to_json(string)
-    json = Hash.from_xml(string).to_json
-    JSON.parse json
-  end
-
-  def write(data, to_file:)
-    data = xml_to_json data
-    f = File.open "../testdata/#{to_file}.json", 'w'
-    f.write JSON.pretty_generate data
-    f.close
-  end
 end
 
 module VeracodeApiScan
@@ -38,25 +25,22 @@ module VeracodeApiScan
       return app_list.scan(/app_id=\"(.+)\" app_name=\"#{of}\"/)[0][0]
     else
       puts 'Record not found, creating one'
-      create_app_result = veracode_api_request 'createapp.do', app_name: of, description: "Static Scanning profile for #{of}.", business_criticality: 'High', business_unit: 'TELUS Digital', web_application: 'true', teams: "#{ENV['VERACODE_TEAM']}"
+      create_app_result = veracode_api_request 'createapp.do', app_name: of, description: "Static Scanning profile for #{of}.", business_criticality: 'High', business_unit: "#{ENV['VERACODE_TEAM']}", web_application: 'true', teams: "#{ENV['VERACODE_TEAM']}"
       app_id = create_app_result.scan(/app_id=\"(.+)\" app_name=\"#{of}\"/)[0][0]
       puts "Record successfully created, app_id is #{app_id}"
       return app_id
     end
   end
 
-  def submit_scan(hostname, archive_path)
-    app_id = validate_existance of: hostname
-    # NOTE: curl must be used here because of a bug in the Veracode api. Ruby cannot be used while this bug is present.
+  def submit_scan(app_name, archive_path)
+    app_id = validate_existance of: app_name
+    # NOTE: curl must be used here because of a bug in the Veracode api. rest-client cannot be used while this bug is present.
     # NOTE: preferred code: upload_result = veracode_api_request 'uploadfile.do', app_id: app_id, file: "#{archive_path}"
     upload_result = `curl --url "https://#{ENV['VERACODE_USERNAME']}:#{ENV['VERACODE_PASSWORD']}@analysiscenter.veracode.com/api/4.0/uploadfile.do" -F 'app_id=#{app_id}' -F 'file=@#{archive_path}'`
     puts upload_result
-    # write upload_result, to_file: "#{app_id}_upload_result"
     prescan_submission_result = veracode_api_request 'beginprescan.do', app_id: app_id, auto_scan: 'true'
     puts prescan_submission_result
     puts "Submit complete for #{app_id}"
-    # File.write 'VERACODE_SCAN_RESULT_CHECK_QUEUE', app_id
-    # write prescan_submission_result, to_file: "#{app_id}_prescan_submission_result"
   end
 end
 
@@ -65,7 +49,6 @@ module VeracodeApiResults
 
   def get_most_recent_build_id(using:)
     build_list = veracode_api_request 'getbuildlist.do', app_id: using
-    # write build_list, to_file: "#{using}_build_list"
     build_list.scan(/build_id="(.*?)"/).last[0]
   end
 
@@ -79,13 +62,12 @@ module VeracodeApiResults
   def get_prescan_results(app_id)
     results = veracode_api_request 'getprescanresults.do', app_id: app_id
     puts "Fetched prescan results for #{app_id}"
-    # write results, to_file: "#{app_id}_prescan_results"
+    puts results
   end
 
   def get_scan_report(app_id)
     build_id = get_most_recent_build_id using: app_id
     report = veracode_api_request 'detailedreport.do', api_version: '3.0', build_id: build_id
-    puts "Fetched report for #{app_id}, build #{build_id}"
-    # write report, to_file: "#{app_id}_report"
+    puts report
   end
 end

data/test/test_veracodecli.rb

@@ -1,7 +1,20 @@
-require 'helper'
+require 'test/unit'
+require 'shoulda/context'
+require_relative '../lib/veracodecli/api'
+include VeracodeApiScan
 
 class TestVeracodecli < Test::Unit::TestCase
-  should "probably rename this file and start testing for real" do
-    flunk "hey buddy, you should probably rename this file and start testing for real"
+  context 'VeracodeApi' do
+
+    setup do
+      ENV['VERACODE_USERNAME'] = 'foo'
+      ENV['VERACODE_PASSWORD'] = 'bar'
+      ENV['VERACODE_TEAM'] = 'foobar'
+    end
+
+    should 'Return HTTP 401' do
+      assert_equal response.code, veracode_api_request('getapplist.do', '')
+    end
+
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: veracodecli
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - isaiah thiessen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-28 00:00:00.000000000 Z
+date: 2015-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -178,20 +178,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.1.0
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.32.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.32.1
 description: Ruby based CLI for accessing veracode's api
 email: isaiah.thiessen@telus.com
 executables:
@@ -201,21 +187,14 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.md
 files:
-- ".document"
-- ".gitignore"
-- Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
-- Rakefile
-- VERSION
 - bin/veracodecli
 - lib/veracodecli.rb
 - lib/veracodecli/api.rb
 - test/API.rb
 - test/helper.rb
 - test/test_veracodecli.rb
-- veracodecli.gemspec
 homepage: http://github.com/isand3r/veracodecli
 licenses:
 - MIT
@@ -240,4 +219,8 @@ rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Ruby based CLI for accessing veracode's api
-test_files: []
+test_files:
+- test/API.rb
+- test/helper.rb
+- test/test_veracodecli.rb
+has_rdoc: 

data/.document

@@ -1,5 +0,0 @@
-lib/**/*.rb
-bin/*
-- 
-features/**/*.feature
-LICENSE.txt

data/.gitignore

@@ -1,49 +0,0 @@
-# rcov generated
-coverage
-coverage.data
-
-# rdoc generated
-rdoc
-
-# yard generated
-doc
-.yardoc
-
-# bundler
-.bundle
-
-# jeweler generated
-pkg
-
-# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
-#
-# * Create a file at ~/.gitignore
-# * Include files you want ignored
-# * Run: git config --global core.excludesfile ~/.gitignore
-#
-# After doing this, these files will be ignored in all your git projects,
-# saving you from having to 'pollute' every project you touch with them
-#
-# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
-#
-# For MacOS:
-#
-#.DS_Store
-
-# For TextMate
-#*.tmproj
-#tmtags
-
-# For emacs:
-#*~
-#\#*
-#.\#*
-
-# For vim:
-#*.swp
-
-# For redcar:
-#.redcar
-
-# For rubinius:
-#*.rbc

data/Gemfile

@@ -1,18 +0,0 @@
-source "http://rubygems.org"
-
-gem 'json'
-gem 'activesupport'
-gem 'rest-client'
-gem 'commander'
-
-group :development do
-  gem "shoulda", ">= 0"
-  gem "yard", "~> 0.7"
-  gem "rdoc", "~> 3.12"
-  gem "bundler", "~> 1.0"
-  gem "jeweler", "~> 2.0.1"
-  gem "simplecov", ">= 0"
-  gem "reek", "~> 1.2.8"
-  gem "roodi", "~> 2.1.0"
-  gem "rubocop", "~> 0.32.1"
-end

data/Gemfile.lock

@@ -1,136 +0,0 @@
-GEM
-  remote: http://rubygems.org/
-  specs:
-    activesupport (4.2.4)
-      i18n (~> 0.7)
-      json (~> 1.7, >= 1.7.7)
-      minitest (~> 5.1)
-      thread_safe (~> 0.3, >= 0.3.4)
-      tzinfo (~> 1.1)
-    addressable (2.3.8)
-    ast (2.0.0)
-    astrolabe (1.3.1)
-      parser (~> 2.2)
-    builder (3.2.2)
-    commander (4.3.5)
-      highline (~> 1.7.2)
-    descendants_tracker (0.0.4)
-      thread_safe (~> 0.3, >= 0.3.1)
-    docile (1.1.5)
-    domain_name (0.5.24)
-      unf (>= 0.0.5, < 1.0.0)
-    faraday (0.9.1)
-      multipart-post (>= 1.2, < 3)
-    git (1.2.9.1)
-    github_api (0.12.4)
-      addressable (~> 2.3)
-      descendants_tracker (~> 0.0.4)
-      faraday (~> 0.8, < 0.10)
-      hashie (>= 3.4)
-      multi_json (>= 1.7.5, < 2.0)
-      nokogiri (~> 1.6.6)
-      oauth2
-    hashie (3.4.2)
-    highline (1.7.6)
-    http-cookie (1.0.2)
-      domain_name (~> 0.5)
-    i18n (0.7.0)
-    jeweler (2.0.1)
-      builder
-      bundler (>= 1.0)
-      git (>= 1.2.5)
-      github_api
-      highline (>= 1.6.15)
-      nokogiri (>= 1.5.10)
-      rake
-      rdoc
-    json (1.8.3)
-    jwt (1.5.1)
-    mime-types (2.6.2)
-    mini_portile (0.6.2)
-    minitest (5.8.0)
-    multi_json (1.11.2)
-    multi_xml (0.5.5)
-    multipart-post (2.0.0)
-    netrc (0.10.3)
-    nokogiri (1.6.6.2)
-      mini_portile (~> 0.6.0)
-    oauth2 (1.0.0)
-      faraday (>= 0.8, < 0.10)
-      jwt (~> 1.0)
-      multi_json (~> 1.3)
-      multi_xml (~> 0.5)
-      rack (~> 1.2)
-    parser (2.2.2.6)
-      ast (>= 1.1, < 3.0)
-    powerpack (0.1.1)
-    rack (1.6.4)
-    rainbow (2.0.0)
-    rake (10.4.2)
-    rdoc (3.12.2)
-      json (~> 1.4)
-    reek (1.2.13)
-      ripper_ruby_parser (~> 0.0.7)
-      ruby2ruby (~> 1.2.5)
-      ruby_parser (~> 2.0)
-      sexp_processor (~> 3.0)
-    rest-client (1.8.0)
-      http-cookie (>= 1.0.2, < 2.0)
-      mime-types (>= 1.16, < 3.0)
-      netrc (~> 0.7)
-    ripper_ruby_parser (0.0.8)
-      sexp_processor (~> 3.0)
-    roodi (2.1.0)
-      ruby_parser
-    rubocop (0.32.1)
-      astrolabe (~> 1.3)
-      parser (>= 2.2.2.5, < 3.0)
-      powerpack (~> 0.1)
-      rainbow (>= 1.99.1, < 3.0)
-      ruby-progressbar (~> 1.4)
-    ruby-progressbar (1.7.5)
-    ruby2ruby (1.2.5)
-      ruby_parser (~> 2.0)
-      sexp_processor (~> 3.0)
-    ruby_parser (2.3.1)
-      sexp_processor (~> 3.0)
-    sexp_processor (3.2.0)
-    shoulda (3.5.0)
-      shoulda-context (~> 1.0, >= 1.0.1)
-      shoulda-matchers (>= 1.4.1, < 3.0)
-    shoulda-context (1.2.1)
-    shoulda-matchers (2.8.0)
-      activesupport (>= 3.0.0)
-    simplecov (0.10.0)
-      docile (~> 1.1.0)
-      json (~> 1.8)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.0)
-    thread_safe (0.3.5)
-    tzinfo (1.2.2)
-      thread_safe (~> 0.1)
-    unf (0.1.4)
-      unf_ext
-    unf_ext (0.0.7.1)
-    yard (0.8.7.6)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  activesupport
-  bundler (~> 1.0)
-  commander
-  jeweler (~> 2.0.1)
-  json
-  rdoc (~> 3.12)
-  reek (~> 1.2.8)
-  rest-client
-  roodi (~> 2.1.0)
-  rubocop (~> 0.32.1)
-  shoulda
-  simplecov
-  yard (~> 0.7)
-
-BUNDLED WITH
-   1.10.6

data/Rakefile

@@ -1,67 +0,0 @@
-# encoding: utf-8
-
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'rake'
-
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
-  gem.name = "veracodecli"
-  gem.homepage = "http://github.com/isand3r/veracodecli"
-  gem.license = "MIT"
-  gem.summary = %Q{Ruby based CLI for accessing veracode's api}
-  gem.description = %Q{Ruby based CLI for accessing veracode's api}
-  gem.email = "isaiah.thiessen@telus.com"
-  gem.authors = ["isaiah thiessen"]
-  gem.files = `git ls-files`.split("\n")
-  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  gem.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
-  gem.require_paths = ['lib']
-  # dependencies defined in Gemfile
-end
-Jeweler::RubygemsDotOrgTasks.new
-
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
-
-require 'rubocop/rake_task'
-RuboCop::RakeTask.new(:rubocop) do |task|
-  task.patterns = ['lib/**/*.rb']
-  task.fail_on_error = false
-end
-
-desc "Code coverage detail"
-task :simplecov do
-  ENV['COVERAGE'] = "true"
-  Rake::Task['test'].execute
-end
-
-require 'reek/rake/task'
-Reek::Rake::Task.new do |t|
-  t.fail_on_error = true
-  t.verbose = false
-  t.source_files = 'lib/**/*.rb'
-end
-
-require 'roodi'
-require 'roodi_task'
-RoodiTask.new do |t|
-  t.verbose = false
-end
-
-task :default => :test
-
-require 'yard'
-YARD::Rake::YardocTask.new

data/VERSION

@@ -1 +0,0 @@
-0.1.1

data/veracodecli.gemspec

@@ -1,78 +0,0 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
-# stub: veracodecli 0.1.1 ruby lib
-
-Gem::Specification.new do |s|
-  s.name = "veracodecli"
-  s.version = "0.1.1"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.require_paths = ["lib"]
-  s.authors = ["isaiah thiessen"]
-  s.date = "2015-09-22"
-  s.description = "Ruby based CLI for accessing veracode's api"
-  s.email = "isaiah.thiessen@telus.com"
-  s.executables = ["veracodecli"]
-  s.extra_rdoc_files = [
-    "LICENSE.txt",
-    "README.md"
-  ]
-  s.files = [
-    "bin/veracodecli",
-    "lib/veracodecli.rb",
-    "lib/veracodecli/api.rb"
-  ]
-  s.homepage = "http://github.com/isand3r/veracodecli"
-  s.licenses = ["MIT"]
-  s.rubygems_version = "2.4.6"
-  s.summary = "Ruby based CLI for accessing veracode's api"
-  s.test_files = ["test/API.rb", "test/helper.rb", "test/test_veracodecli.rb"]
-
-  if s.respond_to? :specification_version then
-    s.specification_version = 4
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<json>, [">= 0"])
-      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
-      s.add_runtime_dependency(%q<rest-client>, [">= 0"])
-      s.add_runtime_dependency(%q<commander>, [">= 0"])
-      s.add_development_dependency(%q<shoulda>, [">= 0"])
-      s.add_development_dependency(%q<yard>, ["~> 0.7"])
-      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
-      s.add_development_dependency(%q<simplecov>, [">= 0"])
-      s.add_development_dependency(%q<reek>, ["~> 1.2.8"])
-      s.add_development_dependency(%q<roodi>, ["~> 2.1.0"])
-    else
-      s.add_dependency(%q<json>, [">= 0"])
-      s.add_dependency(%q<activesupport>, [">= 0"])
-      s.add_dependency(%q<rest-client>, [">= 0"])
-      s.add_dependency(%q<commander>, [">= 0"])
-      s.add_dependency(%q<shoulda>, [">= 0"])
-      s.add_dependency(%q<yard>, ["~> 0.7"])
-      s.add_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_dependency(%q<bundler>, ["~> 1.0"])
-      s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
-      s.add_dependency(%q<simplecov>, [">= 0"])
-      s.add_dependency(%q<reek>, ["~> 1.2.8"])
-      s.add_dependency(%q<roodi>, ["~> 2.1.0"])
-    end
-  else
-    s.add_dependency(%q<json>, [">= 0"])
-    s.add_dependency(%q<activesupport>, [">= 0"])
-    s.add_dependency(%q<rest-client>, [">= 0"])
-    s.add_dependency(%q<commander>, [">= 0"])
-    s.add_dependency(%q<shoulda>, [">= 0"])
-    s.add_dependency(%q<yard>, ["~> 0.7"])
-    s.add_dependency(%q<rdoc>, ["~> 3.12"])
-    s.add_dependency(%q<bundler>, ["~> 1.0"])
-    s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
-    s.add_dependency(%q<simplecov>, [">= 0"])
-    s.add_dependency(%q<reek>, ["~> 1.2.8"])
-    s.add_dependency(%q<roodi>, ["~> 2.1.0"])
-  end
-end
-