yaccl 0.1.5 → 1.0.pre.alpha

data/lib/yaccl/query_result.rb

@@ -0,0 +1,15 @@
+module YACCL
+  class QueryResult
+
+    attr_reader :results
+    attr_reader :num_items
+    attr_reader :has_more_items
+
+    def initialize(results, num_items, has_more_items)
+      @results = results
+      @num_items = num_items
+      @has_more_items = has_more_items
+    end
+
+  end
+end

data/lib/yaccl/relationship.rb

@@ -0,0 +1,18 @@
+module YACCL
+  class Relationship < Object
+
+    def initialize(raw, repository)
+      super
+      cmis_properties %w( cmis:sourceId cmis:targetId )
+    end
+
+    def source
+      repository.object(source_id)
+    end
+
+    def target
+      repository.object(target_id)
+    end
+
+  end
+end

data/lib/yaccl/repository.rb

@@ -0,0 +1,108 @@
+module YACCL
+  class Repository
+
+    attr_reader :connection
+
+    def initialize(raw, connection)
+      raw.each do |key, value|
+        class_eval "def #{key.underscore};'#{value}';end"
+        class_eval "def #{key.gsub('repository', '').underscore};'#{value}';end"
+      end
+
+      @connection = connection
+    end
+
+    def new_document
+      Document.new({}, self)
+    end
+
+    def new_folder
+      Folder.new({}, self)
+    end
+
+    def new_relationship
+      Relationship.new({}, self)
+    end
+
+    def new_item
+      Item.new({}, self)
+    end
+
+    def new_policy
+      Policy.new({}, self)
+    end
+
+    def root
+      result = connection.execute!({ cmisselector: 'object',
+                                     repositoryId: id,
+                                     objectId: root_folder_id })
+
+      ObjectFactory.create(result, self)
+    end
+
+    def object(cmis_object_id)
+      result = connection.execute!({ cmisselector: 'object',
+                                     repositoryId: id,
+                                     objectId: cmis_object_id })
+
+      ObjectFactory.create(result, self)
+    end
+
+    def types
+      result = connection.execute!({ cmisselector: 'typeDescendants',
+                                     repositoryId: id,
+                                     includePropertyDefinitions: true })
+
+      construct_types(result)
+    end
+
+    def type(type_id)
+      result = connection.execute!({ cmisselector: 'typeDefinition',
+                                     repositoryId: id,
+                                     typeId: type_id })
+
+      Type.new(result, self)
+    end
+
+    def create_type(type)
+      result = connection.execute!({ cmisaction: 'createType',
+                                     repositoryId: id,
+                                     type: MultiJson.dump(type.to_hash) })
+
+      Type.new(result, self)
+    end
+
+    def create_relationship(object)
+      raise 'Object is not a Relationship' unless object.is_a?(Relationship)
+
+      result = connection.execute!({ cmisaction: 'createRelationship',
+                                     repositoryId: id,
+                                     properties: object.properties })
+
+      ObjectFactory.create(result, self)
+    end
+
+    def content_changes(change_log_token)
+      connection.execute!({ cmisselector: 'contentChanges',
+                            repositoryId: id,
+                            changeLogToken: change_log_token })
+    end
+
+    def query(statement, options = {})
+      Query.new(self, statement, options)
+    end
+
+
+    private
+
+    def construct_types(a)
+      types = []
+      a.each do |t|
+        types << Type.new(t['type'], self)
+        types << construct_types(t['children']) if t.has_key?('children')
+      end
+      types.flatten
+    end
+
+  end
+end

data/lib/yaccl/server.rb

@@ -0,0 +1,37 @@
+require 'active_support/core_ext/hash/indifferent_access'
+
+module YACCL
+  class Server
+
+    attr_reader :connection
+
+    def initialize(options = {})
+      options.stringify_keys!
+
+      service_url = options['service_url'] || ENV['CMIS_BROWSER_URL']
+      username    = options['username']    || ENV['CMIS_USER']
+      password    = options['password']    || ENV['CMIS_PASSWORD']
+      headers     = options['headers']
+
+      raise "'service_url' must be set" unless service_url
+
+      @connection = Connection.new(service_url, username, password, headers)
+    end
+
+    def repositories
+      result = connection.execute!
+
+      result.values.map do |r|
+        Repository.new(r, connection)
+      end
+    end
+
+    def repository(repository_id)
+      result = connection.execute!({ cmisselector: 'repositoryInfo',
+                                     repositoryId: repository_id })
+
+      Repository.new(result[repository_id], connection)
+    end
+
+  end
+end

data/lib/yaccl/type.rb

@@ -0,0 +1,106 @@
+require 'active_support/core_ext'
+
+module YACCL
+  class Type
+
+    attr_accessor :connection
+    attr_accessor :repository
+
+    def initialize(hash = {}, repository = nil)
+      @repository = repository
+      @connection = repository.connection if repository
+
+      @hash = hash.with_indifferent_access
+
+      properties = %w( id localName localNamespace queryName displayName baseId
+                       parentId description creatable fileable queryable
+                       controllablePolicy controllableACL fulltextIndexed
+                       includedInSupertypeQuery propertyDefinitions versionable
+                       contentStreamAllowed allowedSourceTypes allowedTargetTypes )
+
+      properties.each do |key|
+        class_eval "def #{key.underscore};@hash['#{key}'];end"
+        class_eval "def #{key.underscore}=(value);@hash['#{key}']=value;end"
+      end
+
+      @hash['propertyDefinitions'] ||= ActiveSupport::HashWithIndifferentAccess.new
+      @hash['propertyDefinitions'].each do |key, value|
+        @hash['propertyDefinitions'][key] = PropertyDefinition.new(value)
+      end
+    end
+
+    def add_property_definition(property)
+      property_definitions[property[:id]] = property
+    end
+
+    def create
+      repository.create_type(self)
+    end
+
+    def update(changed_property_defs)
+      new_defs = changed_property_defs.map(&:to_hash).inject({}) do |result, element|
+        result[element[:id]] = element
+        result
+      end
+
+      hash = to_hash
+      hash['propertyDefinitions'] = new_defs
+
+      result = connection.execute! ({ cmisaction: 'updateType',
+                                      repositoryId: repository.id,
+                                      type: MultiJson.dump(hash) })
+
+      Type.new(result, repository)
+    end
+
+    def delete
+      connection.execute!({ cmisaction: 'deleteType',
+                            repositoryId: repository.id,
+                            typeId: id })
+    end
+
+    def document_type?
+      base_id == 'cmis:document'
+    end
+
+    def folder_type?
+      base_id == 'cmis:folder'
+    end
+
+    def relationship_type?
+      base_id == 'cmis:relationship'
+    end
+
+    def policy_type?
+      base_id == 'cmis:policy'
+    end
+
+    def item_type?
+      base_id == 'cmis:item'
+    end
+
+    def new_object
+      object = case base_id
+      when 'cmis:document'
+        Document.new({}, repository)
+      when 'cmis:folder'
+        Folder.new({}, repository)
+      when 'cmis:relationship'
+        Relationship.new({}, repository)
+      when 'cmis:policy'
+        Policy.new({}, repository)
+      when 'cmis:item'
+        Item.new({}, repository)
+      else
+        raise "Unsupported base type: #{base_id}"
+      end
+      object.object_type_id = id
+      object
+    end
+
+    def to_hash
+      @hash
+    end
+
+  end
+end

data/lib/yaccl/version.rb

@@ -1,3 +1,3 @@
 module YACCL
-  VERSION = '0.1.5'
+  VERSION = '1.0-alpha'
 end

data/lib/yaccl.rb

@@ -1,11 +1,21 @@
-module YACCL
-  def self.init(service_url, basic_auth_username=nil, basic_auth_password=nil, succint_properties=true)
-    YACCL.const_set('SERVICE_URL', service_url)
-    YACCL.const_set('BASIC_AUTH_USERNAME', basic_auth_username)
-    YACCL.const_set('BASIC_AUTH_PASSWORD', basic_auth_password)
-    YACCL.const_set('SUCCINCT_PROPERTIES', succint_properties)
-  end
-end
-
-require 'yaccl/model'
-require 'yaccl/services'
+
+require 'yaccl/connection'
+require 'yaccl/server'
+
+require 'yaccl/helpers'
+require 'yaccl/query_result'
+require 'yaccl/query'
+require 'yaccl/children'
+
+require 'yaccl/repository'
+
+require 'yaccl/object'
+require 'yaccl/object_factory'
+require 'yaccl/document'
+require 'yaccl/folder'
+require 'yaccl/item'
+require 'yaccl/policy'
+require 'yaccl/relationship'
+
+require 'yaccl/type'
+require 'yaccl/property_definition'

data/readme.md

@@ -11,10 +11,7 @@ Running the tests requires a running CMIS server.
 ## TODO
 
 * caching
-* complete model( (update) properties)
 * (type) check service input
-* config object (basic auth, succint property…)
-* expand tests to services
 
 ## Contributing
 

data/spec/{model/document_spec.rb → document_spec.rb}

@@ -1,6 +1,6 @@
-require_relative '../helper'
+require_relative './helper'
 
-describe YACCL::Model::Document do
+describe YACCL::Document do
 
   before :all do
     @repo = create_repository('test')
@@ -15,7 +15,7 @@ describe YACCL::Model::Document do
     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 = new_object.create_in_folder(@repo.root)
     doc.name.should eq 'doc1'
     doc.content_stream_mime_type.should eq 'text/plain'
     doc.content_stream_file_name.should eq 'doc1.txt'
@@ -27,7 +27,7 @@ describe YACCL::Model::Document 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 = new_object.create_in_folder(@repo.root)
     doc.name.should eq 'doc2'
     doc.content.should be nil
     doc.delete

data/spec/{model/folder_spec.rb → folder_spec.rb}

@@ -1,6 +1,6 @@
-require_relative '../helper'
+require_relative './helper'
 
-describe YACCL::Model::Folder do
+describe YACCL::Folder do
 
   before :all do
     @repo = create_repository('test')
@@ -29,7 +29,7 @@ describe YACCL::Model::Folder do
     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.should be_a_kind_of YACCL::Document
     object.name.should eq 'doc1'
     object.content_stream_mime_type.should eq 'text/plain'
     object.content_stream_file_name.should eq 'apple.txt'
@@ -42,7 +42,7 @@ describe YACCL::Model::Folder do
     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.should be_a_kind_of YACCL::Folder
     object.name.should eq 'folder1'
     object.delete
   end
@@ -60,14 +60,14 @@ describe YACCL::Model::Folder do
       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.should be_a_kind_of YACCL::Item
       object.name.should eq 'item1'
       object.delete
     end unless @repo.cmis_version_supported < '1.1'
   end
 
   it 'create object' do
-    new_object = YACCL::Model::Object.new @repo.id
+    new_object = YACCL::Object.new({}, @repo)
     new_object.name = 'object1'
     new_object.object_type_id = 'cmis:folder'
     lambda { @repo.root.create(new_object) }.should raise_exception

data/spec/helper.rb

@@ -1,27 +1,27 @@
 require 'yaccl'
 require 'json'
 
-YACCL.init('http://33.33.33.100:8080/browser', 'metaadmin', 'metaadmin')
+META = YACCL::Server.new.repository('meta')
 
 def create_repository(id)
-  meta = YACCL::Model::Server.repository('meta')
+  delete_repository(id)
 
-  repo_type = meta.type('repository')
+  repo_type = META.type('repository')
   property_definitions = repo_type.property_definitions.keys
 
-  f = meta.new_folder
+  f = repo_type.new_object
   f.name = id
   f.properties[:id] = id
-  f.object_type_id = repo_type.id
-  f.properties[:supportsRelationships] = true if property_definitions.include?(:supportsRelationships)
-  f.properties[:supportsPolicies] = true if property_definitions.include?(:supportsPolicies)
-  f.properties[:supportsItems] = true if property_definitions.include?(:supportsItems)
-  f.properties[:realtime] = true if property_definitions.include?(:realtime)
-  meta.root.create(f)
+  f.properties[:supportsRelationships] = true if property_definitions.include?('supportsRelationships')
+  f.properties[:supportsPolicies] = true if property_definitions.include?('supportsPolicies')
+  f.properties[:supportsItems] = true if property_definitions.include?('supportsItems')
+  f.properties[:realtime] = true if property_definitions.include?('realtime')
+  META.root.create(f)
 
-  YACCL::Model::Server.repository(id)
+  YACCL::Server.new.repository(id)
 end
 
 def delete_repository(id)
-  YACCL::Model::Server.repository('meta').object(id).delete
+  META.object(id).delete
+rescue YACCL::CMISRequestError => ex
 end

data/spec/{model/object_spec.rb → object_spec.rb}

@@ -1,6 +1,6 @@
-require_relative '../helper'
+require_relative './helper'
 
-describe YACCL::Model::Object do
+describe YACCL::Object do
 
   before :all do
     @repo = create_repository('test')
@@ -12,14 +12,14 @@ describe YACCL::Model::Object do
 
   it 'repository' do
     doc = create_document
-    doc.repository.should be_a_kind_of YACCL::Model::Repository
+    doc.repository.should be_a_kind_of YACCL::Repository
     doc.repository.id.should eq 'test'
     doc.delete
   end
 
   it 'object_type' do
     doc = create_document
-    doc.object_type.should be_a_kind_of YACCL::Model::Type
+    doc.object_type.should be_a_kind_of YACCL::Type
     doc.object_type.id.should eq 'cmis:document'
     doc.delete
   end
@@ -44,7 +44,7 @@ describe YACCL::Model::Object do
     rels = doc.relationships
     rels.should_not be_nil
     rels.each do |r|
-      r.should be_a_kind_of YACCL::Model::Relationship
+      r.should be_a_kind_of YACCL::Relationship
     end
     doc.delete
   end
@@ -54,7 +54,7 @@ describe YACCL::Model::Object do
     pols = doc.policies
     pols.should_not be_nil
     pols.each do |p|
-      p.should be_a_kind_of YACCL::Model::Policy
+      p.should be_a_kind_of YACCL::Policy
     end
     doc.delete
   end

data/spec/relationship_spec.rb

@@ -0,0 +1,19 @@
+require_relative './helper'
+
+describe YACCL::Relationship do
+
+  before :all do
+    @dummy = YACCL::Server.new.repository('meta')
+  end
+
+  it 'should make properties accessible through method' do
+    new_object = YACCL::Relationship.new({ succinctProperties: { myProp: 'myValue' } }, @dummy)
+    new_object.properties['myProp'].should eq 'myValue'
+  end
+
+  it 'should raise methodmissing for unknown property' do
+    new_object = YACCL::Relationship.new({ succinctProperties: { 'myProp' => 'myValue' } }, @dummy)
+    expect { new_object.myOtherProp }.to raise_error(NoMethodError, /undefined method `myOtherProp'/)
+  end
+
+end

data/spec/repository_spec.rb

@@ -0,0 +1,150 @@
+require_relative './helper'
+
+describe YACCL::Repository do
+
+  context 'generic' do
+
+    before do
+      @id = 'meta'
+      @repo = YACCL::Server.new.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::Folder
+      @repo.new_document.should be_a_kind_of YACCL::Document
+      @repo.new_relationship.should be_a_kind_of YACCL::Relationship
+      @repo.new_policy.should be_a_kind_of YACCL::Policy
+      @repo.new_item.should be_a_kind_of YACCL::Item
+    end
+
+    it 'repositories' do
+      YACCL::Server.new.repositories
+    end
+
+    it 'repository' do
+      r = YACCL::Server.new.repository('generali')
+      r.name.should eq 'generali'
+    end
+
+    it 'root' do
+      root = @repo.root
+      root.should be_a_kind_of YACCL::Folder
+      root.cmis_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::Folder
+      object.cmis_object_id.should eq id
+    end
+
+    it 'type - document' do
+      document = @repo.type('cmis:document')
+      document.should be_a_kind_of YACCL::Type
+      document.id.should eq 'cmis:document'
+    end
+
+    it 'type - folder' do
+      folder = @repo.type('cmis:folder')
+      folder.should be_a_kind_of YACCL::Type
+      folder.id.should eq 'cmis:folder'
+    end
+  end
+
+  context 'upn' do
+
+    before :all do
+      @repo = create_repository('testrepository')
+    end
+
+    after :all do
+      delete_repository('testrepository')
+    end
+
+    it 'type - relationship' do
+      relationship = @repo.type('cmis:relationship')
+      relationship.should be_a_kind_of YACCL::Type
+      relationship.id.should eq 'cmis:relationship'
+    end
+
+    it 'type - policy' do
+      policy = @repo.type('cmis:policy')
+      policy.should be_a_kind_of YACCL::Type
+      policy.id.should eq 'cmis:policy'
+    end
+
+    it 'type - item' do
+      begin
+        item = @repo.type('cmis:item')
+        item.should be_a_kind_of YACCL::Type
+        item.id.should eq 'cmis:item'
+      end unless @repo.cmis_version_supported < '1.1'
+    end
+
+    it 'create, get, delete type - document' do
+      type_id = 'apple'
+
+      type = YACCL::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::Type
+        t.id.should eq type_id
+      end
+
+      @repo.type(type_id).delete
+    end
+
+  end
+end

data/spec/server_spec.rb

@@ -0,0 +1,22 @@
+require_relative './helper'
+
+describe YACCL::Server do
+
+  before :all do
+    @server = YACCL::Server.new
+  end
+
+  it 'repositories' do
+    @server.repositories.each do |repo|
+      repo.should be_a_kind_of YACCL::Repository
+    end
+  end
+
+  it 'repository' do
+    id = 'meta'
+    repo = @server.repository(id)
+    repo.should be_a_kind_of YACCL::Repository
+    repo.id.should eq id
+  end
+
+end