bibsonomy 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 744185c9e820f247763e9318fff488955e65bf01
-  data.tar.gz: 271d38a9ce805a00cc4063ec884e50a6d0c5e18d
+  metadata.gz: c8d9d23c1914cd4715fa7c9642e3b116c98d7b4b
+  data.tar.gz: 880c61defc6356d790ac26c65538d9bb084c57a7
 SHA512:
-  metadata.gz: a01f839150ecb55c934f2d4894a114ae39aa4869337cb8c0bb4bfe706860d1cfc9469d33198cd72babc28c6e53c0ae517cd788ae67ecfd1e1dc59356fa3b5dba
-  data.tar.gz: ecc8ef451e0339579cd93d2950800d7609369b47dc84f521bf50fc040546e31e3a83102bdca779e52f81b5756f584b9ec9007dd7e4a61471e05c5d330ba08faf
+  metadata.gz: a86ad6a98c4f48621c6baca09b8159707540c474fa55c21f2b10e047e1d50e623ef4825623b022aba748058e16dd6998f413a6d4baa9d27d50ce88c7c62a1898
+  data.tar.gz: f74e7b55616b18ed0db1602b58e0ae85cb31094780fa52ca170c144ded2af7bd079599cbe6df8873d8a3d6406cad2795138edec54a4a5b83be3ea3fb0b2feff6

data/lib/bibsonomy/api.rb

@@ -2,11 +2,6 @@
 require 'faraday'
 require 'json'
 
-#
-# TODO:
-# - error handling
-# - getting more than 1000 posts
-#
 
 # configuration options
 $API_URL = "https://www.bibsonomy.org/"
@@ -21,17 +16,18 @@ $resource_types_bibtex = ['bibtex', 'pub', 'publication', 'publications', 'publ'
 #
 # The BibSonomy REST client for Ruby.
 #
+# @todo error handling
+# @todo getting more than 1000 posts
+#
+# @author Robert Jäschke
+# 
 module BibSonomy
   class API
 
     # Initializes the client with the given credentials.
     #
-    # @param user_name [String] The name of the user account used for
-    # accessing the API
-    #
-    # @param api_key [String] The API key corresponding to the user
-    # account - can be obtained from
-    # http://www.bibsonomy.org/settings?selTab=1
+    # @param user_name [String] the name of the user account used for accessing the API
+    # @param api_key [String] the API key corresponding to the user account - can be obtained from http://www.bibsonomy.org/settings?selTab=1
     #
     # @param format [String] The requested return format. One of:
     # 'xml', 'json', 'ruby', 'csl', 'bibtex'. The default is 'ruby'
@@ -64,11 +60,9 @@ module BibSonomy
     #
     # Get a single post
     #
-    # Params:
-    # +user_name+:: [String] The name of the post's owner.
-    # +intra_hash+:: [String] The intrag hash of the post.
-    # +return+:: [BibSonomy::Post] the requested post
-    #
+    # @param user_name [String] the name of the post's owner
+    # @param intra_hash [String] the intrag hash of the post
+    # @return [BibSonomy::Post, String] the requested post
     def get_post(user_name, intra_hash)
       response = @conn.get "/api/users/" + CGI.escape(user_name) + "/posts/" + CGI.escape(intra_hash), { :format => @format }
 
@@ -82,12 +76,12 @@ module BibSonomy
     #
     # Get posts owned by a user, optionally filtered by tags.
     #
-    # Params:
-    # +user_name+:: [String] The name of the posts' owner.
-    # +resource_type+:: [String] The type of the post. Currently supported are 'bookmark' and 'publication'.
-    # +tags+::
-    # +start+::
-    # +endc+::
+    # @param user_name [String] the name of the posts' owner
+    # @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_user(user_name, resource_type, tags = nil, start = 0, endc = $MAX_POSTS_PER_REQUEST)
       params = {
         :format => @format,
@@ -115,10 +109,10 @@ module BibSonomy
     #
     # Get a document belonging to a post.
     #
-    # Params:
-    # +user_name+::
-    # +intra_hash+::
-    # +file_name+::
+    # @param user_name
+    # @param intra_hash
+    # @param file_name
+    # @return the document and the content type
     def get_document(user_name, intra_hash, file_name)
       response = @conn.get get_document_href(user_name, intra_hash, file_name)
       if response.status == 200
@@ -130,11 +124,11 @@ module BibSonomy
     #
     # Get the preview for a document belonging to a post.
     #
-    # Params:
-    # +user_name+::
-    # +intra_hash+::
-    # +file_name+::
-    # +size+::
+    # @param user_name
+    # @param intra_hash
+    # @param file_name
+    # @param size
+    # @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

data/lib/bibsonomy/csl.rb

@@ -23,64 +23,56 @@ require 'bibsonomy'
 # 2015-02-24
 # - initial version
 #
-# TODO:
-# - escape data
-# - make sorting, etc. configurable
-# - automatically rename files (TODO: CSL lacks BibTeX key)
-# - add intra_hash, user_name, etc. to CSL (cf. https://bitbucket.org/bibsonomy/bibsonomy/issue/2411/)
-# - integrate AJAX abstract
-# - make all options available via command line
+# @todo escape data
+# @todo make sorting, etc. configurable
+# @todo automatically rename files (TODO: CSL lacks BibTeX key)
+# @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
+#
+# @author Robert Jäschke
 
 module BibSonomy
   class CSL
-    ##
-    # :attr_accessor: pdf_dir
-    # The output directory for downloaded PDF files. If set to +nil+, no documents are downloaded. (default: +nil+)
-
-    ##
-    # :attr_accessor: style
-    # The CSL[http://citationstyles.org/] style used for rendering. (default: +apa.csl+)
-
-    ##
-    # :attr_accessor: year_headings
-    # A boolean indicating whether year headings shall be rendered. (default: enabled)
+    
+    # @return [String] the output directory for downloaded PDF files. If set to `nil`, no documents are downloaded. (default: `nil`)
+    attr_accessor :pdf_dir
 
-    ##
-    # :attr_accessor: css_class
-    # The CSS class used to render the surrounding +<ul>+ list (default: 'publications')
+    # @return [String] the {http://citationstyles.org/ CSL} style used for rendering. (default: `apa.csl`)
+    attr_accessor :style
 
-    ##
-    # :attr_accessor: doi_link
-    # A boolean indicating whether links for DOIs shall be rendered. (default: true)
+    # @return [Boolean] whether year headings shall be rendered. (default: `true`)
+    attr_accessor :year_headings
 
-    ##
-    # :attr_accessor: url_link
-    # A boolean indicating whether URLs of posts shall be rendered. (default: true)
+    # @return [String] the CSS class used to render the surrounding `<ul>` list (default: 'publications')
+    attr_accessor :css_class
 
-    ##
-    # :attr_accessor: bibtex_link
-    # A boolean indicating whether links to the BibTeX data of a post (in BibSonomy) shall be rendered. (default: true)
+    # @return [Boolean] whether links for DOIs shall be rendered. (default: `true`)
+    attr_accessor :doi_link
 
-    ##
-    # :attr_accessor: bibsonomy_link
-    # A boolean indicating whether links  BibSonomy shall be rendered. (default: true)
+    # @return [Boolean] whether URLs of posts shall be rendered. (default: `true`)
+    attr_accessor :url_link
     
-    ##
-    # :attr_accessor: opt_sep
-    # The separator between options. (default: ' | ')
+    # @return [Boolean] whether links to the BibTeX data of a post (in BibSonomy) shall be rendered. (default: `true`)
+    attr_accessor :bibtex_link
 
-    ##
-    # :attr_accessor: public_doc_postfix
-    # 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 ignored. (default: '_oa.pdf')
+    # @return [Boolean] whether links to BibSonomy shall be rendered. (default: `true`)
+    attr_accessor :bibsonomy_link
 
-    # publicly accessible attributes
-    attr_accessor :style, :pdf_dir, :css_class, :year_headings, :public_doc_postfix, :doi_link, :url_link, :bibtex_link, :bibsonomy_link, :opt_sep
+    # @return [String] the separator between options. (default: ' | ')
+    attr_accessor :opt_sep
 
+    # @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
+    # ignored. (default: '_oa.pdf')
+    attr_accessor :public_doc_postfix
+
+    #
+    # Create a new BibSonomy instance.
     #
-    # Create a new BibSonomy instance
-    # Params:
-    # +user_name+:: BibSonomy user name
-    # +api_key+:: API key of the given user (get at http://www.bibsonomy.org/settings?selTab=1)
+    # @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)
     def initialize(user_name, api_key)
       super()
       @bibsonomy = BibSonomy::API.new(user_name, api_key, 'csl')
@@ -100,11 +92,12 @@ module BibSonomy
     end
 
     #
-    # Download +count+ posts for the given +user+ and +tag(s)+ and render them with CSL.
-    # Params:
-    # +user+:: user name
-    # +tags+:: an array of tags
-    # +count+:: number of posts to download
+    # Download `count` posts for the given `user` and `tag(s)` and render them with {http://citationstyles.org/ CSL}.
+    #
+    # @param user [String] the name of the posts' owner
+    # @param tags [Array<String>] the tags that all posts must contain (can be empty)
+    # @param count [Integer] number of posts to download
+    # @return [String] the rendered posts as HTML
     def render(user, tags, count)
       # get posts from BibSonomy
       posts = JSON.parse(@bibsonomy.get_posts_for_user(user, 'publication', tags, 0, count))
@@ -270,7 +263,10 @@ module BibSonomy
   end
 
 
-  # parse command line options
+  # Parse command line options
+  #
+  # @param args [Array<String>] command line options
+  # @return [String] the rendered posts as HTML
   def self.main(args)
 
     # setting default options

data/lib/bibsonomy/version.rb

@@ -1,3 +1,3 @@
 module BibSonomy
-  VERSION = "0.4.2"
+  VERSION = "0.4.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bibsonomy
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - Robert Jäschke
@@ -197,3 +197,4 @@ summary: Wraps the BibSonomy REST API.
 test_files:
 - test/post_test.rb
 - test/test_helper.rb
+has_rdoc: