license_scout 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d48be3c19574905aef576b453b5750796b64e7ed
+  data.tar.gz: a9424c524ca4e52c478cf45610b229f9f4909268
+SHA512:
+  metadata.gz: b4c68b97c0370efab31ba8a43090ca05762a03275af7f00cd9af0dc4f384a352c701c4c045a4de537af132bb0e7cb1ebe7b5b83122afd3ad6b0d1326fbe6e69d
+  data.tar.gz: 083fa2b33c02f30de9a39976aa2b9f87f366eb90d3a2f90901c71446eb7c0e25892547555ef04a95bc1ed337517f81a58505e17916484aefee6cb58484695ad8

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--exclude-pattern spec/fixtures/**/*

data/.rubocop.yml

@@ -0,0 +1,4 @@
+AllCops:
+  TargetRubyVersion: 2.2
+  Excludes:
+    - spec/fixtures/**/*

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+sudo: false
+
+# do not run expensive spec tests on PRs, only on branches
+branches:
+  only:
+  - master
+
+before_install: gem install bundler
+rvm:
+  - 2.1

data/Gemfile

@@ -0,0 +1,24 @@
+#
+# 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.
+#
+
+source "https://rubygems.org"
+
+gemspec
+
+group(:development, :test) do
+  gem "chefstyle", git: "https://github.com/chef/chefstyle.git", branch: "master"
+end

data/LICENSE

@@ -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,26 @@
+# license_scout
+
+LicenseScout discovers and collects the licenses of a project and its
+dependencies, including transitive dependencies.
+
+Currently supported project types are:
+
+* Ruby - bundler
+* Erlang - rebar
+
+## Usage
+
+## Contributing
+
+This project is maintained by the contribution guidelines identified for
+[chef](https://github.com/chef/chef) project. You can find the guidelines here:
+
+https://github.com/chef/chef/blob/master/CONTRIBUTING.md
+
+Pull requests in this project are merged when they have two :+1:s from maintainers.
+
+## Maintainers
+
+- [Dan DeLeo](https://github.com/danielsdeleo)
+- [Serdar Sutay](https://github.com/sersut)
+- [Ryan Cragun](https://github.com/ryancragun)

data/Rakefile

@@ -0,0 +1,39 @@
+#
+# 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 "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+task default: :test
+
+desc "Run specs"
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = "spec/**/*_spec.rb"
+end
+
+begin
+  require "chefstyle"
+  require "rubocop/rake_task"
+  RuboCop::RakeTask.new(:style) do |task|
+    task.options += ["--display-cop-names", "--no-color"]
+  end
+rescue LoadError
+  puts "chefstyle/rubocop is not available.  gem install chefstyle to do style checking."
+end
+
+desc "Run all tests"
+task test: [:style, :spec]

data/bin/license_scout

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+#
+# 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.
+#
+
+$:.unshift File.expand_path("../../lib", __FILE__)
+
+require "license_scout/collector"
+require "license_scout/overrides"
+require "license_scout/options"
+
+project_dir = File.expand_path(Dir.pwd)
+project_name = File.basename(project_dir)
+
+output_dir = project_dir
+
+overrides = LicenseScout::Overrides.new
+
+opts = LicenseScout::Options.new(overrides: overrides)
+
+collector = LicenseScout::Collector.new(project_name, project_dir, output_dir, opts)
+
+collector.run
+report = collector.issue_report
+
+puts report

data/lib/license_scout/collector.rb

@@ -0,0 +1,137 @@
+#
+# 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/exceptions"
+require "license_scout/dependency_manager"
+
+require "ffi_yajl"
+
+module LicenseScout
+  class Collector
+
+    attr_reader :project_name
+    attr_reader :project_dir
+    attr_reader :output_dir
+    attr_reader :license_manifest_data
+    attr_reader :options
+
+    def initialize(project_name, project_dir, output_dir, options)
+      @project_name = project_name
+      @project_dir = project_dir
+      @output_dir = output_dir
+      @options = options
+    end
+
+    def dependency_managers
+      @dependency_managers ||= all_dependency_managers.select { |m| m.detected? }
+    end
+
+    def run
+      reset_license_manifest
+
+      if !File.exists?(project_dir)
+        raise LicenseScout::Exceptions::ProjectDirectoryMissing.new(project_dir)
+      end
+      FileUtils.mkdir_p(output_dir) unless File.exist?(output_dir)
+
+      if dependency_managers.empty?
+        raise LicenseScout::Exceptions::UnsupportedProjectType.new(project_dir)
+      end
+      dependency_managers.each { |d| collect_licenses_from(d) }
+
+      File.open(license_manifest_path, "w+") do |file|
+        file.print(FFI_Yajl::Encoder.encode(license_manifest_data, pretty: true))
+      end
+    end
+
+    def issue_report
+      report = []
+      license_report = FFI_Yajl::Parser.parse(File.read(license_manifest_path))
+
+      license_report["dependency_managers"].each do |dependency_manager, dependencies|
+        dependencies.each do |dependency|
+          if dependency["name"].nil? || dependency["name"].empty?
+            report << "There is a dependency with a missing name in '#{dependency_manager}'."
+          end
+
+          if dependency["version"].nil? || dependency["version"].empty?
+            report << "Dependency '#{dependency["name"]}' under '#{dependency_manager}' is missing version information."
+          end
+
+          if dependency["license"].nil? || dependency["license"].empty?
+            report << "Dependency '#{dependency["name"]}' version '#{dependency["version"]}' under '#{dependency_manager}' is missing license information."
+          end
+
+          if dependency["license_files"].empty?
+            report << "Dependency '#{dependency["name"]}' version '#{dependency["version"]}' under '#{dependency_manager}' is missing license files information."
+          end
+        end
+      end
+
+      report
+    end
+
+    private
+
+    def reset_license_manifest
+      @license_manifest_data = {
+        license_manifest_version: 1,
+        project_name: project_name,
+        dependency_managers: {},
+      }
+    end
+
+    def license_manifest_path
+      File.join(output_dir, "#{project_name}-dependency-licenses.json")
+    end
+
+    def collect_licenses_from(dependency_manager)
+      license_manifest_data[:dependency_managers][dependency_manager.name] = []
+
+      dependency_manager.dependencies.each do |dep|
+        license_data = {
+          name: dep.name,
+          version: dep.version,
+          license: dep.license,
+          license_files: [],
+        }
+
+        dep.license_files.each do |license_file|
+          output_license_filename = [
+            dependency_manager.name,
+            dep.name,
+            dep.version,
+            File.basename(license_file),
+          ].join("-")
+          output_license_path = File.join(output_dir, output_license_filename)
+          FileUtils.cp(license_file, output_license_path)
+
+          license_data[:license_files] << output_license_filename
+        end
+
+        license_manifest_data[:dependency_managers][dependency_manager.name] << license_data
+
+      end
+    end
+
+    def all_dependency_managers
+      LicenseScout::DependencyManager.implementations.map do |implementation|
+        implementation.new(project_dir, options)
+      end
+    end
+  end
+end

data/lib/license_scout/dependency.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
+  Dependency = Struct.new(:name, :version, :license, :license_files)
+end

data/lib/license_scout/dependency_manager/base.rb

@@ -0,0 +1,55 @@
+#
+# 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/dependency"
+
+module LicenseScout
+  module DependencyManager
+    class Base
+
+      POSSIBLE_LICENSE_FILES = %w{
+        LICENSE
+        LICENSE.txt
+        LICENSE.md
+        LICENSE.rdoc
+        License
+        License.text
+        License.txt
+        License.md
+        License.rdoc
+        Licence.rdoc
+        Licence.md
+        MIT-LICENSE
+        MIT-LICENSE.txt
+        LICENSE.MIT
+        LGPL-2.1
+        COPYING.txt
+        COPYING
+        BSD_LICENSE
+      }
+
+      attr_reader :project_dir
+      attr_reader :options
+
+      def initialize(project_dir, options)
+        @project_dir = project_dir
+        @options = options
+      end
+
+    end
+  end
+end

data/lib/license_scout/dependency_manager/bundler/LICENSE.md

@@ -0,0 +1,23 @@
+Portions copyright (c) 2010 Andre Arko  
+Portions copyright (c) 2009 Engine Yard
+
+MIT License
+
+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.

data/lib/license_scout/dependency_manager/bundler/_bundler_script.rb

@@ -0,0 +1,47 @@
+#
+# 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.
+#
+
+# When using LicenseScout with Omnibus, LicenseScout is run from the bundled
+# omnibus process which has a different ruby executable and rubygems directory
+# than the project we want to collect licenses for. Bundler will end up loading
+# the gemspecs for the gems we are inspecting, so we need to run our query for
+# version and license information from a separate process that executes inside
+# the target ruby+bundler environment. This script is the thing that runs that
+# query; it's intended to be run like
+# `/opt/chef/embedded/bin/ruby /path/to/script`. It returns the data
+# LicenseScout needs as JSON on stdout.
+
+# We need to load the target project's bundler config, so we have to do a full
+# bundler setup:
+require "bundler/setup"
+
+# We're only using things that are in the stdlib.
+require "json"
+
+definition = ::Bundler::Definition.build("./Gemfile", "./Gemfile.lock", nil)
+dependencies = []
+
+definition.specs_for(definition.groups).each do |gem_spec|
+  dependencies << {
+    name: gem_spec.name,
+    version: gem_spec.version,
+    license: gem_spec.license,
+    path: gem_spec.full_gem_path,
+  }
+end
+
+puts JSON.generate(dependencies)