dspace_rest_client 1.2.0 → 2.1.0

data/lib/dspace_client.rb

@@ -1,64 +0,0 @@
-require 'rest-client'
-
-class DspaceClient
-  attr_reader :rest_client, :url
-
-  def initialize(url, authenticated_token = nil)
-    @url = url
-
-    if (authenticated_token.nil?)
-      @rest_client = build_rest_client url
-    else
-      @rest_client = build_rest_client url, rest_dspace_token: authenticated_token
-    end
-  end
-
-  def repository
-    @dspace_repository ||= build_repository @rest_client
-  end
-
-  def login(username, password)
-    user = JSON.generate({
-                             email: username,
-                             password: password
-                         })
-
-    # send login request to server and receive the token
-    authenticated_token = @rest_client['/login'].post user
-
-    # overwrite the rest_client and dspace_repository
-    @rest_client = build_rest_client @url, rest_dspace_token: authenticated_token
-    @dspace_repository = build_repository @rest_client
-
-    authenticated_token
-  end
-
-  def logout
-    response = JSON.parse @rest_client['/logout'].post []
-  end
-
-  def status
-    response = JSON.parse @rest_client['/status'].get
-  end
-
-  def test
-    response = JSON.parse(@rest_client['/test'].get)
-  end
-
-  private
-
-  def build_repository(rest_client)
-    DSpaceRest::Repositories::DspaceRepository.new rest_client
-  end
-
-  def build_rest_client(url, headers={})
-    RestClient::Resource.new(url,
-                             verify_ssl: OpenSSL::SSL::VERIFY_NONE,
-                             headers: headers.merge(
-                                 content_type: :json,
-                                 accept: :json
-                             )
-    )
-  end
-
-end

data/lib/dspace_rest_client.rb

@@ -1,17 +0,0 @@
-# More logical way to require 'dspace-rest-client'
-require File.dirname(__FILE__) + '/dspace_client'
-require File.dirname(__FILE__) + '/dspacerest/bitstream'
-require File.dirname(__FILE__) + '/dspacerest/collection'
-require File.dirname(__FILE__) + '/dspacerest/community'
-require File.dirname(__FILE__) + '/dspacerest/item'
-require File.dirname(__FILE__) + '/dspacerest/metadata'
-require File.dirname(__FILE__) + '/dspacerest/repositories/abstract_repository'
-require File.dirname(__FILE__) + '/dspacerest/repositories/bitstream_repository'
-require File.dirname(__FILE__) + '/dspacerest/repositories/collection_repository'
-require File.dirname(__FILE__) + '/dspacerest/repositories/community_repository'
-require File.dirname(__FILE__) + '/dspacerest/repositories/dspace_repository'
-require File.dirname(__FILE__) + '/dspacerest/repositories/item_repository'
-require File.dirname(__FILE__) + '/dspacerest/strategies/uploads/curl_strategy'
-require File.dirname(__FILE__) + '/dspacerest/strategies/uploads/rest_strategy'
-require File.dirname(__FILE__) + '/dspacerest/builders/hash_builder'
-require File.dirname(__FILE__) + '/dspacerest/builders/model_builder'

data/lib/dspacerest/repositories/abstract_repository.rb

@@ -1,37 +0,0 @@
-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,62 +0,0 @@
-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

data/lib/dspacerest/repositories/collection_repository.rb

@@ -1,78 +0,0 @@
-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,76 +0,0 @@
-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 +0,0 @@
-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,80 +0,0 @@
-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