bibsonomy 0.4.6 → 0.4.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 60a51a2bb7d05aefff235013de9cd8cab94ca6c8
-  data.tar.gz: a89cbb97919dbefb6ceb9c08cc8b9892509c0b24
+  metadata.gz: cfc29c3c38865ebf77e49be3e526070ea1c596f9
+  data.tar.gz: 9ed678b079893cbe99a7f3cbd1614ebcebef197e
 SHA512:
-  metadata.gz: ce0a4005e5b141210c61fbc08a1a2961180c6e70b58cd3f68d3def639ffdf30361af41f944f13aa762e2f451ef803dff2100f23d3cae40fbb8ed8e9d2b26f420
-  data.tar.gz: dd70c37fddda3115fa62aaaddf383be4b0ec5201c3018417d6a73896f013e8ed82edf20f323b30e136338ab39a63ffe2b6664b3d32cd301b0f234d6322c6785c
+  metadata.gz: 9eba9e923dfb6e4c149a741d32513d01f2351ddb3a2a783ee5f79060daa182c5ef6f47c9a560cc876977d61d7e4cb1dcc34f85142924fabdea79899540919f98
+  data.tar.gz: 652a1e547c8460df327387b5a9ba27f5320e87b6a3a63bd77a1f5733f18d9d480adbba09e58e1c84d491f6958338be1d848f07537040822e6d0809180c73874b

data/README.md

@@ -68,6 +68,7 @@ bundle exec rake test
 - `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
+- `get_posts`: [posts for a user or group](https://bitbucket.org/bibsonomy/bibsonomy/wiki/documentation/api/methods/ListOfAllPosts)
 
 ## Jekyll
 

data/lib/bibsonomy/api.rb

@@ -21,9 +21,11 @@ $resource_types_bibtex = ['bibtex', 'pub', 'publication', 'publications', 'publ'
 # @author Robert Jäschke
 #
 # Changes:
+# 2017-05-31 (rja)
+# - refactored get_posts_for_group and get_posts_for_user into get_posts
 # 2017-05-30 (rja)
 # - added get_posts_for_group
-# 
+#
 module BibSonomy
   class API
 
@@ -86,23 +88,7 @@ module BibSonomy
     # @param endc [Integer] number of last post to download
     # @return [Array<BibSonomy::Post>, String] the requested posts
     def get_posts_for_user(user_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
-      }
-      # add tags, if requested
-      if tags != nil
-        params[:tags] = tags.join(" ")
-      end
-      response = @conn.get "/api/users/" + CGI.escape(user_name) + "/posts", params
-
-      if @parse
-        posts = JSON.parse(response.body)["posts"]["post"]
-        return posts.map { |attributes| Post.new(attributes) }
-      end
-      return response.body
+      return get_posts("user", user_name, resource_type, tags, start, endc)
     end
 
     #
@@ -115,17 +101,37 @@ module BibSonomy
     # @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)
+      return get_posts("group", group_name, resource_type, tags, start, endc)
+    end
+
+    #
+    # Get posts for a user or group, optionally filtered by tags.
+    #
+    # @param grouping [String] the type of the name (either "user" or "group")
+    # @param name [String] the name of the group or user
+    # @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(grouping, 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
+        :end => endc
       }
+      # decide what to get
+      if grouping == "user"
+        params[:user] = name
+      elsif grouping == "group"
+        params[:group] = name
+      end
       # add tags, if requested
       if tags != nil
         params[:tags] = tags.join(" ")
       end
+
       response = @conn.get "/api/posts", params
 
       if @parse
@@ -135,7 +141,7 @@ module BibSonomy
       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
@@ -172,9 +178,9 @@ module BibSonomy
     end
 
 
-    
+
     private
-    
+
     #
     # Convenience method to allow sloppy specification of the resource
     # type.

data/lib/bibsonomy/version.rb

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

data/test/post_test.rb

@@ -50,6 +50,33 @@ class BibSonomyPostTest < Minitest::Test
     end      
   end
 
+  def test_get_posts_user
+    VCR.use_cassette('get_posts_user') do
+      result = @api.get_posts("user", "bibsonomy-ruby", "publication", ["test"], 0, 10)
+      
+      # Make sure we got all the posts
+      assert_equal 1, 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_posts_group
+    VCR.use_cassette('get_posts_group') do
+      result = @api.get_posts("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

metadata

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