zenodo 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e6153bc89b1c47f039c53c1ba75a2534196ad77f
-  data.tar.gz: 636baf182e8874f1f7dc286968388af74503c4d8
+  metadata.gz: 89fa4a10e36778e6d9f6c874a4268126f0bd0499
+  data.tar.gz: b59b1061ab1faebb8c8697a093f1989d4f48d175
 SHA512:
-  metadata.gz: e951ea20795e76dd03c3d6733bab2099c3e08111894d689d2848548e400ca4add3c9198e93a326e60f2e1536211392471db306c98c866e36f706f732f5b137e9
-  data.tar.gz: cb71634a7505cfb3e1dbf3fdca9f9292838934b7785e23e0198b294b919e3ca2a1810d5104fc04eec20c7e7a7483b62a13316988b5e57e9ef62f633fc9def4e0
+  metadata.gz: 9e1819983359266f8d722eaede929bf42b8fc2db999bf23a6d53395475ad52daa683e0463babb6fd21d110d9f61b56ff29a95810be14c15e8a27dc8cb020b989
+  data.tar.gz: 9599cc6a849cd1003953a957582c45fdc60a24f0849c789191668ff13d55515da23260f13262e5db1d05ba4c545d67b2e4fc59077d822e983f00e83a60fac2a2

data/lib/zenodo.rb

@@ -10,13 +10,16 @@ module Zenodo
   class << self
     # @return [String]
     attr_accessor :api_key
+    attr_accessor :url
     attr_accessor :logger
   end
 
+  self.url = 'https://zenodo.org/api/'
+
   module_function
 
   # @return [Zenodo::Client]
   def client
-    @client ||= Client.new(Zenodo.api_key)
+    @client ||= Client.new(Zenodo.api_key, Zenodo.url)
   end
 end

data/lib/zenodo/client.rb

@@ -12,13 +12,13 @@ module Zenodo
     include Errors
     include Utils
 
-    URL = 'https://zenodo.org/api/'
     REQUESTS = [:get, :post, :put, :delete]
     HEADERS = {'Accept' => 'application/json', 'Content-Type' => 'application/json'}
 
     # @param [String] api_key
-    def initialize(api_key = Zenodo.api_key)
+    def initialize(api_key = Zenodo.api_key, url = Zenodo.url)
       @api_key = api_key
+      @url = url
 
       # Setup HTTP request connection to Zenodo.
       @connection ||= Faraday.new do |builder|
@@ -40,7 +40,7 @@ module Zenodo
     def request(method, path, query = {}, headers = HEADERS)
       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})
+      token_url = UrlHelper.build_url(path: "#{@url}#{path}", params: {access_token: @api_key})
       payload = nil
       if query.present?
         accept = headers.present? ? headers['Accept'] : nil

data/lib/zenodo/dsl/deposition_actions.rb

@@ -5,32 +5,35 @@ module Zenodo
     # Publish POST deposit/depositions/:id/actions/publish
     # Publishes a deposition.
     # Note publishing will fail if no files are associated with the deposition.
-    # @param [String, Fixnum] id A deposition's ID.
-    # @raise [ArgumentError] If the method arguments are blank.
+    # @param [Hash] options The options to publish a deposition with.
+    # @option options [String, Fixnum] :id A deposition's ID.
+    # @raise [ArgumentError] If the given :id is blank.
     # @return [Zenodo::Resources::deposition, nil].
-    def publish_deposition(id:)
-      raise ArgumentError, "ID cannot be blank" if id.blank?
+    def publish_deposition(options={})
+      id = options[:id] || raise(ArgumentError, "Must supply :id")
       Resources::Deposition.parse(request(:post, "deposit/depositions/#{id}/actions/publish", nil, nil))
     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.
+    # @param [Hash] options The options to edit a deposition with.
+    # @option options [String, Fixnum] :id A deposition's ID.
+    # @raise [ArgumentError] If the given :id is blank.
     # @return [Zenodo::Resources::deposition, nil].
-    def edit_deposition(id:)
-      raise ArgumentError, "ID cannot be blank" if id.blank?
+    def edit_deposition(options={})
+      id = options[:id] || raise(ArgumentError, "Must supply :id")
       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.
+    # @param [Hash] options The options to discard a deposition with.
+    # @option options [String, Fixnum] :id A deposition's ID.
+    # @raise [ArgumentError] If the given :id is blank.
     # @return [Zenodo::Resources::deposition, nil].
-    def discard_deposition(id:)
-      raise ArgumentError, "ID cannot be blank" if id.blank?
+    def discard_deposition(options={})
+      id = options[:id] || raise(ArgumentError, "Must supply :id")
       Resources::Deposition.parse(request(:post, "deposit/depositions/#{id}/actions/discard", nil, nil))
     end
   end
-end
+end

data/lib/zenodo/dsl/deposition_files.rb

@@ -4,26 +4,30 @@ 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.
+    # @param [Hash] options The options to get a deposition with.
+    # @option options [String, Fixnum] :id A deposition's ID.
+    # @raise [ArgumentError] If the given :id is blank.
     # @return [Array, nil].
-    def get_deposition_files(id:)
-      raise ArgumentError, "ID cannot be blank" if id.blank?
+    def get_deposition_files(options={})
+      id = options[:id] || raise(ArgumentError, "Must supply :id")
       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_or_io The file or already open IO to upload.
-    # @param [String] filename The name of the file (optional except when an IO).
-    # @param [String] content_type The content type of the file (optional except when an IO).
-    # @raise [ArgumentError] If the required method arguments are blank.
+    # @param [Hash] options The options to create a deposition file with.
+    # @option options [String, Fixnum] :id A deposition's ID.
+    # @option options [String, IO] file_or_io The file or already open IO to upload.
+    # @option options [String] filename The name of the file (optional except when an IO).
+    # @option options [String] content_type The content type of the file (optional except when an IO).
+    # @raise [ArgumentError] If the :id or :file_or_io arguments are blank.
     # @return [Zenodo::Resources::DepositionFile].
-    def create_deposition_file(id:, file_or_io:, filename: nil, content_type: nil)
-      raise ArgumentError, "ID cannot be blank" if id.blank?
-      raise ArgumentError, "File or IO cannot be blank" if file_or_io.blank?
+    def create_deposition_file(options={})
+      id = options[:id] || raise(ArgumentError, "Must supply :id")
+      file_or_io = options[:file_or_io] || raise(ArgumentError, "Must supply :file_or_io")
+      filename = options[:filename]
+      content_type = options[:content_type]
 
       content_type = MIME::Types.type_for(file_or_io).first.content_type if content_type.blank?
       io = Faraday::UploadIO.new(file_or_io, content_type, filename)
@@ -36,54 +40,58 @@ module Zenodo
 
     # 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.
+    # @param [Hash] options The options to sort a deposition's files with.
+    # @option options [String, Fixnum] :id A deposition's ID.
+    # @option options [Array] :deposition_files The deposition files to sort.
+    # @raise [ArgumentError] If :id or :deposition_files 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?
+    def sort_deposition_files(options={})
+      id = options[:id] || raise(ArgumentError, "Must supply :id")
+      deposition_files = options[:deposition_files] || raise(ArgumentError, "Must supply :deposition_files")
       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.
+    # @param [Hash] options The options to get a deposition's file with.
+    # @option options [String, Fixnum] :id A deposition's ID.
+    # @option options [String] :file_id A deposition file ID.
+    # @raise [ArgumentError] If :id or :file_id 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?
+    def get_deposition_file(options={})
+      id = options[:id] || raise(ArgumentError, "Must supply :id")
+      file_id = options[:file_id] || raise(ArgumentError, "Must supply :file_id")
       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.
+    # @param [Hash] options The options to update a deposition's file with.
+    # @options option [String, Fixnum] :id A deposition's ID.
+    # @options option [String] :file_id A deposition file ID.
+    # @options option [Hash] :deposition_file The deposition file to update.
+    # @raise [ArgumentError] If the :id, :file_id, or :deposition_file 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?
+    def update_deposition_file(options={})
+      id = options[:id] || raise(ArgumentError, "Must supply :id")
+      file_id = options[:file_id] || raise(ArgumentError, "Must supply :file_id")
+      deposition_file = options[:deposition_file] || raise(ArgumentError, "Must supply :deposition_file")
       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.
+    # @param [Hash] options The options to delete a deposition's file with.
+    # @options option [String, Fixnum] :id A deposition's ID.
+    # @options option [String] :file_id A deposition file ID.
+    # @raise [ArgumentError] If the :id or :file_id 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?
+    def delete_deposition_file(options={})
+      id = options[:id] || raise(ArgumentError, "Must supply :id")
+      file_id = options[:file_id] || raise(ArgumentError, "Must supply :file_id")
       request(:delete, "deposit/depositions/#{id}/files/#{file_id}", nil, nil)
     end
   end
-end
+end

data/lib/zenodo/dsl/depositions.rb

@@ -11,43 +11,47 @@ module Zenodo
 
     # GET /Deposit/Deposition/{id}
     # Get a deposition.
-    # @param [String, Fixnum] id A deposition's ID.
-    # @raise [ArgumentError] If the method arguments are blank.
+    # @param [Hash] options The options to get a deposition with.
+    # @option options [String, Fixnum] :id A deposition's ID.
+    # @raise [ArgumentError] If the :id is blank
     # @return [Zenodo::Resources::deposition, nil].
-    def get_deposition(id:)
-      raise ArgumentError, "ID cannot be blank" if id.blank?
+    def get_deposition(options={})
+      id = options[:id] || raise(ArgumentError, "Must supply :id")
       Resources::Deposition.parse(request(:get, "deposit/depositions/#{id}"))
     end
 
     # POST /Deposit/Depositions
     # Creates a deposition.
-    # @param [Hash] deposition The deposition to create.
-    # @raise [ArgumentError] If the method arguments are blank.
+    # @param [Hash] options The options to create a deposition with.
+    # @option options [Hash] :deposition The deposition to create.
+    # @raise [ArgumentError] If the :deposition arguments are blank.
     # @return [Zenodo::Resources::deposition, nil].
-    def create_deposition(deposition:)
-      raise ArgumentError, "Deposition cannot be blank" if deposition.blank?
+    def create_deposition(options={})
+      deposition = options[:deposition] || raise(ArgumentError, "Must supply :deposition")
       Resources::Deposition.parse(request(:post, "deposit/depositions/", deposition))
     end
 
     # PUT /Deposit/Depositions
     # Updates a deposition.
-    # @param [String, Fixnum] id A deposition's ID.
-    # @param [Hash] deposition The deposition to update.
-    # @raise [ArgumentError] If the method arguments are blank.
+    # @param [Hash] options The options to update a deposition with.
+    # @option options [String, Fixnum] :id A deposition's ID.
+    # @option options [Hash] :deposition The deposition to update.
+    # @raise [ArgumentError] If the :id or :deposition arguments are blank.
     # @return [Zenodo::Resources::deposition, nil].
-    def update_deposition(id:, deposition:)
-      raise ArgumentError, "ID cannot be blank" if id.blank?
-      raise ArgumentError, "Deposition cannot be blank" if deposition.blank?
+    def update_deposition(options={})
+      id = options[:id] || raise(ArgumentError, "Must supply :id")
+      deposition = options[:deposition] || raise(ArgumentError, "Must supply :deposition")
       Resources::Deposition.parse(request(:put, "deposit/depositions/#{id}", deposition))
     end
 
     # DELETE /Deposit/Depositions/{id}
     # Deletes a deposition.
-    # @param [String, Fixnum] id A deposition's ID.
-    # @raise [ArgumentError] If the method arguments are blank.
+    # @param [Hash] options The options to delete a deposition with.
+    # @option optoins [String, Fixnum] :id A deposition's ID.
+    # @raise [ArgumentError] If the :id argument is blank.
     # @return [Faraday::Response].
-    def delete_deposition(id:)
-      raise ArgumentError, "ID cannot be blank" if id.blank?
+    def delete_deposition(options={})
+      id = options[:id] || raise(ArgumentError, "Must supply :id")
       request(:delete, "deposit/depositions/#{id}")
     end
   end

data/lib/zenodo/errors/client_error.rb

@@ -1,7 +1,12 @@
 module Zenodo
   module Errors
     class ClientError < StandardError
-      def initialize(method:, url:, headers:, response:)
+      def initialize(options={})
+        method = options[:method] || raise(ArgumentError, "Must supply :method")
+        url = options[:url] || raise(ArgumentError, "Must supply :url")
+        response = options[:response] || raise(ArgumentError, "Must supply :response")
+        headers = options[:headers]
+
         super <<-STR.gsub(/^\s*/, '')
           HTTP #{method} #{url}
           Request Headers: #{headers}

data/lib/zenodo/utils/url_helper.rb

@@ -2,10 +2,14 @@ module Zenodo
   module Utils
     class UrlHelper
       # Build a URL with a querystring containing optional params if supplied.
-      # @param [UrlHelper] path The name of the resource path as per the URL e.g. contacts.
-      # @param [Hash] params A hash of params we're turning into a querystring.
+      # @param [Hash] options The options to build a URL with.
+      # @options option [String] :path The name of the resource path as per the URL e.g. contacts.
+      # @options option [Hash] :params A hash of params we're turning into a querystring.
+      # @raise [ArgumentError] If the :path or :params arguments are blank.
       # @return [UrlHelper] The URL of the resource with required params.
-      def self.build_url(path:, params:)
+      def self.build_url(options={})
+        path = options[:path] || raise(ArgumentError, "Must supply :path")
+        params = options[:params] || raise(ArgumentError, "Must supply :params")
         params.delete_if {|k,v| v.blank?}
         params = params.to_query
         query = path
@@ -14,4 +18,4 @@ module Zenodo
       end
     end
   end
-end
+end

data/lib/zenodo/version.rb

@@ -1,3 +1,3 @@
 module Zenodo
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/zenodo.gemspec

@@ -6,8 +6,8 @@ require 'zenodo/version'
 Gem::Specification.new do |spec|
   spec.name          = "zenodo"
   spec.version       = Zenodo::VERSION
-  spec.authors       = ["David Iorns"]
-  spec.email         = ["david.iorns@gmail.com"]
+  spec.authors       = ["David Iorns", "Zach Dennis"]
+  spec.email         = ["david.iorns@gmail.com", "zach.dennis@gmail.com"]
   spec.summary       = 'A Ruby wrapper for the Zenodo API. https://zenodo.org/dev'
   spec.description   = "A Ruby wrapper for the Zenodo API. https://zenodo.org/dev.
 

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: zenodo
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - David Iorns
+- Zach Dennis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-03 00:00:00.000000000 Z
+date: 2015-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -130,6 +131,7 @@ description: |-
                           that are not part of the existing institutional or subject-based repositories of the research communities.
 email:
 - david.iorns@gmail.com
+- zach.dennis@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []