cmis-ruby 0.3.1 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d2ac859a88499ba57eb289daec0db713d00f666b
-  data.tar.gz: 2063b514d8cae8f4cb153db41dd3df2e047617d2
+  metadata.gz: 9c5f9d4df93396fe4735ee09d4d97db95c48df45
+  data.tar.gz: 8938574723b4af67c631415610fcf4f71c4a1987
 SHA512:
-  metadata.gz: d42ed7b59b590e0ceb931a5a1b8f2fc0d766413b064453d93587560756afa38afa55f8e77f20d1eec7d5a370e5674065634890d21e0f5bede8f3cc30f2a4c410
-  data.tar.gz: 61e99957d26901a28f3aed5c9107951a4287973633a64cb61d548f929190815380e24c21b253aceab50ebf0267f11cefe9e41aec998a7642d96fc5ae907dc56e
+  metadata.gz: db9eec57e4879bcd1ef91cac2f717754e3ac376995cc11fe4f4c3af91dba94b3f777af086447e785eeb4d3887e3ae0247daea4be8f0fbd44e45737b3f42db71a
+  data.tar.gz: d8e06feb0c924488abe759cf1b7525f7d3e1ee33dde2e77e5bee374164d4542bda06b057705dcc974eb806a3f39998db52e0a640a071bdbf3d4ca59ce19f8f2f

data/lib/cmis-ruby.rb

@@ -1,3 +1,6 @@
+require 'cmis/core_ext/array'
+require 'cmis/core_ext/hash'
+
 require 'cmis/connection'
 require 'cmis/exceptions'
 require 'cmis/server'
@@ -6,6 +9,7 @@ require 'cmis/object_factory'
 require 'cmis/query_result'
 require 'cmis/query'
 require 'cmis/children'
+require 'cmis/relationships'
 require 'cmis/repository'
 require 'cmis/object'
 require 'cmis/document'

data/lib/cmis/connection.rb

@@ -1,10 +1,10 @@
 require 'active_support'
+require 'json'
 require 'typhoeus'
 require 'net/http/post/multipart'
 
 module CMIS
   class Connection
-
     def initialize(service_url, username, password, headers)
       @service_url = service_url
       @username = username
@@ -15,123 +15,181 @@ module CMIS
     end
 
     def execute!(params = {}, options = {})
-      options.stringify_keys!
-      query = options['query'] || {}
-      headers = @headers.merge(options['headers'] || {})
+      query, headers = parse_options(options)
+
+      Request.new(service_url: @service_url,
+                  url_cache: @url_cache,
+                  params: params,
+                  query: query,
+                  headers: headers,
+                  username: @username,
+                  password: @password).run
+    end
 
-      url = get_url(params.delete(:repositoryId), params[:objectId])
+    private
 
-      params = transform_hash(params)
+    def parse_options(options)
+      options.symbolize_keys!
+      query = options[:query] || {}
+      headers = @headers
+      headers.merge!(options[:headers]) if options[:headers]
+      [ query, headers ]
+    end
 
-      if params[:cmisaction]
-        method = params[:content] ? 'multipart_post' : 'post'
-        body = params
-      else
-        method = 'get'
-        body = nil
-        query.merge!(params)
+    class Request
+      def initialize(options)
+        @service_url = options[:service_url]
+        @url_cache = options[:url_cache]
+        @params = massage(options[:params])
+        @repository_id = @params.delete(:repositoryId)
+        @query = options[:query]
+        @headers = options[:headers]
+        @username = options[:username]
+        @password = options[:password]
       end
 
-      response = perform_request(method: method, url: url,
-                                 body: body, query: query, headers: headers)
-
-      content_type = if response.respond_to?(:content_type)
-        response.content_type
-      else
-        response.headers['Content-Type']
+      def run
+        case method
+        when 'get'
+          typhoeus_request
+        when 'post'
+          typhoeus_request
+        when 'multipart_post'
+          multipart_post
+        end
       end
 
-      result = response.body
-      result = JSON.parse(result) if content_type =~ /application\/json/
-      result = result.with_indifferent_access if result.is_a? Hash
-
-      check_for_exception!(response.code.to_i, result)
-
-      result
-    end
-
-    private
+      private
+
+      def typhoeus_request
+        options = {
+          method: method,
+          body: body,
+          params: query,
+          headers: @headers,
+          followlocation: true
+        }
+        options[:userpwd] = "#{@username}:#{@password}" if @username
+        response = Typhoeus::Request.new(url, options).run
+        Response.new(response.headers['Content-Type'], response.body).parse!
+      end
 
-    def check_for_exception!(code, result)
-      unless (200...300).include?(code)
-        if result.is_a?(Hash) && result['exception']
-          exception_class = "CMIS::Exceptions::#{result['exception'].camelize}"
-          raise exception_class.constantize, "#{result['message']}"
+      def multipart_post
+        uri = URI.parse(url)
+        req = Net::HTTP::Post::Multipart.new(uri.path, body)
+        @headers.each { |key, value| req[key] = value }
+        req.basic_auth @username, @password if @username
+        opts = if uri.scheme == 'https'
+          { use_ssl: true , verify_mode: OpenSSL::SSL::VERIFY_NONE }
+        else
+          {}
+        end
+        Net::HTTP.start(uri.host, uri.port, opts) do |http|
+          response = http.request(req)
+          Response.new(response['Content-Type'], response.body).parse!
         end
       end
-    end
 
-    def get_url(repository_id, cmis_object_id)
-      if repository_id.nil?
-        @service_url
-      else
-        urls = repository_urls(repository_id)
-        if cmis_object_id
-          urls[:root_folder_url]
+      def url
+        if @repository_id.nil?
+          @service_url
         else
-          urls[:repository_url]
+          urls = repository_urls(@repository_id)
+          if @params[:objectId]
+            urls[:root_folder_url]
+          else
+            urls[:repository_url]
+          end
         end
       end
-    end
 
-    def repository_urls(repository_id)
-      if @url_cache[repository_id].nil?
-        repository_infos = JSON.parse(perform_request(url: @service_url).body)
-        raise Exceptions::ObjectNotFound, "repositoryId: #{repository_id}" unless repository_infos.has_key?(repository_id)
-        repository_info = repository_infos[repository_id]
-        @url_cache[repository_id] = { repository_url:  repository_info['repositoryUrl'],
-                                      root_folder_url: repository_info['rootFolderUrl'] }
+      def method
+        if @params[:cmisaction]
+          if @params[:content]
+            'multipart_post'
+          else
+            'post'
+          end
+        else
+          'get'
+        end
       end
-      @url_cache[repository_id]
-    end
 
-    def transform_hash(hash)
-      hash.reject! { |_, v| v.nil? }
+      def body
+        @params if @params[:cmisaction]
+      end
 
-      if content_hash = hash[:content]
-        hash[:content] = UploadIO.new(content_hash[:stream], content_hash[:mime_type], content_hash[:filename])
+      def query
+        if @params[:cmisaction]
+          @query
+        else
+          @params.merge(@query)
+        end
       end
 
-      if props = hash.delete(:properties)
-        props.each_with_index do |(id, value), index|
-          value = value.to_time if value.is_a?(Date) or value.is_a?(DateTime)
-          value = (value.to_f * 1000).to_i if value.is_a?(Time)
-          if value.is_a?(Array)
-            hash.merge!("propertyId[#{index}]" => id)
-            value.each_with_index do |v, idx|
-              hash.merge!("propertyValue[#{index}][#{idx}]" => value[idx])
+      # TODO: Extract functionality
+      def massage(hash)
+        hash.compact
+
+        if content_hash = hash[:content]
+          hash[:content] = UploadIO.new(content_hash[:stream],
+                                        content_hash[:mime_type],
+                                        content_hash[:filename])
+        end
+
+        if props = hash.delete(:properties)
+          props.each_with_index do |(id, value), index|
+            value = value.to_time if value.is_a?(Date) or value.is_a?(DateTime)
+            value = (value.to_f * 1000).to_i if value.is_a?(Time)
+            if value.is_a?(Array)
+              hash.merge!("propertyId[#{index}]" => id)
+              value.each_with_index do |v, idx|
+                hash.merge!("propertyValue[#{index}][#{idx}]" => value[idx])
+              end
+            else
+              hash.merge!("propertyId[#{index}]" => id,
+                          "propertyValue[#{index}]" => value)
             end
-          else
-            hash.merge!("propertyId[#{index}]" => id,
-                        "propertyValue[#{index}]" => value)
           end
         end
+        hash
       end
-      hash
-    end
 
-    def perform_request(options)
-      if options[:method] == 'multipart_post'
-        multipart_post(options)
-      else
-        typhoeus_request(options)
+      def repository_urls(repository_id)
+        if @url_cache[repository_id].nil?
+
+          options = { method: 'get' }
+          options[:userpwd] = "#{@username}:#{@password}" if @username
+          response = Typhoeus::Request.new(@service_url, options).run
+          repository_infos = JSON.parse(response.body)
+
+          unless repository_infos.has_key?(repository_id)
+            raise Exceptions::ObjectNotFound, "repositoryId: #{repository_id}"
+          end
+
+          repository_info = repository_infos[repository_id]
+          @url_cache[repository_id] = { repository_url:  repository_info['repositoryUrl'],
+                                        root_folder_url: repository_info['rootFolderUrl'] }
+        end
+        @url_cache[repository_id]
       end
     end
 
-    def typhoeus_request(options)
-      options[:params] = options.delete(:query)
-      options[:followlocation] = true
-      options[:userpwd] = "#{@username}:#{@password}" if @username
-      Typhoeus::Request.new(options.delete(:url), options).run
-    end
+    class Response
+      def initialize(content_type, body)
+        @content_type = content_type
+        @body = body
+      end
+
+      def parse!
+        return @body unless @content_type =~ /application\/json/
 
-    def multipart_post(options)
-      url = URI.parse(options[:url])
-      req = Net::HTTP::Post::Multipart.new(url.path, options[:body])
-      options[:headers].each { |key, value| req[key] = value }
-      req.basic_auth @username, @password if @username
-      opts = url.scheme == 'https' ? { use_ssl: true , verify_mode: OpenSSL::SSL::VERIFY_NONE } : {}
-      Net::HTTP.start(url.host, url.port, opts) { |http| http.request(req) }
+        result = JSON.parse(@body)
+        if result.is_a?(Hash) && ex = result['exception']
+          raise "CMIS::Exceptions::#{ex.camelize}".constantize, result['message']
+        end
+        result.with_indifferent_access
+      end
     end
   end
 end

data/lib/cmis/core_ext/array.rb

@@ -0,0 +1,14 @@
+class Array
+  def with_indifferent_access
+    map do |value|
+      case value
+      when Hash
+        value.with_indifferent_access
+      when Array
+        value.with_indifferent_access
+      else
+        value
+      end
+    end
+  end
+end

data/lib/cmis/core_ext/hash.rb

@@ -0,0 +1,5 @@
+class Hash
+  def compact
+    delete_if { |_, v| v.nil? }
+  end
+end

data/lib/cmis/helpers.rb

@@ -41,10 +41,7 @@ module CMIS
         result = raw['succinctProperties']
       elsif raw['properties']
         result = raw['properties'].reduce({}) do |h, (k, v)|
-          val = v['value']
-          val = v['value'].first if v['value'].is_a?(Array) and v['cardinality'] == 'single'
-          val = Time.at(val / 1000) if val and v['type'] == 'datetime'
-          h.merge(k => val)
+          h.merge(k => sanitize(v))
         end
       else
         result = {}
@@ -52,5 +49,21 @@ module CMIS
 
       result.with_indifferent_access
     end
+
+    def sanitize(prop)
+      value = prop['value']
+
+      # Sometimes (when?) single values come in an array
+      if value.is_a?(Array) && prop['cardinality'] == 'single'
+        value = value.first
+      end
+
+      if !!value && prop['type'] == 'datetime'
+        # CMIS sends millis since epoch
+        value = Time.at(value / 1000.0)
+      end
+
+      value
+    end
   end
 end

data/lib/cmis/object.rb

@@ -50,13 +50,8 @@ module CMIS
                             objectId: cmis_object_id }, opts)
     end
 
-    def relationships(direction = :either, opts = {})
-      result = connection.execute!({ cmisselector: 'relationships',
-                                     repositoryId: repository.id,
-                                     objectId: cmis_object_id,
-                                     relationshipDirection: direction }, opts)
-
-      result['objects'].map { |r| Relationship.new(r, repository) }
+    def relationships(opts = {})
+      Relationships.new(self, opts)
     end
 
     def policies(opts = {})

data/lib/cmis/relationship.rb

@@ -12,5 +12,9 @@ module CMIS
     def target(opts = {})
       repository.object(target_id, opts)
     end
+
+    def create(opts = {})
+      repository.create_relationship(self, opts)
+    end
   end
 end

data/lib/cmis/relationships.rb

@@ -0,0 +1,101 @@
+require 'active_support/core_ext/hash/slice'
+
+module CMIS
+  class Relationships
+    # Options: from, page_size
+    def initialize(object, options = {})
+      @object = object
+      @options = options.stringify_keys!
+
+      init_options
+    end
+
+    # Options: limit
+    def each_relationship(options = {}, &block)
+      return enum_for(:each_relationship, options) unless block_given?
+
+      init_options
+      limit = parse_limit(options)
+      counter = 0
+
+      while has_next?
+        results.each do |object|
+          break unless counter < limit
+          yield object
+          counter = counter.next
+        end
+      end
+    end
+
+    # Options: limit
+    def each_page(options = {}, &block)
+      return enum_for(:each_page, options) unless block_given?
+
+      init_options
+      limit = parse_limit(options)
+      counter = 0
+
+      while has_next?
+        break unless counter < limit
+        yield r = results
+        counter += r.size
+      end
+    end
+
+    def results
+      result = do_get_relationships
+
+      @skip_count += result.results.size
+      @has_next = result.has_more_items
+      @total = result.num_items
+
+      result.results
+    end
+
+    def has_next?
+      @has_next
+    end
+
+    def total
+      @total ||= do_get_relationships.num_items
+    end
+
+    private
+
+    def init_options
+      @max_items = @options['page_size'] || 10
+      @skip_count = @options['from'] || 0
+      @direction = @options['direction'] || :either
+      @include_subtypes = @options['include_subtypes']
+      @type_id = @options['type_id']
+      @has_next = true
+
+      @opts = @options.slice('query', 'headers')
+    end
+
+    def parse_limit(options)
+      options.stringify_keys!
+      limit = options['limit'] || 10
+      limit = BigDecimal::INFINITY if limit == :all
+      raise 'Not a valid limit' unless limit.is_a? Numeric
+      limit
+    end
+
+    def do_get_relationships
+      result = @object.connection.execute!({ cmisselector: 'relationships',
+                                             repositoryId: @object.repository.id,
+                                             objectId: @object.cmis_object_id,
+                                             maxItems: @max_items,
+                                             skipCount: @skip_count,
+                                             relationshipDirection: @direction,
+                                             includeSubRelationshipTypes: @include_subtypes,
+                                             typeId: @type_id }, @opts)
+
+      results = result['objects'].map do |r|
+        ObjectFactory.create(r, @object.repository)
+      end
+
+      QueryResult.new(results, result['numItems'], result['hasMoreItems'])
+    end
+  end
+end

data/lib/cmis/repository.rb

@@ -1,5 +1,3 @@
-require 'active_support'
-
 module CMIS
   class Repository
     attr_reader :connection
@@ -118,14 +116,7 @@ module CMIS
     QUOTE = "\'"
 
     def normalize(value)
-      case value
-      when DateTime
-        value = value.strftime('%Y-%m-%dT%H:%M:%S.%L')
-        "TIMESTAMP '#{value}'"
-      when Time
-        value = value.strftime('%Y-%m-%dT%H:%M:%S.%L')
-        "TIMESTAMP '#{value}'"
-      when Date
+      if value.respond_to?(:strftime)
         value = value.strftime('%Y-%m-%dT%H:%M:%S.%L')
         "TIMESTAMP '#{value}'"
       else

data/lib/cmis/version.rb

@@ -1,3 +1,3 @@
 module CMIS
-  VERSION = '0.3.1'
+  VERSION = '0.3.4'
 end

data/spec/helper.rb

@@ -1,5 +1,4 @@
 require 'cmis-ruby'
-require 'json'
 
 META = CMIS::Server.new.repository('meta')
 

data/spec/object_spec.rb

@@ -43,7 +43,7 @@ describe CMIS::Object do
     doc = create_document
     rels = doc.relationships
     rels.should_not be_nil
-    rels.each do |r|
+    rels.each_relationship do |r|
       r.should be_a_kind_of CMIS::Relationship
     end
     doc.delete

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cmis-ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.4
 platform: ruby
 authors:
 - Kenneth Geerts
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-27 00:00:00.000000000 Z
+date: 2014-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -69,6 +69,8 @@ files:
 - lib/cmis-ruby.rb
 - lib/cmis/children.rb
 - lib/cmis/connection.rb
+- lib/cmis/core_ext/array.rb
+- lib/cmis/core_ext/hash.rb
 - lib/cmis/document.rb
 - lib/cmis/exceptions.rb
 - lib/cmis/folder.rb
@@ -81,6 +83,7 @@ files:
 - lib/cmis/query.rb
 - lib/cmis/query_result.rb
 - lib/cmis/relationship.rb
+- lib/cmis/relationships.rb
 - lib/cmis/repository.rb
 - lib/cmis/server.rb
 - lib/cmis/type.rb