bibsonomy 0.4.5 → 0.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 095e2d069a16a1e1f74a13e2d86e05f90e0a7ea4
-  data.tar.gz: 04cd4ad56e5596f8198333cf4361a0c4e73054a0
+  metadata.gz: 60a51a2bb7d05aefff235013de9cd8cab94ca6c8
+  data.tar.gz: a89cbb97919dbefb6ceb9c08cc8b9892509c0b24
 SHA512:
-  metadata.gz: 9a8120c2f359eafbcf34feb26b5a7e642b905ccdff1c88c60edf2107bae1ade05d8a2a24c66ab01b91a64ff735a6f97d9b244d47f34b3ed5c59d93d3a0379747
-  data.tar.gz: 6f8de4d7c4e982b37e2d233a5d099717554435fba7ded75e9b9586e3ffdbf8c00e47df6e6af1bb624d471e88655ae2a48873ee8ce60863360abafc720a5c645c
+  metadata.gz: ce0a4005e5b141210c61fbc08a1a2961180c6e70b58cd3f68d3def639ffdf30361af41f944f13aa762e2f451ef803dff2100f23d3cae40fbb8ed8e9d2b26f420
+  data.tar.gz: dd70c37fddda3115fa62aaaddf383be4b0ec5201c3018417d6a73896f013e8ed82edf20f323b30e136338ab39a63ffe2b6664b3d32cd301b0f234d6322c6785c

data/README.md

@@ -1,6 +1,6 @@
 # BibSonomy
 
-BibSonomy client for Ruby
+[BibSonomy](http://www.bibsonomy.org/) client for Ruby
 
 [![Gem Version](https://badge.fury.io/rb/bibsonomy.svg)](http://badge.fury.io/rb/bibsonomy)
 [![Build Status](https://travis-ci.org/rjoberon/bibsonomy-ruby.svg?branch=master)](https://travis-ci.org/rjoberon/bibsonomy-ruby)
@@ -49,6 +49,26 @@ require 'bibsonomy/csl'
 print BibSonomy::main(ARGV)
 ```
 
+## Testing
+
+Get an API-Key from <http://www.bibsonomy.org/settings?selTab=1> and
+then run the following commands:
+
+```shell
+export BIBSONOMY_USER_NAME="yourusername"
+export BIBSONOMY_API_KEY="yourapikey"
+bundle exec rake test
+```
+
+## Supported API Calls
+
+- `get_post`: [post details](https://bitbucket.org/bibsonomy/bibsonomy/wiki/documentation/api/methods/DetailsForPost) 
+- `get_posts_for_user`:
+[posts for a user](https://bitbucket.org/bibsonomy/bibsonomy/wiki/documentation/api/methods/ListOfPostsForUser)
+- `get_posts_for_group` : posts for a group (= posts of the group members)
+- `get_document`: documents for post
+- `get_document_preview`: preview image for a document
+
 ## Jekyll
 
 A [Jekyll](http://jekyllrb.com/) plugin:
@@ -115,7 +135,10 @@ bibsonomy_document_directory: pdf
 bibsonomy_style: springer-lecture-notes-in-computer-science
 ```
 
-For an example, have a look at [my publication list](http://www.kbs.uni-hannover.de/~jaeschke/publications.html).
+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
+[my publication list](http://www.kbs.uni-hannover.de/~jaeschke/publications.html).
 
 
 ## Contributing

data/bibsonomy.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '~> 2.1'
+  spec.required_ruby_version = '>= 1.9'
   
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
@@ -31,6 +31,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency "faraday", "~> 0.9"
   spec.add_dependency "json", "~> 1.8"
   spec.add_dependency "citeproc", "~> 1.0"
+  spec.add_dependency "citeproc-ruby", "~> 1.0"
   spec.add_dependency "csl-styles", "~> 1.0"
+  spec.add_dependency "csl", "~> 1.2"
 
 end

data/lib/bibsonomy.rb

@@ -1,6 +1,7 @@
 require_relative "bibsonomy/version"
 require_relative "bibsonomy/post"
 require_relative "bibsonomy/api"
+require_relative "bibsonomy/csl"
 
 module BibSonomy
   # Your code goes here...  

data/lib/bibsonomy/api.rb

@@ -2,7 +2,6 @@
 require 'faraday'
 require 'json'
 
-
 # configuration options
 $API_URL = "https://www.bibsonomy.org/"
 $MAX_POSTS_PER_REQUEST = 20
@@ -20,6 +19,10 @@ $resource_types_bibtex = ['bibtex', 'pub', 'publication', 'publications', 'publ'
 # @todo getting more than 1000 posts
 #
 # @author Robert Jäschke
+#
+# Changes:
+# 2017-05-30 (rja)
+# - added get_posts_for_group
 # 
 module BibSonomy
   class API
@@ -102,6 +105,37 @@ module BibSonomy
       return response.body
     end
 
+    #
+    # Get the posts of the users of a group, optionally filtered by tags.
+    #
+    # @param group_name [String] the name of the group
+    # @param resource_type [String] the type of the post. Currently supported are 'bookmark' and 'publication'.
+    # @param tags [Array<String>] the tags that all posts must contain (can be empty)
+    # @param start [Integer] number of first post to download
+    # @param endc [Integer] number of last post to download
+    # @return [Array<BibSonomy::Post>, String] the requested posts
+    def get_posts_for_group(group_name, resource_type, tags = nil, start = 0, endc = $MAX_POSTS_PER_REQUEST)
+      params = {
+        :format => @format,
+        :resourcetype => get_resource_type(resource_type),
+        :start => start,
+        :end => endc,
+        :group => group_name
+      }
+      # add tags, if requested
+      if tags != nil
+        params[:tags] = tags.join(" ")
+      end
+      response = @conn.get "/api/posts", params
+
+      if @parse
+        posts = JSON.parse(response.body)["posts"]["post"]
+        return posts.map { |attributes| Post.new(attributes) }
+      end
+      return response.body
+    end
+
+    
     def get_document_href(user_name, intra_hash, file_name)
       return "/api/users/" + CGI.escape(user_name) + "/posts/" + CGI.escape(intra_hash) + "/documents/" + CGI.escape(file_name)
     end
@@ -127,11 +161,11 @@ module BibSonomy
     # @param user_name
     # @param intra_hash
     # @param file_name
-    # @param size
+    # @param size [String] requested preview size (allowed values: SMALL, MEDIUM, LARGE)
     # @return the preview image and the content type `image/jpeg`
     def get_document_preview(user_name, intra_hash, file_name, size)
-      response = get_document_href(user_name, intra_hash, file_name), { :preview => size }
-      if response.status = 200
+      response = @conn.get get_document_href(user_name, intra_hash, file_name), { :preview => size }
+      if response.status == 200
         return [response.body, 'image/jpeg']
       end
       return nil, nil

data/lib/bibsonomy/csl.rb

@@ -18,8 +18,12 @@ require 'bibsonomy'
 # - number of posts
 # - style
 # - directory
+# - group
 #
 # Changes:
+# 2017-01-19
+# - added optional parameter group to control which posts are
+#   included based on their viewability for a specific group (not yet activated!)
 # 2015-02-24
 # - initial version
 #
@@ -29,6 +33,7 @@ require 'bibsonomy'
 # @todo add intra_hash, user_name, etc. to CSL (cf. https://bitbucket.org/bibsonomy/bibsonomy/issue/2411/)
 # @todo integrate AJAX abstract
 # @todo make all options available via command line
+# @todo support filtering of posts by group (viewability)
 #
 # @author Robert Jäschke
 
@@ -68,6 +73,9 @@ module BibSonomy
     #   ignored. (default: '_oa.pdf')
     attr_accessor :public_doc_postfix
 
+    # @return [String] which posts shall be included, based on the groups they are viewable for
+    attr_accessor :group
+    
     #
     # Create a new BibSonomy instance.
     #
@@ -82,6 +90,7 @@ module BibSonomy
       @css_class = 'publications'
       @year_headings = true
       @public_doc_postfix = '_oa.pdf'
+      @group = 'public'
 
       # optional parts to be rendered (or not)
       @doi_link = true
@@ -109,6 +118,17 @@ module BibSonomy
       # to check for duplicate file names
       file_names = []
 
+      # filter posts by group
+      # 2017-05-30, rja, disabled until group information is returned by the API
+      # posts.delete_if do |v|
+      #   if v["group"] == @group
+      #     true
+      #   else
+      #     print("WARN: " + v["group"])
+      #     false
+      #   end
+      # end
+
       # sort posts by year
       sorted_keys = posts.keys.sort { |a,b| get_sort_posts(posts[b], posts[a]) }
 
@@ -190,7 +210,16 @@ module BibSonomy
     private
     
     def get_year(post)
-      return post["issued"]["literal"]
+      issued = post["issued"]
+      # if the post contains only a "year" field, it is contained in
+      # the field "literal"
+      if issued["literal"]
+        return issued["literal"]
+      else
+        # otherwise, the date can be contained in the "raw" field
+        # TODO: extract the year ([12][0-9]{3}) from that field
+        return issued["raw"]
+      end
     end
 
     def get_sort_posts(a, b)
@@ -202,6 +231,8 @@ module BibSonomy
       if person_b.length == 0
         person_b = b["editor"]
       end
+      # we switch the order of person_b and person_a, to sort
+      # descending by year but ascending by person name
       return [get_year(a), a["type"], person_b[0]["family"]] <=> [get_year(b), b["type"], person_a[0]["family"]]
     end
 
@@ -275,6 +306,7 @@ module BibSonomy
     options.directory = nil
     options.tags = []
     options.style = "apa.csl"
+    options.group = "public"
     options.posts = 1000
 
     opt_parser = OptionParser.new do |opts|
@@ -289,6 +321,7 @@ module BibSonomy
       opts.on('-u', '--user USER', 'return posts for USER instead of user') { |v| options[:user] = 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('-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 }
 
@@ -333,13 +366,14 @@ module BibSonomy
 
     # 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]
 
     html = csl.render(options[:user], options[:tags], options[:posts])
 

data/lib/bibsonomy/post.rb

@@ -3,7 +3,7 @@
 module BibSonomy
   class Post
 
-    attr_reader :user_name, :intra_hash, :title, :year, :entrytype, :booktitle, :journal, :url
+    attr_reader :user_name, :intra_hash, :groups, :title, :year, :entrytype, :booktitle, :journal, :url
 
     def initialize(post)
       publication = post["bibtex"]
@@ -15,6 +15,11 @@ module BibSonomy
       @booktitle = publication["booktitle"]
       @journal = publication["journal"]
       @url = publication["url"]
+      # extract group names
+      @groups = []
+      post["group"].each do |group|
+        @groups << group["name"]
+      end
     end
 
   end

data/lib/bibsonomy/version.rb

@@ -1,3 +1,3 @@
 module BibSonomy
-  VERSION = "0.4.5"
+  VERSION = "0.4.6"
 end

data/test/csl_test.rb

@@ -0,0 +1,21 @@
+require './test/test_helper'
+
+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("bibsonomy-ruby", [], 10)
+
+      assert_equal "<h3>2010</h3>", html[0..12]
+      assert_equal "</ul>", html[-6..-2]
+    end
+  end
+end

data/test/post_test.rb

@@ -11,8 +11,8 @@ class BibSonomyPostTest < Minitest::Test
     assert BibSonomy::API
   end
   
-  def test_find_post
-    VCR.use_cassette('one_post') do
+  def test_get_post
+    VCR.use_cassette('get_post') do
       post = @api.get_post("bibsonomy-ruby", "c9437d5ec56ba949f533aeec00f571e3")
       assert_equal BibSonomy::Post, post.class
       
@@ -24,8 +24,8 @@ class BibSonomyPostTest < Minitest::Test
     end
   end
 
-  def test_find_posts
-    VCR.use_cassette('all_posts') do
+  def test_get_posts_for_user
+    VCR.use_cassette('get_posts_for_user') do
       result = @api.get_posts_for_user("bibsonomy-ruby", "publication", ["test"], 0, 20)
       
       # Make sure we got all the posts
@@ -36,4 +36,39 @@ class BibSonomyPostTest < Minitest::Test
       assert result.first.kind_of?(BibSonomy::Post)
     end      
   end
+
+  def test_get_posts_for_group
+    VCR.use_cassette('get_posts_for_group') do
+      result = @api.get_posts_for_group("iccs", "publication", ["test"], 0, 10)
+      
+      # Make sure we got all the posts
+      assert_equal 2, result.length
+      
+      # Make sure that the JSON was parsed
+      assert result.kind_of?(Array)
+      assert result.first.kind_of?(BibSonomy::Post)
+    end      
+  end
+
+  def test_get_document_href
+    assert_equal "/api/users/bibsonomy-ruby/posts/c9437d5ec56ba949f533aeec00f571e3/documents/paper.pdf", @api.get_document_href("bibsonomy-ruby", "c9437d5ec56ba949f533aeec00f571e3", "paper.pdf")
+  end
+
+  def test_get_document
+    VCR.use_cassette('get_document') do
+      pdf, mimetype = @api.get_document("bibsonomy-ruby", "c9437d5ec56ba949f533aeec00f571e3", "test.pdf")
+      assert_equal "application/octet-stream;charset=UTF-8", mimetype
+      assert_equal "A test file\n", pdf
+    end
+  end
+
+
+  def test_get_document_preview
+    VCR.use_cassette('get_document_preview') do
+      jpeg, mimetype = @api.get_document_preview("bibsonomy-ruby", "c9437d5ec56ba949f533aeec00f571e3", "test.pdf", "SMALL")
+      assert_equal "image/jpeg", mimetype
+      assert_equal ["ffd8ffe00010"].pack('H*') + "JFIF", jpeg[0..9]
+    end
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bibsonomy
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.4.6
 platform: ruby
 authors:
 - Robert Jäschke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-26 00:00:00.000000000 Z
+date: 2017-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -150,6 +150,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: citeproc-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: csl-styles
   requirement: !ruby/object:Gem::Requirement
@@ -164,6 +178,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: csl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 description: Enables calls to the BibSonomy REST API with Ruby.
 email:
 - jaeschke@l3s.de
@@ -183,6 +211,7 @@ files:
 - lib/bibsonomy/csl.rb
 - lib/bibsonomy/post.rb
 - lib/bibsonomy/version.rb
+- test/csl_test.rb
 - test/post_test.rb
 - test/test_helper.rb
 homepage: https://github.com/rjoberon/bibsonomy-ruby
@@ -195,9 +224,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '2.1'
+      version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -210,6 +239,6 @@ signing_key:
 specification_version: 4
 summary: Wraps the BibSonomy REST API.
 test_files:
+- test/csl_test.rb
 - test/post_test.rb
 - test/test_helper.rb
-has_rdoc: