wss_agent 0.0.15

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9ad1e711f699f18be6a05b2a369ee188ea659c28
+  data.tar.gz: 735adf1d078320d844bd1e07cdb8652dd085ac2d
+SHA512:
+  metadata.gz: cea5bba0c253e28e9d5f18ab3a833cfe4c353df179b843675a1308a8cb58e1b3deccaf8af95855a443ea1f2661e1ed04b2b3f6f94c62dc6f69d95b3d5d59033b
+  data.tar.gz: 36b32524a8e165d596f28ad8243b4a0e0abcf92a5119136084bbde350aef87ba8358ec1a160233a60502e7e3f2ffabbcf3d6e9ed831cc390ae633d33e6571622

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.2.0
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in wss_agent.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,73 @@
+**WhiteSource bundle plugin**
+
+    __          ___     _ _        _____                          _
+    \ \        / / |   (_) |      / ____|                        | |
+     \ \  /\  / /| |__  _| |_ ___| (___   ___  _   _ _ __ ___ ___| |
+      \ \/  \/ / | '_ \| | __/ _ \\___ \ / _ \| | | | '__/ __/ _ \ |
+       \  /\  /  | | | | | ||  __/____) | (_) | |_| | | | (_|  __/_|
+        \/  \/   |_| |_|_|\__\___|_____/ \___/ \__,_|_|  \___\___(_)
+
+
+
+
+
+
+More about the White Source service : [http://www.whitesourcesoftware.com/](http://www.whitesourcesoftware.com/)
+
+View documentation here: [http://docs.whitesourcesoftware.com/display/serviceDocs/Ruby+Plugin](http://docs.whitesourcesoftware.com/display/serviceDocs/Ruby+Plugin)
+
+
+## Getting Started:
+
+### 1) Install WhiteSource gem.
+```bash
+$ gem install wss_agent
+```
+
+
+### 2) Initial configuration
+```bash
+$ wss_agent config
+```
+
+add your token in 'wss_agent.yml' file in your project root directory
+
+### 3) Command list
+```bash
+Commands:
+  wss_agent check_policies  # checking dependencies that they conforms with company policy.
+  wss_agent config          # create config file
+  wss_agent help [COMMAND]  # Describe available commands or one specific command
+  wss_agent list            # display list dependencies
+  wss_agent update          # update open source inventory
+  wss_agent version         # Agent version
+```
+
+### 4) update open source inventory
+```bash
+$ wss_agent update
+```
+### 5) checking dependencies that they conforms with company policy.
+```bash
+$ wss_agent check_policies
+```
+
+## Debug
+
+
+### 1) show additional messages
+```bash
+$ wss_agent [command] -v
+```
+
+### 2) display http request
+
+#### linux
+```bash
+$ EXCON_DEBUG=true wss_agent [command]
+```
+
+#### windows
+```cmd
+$ SET EXCON_DEBUG=true &&  wss_agent [command]
+```

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rspec/core/rake_task'
+require "bundler/gem_tasks"
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format']
+end
+
+task :default => :spec

data/bin/wss_agent

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+
+begin
+  require 'bundler'
+rescue LoadError
+  abort("Bundler must be installed")
+end
+
+require 'wss_agent'
+
+WssAgent::CLI.start(ARGV)

data/lib/config/custom_default.yml

@@ -0,0 +1,5 @@
+---
+token: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
+product: ''
+product_version: ''
+

data/lib/config/default.yml

@@ -0,0 +1,11 @@
+---
+url: http://saas.whitesourcesoftware.com/agent
+token: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
+check_policies: false
+agent: bundler-plugin
+agent_version: '1.0'
+product: ''
+product_version: ''
+coordinates:
+  artifact_id: ''
+  version: ''

data/lib/wss_agent/cli.rb

@@ -0,0 +1,49 @@
+module WssAgent
+  class CLI < Thor
+    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
+
+    desc 'list', 'display list dependencies'
+    method_options all: :boolean
+    method_options excludes: :string
+    method_option :verbose, :aliases => "-v", :desc => "Be verbose"
+    def list
+      WssAgent.enable_debug! if options['verbose']
+      results = Specifications.list(options)
+      ap results
+    rescue Bundler::GemfileNotFound => ex
+      ap ex.message
+    rescue Bundler::GemNotFound => ex
+      ap ex.message
+      ap "Could you execute 'bundle install' before"
+    end
+
+    desc 'update', 'update open source inventory'
+    method_options all: :boolean
+    method_options excludes: :string
+    method_option :verbose, :aliases => "-v", :desc => "Be verbose"
+    def update
+      WssAgent.enable_debug! if options['verbose']
+      Specifications.update(options)
+    rescue => ex
+      ap ex.message
+    end
+
+    desc 'check_policies', 'checking dependencies that they conforms with company policy.'
+    method_option :verbose, :aliases => "-v", :desc => "Be verbose"
+    def check_policies
+      WssAgent.enable_debug! if options['verbose']
+      Specifications.check_policies(options)
+    end
+
+    desc 'version', 'Agent version'
+    def version
+      puts WssAgent::VERSION
+    end
+  end
+end

data/lib/wss_agent/client.rb

@@ -0,0 +1,59 @@
+module WssAgent
+  class Client
+
+    attr_accessor :connection
+    CHECK_POLICIES_TYPE = 'CHECK_POLICIES'
+    UPDATE_TYPE = 'UPDATE'
+    REQUEST_TIMEOUT = 120
+
+    def initialize
+      @connection ||= Faraday.new(Configure.url, { request: { timeout: REQUEST_TIMEOUT } }) do |h|
+        h.port = Configure.port
+        h.headers[:content_type] = 'application/x-www-form-urlencoded'
+        h.request :url_encoded
+        h.adapter :excon
+      end
+
+      @connection
+    end
+
+    def diff(gem_list)
+      diff_data = {
+        'coordinates' => Configure.coordinates,
+        'dependencies' => gem_list
+      }
+      if Configure['project_token']
+        diff_data['projectToken'] = Configure['project_token']
+      end
+      Oj.dump([diff_data])
+    end
+
+    def payload(gem_list, options = {})
+      {
+        agent: Configure['agent'],
+        agentVersion: Configure['agent_version'],
+        token: Configure.token,
+        product: Configure['product'].to_s,
+        productVersion: Configure['product_version'].to_s,
+        timeStamp: Time.now.to_i,
+        diff: diff(gem_list)
+      }.merge(options)
+    end
+
+    def update(gem_list)
+      ResponseInventory.new(request(gem_list, { type: UPDATE_TYPE }))
+    end
+
+    def check_policies(gem_list)
+      ResponsePolicies.new(request(gem_list, { type: CHECK_POLICIES_TYPE }))
+    end
+
+    def request(gem_list, options = {})
+      WssAgent.logger.debug "request params: #{payload(gem_list, options)}"
+
+      connection.post(WssAgent::Configure.api_path, payload(gem_list, options))
+    rescue Faraday::Error::ClientError => ex
+      ex
+    end
+  end
+end

data/lib/wss_agent/configure.rb

@@ -0,0 +1,90 @@
+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'
+
+    extend SingleForwardable
+    def_delegator :current, :[]
+
+    class << self
+
+      def default_path
+        File.join(File.expand_path('../..', __FILE__), 'config', DEFAULT_CONFIG_FILE)
+      end
+
+      def custom_default_path
+        File.join(File.expand_path('../..', __FILE__), 'config', CUSTOM_DEFAULT_CONFIG_FILE)
+      end
+
+      def exist_default_config?
+        File.exist?(default_path)
+      end
+
+      def default
+        exist_default_config? ? YAML.load(File.read(default_path)) : {}
+      end
+
+      def current_path
+        Bundler.root.join(CURRENT_CONFIG_FILE).to_s
+      end
+
+      def current
+        if defined?(Bundler) && File.exist?(current_path)
+          default.merge(YAML.load(File.read(current_path)))
+        else
+          default
+        end
+      end
+
+      def uri
+        @url = current['url']
+        if @url.nil? || @url == ''
+          raise ApiUrlNotFound, "Can't find the url, please add your Whitesource url destination in the wss_agent.yml file."
+        end
+        URI(@url)
+      end
+
+      def port
+        uri.port || 80
+      end
+
+      def url
+        @uri = uri
+        [@uri.scheme, @uri.host].join('://')
+      end
+
+      def api_path
+        @uri = uri
+        @url_path = @uri.path
+        @url_path == "" ? API_PATH : @url_path
+      end
+
+      def token
+        if current['token'].nil? || (current['token'] == '') || (current['token'] == default['token'])
+          raise TokenNotFound, "Can't find Token, please add your Whitesource API token in the wss_agent.yml file"
+        else
+          current['token']
+        end
+      end
+
+      def coordinates
+        project_meta = WssAgent::Project.new
+        coordinates_config = current['coordinates']
+        coordinates_artifact_id = coordinates_config['artifact_id']
+        coordinates_version = coordinates_config['version']
+
+        if coordinates_artifact_id.nil? || coordinates_artifact_id == ''
+          coordinates_artifact_id = project_meta.project_name
+          coordinates_version = project_meta.project_version
+        end
+        {
+          'artifactId' => coordinates_artifact_id,
+          'version' => coordinates_version
+        }
+      end
+    end
+  end
+end

data/lib/wss_agent/gem_sha1.rb

@@ -0,0 +1,76 @@
+require "digest"
+
+module WssAgent
+  class GemSha1
+    attr_reader :spec
+
+    def initialize(spec)
+      @spec = spec
+      check_version! unless @spec.version > Gem::Version.new('0')
+    end
+
+    # check version
+    # if version isn't found get latest version
+    #
+    def check_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/versions/#{spec.name}.json")
+      versions = Oj.load(response.body)
+      unless versions.detect { |j| j['number'] == spec.version }
+        spec.version = versions.first['number']
+      end
+    rescue
+
+    end
+
+    def sha1
+      case
+      when spec.source.is_a?(Bundler::Source::Rubygems)
+        path = spec.source.send(:cached_gem, spec).to_s
+        Digest::SHA1.hexdigest(File.binread(path))
+      when spec.source.is_a?(Bundler::Source::Git)
+      # ???
+      when spec.source.is_a?(Bundler::Source::Path)
+      # ????
+      when spec.source.nil?
+        remote_file
+      end
+
+    rescue => ex
+      WssAgent.logger.debug "#{ex.message}"
+      WssAgent.logger.debug "#{spec}"
+      remote_file
+    end
+
+    def remote_file_url
+      URI("http://rubygems.org/gems/#{spec.file_name}")
+    end
+
+    # download gem from rubygems
+    #
+    def remote_file(retry_request = false)
+      response = Net::HTTP.get_response(remote_file_url)
+
+      case response.code
+      when '200' # ok
+        Digest::SHA1.hexdigest(response.body)
+
+      when '302' # redirect
+        response = Net::HTTP.get_response(URI(response['location']))
+        if response.code == '200'
+          return Digest::SHA1.hexdigest(response.body)
+        end
+      else # gem isn't found
+        ''
+      end
+
+    rescue Timeout::Error
+      retry_request ? nil : remote_file(true)
+    end
+
+  end
+end

data/lib/wss_agent/project.rb

@@ -0,0 +1,45 @@
+module WssAgent
+  class Project
+
+    def project_name
+      case
+      when is_gem?
+        gem.name
+      when is_rails_app?
+        rails_app_name
+      else
+        folder_name
+      end
+    end
+
+    def project_version
+      case
+      when is_gem?
+        gem.version.to_s
+      else
+        '0.0.0'
+      end
+    end
+
+    def folder_name
+      Bundler.root.split.last.to_s
+    end
+
+    def is_gem?
+      !Dir.glob(Bundler.root.join('*.gemspec')).last.nil?
+    end
+
+    def gem
+      @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?
+    end
+
+    def rails_app_name
+      application_file = File.read(Dir.glob(Bundler.root.join('config', 'application.rb')).last)
+      application_file.match(/module (\w*)/) && $1
+    end
+  end
+end