Module: BibSonomy
- Defined in:
- lib/bibsonomy/api.rb,
lib/bibsonomy.rb,
lib/bibsonomy/csl.rb,
lib/bibsonomy/post.rb,
lib/bibsonomy/version.rb
Overview
escape data
make sorting, etc. configurable
automatically rename files (TODO: CSL lacks BibTeX key)
add intra_hash, user_name, etc. to CSL (cf. bitbucket.org/bibsonomy/bibsonomy/issue/2411/)
integrate AJAX abstract
make all options available via command line
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
-
altmetric
Changes: 2017-07-05 (rja)
-
added support for Altmetric badges
-
adapted options for command line use to support groups
2017-06-06 (rja)
-
added support for DOIs which are actually URLs (i.e., include the resolver)
2017-05-31 (rja)
-
added support to get posts of a group
2017-01-19 (rja)
-
added optional parameter group to control which posts are included based on their viewability for a specific group (not yet activated!)
2015-02-24 (rja)
-
initial version
Defined Under Namespace
Constant Summary collapse
- VERSION =
"0.4.10"
Class Method Summary collapse
-
.main(args) ⇒ String
Parse command line options.
Class Method Details
.main(args) ⇒ String
Parse command line options
336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 |
# File 'lib/bibsonomy/csl.rb', line 336 def self.main(args) # setting default options = OpenStruct.new .documents = false .directory = nil . = [] .style = "apa.csl" .viewable_group = "public" .altmetric = nil .posts = 1000 opt_parser = OptionParser.new do |opts| opts. = "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', 'get posts for USER') { |v| [:user] = v } opts.on('-g', '--group GROUP', 'get posts for GROUP') { |v| [:group] = v } opts.on('-t', '--tags TAG,TAG,...', Array, 'return posts with the given tags') { |v| [:tags] = v } opts.on('-s', '--style STYLE', 'use CSL style STYLE for rendering') { |v| [:style] = v } opts.on('--viewable-group GROUP', 'include only posts viewable for GROUP') { |v| [:viewable_group] = v } opts.on('-n', '--number-of-posts [COUNT]', Integer, 'number of posts to download') { |v| [:posts] = v } opts.on('-d', '--directory DIR', 'target directory', ' (if not given, no documents are downloaed)') { |v| [:directory] = v } opts.on('-a', '--altmetric TYPE', 'render Altmetric badge with type TYPE') { |v| [:altmetric] = 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 = [] [:api_key] = args.pop missing << :api_key unless [:api_key] [:user_name] = args.pop missing << :user_name unless [: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 # # do the actual work # csl = BibSonomy::CSL.new([:user_name], [:api_key]) csl.pdf_dir = [:directory] csl.style = [:style] csl.group = [:viewable_group] csl.altmetric_badge_type = [:altmetric] if [:group] grouping = "group" name = [:group] elsif [:user] grouping = "user" name = [:user] else # default: API user grouping = "user" name = [:user_name] end puts "call: #{grouping}, #{name}" html = csl.render(grouping, name, [:tags], [:posts]) return html end |