gems-license-finder 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1b21cfc843e5843f328e1ae633c63e6f0d312f9b
-  data.tar.gz: bfeb67385f723d004202e29543a2b1cf9dc0b095
+  metadata.gz: f98586f27c7d0fbd33dc870a4ec90e67d7dfcc13
+  data.tar.gz: c2d415e82f4de573a6bf8c253a75f11ef28a0cc3
 SHA512:
-  metadata.gz: 30dd68d50f6ab6156f498edf5e3897510c9b3e249edd771d61f9f49bca942358e6fe4dca526dd6fcd129bbe9df25cd9066cf53abfbdcaaad6030f4c18fd0bf59
-  data.tar.gz: 648f4fe7e462579d3de271c7db3a21dd58b9f7bdc5622e09ae1edab7a1e847c8d1811397846e97fb02c6720f5c48969e782cfbd976f78b8b0491469c22b491e0
+  metadata.gz: 55ce3bc14c5e56d0f8101a9f67d6207bbec04468ada63ab4bf0363d5f67556ee4d7572d63d91a28bb674032acb91ea216fa919ef5ee170f48b3ca5a264d9b5a8
+  data.tar.gz: 4955d84a89745a597e6ab1073ee0cdf24273aa8fe34251d2380c5c965a610c445c56209af4c24ed53d7f2895f1e66c9e421eb42840dae3af0edcc0a95b7c9321

data/README.md

@@ -21,7 +21,8 @@ $ 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 )
+    -t, --token TOKEN                github token string ( or by GITHUB_TOKEN environment variable )
+    -v, --version                    Print version and exit
 
 For more information about how to generate the github token please look at:
 https://help.github.com/articles/git-over-https-using-oauth-token
@@ -29,15 +30,18 @@ https://help.github.com/articles/git-over-https-using-oauth-token
 
 finding the license of `bundler` gem
 ```
-$ gems-license-finder bundler --output json
+$ gems-license-finder bundler
 {
+  "homepage": "http://bundler.io",
+  "source_code": "http://github.com/carlhuda/bundler/",
+  "documentation": "http://gembundler.com",
+  "mailing_list": "http://groups.google.com/group/ruby-bundler?hl=en",
+  "bug_tracker": "http://github.com/carlhuda/bundler/issues",
   "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"
+  "description": "Bundler manages an application's dependencies through its entire life, across many machines, systematically and repeatably",
+  "license": "https://github.com/bundler/bundler//blob/master/LICENSE.md",
+  "github_url": "https://github.com/bundler/bundler/"
 }
 
 ```
@@ -46,28 +50,31 @@ Github token is optional, it allows authenticated users to submit more than 20 r
 minute
 
 ```
-$ GITHUB_TOEKN=mygithubtoken gems-license-finder rails --output json
+$ GITHUB_TOKEN=mygithubtoken gems-license-finder rails
 {
+  "homepage": "http://www.rubyonrails.org",
+  "source_code": "http://github.com/rails/rails",
+  "documentation": "http://api.rubyonrails.org",
+  "wiki": "http://wiki.rubyonrails.org",
+  "mailing_list": "http://groups.google.com/group/rubyonrails-talk",
+  "bug_tracker": "http://github.com/rails/rails/issues",
   "license_type": "MIT",
   "license_url": "http://choosealicense.com/licenses/mit/",
-  "homepage": "http://github.com/rails/rails",
+  "description": "Ruby on Rails is a full-stack web framework optimized for programmer happiness and sustainable productivity. It encourages beautiful code by favoring convention over configuration.",
   "license": "https://github.com/rails/rails/blob/master/README.md#license",
-  "github_url": "https://github.com/rails/rails",
-  "github_user": "rails",
-  "github_repo": "rails"
+  "github_url": "https://github.com/rails/rails"
 }
 ```
 or via the `--token` switch
 ```
-$ gems-license-finder redis --output json --token mygithubtoken
+$ gems-license-finder redis --token mygithubtoken
 {
+  "homepage": "https://github.com/redis/redis-rb",
   "license_type": "MIT",
   "license_url": "http://choosealicense.com/licenses/mit/",
-  "homepage": "https://github.com/redis/redis-rb",
+  "description": "A Ruby client that tries to match Redis' API one-to-one, while still providing an idiomatic interface. It features thread-safety, client-side sharding, pipelining, and an obsession for performance.",
   "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"
+  "github_url": "https://github.com/redis/redis-rb"
 }
 ```
 via code
@@ -81,13 +88,16 @@ 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"
+  "homepage"=>"http://www.rubyonrails.org",
+  "source_code"=>"http://github.com/rails/rails",
+  "documentation"=>"http://api.rubyonrails.org",
+  "wiki"=>"http://wiki.rubyonrails.org",
+  "mailing_list"=>"http://groups.google.com/group/rubyonrails-talk",
+  "bug_tracker"=>"http://github.com/rails/rails/issues",
+  "license_type"=>"MIT",
+  "license_url"=>"http://choosealicense.com/licenses/mit/",
+  "license"=>"https://github.com/rails/rails/blob/master/README.md#license",
+  "github_url"=>"https://github.com/rails/rails"
 }
 ```
 

data/bin/gems-license-finder

@@ -19,10 +19,15 @@ OptionParser.new do |opts|
     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|
+  opts.on("-t", "--token TOKEN", "github token string ( or by GITHUB_TOKEN environment variable )") do |v|
     options[:oauth_token] = v
   end
 
+  opts.on("-v", "--version","print current version and exit") do
+    puts GemsLicenseFinder.version
+    exit
+  end
+
   opts.separator ""
   opts.separator "For 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"

data/lib/gems-license-finder.rb

@@ -20,7 +20,7 @@ module GemsLicenseFinder
   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]
+                       COPYING COPYING.md GNU GNU.txt GNU.rdoc GNU.markdown]
 
     README_FILES = %w[README.md README.rdoc README.markdown README.txt README]
 
@@ -43,16 +43,11 @@ module GemsLicenseFinder
     end
 
     def find name
-      rubygems_info( name ).merge( github_info name )
+      normalize(github_info name, rubygems_info( name ))
     end
 
     private
 
-    def type_from_license_text t
-      LICENSES_STRINGS.each {|n,s| return normalize_licence(n) if utf8_match(t,s)}
-      nil
-    end
-
     def rubygems_info name
       begin
         content = open("http://rubygems.org/gems/#{name}").read
@@ -60,29 +55,35 @@ module GemsLicenseFinder
         raise e.io.status.first == "404" ? GemNotFound.new(e) : e
       end
 
-      homepage = nil
+      info = Hash[content.scan(/<a href="(.*?)" rel.*>(.*?)</)].invert
       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)
+        (utf8_match(content,'<h5>Licenses<\/h5>.*?<p>(.*?)<')[1]  rescue ""))
+      description = (utf8_match(content,'<div id="markup">.*?<p>(.*?)<')[1].
+                     strip.squeeze(" ").gsub(/\n/,"") rescue nil)
 
-      { license_type: type, license_url: url, homepage: homepage }
+      info.merge({ license_type: type, license_url: url, description: description })
     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}
+    def github_info name, rubygems
+      url = rubygems["Source Code"] || rubygems["Homepage"]
+      if url.to_s =~ /github\.com/
+        # Sometimes the homepage in rubygems.org is old, e.g:
+        # carlhuda/bundler => bundler/bundler
+        open(url.sub("http:","https:")) { |o| url = o.base_uri.to_s } # follow redirects
+      else
+        url = nil
+      end
 
-      type, lurl = []
+      url ||= find_github_url name
+      user, repo, type, lurl, license = URI(url).path.split("/")[1..2]
 
       LICENSE_FILES.each do |file|
         content = fetch_github_file(user, repo, file)
-        info[:license] = "#{url}/blob/master/#{file}" if content
+        license = "#{url}/blob/master/#{file}" if content
 
-        if info[:license]
-          type, lurl = (file =~ /mit/i) ? 
-            normalize_licence("mit") : type_from_license_text(content)
+        if license
+          type, lurl = (file =~ /mit|gnu/i) ? 
+            normalize_licence(file.split(".").first) : type_from_license_text(content)
           break
         end
       end
@@ -92,24 +93,21 @@ module GemsLicenseFinder
       end
 
       README_FILES.each do |file|
-        next if info[:license] and type
-        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
-        type, lurl = normalize_licence(content) if content and type.nil?
-
-        info[:license] ||=  page_url + "#" + 
-          utf8_match(content,'<h\d+>.*?(license.*?)<\/h\d+>')[1].to_s.downcase.gsub(/\s/,"-") rescue nil
+        break if license and type
+        content = GitHub::Markup.render(file,fetch_github_file(user,repo,file)) rescue next
+        type, lurl = normalize_licence(content) if type.nil?
 
-        if info[:license] and type.nil?
-          type, lurl = type_from_license_text(content)
-        end
+        license ||= "https://github.com/#{user}/#{repo}/blob/master/#{file}#" + 
+          utf8_match(content,'<h\d+>.*?(license.*?)<\/h\d+>')[1].
+          to_s.downcase.gsub(/\s/,"-") rescue nil
 
+        type, lurl = type_from_license_text(content) if license and type.nil?
       end
 
+      info = {license: license, github_url: url}
       info[:license_type] = type if type
       info[:license_url] = lurl if lurl
-      info
+      rubygems.merge info
     end
 
     def utf8_match text, regex
@@ -130,6 +128,15 @@ module GemsLicenseFinder
       end
     end
 
+    def type_from_license_text t
+      LICENSES_STRINGS.each {|n,s| return normalize_licence(n) if utf8_match(t,s)}
+      nil
+    end
+
+    def normalize hash
+      Hash[hash.map {|k,v| [k.to_s.downcase.gsub(/\s/,"_"),v]}]
+    end
+
     def normalize_licence str
       case str.downcase
       when /(^|\W)mit(\W|$)/

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

@@ -1,3 +1,3 @@
 module GemsLicenseFinder
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gems-license-finder
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Eran Barak Levi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-25 00:00:00.000000000 Z
+date: 2014-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest