dspace_rest_client 1.2.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b2f83ca04d0ba0ceac01dbb9427a9a1aa7b777dd
-  data.tar.gz: 404728373c56cacdd8face45b875f50aebe5dfeb
+  metadata.gz: 3b3f08f485b23a007cb64a7c526cf2684c4154c2
+  data.tar.gz: 2e8af21ca901677bfe3188c29f97dbc9d53729e4
 SHA512:
-  metadata.gz: 8667ed334ae8f31aa0ca970243235a839e2bf184af32aed1b5759c8ced3a5fdb0e62ad983cbf96cf05c8d1f54ff02cce2a2e3ccd20aa028bf061f4772df58820
-  data.tar.gz: 8a5b6e03db7f815060913e6e93533d6a328a96ba72f46ac8b8bb2973cdddf1aea135c25e896a79a6a5798beac808938da1c267f9cc7fcc78d3551f627ef73ffd
+  metadata.gz: f5223f543ac5d1112864ba60122666dfedb274ec9f69a1cc471686cb11428d3ea13294770d57a314c46af60412413454ac37162862c1fa1b86f2967ace787074
+  data.tar.gz: 3fd6de4861ea64105255b68cf462c8b2ec14e1f2b7495c4f60cc53a91fa7281abdacb795bb7ffc13bc3e9ad60f3486e043a6d51550f87421c4f90052f1bd64a0

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/_lib/
+/.idea/

data/.rbenv

@@ -0,0 +1 @@
+2.2.0

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+gemspec
+
+gem 'json'
+gem 'resource_kit'
+gem 'faraday'
+gem 'net-http-persistent'
+gem 'activesupport'
+
+group :development, :spec do
+  gem 'minitest', '~> 5.8.3'
+  gem 'rspec'
+end

data/README.md

@@ -0,0 +1,58 @@
+# DSpace REST Client
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dspace_rest_client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dspace_rest_client
+
+## Get started
+
+Some requests requires user authentication.
+
+```ruby
+require 'dspace'
+client = Dspace::Client.new(dspace_api: 'https://demo.dspace.org/')
+
+if !client.is_running?
+  raise 'Can\'t connect to DSpace API.'
+end
+
+# authenticate
+client.login 'dspacedemo+admin@gmail.com', 'dspace'
+
+# create an community
+client.communities.create(Dspace::Community.new({'name' => 'Testando'}))
+
+# get a bitstream and your file
+bitstream = client.bitstreams.find(id: 20, expand: 'parent')
+tmp_file = client.bitstreams.retrieve(id: 20) #<Tempfile:/tmp/..._teste.jpg>
+
+# creating a new bitstream for some item
+file = File.new('/your/path/Pictures/Celular/some_book.pdf', 'r')
+bitstream = client.items.add_bitstream(file, id: 11, name: 'some_book.pdf', description: 'testing upload a pdf book')
+
+# updating bitstream metadata
+bitstream.name = 'new_book_name.pdf'
+client.bitstreams.update(bitstream, id: bitstream.id)
+```
+
+To see more examples, visit our Wiki.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rspec spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome. This project is intended to be a safe, welcoming space for collaboration.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dspace"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/dspace_rest_client.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dspace/version'
+
+Gem::Specification.new do |spec|
+  spec.date = '2015-12-04'
+  spec.name = "dspace_rest_client"
+  spec.version = Dspace::VERSION
+  spec.authors = ["Mauricio Giacomini Girardello", "Lucas Ernesto Kindinger", "Bruno N. Zanette", "Mateus Rambo Strey"]
+  spec.email = ["mauriciogiacomini4@gmail.com", "kindingerlek@hotmail.com"]
+  spec.summary = 'DSpace REST API Client for Ruby'
+  spec.description = 'DSpace REST-API Client for Ruby! Implements all DSpace REST-API endpoints requests.'
+  spec.homepage = 'https://gitlab.c3sl.ufpr.br/c3sl/dspace-rest-client'
+  spec.license = 'GNU - General Public License'
+  spec.test_files = `git ls-files -z spec/`.split("\0")
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "json", '~> 1.8', '>= 1.8.3'
+  spec.add_runtime_dependency "resource_kit", "~> 0.1.4"
+  spec.add_runtime_dependency "faraday", "~> 0.9.2"
+  spec.add_runtime_dependency "net-http-persistent", '~> 2.9', '>= 2.9.4'
+  spec.add_runtime_dependency "activesupport", '~> 4.2', '>= 4.2.0'
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'rspec', '~> 3.4', '>= 3.4.0'
+end

data/lib/dspace.rb

@@ -0,0 +1,31 @@
+require "forwardable"
+require "json"
+require "resource_kit"
+require "faraday"
+require "active_support/all"
+
+require_relative "dspace/version"
+require_relative "dspace/resources/community_resource"
+require_relative "dspace/resources/collection_resource"
+require_relative "dspace/resources/authentication_resource"
+require_relative "dspace/resources/bitstream_resource"
+require_relative "dspace/resources/status_resource"
+require_relative "dspace/resources/item_resource"
+require_relative "dspace/builders/hash_builder"
+require_relative "dspace/builders/model_builder"
+require_relative "dspace/builders/tempfile_builder"
+require_relative "dspace/community"
+require_relative "dspace/collection"
+require_relative "dspace/item"
+require_relative "dspace/metadata"
+require_relative "dspace/bitstream"
+require_relative "dspace/policy"
+require_relative "dspace/client"
+
+module Dspace
+
+  class NotAuthorizedError < StandardError; end
+  class InvalidTokenError < StandardError; end
+  class InvalidCredentialsError < StandardError; end
+
+end

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

@@ -1,5 +1,6 @@
-module DSpaceRest
+module Dspace
   class Bitstream
+    include Dspace::Builders::HashBuilder
 
     attr_accessor :name, :bundle_name,
                   :description, :format, :mime_type
@@ -22,12 +23,12 @@ module DSpaceRest
       @retrieve_link = args['retrieveLink']
       @check_sum = args['checkSum']
       @sequence_id = args['sequenceId']
-      @policies = DSpaceRest::Builders::ModelBuilder.build_policies(args['policies'])
+      @policies = Dspace::Builders::ModelBuilder.build_policies(args['policies'])
       @expand = args['expand']
     end
 
     def to_h
-      h = {
+      {
           id: @id,
           name: @name,
           type: @type,
@@ -44,8 +45,6 @@ module DSpaceRest
           policies: @policies,
           expand: @expand
       }
-
-      h
     end
   end
 end

data/lib/{dspacerest → dspace}/builders/hash_builder.rb

@@ -1,18 +1,22 @@
-module DSpaceRest
+module Dspace
   module Builders
     module HashBuilder
 
+      def obj2hash(list)
+        self.class.models2hash list
+      end
+
       def self.models2hash(list)
-        hash = []
-        unless list.nil?
+        if list.is_a? Array
+          hash = []
           list.each do |m|
             hash << m.to_h
           end
-        end
 
-        hash
+          hash
+        end
       end
 
     end
   end
-end
+end

data/lib/{dspacerest → dspace}/builders/model_builder.rb

@@ -1,4 +1,4 @@
-module DSpaceRest
+module Dspace
   module Builders
     module ModelBuilder
 
@@ -6,7 +6,7 @@ module DSpaceRest
         return communities if communities.nil?
         colls = []
         communities.each do |c|
-          colls << DSpaceRest::Community.new(c)
+          colls << Dspace::Community.new(c)
         end
         colls
       end
@@ -15,7 +15,7 @@ module DSpaceRest
         return collections if collections.nil?
         colls = []
         collections.each do |c|
-          colls << DSpaceRest::Collection.new(c)
+          colls << Dspace::Collection.new(c)
         end
         colls
       end
@@ -24,7 +24,7 @@ module DSpaceRest
         return items if items.nil?
         colls = []
         items.each do |c|
-          colls << DSpaceRest::Item.new(c)
+          colls << Dspace::Item.new(c)
         end
         colls
       end
@@ -33,7 +33,7 @@ module DSpaceRest
         return bitstreams if bitstreams.nil?
         colls = []
         bitstreams.each do |c|
-          colls << DSpaceRest::Bitstream.new(c)
+          colls << Dspace::Bitstream.new(c)
         end
         colls
       end
@@ -42,7 +42,7 @@ module DSpaceRest
         return metadatas if metadatas.nil?
         colls = []
         metadatas.each do |c|
-          colls << DSpaceRest::Metadata.new(c)
+          colls << Dspace::Metadata.new(c)
         end
         colls
       end
@@ -51,7 +51,7 @@ module DSpaceRest
         return policies if policies.nil?
         colls = []
         policies.each do |c|
-          colls << DSpaceRest::Policy.new(c)
+          colls << Dspace::Policy.new(c)
         end
         colls
       end

data/lib/dspace/builders/tempfile_builder.rb

@@ -0,0 +1,26 @@
+module Dspace
+  module Builders
+    module TempfileBuilder
+
+      def self.build(filename, contents = nil)
+        file = Tempfile.new([sanitize_filename(filename), File.extname(filename)]).tap do |f|
+          f.write contents
+          f.close
+        end
+      end
+
+      private
+
+      def self.sanitize_filename(filename)
+        filename.strip do |name|
+          # NOTE: File.basename doesn't work right with Windows paths on Unix
+          # get only the filename, not the whole path
+          name.gsub!(/^.*(\\|\/)/, '')
+          # Strip out the non-ascii character
+          name.gsub!(/[^0-9A-Za-z.\-]/, '_')
+        end
+      end
+
+    end
+  end
+end

data/lib/dspace/client.rb

@@ -0,0 +1,78 @@
+module Dspace
+  class Client
+    DSPACE_API = 'https://demo.dspace.org'
+
+    attr_reader :access_token
+
+    def initialize(options = {})
+      @access_token = options.with_indifferent_access[:access_token]
+      @dspace_api = options.with_indifferent_access[:dspace_api]
+      @logger = options.with_indifferent_access[:logger]
+    end
+
+    def connection
+      Faraday.new(connection_options) do |req|
+        req.request :multipart
+        req.request :url_encoded
+        req.use(Faraday::Response::Logger, @logger) unless @logger.nil?
+        req.adapter :net_http_persistent
+      end
+    end
+
+    def self.resources
+      {
+          bitstreams: ::Dspace::Resources::BitstreamResource,
+          items: ::Dspace::Resources::ItemResource,
+          collections: ::Dspace::Resources::CollectionResource,
+          communities: ::Dspace::Resources::CommunityResource,
+          status: ::Dspace::Resources::StatusResource,
+          authentication: ::Dspace::Resources::AuthenticationResource
+      }
+    end
+
+    def method_missing(name, *args, &block)
+      resource(name) || super
+    end
+
+    def resources
+      @resources ||= {}
+    end
+
+    def is_running?
+      resource(:status).test
+    end
+
+    def login(email, password)
+      @access_token = resource(:authentication).login(email, password)
+    end
+
+    def logout
+      resource(:authentication).logout
+      @access_token = nil
+    end
+
+    private
+
+    def resource(name)
+      if self.class.resources.keys.include?(name)
+        resources[name] ||= self.class.resources[name].new(connection: connection)
+        resources[name]
+      end
+    end
+
+    def connection_options
+      {
+          url: @dspace_api || DSPACE_API,
+          ssl: {
+              verify: false
+          },
+          headers: {
+              content_type: 'application/json',
+              accept: 'application/json',
+              'rest-dspace-token' => access_token.to_s,
+              user_agent: "dspace-rest-client #{Dspace::VERSION}"
+          }
+      }
+    end
+  end
+end

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

@@ -1,5 +1,6 @@
-module DSpaceRest
+module Dspace
   class Collection
+    include Dspace::Builders::HashBuilder
 
     attr_accessor :name, :logo, :license, :copyright_text,
                   :introductory_text, :short_description, :sidebar_text
@@ -23,13 +24,13 @@ module DSpaceRest
       @number_items = args['numberItems']
       @expand = args['expand']
 
-      @parent_community = DSpaceRest::Community.new(args['parentCommunity']) unless args['parentCommunity'].nil?
-      @parent_community_list = DSpaceRest::Builders::ModelBuilder.build_communities(args['parentCommunityList'])
-      @items = DSpaceRest::Builders::ModelBuilder.build_items(args['items'])
+      @parent_community = Dspace::Community.new(args['parentCommunity']) unless args['parentCommunity'].nil?
+      @parent_community_list = Dspace::Builders::ModelBuilder.build_communities(args['parentCommunityList'])
+      @items = Dspace::Builders::ModelBuilder.build_items(args['items'])
     end
 
     def to_h
-      h = {
+      {
           id: @id,
           name: @name,
           handle: @handle,
@@ -47,14 +48,6 @@ module DSpaceRest
           numberItems: @number_items,
           expand: @expand
       }
-
-      h
-    end
-
-    private
-
-    def obj2hash(list)
-      DSpaceRest::Builders::HashBuilder.models2hash list
     end
 
   end