bibsonomy 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3670b5540353a413ad5fa4782a7cb52a629f2ddb
-  data.tar.gz: 8b6e6dc6aad993117d7856ec3dd16158c70c6533
+  metadata.gz: 9e90577cd917b74e5f0db75296b9ea9e53bca4ca
+  data.tar.gz: 00d3ca6fe7d1cc3b628f1e4fe56a8230aa445021
 SHA512:
-  metadata.gz: eab5129c8b67a500dc4fc8b891fe802cf4145c9fb5b9ecbb6005f185be97e5d41897f1fa4453aacab61f4f4e1be18a9c8fc1404644592ac99dcd5f81b103fae4
-  data.tar.gz: 40cadee5af345d6057f7d36065a1c4997cf7272a4ae730280815de03f4d9b0fad3775c470d841666a74b55c4b20ba547e051c38cb570cda9118862f611ad186c
+  metadata.gz: 4156a1444092b27d3e1ba14046eefd585ee66b16b992324364c8b49c99ffb3e7f511273989a94c9e100ad10959f792af40ae397d275d68feefac279255515772
+  data.tar.gz: e7142bbfc9134a812419b844a4a5cff7edd7321ed6320f13c64724a36179f03d510f6bed4611f88b92cd93f3af26d01b4f0488c785952e73ff97f7564de333d2

data/README.md

@@ -2,6 +2,8 @@
 
 BibSonomy client for Ruby
 
+[![Gem Version](https://badge.fury.io/rb/bibsonomy.svg)](http://badge.fury.io/rb/bibsonomy)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -64,7 +66,7 @@ module Jekyll
       @tag = parts[1]
       @count = Integer(parts[2])
     end
-    
+
     def render(context)
       site = context.registers[:site]
 
@@ -76,7 +78,7 @@ module Jekyll
       # 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
@@ -85,7 +87,7 @@ module Jekyll
 
       # set date to now
       context.registers[:page]["date"] = Time.new
-      
+
       return html
     end
   end
@@ -97,13 +99,13 @@ 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
@@ -111,6 +113,8 @@ 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).
+
 
 ## Contributing
 

data/bibsonomy.gemspec

@@ -28,6 +28,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency "json", "~> 1.8"
   spec.add_dependency "citeproc", "~> 1.0"
   spec.add_dependency "csl-styles", "~> 1.0"
-  spec.add_dependency "bibtex-ruby", "~> 4.0"
   
 end

data/lib/bibsonomy/api.rb

@@ -64,9 +64,10 @@ module BibSonomy
     #
     # Get a single 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] the requested 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
     #
     def get_post(user_name, intra_hash)
       response = @conn.get "/api/users/" + CGI.escape(user_name) + "/posts/" + CGI.escape(intra_hash), { :format => @format }
@@ -81,10 +82,12 @@ module BibSonomy
     #
     # Get posts owned by a user, optionally filtered by tags.
     #
-    # @param user_name [String] The name of the posts' owner.
-    # @resource_type [String] The type of the post. Currently
-    # supported are 'bookmark' and 'publication'.
-    #
+    # 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+::
     def get_posts_for_user(user_name, resource_type, tags = nil, start = 0, endc = $MAX_POSTS_PER_REQUEST)
       params = {
         :format => @format,
@@ -110,8 +113,12 @@ module BibSonomy
     end
 
     #
-    # get a document belonging to a post
+    # Get a document belonging to a post.
     #
+    # Params:
+    # +user_name+::
+    # +intra_hash+::
+    # +file_name+::
     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
@@ -120,6 +127,14 @@ module BibSonomy
       return nil, nil
     end
 
+    #
+    # Get the preview for a document belonging to a post.
+    #
+    # Params:
+    # +user_name+::
+    # +intra_hash+::
+    # +file_name+::
+    # +size+::
     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
@@ -128,12 +143,14 @@ module BibSonomy
       return nil, nil
     end
 
+
+    
+    private
+    
     #
     # Convenience method to allow sloppy specification of the resource
     # type.
     #
-    # @private
-    #
     def get_resource_type(resource_type)
       if $resource_types_bookmark.include? resource_type.downcase()
         return "bookmark"

data/lib/bibsonomy/csl.rb

@@ -3,7 +3,6 @@
 require 'optparse'
 require 'citeproc'
 require 'csl/styles'
-require 'bibtex'
 require 'json'
 require 'bibsonomy'
 
@@ -27,14 +26,55 @@ require 'bibsonomy'
 # TODO:
 # - escape data
 # - make sorting, etc. configurable
-# - add link to BibSonomy
 # - automatically rename files (TODO: CSL lacks BibTeX key)
-# - add intra_hash, user_name, DOI to CSL
+# - 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
 
 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)
+
+    ##
+    # :attr_accessor: css_class
+    # The CSS class used to render the surrounding +<ul>+ list (default: 'publications')
+
+    ##
+    # :attr_accessor: doi_link
+    # A boolean indicating whether links for DOIs shall be rendered. (default: true)
+
+    ##
+    # :attr_accessor: url_link
+    # A boolean indicating whether URLs of posts shall be rendered. (default: true)
+
+    ##
+    # :attr_accessor: bibtex_link
+    # A boolean indicating whether links to the BibTeX data of a post (in BibSonomy) shall be rendered. (default: true)
+
+    ##
+    # :attr_accessor: bibsonomy_link
+    # A boolean indicating whether links  BibSonomy shall be rendered. (default: true)
+    
+    ##
+    # :attr_accessor: opt_sep
+    # The separator between options. (default: ' | ')
+
+    ##
+    # :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')
+
+    # 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
 
     #
     # Create a new BibSonomy instance
@@ -89,7 +129,7 @@ module BibSonomy
         result += "<h3>" + last_year + "</h3>"
       end
 
-      result += "<ul class='#{@publications}'>\n"
+      result += "<ul class='#{@css_class}'>\n"
       for post_id in sorted_keys
         post = posts[post_id]
 
@@ -98,7 +138,7 @@ module BibSonomy
           year = get_year(post)
           if year != last_year
             last_year = year
-            result += "</ul>\n<h3>" + last_year + "</h3>\n<ul class='#{@publications}'>\n"
+            result += "</ul>\n<h3>" + last_year + "</h3>\n<ul class='#{@css_class}'>\n"
           end
         end
 
@@ -142,13 +182,19 @@ module BibSonomy
         if options.length > 0
           result += " <span class='opt'>[" + options.join(@opt_sep) + "]</span>"
         end
-        
+
         result += "</li>\n"
       end
       result += "</ul>\n"
 
       return result
     end
+
+
+    #
+    # private methods follow
+    #
+    private
     
     def get_year(post)
       return post["issued"]["literal"]
@@ -167,7 +213,7 @@ module BibSonomy
     end
 
     #
-    # only show PDF files and if
+    # only show PDF files
     #
     def get_public_docs(documents)
       result = []
@@ -221,93 +267,6 @@ module BibSonomy
       return [post_id[0, 32], post_id[32, post_id.length]]
     end
 
-    #
-    # setters
-    #
-
-    #
-    # Set the output directory for downloaded PDF files (default: +nil+)
-    # Params:
-    # +pdf_dir+:: directory for downloaded PDF files. If set to +nil+, no documents are downloaded.
-    def pdf_dir=(pdf_dir)
-      @pdf_dir = pdf_dir
-    end
-
-    #
-    # Set the CSL style used for rendering (default: +apa.csl+)
-    # Params:
-    # +style+:: CSL style used for rendering
-    def style=(style)
-      @style = style
-    end
-
-    #
-    # Enable/disable headings for years (default: enabled)
-    # Params:
-    # +year_headings+:: boolean indicating whether year headings shall be rendered
-    def year_headings=(year_headings)
-      @year_headings = year_headings
-    end
-
-    #
-    # The CSS class used to render the surrounding +<ul>+ list (default: 'publications')
-    # Params:
-    # +css_class+:: string indicating the CSS class for rendering the publication list
-    def css_class=(css_class)
-      @css_class = css_class
-    end
-
-    #
-    # Shall links for DOIs be rendered? (default: true)
-    # Params:
-    # +doi_link+:: render DOI link
-    def doi_link=(doi_link)
-      @doi_link = doi_link
-    end
-
-    #
-    # Shall links for URLs of posts be rendered? (default: true)
-    # Params:
-    # +url_link+:: render URL link
-    def url_link=(url_link)
-      @url_link = url_link
-    end
-
-    #
-    # Shall links to the BibTeX of a post (in BibSonomy) be rendered? (default: true)
-    # Params:
-    # +bibtex_link+:: render BibTeX link
-    def bibtex_link=(bibtex_link)
-      @bibtex_link = bibtex_link
-    end
-
-    #
-    # Shall links to BibSonomy be rendered? (default: true)
-    # Params:
-    # +bibsonomy_link+:: render BibSonomy link
-    def bibsonomy_link=(bibsonomy_link)
-      @bibsonomy_link = bibsonomy_link
-    end
-
-    #
-    # Separator between options (default: ' | ')
-    # Params:
-    # +opt_sep+:: option separator
-    def opt_sep=(opt_sep)
-      @opt_sep = opt_sep
-    end
-
-    #
-    # 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')
-    # Params:
-    # +public_doc_postfix+:: postfix to check at document filenames
-    def public_doc_postfix=(public_doc_postfix)
-      @public_doc_postfix = public_doc_postfix
-    end
-    
   end
 
 
@@ -383,8 +342,8 @@ module BibSonomy
     # do the actual work
     #
     csl = BibSonomy::CSL.new(options[:user_name], options[:api_key])
-    csl.pdf_dir(options[:directory])
-    csl.style(options[:style])
+    csl.pdf_dir = options[:directory]
+    csl.style = options[:style]
 
     html = csl.render(options[:user], options[:tags], options[:posts])
 

data/lib/bibsonomy/post.rb

@@ -16,6 +16,6 @@ module BibSonomy
       @journal = publication["journal"]
       @url = publication["url"]
     end
-      
+
   end
 end

data/lib/bibsonomy/version.rb

@@ -1,3 +1,3 @@
 module BibSonomy
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bibsonomy
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Robert Jäschke
@@ -136,20 +136,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: bibtex-ruby
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
 description: Enables calls to the BibSonomy REST API with Ruby.
 email:
 - jaeschke@l3s.de