yaccl 0.0.1

data/lib/yaccl/model/server.rb

@@ -0,0 +1,13 @@
+module YACCL
+  module Model
+    class Server
+      def self.repositories
+        Services.get_repositories.values.map { |r| Repository.create(r) }
+      end
+
+      def self.repository(repository_id)
+        Repository.create(Services.get_repository_info(repository_id).values.first)
+      end
+    end
+  end
+end

data/lib/yaccl/model/type.rb

@@ -0,0 +1,88 @@
+module YACCL
+  module Model
+    class Type
+      attr_accessor :id
+      attr_accessor :local_name
+      attr_accessor :local_namespace
+      attr_accessor :query_name
+      attr_accessor :display_name
+      attr_accessor :base_id
+      attr_accessor :parent_id
+      attr_accessor :description
+      attr_accessor :creatable
+      attr_accessor :fileable
+      attr_accessor :queryable
+      attr_accessor :controllable_policy
+      attr_accessor :controllable_acl
+      attr_accessor :fulltext_indexed
+      attr_accessor :included_in_supertype_query
+      attr_accessor :property_definitions
+      # document type
+      attr_accessor :versionable
+      attr_accessor :content_stream_allowed
+      # relationship type
+      attr_accessor :allowed_source_types
+      attr_accessor :allowed_target_types
+
+      def self.create(raw)
+        Type.new(raw)
+      end
+
+      def initialize(hash={})
+        @id = hash[:id]
+        @local_name = hash[:localName]
+        @local_namespace = hash[:localNamespace]
+        @query_name = hash[:queryName]
+        @display_name = hash[:displayName]
+        @base_id = hash[:baseId]
+        @parent_id = hash[:parentId]
+        @description = hash[:description]
+        @creatable = hash[:creatable]
+        @fileable = hash[:fileable]
+        @queryable = hash[:queryable]
+        @controllable_policy = hash[:controllablePolicy]
+        @controllable_acl = hash[:controllableACL]
+        @fulltext_indexed = hash[:fulltextIndexed]
+        @included_in_supertype_query = hash[:includedInSupertype_query]
+        @property_definitions = hash[:propertyDefinitions] || {}
+        # document type
+        @versionable = hash[:versionable]
+        @content_stream_allowed = hash[:contentStreamAllowed]
+        # relationship type
+        @allowed_source_types = hash[:allowedSourceTypes]
+        @allowed_target_types = hash[:allowedTargetTypes]
+      end
+
+      def add_property_definition(property)
+        @property_definitions[property[:id]] = property
+      end
+
+      def to_hash
+        hash = {}
+        hash[:id] = id
+        hash[:localName] = local_name
+        hash[:localNamespace] = local_namespace
+        hash[:queryName]= query_name
+        hash[:displayName]= display_name
+        hash[:baseId]= base_id
+        hash[:parentId]= parent_id
+        hash[:description]= description
+        hash[:creatable]= creatable
+        hash[:fileable]= fileable
+        hash[:queryable]= queryable
+        hash[:controllablePolicy]= controllable_policy
+        hash[:controllableACL]= controllable_acl
+        hash[:fulltextIndexed]= fulltext_indexed
+        hash[:includedInSupertypeQuery]= included_in_supertype_query
+        hash[:propertyDefinitions]= property_definitions
+        # document type
+        hash[:versionable] = versionable unless versionable.nil?
+        hash[:contentStreamAllowed] = content_stream_allowed unless content_stream_allowed.nil?
+        # relationship type
+        hash[:allowedSourceTypes] = allowed_source_types unless allowed_source_types.nil?
+        hash[:allowedTargetTypes] = allowed_target_types unless allowed_target_types.nil?
+        hash
+      end
+    end
+  end
+end

data/lib/yaccl/services.rb

@@ -0,0 +1,31 @@
+require 'yaccl/services/internal/browser_binding_service'
+require 'yaccl/services/repository_services'
+require 'yaccl/services/navigation_services'
+require 'yaccl/services/object_services'
+require 'yaccl/services/multi_filing_services'
+require 'yaccl/services/discovery_services'
+require 'yaccl/services/versioning_services'
+require 'yaccl/services/relationship_services'
+require 'yaccl/services/policy_services'
+require 'yaccl/services/acl_services'
+
+module YACCL
+  module Services
+    class << self
+      def perform_request(*params)
+        service = Internal::BrowserBindingService.new(YACCL::SERVICE_URL)
+        service.perform_request(*params)
+      end
+
+      include RepositoryServices
+      include NavigationServices
+      include ObjectServices
+      include MultiFilingServices
+      include DiscoveryServices
+      include VersioningServices
+      include RelationshipServices
+      include PolicyServices
+      include ACLServices
+    end
+  end
+end

data/lib/yaccl/services/acl_services.rb

@@ -0,0 +1,21 @@
+module YACCL
+  module ACLServices
+    def get_acl(repository_id, object_id, only_basic_permissions, extension={})
+      required = {cmisselector: 'acl',
+                  repositoryId: repository_id,
+                  objectId: object_id}
+      optional = {onlyBasicPermissions: only_basic_permissions}
+      perform_request(required, optional)
+    end
+
+    def apply_acl(repository_id, object_id, add_aces, remove_aces, acl_propagation, extension={})
+      required = {cmisaction: 'applyACL',
+                  repositoryId: repository_id,
+                  objectId: object_id}
+      optional = {addACEs: add_aces,
+                  removeACEs: remove_aces,
+                  ACLPropagation: acl_propagation}
+      perform_request(required, optional)
+    end
+  end
+end

data/lib/yaccl/services/discovery_services.rb

@@ -0,0 +1,27 @@
+module YACCL
+  module DiscoveryServices
+    def query(repository_id, statement, search_all_versions, include_relationships, rendition_filter, include_allowable_actions, max_items, skip_count, extension={})
+      required = {cmisselector: 'query',
+                  repositoryId: repository_id,
+                  q: statement}
+      optional = {searchAllVersions: search_all_versions,
+                  includeRelationships: include_relationships,
+                  renditionFilter: rendition_filter,
+                  includeAllowableActions: include_allowable_actions,
+                  maxItems: max_items,
+                  skipCount: skip_count}
+      perform_request(required, optional)
+    end
+
+    def get_content_changes(repository_id, change_log_token, include_properties, include_policy_ids, include_acl, max_items, extension={})
+      required = {cmisselector: 'contentChanges',
+                  repositoryId: repository_id}
+      optional = {changeLogToken: change_log_token,
+                  includeProperties: include_properties,
+                  includePolicyIds: include_policy_ids,
+                  includeAcl: include_acl,
+                  maxItems: max_items}
+      perform_request(required, optional)
+    end
+  end
+end

data/lib/yaccl/services/internal/browser_binding_service.rb

@@ -0,0 +1,99 @@
+require 'httparty'
+require 'net/http/post/multipart'
+require 'multi_json'
+
+module YACCL
+  module Services
+    class CMISRequestError < RuntimeError; end
+
+    module Internal
+      class BrowserBindingService
+        def initialize(service_url)
+          @service_url = service_url
+        end
+
+        def perform_request(required_params={}, optional_params={})
+          url = get_url(required_params.delete(:repositoryId), required_params[:objectId])
+
+          optional_params.reject! { |_, v| v.nil? }
+          params = transform_hash(required_params.merge(optional_params))
+
+          check(params)
+
+          response = if params.has_key?(:cmisaction)
+            if params.has_key?(:content)
+              Basement.multipart_post(url, params)
+            else
+              Basement.post(url, body: params)
+            end
+          else
+            Basement.get(url, query: params)
+          end
+
+          result = response.body
+          if response.content_type == 'application/json'
+            result = MultiJson.load(result, symbolize_keys: true)
+            if result.is_a?(Hash) && result.has_key?(:exception)
+              raise CMISRequestError, "#{result[:exception]} -- #{result[:message]}"
+            end
+          end
+          result
+        end
+
+        private
+
+        def get_url(repository_id, object_id)
+          if repository_id.nil?
+            @service_url
+          else
+            repository_info = Basement.get(@service_url)[repository_id]
+            repository_info[object_id.nil? ? 'repositoryUrl' : 'rootFolderUrl']
+          end
+        end
+
+        def check(hash)
+          check_in(hash, :includeRelationships, [:none, :source, :target, :both])
+        end
+
+        def check_in(hash, key, arr)
+          value = hash[key]
+          unless value.nil?
+            unless arr.include?(value)
+              raise ArgumentError, "#{key} must be one of #{arr}."
+            end
+          end
+        end
+
+        def transform_hash(hash)
+          if hash.has_key?(:content)
+            content = hash.delete(:content)
+            hash[:content] = UploadIO.new(content[:stream],
+                                          content[:mime_type],
+                                          content[:filename])
+          end
+          if hash.has_key?(:properties)
+            props = hash.delete(:properties)
+            if props.is_a?(Hash)
+              props.each_with_index do |(id, value), index|
+                hash.merge!("propertyId[#{index}]" => id,
+                            "propertyValue[#{index}]" => value)
+              end
+            end
+          end
+          hash
+        end
+
+        class Basement
+          include HTTParty
+
+          def self.multipart_post(url, options)
+            url = URI.parse(url)
+            Net::HTTP.start(url.host, url.port) do |http|
+              http.request(Net::HTTP::Post::Multipart.new(url.path, options))
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yaccl/services/multi_filing_services.rb

@@ -0,0 +1,20 @@
+module YACCL
+  module MultiFilingServices
+    def add_object_to_folder(repository_id, object_id, folder_id, all_versions, extension={})
+      required = {cmisaction: 'addObjectToFolder',
+                  repositoryId: repository_id,
+                  objectId: object_id,
+                  folderId: folder_id}
+      optional = {allVersions: all_versions}
+      perform_request(required, optional)
+    end
+
+    def remove_object_from_folder(repository_id, object_id, folder_id, extension={})
+      required = {repositoryId: repository_id,
+                  cmisaction: 'removeObjectFromFolder',
+                  objectId: object_id}
+      optional = {folderId: folder_id}
+      perform_request(required, optional)
+    end
+  end
+end

data/lib/yaccl/services/navigation_services.rb

@@ -0,0 +1,78 @@
+module YACCL
+  module NavigationServices
+    def get_children(repository_id, folder_id, filter, order_by, include_allowable_actions, include_relationships, rendition_filter, include_path_segment, max_items, skip_count, extension={})
+      required = {cmisselector: 'children',
+                  repositoryId: repository_id,
+                  objectId: folder_id}
+      optional = {filter: filter,
+                  orderBy: order_by,
+                  includeAllowableActions: include_allowable_actions,
+                  includeRelationships: include_relationships,
+                  renditionFilter: rendition_filter,
+                  includePathSegment: include_path_segment,
+                  maxItems: max_items,
+                  skipCount: skip_count}
+      perform_request(required, optional)
+    end
+
+    def get_descendants(repository_id, folder_id, depth, filter, include_allowable_actions, include_relationships, rendition_filter, include_path_segment, extension={})
+      required = {cmisselector: 'descendants',
+                  repositoryId: repository_id,
+                  objectId: folder_id}
+      optional = {depth: depth,
+                  filter: filter,
+                  includeAllowableActions: include_allowable_actions,
+                  includeRelationships: include_relationships,
+                  renditionFilter: rendition_filter,
+                  includePathSegment: include_path_segment}
+      perform_request(required, optional)
+    end
+
+    def get_folder_tree(repository_id, folder_id, depth, filter, include_allowable_actions, include_relationships, rendition_filter, include_path_segment, extension={})
+      required = {cmisselector: 'folderTree',
+                  repositoryId: repository_id,
+                  objectId: folder_id}
+      optional = {depth: depth,
+                  filter: filter,
+                  includeAllowableActions: include_allowable_actions,
+                  includeRelationships: include_relationships,
+                  renditionFilter: rendition_filter,
+                  includePathSegment: include_path_segment}
+      perform_request(required, optional)
+    end
+
+    def get_folder_parent(repository_id, folder_id, filter, extension={})
+      required = {cmisselector: 'parent',
+                  repositoryId: repository_id,
+                  objectId: folder_id}
+      optional = {filter:filter}
+      perform_request(required, optional)
+    end
+
+    def get_object_parents(repository_id, object_id, filter, include_allowable_actions, include_relationships, rendition_filter, include_relative_path_segment, extension={})
+      required = {cmisselector: 'parents',
+                  repositoryId: repository_id,
+                  objectId: object_id}
+      optional = {filter: filter,
+                  includeAllowableActions: include_allowable_actions,
+                  includeRelationships: include_relationships,
+                  renditionFilter: rendition_filter,
+                  includePathSegment: include_path_segment}
+      perform_request(required, optional)
+    end
+
+    def get_checked_out_docs(repository_id, folder_id, filter, order_by, include_allowable_actions, include_relationships, rendition_filter, max_items, skip_count, extension={})
+      required = {cmisselector: 'checkedout',
+                  repositoryId: repository_id}
+      optional =  {objectId: folder_id,
+                   filter: filter,
+                   orderBy: order_by,
+                   includeAllowableActions: include_allowable_actions,
+                   includeRelationships: include_relationships,
+                   renditionFilter: rendition_filter,
+                   maxItems: max_items,
+                   skipCount: skip_count}
+      perform_request(required, optional)
+    end
+  end
+end

data/lib/yaccl/services/object_services.rb

@@ -0,0 +1,192 @@
+module YACCL
+  module ObjectServices
+    def get_object(repository_id, object_id, filter, include_allowable_actions, include_relationships, rendition_filter, include_policy_ids, include_acl, extension={})
+      required = {cmisselector: 'object',
+                  repositoryId: repository_id,
+                  objectId: object_id}
+      optional = {filter: filter,
+                  includeAllowableActions: include_allowable_actions,
+                  includeRelationships: include_relationships,
+                  renditionFilter: rendition_filter,
+                  includePolicyIds: include_policy_ids,
+                  includeAcl: include_acl}
+      perform_request(required, optional)
+    end
+
+    def get_properties(repository_id, object_id, filter, extension={})
+      required = {cmisselector: 'properties',
+                  repositoryId: repository_id,
+                  objectId: object_id}
+      optional = {filter: filter}
+      perform_request(required, optional)
+    end
+
+    def create_document(repository_id, properties, folder_id, content, versioning_state, policies, add_aces, remove_aces, extension={})
+      required = {cmisaction: 'createDocument',
+                  repositoryId: repository_id,
+                  properties: properties}
+      optional = {objectId: folder_id,
+                  content: content,
+                  versioningState: versioning_state,
+                  policies: policies,
+                  addACEs: add_aces,
+                  removeACEs: remove_aces}
+      perform_request(required, optional)
+    end
+
+    def create_document_from_source(repository_id, source_id, properties, folder_id, versioning_state, policies, add_aces, remove_aces, extension={})
+      required = {cmisaction: 'createDocument',
+                  repositoryId: repository_id,
+                  sourceId: source_id}
+      optional = {properties: properties,
+                  objectId: folder_id,
+                  versioningState: versioning_state,
+                  policies: policies,
+                  addACEs: add_aces,
+                  removeACEs: remove_aces}
+      perform_request(required, optional)
+    end
+
+    def create_folder(repository_id, properties, folder_id, policies, add_aces, remove_aces, extension={})
+      required = {cmisaction: 'createFolder',
+                  repositoryId: repository_id,
+                  properties: properties,
+                  objectId: folder_id}
+      optional = {policies: policies,
+                  addACEs: add_aces,
+                  removeACEs: remove_aces}
+      perform_request(required, optional)
+    end
+
+    def create_relationship(repository_id, properties, policies, add_aces, remove_aces, extension={})
+      required = {cmisaction: 'createRelationship',
+                  repositoryId: repository_id,
+                  properties: properties}
+      optional  = {policies: policies,
+                   addACEs: add_aces,
+                   removeACEs: remove_aces}
+      perform_request(required, optional)
+    end
+
+    def create_policy(repository_id, properties, folder_id, policies, add_aces, remove_aces, extension={})
+      required = {cmisaction: 'createPolicy',
+                  repositoryId: repository_id,
+                  properties: properties}
+      optional = {objectId: folder_id,
+                  policies: policies,
+                  addACEs: add_aces,
+                  removeACEs: remove_aces}
+      perform_request(required, optional)
+    end
+
+    def create_item(repository_id, properties, folder_id, policies, add_aces, remove_aces, extension={})
+      required = {cmisaction: 'createItem',
+                  repositoryId: repository_id,
+                  properties: properties}
+      optional = {objectId: folder_id,
+                  policies: policies,
+                  addACEs: add_aces,
+                  removeACEs: remove_aces}
+      perform_request(required, optional)
+    end
+
+    def get_allowable_actions(repository_id, object_id, extension={})
+      required = {cmisselector: 'allowableActions',
+                  repositoryId: repository_id,
+                  objectId: object_id}
+      perform_request(required)
+    end
+
+    def get_renditions(repository_id, object_id, rendition_filter, max_items, skip_count, extension={})
+      required = {cmisselector: 'renditions',
+                  repositoryId: repository_id,
+                  objectId: object_id}
+      optional = {renditionFilter: rendition_filter,
+                  maxItems: max_items,
+                  skipCount: skip_count}
+      perform_request(required, optional)
+    end
+
+    def get_object_by_path(repository_id, path, filter, include_allowable_actions, include_relationships, rendition_filter, include_policy_ids, include_acl, extension={})
+      raise 'Not supported.'
+    end
+
+    def get_content_stream(repository_id, object_id, stream_id, offset, length, extension={})
+      required = {cmisselector: 'content',
+                  repositoryId: repository_id,
+                  objectId: object_id}
+      optional = {streamId: stream_id,
+                  offset: offset,
+                  length: length}
+      perform_request(required, optional)
+    end
+
+    def update_properties(repository_id, object_id, change_token, properties, extension={})
+      required = {cmisaction: 'update',
+                  repositoryId: repository_id,
+                  objectId: object_id,
+                  properties: properties}
+      optional = {changeToken: change_token}
+      perform_request(required, optional)
+    end
+
+    def bulk_update_properties(repository_id, object_ids_and_change_tokens, properties, add_secondary_type_ids, remove_secondary_type_ids, extension={})
+      # TODO
+    end
+
+    def move_object(repository_id, object_id, target_folder_id, source_folder_id, extension={})
+      required = {cmisaction: 'move',
+                  repositoryId: repository_id,
+                  objectId: object_id,
+                  targetFolderId: target_folder_id,
+                  sourceFolderId: source_folder_id}
+      perform_request(required)
+    end
+
+    def delete_object(repository_id, object_id, all_versions, extension={})
+      required = {cmisaction: 'delete',
+                  repositoryId: repository_id,
+                  objectId: object_id}
+      optional = {allVersions: all_versions}
+      perform_request(required, optional)
+    end
+
+    def delete_tree(repository_id, folder_id, all_versions, unfile_objects, continue_on_failure, extension={})
+      required = {cmisaction: 'deleteTree',
+                  repositoryId: repository_id,
+                  objectId: folder_id}
+      optional = {allVersions: all_versions,
+                  unfileObjects: unfile_objects,
+                  continueOnFailure: continue_on_failure}
+      perform_request(required, optional)
+    end
+
+    def set_content_stream(repository_id, object_id, overwrite_flag, change_token, content, extension={})
+      required = {cmisaction: 'setContent',
+                  repositoryId: repository_id,
+                  objectId: object_id,
+                  content: content}
+      optional = {overwriteFlag: overwrite_flag,
+                  changeToken:change_token}
+      perform_request(required, optional)
+    end
+
+    def delete_content_stream(repository_id, object_id, change_token, extension={})
+      required = {cmisaction: 'deleteContent',
+                  repositoryId: repository_id,
+                  objectId: object_id}
+      optional = {changeToken: change_token}
+      perform_request(required, optional)
+    end
+
+    def append_content_stream(repository_id, object_id, change_token, content, is_last_chunk, extension={})
+      required = {cmisaction: 'appendContent',
+                  repositoryId: repository_id,
+                  objectId: object_id,
+                  content: content}
+      optional = {isLastChunk: is_last_chunk,
+                  changeToken: change_token}
+      perform_request(required, optional)
+    end
+  end
+end