license_scout 0.1.0

data/lib/license_scout/license_file_analyzer/text.rb

@@ -0,0 +1,46 @@
+# Copied from https://github.com/pivotal/LicenseFinder
+#
+# The MIT License
+#
+# Copyright (c) 2012 Pivotal Labs
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+module LicenseScout
+  module LicenseFileAnalyzer
+    module Text
+      SPACES = /[[:space:]]+/
+      QUOTES = /['`"]{1,2}/
+      PLACEHOLDERS = /<[^<>]+>/
+
+      def self.normalize_punctuation(text)
+        text.gsub(SPACES, " ")
+            .gsub(QUOTES, '"')
+            .strip
+      end
+
+      def self.compile_to_regex(text)
+        text = normalize_punctuation(text)
+        regex_source = Regexp.escape(text)
+        regex_source = regex_source.gsub(PLACEHOLDERS, "(.*)")
+        Regexp.new(regex_source, Regexp::IGNORECASE)
+      end
+    end
+  end
+end

data/lib/license_scout/license_file_analyzer.rb

@@ -0,0 +1,26 @@
+#
+# Copyright:: Copyright 2016, Chef Software Inc.
+# License:: Apache License, Version 2.0
+#
+# 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.
+#
+
+require "license_scout/license_file_analyzer/definitions"
+
+module LicenseScout
+  module LicenseFileAnalyzer
+    def self.find_by_text(text)
+      Definitions.all.detect { |l| l.matches_text? text }
+    end
+  end
+end

data/lib/license_scout/net_fetcher.rb

@@ -0,0 +1,104 @@
+#
+# Copyright:: Copyright 2016, Chef Software Inc.
+# License:: Apache License, Version 2.0
+#
+# 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.
+#
+
+require "open-uri"
+require "tmpdir"
+require "digest"
+
+require "license_scout/exceptions"
+
+module LicenseScout
+  class NetFetcher
+
+    def self.remote?(uri_or_path)
+      !URI(uri_or_path).scheme.nil?
+    end
+
+    def self.cache(uri)
+      fetcher = new(uri)
+      fetcher.fetch!
+      fetcher.cache_path
+    end
+
+    attr_reader :from_url
+
+    def initialize(from_url)
+      @from_url = from_url
+    end
+
+    def fetch!
+      download_file! unless exists_in_cache?
+    end
+
+    def cache_dir
+      File.join(Dir.tmpdir, "license_scout_cache")
+    end
+
+    def cache_path
+      File.join(cache_dir, url_cache_key, File.basename(from_url))
+    end
+
+    private
+
+    def exists_in_cache?
+      File.exist?(cache_path)
+    end
+
+    def url_cache_key
+      d = Digest::SHA256.new
+      d.update(from_url)
+      d.hexdigest
+    end
+
+    def save_to_cache(file)
+      cache_directory = File.dirname(cache_path)
+      FileUtils.mkdir_p(cache_directory) unless File.exist?(cache_directory)
+
+      File.open(cache_path, "w+") do |output_file|
+        output_file.print(file.read)
+      end
+    end
+
+    # This method is highly inspired from:
+    # https://github.com/chef/omnibus/blob/master/lib/omnibus/download_helpers.rb
+    def download_file!
+      retries = 3
+
+      begin
+        options = {
+          :read_timeout => 60,
+        }
+
+        open(from_url, options) do |f|
+          save_to_cache(f)
+        end
+      rescue SocketError,
+             Errno::ECONNREFUSED,
+             Errno::ECONNRESET,
+             Errno::ENETUNREACH,
+             Timeout::Error,
+             OpenURI::HTTPError => e
+        if retries != 0
+          retries -= 1
+          retry
+        else
+          raise Exceptions::NetworkError.new(from_url, e)
+        end
+      end
+    end
+  end
+end

data/lib/license_scout/options.rb

@@ -0,0 +1,45 @@
+#
+# Copyright:: Copyright 2016, Chef Software Inc.
+# License:: Apache License, Version 2.0
+#
+# 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.
+#
+
+require "license_scout/overrides"
+
+module LicenseScout
+  class Options
+    SUPPORTED_OPTIONS = [:overrides, :environment, :ruby_bin]
+
+    SUPPORTED_OPTIONS.each do |o|
+      self.send(:attr_reader, o)
+    end
+
+    def initialize(options = {})
+      SUPPORTED_OPTIONS.each do |o|
+        data = options[o] || defaults[o]
+        instance_variable_set("@#{o}".to_sym, data)
+      end
+    end
+
+    private
+
+    def defaults
+      {
+        overrides: Overrides.new,
+        environment: {},
+        ruby_bin: nil,
+      }
+    end
+  end
+end

data/lib/license_scout/overrides.rb

@@ -0,0 +1,149 @@
+#
+# Copyright:: Copyright 2016, Chef Software Inc.
+# License:: Apache License, Version 2.0
+#
+# 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.
+#
+
+require "license_scout/net_fetcher"
+
+require "pathname"
+
+module LicenseScout
+  class Overrides
+
+    class OverrideLicenseSet
+
+      attr_reader :license_locations
+
+      def initialize(license_locations)
+        @license_locations = license_locations || []
+      end
+
+      def empty?
+        license_locations.empty?
+      end
+
+      def resolve_locations(dependency_root_dir)
+        license_locations.map do |license_location|
+          if NetFetcher.remote?(license_location)
+            NetFetcher.cache(license_location)
+          else
+            normalize_and_verify_path(license_location, dependency_root_dir)
+          end
+        end
+      end
+
+      def normalize_and_verify_path(license_location, dependency_root_dir)
+        full_path = File.expand_path(license_location, dependency_root_dir)
+        if File.exists?(full_path)
+          full_path
+        else
+          raise Exceptions::InvalidOverride, "Provided license file path '#{license_location}' can not be found under detected dependency path '#{dependency_root_dir}'."
+        end
+      end
+
+    end
+
+    attr_reader :override_rules
+
+    def initialize(&rules)
+      @override_rules = {}
+      instance_eval(&rules) if block_given?
+
+      default_overrides
+    end
+
+    def override_license(dependency_manager, dependency_name, &rule)
+      override_rules[dependency_manager] ||= {}
+      override_rules[dependency_manager][dependency_name] = rule
+    end
+
+    def license_for(dependency_manager, dependency_name, dependency_version)
+      license_data = license_data_for(dependency_manager, dependency_name, dependency_version)
+      license_data && license_data[:license]
+    end
+
+    def license_files_for(dependency_manager, dependency_name, dependency_version)
+      license_data = license_data_for(dependency_manager, dependency_name, dependency_version)
+      OverrideLicenseSet.new(license_data && license_data[:license_files])
+    end
+
+    def have_override_for?(dependency_manager, dependency_name, dependency_version)
+      override_rules.key?(dependency_manager) && override_rules[dependency_manager].key?(dependency_name)
+    end
+
+    private
+
+    def license_data_for(dependency_manager, dependency_name, dependency_version)
+      return nil unless have_override_for?(dependency_manager, dependency_name, dependency_version)
+      override_rules[dependency_manager][dependency_name].call(dependency_version)
+    end
+
+    def default_overrides
+      # Default overrides for ruby_bundler dependency manager.
+      [
+        ["debug_inspector", "MIT", ["README.md"]],
+        ["inifile", "MIT", ["README.md"]],
+        ["syslog-logger", "MIT", ["README.rdoc"]],
+        ["httpclient", "Ruby", ["README.md"]],
+        ["little-plugger", "MIT", ["README.rdoc"]],
+        ["logging", "MIT", ["README.md"]],
+        ["coderay", nil, ["README_INDEX.rdoc"]],
+        ["multipart-post", "MIT", ["README.md"]],
+        ["erubis", "MIT", nil],
+        ["binding_of_caller", "MIT", nil],
+        ["method_source", "MIT", nil],
+        ["pry-remote", "MIT", nil],
+        ["pry-stack_explorer", "MIT", nil],
+        ["plist", "MIT", nil],
+        ["proxifier", "MIT", nil],
+        ["mixlib-shellout", "Apache-2.0", nil],
+        ["mixlib-log", "Apache-2.0", nil],
+        ["uuidtools", "Apache-2.0", nil],
+        ["cheffish", "Apache-2.0", nil],
+        ["chef-provisioning", "Apache-2.0", nil],
+        ["chef-provisioning-aws", "Apache-2.0", nil],
+        ["chef-rewind", "MIT", nil],
+        ["ubuntu_ami", "Apache-2.0", nil],
+        ["net-telnet", "Ruby", nil],
+        # Overrides that require file fetching from internet
+        ["sfl", "Ruby", ["https://raw.githubusercontent.com/ujihisa/spawn-for-legacy/master/LICENCE.md"]],
+        ["json_pure", nil, ["https://raw.githubusercontent.com/flori/json/master/README.md"]],
+        ["aws-sdk-core", nil, ["https://raw.githubusercontent.com/aws/aws-sdk-ruby/master/README.md"]],
+        ["aws-sdk-resources", nil, ["https://raw.githubusercontent.com/aws/aws-sdk-ruby/master/README.md"]],
+        ["aws-sdk", nil, ["https://raw.githubusercontent.com/aws/aws-sdk-ruby/master/README.md"]],
+        ["fuzzyurl", nil, ["https://raw.githubusercontent.com/gamache/fuzzyurl/master/LICENSE.txt"]],
+        ["jwt", nil, ["https://github.com/jwt/ruby-jwt/blob/master/LICENSE"]],
+        ["win32-process", nil, ["http://www.perlfoundation.org/attachment/legal/artistic-2_0.txt"]],
+        ["win32-api", nil, ["http://www.perlfoundation.org/attachment/legal/artistic-2_0.txt"]],
+        ["win32-dir", nil, ["http://www.perlfoundation.org/attachment/legal/artistic-2_0.txt"]],
+        ["win32-ipc", nil, ["http://www.perlfoundation.org/attachment/legal/artistic-2_0.txt"]],
+        ["win32-event", nil, ["http://www.perlfoundation.org/attachment/legal/artistic-2_0.txt"]],
+        ["win32-eventlog", nil, ["http://www.perlfoundation.org/attachment/legal/artistic-2_0.txt"]],
+        ["win32-mmap", nil, ["http://www.perlfoundation.org/attachment/legal/artistic-2_0.txt"]],
+        ["win32-mutex", nil, ["http://www.perlfoundation.org/attachment/legal/artistic-2_0.txt"]],
+        ["win32-service", nil, ["http://www.perlfoundation.org/attachment/legal/artistic-2_0.txt"]],
+        ["windows-api", nil, ["http://www.perlfoundation.org/attachment/legal/artistic-2_0.txt"]],
+      ].each do |override_data|
+        override_license "ruby_bundler", override_data[0] do |version|
+          {}.tap do |d|
+            d[:license] = override_data[1] if override_data[1]
+            d[:license_files] = override_data[2] if override_data[2]
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/license_scout/version.rb

@@ -0,0 +1,20 @@
+#
+# Copyright:: Copyright 2016, Chef Software Inc.
+# License:: Apache License, Version 2.0
+#
+# 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.
+#
+
+module LicenseScout
+  VERSION = "0.1.0"
+end

data/lib/license_scout.rb

@@ -0,0 +1,19 @@
+#
+# Copyright:: Copyright 2016, Chef Software Inc.
+# License:: Apache License, Version 2.0
+#
+# 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.
+#
+
+module LicenseScout
+end

data/license_scout.gemspec

@@ -0,0 +1,46 @@
+#
+# Copyright:: Copyright 2016, Chef Software Inc.
+# License:: Apache License, Version 2.0
+#
+# 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.
+#
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "license_scout/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "license_scout"
+  spec.version       = LicenseScout::VERSION
+  spec.authors       = [ "Serdar Sutay" ]
+  spec.email         = [ "serdar@chef.io" ]
+  spec.license       = "Apache-2.0"
+
+  spec.summary       = "Discovers license files of a project's dependencies."
+  spec.description   = "Discovers license files of a project's dependencies."
+  spec.homepage      = "https://github.com/chef/license_scout"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = %w{license_scout}
+  spec.require_paths = %w{lib}
+
+  spec.add_dependency "ffi-yajl",         "~> 2.2"
+  spec.add_dependency "mixlib-shellout",  "~> 2.2"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rb-readline"
+end

metadata

@@ -0,0 +1,190 @@
+--- !ruby/object:Gem::Specification
+name: license_scout
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Serdar Sutay
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi-yajl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: mixlib-shellout
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: pry
+  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: rb-readline
+  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: Discovers license files of a project's dependencies.
+email:
+- serdar@chef.io
+executables:
+- license_scout
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/license_scout
+- lib/license_scout.rb
+- lib/license_scout/collector.rb
+- lib/license_scout/dependency.rb
+- lib/license_scout/dependency_manager.rb
+- lib/license_scout/dependency_manager/base.rb
+- lib/license_scout/dependency_manager/bundler.rb
+- lib/license_scout/dependency_manager/bundler/LICENSE.md
+- lib/license_scout/dependency_manager/bundler/_bundler_script.rb
+- lib/license_scout/dependency_manager/rebar.rb
+- lib/license_scout/exceptions.rb
+- lib/license_scout/license_file_analyzer.rb
+- lib/license_scout/license_file_analyzer/any_matcher.rb
+- lib/license_scout/license_file_analyzer/definitions.rb
+- lib/license_scout/license_file_analyzer/header_matcher.rb
+- lib/license_scout/license_file_analyzer/matcher.rb
+- lib/license_scout/license_file_analyzer/template.rb
+- lib/license_scout/license_file_analyzer/templates/Apache2-short.txt
+- lib/license_scout/license_file_analyzer/templates/Apache2.txt
+- lib/license_scout/license_file_analyzer/templates/BSD-2-Clause-bullets.txt
+- lib/license_scout/license_file_analyzer/templates/BSD-2-Clause.txt
+- lib/license_scout/license_file_analyzer/templates/BSD-3-Clause-alt-format.txt
+- lib/license_scout/license_file_analyzer/templates/BSD-3-Clause.txt
+- lib/license_scout/license_file_analyzer/templates/BSD.txt
+- lib/license_scout/license_file_analyzer/templates/EPLICENSE.txt
+- lib/license_scout/license_file_analyzer/templates/GPL-2.0.txt
+- lib/license_scout/license_file_analyzer/templates/GPL-3.0.txt
+- lib/license_scout/license_file_analyzer/templates/ISC.txt
+- lib/license_scout/license_file_analyzer/templates/LGPL-3.0.txt
+- lib/license_scout/license_file_analyzer/templates/MIT.txt
+- lib/license_scout/license_file_analyzer/templates/MPL2.txt
+- lib/license_scout/license_file_analyzer/templates/Python-2.0.txt
+- lib/license_scout/license_file_analyzer/templates/Ruby.txt
+- lib/license_scout/license_file_analyzer/text.rb
+- lib/license_scout/net_fetcher.rb
+- lib/license_scout/options.rb
+- lib/license_scout/overrides.rb
+- lib/license_scout/version.rb
+- license_scout.gemspec
+homepage: https://github.com/chef/license_scout
+licenses:
+- Apache-2.0
+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.6
+signing_key: 
+specification_version: 4
+summary: Discovers license files of a project's dependencies.
+test_files: []