veracode-api 0.4.1

data/lib/veracode/api/summary.rb

@@ -0,0 +1,93 @@
+require 'veracode/api/types'
+require 'veracode/api/flaws'
+
+module Veracode
+  module Result
+    
+      class SummaryCategory < Veracode::Common::Base
+        api_field :categoryname, :tag => :categoryname
+        api_field :severity, :tag => :severity
+        api_field :count, :tag => :count
+      end
+
+      class SummarySeverity < Veracode::Common::Base
+        api_field :level, :tag => :level
+        
+        def categories
+          @categories ||= [] 
+          begin
+            if @categories.empty?
+              if @xml_hash.category.class == Array 
+                @categories = @xml_hash.category.map do |sev|
+                  SummaryCategory.new(sev)
+                end
+              else
+                @categories << SummaryCategory.new(@xml_hash.category) 
+              end
+            end
+          rescue NoMethodError
+          end
+
+          return @categories
+        end
+      end
+    
+    class SummaryReport < Veracode::Common::Base
+      api_field :report_format_version, :tag => :report_format_version
+      api_field :app_name, :tag => :app_name
+      api_field :app_id, :tag => :app_id
+      api_field :first_build_submitted_date, :tag => :first_build_submitted_date
+      api_field :version, :tag => :version
+      api_field :build_id, :tag => :build_id
+      api_field :vendor, :tag => :vendor
+      api_field :submitter, :tag => :submitter
+      api_field :platform, :tag => :platform
+      api_field :assurance_level, :tag => :assurance_level
+      api_field :business_criticality, :tag => :business_criticality
+      api_field :generation_date, :tag => :generation_date
+      api_field :veracode_level, :tag => :veracode_level
+      api_field :total_flaws, :tag => :total_flaws
+      api_field :flaws_not_mitigated, :tag => :flaws_not_mitigated
+      api_field :teams, :tag => :teams
+      api_field :life_cycle_stage, :tag => :life_cycle_stage
+      api_field :planned_deployment_date, :tag => :planned_deployment_date
+      api_field :last_update_time, :tag => :last_update_time
+      api_field :policy_name, :tag => :policy_name
+      api_field :policy_version, :tag => :policy_version
+      api_field :policy_compliance_status, :tag => :policy_compliance_status
+      api_field :policy_rules_status, :tag => :policy_rules_status
+      api_field :scan_overdue, :tag => :scan_overdue
+      api_field :any_type_scan_due, :tag => :any_type_scan_due
+      api_field :business_owner, :tag => :business_owner
+      api_field :business_unit, :tag => :business_unit
+      api_field :tags, :tag => :tags
+      
+      api_type_field :static_analysis, :tag => :static_analysis, :as => Analysis
+      api_type_field :dynamic_analysis, :tag => :dynamic_analysis, :as => Analysis
+      api_type_field :manual_analysis, :tag => :manual_analysis, :as => ManualAnalysis
+      api_type_field :flaw_status, :tag => :flaw_status, :as => FlawStatus
+      
+      def is_latest_build?
+        @is_latest_build ||= @xml_hash.is_latest_build.to_bool
+      end
+      
+      def grace_period_expired?
+        @grace_period_expired ||= @xml_hash.grace_period_expired.to_bool
+      end
+      
+      def severity
+        @severity ||= []
+        if @severity.empty?
+          if @xml_hash.severity.class == Array
+            @severity = @xml_hash.severity.map do |sev|
+              SummarySeverity.new(sev)
+            end
+          else
+            @severity << SummarySeverity.new(@xml_hash.severity)
+          end
+        end
+        return @severity
+      end
+    end
+  end
+end

data/lib/veracode/api/types.rb

@@ -0,0 +1,205 @@
+
+require 'base64'
+
+# Veracode API General Types used by Summary and Detailed results as well as Application Build API 
+#
+module Veracode
+  module Common
+    # Base Class for result
+    class Base
+      
+      def self.api_field(name, args)  
+        send(:define_method, name) do   
+          begin
+            return @xml_hash.send(args[:tag].to_sym)
+          rescue NoMethodError
+            return nil
+          end
+        end
+      end    
+      
+      def self.api_type_field(name, args)
+        send(:define_method, name) do
+          begin
+            tmp = eval("@" + name.to_s)  
+            tmp ||= args[:as].new(@xml_hash.send(args[:tag].to_sym))
+            instance_variable_set("@#{name}", tmp) 
+            return tmp
+          rescue NoMethodError
+            return nil
+          end
+        end   
+      end
+      # Takes Hash of XML stores, hash is has addition to allow dot access to components
+      def initialize(xml_hash)
+        @xml_hash = xml_hash
+      end 
+    end
+  end
+  
+  module Result 
+    class Screenshot < Veracode::Common::Base
+      api_field :format, :tag => :format            
+      
+      def data
+        @scr_data ||= Base64.decode64(@xml_hash.data)
+        
+        return @scr_data
+      end
+      #xml_reader(:data) {|b64data| Base64.decode64(b64data) }
+    end
+    
+    class BulletType < Veracode::Common::Base
+      api_field :text, :tag => :text
+    end
+    
+    class ParaType  < Veracode::Common::Base
+      #xml_reader :bulletitem, :as => [BulletType]
+      api_field :text, :tag => :text
+      
+      def bulletitem
+        @bulletitems ||= []
+        begin
+          if @bulletitems.empty?
+            if @xml_hash.bulletitem.class == Array
+              @bulletitems = @xml_hash.bulletitem.map do |item|
+                BulletType.new(item)
+              end
+            else
+              @bulletitems << BulletType.new(@xml_hash.bulletitem)
+            end
+          end
+        rescue NoMethodError
+        end
+        return @bulletitems
+      end
+    end
+    
+    class TextType < Veracode::Common::Base
+      #xml_reader :text, :from => "text/@text"
+    end
+    
+    class Para < Veracode::Common::Base
+      #xml_reader :para, :as => [ParaType] 
+      def para
+        @paras ||= []
+        if @paras.empty?
+          if @xml_hash.para.class == Array
+            @paras = @xml_hash.para.map do |para|
+              ParaType.new(para)
+            end
+          else
+            @paras << ParaType.new(@xml_hash.para)
+          end
+        end
+        return @paras
+      end
+    end
+    
+    class AppendixType < Veracode::Common::Base
+      api_field :description, :tag => :description
+      #xml_reader :screenshot, :as => [Screenshot]
+      def screenshot
+          @screenshots ||= []
+          begin
+            if @screenshots.empty?
+              if @xml_hash.screenshot.class == Array
+                @screenshots = @xml_hash.screenshot.map do |screenshot|
+                  Screenshot.new(screenshot)
+                end
+              else
+                @screenshots << Screenshot.new(@xml_hash.screenshot)
+              end
+            end
+          rescue NoMethodError
+          end
+          return @screenshots
+        end
+      api_field :code, :tag => :code
+    end
+    
+    class Module < Veracode::Common::Base
+      api_field :name, :tag => :name
+      api_field :compiler, :tag => :compiler
+      api_field :os, :tag => :os
+      api_field :architecture, :tag => :architecture
+      api_field :score, :tag => :score
+      api_field :numflawssev0, :tag => :numflawssev0
+      api_field :numflawssev1, :tag => :numflawssev1
+      api_field :numflawssev2, :tag => :numflawssev2 
+      api_field :numflawssev3, :tag => :numflawssev3 
+      api_field :numflawssev4, :tag => :numflawssev4 
+      api_field :numflawssev5, :tag => :numflawssev5
+    end
+    
+    class Analysis < Veracode::Common::Base
+
+      api_field :analysis_size_bytes, :tag => :analysis_size_bytes
+      api_field :rating, :tag => :rating
+      api_field :score, :tag => :score
+      api_field :mitigated_rating, :tag => :mitigated_rating
+      api_field :mitigated_score, :tag => :mitigated_score
+      api_field :submitted_date, :tag => :submitted_date
+      api_field :published_date, :tag => :published_date
+      api_field :next_scan_due, :tag => :next_scan_due
+      
+      def modules
+          @modules ||= []
+          if @modules.empty?
+            if @xml_hash.modules.class == Array
+              @modules = @xml_hash.modules.map do |modules|
+                Module.new(modules.module)
+              end
+            else
+              @modules << Module.new(@xml_hash.modules.module)
+            end
+          end
+          return @modules
+        end
+    end
+      
+    class ManualAnalysis < Veracode::Common::Base
+       api_field :rating, :tag => :rating
+       api_field :score, :tag => :score
+       api_field :mitigated_rating, :tag => :mitigated_rating
+       api_field :mitigated_score, :tag => :mitigated_score
+       api_field :submitted_date, :tag => :submitted_date
+       api_field :published_date, :tag => :published_date
+       api_field :next_scan_due, :tag => :next_scan_due
+       api_field :cia_adjustment, :tag => :cia_adjustment
+       api_field :delivery_consultant, :tag => :delivery_consultant
+       
+       def modules
+          @modules ||= []
+          if @modules.empty?
+            if @xml_hash.modules.class == Array
+              @modules = @xml_hash.modules.map do |modules|
+                Module.new(modules.module)
+              end
+            else
+              @modules << Module.new(@xml_hash.modules.module)
+            end
+          end
+          return @modules
+        end
+    end
+    
+    class FlawStatus < Veracode::Common::Base
+      api_field :new_flaws, :tag => :new
+      api_field :reopen_flaws, :tag => :reopen
+      #api_field :open_flaws, :tag => :open 
+      api_field :fixed_flaws, :tag => :fixed
+      api_field :total_flaws, :tag => :total
+      api_field :not_mitigated, :tag => :not_mitigated
+      api_field :sev_1_change, :tag => :sev_1_change 
+      api_field :sev_2_change, :tag => :sev_2_change 
+      api_field :sev_3_change, :tag => :sev_3_change
+      api_field :sev_4_change, :tag => :sev_4_change
+      api_field :sev_5_change, :tag => :sev_5_change 
+      
+      def open_flaws
+        return @xml_hash['open']
+      end
+    end
+  end
+end

data/lib/veracode/api/upload.rb

@@ -0,0 +1,155 @@
+require 'veracode/api/types'
+
+module Veracode
+  module Upload 
+    class AnalysisUnit < Veracode::Common::Base 
+      api_field :analysis_type, :tag => :analysis_type
+      api_field :status, :tag => :status
+      api_field :published_date, :tag => :published_date
+    end
+    
+    class Build < Veracode::Common::Base 
+      api_field :version, :tag => :version
+      api_field :build_id, :tag => :build_id
+      api_field :submitter, :tag => :submitter
+      api_field :platform, :tag => :platform
+      api_field :lifecycle_stage, :tag => :lifecycle_stage
+      api_field :policy_name, :tag => :policy_name
+      api_field :policy_version, :tag => :policy_version
+      api_field :policy_compliance_status, :tag => :policy_compliance_status
+      api_field :rules_status, :tag => :rules_status 
+      
+      def grace_period_expired?
+        @grace_period_expired ||= @xml_hash.grace_period_expired.to_bool
+      end
+      
+      def scan_overdue?
+        @scan_overdue ||= @xml_hash.scan_overdue.to_bool
+      end
+      
+      def results_ready?
+        @results_ready ||= @xml_hash.results_ready.to_bool
+      end
+              
+      def analysis_units
+        @analysis_units ||= []
+        if @analysis_units.empty?
+          if @xml_hash.analysis_unit.class == Array
+            @analysis_units = @xml_hash.analysis_unit.map do |analysis_unit|
+              AnalysisUnit.new(analysis_unit)
+            end
+          else
+            @analysis_units << AnalysisUnit.new(@xml_hash.analysis_unit)
+          end
+        end
+        return @analysis_units
+      end
+    end
+    
+    class BuildInfo < Veracode::Common::Base 
+      api_field :build_id, :tag => :build_id
+      api_field :app_id, :tag => :app_id
+      api_field :account_id, :tag => :account_id
+      
+      api_type_field :build, :tag => :build, :as => Build        
+    end
+    
+    class BuildList < Veracode::Common::Base
+      api_field :app_id, :tag => :app_id
+      api_field :account_id, :tag => :account_id
+      api_field :app_name, :tag => :app_name
+      
+      def build
+        @builds ||= []
+        begin  
+          if @builds.empty?      
+            if @xml_hash.build.class == Array
+              @builds = @xml_hash.build.map do |item|
+                Build.new(item)
+              end
+            else
+              @builds << Build.new(@xml_hash.build)
+            end
+          end
+        rescue NoMethodError
+        end
+        return @builds
+      end
+    end
+    
+    class Application < Veracode::Common::Base
+      api_field :app_id, :tag => :app_id
+      api_field :app_name, :tag => :app_name
+      api_field :vendor, :tag => :vendor
+      api_field :description, :tag => :description
+      api_field :business_criticality, :tag => :business_criticality
+      api_field :policy, :tag => :policy
+      api_field :teams, :tag => :teams
+      api_field :origin, :tag => :origin
+      api_field :industry_vertical, :tag => :industry_vertical
+      api_field :app_type, :tag => :app_type
+      api_field :deployment_method, :tag => :deployment_method
+      api_field :archer_app_name, :tag => :archer_app_name
+      api_field :modified_date, :tag => :modified_date
+      api_field :vendor_id, :tag => :vendor_id
+      api_field :business_unit, :tag => :business_unit
+      api_field :business_owner, :tag => :business_owner
+      api_field :business_owner_email, :tag => :business_owner_email
+      api_field :tags, :tag => :tags
+      
+      def is_web_application?
+        @is_web_application ||= @xml_hash.is_web_application.to_bool
+      end
+      
+      def cots?
+        @cots ||= @xml_hash.cots.to_bool
+      end 
+    end
+    
+    class ApplicationInfo < Veracode::Common::Base 
+      def application
+        @applications ||= []
+        begin  
+          if @applications.empty?      
+            if @xml_hash.application.class == Array
+              @applications = @xml_hash.application.map do |item|
+                Application.new(item)
+              end
+            else
+              @applications << Application.new(@xml_hash.application)
+            end
+          end
+        rescue NoMethodError
+        end
+        return @applications
+      end
+    end
+  
+    class App < Veracode::Common::Base
+      api_field :app_id, :tag => :app_id
+      api_field :app_name, :tag => :app_name
+      api_field :vendor_name, :tag => :vendor_name
+    end
+    
+    class AppList < Veracode::Common::Base
+      api_field :account_id, :tag => :account_id 
+      
+      def app
+        @applications ||= []
+        begin  
+          if @applications.empty?      
+            if @xml_hash.app.class == Array
+              @applications = @xml_hash.app.map do |item|
+                App.new(item)
+              end
+            else
+              @applications << App.new(@xml_hash.app)
+            end
+          end
+        rescue NoMethodError
+        end
+        return @applications
+      end
+    end
+  end
+end