cmis-ruby 0.3.8 → 0.3.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5509c0d7a7ebe328fb70713c0d33286634414c3b
-  data.tar.gz: 1b083a997de518a72a4d3de31b955321f32184ef
+  metadata.gz: eb2a6ae007e4f3159fd4f301e20f41566a88e0c7
+  data.tar.gz: 847b9a6c163696833c89fdedcb63248658fa7557
 SHA512:
-  metadata.gz: 71aeea351aef546a84493d3090c959b62f8b318c9adc0e13ffbb98ed8125cc7ac03bb63c1ae18d82936ce2a0eb80092b1f71074b9b1b94ea0667fb0bc8ec154a
-  data.tar.gz: 933826ba179011b28eda09faa060b4fc722ff5ea595f0a243a9ddc9dbbec9581b50d50f40151936e02550b590c287f256cc43f5ff18588de3470f22fd73c7ea2
+  metadata.gz: f8dbd5f1d1dfd272697240739e7fd8dd9af6f111be7f4afe4946e286920186580b07dcd4f3d71097fad75310c908e1d90d0faf3b82c1f21eb34a995975933d84
+  data.tar.gz: a16cdbc5e5acfb6a5fff6d0b0de835729e644d596e574381cfc718a6fe1eb97316ccd953dddf1d6fb640791373e91023dbda49c3ef1dba91fb3acd857769129f

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+env:
+  - TEST_ENV=alfresco

data/Gemfile

@@ -2,5 +2,7 @@ source 'https://rubygems.org'
 
 gemspec
 
-gem 'rake'
-gem 'rspec'
+group :test do
+  gem 'rake'
+  gem 'rspec'
+end

data/Rakefile

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

data/cmis-ruby.gemspec

@@ -2,23 +2,25 @@ $LOAD_PATH.unshift 'lib'
 require 'cmis/version'
 
 Gem::Specification.new do |s|
-  s.name              = 'cmis-ruby'
-  s.version           = CMIS::VERSION
-  s.date              = Time.now.strftime('%Y-%m-%d')
-  s.authors           = ['Kenneth Geerts', 'Michael Brackx']
-  s.email             = ['kenneth@up-nxt.com']
-  s.homepage          = 'https://github.com/UP-nxt'
-  s.summary           = 'Ruby client for CMIS'
-  s.license           = 'Apache-2.0'
-  s.has_rdoc          = false
+  s.name                  = 'cmis-ruby'
+  s.version               = CMIS::VERSION
+  s.date                  = Time.now.strftime('%Y-%m-%d')
+  s.authors               = ['Kenneth Geerts', 'Michael Brackx']
+  s.email                 = ['kenneth@up-nxt.com']
+  s.homepage              = 'https://github.com/UP-nxt'
+  s.summary               = 'Ruby client for CMIS'
+  s.license               = 'Apache-2.0'
+  s.has_rdoc              = false
 
-  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.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         = %w( lib )
 
-  s.add_dependency    'faraday', '~> 0.9'
-  s.add_dependency    'activesupport', '>= 3.2', '< 5.0'
+  s.required_ruby_version = '>= 1.9.3'
+
+  s.add_dependency        'faraday', '~> 0.9'
+  s.add_dependency        'activesupport', '>= 3.2', '< 5.0'
 
   s.description = <<-DESCRIPTION
 CMIS browser binding client library in ruby.

data/lib/cmis/children.rb

@@ -88,7 +88,7 @@ module CMIS
                                  skipCount: @skip_count,
                                  orderBy: @order_by,
                                  includeRelationships: @include_relationships,
-                                 filter: @filter}, @opts)
+                                 filter: @filter }, @opts)
 
       results = result['objects'].map { |o| build_object_with_relationships(o) }
       QueryResult.new(results, result['numItems'], result['hasMoreItems'])

data/lib/cmis/connection.rb

@@ -3,8 +3,8 @@ module CMIS
     def initialize(options)
       options.symbolize_keys!
 
-      @service_url = options[:service_url] || ENV['CMIS_BROWSER_URL'] or \
-        raise "option `:service_url` or ENV['CMIS_BROWSER_URL'] must be set"
+      message = "option `service_url` must be set"
+      @service_url = options[:service_url] or raise message
 
       adapter = (options[:adapter] || :net_http).to_sym
 
@@ -18,9 +18,8 @@ module CMIS
         builder.request :multipart
         builder.request :url_encoded
 
-        if username = options[:username] || ENV['CMIS_USER']
-          password = options[:password] || ENV['CMIS_PASSWORD']
-          builder.basic_auth(username, password)
+        if options[:username]
+          builder.basic_auth(options[:username], options[:password])
         end
 
         builder.adapter adapter
@@ -35,7 +34,7 @@ module CMIS
       options.symbolize_keys!
 
       query = options[:query] || {}
-      headers = options[:headers]|| {}
+      headers = options[:headers] || {}
       url = url(params.delete(:repositoryId), params[:objectId])
 
       response = if params[:cmisaction]

data/lib/cmis/document.rb

@@ -37,12 +37,15 @@ module CMIS
                         repositoryId: repository.id,
                         objectId: cmis_object_id }, opts)
 
-    rescue Exceptions::Constraint
-      # Check for specific constraint?
-      nil
+    rescue Exceptions::Constraint => e
+      if e.message =~ /no content stream/
+        nil
+      else
+        raise e
+      end
     end
 
-    def set_content(opts = {})
+    def content=(opts = {})
       opts.stringify_keys!
       content = { stream: opts.delete('stream'),
                   mime_type: opts.delete('mime_type'),

data/lib/cmis/folder.rb

@@ -21,29 +21,16 @@ module CMIS
 
     def create(object, opts = {})
       case object
-      when Relationship
-        raise "'cmis:relationship' is not fileable. Use Repository#create_relationship"
-
       when Document
         return object.create_in_folder(self, opts)
-
       when Folder
-        o = server.execute!({ cmisaction: 'createFolder',
-                              repositoryId: repository.id,
-                              properties: object.properties,
-                              objectId: cmis_object_id }, opts)
-
+        o = create_in_self(object, 'createFolder', opts)
       when Policy
-        o = server.execute!({ cmisaction: 'createPolicy',
-                              repositoryId: repository.id,
-                              properties: object.properties,
-                              objectId: cmis_object_id }, opts)
+        o = create_in_self(object, 'createPolicy', opts)
       when Item
-        o = server.execute!({ cmisaction: 'createItem',
-                              repositoryId: repository.id,
-                              properties: object.properties,
-                              objectId: cmis_object_id }, opts)
-
+        o = create_in_self(object, 'createItem', opts)
+      when Relationship
+        raise "`cmis:relationship` is not fileable. Use Repository#create_relationship."
       else
         raise "Unexpected base_type_id: #{object.base_type_id}"
       end
@@ -70,5 +57,14 @@ module CMIS
                         objectId: object.cmis_object_id,
                         folderId: cmis_object_id }, opts)
     end
+
+    private
+
+    def create_in_self(object, cmis_action, opts)
+      server.execute!({ cmisaction: cmis_action,
+                        repositoryId: repository.id,
+                        properties: object.properties,
+                        objectId: cmis_object_id }, opts)
+    end
   end
 end

data/lib/cmis/helpers.rb

@@ -68,14 +68,17 @@ module CMIS
     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
+      # Sometimes (when?) single values come in an array.
+      # For now, we do nothing to hide this and leave it up to the user.
+      # #  value = value.first if value.is_a?(Array)
 
       if !!value && prop['type'] == 'datetime'
         # CMIS sends millis since epoch
-        value = Time.at(value / 1000.0)
+        if value.is_a? Array
+          value.map! { |v| Time.at(v / 1000.0) }
+        else
+          value = Time.at(value / 1000.0)
+        end
       end
 
       value

data/lib/cmis/repository.rb

@@ -68,7 +68,7 @@ module CMIS
       Type.new(result, self)
     end
 
-    def has_type?(type_id)
+    def type?(type_id)
       type(type_id)
       true
     rescue Exceptions::ObjectNotFound
@@ -120,7 +120,7 @@ module CMIS
         value = value.strftime('%Y-%m-%dT%H:%M:%S.%L')
         "TIMESTAMP '#{value}'"
       else
-        # TODO Correct escaping for find_object
+        # TODO: Correct escaping for find_object
         # value = value.gsub(BACKSLASH, BACKSLASH * 4).gsub(QUOTE, "#{BACKSLASH * 2}#{QUOTE}")
         "'#{value}'"
       end
@@ -130,7 +130,7 @@ module CMIS
       types = []
       a.each do |t|
         types << Type.new(t['type'], self)
-        types << construct_types(t['children']) if t.has_key?('children')
+        types << construct_types(t['children']) if t.key?('children')
       end
       types.flatten
     end

data/lib/cmis/server.rb

@@ -1,6 +1,5 @@
 module CMIS
   class Server < Connection
-
     def initialize(options = {})
       super
     end
@@ -20,7 +19,7 @@ module CMIS
       Repository.new(result[repository_id], self)
     end
 
-    def has_repository?(repository_id)
+    def repository?(repository_id)
       repository(repository_id)
       true
     rescue Exceptions::ObjectNotFound

data/lib/cmis/version.rb

@@ -1,3 +1,3 @@
 module CMIS
-  VERSION = '0.3.8'
+  VERSION = '0.3.9'
 end

data/readme.md

@@ -1,12 +1,15 @@
-# cmis-ruby
+# CMIS ruby
 
-**cmis-ruby** is a [CMIS](http://chemistry.apache.org/project/cmis.html) client library, using the the CMIS browser binding ([CMIS 1.1](http://docs.oasis-open.org/cmis/CMIS/v1.1/CMIS-v1.1.html)) for Ruby.
+[![Gem Version](https://badge.fury.io/rb/cmis-ruby.png)](http://badge.fury.io/rb/cmis-ruby)
+[![Code Climate](https://codeclimate.com/github/UP-nxt/cmis-ruby.png)](https://codeclimate.com/github/UP-nxt/cmis-ruby)
+[![Build Status](https://travis-ci.org/UP-nxt/cmis-ruby.png?branch=master)](https://travis-ci.org/UP-nxt/cmis-ruby)
+[![Dependency Status](https://gemnasium.com/UP-nxt/cmis-ruby.png)](https://gemnasium.com/UP-nxt/cmis-ruby)
 
-## Running Test
+**CMIS ruby** is a [CMIS](http://chemistry.apache.org/project/cmis.html) client library, using the the CMIS browser binding ([CMIS 1.1](http://docs.oasis-open.org/cmis/CMIS/v1.1/CMIS-v1.1.html)) for Ruby.
 
-Running the tests requires a running CMIS server.
+## Running specs
 
-    rake
+Running the tests requires a separate CMIS server. The default rake task runs the specs.
 
 ## TODO
 
@@ -15,4 +18,4 @@ Running the tests requires a running CMIS server.
 
 ## Contributing
 
-Write some code. Run tests. Open a pull request.
+Write some code. Run the specs. Open a pull request.

data/spec/cmis-ruby/document_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+module CMIS
+  describe Document do
+    context 'when creating a document with content' do
+      it 'has properties and content' do
+        document = repository.new_document
+        document.name = 'apple_document'
+        document.object_type_id = 'cmis:document'
+        document.content = { stream: StringIO.new('apple is a fruit'),
+                             mime_type: 'text/apple',
+                             filename: 'apple.txt' }
+        document = document.create_in_folder(repository.root)
+
+        expect(document.content_stream_mime_type).to eq('text/apple')
+        expect(document.content_stream_file_name).to eq('apple.txt')
+        expect(document.content).to eq('apple is a fruit')
+
+        document.delete
+      end
+    end
+
+    context 'when creating a document without content' do
+      it 'has properties and no content' do
+        document = repository.new_document
+        document.name = 'apple_document'
+        document.object_type_id = 'cmis:document'
+        document = document.create_in_folder(repository.root)
+
+        expect(document.content_stream_mime_type).to be_nil
+        expect(document.content_stream_file_name).to be_nil
+        expect(document.content).to be_nil
+
+        document.delete
+      end
+    end
+
+    context 'when creating a document and then setting the content' do
+      it 'has properties and content' do
+        document = repository.new_document
+        document.name = 'apple_document'
+        document.object_type_id = 'cmis:document'
+        document = document.create_in_folder(repository.root)
+
+        document.content = { stream: StringIO.new('apple is a fruit'),
+                             mime_type: 'text/apple',
+                             filename: 'apple.txt' }
+
+        # Why doesn't this work?
+        # expect(document.content_stream_mime_type).to eq('text/apple')
+        # expect(document.content_stream_file_name).to eq('apple.txt')
+        expect(document.content).to eq('apple is a fruit')
+
+        document.delete
+      end
+    end
+  end
+end

data/spec/cmis-ruby/folder_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+module CMIS
+  describe Folder do
+    describe '#parent' do
+      before do
+        @folder = create_folder
+      end
+
+      after do
+        @folder.delete
+      end
+
+      it 'is nil for the root folder' do
+        expect(repository.root.parent).to be_nil
+      end
+
+      it 'is the root folder for its child' do
+        expect(@folder.parent.cmis_object_id).to eq(repository.root_folder_id)
+      end
+
+      def create_folder
+        folder = repository.new_folder
+        folder.name = 'test_folder'
+        folder.object_type_id = 'cmis:folder'
+        repository.root.create(folder)
+      end
+    end
+
+    describe '#create' do
+      context 'when creating a relationship in a folder' do
+        it 'raises an exception' do
+          relationship = repository.new_relationship
+          relationship.name = 'test_relationship'
+          relationship.object_type_id = 'cmis:relationship'
+          expect {
+            repository.root.create(new_object)
+          }.to raise_exception
+        end
+      end
+
+      context 'when creating an item in a folder' do
+        it 'raises an exception' do
+          item = repository.new_item
+          item.name = 'test_item'
+          item.object_type_id = 'cmis:item'
+          item = repository.root.create(item)
+          expect(item).to be_a CMIS::Item
+          expect(item.name).to eq('test_item')
+          item.delete
+        end
+      end
+
+      context 'when creating a plain object in a folder' do
+        it 'raises an exception' do
+          new_object = CMIS::Object.new({}, repository)
+          new_object.name = 'object1'
+          new_object.object_type_id = 'cmis:folder'
+          expect {
+            repository.root.create(new_object)
+          }.to raise_exception
+        end
+      end
+    end
+  end
+end

data/spec/cmis-ruby/object_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+module CMIS
+  describe Object do
+    before do
+      @document = create_document
+    end
+
+    after do
+      @document.delete
+    end
+
+    describe '#properties' do
+      # Property accessor behavior...
+    end
+
+    describe '#object_type' do
+      it 'returns the type' do
+        expect(@document.object_type).to be_a CMIS::Type
+        expect(@document.object_type.id).to eq('cmis:document')
+      end
+    end
+
+    describe '#parents' do
+      it 'has the root as only parent' do
+        expect(@document.parents.size).to eq(1)
+        expect(@document.parents.first.cmis_object_id).to eq(repository.root_folder_id)
+      end
+    end
+
+    describe '#allowable_actions' do
+      it 'returns the allowable actions' do
+        actions = @document.allowable_actions
+        expect(actions).to_not be_nil
+        expect(actions).to_not be_empty
+        actions.values.each do |v|
+          expect([true, false]).to include(v)
+        end
+      end
+    end
+
+    describe '#relationships' do
+      it 'returns all relationships' do
+        relationships = @document.relationships
+        expect(relationships).to be_a_kind_of(Relationships)
+        relationships.each_relationship do |r|
+          expect(r).to be_a(Relationship)
+        end
+      end
+    end
+
+    describe '#unfile' do
+      it 'unfiles it from the parent folder' do
+        @document.unfile
+        expect(@document.parents).to be_empty
+      end
+    end
+
+    describe '#acls' do
+      it 'returns acls' do
+        acls = @document.acls
+        expect(acls).to have_key(:aces)
+        expect(acls).to have_key(:isExact)
+        expect([true, false]).to include(acls[:isExact])
+      end
+    end
+
+    def create_document
+      document = repository.new_document
+      document.name = 'test_document'
+      document.object_type_id = 'cmis:document'
+      repository.root.create(document)
+    end
+  end
+end