dspace_rest_client 1.1.2 → 1.2.0

data/lib/dspacerest/repositories/collection_repository.rb

@@ -1,73 +1,78 @@
-module DSpaceRest
-  module Repositories
-    class CollectionRepository < AbstractRepository
-      # Collections in DSpace are containers of Items
-
-      # √ GET /communities/{communityId}/collections - Returns array of collections of community.
-      # √ GET /collections - Return all collections of DSpace in array.
-      # √ GET /collections/{collectionId} - Return collection with id.
-      # √ GET /collections/{collectionId}/items - Return all items of collection.
-      # √ POST /communities/{communityId}/collections - Create new collections in community. You must post Collection.
-      # √ POST /collections/{collectionId}/items - Create posted item in collection. You must post an Item
-      # POST /collections/find-collection - Find collection by passed name.
-      # PUT /collections/{collectionId} - Update collection. You must put Collection.
-      # DELETE /collections/{collectionId} - Delete collection from DSpace.
-      # DELETE /collections/{collectionId}/items/{itemId} - Delete item in collection.
-      # DELETE /communities/{communityId}/collections/{collectionId} - Delete collection in community.
-
-      def get_collection_items(collection)
-        response = rest_client["/collections/#{collection.id}/items"].get
-        items = []
-        JSON.parse(response).each do |item|
-          items << DSpaceRest::Item.new(item)
-        end
-        items
-      end
-
-      def get_collection_by_id(id, expand = nil)
-        expand_uri = build_expand_uri(expand)
-        response = rest_client["/collections/#{id}?#{expand_uri}"].get
-        DSpaceRest::Collection.new(JSON.parse(response))
-      end
-
-      def get_all_collections(expand = nil)
-        expand_uri = build_expand_uri(expand)
-        response = rest_client["/collections?#{expand_uri}"].get
-        collections = []
-        JSON.parse(response).each do |coll|
-          collections << DSpaceRest::Collection.new(coll)
-        end
-        collections
-      end
-
-      def get_collections_of(community, expand = nil)
-        expand_uri = build_expand_uri(expand)
-        response = rest_client["/communities/#{community.id}/collections?#{expand_uri}"].get
-        collections = []
-        JSON.parse(response).each do |coll|
-          collections << DSpaceRest::Collection.new(coll)
-        end
-        collections
-      end
-
-      def create_collection_for(community, collection)
-        form = JSON.generate(collection.to_h)
-        response = rest_client["/communities/#{community.id}/collections"].post form
-        DSpaceRest::Collection.new(JSON.parse(response))
-      end
-
-      def create_item_for(collection, item)
-        form = JSON.generate({"metadata" => item.to_h["metadata"]})
-        response = rest_client["/collections/#{collection.id}/items"].post form
-        DSpaceRest::Item.new(JSON.parse(response))
-      end
-
-      private
-
-      def expandable_properties
-        ["parentCommunityList","parentCommunity","items","license","logo","all"]
-      end
-
-    end
-  end
-end
+module DSpaceRest
+  module Repositories
+    class CollectionRepository < AbstractRepository
+      # Collections in DSpace are containers of Items
+
+      # √ GET /communities/{communityId}/collections - Returns array of collections of community.
+      # √ GET /collections - Return all collections of DSpace in array.
+      # √ GET /collections/{collectionId} - Return collection with id.
+      # √ GET /collections/{collectionId}/items - Return all items of collection.
+      # √ POST /communities/{communityId}/collections - Create new collections in community. You must post Collection.
+      # √ POST /collections/{collectionId}/items - Create posted item in collection. You must post an Item
+      # POST /collections/find-collection - Find collection by passed name.
+      # PUT /collections/{collectionId} - Update collection. You must put Collection.
+      # DELETE /collections/{collectionId} - Delete collection from DSpace.
+      # DELETE /collections/{collectionId}/items/{itemId} - Delete item in collection.
+      # DELETE /communities/{communityId}/collections/{collectionId} - Delete collection in community.
+
+      def get_collection_items(collection, params)
+        query_string = build_query_string(params)
+        response = rest_client["/collections/#{collection.id}/items?#{query_string}"].get
+        items = []
+        JSON.parse(response).each do |item|
+          items << DSpaceRest::Item.new(item)
+        end
+        items
+      end
+
+      def get_collection_by_id(id, params)
+        query_string = build_query_string(params)
+        response = rest_client["/collections/#{id}?#{query_string}"].get
+        DSpaceRest::Collection.new(JSON.parse(response))
+      end
+
+      def get_all_collections(params)
+        query_string = build_query_string(params)
+        response = rest_client["/collections?#{query_string}"].get
+        collections = []
+        JSON.parse(response).each do |coll|
+          collections << DSpaceRest::Collection.new(coll)
+        end
+        collections
+      end
+
+      def get_collections_of(community, params)
+        query_string = build_query_string(params)
+        response = rest_client["/communities/#{community.id}/collections?#{query_string}"].get
+        collections = []
+        JSON.parse(response).each do |coll|
+          collections << DSpaceRest::Collection.new(coll)
+        end
+        collections
+      end
+
+      def create_collection_for(community, collection)
+        form = JSON.generate(collection.to_h)
+        response = rest_client["/communities/#{community.id}/collections"].post form
+        DSpaceRest::Collection.new(JSON.parse(response))
+      end
+
+      def create_item_for(collection, item)
+        form = JSON.generate({"metadata" => item.to_h[:metadata]})
+        response = rest_client["/collections/#{collection.id}/items"].post form
+        DSpaceRest::Item.new(JSON.parse(response))
+      end
+
+      private
+
+      def expandable_properties
+        ["parentCommunityList","parentCommunity","items","license","logo","all"]
+      end
+
+      def query_parameters
+        ["limit","offset"]
+      end
+
+    end
+  end
+end

data/lib/dspacerest/repositories/community_repository.rb

@@ -1,72 +1,76 @@
-module DSpaceRest
-  module Repositories
-    class CommunityRepository < AbstractRepository
-      # Communities in DSpace are used for organization and hierarchy, and are containers that hold sub-Communities and Collections.
-
-      # √ GET /communities - Returns array of all communities in DSpace.
-      # √ GET /communities/top-communities - Returns array of all top communities in DSpace
-      # √ GET /communities/{communityId} - Returns community
-      # √ GET /communities/{communityId}/communities - Returns array of subcommunities of community.
-      # √ POST /communities - Create new community at top level. You must post community.
-      # √ POST /communities/{communityId}/communities - Create new subcommunity in community. You must post Community.
-      # PUT /communities/{communityId} - Update community. You must put Community
-      # DELETE /communities/{communityId} - Delete community.
-      # DELETE /communities/{communityId}/communities/{communityId2} - Delete subcommunity in community.
-
-      def get_community_by_id(id, expand = nil)
-        expand_uri = build_expand_uri(expand)
-        response = rest_client["/communities/#{id}?#{expand_uri}"].get
-        DSpaceRest::Community.new(JSON.parse(response))
-      end
-
-      def get_all_communities(expand = nil)
-        expand_uri = build_expand_uri(expand)
-        response = rest_client["/communities?#{expand_uri}"].get
-        communities = []
-        JSON.parse(response).each do |comm|
-          communities << DSpaceRest::Community.new(comm)
-        end
-        communities
-      end
-
-      def get_top_communities(expand = nil)
-        expand_uri = build_expand_uri(expand)
-        response = rest_client["/communities/top-communities?#{expand_uri}"].get
-        communities = []
-        JSON.parse(response).each do |comm|
-          communities << DSpaceRest::Community.new(comm)
-        end
-        communities
-      end
-
-      def get_subcommunities_of(community, expand = nil)
-        expand_uri = build_expand_uri(expand)
-        response = rest_client["/communities/#{community.id}/communities?#{expand_uri}"].get
-        communities = []
-        JSON.parse(response).each do |comm|
-          communities << DSpaceRest::Community.new(comm)
-        end
-        communities
-      end
-
-      def create_community(community)
-        form = JSON.generate(community.to_h)
-        response = rest_client["/communities"].post form
-      end
-
-      def create_subcommunity_of(community, subcommunity)
-        form = JSON.generate(subcommunity.to_h)
-        response = rest_client["/communities/#{community.id}/communities"].post form
-
-        DSpaceRest::Community.new(JSON.parse(response))
-      end
-
-      private
-
-      def expandable_properties
-        ["parentCommunity","collections","subCommunities","logo","all"]
-      end
-
-    end
-  end
-end
+module DSpaceRest
+  module Repositories
+    class CommunityRepository < AbstractRepository
+      # Communities in DSpace are used for organization and hierarchy, and are containers that hold sub-Communities and Collections.
+
+      # √ GET /communities - Returns array of all communities in DSpace.
+      # √ GET /communities/top-communities - Returns array of all top communities in DSpace
+      # √ GET /communities/{communityId} - Returns community
+      # √ GET /communities/{communityId}/communities - Returns array of subcommunities of community.
+      # √ POST /communities - Create new community at top level. You must post community.
+      # √ POST /communities/{communityId}/communities - Create new subcommunity in community. You must post Community.
+      # PUT /communities/{communityId} - Update community. You must put Community
+      # DELETE /communities/{communityId} - Delete community.
+      # DELETE /communities/{communityId}/communities/{communityId2} - Delete subcommunity in community.
+
+      def get_community_by_id(id, params)
+        query_string = build_query_string(params)
+        response = rest_client["/communities/#{id}?#{query_string}"].get
+        DSpaceRest::Community.new(JSON.parse(response))
+      end
+
+      def get_all_communities(params)
+        query_string = build_query_string(params)
+        response = rest_client["/communities?#{query_string}"].get
+        communities = []
+        JSON.parse(response).each do |comm|
+          communities << DSpaceRest::Community.new(comm)
+        end
+        communities
+      end
+
+      def get_top_communities(params)
+        query_string = build_query_string(params)
+        response = rest_client["/communities/top-communities?#{query_string}"].get
+        communities = []
+        JSON.parse(response).each do |comm|
+          communities << DSpaceRest::Community.new(comm)
+        end
+        communities
+      end
+
+      def get_subcommunities_of(community, params)
+        query_string = build_query_string(params)
+        response = rest_client["/communities/#{community.id}/communities?#{query_string}"].get
+        communities = []
+        JSON.parse(response).each do |comm|
+          communities << DSpaceRest::Community.new(comm)
+        end
+        communities
+      end
+
+      def create_community(community)
+        form = JSON.generate(community.to_h)
+        response = rest_client["/communities"].post form
+      end
+
+      def create_subcommunity_of(community, subcommunity)
+        form = JSON.generate(subcommunity.to_h)
+        response = rest_client["/communities/#{community.id}/communities"].post form
+
+        DSpaceRest::Community.new(JSON.parse(response))
+      end
+
+      private
+
+      def expandable_properties
+        ["parentCommunity","collections","subCommunities","logo","all"]
+      end
+
+      def query_parameters
+        ["limit","offset"]
+      end
+
+    end
+  end
+end

data/lib/dspacerest/repositories/dspace_repository.rb

@@ -1,27 +1,27 @@
-module DSpaceRest
-  module Repositories
-    class DspaceRepository < AbstractRepository
-
-      def bitstream_repository
-        BitstreamRepository.new rest_client
-      end
-
-      def collection_repository
-        CollectionRepository.new rest_client
-      end
-
-      def community_repository
-        CommunityRepository.new rest_client
-      end
-
-      def item_repository
-        ItemRepository.new rest_client
-      end
-
-      def metadata_repository
-        MetadataRepository.new rest_client
-      end
-
-    end
-  end
+module DSpaceRest
+  module Repositories
+    class DspaceRepository < AbstractRepository
+
+      def bitstream_repository
+        BitstreamRepository.new rest_client
+      end
+
+      def collection_repository
+        CollectionRepository.new rest_client
+      end
+
+      def community_repository
+        CommunityRepository.new rest_client
+      end
+
+      def item_repository
+        ItemRepository.new rest_client
+      end
+
+      def metadata_repository
+        MetadataRepository.new rest_client
+      end
+
+    end
+  end
 end

data/lib/dspacerest/repositories/item_repository.rb

@@ -1,76 +1,80 @@
-module DSpaceRest
-  module Repositories
-    class ItemRepository < AbstractRepository
-      # Items in DSpace represent a "work" and combine metadata and files, known as Bitstreams
-
-      # √ GET /items - Return list of items.
-      # √ GET /items/{item id} - Return item.
-      # √ GET /items/{item id}/metadata - Return item metadata.
-      # √ GET /items/{item id}/bitstreams - Return item bitstreams.
-      # POST /items/find-by-metadata-field - Find items by metadata entry. You must post a MetadataEntry.  DS-2501 - wrong SQL in REST /items/find-by-metadata-field CLOSED
-      # √ POST /items/{item id}/metadata - Add metadata to item. You must post an array of MetadataEntry
-      # √ POST /items/{item id}/bitstreams - Add bitstream to item. You must post a Bitstream
-      # √ PUT /items/{item id}/metadata - Update metadata in item. You must put a MetadataEntry
-      # √ DELETE /items/{item id} - Delete item.
-      # DELETE /items/{item id}/metadata - Clear item metadata.
-      # DELETE /items/{item id}/bitstreams/{bitstream id} - Delete item bitstream.
-
-
-      def get_all_items(expand = nil)
-        expand_uri = build_expand_uri(expand)
-        response = rest_client["/items?#{expand_uri}"].get
-        items = []
-        JSON.parse(response).each do |item|
-          items << DSpaceRest::Item.new(item)
-        end
-        items
-      end
-
-      def get_item_by_id(id, expand = nil)
-        expand_uri = build_expand_uri(expand)
-        response = rest_client["/items/#{id}?#{expand_uri}"].get
-        DSpaceRest::Item.new(JSON.parse(response))
-      end
-
-      def get_metadata_of(item)
-        response = rest_client["/items/#{item.id}/metadata"].get
-        metadata = []
-        JSON.parse(response).each do |m|
-          metadata << DSpaceRest::Metadata.new(m)
-        end
-        metadata
-      end
-
-      def get_bitstreams_of(item)
-        response = rest_client["/items/#{item.id}/bitstreams"].get
-        bitstreams = []
-        JSON.parse(response).each do |bits|
-          bitstreams << DSpaceRest::Bitstream.new(bits)
-        end
-        bitstreams
-      end
-
-
-      def create_metadata_for(item)
-        form = JSON.generate(self.to_h["metadata"])
-        response = rest_client["/items/#{item.id}/metadata"].put form
-      end
-
-      def create_bitstream_for(item, file, upload_strategy)
-        response = upload_strategy.upload("/items/#{item.id}/bitstreams", file)
-        DSpaceRest::Bitstream.new(JSON.parse(response))
-      end
-
-      def delete(item)
-        response = rest_client["/items/#{item.id}"].delete
-      end
-
-      private
-
-      def expandable_properties
-        ["metadata","parentCollection","parentCollectionList","parentCommunityList","bitstreams","all"]
-      end
-
-    end
-  end
-end
+module DSpaceRest
+  module Repositories
+    class ItemRepository < AbstractRepository
+      # Items in DSpace represent a "work" and combine metadata and files, known as Bitstreams
+
+      # √ GET /items - Return list of items.
+      # √ GET /items/{item id} - Return item.
+      # √ GET /items/{item id}/metadata - Return item metadata.
+      # √ GET /items/{item id}/bitstreams - Return item bitstreams.
+      # POST /items/find-by-metadata-field - Find items by metadata entry. You must post a MetadataEntry.  DS-2501 - wrong SQL in REST /items/find-by-metadata-field CLOSED
+      # √ POST /items/{item id}/metadata - Add metadata to item. You must post an array of MetadataEntry
+      # √ POST /items/{item id}/bitstreams - Add bitstream to item. You must post a Bitstream
+      # √ PUT /items/{item id}/metadata - Update metadata in item. You must put a MetadataEntry
+      # √ DELETE /items/{item id} - Delete item.
+      # DELETE /items/{item id}/metadata - Clear item metadata.
+      # DELETE /items/{item id}/bitstreams/{bitstream id} - Delete item bitstream.
+
+
+      def get_all_items(params)
+        query_string = build_query_string(params)
+        response = rest_client["/items?#{query_string}"].get
+        items = []
+        JSON.parse(response).each do |item|
+          items << DSpaceRest::Item.new(item)
+        end
+        items
+      end
+
+      def get_item_by_id(id, params)
+        query_string = build_query_string(params)
+        response = rest_client["/items/#{id}?#{query_string}"].get
+        DSpaceRest::Item.new(JSON.parse(response))
+      end
+
+      def get_metadata_of(item)
+        response = rest_client["/items/#{item.id}/metadata"].get
+        metadata = []
+        JSON.parse(response).each do |m|
+          metadata << DSpaceRest::Metadata.new(m)
+        end
+        metadata
+      end
+
+      def get_bitstreams_of(item, params)
+        query_string = build_query_string(params)
+        response = rest_client["/items/#{item.id}/bitstreams?#{query_string}"].get
+        bitstreams = []
+        JSON.parse(response).each do |bits|
+          bitstreams << DSpaceRest::Bitstream.new(bits)
+        end
+        bitstreams
+      end
+
+      def create_metadata_for(item)
+        form = JSON.generate(self.to_h["metadata"])
+        response = rest_client["/items/#{item.id}/metadata"].put form
+      end
+
+      def create_bitstream_for(item, file, upload_strategy)
+        response = upload_strategy.upload("/items/#{item.id}/bitstreams?name=#{file.name}&description=#{file.description}", file.path)
+        DSpaceRest::Bitstream.new(JSON.parse(response))
+      end
+
+      def delete(item)
+        response = rest_client["/items/#{item.id}"].delete
+      end
+
+      private
+
+      def expandable_properties
+        ["metadata","parentCollection","parentCollectionList","parentCommunityList","bitstreams","all"]
+      end
+
+      def query_parameters
+        ["limit","offset"]
+      end
+
+    end
+  end
+end

data/lib/dspacerest/strategies/uploads/curl_strategy.rb

@@ -1,27 +1,27 @@
-#require 'curl'
-
-module DSpaceRest
-  module Strategies
-    module Uploads
-      class CurlStrategy
-
-        def initialize(host_url, token)
-          @host_url = host_url
-          @token = token
-        end
-
-        def upload(endpoint, file)
-          c = Curl::Easy.new(@host_url.concat(endpoint))
-          c.headers['Accept'] = 'application/json'
-          c.headers['rest-dspace-token'] = @token
-
-          c.multipart_form_post = true
-          c.ssl_verify_peer = false
-          c.http_post(Curl::PostField.file('file', file))
-
-          c.body_str
-        end
-      end
-    end
-  end
+#require 'curl'
+
+module DSpaceRest
+  module Strategies
+    module Uploads
+      class CurlStrategy
+
+        def initialize(host_url, token)
+          @host_url = host_url
+          @token = token
+        end
+
+        def upload(endpoint, file)
+          c = Curl::Easy.new(@host_url.concat(endpoint))
+          c.headers['Accept'] = 'application/json'
+          c.headers['rest-dspace-token'] = @token
+
+          c.multipart_form_post = true
+          c.ssl_verify_peer = false
+          c.http_post(Curl::PostField.file('file', file))
+
+          c.body_str
+        end
+      end
+    end
+  end
 end

data/lib/dspacerest/strategies/uploads/rest_strategy.rb

@@ -1,17 +1,17 @@
-module DSpaceRest
-  module Strategies
-    module Uploads
-      class RestStrategy
-
-        def initialize(rest_client)
-          @rest_client = rest_client
-        end
-
-        def upload(endpoint, file)
-          @rest_client[endpoint].post File.read(file)
-        end
-
-      end
-    end
-  end
+module DSpaceRest
+  module Strategies
+    module Uploads
+      class RestStrategy
+
+        def initialize(rest_client)
+          @rest_client = rest_client
+        end
+
+        def upload(endpoint, file)
+          @rest_client[endpoint].post File.read(file)
+        end
+
+      end
+    end
+  end
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: dspace_rest_client
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
 platform: ruby
 authors:
 - Mauricio Giacomini Girardello
-- Bruno N. Zanette
+- Bruno Nocera Zanette
 - Mateus Rambo Strey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-22 00:00:00.000000000 Z
+date: 2015-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -91,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: DSpace REST-API Client for Ruby!