bibsonomy 0.4.13 → 0.4.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 32cf0dbab26bbf3420c93d33ca576845c363542f
-  data.tar.gz: 2f30eb91cd65347ab3bc7d8b18ad061cb5cc04ca
+  metadata.gz: '08a8cca92bb613eee121fc83132952133523cbea'
+  data.tar.gz: b02c0ef8002b4d9bbf3d70688c951d4d30c7c545
 SHA512:
-  metadata.gz: ec363069944e2b3ff51d3e61f7c666b34872abd8b7de43ff167068a624f8d6d99a754dd4d1d1d3a21f2dcc05296b8560b0e24ef6d47d063208a1e68abc765756
-  data.tar.gz: e20f1151a59b2431c7f40be23bfca5ea1d4d065b8d7b64081edfb3492d65767beac2e9885e34930577721fe7ba8da04903494750d7d0b07132a7473a64dde152
+  metadata.gz: 400ef771b97d5dd937dee0412ccdb2a147989b8685792adca8bf0dd631d4a45dfb8a2214f961c473c7fd8e4161f9bbeb3cf1d9c9135631f5ba3a95da5493ae12
+  data.tar.gz: aec2bb9a73eb1caa933b0d59971459b84d6bea767153c459128b33d3d900697ffe351eea62e7558c0d525d9ead7787fa372cce70b58f15bfd71fbcd128c84c89

data/README.md

@@ -1,6 +1,6 @@
 # BibSonomy
 
-[BibSonomy](http://www.bibsonomy.org/) client for Ruby
+[BibSonomy](https://www.bibsonomy.org/) client for Ruby
 
 [![Gem Version](https://badge.fury.io/rb/bibsonomy.svg)](http://badge.fury.io/rb/bibsonomy)
 [![Build Status](https://travis-ci.org/rjoberon/bibsonomy-ruby.svg?branch=master)](https://travis-ci.org/rjoberon/bibsonomy-ruby)
@@ -51,7 +51,7 @@ print BibSonomy::main(ARGV)
 
 ## Testing
 
-Get an API-Key from <http://www.bibsonomy.org/settings?selTab=1> and
+Get an API-Key from <https://www.bibsonomy.org/settings?selTab=1> and
 then run the following commands:
 
 ```shell

data/bibsonomy.gemspec

@@ -34,6 +34,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "citeproc-ruby", "~> 1.0", '>= 1.1.10'
   spec.add_dependency "csl-styles", "~> 1.0"
   spec.add_dependency "csl", "~> 1.5"
+  spec.add_dependency 'addressable', '~> 2.5'
   # required by citeproc-ruby when Ruby version <= 2.4
   spec.add_dependency "unicode", "~> 0.4", ">=0.4.4.4"
 

data/lib/bibsonomy.rb

@@ -1,3 +1,10 @@
+require 'optparse'
+require 'citeproc'
+require 'csl/styles'
+require 'json'
+require 'faraday'
+require 'addressable/template'
+
 require_relative "bibsonomy/version"
 require_relative "bibsonomy/post"
 require_relative "bibsonomy/api"

data/lib/bibsonomy/api.rb

@@ -1,6 +1,4 @@
 # coding: utf-8
-require 'faraday'
-require 'json'
 
 # configuration options
 $API_URL = "https://www.bibsonomy.org/"
@@ -21,6 +19,8 @@ $resource_types_bibtex = ['bibtex', 'pub', 'publication', 'publications', 'publ'
 # @author Robert Jäschke
 #
 # Changes:
+# 2018-10-09 (rja)
+# - migrated URL handling to addressable library
 # 2017-05-31 (rja)
 # - refactored get_posts_for_group and get_posts_for_user into get_posts
 # 2017-05-30 (rja)
@@ -59,6 +59,10 @@ module BibSonomy
 
       @conn.basic_auth(user_name, api_key)
 
+      # initialise URLs
+      @url_post  = Addressable::Template.new("/api/users/{user_name}/posts/{intra_hash}?format={format}")
+      @url_posts = Addressable::Template.new("/api/posts{?format,resourcetype,start,end,user,group,tags}")
+      @url_doc   = Addressable::Template.new("/api/users/{user_name}/posts/{intra_hash}/documents/{file_name}")
     end
 
 
@@ -69,7 +73,11 @@ module BibSonomy
     # @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 }
+      response = @conn.get @url_post.expand({
+                                              :user_name => user_name,
+                                              :intra_hash => intra_hash,
+                                              :format => @format
+                                            })
 
       if @parse
         attributes = JSON.parse(response.body)
@@ -115,24 +123,24 @@ module BibSonomy
     # @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
-      }
+      url = @url_posts.partial_expand({
+                                        :format => @format,
+                                        :resourcetype => get_resource_type(resource_type),
+                                        :start => start,
+                                        :end => endc
+                                      })
       # decide what to get
       if grouping == "user"
-        params[:user] = name
+        url = url.partial_expand({:user => name})
       elsif grouping == "group"
-        params[:group] = name
+        url = url.partial_expand({:group => name})
       end
       # add tags, if requested
       if tags != nil
-        params[:tags] = tags.join(" ")
+        url = url.partial_expand({:tags => tags.join(" ")})
       end
 
-      response = @conn.get "/api/posts", params
+      response = @conn.get url.expand({})
 
       if @parse
         posts = JSON.parse(response.body)["posts"]["post"]
@@ -143,7 +151,11 @@ module BibSonomy
 
 
     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)
+      return @url_doc.expand({
+                               :user_name => user_name,
+                               :intra_hash => intra_hash,
+                               :file_name => file_name
+                             })
     end
 
     #

data/lib/bibsonomy/csl.rb

@@ -1,11 +1,5 @@
 # coding: utf-8
 
-require 'optparse'
-require 'citeproc'
-require 'csl/styles'
-require 'json'
-require 'bibsonomy'
-
 #
 # Generates a list of publication posts from BibSonomy
 #

data/lib/bibsonomy/version.rb

@@ -1,3 +1,3 @@
 module BibSonomy
-  VERSION = "0.4.13"
+  VERSION = "0.4.14"
 end

data/test/post_test.rb

@@ -5,17 +5,17 @@ class BibSonomyPostTest < Minitest::Test
   def setup
     @api = BibSonomy::API.new(ENV['BIBSONOMY_USER_NAME'], ENV['BIBSONOMY_API_KEY'], 'ruby')
   end
-  
+
   def test_exists
     assert BibSonomy::Post
     assert BibSonomy::API
   end
-  
+
   def test_get_post
     VCR.use_cassette('get_post') do
       post = @api.get_post("bibsonomy-ruby", "c9437d5ec56ba949f533aeec00f571e3")
       assert_equal BibSonomy::Post, post.class
-      
+
       # Check that the fields are accessible by our model
       assert_equal "bibsonomy-ruby", post.user_name
       assert_equal "c9437d5ec56ba949f533aeec00f571e3", post.intra_hash
@@ -27,58 +27,58 @@ class BibSonomyPostTest < Minitest::Test
   def test_get_posts_for_user
     VCR.use_cassette('get_posts_for_user') do
       result = @api.get_posts_for_user("bibsonomy-ruby", "publication", ["test"], 0, 20)
-      
+
       # 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
   end
 
   def test_get_posts_for_group
     VCR.use_cassette('get_posts_for_group') do
       result = @api.get_posts_for_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
   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 2, result.length
-      
+
       # Make sure that the JSON was parsed
       assert result.kind_of?(Array)
       assert result.first.kind_of?(BibSonomy::Post)
-    end      
+    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
   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")
+    assert_equal Addressable::URI.parse("/api/users/bibsonomy-ruby/posts/c9437d5ec56ba949f533aeec00f571e3/documents/paper%202.pdf"), @api.get_document_href("bibsonomy-ruby", "c9437d5ec56ba949f533aeec00f571e3", "paper 2.pdf")
   end
 
   def test_get_document

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bibsonomy
 version: !ruby/object:Gem::Version
-  version: 0.4.13
+  version: 0.4.14
 platform: ruby
 authors:
 - Robert Jäschke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-09 00:00:00.000000000 Z
+date: 2018-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -204,6 +204,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: unicode
   requirement: !ruby/object:Gem::Requirement