dspace_rest_client 1.2.0 → 2.1.0

data/lib/{dspacerest → dspace}/community.rb

@@ -1,4 +1,4 @@
-module DSpaceRest
+module Dspace
   class Community
 
     attr_accessor :name, :logo, :copyright_text,
@@ -14,19 +14,19 @@ module DSpaceRest
       @type = args['type']
       @link = args['link']
       @logo = args['logo']
-      @parent_community = DSpaceRest::Community.new(args['parentCommunity']) unless args['parentCommunity'].nil?
+      @parent_community = Dspace::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'])
+      @sub_communities = Dspace::Builders::ModelBuilder.build_communities(args['subcommunities']) unless args['subcommunities'].nil?
+      @collections = Dspace::Builders::ModelBuilder.build_collections(args['collections']) unless args['collections'].nil?
       @expand = args['expand']
     end
 
     def to_h
-      h = {
+      {
           id: @id,
           name: @name,
           handle: @handle,
@@ -43,14 +43,12 @@ module DSpaceRest
           countItems: @count_items,
           expand: @expand
       }
-
-      h
     end
 
     private
 
     def obj2hash(list)
-      DSpaceRest::Builders::HashBuilder.models2hash list
+      Dspace::Builders::HashBuilder.models2hash list if list.is_a? Array
     end
 
   end

data/lib/{dspacerest → dspace}/item.rb

@@ -1,7 +1,6 @@
-require 'curb'
-
-module DSpaceRest
+module Dspace
   class Item
+    include Dspace::Builders::HashBuilder
 
     attr_accessor :name, :archived, :withdrawn
 
@@ -16,18 +15,18 @@ module DSpaceRest
       @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']) || []
+      @parent_collection = Dspace::Collection.new(args['parentCollection']) unless args['parentCollection'].nil?
+      @parent_collection_list = Dspace::Builders::ModelBuilder.build_collections(args['parentCollectionList'])
+      @parent_community_list = Dspace::Builders::ModelBuilder.build_communities(args['parentCommunityList'])
+      @bit_streams = Dspace::Builders::ModelBuilder.build_bitstreams(args['bitstreams'])
       @archived = args['archived']
       @withdrawn = args['withdrawn']
       @expand = args['expand']
-      @metadata = DSpaceRest::Builders::ModelBuilder.build_metadatas(args['metadata']) || []
+      @metadata = Dspace::Builders::ModelBuilder.build_metadatas(args['metadata'])
     end
 
     def to_h
-      h = {
+      {
           id: @id,
           name: @name,
           handle: @handle,
@@ -43,8 +42,6 @@ module DSpaceRest
           expand: @expand,
           metadata: obj2hash(@metadata)
       }
-
-      h
     end
 
     def add_metadata(key, value, language)
@@ -52,7 +49,8 @@ module DSpaceRest
       m['key'] = key
       m['value'] = value
       m['language'] = language || ""
-      @metadata << DSpaceRest::Metadata.new(m)
+
+      @metadata << Dspace::Metadata.new(m)
       @metadata
     end
 
@@ -60,11 +58,5 @@ module DSpaceRest
       @metadata = []
     end
 
-    private
-
-    def obj2hash(list)
-      DSpaceRest::Builders::HashBuilder.models2hash list
-    end
-
   end
-end
+end

data/lib/{dspacerest → dspace}/metadata.rb

@@ -1,6 +1,5 @@
-module DSpaceRest
+module Dspace
   class Metadata
-
     attr_accessor :key, :value, :language
 
     def initialize args

data/lib/{dspacerest → dspace}/policy.rb

@@ -1,4 +1,4 @@
-module DSpaceRest
+module Dspace
   class Policy
 
     attr_reader :id, :action, :eperson_id, :group_id,
@@ -20,7 +20,7 @@ module DSpaceRest
     end
 
     def to_h
-      h = {
+      {
           id: @id,
           action: @action,
           epersonId: @eperson_id,
@@ -33,8 +33,6 @@ module DSpaceRest
           startDate: @start_date,
           endDate: @end_date
       }
-      
-      h
     end
 
   end

data/lib/dspace/resources/authentication_resource.rb

@@ -0,0 +1,22 @@
+module Dspace
+  module Resources
+    class AuthenticationResource < ResourceKit::Resource
+
+      resources do
+        default_handler(400) { raise InvalidTokenError, 'Invalid access token.' }
+        default_handler(403) { raise InvalidCredentialsError, 'Wrong Dspace credentials.' }
+
+        action :login, 'POST /rest/login' do
+          body { |email, password| JSON.generate({email: email, password: password}) }
+          handler(200, 201) { |response| access_token = response.body }
+        end
+
+        action :logout, 'POST /rest/logout' do
+          body { |object| JSON.generate(object.to_h) }
+          handler(200, 201, 203, 204) { |response| true }
+        end
+      end
+
+    end
+  end
+end

data/lib/dspace/resources/bitstream_resource.rb

@@ -0,0 +1,63 @@
+module Dspace
+  module Resources
+    class BitstreamResource < ResourceKit::Resource
+
+      resources do
+        default_handler(401) { raise NotAuthorizedError, 'This request requires authentication' }
+
+        action :all, 'GET /rest/bitstreams' do
+          query_keys :expand, :limit, :offset
+          handler(200) do |response|
+            Dspace::Builders::ModelBuilder.build_items(JSON.parse(response.body))
+          end
+        end
+
+        action :find, 'GET /rest/bitstreams/:id' do
+          query_keys :expand
+          handler(200) do |response|
+            Dspace::Bitstream.new(JSON.parse(response.body))
+          end
+        end
+
+        action :policy, 'GET /rest/bitstreams/:id/policy' do
+          handler(200) do |response|
+            Dspace::Policy.new(JSON.parse(response.body))
+          end
+        end
+
+        action :retrieve, 'GET /rest/bitstreams/:id/retrieve' do
+          handler(200) { |response| response.body }
+        end
+
+        action :delete, 'DELETE /rest/bitstreams/:id' do
+          handler(200, 201, 204) { |response| true }
+        end
+
+        action :delete_policy, 'DELETE /rest/bitstreams/:id/policy/:policy_id' do
+          handler(200, 201, 204) { |response| true }
+        end
+
+        action :add_policy, 'POST /rest/bitstreams/:id/policy' do
+          body { |object| JSON.generate(object.to_h) }
+          handler(200, 201) { |response| true }
+        end
+
+        action :update, 'PUT /rest/bitstreams/:id' do
+          body { |object| JSON.generate(object.to_h) }
+          handler(200, 201) { |response| true }
+        end
+
+        action :update_data, 'PUT /rest/bitstreams/:id/data' do
+          body { |file| Base64.encode64(file.read) }
+          handler(200, 201) { |response| true }
+        end
+      end
+
+      def retrieve(args={})
+        bitstream = ResourceKit::ActionInvoker.call(action(:find), self, id: args.fetch(:id))
+        Dspace::Builders::TempfileBuilder.build(bitstream.name, ResourceKit::ActionInvoker.call(action(:retrieve), self))
+      end
+
+    end
+  end
+end

data/lib/dspace/resources/collection_resource.rb

@@ -0,0 +1,50 @@
+module Dspace
+  module Resources
+    class CollectionResource < ResourceKit::Resource
+
+      resources do
+        default_handler(401) { raise NotAuthorizedError, 'This request requires authentication' }
+
+        action :all, 'GET /rest/collections' do
+          query_keys :expand
+          handler(200) do |response|
+            Dspace::Builders::ModelBuilder.build_collections(JSON.parse(response.body))
+          end
+        end
+
+        action :find, 'GET /rest/collections/:id' do
+          query_keys :expand
+          handler(200) do |response|
+            Dspace::Collection.new(JSON.parse(response.body))
+          end
+        end
+
+        action :update, 'PUT /rest/collections/:id' do
+          body { |object| JSON.generate(object.to_h) }
+          handler(200, 201) { |response| true }
+        end
+
+        action :delete, 'DELETE /rest/collections/:id' do
+          handler(200, 201, 204) { |response| true }
+        end
+
+        action :delete_item, 'DELETE /rest/collections/:id/items/:item_id' do
+          handler(200, 201, 204) { |response| true }
+        end
+
+        action :items, 'GET /rest/collections/:id/items' do
+          query_keys :expand, :limit, :offset
+          handler(200) do |response|
+            Dspace::Builders::ModelBuilder.build_items(JSON.parse(response.body))
+          end
+        end
+
+        action :create_item, 'POST /rest/collections/:id/items' do
+          body { |object| JSON.generate(object.to_h) }
+          handler(200, 201) { |response| true }
+        end
+
+      end
+    end
+  end
+end

data/lib/dspace/resources/community_resource.rb

@@ -0,0 +1,78 @@
+module Dspace
+  module Resources
+    class CommunityResource < ResourceKit::Resource
+
+      resources do
+        default_handler(401) { raise NotAuthorizedError, 'This request requires authentication' }
+
+        action :all, 'GET /rest/communities' do
+          query_keys :expand
+          handler(200) do |response|
+            Dspace::Builders::ModelBuilder.build_communities(JSON.parse(response.body))
+          end
+        end
+
+        action :top_communities, 'GET /rest/communities/top-communities' do
+          query_keys :expand
+          handler(200) do |response|
+            Dspace::Builders::ModelBuilder.build_communities(JSON.parse(response.body))
+          end
+        end
+
+        action :find, 'GET /rest/communities/:id' do
+          query_keys :expand
+          handler(200) do |response|
+            Dspace::Community.new(JSON.parse(response.body))
+          end
+        end
+
+        action :collections, 'GET /rest/communities/:id/collections' do
+          query_keys :expand
+          handler(200) do |response|
+            Dspace::Builders::ModelBuilder.build_collections(JSON.parse(response.body))
+          end
+        end
+
+        action :sub_communities, 'GET /rest/communities/:id/communities' do
+          query_keys :expand
+          handler(200) do |response|
+            Dspace::Builders::ModelBuilder.build_communities(JSON.parse(response.body))
+          end
+        end
+
+        action :create, 'POST /rest/communities' do
+          body { |object| JSON.generate(object.to_h) }
+          handler(200, 201) { |response| true }
+        end
+
+        action :create_subcommunity, 'POST /rest/communities/:id/communities' do
+          body { |object| JSON.generate(object.to_h) }
+          handler(200, 201) { |response| true }
+        end
+
+        action :create_collection, 'POST /rest/communities/:id/collections' do
+          body { |object| JSON.generate(object.to_h) }
+          handler(200, 201) { |response| true }
+        end
+
+        action :update, 'PUT /rest/communities/:id' do
+          body { |object| JSON.generate(object.to_h) }
+          handler(200, 201) { |response| true }
+        end
+
+        action :delete, 'DELETE /rest/communities/:id' do
+          handler(200, 201, 204) { |response| true }
+        end
+
+        action :delete_collection, 'DELETE /rest/communities/:id/collections/:collection_id' do
+          handler(200, 201, 204) { |response| true }
+        end
+
+        action :delete_subcommunity, 'DELETE /rest/communities/:id/communities/:subcommunity_id' do
+          handler(200, 201, 204) { |response| true }
+        end
+
+      end
+    end
+  end
+end

data/lib/dspace/resources/item_resource.rb

@@ -0,0 +1,66 @@
+module Dspace
+  module Resources
+    class ItemResource < ResourceKit::Resource
+
+      resources do
+        default_handler(401) { raise NotAuthorizedError, 'This request requires authentication' }
+
+        action :all, 'GET /rest/items' do
+          query_keys :expand
+          handler(200) do |response|
+            Dspace::Builders::ModelBuilder.build_items(JSON.parse(response.body))
+          end
+        end
+
+        action :find, 'GET /rest/items/:id' do
+          query_keys :expand
+          handler(200) do |response|
+            Dspace::Item.new(JSON.parse(response.body))
+          end
+        end
+
+        action :metadata, 'GET /rest/items/:id/metadata' do
+          handler(200) do |response|
+            Dspace::Builders::ModelBuilder.build_metadatas(JSON.parse(response.body))
+          end
+        end
+
+        action :bitstreams, 'GET /rest/items/:id/bitstreams' do
+          query_keys :expand, :limit, :offset
+          handler(200) do |response|
+            Dspace::Builders::ModelBuilder.build_bitstreams(JSON.parse(response.body))
+          end
+        end
+
+        action :delete, 'DELETE /rest/items/:id' do
+          handler(200, 201, 204) { |response| true }
+        end
+
+        action :clear_metadata, 'DELETE /rest/items/:id/metadata' do
+          handler(200, 201, 204) { |response| true }
+        end
+
+        action :delete_bitstream, 'DELETE /rest/items/:id/bitstreams/:bitstream_id' do
+          handler(200, 201, 204) { |response| true }
+        end
+
+        action :add_metadata, 'POST /rest/items/:id/metadata' do
+          body { |objects| Dspace::Builders::HashBuilder.models2hash(objects) }
+          handler(200, 201) { |response| true }
+        end
+
+        action :add_bitstream, 'POST /rest/items/:id/bitstreams' do
+          query_keys :name, :description
+          body { |file| Base64.encode64(file.read) }
+          handler(200) { |response| Dspace::Bitstream.new(JSON.parse(response.body)) }
+        end
+
+        action :update_metadata, 'PUT /rest/items/:id/metadata' do
+          body { |object| JSON.generate(object.to_h) }
+          handler(200, 201) { |response| true }
+        end
+
+      end
+    end
+  end
+end

data/lib/dspace/resources/status_resource.rb

@@ -0,0 +1,19 @@
+module Dspace
+  module Resources
+    class StatusResource < ResourceKit::Resource
+
+      resources do
+
+        action :test, 'GET /rest/test' do
+          handler(200, 201) { |response| true }
+        end
+
+        action :status, 'GET /rest/status' do
+          handler(200) { |response| JSON.parse(response.body) }
+        end
+
+      end
+      
+    end
+  end
+end