groupdocs 2.2.0 → 2.3.0

data/lib/groupdocs/api/helpers/path_helper.rb

@@ -1,28 +1,28 @@
-module GroupDocs
-  module Api
-    module Helpers
-      module Path
-
-        #
-        # Make helper methods accessible as class methods as well
-        #
-        def self.included(klass)
-          klass.extend self
-        end
-
-        private
-
-        #
-        # Prepares path.
-        # @param [String] path
-        # @return [String]
-        # @api private
-        #
-        def prepare_path(path)
-          path.sub(%r(^/), '').gsub(%r(//+), '/')
-        end
-
-      end # Path
-    end # Helpers
-  end # Api
-end # GroupDocs
+module GroupDocs
+  module Api
+    module Helpers
+      module Path
+
+        #
+        # Make helper methods accessible as class methods as well
+        #
+        def self.included(klass)
+          klass.extend self
+        end
+
+        private
+
+        #
+        # Prepares path.
+        # @param [String] path
+        # @return [String]
+        # @api private
+        #
+        def prepare_path(path)
+          path.sub(%r(^/), '').gsub(%r(//+), '/')
+        end
+
+      end # Path
+    end # Helpers
+  end # Api
+end # GroupDocs

data/lib/groupdocs/api/helpers/rest_helper.rb

@@ -1,99 +1,99 @@
-require 'json'
-require 'rest-client'
-
-module GroupDocs
-  module Api
-    module Helpers
-      module REST
-
-        DEFAULT_HEADERS = {
-          :accept             => 'application/json',
-          :content_length     => 0,
-          :groupdocs_referrer => "ruby/#{VERSION}"
-        }
-
-        private
-
-        #
-        # Prepares headers, method and payload for request.
-        #
-        # @api private
-        #
-        def prepare_request
-          if options[:headers].is_a?(Hash)
-            options[:headers].merge!(DEFAULT_HEADERS)
-          else
-            options[:headers] = DEFAULT_HEADERS.dup
-          end
-
-          options[:method] = options[:method].to_s.downcase.to_sym
-
-          if options[:request_body] && !options[:request_body].is_a?(Object::File)
-            unless options[:plain]
-              options[:request_body] = options[:request_body].to_json
-              options[:headers][:content_type]= 'application/json'
-            end
-            options[:headers][:content_length] = options[:request_body].length
-          end
-        end
-
-        #
-        # Changed in release 1.5.8
-        #
-        # Sends request to API server.
-        #
-        # @api private
-        #
-        def send_request
-
-          self.response = case options[:method]
-            when :get, :download
-              resource[options[:path]].get(options[:headers])
-            when :post
-              resource[options[:path]].post(options[:request_body], options[:headers])
-            when :put
-              resource[options[:path]].put(options[:request_body], options[:headers])
-            when :delete
-              if options[:request_body]
-              url = GroupDocs.api_server + options[:path]
-              RestClient::Request.execute(options.merge(
-                            :method => :delete,
-                            :url => url,
-                            :payload => options[:request_body],
-                            :headers => options[:headers]))
-              else
-                resource[options[:path]].delete(options[:headers])
-              end
-            else
-              raise UnsupportedMethodError, "Unsupported HTTP method: #{options[:method].inspect}"
-          end
-        end
-
-        #
-        # Parses response from API server.
-        #
-        # @api private
-        #
-        def parse_response
-          # for DOWNLOAD requests, just return response
-          if options[:method] == :download
-            response
-          # for all other requests, parse JSON
-          else
-            json = JSON.parse(response, :symbolize_names => true)
-            json[:status] == 'Ok' ? json[:result] : raise_bad_request_error(json)
-          end
-        end
-
-        #
-        # @raise [GroupDocs::BadResponseError]
-        # @api private
-        #
-        def raise_bad_request_error(json)
-          raise BadResponseError, json[:error_message]
-        end
-
-      end # REST
-    end # Helpers
-  end # Api
-end # GroupDocs
+require 'json'
+require 'rest-client'
+
+module GroupDocs
+  module Api
+    module Helpers
+      module REST
+
+        DEFAULT_HEADERS = {
+          :accept             => 'application/json',
+          :content_length     => 0,
+          :groupdocs_referrer => "ruby/#{VERSION}"
+        }
+
+        private
+
+        #
+        # Prepares headers, method and payload for request.
+        #
+        # @api private
+        #
+        def prepare_request
+          if options[:headers].is_a?(Hash)
+            options[:headers].merge!(DEFAULT_HEADERS)
+          else
+            options[:headers] = DEFAULT_HEADERS.dup
+          end
+
+          options[:method] = options[:method].to_s.downcase.to_sym
+
+          if options[:request_body] && !options[:request_body].is_a?(Object::File)
+            unless options[:plain]
+              options[:request_body] = options[:request_body].to_json
+              options[:headers][:content_type]= 'application/json'
+            end
+            options[:headers][:content_length] = options[:request_body].length
+          end
+        end
+
+        #
+        # Changed in release 1.5.8
+        #
+        # Sends request to API server.
+        #
+        # @api private
+        #
+        def send_request
+
+          self.response = case options[:method]
+            when :get, :download
+              resource[options[:path]].get(options[:headers])
+            when :post
+              resource[options[:path]].post(options[:request_body], options[:headers])
+            when :put
+              resource[options[:path]].put(options[:request_body], options[:headers])
+            when :delete
+              if options[:request_body]
+              url = GroupDocs.api_server + options[:path]
+              RestClient::Request.execute(options.merge(
+                            :method => :delete,
+                            :url => url,
+                            :payload => options[:request_body],
+                            :headers => options[:headers]))
+              else
+                resource[options[:path]].delete(options[:headers])
+              end
+            else
+              raise UnsupportedMethodError, "Unsupported HTTP method: #{options[:method].inspect}"
+          end
+        end
+
+        #
+        # Parses response from API server.
+        #
+        # @api private
+        #
+        def parse_response
+          # for DOWNLOAD requests, just return response
+          if options[:method] == :download
+            response
+          # for all other requests, parse JSON
+          else
+            json = JSON.parse(response, :symbolize_names => true)
+            json[:status] == 'Ok' ? json[:result] : raise_bad_request_error(json)
+          end
+        end
+
+        #
+        # @raise [GroupDocs::BadResponseError]
+        # @api private
+        #
+        def raise_bad_request_error(json)
+          raise BadResponseError, json[:error_message]
+        end
+
+      end # REST
+    end # Helpers
+  end # Api
+end # GroupDocs

data/lib/groupdocs/api/helpers/signature_public_helper.rb

@@ -1,22 +1,22 @@
-module GroupDocs
-  module Api
-    module Helpers
-      module SignaturePublic
-
-        private
-
-        #
-        # Returns corresponding URI fragment for (un)public call.
-        #
-        # @param [Boolean, nil] public_flag
-        # @return [String]
-        # @api private
-        #
-        def client_id(public_flag)
-          !!public_flag ? 'public' : '{{client_id}}'
-        end
-
-      end # SignaturePublic
-    end # Helpers
-  end # Api
-end # GroupDocs
+module GroupDocs
+  module Api
+    module Helpers
+      module SignaturePublic
+
+        private
+
+        #
+        # Returns corresponding URI fragment for (un)public call.
+        #
+        # @param [Boolean, nil] public_flag
+        # @return [String]
+        # @api private
+        #
+        def client_id(public_flag)
+          !!public_flag ? 'public' : '{{client_id}}'
+        end
+
+      end # SignaturePublic
+    end # Helpers
+  end # Api
+end # GroupDocs

data/lib/groupdocs/api/helpers/status_helper.rb

@@ -1,27 +1,27 @@
-module GroupDocs
-  module Api
-    module Helpers
-      module Status
-
-        private
-
-        #
-        # Converts status from/to human-readable format.
-        #
-        # @param [String, Symbol] status
-        # @return [Symbol, String]
-        # @raise [ArgumentError] if argument is not symbol/string
-        # @api private
-        #
-        def parse_status(status)
-          case status
-          when Symbol then status.to_s.camelize
-          when String then status.underscore.to_sym
-          else raise ArgumentError, "Expected string/symbol, received: #{status.class}"
-          end
-        end
-
-      end # Status
-    end # Helpers
-  end # Api
-end # GroupDocs
+module GroupDocs
+  module Api
+    module Helpers
+      module Status
+
+        private
+
+        #
+        # Converts status from/to human-readable format.
+        #
+        # @param [String, Symbol] status
+        # @return [Symbol, String]
+        # @raise [ArgumentError] if argument is not symbol/string
+        # @api private
+        #
+        def parse_status(status)
+          case status
+          when Symbol then status.to_s.camelize
+          when String then status.underscore.to_sym
+          else raise ArgumentError, "Expected string/symbol, received: #{status.class}"
+          end
+        end
+
+      end # Status
+    end # Helpers
+  end # Api
+end # GroupDocs

data/lib/groupdocs/api/helpers/url_helper.rb

@@ -1,101 +1,101 @@
-require 'base64'
-require 'uri'
-require 'cgi'
-
-module GroupDocs
-  module Api
-    module Helpers
-      module URL
-
-        #
-        # Appends path with parameters.
-        #
-        # @param [Hash] params
-        #
-        def add_params(params)
-          params.each do |param, value|
-            value = value.join(',') if value.is_a?(Array)
-            options[:path] << "#{separator}#{param}=#{value}"
-          end
-        end
-
-        private
-
-        #
-        # Normalizes path replacing two or more slashes with one.
-        #
-        # @api private
-        #
-        def normalize_path
-          options[:path].gsub!(%r(//+), '/')
-        end
-
-        #
-        # URL encodes path.
-        #
-        # @api private
-        #
-        def url_encode_path
-          options[:path] = URI.escape(options[:path])
-          # handle special symbols correctly
-          options[:path].gsub!('[', '%5B')
-          options[:path].gsub!(']', '%5D')
-          options[:path].gsub!('+', '%2B')
-        end
-
-        #
-        # Parses path replacing {{client_id}} with real one.
-        #
-        # @api private
-        #
-        def replace_client_id
-          options[:path].sub!(/\{\{client_id\}\}/, client_id)
-        end
-
-
-        #
-        # Adds signature to path.
-        #
-        # @api private
-        #
-        def sign_url
-          # calculate a hash of the path with private key
-          hash = OpenSSL::Digest.new('sha1')  # Changed in release 1.5.9
-          hash = OpenSSL::HMAC.digest(hash, private_key, options[:path])
-          # convert hash to base64
-          hash = Base64.strict_encode64(hash)
-          # remove trailing '='
-          hash.gsub!(/=*$/, '')
-          # URL encode hash
-          hash = CGI.escape(hash)
-          # covert all hexademical characters to upper case
-          hash.gsub!(/(%[A-Fa-f0-9]{1,2})/) { |group| group.upcase }
-
-          options[:path] << "#{separator}signature=#{hash}"
-        end
-
-        #
-        # Returns separator for GET parameters.
-        #
-        # @return [String] Either ? or &
-        # @api private
-        #
-        def separator
-          options[:path].include?('?') ? '&' : '?'
-        end
-
-        #
-        # Prepends path with version number if it's set.
-        #
-        # @api private
-        #
-        def prepend_version
-          if GroupDocs.api_version
-            options[:path] = "/v#{GroupDocs.api_version}#{options[:path]}"
-          end
-        end
-
-      end # URL
-    end # Helpers
-  end # Api
-end # GroupDocs
+require 'base64'
+require 'uri'
+require 'cgi'
+
+module GroupDocs
+  module Api
+    module Helpers
+      module URL
+
+        #
+        # Appends path with parameters.
+        #
+        # @param [Hash] params
+        #
+        def add_params(params)
+          params.each do |param, value|
+            value = value.join(',') if value.is_a?(Array)
+            options[:path] << "#{separator}#{param}=#{value}"
+          end
+        end
+
+        private
+
+        #
+        # Normalizes path replacing two or more slashes with one.
+        #
+        # @api private
+        #
+        def normalize_path
+          options[:path].gsub!(%r(//+), '/')
+        end
+
+        #
+        # URL encodes path.
+        #
+        # @api private
+        #
+        def url_encode_path
+          options[:path] = URI.escape(options[:path])
+          # handle special symbols correctly
+          options[:path].gsub!('[', '%5B')
+          options[:path].gsub!(']', '%5D')
+          options[:path].gsub!('+', '%2B')
+        end
+
+        #
+        # Parses path replacing {{client_id}} with real one.
+        #
+        # @api private
+        #
+        def replace_client_id
+          options[:path].sub!(/\{\{client_id\}\}/, client_id)
+        end
+
+
+        #
+        # Adds signature to path.
+        #
+        # @api private
+        #
+        def sign_url
+          # calculate a hash of the path with private key
+          hash = OpenSSL::Digest.new('sha1')  # Changed in release 1.5.9
+          hash = OpenSSL::HMAC.digest(hash, private_key, options[:path])
+          # convert hash to base64
+          hash = Base64.strict_encode64(hash)
+          # remove trailing '='
+          hash.gsub!(/=*$/, '')
+          # URL encode hash
+          hash = CGI.escape(hash)
+          # covert all hexademical characters to upper case
+          hash.gsub!(/(%[A-Fa-f0-9]{1,2})/) { |group| group.upcase }
+
+          options[:path] << "#{separator}signature=#{hash}"
+        end
+
+        #
+        # Returns separator for GET parameters.
+        #
+        # @return [String] Either ? or &
+        # @api private
+        #
+        def separator
+          options[:path].include?('?') ? '&' : '?'
+        end
+
+        #
+        # Prepends path with version number if it's set.
+        #
+        # @api private
+        #
+        def prepend_version
+          if GroupDocs.api_version
+            options[:path] = "/v#{GroupDocs.api_version}#{options[:path]}"
+          end
+        end
+
+      end # URL
+    end # Helpers
+  end # Api
+end # GroupDocs