yaccl 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+Gemfile.lock
+
+.idea
+*.iml

data/Gemfile

@@ -0,0 +1,6 @@
+source :rubygems
+
+gemspec
+
+gem 'rake'
+gem 'rspec'

data/Rakefile

@@ -0,0 +1,7 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.rspec_opts = ['--colour']
+end
+
+task default: [:spec]

data/examples/create_type_manual.rb

@@ -0,0 +1,40 @@
+require 'yaccl'
+
+repository = YACCL::Model::Server.repository('blueprint')
+
+type = YACCL::Model::Type.new
+type.id = 'apple'
+type.local_name = 'apple'
+type.query_name = 'apple'
+type.display_name = 'Apple'
+type.parent_id = 'cmis:document'
+type.base_id = 'cmis:document'
+type.description = 'The apple fruit.'
+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: 'The color.',
+  propertyType: 'string',
+  cardinality: 'single',
+  updatability: 'readwrite',
+  inherited: false,
+  required: false,
+  queryable: true,
+  orderable: true
+)
+
+full_type = repository.create_type(type)
+puts full_type.to_hash
+repository.delete_type(type.id)

data/lib/yaccl.rb

@@ -0,0 +1,10 @@
+module YACCL
+  VERSION = '0.0.1'
+
+  def self.init(url)
+    YACCL.const_set('SERVICE_URL', url)
+  end
+end
+
+require 'yaccl/model'
+require 'yaccl/services'

data/lib/yaccl/model.rb

@@ -0,0 +1,10 @@
+require 'yaccl/model/object'
+require 'yaccl/model/object_factory'
+require 'yaccl/model/document'
+require 'yaccl/model/folder'
+require 'yaccl/model/item'
+require 'yaccl/model/policy'
+require 'yaccl/model/relationship'
+require 'yaccl/model/repository'
+require 'yaccl/model/type'
+require 'yaccl/model/server'

data/lib/yaccl/model/document.rb

@@ -0,0 +1,63 @@
+module YACCL
+  module Model
+    class Document < Object
+      attr_reader :is_immutable
+      attr_reader :is_latest_version
+      attr_reader :is_major_version
+      attr_reader :is_latest_major_version
+      attr_reader :is_private_working_copy
+      attr_reader :version_label
+      attr_reader :version_series_id
+      attr_reader :version_series_checked_out
+      attr_reader :version_series_checked_out_by
+      attr_reader :version_series_checked_out_id
+      attr_reader :checkin_comment
+      attr_reader :content_stream_length
+      attr_reader :content_stream_mime_type
+      attr_reader :content_stream_file_name
+      attr_reader :content_stream_id
+
+      def initialize(repository_id, raw={})
+        super
+        @is_immutable = @properties[:'cmis:isImmutable']
+        @is_latest_version = @properties[:'cmis:isLatestVersion']
+        @is_major_version = @properties[:'cmis:isMajorVersion']
+        @is_lastest_major_version = @properties[:'cmis:isLatestMajorVersion']
+        @is_private_working_copy = @properties[:'cmis:isPrivateWorkingCopy']
+        @version_label = @properties[:'cmis:versionLabel']
+        @version_series_id = @properties[:'cmis:versionSeriesId']
+        @version_series_checked_out = @properties[:'cmis:isVersionSeriesCheckedOut']
+        @version_series_checked_out_by = @properties[:'cmis:versionSeriesCheckedOutBy']
+        @version_series_checked_out_id = @properties[:'cmis:versionSeriesCheckedOutId']
+        @checkin_comment = @properties[:'cmis:checkinComment']
+        @content_stream_length = @properties[:'cmis:contentStreamLength']
+        @content_stream_mime_type = @properties[:'cmis:contentStreamMimeType']
+        @content_stream_file_name = @properties[:'cmis:contentStreamFileName']
+        @content_stream_id = @properties[:'cmis:contentStreamId']
+      end
+
+      def copy_in_folder(folder)
+        new_object_id = Services.create_document_from_source(repository_id, object_id, nil, folder.object_id, nil, nil, nil, nil)
+        repository.object(new_object_id)
+      end
+
+      def content
+        Services.get_content_stream(repository_id, object_id, nil, nil, nil)
+      end
+
+      def set_content(stream, mime_type, filename)
+        content = {stream: stream, mime_type: mime_type, filename: filename}
+        if detached?
+          @local_content = content
+        else
+          Services.set_content_stream(repository_id, object_id, nil, nil, content)
+        end
+      end
+
+      def create_in_folder(folder_id)
+        hash = Services.create_document(repository_id, create_properties, folder_id, @local_content, nil, nil, nil, nil)
+        ObjectFactory.create(repository_id, hash)
+      end
+    end
+  end
+end

data/lib/yaccl/model/folder.rb

@@ -0,0 +1,66 @@
+module YACCL
+  module Model
+    class Folder < Object
+      attr_reader :parent_id
+      attr_reader :path
+      attr_reader :allowed_child_object_type_ids
+
+      def initialize(repository_id, raw={})
+        super
+        @parent_id = @properties[:'cmis:parentId']
+        @path = @properties[:'cmis:path']
+        @allowed_child_object_type_ids = @properties[:'cmis:allowedChildObjectTypeIds']
+      end
+
+      def parent
+        repository.object(parent_id) unless parent_id.nil?
+      end
+
+      def allowed_child_object_types
+        return nil if allowed_child_object_type_ids.nil?
+        allowed_child_object_type_ids.map do |type_id|
+          repository.type(type_id)
+        end
+      end
+
+      def children
+        Services.navigation.get_children(repository_id, object_id, nil, nil, nil, nil, nil, nil, nil, nil).map do |o|
+          ObjectFactory.create(repository_id, o)
+        end
+      end
+
+      def tree(depth)
+      end
+
+      def create(object)
+        properties = object.create_properties
+        if object.is_a? Folder
+          o = Services.create_folder(repository_id, properties, object_id, nil, nil, nil)
+        elsif object.is_a? Document
+          return object.create_in_folder(object_id)
+        elsif object.is_a? Relationship
+          raise 'relationship is not fileable'
+        elsif object.is_a? Policy
+          o = Services.create_policy(repository_id, properties, object_id, nil, nil, nil)
+        elsif object.is_a? Item
+          o = Services.create_item(repository_id, properties, object_id, nil, nil, nil)
+        else
+          raise "Unexpected base_type_id: #{object.base_type_id}"
+        end
+        ObjectFactory.create(repository_id, o)
+      end
+
+      def delete_tree
+        Services.delete_tree(repository_id, object_id, true, false, false)
+      end
+
+      def add(object)
+        Services.add_object_to_folder(repository_id, object.object_id, object_id, nil)
+      end
+
+      def remove(object)
+        Services.remove_object_from_folder(repository_id, object.object_id, object_id)
+      end
+    end
+  end
+end

data/lib/yaccl/model/item.rb

@@ -0,0 +1,9 @@
+module YACCL
+  module Model
+    class Item < Object
+      def initialize(repository_id, raw={})
+        super
+      end
+    end
+  end
+end

data/lib/yaccl/model/object.rb

@@ -0,0 +1,98 @@
+module YACCL
+  module Model
+    class Object
+      attr_reader :repository_id
+      attr_reader :object_id
+      attr_reader :base_type_id
+      attr_accessor :object_type_id
+      attr_reader :secondary_object_type_ids
+      attr_accessor :name
+      attr_reader :description
+      attr_reader :created_by
+      attr_reader :creation_date
+      attr_reader :last_modified_by
+      attr_reader :last_modification_date
+      attr_reader :change_token
+      attr_reader :properties
+
+      def initialize(repository_id, raw={})
+        @repository_id = repository_id
+        @properties = get_properties_map(raw)
+        @object_id = @properties[:'cmis:objectId']
+        @base_type_id = @properties[:'cmis:baseTypeId']
+        @object_type_id = @properties[:'cmis:objectTypeId']
+        @secondary_object_type_ids = @properties[:'cmis:secondaryObjectTypeId']
+        @name = @properties[:'cmis:name']
+        @description = @properties[:'cmis:description']
+        @created_by = @properties[:'cmis:createdBy']
+        @creation_date = @properties[:'cmis:creationDate']
+        @last_modified_by = @properties[:'cmis:lastModifiedBy']
+        @last_modification_date = @properties[:'cmis:lastModificationDate']
+        @change_token = @properties[:'cmis:changeToken']
+      end
+
+      def repository
+        Server.repository(repository_id)
+      end
+
+      def object_type
+        repository.type(object_type_id)
+      end
+
+      def delete
+        Services.delete_object(repository_id, object_id, true)
+      end
+
+      def allowable_actions
+        Services.get_allowable_actions(repository_id, object_id)
+      end
+
+      def relationships(direction='either')
+        result = Services.get_object_relationships(repository_id, object_id, nil, direction, nil, nil, false, nil, nil)
+        result[:objects] = result[:objects].map { |r| Relationship.create(repository_id, r) }
+        result
+      end
+
+      def policies
+        Services.get_applied_policies(repository_id, object_id, nil).map do |policy|
+          Policy.create(repository_id, policy)
+        end
+      end
+
+      # remove from all folders
+      def unfile
+        Services.remove_object_from_folder(repository_id, object_id, nil)
+      end
+
+      def acls
+        Services.get_acl(repository_id, object_id, nil)
+      end
+
+      def add_aces(aces)
+        Services.apply_acl(repository_id, object_id, aces, nil, nil)
+      end
+
+      def remove_aces(aces)
+        Services.apply_acl(repository_id, object_id, nil, aces, nil)
+      end
+
+      protected
+
+      def create_properties
+        {'cmis:name' => name, 'cmis:objectTypeId' => object_type_id}.merge(properties)
+      end
+
+      def detached?
+        object_id.nil?
+      end
+
+      private
+
+      def get_properties_map(raw)
+        raw_properties = raw[:properties]
+        return {} if raw_properties.nil?
+        raw_properties.reduce({}) { |h, (k, v)| h.merge(k => v[:value]) }
+      end
+    end
+  end
+end

data/lib/yaccl/model/object_factory.rb

@@ -0,0 +1,18 @@
+module YACCL
+  module Model
+    class ObjectFactory
+      def self.create(repository_id, raw)
+        properties = raw[:properties]
+        base_type_id = properties[:'cmis:baseTypeId'][:value]
+        case base_type_id
+        when 'cmis:folder' then Folder.new(repository_id, raw)
+        when 'cmis:document' then Document.new(repository_id, raw)
+        when 'cmis:relationship' then Relationship.new(repository_id, raw)
+        when 'cmis:policy' then Policy.new(repository_id, raw)
+        when 'cmis:item' then Item.new(repository_id, raw)
+        else raise "Unexpected baseTypeId: #{base_type_id}."
+        end
+      end
+    end
+  end
+end

data/lib/yaccl/model/policy.rb

@@ -0,0 +1,20 @@
+module YACCL
+  module Model
+    class Policy < Object
+      attr_reader :policy_text
+
+      def initialize(repository_id, raw={})
+        super
+        @policy_text = @properties[:'cmis:policyText']
+      end
+
+      def apply_to(object)
+        Services.apply_policy(repository_id, object_id, object.object_id)
+      end
+
+      def remove_from(object)
+        Services.remove_policy(repository_id, object_id, object.object_id)
+      end
+    end
+  end
+end

data/lib/yaccl/model/relationship.rb

@@ -0,0 +1,22 @@
+module YACCL
+  module Model
+    class Relationship < Object
+      attr_reader :source_id
+      attr_reader :target_id
+
+      def initialize(repository_id, raw={})
+        super
+        @source_id = @properties['cmis:sourceId']
+        @target_id = @properties['cmis:targetId']
+      end
+
+      def source
+        Object.create(Services.get_object(repository_id, source_id, nil, false, false, nil, false, false))
+      end
+
+      def target
+        Object.create(Services.get_object(repository_id, target_id, nil, false, false, nil, false, false))
+      end
+    end
+  end
+end

data/lib/yaccl/model/repository.rb

@@ -0,0 +1,106 @@
+module YACCL
+  module Model
+    class Repository
+      attr_reader :id
+      attr_reader :name
+      attr_reader :description
+      attr_reader :root_folder_id
+      attr_reader :capabilities
+      attr_reader :url
+      attr_reader :latest_change_log_token
+      attr_reader :vendor_name
+      attr_reader :cmis_version_supported
+      attr_reader :acl_capabilities
+      attr_reader :product_name
+      attr_reader :product_version
+      attr_reader :thin_client_uri
+      attr_reader :changes_on_type
+      attr_reader :root_folder_url
+
+      def self.create(raw_repository)
+        Repository.new(raw_repository)
+      end
+
+      def initialize(raw)
+        @id = raw[:repositoryId]
+        @name = raw[:repositoryName]
+        @description = raw[:repositoryDescription]
+        @root_folder_id = raw[:rootFolderId]
+        @capabilities = raw[:capabilities]
+        @url = raw[:repositoryUrl]
+        @latest_change_log_token = raw[:latestChangeLogToken]
+        @vendor_name = raw[:vendorName]
+        @cmis_version_supported = raw[:cmisVersionSupported]
+        @acl_capabilities = raw[:aclCapabilities]
+        @product_name = raw[:productName]
+        @product_version = raw[:productVersion]
+        @thin_client_uri = raw[:thinClientUri]
+        @changes_on_type = raw[:changesOnType]
+        @root_folder_url = raw[:rootFolderUrl]
+      end
+
+      def new_folder
+        Folder.new(id)
+      end
+
+      def new_document
+        Document.new(id)
+      end
+
+      def new_relationship
+        Relationship.new(id)
+      end
+
+      def new_policy
+        Policy.new(id)
+      end
+
+      def new_item
+        Item.new(id)
+      end
+
+      # object
+
+      def root
+        ObjectFactory.create(id, Services.get_object(id, root_folder_id, nil, false, nil, nil, false, false))
+      end
+
+      def object(object_id)
+        ObjectFactory.create(id, Services.get_object(id, object_id, nil, false, nil, nil, false, false))
+      end
+
+      # type
+
+      def type(type_id)
+        Type.create(Services.get_type_definition(id, type_id))
+      end
+
+      def type_tree
+      end
+
+      def create_type(type)
+        Type.create(Services.create_type(id, type.to_hash))
+      end
+
+      def update_type(type)
+        Type.create(Services.update_type(id, type.to_hash))
+      end
+
+      def delete_type(type_id)
+        Services.delete_type(id, type_id)
+      end
+
+      # discovery
+
+      def query(statement)
+        Services.query(id, statement, false, nil, nil, nil, nil, nil).map do |o|
+          ObjectFactory.create(id, o)
+        end
+      end
+
+      def content_changes(change_log_token)
+        Services.get_content_changes(id, change_log_token, nil, nil, nil, nil)
+      end
+    end
+  end
+end