bibsonomy 0.4.9 → 0.4.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a49f98d282f7af4fe43e57572ebed332a8edeeb0
-  data.tar.gz: b67833cb0964c9c5059b157d9aee5658935ee013
+  metadata.gz: d663777e3f80abee1893b48f69ea63285cd46831
+  data.tar.gz: ca800a9b1edb0089388c45a2fa374c68c2e6e908
 SHA512:
-  metadata.gz: ed3024658f649b2566b79ed6588fb89a986fb6daffaeec750c32e3c9520e50d05c24850ee993db04abfdccbff02fb029bf2bab57864a26c7389d9383767ed0b3
-  data.tar.gz: 5756909805eff1c0286018cf8745233db2909c55bc0451e12d9a097caf0866e7d04676badaaeec5deda258837e70cce509dc7def0c62d9feb50ad7bf41bd974b
+  metadata.gz: 3d59edc42adcc225fb04725882d0752ef68f19850173e1cdc847e5634eb205f6cd1946ae5bdcbf0baa673b90e82a095ba1d633eefd95939cdfa9b972969de0e9
+  data.tar.gz: b71cd309c671a5514522cb55a9086085d7a2d68a2bcc4faef886858a2bc4553409f13cfc3f05b973dcc9666ff8731d983ef389064fcaa240767553557ce48b48

data/bibsonomy.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.summary       = %q{Wraps the BibSonomy REST API.}
   spec.description   = %q{Enables calls to the BibSonomy REST API with Ruby.}
   spec.homepage      = "https://github.com/rjoberon/bibsonomy-ruby"
-  spec.license       = "LGPL 2.1"
+  spec.license       = "LGPL-2.1"
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "simplecov", '~> 0.7'
   
   spec.add_dependency "faraday", "~> 0.9"
-  spec.add_dependency "json", "~> 1.8"
+  spec.add_dependency "json", "~> 2.0"
   spec.add_dependency "citeproc", "~> 1.0"
   spec.add_dependency "citeproc-ruby", "~> 1.0"
   spec.add_dependency "csl-styles", "~> 1.0"

data/lib/bibsonomy/csl.rb

@@ -19,8 +19,12 @@ require 'bibsonomy'
 # - style
 # - directory
 # - group
+# - altmetric
 #
 # Changes:
+# 2017-07-05 (rja)
+# - added support for Altmetric badges
+# - adapted options for command line use to support groups
 # 2017-06-06 (rja)
 # - added support for DOIs which are actually URLs (i.e., include the resolver)
 # 2017-05-31 (rja)
@@ -71,6 +75,9 @@ module BibSonomy
     # @return [String] the separator between options. (default: ' | ')
     attr_accessor :opt_sep
 
+    # @return [String] the badge type for embedded Altmetric badges. If set to `nil`, no badge is included. (default: `nil`)
+    attr_accessor :altmetric_badge_type
+
     # @return [String] When a post has several documents and the
     #   filename of one of them ends with `public_doc_postfix`, only
     #   this document is downloaded and linked, all other are
@@ -95,6 +102,7 @@ module BibSonomy
       @year_headings = true
       @public_doc_postfix = '_oa.pdf'
       @group = 'public'
+      @altmetric_badge_type = nil
 
       # optional parts to be rendered (or not)
       @doi_link = true
@@ -202,6 +210,12 @@ module BibSonomy
           result += " <span class='opt'>[" + options.join(@opt_sep) + "]</span>"
         end
 
+        # attach Altmetric badge
+        if @altmetric_badge_type and doi != ""
+          doi, doi_url = get_doi(doi)
+          result += "<div class='altmetric-embed' data-badge-type='#{@altmetric_badge_type}' data-doi='#{doi}'></div>"
+        end
+
         result += "</li>\n"
       end
       result += "</ul>\n"
@@ -327,7 +341,8 @@ module BibSonomy
     options.directory = nil
     options.tags = []
     options.style = "apa.csl"
-    options.group = "public"
+    options.viewable_group = "public"
+    options.altmetric = nil
     options.posts = 1000
 
     opt_parser = OptionParser.new do |opts|
@@ -339,12 +354,14 @@ module BibSonomy
       # mandatory arguments are handled separately
 
       # optional arguments
-      opts.on('-u', '--user USER', 'return posts for USER instead of user') { |v| options[:user] = v }
+      opts.on('-u', '--user USER', 'get posts for USER') { |v| options[:user] = v }
+      opts.on('-g', '--group GROUP', 'get posts for GROUP') { |v| options[:group] = v }
       opts.on('-t', '--tags TAG,TAG,...', Array, 'return posts with the given tags') { |v| options[:tags] = v }
       opts.on('-s', '--style STYLE', 'use CSL style STYLE for rendering') { |v| options[:style] = v }
-      opts.on('-g', '--group GROUP', 'include only posts viewable for GROUP') { |v| options[:group] = v }
+      opts.on('--viewable-group GROUP', 'include only posts viewable for GROUP') { |v| options[:viewable_group] = v }
       opts.on('-n', '--number-of-posts [COUNT]', Integer, 'number of posts to download') { |v| options[:posts] = v }
       opts.on('-d', '--directory DIR', 'target directory', '  (if not given, no documents are downloaed)') { |v| options[:directory] = v }
+      opts.on('-a', '--altmetric TYPE', 'render Altmetric badge with type TYPE') { |v| options[:altmetric] = v }
 
       opts.separator ""
       opts.separator "Common options:"
@@ -385,18 +402,29 @@ module BibSonomy
       exit
     end
 
-    # set defaults for optional arguments
-    options[:user] = options[:user_name] unless options[:user]
-
     #
     # do the actual work
     #
     csl = BibSonomy::CSL.new(options[:user_name], options[:api_key])
     csl.pdf_dir = options[:directory]
     csl.style = options[:style]
-    csl.group = options[:group]
+    csl.group = options[:viewable_group]
+    csl.altmetric_badge_type = options[:altmetric]
+
+    if options[:group]
+      grouping = "group"
+      name = options[:group]
+    elsif options[:user]
+      grouping = "user"
+      name = options[:user]
+    else
+      # default: API user
+      grouping = "user"
+      name = options[:user_name]
+    end
 
-    html = csl.render(options[:user], options[:tags], options[:posts])
+    puts "call: #{grouping}, #{name}"
+    html = csl.render(grouping, name, options[:tags], options[:posts])
 
     return html
 

data/lib/bibsonomy/version.rb

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

data/test/csl_test.rb

@@ -19,17 +19,40 @@ class BibSonomyCSLTest < Minitest::Test
     end
   end
 
+  def test_render_all
+    VCR.use_cassette('render_all') do
+      html = @csl.render("user", "bibsonomy-ruby", [], 10)
+
+      assert_equal "<h3>2015</h3>", html[0..12]
+      assert_equal "<h3>2010</h3>", html[765..777]
+      assert_equal "</ul>", html[-6..-2]
+    end
+  end
+
   def test_render_doi
-    VCR.use_cassette('render') do
+    VCR.use_cassette('render_doi') 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]
+      assert_equal "DOI:<a href='https://dx.doi.org/10.1007/s00778-010-0208-4'>10.1007/s00778-010-0208-4</a>", html[339,88]
+    end
+  end
 
+  def test_render_broken_doi
+    VCR.use_cassette('render_broken_doi') do
       # 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]
+      # 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[374,83]
     end
   end
 
+  def test_get_docs
+    VCR.use_cassette('get_docs') do
+      # DOI is a URL
+      @csl.pdf_dir = "docs"
+      html = @csl.render("user", "bibsonomy-ruby", ["test", "doiok"], 10)
+
+      assert_equal "<a href='docs/test.pdf'>PDF</a>", html[339,31]
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bibsonomy
 version: !ruby/object:Gem::Version
-  version: 0.4.9
+  version: 0.4.10
 platform: ruby
 authors:
 - Robert Jäschke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-06 00:00:00.000000000 Z
+date: 2017-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -128,14 +128,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: citeproc
   requirement: !ruby/object:Gem::Requirement
@@ -216,7 +216,7 @@ files:
 - test/test_helper.rb
 homepage: https://github.com/rjoberon/bibsonomy-ruby
 licenses:
-- LGPL 2.1
+- LGPL-2.1
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -234,7 +234,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Wraps the BibSonomy REST API.