gems-license-finder 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a01609bf3346c47dc552b9232be5d69c1e90846d
+  data.tar.gz: 8f8383ad8bca15ed9b8e6110488767c679b5da89
+SHA512:
+  metadata.gz: 8e23caae8e928bdd1260a94b874a7f1e1f4b943cb30ae1e07d835581e2fb33ad0ca3ea39f3f39c64422ea160fa4bd75ae0c701f1e76833d01a9f5da93aa06973
+  data.tar.gz: 9643d7c373a601bb5779f046f89d7d320854fa7c639e362b6b0f4668a1bff027b0f4827be96855fe22b0f95b8e166a428b226e47b06e47e28e008205315212bf

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,64 @@
+PATH
+  remote: .
+  specs:
+    gems-license-finder (0.0.1)
+      bluecloth
+      faraday (< 0.9)
+      github-markup
+      github_api
+      kramdown
+      maruku
+      posix-spawn
+      rdiscount
+      redcarpet
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.5)
+    bluecloth (2.2.0)
+    descendants_tracker (0.0.3)
+    faraday (0.8.9)
+      multipart-post (~> 1.2.0)
+    github-markup (1.1.0)
+    github_api (0.11.3)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.1)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 1.2)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.0)
+      oauth2
+    hashie (2.0.5)
+    jwt (0.1.11)
+      multi_json (>= 1.5)
+    kramdown (1.3.3)
+    maruku (0.7.1)
+    metaclass (0.0.4)
+    mini_portile (0.5.2)
+    minitest (5.3.1)
+    mocha (1.0.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.9.2)
+    multi_xml (0.5.5)
+    multipart-post (1.2.0)
+    nokogiri (1.6.1)
+      mini_portile (~> 0.5.0)
+    oauth2 (0.9.3)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 0.1.8)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    posix-spawn (0.3.8)
+    rack (1.5.2)
+    rdiscount (2.1.7)
+    redcarpet (3.1.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  gems-license-finder!
+  minitest
+  mocha

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Kontera Technologies
+
+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/README.md

@@ -0,0 +1,95 @@
+# Gems License Finder
+
+Poor man's implementation of a license finder for rubygems.
+<br/>It uses `rubygems.org` && `Github` under the hood and **works 90% of the time** :)
+
+## WARNING
+Please be aware that it may give you the WRONG license for some of the gems,
+so use it at your own risk
+
+## Installtion
+`gem install gems-license-finder`
+
+or add this to your `Gemfile` and bundle
+
+`gem 'gems-license-finder'`
+
+## Usage
+via command line
+```
+$ gems-license-finder --help
+Usage: gems-license-finder gem-name [options]
+
+    -o, --output FORMAT              output format [json, yaml]
+    -t, --token TOKEN                github token string ( or by GITHUB_TOEKN environment variable )
+
+More information about how to generate the github token please look at:
+https://help.github.com/articles/git-over-https-using-oauth-token
+```
+
+finding the license of `bundler` gem
+```
+$ gems-license-finder bundler --output json
+{
+  "license_type": "MIT",
+  "license_url": "http://choosealicense.com/licenses/mit/",
+  "homepage": "http://github.com/carlhuda/bundler/",
+  "license": "https://github.com/bundler/bundler/blob/master/LICENSE.md",
+  "github_url": "https://github.com/bundler/bundler",
+  "github_user": "bundler",
+  "github_repo": "bundler"
+}
+
+```
+
+Github token is optional, it allows authenticated users to submit more than 20 requests per
+minute
+
+```
+$ GITHUB_TOEKN=mygithubtoken gems-license-finder rails --output json
+{
+  "license_type": "MIT",
+  "license_url": "http://choosealicense.com/licenses/mit/",
+  "homepage": "http://github.com/rails/rails",
+  "license": "https://github.com/rails/rails/blob/master/README.md#license",
+  "github_url": "https://github.com/rails/rails",
+  "github_user": "rails",
+  "github_repo": "rails"
+}
+```
+or 
+```
+$ gems-license-finder redis --output json --token mygithubtoken
+{
+  "license_type": "MIT",
+  "license_url": "http://choosealicense.com/licenses/mit/",
+  "homepage": "https://github.com/redis/redis-rb",
+  "license": "https://github.com/redis/redis-rb/blob/master/LICENSE",
+  "github_url": "https://github.com/redis/redis-rb",
+  "github_user": "redis",
+  "github_repo": "redis-rb"
+
+```
+via code
+
+```ruby
+require 'gems-license-finder'
+require 'pp'
+
+client = GemsLicenseFinder.new(oauth_token: "MY-GITHUB-TOKEN")
+pp client.find("rails")
+
+# this should be printed to the console
+
+{:license_type=>"MIT",
+ :license_url=>"http://choosealicense.com/licenses/mit/",
+ :homepage=>"http://github.com/rails/rails",
+ :license=>"https://github.com/rails/rails/blob/master/README.md#license",
+ :github_url=>"https://github.com/rails/rails",
+ :github_user=>"rails",
+ :github_repo=>"rails"}
+```
+
+## Warranty
+This software is provided “as is” and without any express or implied warranties, including, without limitation, the implied warranties of merchantability and fitness for a particular purpose.
+

data/Rakefile

@@ -0,0 +1,18 @@
+$:.unshift File.expand_path '../lib', __FILE__
+require 'gems-license-finder'
+require 'rubygems/package_task'
+require 'rake/testtask'
+
+GemsLicenseFinder::GemSpec = eval File.read 'gems-license-finder.gemspec'
+
+Gem::PackageTask.new GemsLicenseFinder::GemSpec do |p|
+  p.gem_spec = GemsLicenseFinder::GemSpec
+end
+
+## Tests stuff
+task :default => :test
+
+Rake::TestTask.new(:test) do |t|
+  t.libs.push 'tests'
+  t.pattern = 'tests/**/*_test.rb'
+end

data/bin/gems-license-finder

@@ -0,0 +1,33 @@
+#! /usr/bin/env ruby
+
+$:.unshift File.expand_path("../../lib",__FILE__)
+
+require 'gems-license-finder'
+require 'yaml'
+require 'json'
+require 'optparse'
+
+options = { output: ->(hash) { JSON.pretty_generate hash } }
+options[:oauth_token] =  ENV["GITHUB_TOKEN"] if ENV["GITHUB_TOKEN"]
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: gems-license-finder gem-name [options]"
+  opts.separator ""
+
+  opts.on("-o", "--output FORMAT", "output format [json, yaml]") do |v|
+    options[:output] = ->(hash) { hash.to_yaml } if v =~ /yaml/i
+  end
+
+  opts.on("-t", "--token TOKEN", "github token string ( or by GITHUB_TOEKN environment variable )") do |v|
+    options[:oauth_token] = v
+  end
+
+  opts.separator ""
+  opts.separator "More information about how to generate the github token please look at:"
+  opts.separator "https://help.github.com/articles/git-over-https-using-oauth-token"
+  opts.separator ""
+  
+end.parse!
+
+ARGV.first or abort "No gem was specified..."
+puts options[:output].(GemsLicenseFinder.new(options).find ARGV.first)

data/lib/gems-license-finder.rb

@@ -0,0 +1,132 @@
+# encoding: utf-8
+
+require 'github_api'
+require 'open-uri'
+require 'uri'
+require 'github/markup'
+require 'gems-license-finder/version'
+
+module GemsLicenseFinder
+  GemNotFound = Class.new(StandardError)
+
+  def self.new(*args)
+    Client.new(*args)
+  end
+
+  def self.version
+    GemsLicenseFinder::VERSION
+  end
+
+  class Client
+
+    LICENSE_FILES = %w[LICENSE LICENSE.md LICENSE.markdown MIT-LICENSE LICENSE.txt
+      MIT-LICENSE.txt MIT.LICENSE MIT-LICENSE.md  COPYING COPYING.md]
+    README_FILES = %w[README.md README.rdoc README.markdown README.txt README]
+
+    def initialize options = {}
+      @github = Github.new options.clone
+    end
+
+    def find name
+      rubygems_info( name ).merge( github_info name )
+    end
+
+    private
+
+    def rubygems_info name
+      begin
+        content = open("http://rubygems.org/gems/#{name}").read
+      rescue Exception => e
+        raise e.io.status.first == "404" ? GemNotFound.new(e) : e
+      end
+
+      homepage = nil
+      type, url = normalize_licence(
+        (content.match(/<h5>Licenses<\/h5>.*?<p>(.*?)</msi)[1]  rescue ""))
+      homepage = (content.match(/<a href="(.*?)".*?>Source/)[1] rescue nil)
+      homepage ||= (content.match(/<a href="(.*?)".*?>Home/)[1] rescue nil)
+
+      { license_type: type, license_url: url, homepage: homepage }
+    end
+
+    def github_info name
+      url = find_github_url name
+      user, repo = URI(url).path.split("/")[1..2]
+      info = {license: nil, github_url: url, github_user: user, github_repo: repo}
+
+      LICENSE_FILES.each do |file|
+        info[:license] = "#{url}/blob/master/#{file}" if fetch_github_file(user, repo, file)
+
+        if info[:license]
+          info[:license_type], info[:license_url] = normalize_licence("mit") if file =~ /mit/i
+          break
+        end
+      end
+
+      if (!info[:license_type] and gemspec = fetch_github_file(user,repo,"#{name}.gemspec") )
+        info[:license_type], info[:license_url] = normalize_licence(gemspec)
+      end
+
+      README_FILES.each do |file|
+        next if info[:license]
+        page_url = "https://github.com/#{user}/#{repo}/blob/master/#{file}"
+        raw_content = fetch_github_file(user, repo, file)
+        content = GitHub::Markup.render(file, raw_content) rescue next
+
+        if content and info[:license_type].nil?
+          info[:license_type], info[:license_url] = normalize_licence(content) 
+        end
+
+        msi = Regexp::FIXEDENCODING | Regexp::IGNORECASE | Regexp::MULTILINE
+        regex = Regexp.new('<h\d+>.*?(license.*?)<\/h\d+>'.force_encoding("UTF-8"),msi)
+        info[:license] =  page_url + "#" + 
+          content.match(regex)[1].to_s.downcase.gsub(/\s/,"-") rescue nil
+      end
+
+      info
+    end
+
+    def find_github_url name
+      @github.search.repos(q: "#{name} language:ruby").to_a[1][1][0].html_url
+    end
+
+    def fetch_github_file user, repo, file
+      begin
+        Base64.decode64(@github.repos.contents.get(user, repo, file).content)
+      rescue Github::Error::NotFound
+      end
+    end
+
+    def normalize_licence str
+      case str.downcase
+      when /(^|\W)mit(\W|$)/
+        ["MIT","http://choosealicense.com/licenses/mit/"]
+      when /(^|\W)bsd\W.*?3/
+        ["BSD-3","http://choosealicense.com/licenses/bsd-3-clause/"]
+      when /(^|\W)bsd(\W|$)/
+        ["BSD","http://choosealicense.com/licenses/bsd/"]
+      when /(^|\W)apache(\W|$)/
+        ["Apache","http://choosealicense.com/licenses/apache/"]
+      when /(^|\W)lgpl\W.*?3/
+        ["LGPL-3","http://choosealicense.com/licenses/lgpl-v3/"]
+      when /(^|\W)lgpl(\W|$)/
+        ["LGPL","http://choosealicense.com/licenses/lgpl-v2.1/"]
+      when /(affero)|(agpl)/
+        ["Affero-GPL","http://choosealicense.com/licenses/agpl/"]
+      when /(^|\W)gpl\W.*?3/
+        ["GPL-3","http://choosealicense.com/licenses/gpl-v3/"]
+      when /(^|\W)gpl(\W|$)/
+        ["GPL-2","http://choosealicense.com/licenses/gpl-v2/"]
+      when /(^|\W)artistic(\W|$)/
+        ["Artistic","http://choosealicense.com/licenses/artistic/"]
+      when /(license.*?ruby)|(ruby.*?license)/
+        ["Ruby","https://www.ruby-lang.org/en/about/license.txt"]
+      when "ruby"
+        ["Ruby","https://www.ruby-lang.org/en/about/license.txt"]
+      else
+        nil
+      end
+    end
+
+  end
+end

data/lib/gems-license-finder/version.rb

@@ -0,0 +1,3 @@
+module GemsLicenseFinder
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,205 @@
+--- !ruby/object:Gem::Specification
+name: gems-license-finder
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Eran Barak Levi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: mocha
+  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: github_api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: github-markup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: posix-spawn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdiscount
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: maruku
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bluecloth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - <
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - <
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Poor man's license finder for rubygems, that might work
+email: eran@kontera.com
+executables:
+- gems-license-finder
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/gems-license-finder
+- lib/gems-license-finder.rb
+- lib/gems-license-finder/version.rb
+homepage: http://www.kontera.com
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Poor man's license finder for rubygems
+test_files: []