dspace_rest_client 1.1.2 → 1.2.0

data/lib/dspacerest/community.rb

@@ -1,57 +1,57 @@
-module DSpaceRest
-  class Community
-
-    attr_accessor :name, :logo, :copyright_text,
-                  :introductory_text, :short_description, :sidebar_text
-
-    attr_reader :id, :handle, :type, :link, :parent_community,
-                :count_items, :sub_communities, :collections, :expand
-
-    def initialize(args={})
-      @id = args['id']
-      @name = args['name']
-      @handle = args['handle']
-      @type = args['type']
-      @link = args['link']
-      @logo = args['logo']
-      @parent_community = DSpaceRest::Community.new(args['parentCommunity']) unless args['parentCommunity'].nil?
-      @copyright_text = args['copyrightText']
-      @introductory_text = args['introductoryText']
-      @short_description = args['shortDescription']
-      @sidebar_text = args['sidebarText']
-      @count_items = args['countItems']
-      @sub_communities = DSpaceRest::Builders::ModelBuilder.build_communities(args['subcommunities'])
-      @collections = DSpaceRest::Builders::ModelBuilder.build_collections(args['collections'])
-      @expand = args['expand']
-    end
-
-    def to_h
-      h = {
-          id: @id,
-          name: @name,
-          handle: @handle,
-          type: @type,
-          link: @link,
-          logo: @logo,
-          parentCommunity: @parent_community,
-          subcommunities: obj2hash(@sub_communities),
-          collections: obj2hash(@collections),
-          copyrightText: @copyright_text,
-          introductoryText: @introductory_text,
-          shortDescription: @short_description,
-          sidebarText: @sidebar_text,
-          countItems: @count_items,
-          expand: @expand
-      }
-
-      h
-    end
-
-    private
-
-    def obj2hash(list)
-      DSpaceRest::Builders::HashBuilder.models2hash list
-    end
-
-  end
-end
+module DSpaceRest
+  class Community
+
+    attr_accessor :name, :logo, :copyright_text,
+                  :introductory_text, :short_description, :sidebar_text
+
+    attr_reader :id, :handle, :type, :link, :parent_community,
+                :count_items, :sub_communities, :collections, :expand
+
+    def initialize(args={})
+      @id = args['id']
+      @name = args['name']
+      @handle = args['handle']
+      @type = args['type']
+      @link = args['link']
+      @logo = args['logo']
+      @parent_community = DSpaceRest::Community.new(args['parentCommunity']) unless args['parentCommunity'].nil?
+      @copyright_text = args['copyrightText']
+      @introductory_text = args['introductoryText']
+      @short_description = args['shortDescription']
+      @sidebar_text = args['sidebarText']
+      @count_items = args['countItems']
+      @sub_communities = DSpaceRest::Builders::ModelBuilder.build_communities(args['subcommunities'])
+      @collections = DSpaceRest::Builders::ModelBuilder.build_collections(args['collections'])
+      @expand = args['expand']
+    end
+
+    def to_h
+      h = {
+          id: @id,
+          name: @name,
+          handle: @handle,
+          type: @type,
+          link: @link,
+          logo: @logo,
+          parentCommunity: @parent_community,
+          subcommunities: obj2hash(@sub_communities),
+          collections: obj2hash(@collections),
+          copyrightText: @copyright_text,
+          introductoryText: @introductory_text,
+          shortDescription: @short_description,
+          sidebarText: @sidebar_text,
+          countItems: @count_items,
+          expand: @expand
+      }
+
+      h
+    end
+
+    private
+
+    def obj2hash(list)
+      DSpaceRest::Builders::HashBuilder.models2hash list
+    end
+
+  end
+end

data/lib/dspacerest/item.rb

@@ -1,71 +1,70 @@
-require 'curb'
-
-module DSpaceRest
-  class Item
-
-    attr_accessor :name, :archived, :withdrawn
-
-    attr_reader :id, :handle, :type, :link, :last_modified, :parent_collection,
-                :parent_collection_list, :parent_community_list, :bit_streams,
-                :expand, :metadata
-
-    def initialize args
-      @id = args['id']
-      @name = args['name']
-      @handle = args['handle']
-      @type = args['type']
-      @link = args['link']
-      @last_modified = args['lastModified']
-      @parent_collection = DSpaceRest::Collection.new(args['parentCollection']) unless args['parentCollection'].nil?
-      @parent_collection_list = DSpaceRest::Builders::ModelBuilder.build_collections(args['parentCollectionList'])
-      @parent_community_list = DSpaceRest::Builders::ModelBuilder.build_communities(args['parentCommunityList'])
-      @bit_streams = DSpaceRest::Builders::ModelBuilder.build_bitstreams(args['bitstreams'])
-      @archived = args['archived']
-      @withdrawn = args['withdrawn']
-      @expand = args['expand']
-      @metadata = DSpaceRest::Builders::ModelBuilder.build_metadatas(args['metadata'])
-    end
-
-    def to_h
-      h = {
-          id: @id,
-          name: @name,
-          handle: @handle,
-          type: @type,
-          link: @link,
-          lastModified: @last_modified,
-          parentCollection: @parent_collection.to_h,
-          parentCollectionList: obj2hash(@parent_collection_list),
-          parentCommunityList: obj2hash(@parent_community_list),
-          bitstreams: obj2hash(@bit_streams),
-          archived: @archived,
-          withdrawn: @withdrawn,
-          expand: @expand,
-          metadata: obj2hash(@metadata)
-      }
-
-      h
-    end
-
-    def add_metadata(key, value, language)
-      m = {}
-      m['key'] = key
-      m['value'] = value
-      m['language'] = language || ""
-
-      @metadata << DSpaceRest::Metadata.new(m)
-      @metadata
-    end
-
-    def reset_metadata
-      @metadata = []
-    end
-
-    private
-
-    def obj2hash(list)
-      DSpaceRest::Builders::HashBuilder.models2hash list
-    end
-
-  end
-end
+require 'curb'
+
+module DSpaceRest
+  class Item
+
+    attr_accessor :name, :archived, :withdrawn
+
+    attr_reader :id, :handle, :type, :link, :last_modified, :parent_collection,
+                :parent_collection_list, :parent_community_list, :bit_streams,
+                :expand, :metadata
+
+    def initialize args
+      @id = args['id']
+      @name = args['name']
+      @handle = args['handle']
+      @type = args['type']
+      @link = args['link']
+      @last_modified = args['lastModified']
+      @parent_collection = DSpaceRest::Collection.new(args['parentCollection']) unless args['parentCollection'].nil?
+      @parent_collection_list = DSpaceRest::Builders::ModelBuilder.build_collections(args['parentCollectionList']) || []
+      @parent_community_list = DSpaceRest::Builders::ModelBuilder.build_communities(args['parentCommunityList']) || []
+      @bit_streams = DSpaceRest::Builders::ModelBuilder.build_bitstreams(args['bitstreams']) || []
+      @archived = args['archived']
+      @withdrawn = args['withdrawn']
+      @expand = args['expand']
+      @metadata = DSpaceRest::Builders::ModelBuilder.build_metadatas(args['metadata']) || []
+    end
+
+    def to_h
+      h = {
+          id: @id,
+          name: @name,
+          handle: @handle,
+          type: @type,
+          link: @link,
+          lastModified: @last_modified,
+          parentCollection: @parent_collection.to_h,
+          parentCollectionList: obj2hash(@parent_collection_list),
+          parentCommunityList: obj2hash(@parent_community_list),
+          bitstreams: obj2hash(@bit_streams),
+          archived: @archived,
+          withdrawn: @withdrawn,
+          expand: @expand,
+          metadata: obj2hash(@metadata)
+      }
+
+      h
+    end
+
+    def add_metadata(key, value, language)
+      m = {}
+      m['key'] = key
+      m['value'] = value
+      m['language'] = language || ""
+      @metadata << DSpaceRest::Metadata.new(m)
+      @metadata
+    end
+
+    def reset_metadata
+      @metadata = []
+    end
+
+    private
+
+    def obj2hash(list)
+      DSpaceRest::Builders::HashBuilder.models2hash list
+    end
+
+  end
+end

data/lib/dspacerest/metadata.rb

@@ -1,17 +1,17 @@
-module DSpaceRest
-  class Metadata
-
-    attr_accessor :key, :value, :language
-
-    def initialize args
-      @key = args['key']
-      @value = args['value']
-      @language = args['language'] || nil
-    end
-
-    def to_h
-      {key: @key, value: @value, language: @language}
-    end
-
-  end
-end
+module DSpaceRest
+  class Metadata
+
+    attr_accessor :key, :value, :language
+
+    def initialize args
+      @key = args['key']
+      @value = args['value']
+      @language = args['language'] || nil
+    end
+
+    def to_h
+      {key: @key, value: @value, language: @language}
+    end
+
+  end
+end

data/lib/dspacerest/policy.rb

@@ -1,41 +1,41 @@
-module DSpaceRest
-  class Policy
-
-    attr_reader :id, :action, :eperson_id, :group_id,
-                :resource_id, :resource_type, :rp_description,
-                :rp_name, :rp_type, :start_date, :end_date
-
-    def initialize args
-      @id = args['id']
-      @action = args['action']
-      @eperson_id = args['epersonId']
-      @group_id = args['groupId']
-      @resource_id = args['resourceId']
-      @resource_type = args['resourceType']
-      @rp_description = args['rpDescription']
-      @rp_name = args['rpName']
-      @rp_type = args['rpType']
-      @start_date = args['startDate']
-      @end_date = args['endDate']
-    end
-
-    def to_h
-      h = {
-          id: @id,
-          action: @action,
-          epersonId: @eperson_id,
-          groupId: @group_id,
-          resourceId: @resource_id,
-          resourceType: @resource_type,
-          rpDescription: @rp_description,
-          rpName: @rp_name,
-          rpType: @rp_type,
-          startDate: @start_date,
-          endDate: @end_date
-      }
-      
-      h
-    end
-
-  end
-end
+module DSpaceRest
+  class Policy
+
+    attr_reader :id, :action, :eperson_id, :group_id,
+                :resource_id, :resource_type, :rp_description,
+                :rp_name, :rp_type, :start_date, :end_date
+
+    def initialize args
+      @id = args['id']
+      @action = args['action']
+      @eperson_id = args['epersonId']
+      @group_id = args['groupId']
+      @resource_id = args['resourceId']
+      @resource_type = args['resourceType']
+      @rp_description = args['rpDescription']
+      @rp_name = args['rpName']
+      @rp_type = args['rpType']
+      @start_date = args['startDate']
+      @end_date = args['endDate']
+    end
+
+    def to_h
+      h = {
+          id: @id,
+          action: @action,
+          epersonId: @eperson_id,
+          groupId: @group_id,
+          resourceId: @resource_id,
+          resourceType: @resource_type,
+          rpDescription: @rp_description,
+          rpName: @rp_name,
+          rpType: @rp_type,
+          startDate: @start_date,
+          endDate: @end_date
+      }
+      
+      h
+    end
+
+  end
+end

data/lib/dspacerest/repositories/abstract_repository.rb

@@ -1,20 +1,37 @@
-module DSpaceRest
-  module Repositories
-    class AbstractRepository
-      attr_reader :rest_client
-
-      def initialize(rest_client)
-        @rest_client = rest_client
-      end
-
-      protected
-
-      def build_expand_uri(expand = nil)
-        if expandable_properties.include? expand
-          "expand=#{expand}"
-        end
-      end
-
-    end
-  end
-end
+module DSpaceRest
+  module Repositories
+    class AbstractRepository
+      attr_reader :rest_client
+
+      def initialize(rest_client)
+        @rest_client = rest_client
+      end
+
+      protected
+
+      def build_query_string(params)
+
+        query_string=""
+
+        if query_parameters.include? 'limit'
+          query_string << "limit=#{params[:limit]}&"
+        end
+
+        if query_parameters.include? 'offset'
+          query_string << "offset=#{params[:offset]}&"
+        end
+
+        expand_string = ""
+        params[:expand].each do |expand|
+          if expandable_properties.include? expand
+            expand_string << "#{expand},"
+          end
+        end
+        query_string << "expand=#{expand_string}"
+
+        query_string
+      end
+
+    end
+  end
+end

data/lib/dspacerest/repositories/bitstream_repository.rb

@@ -1,58 +1,62 @@
-module DSpaceRest
-  module Repositories
-    class BitstreamRepository < AbstractRepository
-
-      # Bitstreams are files. They have a filename, size (in bytes), and a file format.
-      # Typically in DSpace, the Bitstream will the "full text" article, or some other media.
-      # Some files are the actual file that was uploaded (tagged with bundleName:ORIGINAL),
-      # others are DSpace-generated files that are derivatives or renditions, such as text-extraction, or thumbnails.
-      # You can download files/bitstreams.
-      # DSpace doesn't really limit the type of files that it takes in, so this could be PDF, JPG, audio, video, zip,
-      # or other.
-      # Also, the logo for a Collection or a Community, is also a Bitstream.
-
-      # √ GET /bitstreams - Return all bitstreams in DSpace.
-      # √ GET /bitstreams/{bitstream id} - Return bitstream.
-      # GET /bitstreams/{bitstream id}/policy - Return bitstream policies.
-      # √ GET /bitstreams/{bitstream id}/retrieve - Return data of bitstream.
-      # POST /bitstreams/{bitstream id}/policy - Add policy to item. You must post a ResourcePolicy
-      # PUT /bitstreams/{bitstream id}/data - Update data/file of bitstream. You must put the data
-      # √ PUT /bitstreams/{bitstream id} - Update metadata of bitstream. You must put a Bitstream, does not alter the file/data
-      # DELETE /bitstreams/{bitstream id} - Delete bitstream from DSpace.
-      # DELETE /bitstreams/{bitstream id}/policy/{policy_id} - Delete bitstream policy.
-
-      def get_bitstream_by_id(id, expand = nil)
-        expand_uri = build_expand_uri(expand)
-        response = rest_client["/bitstreams/#{id}?#{expand_uri}"].get
-        DSpaceRest::Bitstream.new(JSON.parse(response))
-      end
-
-      def get_all_bitstreams(expand = nil)
-        expand_uri = build_expand_uri(expand)
-        response = rest_client["/bitstreams?#{expand_uri}"].get
-        bit_streams = []
-        JSON.parse(response).each do |bits|
-          bit_streams << DSpaceRest::Bitstream.new(bits)
-        end
-        bit_streams
-      end
-
-      def retrieve_data(bitstream)
-        response = rest_client["/bitstreams/#{bitstream.id}/retrieve"].get
-      end
-
-      def update(bitstream)
-        valid_keys=[:name, :description, :sequenceId]
-        form = JSON.generate(bitstream.to_h.select { |k, v| valid_keys.include? k })
-        response = rest_client["/bitstreams/#{bitstream.id}"].put form
-      end
-
-      private
-
-      def expandable_properties
-        ["parent","policies","all"]
-      end
-
-    end
-  end
-end
+module DSpaceRest
+  module Repositories
+    class BitstreamRepository < AbstractRepository
+
+      # Bitstreams are files. They have a filename, size (in bytes), and a file format.
+      # Typically in DSpace, the Bitstream will the "full text" article, or some other media.
+      # Some files are the actual file that was uploaded (tagged with bundleName:ORIGINAL),
+      # others are DSpace-generated files that are derivatives or renditions, such as text-extraction, or thumbnails.
+      # You can download files/bitstreams.
+      # DSpace doesn't really limit the type of files that it takes in, so this could be PDF, JPG, audio, video, zip,
+      # or other.
+      # Also, the logo for a Collection or a Community, is also a Bitstream.
+
+      # √ GET /bitstreams - Return all bitstreams in DSpace.
+      # √ GET /bitstreams/{bitstream id} - Return bitstream.
+      # GET /bitstreams/{bitstream id}/policy - Return bitstream policies.
+      # √ GET /bitstreams/{bitstream id}/retrieve - Return data of bitstream.
+      # POST /bitstreams/{bitstream id}/policy - Add policy to item. You must post a ResourcePolicy
+      # PUT /bitstreams/{bitstream id}/data - Update data/file of bitstream. You must put the data
+      # √ PUT /bitstreams/{bitstream id} - Update metadata of bitstream. You must put a Bitstream, does not alter the file/data
+      # DELETE /bitstreams/{bitstream id} - Delete bitstream from DSpace.
+      # DELETE /bitstreams/{bitstream id}/policy/{policy_id} - Delete bitstream policy.
+
+      def get_bitstream_by_id(id, params)
+        query_string = build_query_string(params)
+        response = rest_client["/bitstreams/#{id}?#{query_string}"].get
+        DSpaceRest::Bitstream.new(JSON.parse(response))
+      end
+
+      def get_all_bitstreams(params)
+        query_string = build_query_string(params)
+        response = rest_client["/bitstreams?#{query_string}"].get
+        bit_streams = []
+        JSON.parse(response).each do |bits|
+          bit_streams << DSpaceRest::Bitstream.new(bits)
+        end
+        bit_streams
+      end
+
+      def retrieve_data(bitstream)
+        response = rest_client["/bitstreams/#{bitstream.id}/retrieve"].get
+      end
+
+      def update(bitstream)
+        valid_keys=[:name, :description, :sequenceId]
+        form = JSON.generate(bitstream.to_h.select { |k, v| valid_keys.include? k })
+        response = rest_client["/bitstreams/#{bitstream.id}"].put form
+      end
+
+      private
+
+      def expandable_properties
+        ["parent","policies","all"]
+      end
+
+      def query_parameters
+        ["limit","offset"]
+      end
+
+    end
+  end
+end