Module: BibSonomy

Defined in:

lib/bibsonomy/api.rb,
lib/bibsonomy.rb,
lib/bibsonomy/csl.rb,
lib/bibsonomy/post.rb,
lib/bibsonomy/version.rb

Overview

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. 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)

Generates a list of publication posts from BibSonomy

required parameters:

• user name

• api key

optional parameters:

• user name

• tags

• 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

Author:

• Robert Jäschke

Defined Under Namespace

Classes: API, CSL, Post

Constant Summary

VERSION =

"0.4.7"

Class Method Summary

• .main(args) ⇒ String

  Parse command line options.

Class Method Details

.main(args) ⇒ String

Parse command line options

Parameters:

• args (Array<String>) —

  command line options

Returns:

• (String) —

  the rendered posts as HTML

# File 'lib/bibsonomy/csl.rb', line 301

def self.main(args)

  # setting default options
  options = OpenStruct.new
  options.documents = false
  options.directory = nil
  options.tags = []
  options.style = "apa.csl"
  options.group = "public"
  options.posts = 1000

  opt_parser = OptionParser.new do |opts|
    opts.banner = "Usage: csl.rb [options] user_name api_key"

    opts.separator ""
    opts.separator "Specific options:"

    # 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('-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 }

    opts.separator ""
    opts.separator "Common options:"

    opts.on('-h', '--help', 'show this help message and exit') do
      puts opts
      exit
    end

    opts.on_tail('-v', "--version", "show version") do
      puts BibSonomy::VERSION
      exit
    end

  end

  opt_parser.parse!(args)

  # handle mandatory arguments
  begin
    mandatory = [:user_name, :api_key]
    missing = []

    options[:api_key] = args.pop
    missing << :api_key unless options[:api_key]

    options[:user_name] = args.pop
    missing << :user_name unless options[:user_name]

    if not missing.empty?
      puts "Missing options: #{missing.join(', ')}"
      puts opt_parser
      exit
    end
  rescue OptionParser::InvalidOption, OptionParser::MissingArgument
    puts $!.to_s
    puts opt_parser
    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]

  html = csl.render(options[:user], options[:tags], options[:posts])

  return html

end