yaccl 0.0.1

data/lib/yaccl/services/policy_services.rb

@@ -0,0 +1,27 @@
+module YACCL
+  module PolicyServices
+    def apply_policy(repository_id, policy_id, object_id, extension={})
+      required = {cmisaction: 'applyPolicy',
+                  repositoryId: repository_id,
+                  policyId: policy_id,
+                  objectId: object_id}
+      perform_request(required)
+    end
+
+    def remove_policy(repository_id, policy_id, object_id, extension={})
+      required = {cmisaction: 'removePolicy',
+                  repositoryId: repository_id,
+                  policyId: policy_id,
+                  objectId: object_id}
+      perform_request(required)
+    end
+
+    def get_applied_policies(repository_id, object_id, filter, extension={})
+      required = {cmisselector: 'policies',
+                  repositoryId: repository_id,
+                  objectId: object_id}
+      optional = {filter: filter}
+      perform_request(required, optional)
+    end
+  end
+end

data/lib/yaccl/services/relationship_services.rb

@@ -0,0 +1,17 @@
+module YACCL
+  module RelationshipServices
+    def get_object_relationships(repository_id, object_id, include_sub_relationship_types, relationship_direction, type_id, filter, include_allowable_actions, max_items, skip_count, extension={})
+      required = {cmisselector: 'relationships',
+                  repositoryId: repository_id,
+                  objectId: object_id}
+      optional = {includeSubRelationshipTypes: include_sub_relationship_types,
+                  relationshipDirection: relationship_direction,
+                  typeId: type_id,
+                  filter: filter,
+                  includeAllowableActions: include_allowable_actions,
+                  maxItems: max_items,
+                  skipCount: skip_count}
+      perform_request(required, optional)
+    end
+  end
+end

data/lib/yaccl/services/repository_services.rb

@@ -0,0 +1,60 @@
+module YACCL
+  module RepositoryServices
+    def get_repositories(extension={})
+      perform_request
+    end
+
+    def get_repository_info(repository_id, extension={})
+      required = {cmisselector: 'repositoryInfo',
+                  repositoryId: repository_id}
+      perform_request(required)
+    end
+
+    def get_type_children(repository_id, type_id, include_property_definitions, max_items, skip_count, extension={})
+      required = {cmisselector: 'typeChildren',
+                  repositoryId: repository_id}
+      optional = {typeId: type_id,
+                  includePropertyDefinitions: include_property_definitions,
+                  maxItems: max_items,
+                  skipCount: skip_count}
+      perform_request(required, optional)
+    end
+
+    def get_type_descendants(repository_id, type_id, depth, include_property_definitions, extension={})
+      required = {cmisselector: 'typeDescendants',
+                  repositoryId: repository_id}
+      optional = {typeId: type_id,
+                  depth: depth,
+                  includePropertyDefinitions: include_property_definitions}
+      perform_request(required, optional)
+    end
+
+    def get_type_definition(repository_id, type_id, extension={})
+      required = {cmisselector: 'typeDefinition',
+                  repositoryId: repository_id,
+                  typeId: type_id}
+      perform_request(required)
+    end
+
+    def create_type(repository_id, type, extension={})
+      required = {cmisaction: 'createType',
+                  repositoryId: repository_id,
+                  type: MultiJson.dump(type)}
+      perform_request(required)
+    end
+
+    def update_type(type, extension={})
+      required = {cmisaction: 'updateType',
+                  repositoryId: repository_id,
+                  type: MultiJson.dump(type)}
+      perform_request(required)
+    end
+
+    def delete_type(repository_id, type_id, extension={})
+      required = {cmisaction: 'deleteType',
+                  repositoryId: repository_id,
+                  typeId: type_id}
+      perform_request(required)
+    end
+  end
+end

data/lib/yaccl/services/versioning_services.rb

@@ -0,0 +1,21 @@
+module YACCL
+  module VersioningServices
+    def check_out(repository_id, object_id, content_copied, extension={})
+    end
+
+    def cancel_check_out(repository_id, object_id, extension={})
+    end
+
+    def check_in(repository_id, object_id, major, properties, content_stream, checkin_comment, policies, add_aces, remove_aces, extension={})
+    end
+
+    def get_object_of_latest_version(repository_id, object_id, version_series_id, major, filter, include_allowable_actions, include_relationships, rendition_filter, include_policy_ids, include_acl, extension={})
+    end
+
+    def get_properties_of_latest_version(repository_id, object_id, version_series_id, major, filter, extension={})
+    end
+
+    def get_all_versions(repository_id, object_id, version_series_id, filter, include_allowable_actions, extension={})
+    end
+  end
+end

data/readme.md

@@ -0,0 +1,21 @@
+# YACCL
+
+**YACCL** (pronounced _jackal_) stands for **Yet Another CMIS Client Library** and is a [CMIS](http://chemistry.apache.org/project/cmis.html) client library on top of the CMIS browser binding ([CMIS 1.1](http://docs.oasis-open.org/cmis/CMIS/v1.1/CMIS-v1.1.html)), written in Ruby.
+
+## Running Test
+
+Running the tests requires a running CMIS server.
+
+    rake
+
+## TODO
+
+* caching
+* complete model( (update) properties)
+* (type) check service input
+* config object (basic auth, succint property…)
+* expand tests to services
+
+## Contributing
+
+Write some code. Run the tests. Open a pull request.

data/spec/helper.rb

@@ -0,0 +1,19 @@
+require 'yaccl'
+
+YACCL.init('http://localhost:8080/upncmis/browser')
+
+def create_repository(id)
+  meta = YACCL::Model::Server.repository('meta')
+  f = meta.new_folder
+  f.name = id
+  f.object_type_id = 'repository'
+  f.properties['supportsRelationships'] = true
+  f.properties['supportsPolicies'] = true
+  f.properties['supportsItem'] = true
+  meta.root.create(f)
+  YACCL::Model::Server.repository(id)
+end
+
+def delete_repository(id)
+  YACCL::Model::Server.repository('meta').object(id).delete
+end

data/spec/model/document_spec.rb

@@ -0,0 +1,44 @@
+require_relative '../helper'
+
+describe YACCL::Model::Document do
+
+  before :all do
+    @repo = create_repository('test_document')
+  end
+
+  after :all do
+    delete_repository('test_document')
+  end
+
+  it 'create_in_folder with content' do
+    new_object = @repo.new_document
+    new_object.name = 'doc1'
+    new_object.object_type_id = 'cmis:document'
+    new_object.set_content(StringIO.new('content1'), 'text/plain', 'doc1.txt') # set content on detached doc
+    doc = new_object.create_in_folder(@repo.root_folder_id)
+    doc.name.should eq 'doc1'
+    doc.content_stream_mime_type.should eq 'text/plain'
+    doc.content_stream_file_name.should eq 'doc1.txt'
+    doc.content.should eq 'content1'
+    doc.delete
+  end
+
+  it 'create_in_folder without content' do
+    new_object = @repo.new_document
+    new_object.name = 'doc2'
+    new_object.object_type_id = 'cmis:document'
+    doc = new_object.create_in_folder(@repo.root_folder_id)
+    doc.name.should eq 'doc2'
+    doc.delete
+  end
+
+  #it 'set content - attached' do
+  #  new_object = @repo.new_document
+  #  new_object.name = 'doc3'
+  #  new_object.object_type_id = 'cmis:document'
+  #  doc = @repo.root.create(new_object)
+  #  doc.set_content(StringIO.new('content3'), 'text/plain', 'doc3.txt') # set content on attached doc
+  #  doc.content.should eq 'content3'
+  #  doc.delete
+  #end
+end

data/spec/model/folder_spec.rb

@@ -0,0 +1,73 @@
+require_relative '../helper'
+
+describe YACCL::Model::Folder do
+
+  before :all do
+    @repo = create_repository('test_folder')
+  end
+
+  after :all do
+    delete_repository('test_folder')
+  end
+
+  it 'parent - root' do
+    @repo.root.parent.should be_nil
+  end
+
+  it 'parent - root child' do
+    new_object = @repo.new_folder
+    new_object.name = 'folder1'
+    new_object.object_type_id = 'cmis:folder'
+    folder = @repo.root.create(new_object)
+    folder.parent.object_id.should eq @repo.root_folder_id
+    folder.delete
+  end
+
+  it 'create document' do
+    new_object = @repo.new_document
+    new_object.name = 'doc1'
+    new_object.object_type_id = 'cmis:document'
+    new_object.set_content(StringIO.new('apple is a fruit'), 'text/plain', 'apple.txt')
+    object = @repo.root.create(new_object)
+    object.should be_a_kind_of YACCL::Model::Document
+    object.name.should eq 'doc1'
+    object.content_stream_mime_type.should eq 'text/plain'
+    object.content_stream_file_name.should eq 'apple.txt'
+    object.content.should eq 'apple is a fruit'
+    object.delete
+  end
+
+  it 'create folder' do
+    new_object = @repo.new_folder
+    new_object.name = 'folder1'
+    new_object.object_type_id = 'cmis:folder'
+    object = @repo.root.create(new_object)
+    object.should be_a_kind_of YACCL::Model::Folder
+    object.name.should eq 'folder1'
+    object.delete
+  end
+
+  it 'create relationship' do
+    new_object = @repo.new_relationship
+    new_object.name = 'rel1'
+    new_object.object_type_id = 'cmis:relationship'
+    lambda { @repo.root.create(new_object) }.should raise_exception
+  end
+
+  it 'create item' do
+    new_object = @repo.new_item
+    new_object.name = 'item1'
+    new_object.object_type_id = 'cmis:item'
+    object = @repo.root.create(new_object)
+    object.should be_a_kind_of YACCL::Model::Item
+    object.name.should eq 'item1'
+    object.delete
+  end
+
+  it 'create object' do
+    new_object = YACCL::Model::Object.new @repo.id
+    new_object.name = 'object1'
+    new_object.object_type_id = 'cmis:folder'
+    lambda { @repo.root.create(new_object) }.should raise_exception
+  end
+end

data/spec/model/object_spec.rb

@@ -0,0 +1,103 @@
+require_relative '../helper'
+
+describe YACCL::Model::Object do
+
+  before :all do
+    @repo = create_repository('test_object')
+  end
+
+  after :all do
+    delete_repository('test_object')
+  end
+
+  it 'repository' do
+    doc = create_document
+    doc.repository.should be_a_kind_of YACCL::Model::Repository
+    doc.repository.id.should eq 'test_object'
+    doc.delete
+  end
+
+  it 'object_type' do
+    doc = create_document
+    doc.object_type.should be_a_kind_of YACCL::Model::Type
+    doc.object_type.id.should eq 'cmis:document'
+    doc.delete
+  end
+
+  it 'delete' do
+    doc = create_document
+    doc.delete
+    #TODO check
+  end
+
+  it 'allowable actions' do
+    doc = create_document
+    actions = doc.allowable_actions
+    actions.should_not be_nil
+    actions.should_not be_empty
+    actions.values.each { |v| [true, false].should include v }
+    doc.delete
+  end
+
+  it 'relationships' do
+    doc = create_document
+    rels = doc.relationships
+    rels.should_not be_nil
+    rels.should have_key :objects
+    rels.should have_key :hasMoreItems
+    rels.should have_key :numItems
+    rels[:objects].each do |r|
+      r.should be_a_kind_of YACCL::Model::Relationship
+    end
+    doc.delete
+  end
+
+  it 'policies' do
+    doc = create_document
+    pols = doc.policies
+    pols.should_not be_nil
+    pols.each do |p|
+      p.should be_a_kind_of YACCL::Model::Policy
+    end
+    doc.delete
+  end
+
+  it 'unfile' do
+    doc = create_document
+    doc.unfile
+    #TODO check
+    doc.delete
+  end
+
+  it 'acls' do
+    doc = create_document
+    acls = doc.acls
+    acls.should_not be_nil
+    acls.should_not be_empty
+    acls.should have_key :aces
+    acls.should have_key :isExact
+    [true, false].should include acls[:isExact]
+    doc.delete
+  end
+
+  it 'add aces' do
+    doc = create_document
+    doc.add_aces({})
+    #TODO check
+    doc.delete
+  end
+
+  it 'remove aces' do
+    doc = create_document
+    doc.remove_aces({})
+    #TODO check
+    doc.delete
+  end
+
+  def create_document
+    new_object = @repo.new_document
+    new_object.name = 'doc'
+    new_object.object_type_id = 'cmis:document'
+    @repo.root.create(new_object)
+  end
+end

data/spec/model/repository_spec.rb

@@ -0,0 +1,134 @@
+require_relative '../helper'
+
+describe YACCL::Model::Repository do
+
+  context 'generic' do
+    before do
+      @id = 'meta'
+      @repo = YACCL::Model::Server.repository(@id)
+    end
+
+    it 'id' do
+      @repo.id.should.eql? @id
+    end
+
+    it 'fields' do
+      @repo.id.should_not be_nil
+      @repo.name.should_not be_nil
+      @repo.product_version.should_not be_nil
+      @repo.description.should_not be_nil
+      @repo.root_folder_id.should_not be_nil
+      @repo.capabilities.should_not be_nil
+      @repo.url.should_not be_nil
+      @repo.changes_on_type.should_not be_nil
+      @repo.root_folder_url.should_not be_nil
+      @repo.product_name.should_not be_nil
+      @repo.product_version.should_not be_nil
+
+      %w(1.0 1.1).should include @repo.cmis_version_supported
+    end
+
+    it 'new object' do
+      @repo.new_folder.should be_a_kind_of YACCL::Model::Folder
+      @repo.new_document.should be_a_kind_of YACCL::Model::Document
+      @repo.new_relationship.should be_a_kind_of YACCL::Model::Relationship
+      @repo.new_policy.should be_a_kind_of YACCL::Model::Policy
+      @repo.new_item.should be_a_kind_of YACCL::Model::Item
+    end
+
+    it 'root' do
+      root = @repo.root
+      root.should be_a_kind_of YACCL::Model::Folder
+      root.object_id.should eq @repo.root_folder_id
+    end
+
+    it 'object' do
+      id = @repo.root_folder_id
+      object = @repo.object(id)
+      object.should be_a_kind_of YACCL::Model::Folder
+      object.object_id.should eq id
+    end
+
+    it 'type - document' do
+      document = @repo.type('cmis:document')
+      document.should be_a_kind_of YACCL::Model::Type
+      document.id.should eq 'cmis:document'
+    end
+
+    it 'type - folder' do
+      folder = @repo.type('cmis:folder')
+      folder.should be_a_kind_of YACCL::Model::Type
+      folder.id.should eq 'cmis:folder'
+    end
+  end
+
+  context 'upn' do
+    before :all do
+      @repo = create_repository('test_repository')
+    end
+
+    after :all do
+      delete_repository('test_repository')
+    end
+
+    it 'type - relationship' do
+      relationship = @repo.type('cmis:relationship')
+      relationship.should be_a_kind_of YACCL::Model::Type
+      relationship.id.should eq 'cmis:relationship'
+    end
+
+    it 'type - policy' do
+      policy = @repo.type('cmis:policy')
+      policy.should be_a_kind_of YACCL::Model::Type
+      policy.id.should eq 'cmis:policy'
+    end
+
+    it 'type - item' do
+      item = @repo.type('cmis:item')
+      item.should be_a_kind_of YACCL::Model::Type
+      item.id.should eq 'cmis:item'
+    end
+
+    it 'create, get, delete type - document' do
+      type_id = 'apple'
+
+      type = YACCL::Model::Type.new
+      type.id = type_id
+      type.local_name = 'apple'
+      type.query_name = 'apple'
+      type.display_name = 'apple'
+      type.parent_id = 'cmis:document'
+      type.base_id = 'cmis:document'
+      type.description = 'appel'
+      type.creatable = true
+      type.fileable = true
+      type.queryable = true
+      type.controllable_policy = true
+      type.controllable_acl = true
+      type.fulltext_indexed = true
+      type.included_in_supertype_query = true
+      type.content_stream_allowed = 'allowed'
+      type.versionable = false
+
+      type.add_property_definition(id: 'color',
+                                   localName: 'color',
+                                   queryName: 'color',
+                                   displayName: 'color',
+                                   description: 'color',
+                                   propertyType: 'string',
+                                   cardinality: 'single',
+                                   updatability: 'readwrite',
+                                   inherited: false,
+                                   required: false,
+                                   queryable: true,
+                                   orderable: true)
+
+      @repo.create_type(type)
+      @repo.type(type_id).tap do |t|
+        t.should be_a_kind_of YACCL::Model::Type
+        t.id.should eq type_id
+      end
+      @repo.delete_type(type_id)
+    end
+  end
+end