cmis-ruby 0.3.5 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dc97717108219ab5cccfdc7ebbcebdae3e49459f
-  data.tar.gz: 7f6f2d04fdf02fdd4e903024f90cf208a3b0fbc0
+  metadata.gz: 02a90b75f0be84cc302c4a1009af31ba8c5bda9b
+  data.tar.gz: 4c4fbdf04f4c5dee685f77a1ecfe43af08616431
 SHA512:
-  metadata.gz: b85d9befb1c62a5f7077040094c7100d4dd14d1f09712d831b5e8f2362f46186923e03b236c7bfb3330c5c2795e26a17b73cfb34faa97b55da60d8756d6fb07b
-  data.tar.gz: 8f82470e491ee50316dc856f5ef454749a5118ae542991f89ddbdee16e3b4726681ff892c3016f3b099e44e3c271d7c5b49e77a0d49e3b1b703fe720d07851b5
+  metadata.gz: d21dacc515544df7721021adc675a1a7492ec56d3067e0a9a7220b205274dbdbb06212cb2028b926867deef899aa8373c3112be0071ab2e1e46973633070aa21
+  data.tar.gz: 5b2ed9b877541bf0fb23f97ca15fa8f7bafa776eb803dab54c2d025fc30984023479f0c0a3b47c2b49c6cf51f452d35b56ed17cc3d3ed0170e4f95c2c86b50f2

data/cmis-ruby.gemspec

@@ -16,9 +16,8 @@ Gem::Specification.new do |s|
   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 'activesupport', '>= 3.2'
+  s.add_dependency 'faraday', '~> 0.9.0'
+  s.add_dependency 'activesupport', '>= 3.2', '< 5.0'
 
   s.description = <<-DESC.gsub(/^    /, '')
     CMIS browser binding client library in ruby.

data/lib/cmis-ruby.rb

@@ -1,16 +1,11 @@
-# ruby
 require 'bigdecimal'
 require 'json'
 
-# core extensions
 require 'active_support/core_ext'
 require 'core_ext'
 
-# HTTP
-require 'typhoeus'
-require 'net/http/post/multipart'
+require 'faraday'
 
-# cmis-ruby
 require 'cmis/connection'
 require 'cmis/exceptions'
 require 'cmis/server'
@@ -29,3 +24,4 @@ require 'cmis/policy'
 require 'cmis/relationship'
 require 'cmis/property_definition'
 require 'cmis/type'
+require 'cmis/version'

data/lib/cmis/connection.rb

@@ -1,189 +1,145 @@
 module CMIS
   class Connection
-    def initialize(service_url, username, password, headers)
-      @service_url = service_url
-      @username = username
-      @password = password
-      @headers = headers
+    def initialize(options)
+      options.symbolize_keys!
+
+      service_url = options[:service_url] || ENV['CMIS_BROWSER_URL']
+      @service_url = service_url or raise "\
+      option `:service_url` or ENV['CMIS_BROWSER_URL'] must be set"
+
+      adapter = (options[:adapter] || :net_http).to_sym
+
+      headers = {
+        user_agent: "cmis-ruby/#{VERSION} [#{adapter}]"
+      }.merge(options[:headers] || {})
+      conn_opts = { headers: headers, ssl: options[:ssl] }.compact
+
+      @http = Faraday.new(conn_opts) do |builder|
+        builder.use RequestModifier
+        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)
+        end
+
+        builder.adapter adapter
+        builder.response :logger if options[:log_requests]
+        builder.use ResponseParser
+      end
 
       @url_cache = {}
     end
 
     def execute!(params = {}, options = {})
-      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
-
-    private
-
-    def parse_options(options)
       options.symbolize_keys!
-      query = options[:query] || {}
-      headers = @headers
-      headers.merge!(options[:headers]) if options[:headers]
-      [ query, headers ]
-    end
 
-    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
+      query = options[:query] || {}
+      headers = options[:headers]|| {}
+      url = url(params.delete(:repositoryId), params[:objectId])
 
-      def run
-        case method
-        when 'get'
-          typhoeus_request
-        when 'post'
-          typhoeus_request
-        when 'multipart_post'
-          multipart_post
-        end
+      response = if params[:cmisaction]
+        @http.post(url, params, headers)
+      else
+        @http.get(url, params.merge(query), headers)
       end
 
-      private
+      response.body
+    end
 
-      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
+    private
 
-      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
+    def url(repository_id, object_id)
+      if repository_id.nil?
+        @service_url
+      else
+        urls = repository_urls(repository_id)
+        urls[object_id ? :root_folder_url : :repository_url]
       end
+    end
 
-      def url
-        if @repository_id.nil?
-          @service_url
-        else
-          urls = repository_urls(@repository_id)
-          if @params[:objectId]
-            urls[:root_folder_url]
-          else
-            urls[:repository_url]
-          end
-        end
-      end
+    def repository_urls(repository_id)
+      if @url_cache[repository_id].nil?
+        repository_infos = @http.get(@service_url).body
 
-      def method
-        if @params[:cmisaction]
-          if @params[:content]
-            'multipart_post'
-          else
-            'post'
-          end
-        else
-          'get'
+        unless repository_infos.has_key?(repository_id)
+          raise Exceptions::ObjectNotFound, "repositoryId: #{repository_id}"
         end
-      end
 
-      def body
-        @params if @params[:cmisaction]
+        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 query
-        if @params[:cmisaction]
-          @query
-        else
-          @params.merge(@query)
-        end
+  class RequestModifier < Faraday::Middleware
+    def call(env)
+      if env[:body]
+        env[:body].compact!
+        wrap_content(env)
+        massage_properties(env)
       end
+      @app.call(env)
+    end
 
-      # TODO: Extract functionality
-      def massage(hash)
-        hash.compact
+    private
 
-        if content_hash = hash[:content]
-          hash[:content] = UploadIO.new(content_hash[:stream],
-                                        content_hash[:mime_type],
-                                        content_hash[:filename])
-        end
+    def wrap_content(env)
+      if content_hash = env[:body][:content]
+        env[:body][:content] = Faraday::UploadIO.new(content_hash[:stream],
+                                                     content_hash[:mime_type],
+                                                     content_hash[:filename])
+      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])
-              end
-            else
-              hash.merge!("propertyId[#{index}]" => id,
-                          "propertyValue[#{index}]" => value)
+    def massage_properties(env)
+      if props = env[:body].delete(:properties)
+        props.each_with_index do |(id, value), index|
+          if value.is_a?(Array)
+            env[:body][id_key(index)] = id
+            value.each_with_index do |sub_value, sub_index|
+              env[:body][val_key(index, sub_index)] = normalize(sub_value)
             end
+          else
+            env[:body][id_key(index)] = id
+            env[:body][val_key(index)] = normalize(value)
           end
         end
-        hash
       end
+    end
 
-      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
+    def normalize(value)
+      value = value.to_time if value.is_a?(Date)
+      value = (value.to_f * 1000).to_i if value.is_a?(Time)
+      value
     end
 
-    class Response
-      def initialize(content_type, body)
-        @content_type = content_type
-        @body = body
-      end
+    def id_key(index)
+      "propertyId[#{index}]"
+    end
 
-      def parse!
-        return @body unless @content_type =~ /application\/json/
+    def val_key(i1, i2 = nil)
+      result = "propertyValue[#{i1}]"
+      result = "#{result}[#{i2}]" if i2
+      result
+    end
+  end
 
-        result = JSON.parse(@body)
-        if result.is_a?(Hash) && ex = result['exception']
-          raise "CMIS::Exceptions::#{ex.camelize}".constantize, result['message']
+  class ResponseParser < Faraday::Middleware
+    def call(env)
+      @app.call(env).on_complete do |env|
+        if env[:response_headers][:content_type] =~ /\/(x-)?json(;.+?)?$/
+          env[:body] = JSON.parse(env[:body]).with_indifferent_access
+          if env[:body].is_a?(Hash) && ex = env[:body][:exception]
+            ruby_exception = "CMIS::Exceptions::#{ex.camelize}".constantize
+            raise ruby_exception, env[:body]['message']
+          end
         end
-        result.with_indifferent_access
       end
     end
   end

data/lib/cmis/server.rb

@@ -3,16 +3,7 @@ module CMIS
     attr_reader :connection
 
     def initialize(options = {})
-      options.stringify_keys!
-
-      service_url = options['service_url'] || ENV['CMIS_BROWSER_URL']
-      username    = options['username']    || ENV['CMIS_USER']
-      password    = options['password']    || ENV['CMIS_PASSWORD']
-      headers     = options['headers']     || {}
-
-      raise "`service_url` must be set" unless service_url
-
-      @connection = Connection.new(service_url, username, password, headers)
+      @connection = Connection.new(options)
     end
 
     def repositories(opts = {})

data/lib/cmis/version.rb

@@ -1,3 +1,3 @@
 module CMIS
-  VERSION = '0.3.5'
+  VERSION = '0.3.6'
 end

data/readme.md

@@ -10,7 +10,6 @@ Running the tests requires a running CMIS server.
 
 ## TODO
 
-* use Faraday for HTTP
 * facilitate copy between servers (make a flow)
 * caching
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cmis-ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.3.6
 platform: ruby
 authors:
 - Kenneth Geerts
@@ -9,36 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-04 00:00:00.000000000 Z
+date: 2014-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: typhoeus
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
-- !ruby/object:Gem::Dependency
-  name: multipart-post
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -46,6 +32,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -53,6 +42,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 description: |
   CMIS browser binding client library in ruby.
 email: