sword2ruby 1.0.0

data/lib/sword2ruby/constant.rb

@@ -0,0 +1,35 @@
+module Sword2Ruby
+  
+  #The Atom Syndication Format namespace: http://www.w3.org/2005/Atom
+  ATOM_SYNDICATION_FORMAT_NAMESPACE = "http://www.w3.org/2005/Atom"
+  
+  #Atom Publishing Protocol namespace: http://www.w3.org/2007/app
+  ATOM_PUBLISHING_PROTOCOL_NAMESPACE = "http://www.w3.org/2007/app"
+  
+  #An array of valid URL schemes: http://, https:// and file://
+  VALID_URI_SCHEMES = [:http, :https, :file]
+  
+  #A special lambda object representing the nil object, used by find() when parsing XML which may or may not contain specific elements and attributes
+  NIL_LAMBDA = lambda {
+    result = nil;
+
+    def result.text
+      nil
+    end
+
+    def result.href
+      nil
+    end
+
+    def result.value
+      nil
+    end
+
+    def result.attribute(name)
+      nil
+    end
+
+    result;
+  }
+  
+end

data/lib/sword2ruby/deposit_receipt.rb

@@ -0,0 +1,52 @@
+module Sword2Ruby
+  #The DepositReceipt object is returned following Post, Put and Delete operations on the Sword server.
+  #In some cases (e.g. Post), an Atom::Entry will usually be returned describing the newly created entry. Operations such as Delete do not return an Atom::Entry.
+  #If the Sword server does not automatically return the Atom::Entry but instead provides a link to it, the DepositReceipt object will automatically fetch it.
+  #
+  #For more information, see the Sword2 specification: {section 10 "Deposit Receipt"}[http://sword-app.svn.sourceforge.net/viewvc/sword-app/spec/tags/sword-2.0/SWORDProfile.html?revision=377#depositreceipt].
+  class DepositReceipt
+    
+    #Boolean value indicating whether there is an Atom::Entry associated with this receipt.
+    attr_reader :has_entry
+
+    #The Atom::Entry associated with this receipt, or nil if not supplied. The Atom::Entry will be automatically fetched from the server when necessary.
+    attr_reader :entry
+    
+    #The location header returned by the Sword server, usually after Posting or Putting. 
+    attr_reader :location
+
+    #The http status code returned by the Sword server.
+    attr_reader :status_code
+    
+    #The http status message returned by the Sword server.
+    attr_reader :status_message
+    
+    #Create a new DepositReceipt using the Response object returned by the server.
+    #===Parameters
+    #response:: the response object returned by the request
+    #connection:: a Sword2Ruby::Connection object
+    def initialize(response, connection)
+      @location = response.header["location"]
+      @status_code = response.code
+      @status_message = response.message
+            
+      if response.body
+        #If a receipt was returned, parse it
+        @entry = ::Atom::Entry.parse(response.body)
+        @entry.http = connection
+        @has_entry = true
+      else
+        #if the receipt was not returned, try and retrieve it
+        if @location
+          @entry = ::Atom::Entry.parse(connection.get(@location).body)
+          @has_entry = true
+        else
+          #Otherwise, there is no receipt (e.g. for a delete)
+          @has_entry = false
+          @entry = nil
+        end
+      end
+    end
+    
+  end
+end

data/lib/sword2ruby/element.rb

@@ -0,0 +1,12 @@
+require 'atom/element'
+
+module Sword2Ruby
+  #Extensions to the atom-tools[https://github.com/bct/atom-tools/wiki] Atom::Element class to support Sword2 operations.
+  #These methods are additive to those supplied by the atom-tools gem.
+  #
+  #Please see the {atom-tools documentation}[http://rdoc.info/github/bct/atom-tools/master/frames] for a complete list of attributes and methods.
+  class ::Atom::Element
+    #Sword2Ruby::Connection (Atom::HTTP) object to facilitate connections in derived classes, such as Atom::Entry, Atom::Feed, Atom::Workspace and Atom::Collection.
+    attr_accessor :http
+  end
+end