gem-license 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 86ddc134de3304378496bf70a06b5c0b1d356c497f8efc2d05302374e558e855
+  data.tar.gz: 14ad79c931803710aac2010d337eb22d865e158804c48bdd93ba8fdd2919c7ed
+SHA512:
+  metadata.gz: 8811aa0cd2824b2c0b865d84ecfa6e1dbec978fb413e905f121dad77373ee7e022a84a5cd231628f8e8303b5290fd7d7800755fbac057a72a23dd5415e44f157
+  data.tar.gz: d3b0f87a9fb1fb2a1055749ef942d682a75df96cdc39f3bda3f2bf2f1f4cd59d7f9c2c40dc1426605c4497a123312606c587f651eee19c756497123a383ee384

data/.gitignore

@@ -0,0 +1,53 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rubocop.yml

@@ -0,0 +1,6 @@
+Style/ClassAndModuleChildren:
+  Exclude:
+    - "lib/rubygems/commands/license_command.rb"
+
+Metrics/LineLength:
+  Max: 110

data/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) <year> <copyright holders>
+
+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 (including the next paragraph) 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/README.md

@@ -0,0 +1,31 @@
+# gem-license
+
+A gem plugin for fetching licenses
+
+## Installation
+
+```sh
+gem install gem-license
+```
+
+## Usage
+
+```sh
+gem license mit
+
+# output to stdout
+gem license gpl-3.0
+
+# create a LICENSE.md
+gem license apl-1.0
+```
+
+Licenses names are all based on SPDX identifiers and are not case sensitive.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/swarley/gem-license.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/gem-license.gemspec

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name          = 'gem-license'
+  spec.version       = '0.1.0'
+  spec.authors       = ['Matt Carey']
+  spec.email         = ['matthew.b.carey@gmail.com']
+
+  spec.summary       = 'Gem plugin to download licenses'
+  spec.description   = 'Gem plugin to download a LICENSE file based on its shortname'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 2.0.1'
+  spec.add_development_dependency 'rubocop', '~> 0.69'
+end

data/lib/rubygems/commands/license_command.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require 'open-uri'
+require 'json'
+
+# license gem plugin
+class Gem::Commands::LicenseCommand < Gem::Command
+  def initialize
+    super('license', 'Download a license by SPDX id')
+
+    add_option('-m', '--markdown', 'Download as LICENSE.md') do |_, options|
+      options[:markdown] = true
+    end
+
+    add_option('-s', '--stdout', 'Write to STDOUT instead of LICENSE') do |_, options|
+      options[:stdout] = true
+    end
+  end
+
+  def fetch_license_list
+    list_uri = URI('https://spdx.org/licenses/licenses.json')
+    JSON.parse(list_uri.read)
+  rescue OpenURI::HTTPError => e
+    raise Gem::CommandLineError, "Unable to get license list. [#{e.message}]"
+  end
+
+  def fetch_license_text(url)
+    license_uri = URI(url)
+    license_obj = JSON.parse(license_uri.read)
+    license_obj['licenseText']
+  rescue OpenURI::HTTPError => e
+    raise Gem::CommandLineError, "Unable to get license text. [#{e.message}]"
+  end
+
+  def match_license_id(license_id, id_list)
+    license_id_rxp = Regexp.new(Regexp.escape(license_id), Regexp::IGNORECASE)
+    matched_ids = id_list.select { |id| id =~ license_id_rxp }
+
+    perfect_match = matched_ids.find { |id| id =~ /\A#{license_id_rxp}\Z/i }
+
+    unless perfect_match
+      say 'Unable to find an exact match. Suggestions below'
+      matched_ids.each { |id| say "\t#{id}" }
+      exit
+    end
+
+    perfect_match
+  end
+
+  def write_license(license_obj)
+    text = fetch_license_text(license_obj['detailsUrl'])
+    if options[:stdout]
+      say text
+    else
+      fname = 'LICENSE'
+      fname += '.md' if options[:markdown]
+      File.open(fname, 'w+') do |f|
+        f.write text
+      end
+    end
+  end
+
+  def download(shortname)
+    license_list = fetch_license_list['licenses']
+    id_list = license_list.collect { |l_obj| l_obj['licenseId'] }
+
+    id = match_license_id(shortname, id_list)
+    license_obj = license_list.find { |l_obj| l_obj['licenseId'] == id }
+
+    write_license license_obj
+  end
+
+  def execute
+    id = options[:args].first
+    download(id)
+  end
+end

data/lib/rubygems_plugin.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'rubygems/command_manager'
+
+Gem::CommandManager.instance.register_command(:license)

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: gem-license
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matt Carey
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.69'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.69'
+description: Gem plugin to download a LICENSE file based on its shortname
+email:
+- matthew.b.carey@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- LICENSE
+- README.md
+- gem-license.gemspec
+- lib/rubygems/commands/license_command.rb
+- lib/rubygems_plugin.rb
+homepage: 
+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: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Gem plugin to download licenses
+test_files: []