cmis-ruby 0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 107af5f3b660dfdeb4a37320f00df2dcd1f90482
+  data.tar.gz: fd8d344df8996b58419b6f2919b0fb0fed6fa58d
+SHA512:
+  metadata.gz: b05da4dcef03c6c98e164027e3e3ea019696cf4fce952efbf19d02c75293d8693f6ac248bb4536ca51afac7a154e0a93ba30295acdce48e80ded87064f683ce4
+  data.tar.gz: 1af4ac5bb0fdcb9395f26388e8d8c2fe372a68195dd3c460c05fd75c336e5f220143eea43064b440bd5261d21e75789e03ac03e69c3b6a6c1c3a5e3c2bd31bfc

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake'
+gem 'rspec'

data/LICENSE

@@ -0,0 +1,176 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

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/cmis-ruby.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cmis/version'
+
+Gem::Specification.new do |s|
+  s.name = 'cmis-ruby'
+  s.version = CMIS::VERSION
+  s.authors = ['Kenneth Geerts', 'Michael Brackx']
+  s.email = ['gem@up-nxt.com']
+  s.homepage = 'https://github.com/UP-nxt'
+  s.summary = 'Ruby client for CMIS'
+
+  s.files = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ['lib']
+
+  s.add_dependency 'typhoeus', '~> 0.6'
+  s.add_dependency 'multipart-post', '~> 1.1'
+  s.add_dependency 'multi_json', '~> 1.5'
+  s.add_dependency 'activesupport', '>= 3.2'
+
+  s.description = <<-DESC.gsub(/^    /, '')
+    CMIS browser binding client library in ruby.
+  DESC
+end

data/lib/cmis-ruby.rb

@@ -0,0 +1,20 @@
+require 'cmis/connection'
+require 'cmis/server'
+
+require 'cmis/helpers'
+require 'cmis/query_result'
+require 'cmis/query'
+require 'cmis/children'
+
+require 'cmis/repository'
+
+require 'cmis/object'
+require 'cmis/object_factory'
+require 'cmis/document'
+require 'cmis/folder'
+require 'cmis/item'
+require 'cmis/policy'
+require 'cmis/relationship'
+
+require 'cmis/type'
+require 'cmis/property_definition'

data/lib/cmis/children.rb

@@ -0,0 +1,95 @@
+module CMIS
+  class Children
+
+    # Options: from, page_size
+    def initialize(folder, options = {})
+      @folder = folder
+      @options = options.stringify_keys!
+
+      init_options
+    end
+
+    # Options: limit
+    def each_result(options = {}, &block)
+      return enum_for(:each_result, 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_children
+
+      @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_children.num_items
+    end
+
+    private
+
+    def init_options
+      @max_items = @options['page_size'] || 10
+      @skip_count = @options['from'] || 0
+      @order_by = @options['order_by']
+      @has_next = true
+    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_children
+      result = @folder.connection.execute!({ cmisselector: 'children',
+                                             repositoryId: @folder.repository.id,
+                                             objectId: @folder.cmis_object_id,
+                                             maxItems: @max_items,
+                                             skipCount: @skip_count,
+                                             orderBy: @order_by })
+
+      results = result['objects'].map do |r|
+        ObjectFactory.create(r['object'], @folder.repository)
+      end
+
+      QueryResult.new(results, result['numItems'], result['hasMoreItems'])
+    end
+
+  end
+end

data/lib/cmis/connection.rb

@@ -0,0 +1,147 @@
+require 'active_support/core_ext/hash/indifferent_access'
+require 'date'
+require 'typhoeus'
+require 'net/http/post/multipart'
+require 'multi_json'
+
+module CMIS
+
+  class CMISRequestError < Exception; end
+
+  class Connection
+
+    def initialize(service_url, username, password, headers = {})
+      @service_url = service_url
+      @username = username
+      @password = password
+      @headers = headers
+
+      @url_cache = {}
+    end
+
+    def execute!(params = {}, query = {}, headers = {})
+
+      url = get_url(params.delete(:repositoryId), params[:objectId])
+
+      params = transform_hash(params)
+
+      if params.has_key?(:cmisaction)
+        method = params.has_key?(:content) ? 'multipart_post' : 'post'
+        body = params
+      else
+        method = 'get'
+        body = nil
+        query.merge!(params)
+      end
+
+      response = perform_request(method: method,
+                                 url: url,
+                                 query: query,
+                                 body: body,
+                                 headers: headers)
+
+      result = response.body
+
+      content_type = if response.respond_to?(:content_type)
+        response.content_type
+      else
+        response.headers['Content-Type']
+      end
+
+      result = MultiJson.load(result) if content_type =~ /application\/json/
+      result = result.with_indifferent_access if result.is_a? Hash
+
+      unless (200...300).include?(response.code.to_i)
+        if result.is_a?(Hash) && result.has_key?(:exception)
+          raise CMISRequestError, "#{response.code} -- #{result[:exception]} -- #{result[:message]}"
+        else
+          raise CMISRequestError, "#{response.code} -- #{result}"
+        end
+      end
+
+      result
+    end
+
+    private
+
+    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]
+        else
+          urls[:repository_url]
+        end
+      end
+    end
+
+    def repository_urls(repository_id)
+      if @url_cache[repository_id].nil?
+        repository_infos = MultiJson.load(perform_request(url: @service_url).body , symbolize_keys: false)
+        raise "No repository found with ID #{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'] }
+      end
+      @url_cache[repository_id]
+    end
+
+    def transform_hash(hash)
+      hash.reject! { |_, v| v.nil? }
+
+      if hash.has_key?(:content)
+        content = hash.delete(:content)
+        hash[:content] = UploadIO.new(content[:stream],
+                                      content[:mime_type],
+                                      content[:filename])
+      end # Move to multipart_post?
+
+      if hash.has_key?(:properties)
+        props = hash.delete(:properties)
+        if props.is_a?(Hash)
+          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
+          end
+        end
+      end
+      hash
+    end
+
+    def perform_request(options)
+      if options[:method] == 'multipart_post'
+        multipart_post(options)
+      else
+        typhoeus_request(options)
+      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
+
+    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) }
+    end
+
+  end
+end