zenodo 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd009682a5116ded3fc34b4c6cd29f379bb58151
-  data.tar.gz: 8314835d3f2e89512b92bc9fa04e430eea5ddc74
+  metadata.gz: 760bbc73a127edd08e6a2d032397e17926e56763
+  data.tar.gz: dfda00d95a5a1eba199f094968903ad76e468bb3
 SHA512:
-  metadata.gz: fea91f7edd47ebef37c68a0ee97ff217f229f4799d7a3334c939809e2ca7003eb85302a2c63b09bcfdab01dda7438adafca1b2c67c6a9ef21a7936cde98b617e
-  data.tar.gz: 5c70998c8a61f1d1db0cbe9f73e51090503a591a165c1689cdff880ee6bdda01a6857f95c9c4608cee8b0918f0231d8d8a5324fcb0fa4f5a5a707682715a5383
+  metadata.gz: 5f86205fdf020b77ee74fd7ade072c3ad7f24d95918daf83439984045cefaa3de92d15ef302ee3bec3d3ef3725a07c746337fa5f2eefe5fae06b65fab8f4333f
+  data.tar.gz: 1af5d9ada62fb6f04e70d36ea57aa97c28d006eef252038701aee39a821a12f1d20c8ce5242552cfe238ecb919c395f65ef8d03941f0975ee1a2d0ff5f8c0072

data/.gitignore

@@ -13,5 +13,6 @@
 *.so
 *.o
 *.a
+*.gem
 mkmf.log
 /config/gem_secret.yml

data/lib/zenodo/client.rb

@@ -22,6 +22,7 @@ module Zenodo
 
       # Setup HTTP request connection to Zenodo.
       @connection ||= Faraday.new do |builder|
+        builder.request :multipart
         builder.request :url_encoded
         builder.response :logger if Zenodo.logger
         builder.adapter Faraday.default_adapter
@@ -40,7 +41,15 @@ module Zenodo
       raise ArgumentError, "Unsupported method #{method.inspect}. Only :get, :post, :put, :delete are allowed" unless REQUESTS.include?(method)
 
       token_url = UrlHelper.build_url(path: "#{URL}#{path}", params: {access_token: @api_key})
-      payload = !query.blank? ? JSON.generate(query) : nil
+      payload = nil
+      if query.present?
+        accept = headers.present? ? headers['Accept'] : nil
+        if accept.present? && accept == 'application/json'
+          payload = JSON.generate(query)
+        else
+          payload = query
+        end
+      end
       response = @connection.run_request(method, token_url, payload, headers)
 
       case response.status.to_i

data/lib/zenodo/dsl.rb

@@ -9,6 +9,7 @@ require 'zenodo/dsl/depositions'
 require 'zenodo/dsl/deposition_files'
 require 'zenodo/dsl/deposition_actions'
 require 'zenodo/utils'
+require 'mime-types'
 
 module Zenodo
   module DSL

data/lib/zenodo/dsl/deposition_actions.rb

@@ -13,7 +13,23 @@ module Zenodo
     end
 
     # Edit POST deposit/depositions/:id/actions/edit
+    # Unlock already submitted deposition for editing.
+    # @param [String, Fixnum] id A deposition's ID.
+    # @raise [ArgumentError] If the method arguments are blank.
+    # @return [Zenodo::Resources::deposition, nil].
+    def edit_deposition(id:)
+      raise ArgumentError, "ID cannot be blank" if id.blank?
+      Resources::Deposition.parse(request(:post, "deposit/depositions/#{id}/actions/edit", nil, nil))
+    end
 
     # Discard POST deposit/depositions/:id/actions/discard
+    # Discard changes in the current editing session.
+    # @param [String, Fixnum] id A deposition's ID.
+    # @raise [ArgumentError] If the method arguments are blank.
+    # @return [Zenodo::Resources::deposition, nil].
+    def discard_deposition(id:)
+      raise ArgumentError, "ID cannot be blank" if id.blank?
+      Resources::Deposition.parse(request(:post, "deposit/depositions/#{id}/actions/discard", nil, nil))
+    end
   end
 end

data/lib/zenodo/dsl/deposition_files.rb

@@ -3,15 +3,85 @@ require 'zenodo/dsl'
 module Zenodo
   module DSL::DepositionFiles
     # List GET deposit/depositions/:id/files
+    # List all deposition files for a given deposition.
+    # @param [String, Fixnum] id A deposition's ID.
+    # @raise [ArgumentError] If the method arguments are blank.
+    # @return [Array, nil].
+    def get_deposition_files(id:)
+      raise ArgumentError, "ID cannot be blank" if id.blank?
+      Resources::DepositionFile.parse(request(:get, "deposit/depositions/#{id}/files", nil))
+    end
 
     # Create (upload) POST deposit/depositions/:id/files
+    # Upload a new file.
+    # Note the upload will fail if the filename already exists.
+    # @param [String, Fixnum] id A deposition's ID.
+    # @param [String] file The file to upload.
+    # @param [String] filename The name of the file (optional).
+    # @raise [ArgumentError] If the method arguments are blank.
+    # @return [Zenodo::Resources::DepositionFile].
+    def create_deposition_file(id:, file:, filename: '')
+      raise ArgumentError, "ID cannot be blank" if id.blank?
+      raise ArgumentError, "File cannot be blank" if file.blank?
+      content_type = MIME::Types.type_for(file).first.content_type
+      io = Faraday::UploadIO.new(file, content_type)
+      filename = File.basename(file) if filename.blank?
+      Resources::DepositionFile.parse(
+        request(:post, "deposit/depositions/#{id}/files", { name: filename, file: io },
+          "Content-Type" => "multipart/form-data")
+      )
+    end
 
     # Sort PUT deposit/depositions/:id/files
+    # Sort the files for a deposition. By default, the first file is shown in the file preview.
+    # @param [String, Fixnum] id A deposition's ID.
+    # @param [Array] deposition_files The deposition files to sort.
+    # @raise [ArgumentError] If the method arguments are blank.
+    # @return [Array, nil].
+    def sort_deposition_files(id:, deposition_files:)
+      raise ArgumentError, "ID cannot be blank" if id.blank?
+      raise ArgumentError, "Deposition files cannot be blank" if deposition_files.blank?
+      Resources::DepositionFile.parse(request(:put, "deposit/depositions/#{id}/files", deposition_files))
+    end
 
     # Retrieve GET deposit/depositions/:id/files/:file_id
+    # Retrieve a single deposition file.
+    # @param [String, Fixnum] id A deposition's ID.
+    # @param [String] file_id A deposition file ID.
+    # @raise [ArgumentError] If the method arguments are blank.
+    # @return [Zenodo::Resources::DepositionFile].
+    def get_deposition_file(id:, file_id:)
+      raise ArgumentError, "ID cannot be blank" if id.blank?
+      raise ArgumentError, "File ID cannot be blank" if file_id.blank?
+      Resources::DepositionFile.parse(request(:get, "deposit/depositions/#{id}/files/#{file_id}", nil))
+    end
 
     # Update PUT deposit/depositions/:id/files/:file_id
+    # Update a deposition file resource. Currently the only use is renaming an already uploaded file.
+    # If you one to replace the actual file, please delete the file and upload a new file.
+    # @param [String, Fixnum] id A deposition's ID.
+    # @param [String] file_id A deposition file ID.
+    # @param [Hash] deposition_file The deposition file to update.
+    # @raise [ArgumentError] If the method arguments are blank.
+    # @return [Zenodo::Resources::DepositionFile].
+    def update_deposition_file(id:, file_id:, deposition_file:)
+      raise ArgumentError, "ID cannot be blank" if id.blank?
+      raise ArgumentError, "File ID cannot be blank" if file_id.blank?
+      raise ArgumentError, "Deposition file cannot be blank" if deposition_file.blank?
+      Resources::DepositionFile.parse(request(:put, "deposit/depositions/#{id}/files/#{file_id}", deposition_file))
+    end
 
     # Delete DELETE deposit/depositions/:id/files/:file_id
+    # Delete an existing deposition file resource.
+    # Note, only deposition files for unpublished depositions may be deleted.
+    # @param [String, Fixnum] id A deposition's ID.
+    # @param [String] file_id A deposition file ID.
+    # @raise [ArgumentError] If the method arguments are blank.
+    # @return [Faraday::Response].
+    def delete_deposition_file(id:, file_id:)
+      raise ArgumentError, "ID cannot be blank" if id.blank?
+      raise ArgumentError, "File ID cannot be blank" if file_id.blank?
+      request(:delete, "deposit/depositions/#{id}/files/#{file_id}", nil, nil)
+    end
   end
 end

data/lib/zenodo/resources.rb

@@ -7,4 +7,5 @@ end
 
 require 'zenodo/resources/object'
 require 'zenodo/resources/deposition'
+require 'zenodo/resources/deposition_file'
 

data/lib/zenodo/resources/deposition_file.rb

@@ -0,0 +1,9 @@
+require 'zenodo/resources/object'
+
+module Zenodo
+  module Resources
+    class DepositionFile < Zenodo::Resources::Object
+
+    end
+  end
+end

data/lib/zenodo/version.rb

@@ -1,3 +1,3 @@
 module Zenodo
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/fixtures/test_file_upload.txt

@@ -0,0 +1 @@
+Hello world

data/spec/zenodo/dsl/deposition_actions_spec.rb

@@ -29,6 +29,22 @@ describe Zenodo::DSL::DepositionActions do
   end
 
   # Edit POST deposit/depositions/:id/actions/edit
+  describe '#edit_deposition' do
+    it 'allows editing of a deposition' do
+      VCR.use_cassette('edit_deposition') do
+        response = Zenodo.client.edit_deposition(id: deposition_id)
+        expect(response).to be_a(Deposition)
+      end
+    end
+  end
 
   # Discard POST deposit/depositions/:id/actions/discard
+  describe '#discard_deposition' do
+    it 'discards proposed edits of a deposition' do
+      VCR.use_cassette('discard_deposition') do
+        response = Zenodo.client.discard_deposition(id: deposition_id)
+        expect(response).to be_a(Deposition)
+      end
+    end
+  end
 end

data/spec/zenodo/dsl/deposition_files_spec.rb

@@ -1,5 +1,105 @@
 require 'spec_helper'
 
 describe Zenodo::DSL::DepositionFiles do
+  let(:deposition_attributes) do
+    {
+      'metadata' => {
+        'title' => 'My first upload',
+        'upload_type' => 'poster',
+        'description' => 'This is my first upload',
+        'creators' =>[{'name' => 'Doe, John','affiliation' => 'ZENODO'}]
+      }
+    }
+  end
+  let(:deposition_file_attributes) do
+    {
+      'filename' => 'test_file_upload.txt'
+    }
+  end
+  let!(:file) { File.join(APP_ROOT, 'spec/fixtures/test_file_upload.txt') }
+  let!(:deposition_id) do
+    VCR.use_cassette('create_deposition_with_files') do
+      deposition = Zenodo.client.create_deposition(deposition: deposition_attributes)
+      deposition['id']
+    end
+  end
+  let!(:deposition_file_id) do
+    VCR.use_cassette('create_deposition_file') do
+      deposition_file = Zenodo.client.create_deposition_file(
+        id: deposition_id, file: file)
+      deposition_file['id']
+    end
+  end
+  # let!(:deleted_deposition_file_id) do
+  #   VCR.use_cassette('create_deposition_file_for_deletion') do
+  #     deposition_file = Zenodo.client.create_deposition_file(
+  #       id: deposition_id, file: file, filename: 'foobar.txt')
+  #     deposition_file['id']
+  #   end
+  # end
 
+  # List GET deposit/depositions/:id/files
+  # describe '#get_deposition_files' do
+  #   it 'returns a array of files for a deposition' do
+  #     VCR.use_cassette('get_deposition_files') do
+  #       deposition_files = Zenodo.client.get_deposition_files(id: deposition_id)
+  #       expect(deposition_files).to be_a(Array)
+  #       expect(deposition_files.first).to be_a(DepositionFile)
+  #     end
+  #   end
+  # end
+
+  # Create (upload) POST deposit/depositions/:id/files
+  describe '#create_deposition_file' do
+    it 'uploads a file for a deposition' do
+      VCR.use_cassette('create_deposition_file') do
+        deposition_file = Zenodo.client.create_deposition_file(id: deposition_id, file: file)
+        expect(deposition_file).to be_a(DepositionFile)
+      end
+    end
+  end
+
+  # # Sort PUT deposit/depositions/:id/files
+  # describe '#sort_deposition_files' do
+  #   it 'sorts files for a deposition' do
+  #     # VCR.use_cassette('sort_deposition_files') do
+  #     #   deposition_files = Zenodo.client.sort_deposition_files(
+  #     #     id: deposition_id, deposition_files: deposition_file_attributes)
+  #     #   expect(deposition_files).to be_a(Array)
+  #     #   expect(deposition_files.first).to be_a(DepositionFile)
+  #     # end
+  #   end
+  # end
+
+  # Retrieve GET deposit/depositions/:id/files/:file_id
+  describe '#get_deposition_file' do
+    it 'gets a deposition file' do
+      VCR.use_cassette('get_deposition_file') do
+        deposition_file = Zenodo.client.get_deposition_file(id: deposition_id, file_id: deposition_file_id)
+        expect(deposition_file).to be_a(DepositionFile)
+      end
+    end
+  end
+
+  # # Update PUT deposit/depositions/:id/files/:file_id
+  # describe '#update_deposition_file' do
+  #   it 'updates a deposition file' do
+  #     # VCR.use_cassette('update_deposition_file') do
+  #     #   deposition_file = Zenodo.client.update_deposition_file(
+  #     #     id: deposition_id, deposition_file_id: deposition_file_id,
+  #     #     deposition_file: deposition_file_attributes)
+  #     #   expect(deposition_file).to be_a(DepositionFile)
+  #     # end
+  #   end
+  # end
+  #
+  # # Delete DELETE deposit/depositions/:id/files/:file_id
+  # describe '#delete_deposition_file' do
+  #   it 'returns a response with code 204' do
+  #     VCR.use_cassette('delete_deposition_file') do
+  #       response = Zenodo.client.delete_deposition_file(id: deposition_id, deposition_file_id: deleted_deposition_file_id)
+  #       expect(response.status).to eq(204)
+  #     end
+  #   end
+  # end
 end

data/zenodo.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'faraday'
   spec.add_dependency 'activesupport'
+  spec.add_dependency 'mime-types'
 
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'rake', '~> 10.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zenodo
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - David Iorns
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-15 00:00:00.000000000 Z
+date: 2014-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -132,12 +146,14 @@ files:
 - lib/zenodo/errors/resource_not_found_error.rb
 - lib/zenodo/resources.rb
 - lib/zenodo/resources/deposition.rb
+- lib/zenodo/resources/deposition_file.rb
 - lib/zenodo/resources/object.rb
 - lib/zenodo/resources/object/attributes.rb
 - lib/zenodo/resources/object/serializers.rb
 - lib/zenodo/utils.rb
 - lib/zenodo/utils/url_helper.rb
 - lib/zenodo/version.rb
+- spec/fixtures/test_file_upload.txt
 - spec/spec_helper.rb
 - spec/zenodo/client_spec.rb
 - spec/zenodo/dsl/deposition_actions_spec.rb
@@ -169,6 +185,7 @@ signing_key:
 specification_version: 4
 summary: A Ruby wrapper for the Zenodo API.
 test_files:
+- spec/fixtures/test_file_upload.txt
 - spec/spec_helper.rb
 - spec/zenodo/client_spec.rb
 - spec/zenodo/dsl/deposition_actions_spec.rb