wss_agent 0.0.17 → 0.0.21

data/lib/wss_agent.rb

@@ -2,7 +2,7 @@ require 'thor'
 require 'net/http'
 require 'awesome_print'
 require 'yaml'
-require 'oj'
+require 'multi_json'
 require 'faraday'
 require 'faraday_middleware'
 require 'yell'
@@ -17,9 +17,8 @@ require 'wss_agent/client'
 require 'wss_agent/gem_sha1'
 require 'wss_agent/project'
 
-
 module WssAgent
-  # Your code goes here...
+  DEFAULT_CA_BUNDLE_PATH = File.dirname(__FILE__) + '/data/ca-certificates.crt'
 
   class WssAgentError < StandardError
     def self.status_code(code)
@@ -27,11 +26,11 @@ module WssAgent
     end
   end
 
-  class NotFoundConfigFile  < WssAgentError; status_code(8) ; end
-  class InvalidConfigFile   < WssAgentError; status_code(9) ; end
-  class TokenNotFound       < WssAgentError; status_code(10) ; end
-  class ApiUrlNotFound      < WssAgentError; status_code(11) ; end
-  class ApiUrlInvalid       < WssAgentError; status_code(12) ; end
+  class NotFoundConfigFile  < WssAgentError; status_code(8); end
+  class InvalidConfigFile   < WssAgentError; status_code(9); end
+  class TokenNotFound       < WssAgentError; status_code(10); end
+  class ApiUrlNotFound      < WssAgentError; status_code(11); end
+  class ApiUrlInvalid       < WssAgentError; status_code(12); end
 
   def self.logger
     @logger ||= Yell.new STDOUT, level: [:info]

data/lib/wss_agent/cli.rb

@@ -1,17 +1,18 @@
 module WssAgent
   class CLI < Thor
-    desc "config", "create config file"
+    desc 'config', 'create config file'
     def config
       File.open(File.join(Dir.pwd, Configure::CURRENT_CONFIG_FILE), 'w') do |f|
         f << File.read(Configure.custom_default_path)
       end
       ap 'Created the config file: wss_agent.yml'
     end
+    map init: :config
 
     desc 'list', 'display list dependencies'
-    method_options all: :boolean
-    method_options excludes: :string
-    method_option :verbose, :aliases => "-v", :desc => "Be verbose"
+    method_option :all, type: :boolean
+    method_option :excludes, type: :string
+    method_option :verbose, aliases: '-v', desc: 'Be verbose'
     def list
       WssAgent.enable_debug! if options['verbose']
       results = Specifications.list(options)
@@ -24,9 +25,10 @@ module WssAgent
     end
 
     desc 'update', 'update open source inventory'
-    method_options all: :boolean
-    method_options excludes: :string
-    method_option :verbose, :aliases => "-v", :desc => "Be verbose"
+    method_option :all, type: :boolean
+    method_option :excludes, type: :string
+    method_option :verbose, aliases: '-v', desc: 'Be verbose'
+    method_option :force, type: :boolean, aliases: '-f', desc: 'Force Check All Dependencies'
     def update
       WssAgent.enable_debug! if options['verbose']
       Specifications.update(options)
@@ -35,7 +37,8 @@ module WssAgent
     end
 
     desc 'check_policies', 'checking dependencies that they conforms with company policy.'
-    method_option :verbose, :aliases => "-v", :desc => "Be verbose"
+    method_option :verbose, aliases: '-v', desc: 'Be verbose'
+    method_option :force, type: :boolean, aliases: '-f', desc: 'Force Check All Dependencies'
     def check_policies
       WssAgent.enable_debug! if options['verbose']
       Specifications.check_policies(options)

data/lib/wss_agent/client.rb

@@ -1,13 +1,16 @@
 module WssAgent
   class Client
-
     attr_accessor :connection
-    CHECK_POLICIES_TYPE = 'CHECK_POLICIES'
-    UPDATE_TYPE = 'UPDATE'
+    POLICY_TYPES = {
+      basic: 'CHECK_POLICIES',
+      compliance: 'CHECK_POLICY_COMPLIANCE'
+    }.freeze
+
+    UPDATE_TYPE = 'UPDATE'.freeze
     REQUEST_TIMEOUT = 120
 
     def initialize
-      @connection ||= Faraday.new(Configure.url, { request: { timeout: REQUEST_TIMEOUT } }) do |h|
+      @connection ||= Faraday.new(connection_options) do |h|
         h.port = Configure.port
         h.headers[:content_type] = 'application/x-www-form-urlencoded'
         h.request :url_encoded
@@ -25,7 +28,7 @@ module WssAgent
       if Configure['project_token']
         diff_data['projectToken'] = Configure['project_token']
       end
-      Oj.dump([diff_data])
+      MultiJson.dump([diff_data])
     end
 
     def payload(gem_list, options = {})
@@ -41,11 +44,18 @@ module WssAgent
     end
 
     def update(gem_list)
-      ResponseInventory.new(request(gem_list, { type: UPDATE_TYPE }))
+      ResponseInventory.new(request(gem_list, type: UPDATE_TYPE))
     end
 
-    def check_policies(gem_list)
-      ResponsePolicies.new(request(gem_list, { type: CHECK_POLICIES_TYPE }))
+    def check_policies(gem_list, options = {})
+      request_options =
+        if WssAgent::Configure['force_check_all_dependencies'] || options['force']
+          { type: POLICY_TYPES[:compliance], forceCheckAllDependencies: true }
+        else
+          { type: POLICY_TYPES[:basic], forceCheckAllDependencies: false }
+        end
+
+      ResponsePolicies.new(request(gem_list, request_options))
     end
 
     def request(gem_list, options = {})
@@ -55,5 +65,24 @@ module WssAgent
     rescue Faraday::Error::ClientError => ex
       ex
     end
+
+    private
+
+    def connection_options
+      @connection_options ||
+        begin
+
+          @connection_options = {
+            url: Configure.url,
+            request: { timeout: REQUEST_TIMEOUT }
+          }
+          if Configure.ssl?
+            @connection_options[:ssl] = {
+              ca_file: WssAgent::DEFAULT_CA_BUNDLE_PATH
+            }
+          end
+        end
+      @connection_options
+    end
   end
 end

data/lib/wss_agent/configure.rb

@@ -1,16 +1,14 @@
 module WssAgent
   class Configure
-
-    DEFAULT_CONFIG_FILE = 'default.yml'
-    CUSTOM_DEFAULT_CONFIG_FILE = 'custom_default.yml'
-    CURRENT_CONFIG_FILE = 'wss_agent.yml'
-    API_PATH = '/agent'
+    DEFAULT_CONFIG_FILE = 'default.yml'.freeze
+    CUSTOM_DEFAULT_CONFIG_FILE = 'custom_default.yml'.freeze
+    CURRENT_CONFIG_FILE = 'wss_agent.yml'.freeze
+    API_PATH = '/agent'.freeze
 
     extend SingleForwardable
     def_delegator :current, :[]
 
     class << self
-
       def default_path
         File.join(File.expand_path('../..', __FILE__), 'config', DEFAULT_CONFIG_FILE)
       end
@@ -38,8 +36,8 @@ module WssAgent
 
         @current_config = YAML.load(File.read(current_path))
 
-       unless !!@current_config
-          return raise InvalidConfigFile, "Problem reading wss_agent.yml, please check the file is a valid YAML"
+        unless !!@current_config
+          return raise InvalidConfigFile, 'Problem reading wss_agent.yml, please check the file is a valid YAML'
         end
 
         default.merge(@current_config)
@@ -53,7 +51,7 @@ module WssAgent
         URI(@url)
 
       rescue URI::Error
-        raise ApiUrlInvalid, "Api url is invalid. Could you please check url in wss_agent.yml"
+        raise ApiUrlInvalid, 'Api url is invalid. Could you please check url in wss_agent.yml'
       end
 
       def port
@@ -65,10 +63,14 @@ module WssAgent
         [@uri.scheme, @uri.host].join('://')
       end
 
+      def ssl?
+        uri.scheme == 'https'
+      end
+
       def api_path
         @uri = uri
         @url_path = @uri.path
-        @url_path == "" ? API_PATH : @url_path
+        @url_path == '' ? API_PATH : @url_path
       end
 
       def token

data/lib/wss_agent/gem_sha1.rb

@@ -1,4 +1,4 @@
-require "digest"
+require 'digest'
 
 module WssAgent
   class GemSha1
@@ -19,7 +19,7 @@ module WssAgent
         h.adapter :excon
       end
       response = conn.get("/api/v1/versions/#{spec.name}.json")
-      versions = Oj.load(response.body)
+      versions = MultiJson.load(response.body)
       unless versions.detect { |j| j['number'] == spec.version }
         spec.version = versions.first['number']
       end
@@ -61,9 +61,7 @@ module WssAgent
 
       when '302' # redirect
         response = Net::HTTP.get_response(URI(response['location']))
-        if response.code == '200'
-          return Digest::SHA1.hexdigest(response.body)
-        end
+        return Digest::SHA1.hexdigest(response.body) if response.code == '200'
       else # gem isn't found
         ''
       end
@@ -71,6 +69,5 @@ module WssAgent
     rescue Timeout::Error
       retry_request ? nil : remote_file(true)
     end
-
   end
 end

data/lib/wss_agent/project.rb

@@ -2,43 +2,39 @@ module WssAgent
   class Project
 
     def project_name
-      case
-      when is_gem?
-        gem.name
-      when is_rails_app?
-        rails_app_name
-      else
-        folder_name
-      end
+      return gem.name if gem?
+      return rails_app_name if rails?
+      folder_name
     end
 
     def project_version
-      if is_gem?
-        gem.version.to_s
-      else
-        ''
-      end
+      gem? ? gem.version.to_s : ''
     end
 
     def folder_name
       Bundler.root.split.last.to_s
     end
 
-    def is_gem?
+    def gem?
       !Dir.glob(Bundler.root.join('*.gemspec')).last.nil?
     end
 
     def gem
-      @gem ||= Gem::Specification.load(Dir.glob(Bundler.root.join('*.gemspec')).last)
+      @gem ||= Gem::Specification.load(
+        Dir.glob(Bundler.root.join('*.gemspec')).last
+      )
     end
 
-    def is_rails_app?
-      !Dir.glob(Bundler.root.join('config', 'application.rb')).last.nil?
+    def rails?
+      File.exist?(rails_app_path)
     end
 
     def rails_app_name
-      application_file = File.read(Dir.glob(Bundler.root.join('config', 'application.rb')).last)
-      application_file.match(/module (\w*)/) && $1
+      File.read(rails_app_path).match(/module (\w*)/)[1]
+    end
+
+    def rails_app_path
+      Bundler.root.join('config', 'application.rb')
     end
   end
 end

data/lib/wss_agent/response.rb

@@ -23,7 +23,7 @@ module WssAgent
     def parse_response
       if response.success?
         begin
-          @response_data = Oj.load(response.body)
+          @response_data = MultiJson.load(response.body)
           @status = @response_data['status'].to_i
           @message = @response_data['message']
         rescue
@@ -49,9 +49,9 @@ module WssAgent
     end
 
     def data
-      @data ||= Oj.load(response_data['data'])
+      @data ||= MultiJson.load(response_data['data'])
     rescue
-      response_data && response_data.key?('data') ?  response_data['data'] : nil
+      response_data && response_data.key?('data') ? response_data['data'] : nil
     end
   end
 end

data/lib/wss_agent/response_inventory.rb

@@ -6,19 +6,20 @@ module WssAgent
         @message = "White Source update results: \n"
         @message << "  White Source organization: #{data['organization']} \n"
 
-        unless data['createdProjects'].empty?
+        if data['createdProjects'].empty?
+          @message << "  No new projects found \n"
+        else
           @message << "  #{data['createdProjects'].size} newly created projects: "
           @message << data['createdProjects'].join(' ')
-        else
-          @message << "  No new projects found \n"
         end
 
-        unless data['updatedProjects'].empty?
+        if data['updatedProjects'].empty?
+          @message << "\n  No projects were updated \n"
+        else
           @message << "  #{data['updatedProjects'].size}  existing projects were updated: "
           @message << data['updatedProjects'].join(' ')
-        else
-          @message << "\n  No projects were updated \n"
         end
+
         @message
       else
         super

data/lib/wss_agent/response_policies.rb

@@ -1,11 +1,11 @@
 module WssAgent
   class ResponsePolicies < Response
-    REJECT_ACTION = 'Reject'
+    REJECT_ACTION = 'Reject'.freeze
 
     def parse_response
       if response.success?
         begin
-          @response_data = Oj.load(response.body)
+          @response_data = MultiJson.load(response.body)
           @status = @response_data['status'].to_i
           @message = @response_data['message']
           check_new_projects
@@ -20,7 +20,6 @@ module WssAgent
       end
     end
 
-
     def message
       if success?
         if policy_violations?
@@ -33,7 +32,7 @@ module WssAgent
           }.join("\n")
           @message.join("\n")
         else
-          "All dependencies conform with open source policies"
+          'All dependencies conform with open source policies'
         end
       end
     end
@@ -64,8 +63,10 @@ module WssAgent
     def check(resource)
       if resource.key?('resource') && resource.key?('policy') &&
          (resource['policy']['actionType'] == REJECT_ACTION)
-        add_resource({'resource' => resource['resource'],
-                      'policy' => resource['policy']})
+        add_resource(
+          'resource' => resource['resource'],
+          'policy' => resource['policy']
+        )
       end
 
       if resource.key?('children') && resource['children'].is_a?(Array)

data/lib/wss_agent/specifications.rb

@@ -1,4 +1,4 @@
-require "digest"
+require 'digest'
 
 module WssAgent
   class Specifications
@@ -10,7 +10,11 @@ module WssAgent
       # @option options [Boolean] 'all' if true then get all dependencies (include development dependencies)
       # @option options [String] 'excludes' list gem name which need to exclude from end list
       def specs(options = {})
-        list_gems = Bundler::Definition.build(Bundler.default_gemfile, Bundler.default_lockfile, false).specs.to_a
+        list_gems = Bundler::Definition.build(
+          Bundler.default_gemfile,
+          Bundler.default_lockfile,
+          false
+        ).specs.to_a
         if options['all']
           # get all gems
           list = {}
@@ -31,26 +35,38 @@ module WssAgent
         new(specs(options)).call
       end
 
+      def check_policy?(options = {})
+        options['force'] ||
+          WssAgent::Configure['check_policies'] ||
+          WssAgent::Configure['force_check_all_dependencies']
+      end
+      private :check_policy?
+
       # Send gem list to server
       #
       # @param (see Specifications#specs)
       def update(options = {})
         wss_client = WssAgent::Client.new
-        if WssAgent::Configure['check_policies']
-          policy_results = wss_client.check_policies(WssAgent::Specifications.list(options))
+
+        if check_policy?(options)
+          policy_results = wss_client.check_policies(
+            WssAgent::Specifications.list(options),
+            options
+          )
           if policy_results.success? && policy_results.policy_violations?
             puts policy_results.message
             return false
           end
         end
 
+
         result = wss_client.update(WssAgent::Specifications.list(options))
         if result.success?
           WssAgent.logger.debug result.data
           puts result.message
         else
           WssAgent.logger.debug "synchronization errors occur: status: #{result.status}, message: #{result.message}, data: #{result.data}"
-          ap "error: #{result.status}/#{result.data}", color: {string: :red }
+          ap "error: #{result.status}/#{result.data}", color: { string: :red }
         end
 
         result.success?
@@ -61,13 +77,16 @@ module WssAgent
       # @param (see Specifications#specs)
       def check_policies(options = {})
         wss_client = WssAgent::Client.new
-        result = wss_client.check_policies(WssAgent::Specifications.list(options))
+        result = wss_client.check_policies(
+          WssAgent::Specifications.list(options),
+          options
+        )
         if result.success?
           WssAgent.logger.debug result.data
           puts result.message
         else
           WssAgent.logger.debug "check policies errors occur: #{result.status}, message: #{result.message}, data: #{result.data}"
-          ap "error: #{result.status}/#{result.data}", color: {string: :red }
+          ap "error: #{result.status}/#{result.data}", color: { string: :red }
         end
       end
 
@@ -84,6 +103,7 @@ module WssAgent
           if options['excludes'] && options['excludes'].to_s.split(',').include?(gd.name)
             next
           end
+
           gs = gd.matching_specs.first
           if gs
             unless list[gs.name]
@@ -94,8 +114,10 @@ module WssAgent
             end
           else
             unless list[gd.name]
-              list[gd.name] = Gem::Specification.new(gd.name,
-                                                     gd.requirements_list.last.scan(/[\d\.\w]+/).first)
+              list[gd.name] = Gem::Specification.new(
+                gd.name,
+                gd.requirements_list.last.scan(/[\d\.\w]+/).first
+              )
               rm_dep = remote_dependencies(gd.name, gd.requirements_list.last)
               unless rm_dep.empty?
                 list = gem_dependencies(list, rm_dep, options)
@@ -113,16 +135,20 @@ module WssAgent
       # @params version [String] version gem
       #
       # @return [Array<Gem::Dependency>] list gem dependencies
-      def remote_dependencies(gem_name, version)
+      def remote_dependencies(gem_name, _version)
         conn = Faraday.new(url: 'https://rubygems.org') do |h|
           h.headers[:content_type] = 'application/x-www-form-urlencoded'
           h.request :url_encoded
           h.adapter :excon
         end
         response = conn.get("/api/v1/gems/#{gem_name}.json")
-        dep_list = Oj.load(response.body)
-        dep_list['dependencies'].values.flatten.
-          map { |j| Gem::Dependency.new(j['name'], Gem::Requirement.new(j['requirements'].split(','))) }
+        dep_list = MultiJson.load(response.body)
+        dep_list['dependencies'].values.flatten.map do |j|
+          Gem::Dependency.new(
+            j['name'],
+            Gem::Requirement.new(j['requirements'].split(','))
+          )
+        end
       end
     end # end class << self
 
@@ -140,8 +166,8 @@ module WssAgent
     def gem_item(spec)
       {
         'groupId' => spec.name,
-			  'artifactId' => spec.file_name,
-			  'version' => spec.version.to_s,
+        'artifactId' => spec.file_name,
+        'version' => spec.version.to_s,
         'sha1' => GemSha1.new(spec).sha1,
         'optional' => false,
         'children' => [],