bibsonomy 0.4.8 → 0.4.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2dc63bd9e3b259ddf0c5808f4f7c2aaf70a86ae0
-  data.tar.gz: 68b95dc7e2123f176cf04ee8df9bd959fa3d99e4
+  metadata.gz: a49f98d282f7af4fe43e57572ebed332a8edeeb0
+  data.tar.gz: b67833cb0964c9c5059b157d9aee5658935ee013
 SHA512:
-  metadata.gz: 9946d9fb4ab157a8d5b2509b86cbb67ad46cc5458793a08878368b41d46c24f37b499a15fdc7d00853938e194431f348dce9527d39c152c3e3a42428f83dc9a5
-  data.tar.gz: 1d9e13932a6e3e4d85f91a95b58d9487f89a824760f78888593a925e5c93881190c47e944bca32e60b0ffb155751e5d4de735af784039f5139d61f48129d764f
+  metadata.gz: ed3024658f649b2566b79ed6588fb89a986fb6daffaeec750c32e3c9520e50d05c24850ee993db04abfdccbff02fb029bf2bab57864a26c7389d9383767ed0b3
+  data.tar.gz: 5756909805eff1c0286018cf8745233db2909c55bc0451e12d9a097caf0866e7d04676badaaeec5deda258837e70cce509dc7def0c62d9feb50ad7bf41bd974b

data/README.md

@@ -72,76 +72,12 @@ bundle exec rake test
 
 ## Jekyll
 
-A [Jekyll](http://jekyllrb.com/) plugin:
-
-```ruby
-# coding: utf-8
-require 'time'
-require 'bibsonomy/csl'
-
-module Jekyll
-
-  class BibSonomyPostList < Liquid::Tag
-    def initialize(tag_name, text, tokens)
-      super
-      parts = text.split(/\s+/)
-      @user = parts[0]
-      @tag = parts[1]
-      @count = Integer(parts[2])
-    end
-
-    def render(context)
-      site = context.registers[:site]
-
-      # user name and API key for BibSonomy
-      user_name = site.config['bibsonomy_user']
-      api_key = site.config['bibsonomy_apikey']
-      csl = BibSonomy::CSL.new(user_name, api_key)
-
-      # target directory for PDF documents
-      pdf_dir = site.config['bibsonomy_document_directory']
-      csl.pdf_dir = pdf_dir
-
-      # CSL style for rendering
-      style = site.config['bibsonomy_style']
-      csl.style = style
-
-      html = csl.render(@user, [@tag], @count)
-
-      # set date to now
-      context.registers[:page]["date"] = Time.new
-
-      return html
-    end
-  end
-
-end
-
-Liquid::Template.register_tag('bibsonomy', Jekyll::BibSonomyPostList)
-```
-
-The plugin can be used inside Markdown files as follows:
-
-```Liquid
-{% bibsonomy jaeschke myown 100 %}
-```
-
-Add the following options to your `_config.yml`:
-
-```YAML
-bibsonomy_user: yourusername
-bibsonomy_apikey: yourapikey
-bibsonomy_document_directory: pdf
-# other: apa, acm-siggraph
-bibsonomy_style: springer-lecture-notes-in-computer-science
-```
-
-For an example how to use the Jekyll plugin, have a look at
-[the demo project](https://github.com/rjoberon/bibsonomy-jekyll-demo)
-and for an example showing the output, have a look at
+This gem is used by the
+[BibSonomy plugin](https://github.com/rjoberon/bibsonomy-jekyll) for
+[Jekyll](http://jekyllrb.com/) to render post lists in Jekyll web
+sites. For an example output, have a look at
 [my publication list](http://www.kbs.uni-hannover.de/~jaeschke/publications.html).
 
-
 ## Contributing
 
 1. Fork it ( https://github.com/rjoberon/bibsonomy-ruby/fork )

data/lib/bibsonomy/csl.rb

@@ -21,12 +21,14 @@ require 'bibsonomy'
 # - group
 #
 # Changes:
-# 2017-05-31
+# 2017-06-06 (rja)
+# - added support for DOIs which are actually URLs (i.e., include the resolver)
+# 2017-05-31 (rja)
 # - added support to get posts of a group
-# 2017-01-19
+# 2017-01-19 (rja)
 # - added optional parameter group to control which posts are
 #   included based on their viewability for a specific group (not yet activated!)
-# 2015-02-24
+# 2015-02-24 (rja)
 # - initial version
 #
 # @todo escape data
@@ -41,7 +43,7 @@ require 'bibsonomy'
 
 module BibSonomy
   class CSL
-    
+
     # @return [String] the output directory for downloaded PDF files. If set to `nil`, no documents are downloaded. (default: `nil`)
     attr_accessor :pdf_dir
 
@@ -59,7 +61,7 @@ module BibSonomy
 
     # @return [Boolean] whether URLs of posts shall be rendered. (default: `true`)
     attr_accessor :url_link
-    
+
     # @return [Boolean] whether links to the BibTeX data of a post (in BibSonomy) shall be rendered. (default: `true`)
     attr_accessor :bibtex_link
 
@@ -77,12 +79,12 @@ module BibSonomy
 
     # @return [String] which posts shall be included, based on the groups they are viewable for
     attr_accessor :group
-    
+
     #
     # Create a new BibSonomy instance.
     #
     # @param user_name [String] the BibSonomy user name
-    # @param api_key [String] the API key of the user (get at http://www.bibsonomy.org/settings?selTab=1)
+    # @param api_key [String] the API key of the user (get at https://www.bibsonomy.org/settings?selTab=1)
     def initialize(user_name, api_key)
       super()
       @bibsonomy = BibSonomy::API.new(user_name, api_key, 'csl')
@@ -178,7 +180,8 @@ module BibSonomy
         # attach DOI
         doi = post["DOI"]
         if @doi_link and doi != ""
-          options << "DOI:<a href='http://dx.doi.org/#{doi}'>#{doi}</a>"
+          doi, doi_url = get_doi(doi)
+          options << "DOI:<a href='#{doi_url}'>#{doi}</a>"
         end
         # attach URL
         url = post["URL"]
@@ -187,11 +190,11 @@ module BibSonomy
         end
         # attach BibTeX
         if @bibtex_link
-          options << "<a href='http://www.bibsonomy.org/bib/publication/#{intra_hash}/#{user_name}'>BibTeX</a>"
+          options << "<a href='https://www.bibsonomy.org/bib/publication/#{intra_hash}/#{user_name}'>BibTeX</a>"
         end
         # attach link to BibSonomy
         if @bibsonomy_link
-          options << "<a href='http://www.bibsonomy.org/publication/#{intra_hash}/#{user_name}'>BibSonomy</a>"
+          options << "<a href='https://www.bibsonomy.org/publication/#{intra_hash}/#{user_name}'>BibSonomy</a>"
         end
 
         # attach options
@@ -211,7 +214,22 @@ module BibSonomy
     # private methods follow
     #
     private
-    
+
+    # given a DOI (or a URL with a DOI) return DOI and resolvable URL
+    def get_doi(doi)
+      # simplistic check whether DOI is a URL
+      if doi.start_with?("http")
+        # extract DOI, regex from https://www.crossref.org/blog/dois-and-matching-regular-expressions/
+        if doi =~ /(10.\d{4,9}\/[-._;()\/:A-Z0-9]+)/i
+          return $1, doi
+        else
+          return doi, doi
+        end
+      else
+        return doi, "https://dx.doi.org/#{doi}"
+      end
+    end
+
     def get_year(post)
       issued = post["issued"]
       # if the post contains only a "year" field, it is contained in
@@ -369,7 +387,7 @@ module BibSonomy
 
     # set defaults for optional arguments
     options[:user] = options[:user_name] unless options[:user]
-    
+
     #
     # do the actual work
     #

data/lib/bibsonomy/version.rb

@@ -1,3 +1,3 @@
 module BibSonomy
-  VERSION = "0.4.8"
+  VERSION = "0.4.9"
 end

data/test/csl_test.rb

@@ -5,17 +5,31 @@ class BibSonomyCSLTest < Minitest::Test
   def setup
     @csl = BibSonomy::CSL.new(ENV['BIBSONOMY_USER_NAME'], ENV['BIBSONOMY_API_KEY'])
   end
-  
+
   def test_exists
     assert BibSonomy::CSL
   end
-  
+
   def test_render
     VCR.use_cassette('render') do
-      html = @csl.render("user", "bibsonomy-ruby", [], 10)
+      html = @csl.render("user", "bibsonomy-ruby", ["doiok"], 10)
 
       assert_equal "<h3>2010</h3>", html[0..12]
       assert_equal "</ul>", html[-6..-2]
     end
   end
+
+  def test_render_doi
+    VCR.use_cassette('render') do
+      html = @csl.render("user", "bibsonomy-ruby", ["doiok"], 10)
+      # DOI is correct
+      assert_equal "DOI:<a href='https://dx.doi.org/10.1007/s00778-010-0208-4'>10.1007/s00778-010-0208-4</a>", html[338,88]
+
+      # DOI is a URL
+      html = @csl.render("user", "bibsonomy-ruby", ["brokendoi", "test"], 10)
+      # thus we have http not https!
+      assert_equal "DOI:<a href='http://dx.doi.org/10.1145/2786451.2786927'>10.1145/2786451.2786927</a>", html[373,83]
+    end
+  end
+
 end

data/test/post_test.rb

@@ -29,7 +29,7 @@ class BibSonomyPostTest < Minitest::Test
       result = @api.get_posts_for_user("bibsonomy-ruby", "publication", ["test"], 0, 20)
       
       # Make sure we got all the posts
-      assert_equal 1, result.length
+      assert_equal 2, result.length
       
       # Make sure that the JSON was parsed
       assert result.kind_of?(Array)
@@ -55,7 +55,7 @@ class BibSonomyPostTest < Minitest::Test
       result = @api.get_posts("user", "bibsonomy-ruby", "publication", ["test"], 0, 10)
       
       # Make sure we got all the posts
-      assert_equal 1, result.length
+      assert_equal 2, result.length
       
       # Make sure that the JSON was parsed
       assert result.kind_of?(Array)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bibsonomy
 version: !ruby/object:Gem::Version
-  version: 0.4.8
+  version: 0.4.9
 platform: ruby
 authors:
 - Robert Jäschke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-31 00:00:00.000000000 Z
+date: 2017-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler