ecs_bundler 1.0.0

data/lib/ecs_bundler/scan.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module ECSBundler
+  # Scan model
+  class Scan
+    API_PATH = '/api/v1'.freeze
+    CREATE_PATH = '/scans'.freeze
+    attr_accessor :id, :data
+    attr_reader :message
+
+    def initialize(data)
+      @data = data
+    end
+
+    def save
+      create unless id
+      self
+    end
+
+    private
+
+    def create
+      ECSBundler.rest_client.post("#{API_PATH}#{CREATE_PATH}", data){ |_, response, message| @id, @message = response['scanId'], message }
+    end
+
+    class << self
+      def create(data)
+        Scan.new(data).save
+      end
+    end
+  end
+end

data/lib/ecs_bundler/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module ECSBundler
+  # Contains version string
+  VERSION = File.exist?('VERSION') ? File.read('VERSION') : ''
+end

data/lib/ecs_bundler.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module ECSBundler
+  autoload :BundlerScanner, 'ecs_bundler/bundler_scanner'
+  autoload :Config, 'ecs_bundler/config'
+  autoload :ProjectSpecification, 'ecs_bundler/project_specification'
+  autoload :RestClient, 'ecs_bundler/rest_client'
+  autoload :Scan, 'ecs_bundler/scan'
+  autoload :VERSION, 'ecs_bundler/version'
+  class BundlerScanner
+    autoload :RepositoryFinder, 'ecs_bundler/bundler_scanner/repository_finder'
+  end
+
+  class << self
+    # Return config class
+    def config
+      @@config ||= Config.new
+    end
+
+    # Return rest-client class
+    def rest_client(options = {})
+      @@rest_client ||= RestClient.new(options)
+    end
+
+    # Run cli application
+    def run_cli
+      require 'cli'
+      settings = ::CLI.new do
+        version(ECSBundler::VERSION)
+        option :apiKey, short: :k, description: 'api key'
+        option :userName,	short: :u, description: 'user name'
+        option :url, description: 'Base url'
+        option :project, short: :p, description: 'Project name'
+        option :config, short: :c, description: 'Config path'
+      end.parse!
+      run(settings.to_h.compact)
+    end
+
+    # Run application
+    def run(options = {})
+      config.load(options[:config] ? options[:config] : nil)
+      options = config.data.merge(options)
+      validate_options!(options)
+      rest_client(options)
+      scan = Scan.create(BundlerScanner.run)
+      if scan.id
+        print "ecs-bundler successfully transferred scan to server: scanId => #{scan.id}\n"
+      else
+        print "ecs-bundler error transferring scan: #{scan.message}\n"
+      end
+    end
+
+    private
+
+    # validate options
+    def validate_options!(options)
+      if !options[:userName] || !options[:apiKey]
+        raise "Please provide a 'userName' and 'apiKey' property in credentials file('#{Config::FILE_NAME}')."
+      end
+      raise "Please provide a 'project' property in credentials file('#{Config::FILE_NAME}')." unless options[:project]
+    end
+  end
+end

data/spec/fixtures/.ecsrc.json

@@ -0,0 +1,5 @@
+{
+  "project": "project",
+  "userName": "userName",
+  "apiKey": "apiKey"
+}

data/spec/fixtures/config.json

@@ -0,0 +1,5 @@
+{
+  "project": "project",
+  "userName": "userNameConf",
+  "apiKey": "apiKey"
+}

data/spec/lib/ecs_bundler/bundler_scanner/repository_finder_spec.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe ECSBundler::BundlerScanner::RepositoryFinder do
+  let(:url) { 'https://github.com/eacg-gmbh/ecs-bundler' }
+  let(:repository_finder) { ECSBundler::BundlerScanner::RepositoryFinder }
+
+  describe '.url' do
+    it { expect(repository_finder.url(OpenStruct.new(name: 'actioncable'))).to eq 'https://github.com/rails/rails' }
+    it { expect(repository_finder.url(OpenStruct.new(name: 'test', homepage: url))).to eq url }
+    it { expect(repository_finder.url(OpenStruct.new(name: 'test', homepage: '', description: "description with url #{url} ."))).to eq url }
+    it { expect(repository_finder.url(OpenStruct.new(name: 'test', homepage: '', description: ''))).to be_nil }
+  end
+end

data/spec/lib/ecs_bundler/bundler_scanner_spec.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe ECSBundler::BundlerScanner do
+  let(:project_specification) { ECSBundler::ProjectSpecification.new }
+  let(:scanner) { ECSBundler::BundlerScanner }
+
+  describe '.run' do
+    it 'return correct result' do
+      expect_any_instance_of(ECSBundler::ProjectSpecification).to receive(:runtime_dependencies).and_return([])
+      allow(ECSBundler.config).to receive(:[]).with(:project).and_return('Test')
+      result = scanner.run
+      expect(result).to include(project: 'Test', module: 'Test', moduleId: 'bundler:Test')
+      expect(result).to have_key(:dependencies)
+    end
+  end
+
+  describe '.specification_to_h' do
+    it do
+      expect(project_specification).to receive(:runtime_dependencies).and_return([])
+      allow(ECSBundler.config).to receive(:[]).with(:project).and_return('actioncable')
+      result = scanner.send(:specification_to_h, project_specification)
+      expect(result).to include(
+        name: 'actioncable',
+        key: 'bundler:actioncable',
+        description: nil,
+        private: true,
+        licenses: [],
+        homepageUrl: nil,
+        repoUrl: 'https://github.com/rails/rails',
+        versions: [ECSBundler::VERSION],
+        dependencies: []
+      )
+    end
+
+    it 'call specification_to_h to dependency spec' do
+      allow_any_instance_of(ECSBundler::ProjectSpecification).to receive(:runtime_dependencies).and_return([])
+      expect(project_specification).to receive(:runtime_dependencies).and_return([OpenStruct.new(to_spec: ECSBundler::ProjectSpecification.new)])
+      allow(ECSBundler.config).to receive(:[]).with(:project).and_return('actioncable')
+      expect(scanner.send(:specification_to_h, project_specification)[:dependencies].count).to eq(1)
+    end
+  end
+end

data/spec/lib/ecs_bundler/config_spec.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe ECSBundler::Config do
+  let(:config) { ECSBundler::Config.new }
+
+  describe '#new' do
+    it { expect(config.data).to be_an_instance_of(Hash) }
+    %i[url project apiKey userName userAgent].each do |key|
+      it { expect(config.data).to have_key(key) }
+    end
+  end
+
+  describe '#load' do
+    it do
+      config.load(RSpec.root.join('fixtures'))
+      expect(config[:userName]).to eq('userName')
+    end
+
+    it do
+      config.load(RSpec.root.join('fixtures/config.json'))
+      expect(config[:userName]).to eq('userNameConf')
+    end
+  end
+
+  describe '#[]' do
+    it { expect(config[:userAgent]).to match(ECSBundler.name) }
+    it { expect(config[:userAgent]).to eq(config.data[:userAgent]) }
+  end
+
+  describe '#get_default_options' do
+    it { expect(config.send(:get_default_options)).to be_an_instance_of(Hash) }
+    it { expect(config.send(:get_default_options)).to eq(config.data) }
+  end
+end

data/spec/lib/ecs_bundler/project_specification_spec.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe ECSBundler::ProjectSpecification do
+  let(:project_specification) { ECSBundler::ProjectSpecification.new }
+
+  describe '#name' do
+    it 'eq rails application name' do
+      without_partial_double_verification do
+        rails = double
+        stub_const 'Rails', rails
+        expect(rails).to receive(:application).and_return(ECSBundler::ProjectSpecification.new)
+        expect(ECSBundler::ProjectSpecification).to receive(:parent).and_return(ECSBundler)
+        expect(project_specification.name).to eq(ECSBundler.name)
+      end
+    end
+
+    it do
+      expect(ECSBundler.config).to receive(:[]).with(:project).and_return('Test *&^project')
+      expect(project_specification.name).to eq('Test-project')
+    end
+  end
+
+  %i[description license homepage].each do |key|
+    describe "##{key}" do
+      it { expect(project_specification.send(key)).to be_nil }
+    end
+  end
+
+  describe '#version' do
+    it { expect(project_specification.version).to eq(ECSBundler::VERSION) }
+  end
+
+  describe '#runtime_dependencies' do
+    it do
+      bundler = double
+      expect(Bundler).to receive(:load).and_return(bundler)
+      expect(bundler).to receive(:current_dependencies).and_return('result')
+      expect(project_specification.runtime_dependencies).to eq('result')
+    end
+  end
+end

data/spec/lib/ecs_bundler/rest_client_spec.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe ECSBundler::Scan do
+  let(:options) { { userAgent: 'userAgent', apiKey: 'apiKey', userName: 'userName', url: 'url' } }
+  let(:rest_client) { ECSBundler::RestClient.new(options) }
+
+  describe '#new' do
+    it { expect(rest_client.options).to eq(options) }
+  end
+
+  describe '#headers' do
+    it { expect(rest_client.headers).to be_an_instance_of(Hash) }
+    it { expect(rest_client.headers).to include(content_type: :json, accept: :json, 'User-Agent' => 'userAgent', 'X-ApiKey' => 'apiKey', 'X-User' => 'userName') }
+  end
+
+  describe '#respond_to_missing?' do
+    it { expect(rest_client.respond_to?(:get)).to be_truthy }
+    it { expect(rest_client.respond_to?(:post)).to be_truthy }
+    it { expect(rest_client.respond_to?(:poster)).to be_falsey }
+  end
+
+  describe '#method_missing' do
+    it do
+      expect(::RestClient::Request).to receive(:execute).with(method: :get, url: 'url/get', payload: nil, headers: rest_client.headers)
+      rest_client.get('/get')
+    end
+
+    it do
+      data = { test: 1 }
+      expect(::RestClient::Request).to receive(:execute).with(method: :post, url: 'url/post', payload: data.to_json, headers: rest_client.headers)
+      rest_client.post('/post', data)
+    end
+
+    it { expect { rest_client.check('/post') }.to raise_error(NoMethodError) }
+
+    it do
+      body = { 'info' => 'info message', 'messages' => [{ 'message' => 'message#1' }] }
+      response = double
+      allow(response).to receive(:code).and_return(400)
+      expect(response).to receive(:body).and_return(body.to_json)
+      expect(::RestClient::Request).to receive(:execute).and_yield(response)
+      rest_client.post('/post', {}) do |result_response, parsed_response, message|
+        expect(result_response).to eq response
+        expect(parsed_response).to eq body
+        expect(message).to eq '400 Bad Request, info message, message#1'
+      end
+    end
+  end
+end

data/spec/lib/ecs_bundler/scan_spec.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe ECSBundler::Scan do
+  let(:data) { { name: 'test name' } }
+  let(:scan) { ECSBundler::Scan.new(data) }
+
+  describe '#new' do
+    it { expect(scan.data).to eq(data) }
+  end
+
+  describe '#save' do
+    after { scan.save }
+
+    it { expect(scan).to receive(:create) }
+    it do
+      scan.id = 1
+      expect(scan).to_not receive(:create)
+    end
+  end
+
+  describe '#create' do
+    it 'call rest-client post' do
+      without_partial_double_verification do
+        expect(ECSBundler.rest_client).to receive(:post).with("#{ECSBundler::Scan::API_PATH}#{ECSBundler::Scan::CREATE_PATH}", data)
+        scan.send(:create)
+      end
+    end
+  end
+
+  describe '.create' do
+    it 'create instance and call save method' do
+      expect_any_instance_of(ECSBundler::Scan).to receive(:save)
+      ECSBundler::Scan.create(data)
+    end
+  end
+end

data/spec/lib/ecs_bundler_spec.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'cli'
+
+RSpec.describe ECSBundler do
+  describe '.config' do
+    it { expect(ECSBundler.config).to be_an_instance_of(ECSBundler::Config) }
+  end
+
+  describe '.rest_client' do
+    it { expect(ECSBundler.rest_client).to be_an_instance_of(ECSBundler::RestClient) }
+  end
+
+  describe '.run_cli' do
+    it 'call run with no options' do
+      expect_any_instance_of(::CLI).to receive(:parse!).and_return(userName: nil)
+      expect(ECSBundler).to receive(:run).with({})
+      ECSBundler.run_cli
+    end
+
+    it 'call run with options' do
+      expect_any_instance_of(::CLI).to receive(:parse!).and_return(userName: 'userName')
+      expect(ECSBundler).to receive(:run).with(userName: 'userName')
+      ECSBundler.run_cli
+    end
+  end
+
+  describe '.run' do
+    it do
+      expect(ECSBundler::BundlerScanner).to receive(:run).and_return({})
+      expect(ECSBundler::Scan).to receive(:create).and_return(OpenStruct.new(id: 1))
+      expect(ECSBundler).to receive(:print).with(/successfully.*scanId => 1/)
+      ECSBundler.run(config: RSpec.root.join('fixtures'))
+    end
+
+    it do
+      expect(ECSBundler::BundlerScanner).to receive(:run).and_return({})
+      expect(ECSBundler::Scan).to receive(:create).and_return(OpenStruct.new(id: nil, message: 'MESSAGE'))
+      expect(ECSBundler).to receive(:print).with(/error.*scan: MESSAGE/)
+      ECSBundler.run(config: RSpec.root.join('fixtures'))
+    end
+  end
+
+  describe '.validate_options!' do
+    it { expect { ECSBundler.send(:validate_options!, {}) }.to raise_error RuntimeError, /Please provide a 'userName' and 'apiKey'/ }
+    it { expect { ECSBundler.send(:validate_options!, userName: 'userName', apiKey: 'apiKey') }.to raise_error RuntimeError, /Please provide a 'project' property/ }
+    it { expect { ECSBundler.send(:validate_options!, userName: 'userName', apiKey: 'apiKey', project: 'project') }.to_not raise_error }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'simplecov'
+
+module ::RSpec
+  module_function
+
+  def root
+    @spec_root ||= Pathname.new(__dir__)
+  end
+end
+
+SimpleCov.start do
+  load_profile 'test_frameworks'
+
+  at_exit do
+    SimpleCov.result.format!
+    puts "Click to open report file://#{RSpec.root.join('../').realpath}/coverage/index.html#_AllFiles"
+  end
+end
+
+require 'bundler/setup'
+require 'ecs_bundler'
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = '.rspec_status'
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+end

metadata

@@ -0,0 +1,218 @@
+--- !ruby/object:Gem::Specification
+name: ecs_bundler
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Anatolii Varanytsia
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: cli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.5
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Module for Bundler allowing the transfer of package dependencies to ECS
+  for further legal and vulnerability analysis. See https://ecs.eacg.de for a detailed
+  service description.
+email: prizrack13@mail.ru
+executables:
+- ecs_bundler
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- ".document"
+- ".ecsrc.json"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- bin/ecs_bundler
+- ecs_bundler.gemspec
+- lib/ecs_bundler.rb
+- lib/ecs_bundler/bundler_scanner.rb
+- lib/ecs_bundler/bundler_scanner/repository_finder.rb
+- lib/ecs_bundler/config.rb
+- lib/ecs_bundler/project_specification.rb
+- lib/ecs_bundler/rest_client.rb
+- lib/ecs_bundler/scan.rb
+- lib/ecs_bundler/version.rb
+- spec/fixtures/.ecsrc.json
+- spec/fixtures/config.json
+- spec/lib/ecs_bundler/bundler_scanner/repository_finder_spec.rb
+- spec/lib/ecs_bundler/bundler_scanner_spec.rb
+- spec/lib/ecs_bundler/config_spec.rb
+- spec/lib/ecs_bundler/project_specification_spec.rb
+- spec/lib/ecs_bundler/rest_client_spec.rb
+- spec/lib/ecs_bundler/scan_spec.rb
+- spec/lib/ecs_bundler_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/eacg-gmbh/ecs-bundler
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.9
+signing_key: 
+specification_version: 4
+summary: Module for Bundler allowing the transfer of package dependencies to ECS
+test_files: []