cmis 0.2.0-java → 0.2.1-java

data/README.md

@@ -31,6 +31,12 @@ Or install it yourself as:
 
     $ gem install cmis
 
+
+## Notes about JRuby and OpenCMIS
+Every call you do in this library that returns an object actually returns a real Java object from OpenCMIS so you have access to all the functionality that OpenCMIS provides.
+
+If you want to do something that is not described in the documentation below you can read the [OpenCMIS JavaDoc](http://chemistry.apache.org/java/0.8.0/maven/apidocs/) and you should figure out how to do it.
+
 ## Usage
 
 This guide is for JRuby developers who want to access CMIS-compliant content repositories from JRuby. The examples has been tested with Alfresco Community Edition 4.2.c which is one of the most feature complete CMIS content repository.
@@ -66,6 +72,8 @@ puts "Trying to connect to a repository with id #{available_repos[0].id}"
 
 ```
 
+Note: The create_session method returns a real [Session](http://chemistry.apache.org/java/0.8.0/maven/apidocs/org/apache/chemistry/opencmis/client/api/Session.html) object that is used in OpenCMIS so you have access to every functionality that the Session object provides.
+
 ## Working with folders and documents
 
 Finding the contents of the root folder:
@@ -93,8 +101,11 @@ Create a folder the hard way:
 ```ruby
 folder_props = { CMIS::PropertyIds::OBJECT_TYPE_ID => "cmis:folder", CMIS::PropertyIds::NAME => "Another folder" }
 root.create_folder(folder_props)
+puts folder.name
 ```
 
+Note: When you create a folder it will return an actual Java OpenCMIS Folder object. That means you have access to everything it provides. [More information can be found in the JavaDoc for the Folder interface](http://chemistry.apache.org/java/0.8.0/maven/apidocs/org/apache/chemistry/opencmis/client/api/Folder.html)
+
 ### Creating/Uploading documents
 
 The create_cmis_document method is a convenient method implemented in the JRuby CMIS Library.
@@ -113,9 +124,12 @@ content_stream = CMIS::create_content_stream("/Users/ricn/cmis_logo.png", @sessi
 props = { CMIS::PropertyIds::OBJECT_TYPE_ID => "cmis:document", CMIS::PropertyIds::NAME => "cmis_logo.png" }
 id = root.create_document(props, content_stream, CMIS::VersioningState::MAJOR)
 doc = @session.get_object(id)
+puts doc.name
 ```
 
-#### Download a document to your local disk
+Note: When you create a document it will return an actual Java OpenCMIS Document object. That means you have access to everything it provides. [More information can be found in the JavaDoc for the Document interface](http://chemistry.apache.org/java/0.8.0/maven/apidocs/org/apache/chemistry/opencmis/client/api/Document.html)
+
+#### Download a document to your local disc
 
 ```ruby
 doc = @session.get_object(id)
@@ -438,6 +452,22 @@ puts rel.source.id
 puts rel.target.id
 ```
 
+## Exceptions
+If something goes wrong in an OpenCMIS method, an exception will be thrown. All OpenCMIS exceptions extend [CmisBaseException](http://chemistry.apache.org/java/0.8.0/maven/apidocs/org/apache/chemistry/opencmis/commons/exceptions/package-tree.html) which is a Java runtime exception. Because all exceptions are runtime, you do not have to catch or specify the exceptions in your own code.
+
+When you are using the ATOMPUB binding, [CmisBaseException](http://chemistry.apache.org/java/0.8.0/maven/apidocs/org/apache/chemistry/opencmis/commons/exceptions/package-tree.html) provides a error_content method which returns the content of the error page returned from the server, if there is one. This can be very useful when debugging, as the server side is normally able to provide far more information that the client. 
+In the following example, a CMISInvalidArgumentException exception is forced by trying to create a folder with an invalid type. The rescue block prints the server's error page:
+
+```ruby
+begin
+  folder_props = { CMIS::PropertyIds::OBJECT_TYPE_ID => "INVALIDOBJECTTYPEID", CMIS::PropertyIds::NAME => "folder name" }
+  folder = @session.root_folder.create_folder(folder_props)
+rescue StandardError => e
+  puts e.message
+  puts e.error_content
+end
+```
+
 ## Contributing
 
 1. Fork it

data/lib/cmis.rb

@@ -71,7 +71,7 @@ module CMIS
         content = session.object_factory.create_content_stream(file.name, file.length, CMIS::MimeTypes.getMIMEType(file), stream)
         doc_props = { CMIS::PropertyIds::OBJECT_TYPE_ID => "cmis:document", CMIS::PropertyIds::NAME => name }
         doc_props.merge!(props) if props != nil && props.is_a?(Hash)
-        self.create_document(doc_props, content, CMIS::VersioningState::MAJOR)
+        self.create_document(java.util.HashMap.new(doc_props), content, CMIS::VersioningState::MAJOR)
       end
     end
 
@@ -88,7 +88,7 @@ module CMIS
       session_factory = SessionFactoryImpl.new_instance
       repo_id = self.repositories(url, user, password)[0].id if repo_id == nil
       
-      parameters = { 
+      params = { 
         SessionParameter::ATOMPUB_URL => url,
         SessionParameter::BINDING_TYPE => BindingType::ATOMPUB.value,
         SessionParameter::USER => user,
@@ -96,19 +96,33 @@ module CMIS
         SessionParameter::REPOSITORY_ID => repo_id
       }
 
-      session_factory.create_session(parameters)
+      session_factory.create_session(java.util.HashMap.new(params))
+  end
+
+  def self.create_session_with_soap(user, password, web_services, repo_id = nil)
+    session_factory = SessionFactoryImpl.new_instance
+    repo_id = self.repositories(url, user, password)[0].id if repo_id == nil
+    
+    params = {
+        SessionParameter::BINDING_TYPE => BindingType::WEBSERVICES.value,
+        SessionParameter::USER => user,
+        SessionParameter::PASSWORD => password,
+        SessionParameter::REPOSITORY_ID => repo_id
+    }.merge!(web_services)
+
+    session_factory.create_session(java.util.HashMap.new(params))
   end
 
   def self.repositories(url, user, password)
     session_factory = SessionFactoryImpl.new_instance
-      parameters = { 
+      params = { 
         SessionParameter::ATOMPUB_URL => url,
         SessionParameter::BINDING_TYPE => BindingType::ATOMPUB.value,
         SessionParameter::USER => user,
         SessionParameter::PASSWORD => password
       }
 
-    session_factory.get_repositories(parameters)
+    session_factory.get_repositories(java.util.HashMap.new(params))
   end
 
   def self.create_content_stream(filename, session)

data/lib/cmis/version.rb

@@ -1,3 +1,3 @@
 module Cmis
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/spec/cmis_spec.rb

@@ -18,6 +18,7 @@ describe "CMIS" do
     end
 
     describe "Repository functionality" do
+
       it "should create a session" do
         @session.is_a?(Java::OrgApacheChemistryOpencmisClientRuntime::SessionImpl).should be_true
       end
@@ -306,11 +307,31 @@ describe "CMIS" do
   end
 
   describe "Local Alfresco" do
+    # Basic test for web service binding
+    it "should be possible to use web services" do
+        repo_id = CMIS::repositories("http://localhost:8181/alfresco/service/cmis", "admin", "admin")[0].id
+        ws_url = "http://localhost:8181/alfresco/cmis/"
+        ws_urls = {
+          CMIS::SessionParameter::WEBSERVICES_ACL_SERVICE => "#{ws_url}ACLService?wsdl",
+          CMIS::SessionParameter::WEBSERVICES_DISCOVERY_SERVICE => "#{ws_url}DiscoveryService?wsdl",
+          CMIS::SessionParameter::WEBSERVICES_MULTIFILING_SERVICE => "#{ws_url}MultiFilingService?wsdl",
+          CMIS::SessionParameter::WEBSERVICES_NAVIGATION_SERVICE => "#{ws_url}NavigationService?wsdl",
+          CMIS::SessionParameter::WEBSERVICES_OBJECT_SERVICE => "#{ws_url}ObjectService?wsdl",
+          CMIS::SessionParameter::WEBSERVICES_POLICY_SERVICE => "#{ws_url}PolicyService?wsdl",
+          CMIS::SessionParameter::WEBSERVICES_RELATIONSHIP_SERVICE => "#{ws_url}RelationshipService?wsdl",
+          CMIS::SessionParameter::WEBSERVICES_REPOSITORY_SERVICE => "#{ws_url}RepositoryService?wsdl",
+          CMIS::SessionParameter::WEBSERVICES_VERSIONING_SERVICE => "#{ws_url}VersioningService?wsdl"
+        }
+
+        @ws_session = CMIS::create_session_with_soap("admin", "admin", ws_urls, repo_id)
+        @ws_session.locale.should_not be_nil
+    end
+
     atom_url = "http://localhost:8181/alfresco/service/cmis"
     user = "admin"
     password = "admin"
 
-    #it_behaves_like "a CMIS repository", atom_url, user, password
+    it_behaves_like "a CMIS repository", atom_url, user, password
   end
 
   describe "Alfresco" do
@@ -318,7 +339,7 @@ describe "CMIS" do
     user = "admin"
     password = "admin"
     
-    it_behaves_like "a CMIS repository", atom_url, user, password
+    #it_behaves_like "a CMIS repository", atom_url, user, password
   end
 
   describe "Nuxeo" do
@@ -326,6 +347,6 @@ describe "CMIS" do
     user = "Administrator"
     password = "Administrator"
     
-    it_behaves_like "a CMIS repository", atom_url, user, password
+    #it_behaves_like "a CMIS repository", atom_url, user, password
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cmis
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease:
 platform: java
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-01-29 00:00:00.000000000 Z
+date: 2013-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec