groupdocs 2.2.0 → 2.3.0

data/lib/groupdocs/api/helpers.rb

@@ -1,11 +1,11 @@
-require 'groupdocs/api/helpers/byte_flag_helper'
-require 'groupdocs/api/helpers/access_mode_helper'
-require 'groupdocs/api/helpers/access_rights_helper'
-require 'groupdocs/api/helpers/accessor_helper'
-require 'groupdocs/api/helpers/credentials_helper'
-require 'groupdocs/api/helpers/mime_helper'
-require 'groupdocs/api/helpers/path_helper'
-require 'groupdocs/api/helpers/rest_helper'
-require 'groupdocs/api/helpers/signature_public_helper'
-require 'groupdocs/api/helpers/status_helper'
-require 'groupdocs/api/helpers/url_helper'
+require 'groupdocs/api/helpers/byte_flag_helper'
+require 'groupdocs/api/helpers/access_mode_helper'
+require 'groupdocs/api/helpers/access_rights_helper'
+require 'groupdocs/api/helpers/accessor_helper'
+require 'groupdocs/api/helpers/credentials_helper'
+require 'groupdocs/api/helpers/mime_helper'
+require 'groupdocs/api/helpers/path_helper'
+require 'groupdocs/api/helpers/rest_helper'
+require 'groupdocs/api/helpers/signature_public_helper'
+require 'groupdocs/api/helpers/status_helper'
+require 'groupdocs/api/helpers/url_helper'

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

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

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

@@ -1,55 +1,55 @@
-module GroupDocs
-  module Api
-    module Helpers
-      module AccessRights
-
-        include Api::Helpers::ByteFlag
-        #Changed in release 1.5.9
-        ACCESS_RIGHTS = {
-          :view     => 1,
-          :annotate => 2,
-          :download => 4,
-          :export   => 8,
-          :all => 31
-        }
-
-        private
-
-        #
-        # Converts shared link access rights array to byte flag.
-        #
-        # @param [Array<String, Symbol>] rights
-        # @return [Integer]
-        # @raise [ArgumentError] if rights is not an array
-        # @raise [ArgumentError] if right is unknown
-        # @api private
-        #
-        def convert_access_rights_to_byte(rights)
-          rights.is_a?(Array) or raise ArgumentError, "Rights should be an array, received: #{rights.inspect}"
-          rights = rights.map(&:to_sym)
-
-          possible_rights = ACCESS_RIGHTS.map { |hash| hash.first }
-          rights.each do |right|
-            possible_rights.include?(right) or raise ArgumentError, "Unknown access right: #{rights.inspect}"
-          end
-
-          byte_from_array(rights, ACCESS_RIGHTS)
-        end
-
-        #
-        # Converts byte flag to shared link access rights array.
-        #
-        # @param [Integer] rights
-        # @return [Array<Symbol>]
-        # @raise [ArgumentError] if rights is not integer
-        # @api private
-        #
-        def convert_byte_to_access_rights(rights)
-          rights.is_a?(Integer) or raise ArgumentError, "Rights should be an integer, received: #{rights.inspect}"
-          array_from_byte(rights, ACCESS_RIGHTS)
-        end
-
-      end # AccessRights
-    end # Helpers
-  end # Api
-end # GroupDocs
+module GroupDocs
+  module Api
+    module Helpers
+      module AccessRights
+
+        include Api::Helpers::ByteFlag
+        #Changed in release 1.5.9
+        ACCESS_RIGHTS = {
+          :view     => 1,
+          :annotate => 2,
+          :download => 4,
+          :export   => 8,
+          :all => 31
+        }
+
+        private
+
+        #
+        # Converts shared link access rights array to byte flag.
+        #
+        # @param [Array<String, Symbol>] rights
+        # @return [Integer]
+        # @raise [ArgumentError] if rights is not an array
+        # @raise [ArgumentError] if right is unknown
+        # @api private
+        #
+        def convert_access_rights_to_byte(rights)
+          rights.is_a?(Array) or raise ArgumentError, "Rights should be an array, received: #{rights.inspect}"
+          rights = rights.map(&:to_sym)
+
+          possible_rights = ACCESS_RIGHTS.map { |hash| hash.first }
+          rights.each do |right|
+            possible_rights.include?(right) or raise ArgumentError, "Unknown access right: #{rights.inspect}"
+          end
+
+          byte_from_array(rights, ACCESS_RIGHTS)
+        end
+
+        #
+        # Converts byte flag to shared link access rights array.
+        #
+        # @param [Integer] rights
+        # @return [Array<Symbol>]
+        # @raise [ArgumentError] if rights is not integer
+        # @api private
+        #
+        def convert_byte_to_access_rights(rights)
+          rights.is_a?(Integer) or raise ArgumentError, "Rights should be an integer, received: #{rights.inspect}"
+          array_from_byte(rights, ACCESS_RIGHTS)
+        end
+
+      end # AccessRights
+    end # Helpers
+  end # Api
+end # GroupDocs

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

@@ -1,30 +1,30 @@
-module GroupDocs
-  module Api
-    module Helpers
-      module Accessor
-
-        #
-        # Allows to easily alias accessors.
-        #
-        # @example
-        #   class File < Api::Entity
-        #     attr_accessor :fileName
-        #     alias_accessor :file_name, :fileName
-        #   end
-        #   file = File.new
-        #   file.file_name = "document"
-        #   file.file_name
-        #   #=> "document"
-        #
-        # @param [Symbol] new_name
-        # @param [Symbol] old_name
-        #
-        def alias_accessor(new_name, old_name)
-          alias_method :"#{new_name}",  :"#{old_name}"
-          alias_method :"#{new_name}=", :"#{old_name}="
-        end
-
-      end # Accessor
-    end # Helpers
-  end # Api
-end # GroupDocs
+module GroupDocs
+  module Api
+    module Helpers
+      module Accessor
+
+        #
+        # Allows to easily alias accessors.
+        #
+        # @example
+        #   class File < Api::Entity
+        #     attr_accessor :fileName
+        #     alias_accessor :file_name, :fileName
+        #   end
+        #   file = File.new
+        #   file.file_name = "document"
+        #   file.file_name
+        #   #=> "document"
+        #
+        # @param [Symbol] new_name
+        # @param [Symbol] old_name
+        #
+        def alias_accessor(new_name, old_name)
+          alias_method :"#{new_name}",  :"#{old_name}"
+          alias_method :"#{new_name}=", :"#{old_name}="
+        end
+
+      end # Accessor
+    end # Helpers
+  end # Api
+end # GroupDocs

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

@@ -1,49 +1,49 @@
-module GroupDocs
-  module Api
-    module Helpers
-      module ByteFlag
-
-        #
-        # Converts array of values to byte flag using hash of value => byte.
-        #
-        # @param [Array<String, Symbol>] values
-        # @param [Hash] value_byte_hash
-        # @return [Integer]
-        # @raise [ArgumentError] if values is not an array
-        # @api private
-        #
-        def byte_from_array(values, value_byte_hash)
-          flag = 0
-          values.each do |value|
-            flag += value_byte_hash[value]
-          end
-
-          flag
-        end
-
-        #
-        # Converts byte flag to array of values using hash of value => byte.
-        #
-        # @param [Integer] byte
-        # @param [Hash] value_byte_hash
-        # @return [Integer]
-        # @api private
-        #
-        def array_from_byte(byte, value_byte_hash)
-          values = []
-
-          value_byte_hash.sort { |a, b| b[1] <=> a[1] }.each do |value_byte|
-            decreased_byte = byte - value_byte[1]
-            if decreased_byte >= 0
-              values << value_byte[0]
-              byte = decreased_byte
-            end
-          end
-
-          values
-        end
-
-      end # ByteFlag
-    end # Helpers
-  end # Api
-end # GroupDocs
+module GroupDocs
+  module Api
+    module Helpers
+      module ByteFlag
+
+        #
+        # Converts array of values to byte flag using hash of value => byte.
+        #
+        # @param [Array<String, Symbol>] values
+        # @param [Hash] value_byte_hash
+        # @return [Integer]
+        # @raise [ArgumentError] if values is not an array
+        # @api private
+        #
+        def byte_from_array(values, value_byte_hash)
+          flag = 0
+          values.each do |value|
+            flag += value_byte_hash[value]
+          end
+
+          flag
+        end
+
+        #
+        # Converts byte flag to array of values using hash of value => byte.
+        #
+        # @param [Integer] byte
+        # @param [Hash] value_byte_hash
+        # @return [Integer]
+        # @api private
+        #
+        def array_from_byte(byte, value_byte_hash)
+          values = []
+
+          value_byte_hash.sort { |a, b| b[1] <=> a[1] }.each do |value_byte|
+            decreased_byte = byte - value_byte[1]
+            if decreased_byte >= 0
+              values << value_byte[0]
+              byte = decreased_byte
+            end
+          end
+
+          values
+        end
+
+      end # ByteFlag
+    end # Helpers
+  end # Api
+end # GroupDocs

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

@@ -1,35 +1,35 @@
-module GroupDocs
-  module Api
-    module Helpers
-      module Credentials
-
-        private
-
-        #
-        # Returns client ID from access hash or GroupDocs class variable.
-        #
-        # @return [String]
-        # @raise [NoClientIdError] If Client ID hasn't been set yet, raise exception.
-        # @api private
-        #
-        def client_id
-          client_id = options[:access][:client_id] || GroupDocs.client_id
-          client_id or raise NoClientIdError, 'Client ID has not been specified.'
-        end
-
-        #
-        # Returns private key from access hash or GroupDocs class variable.
-        #
-        # @return [String]
-        # @raise [NoPrivateKeyError] If private key hasn't been set yet, raise exception.
-        # @api private
-        #
-        def private_key
-          private_key = options[:access][:private_key] || GroupDocs.private_key
-          private_key or raise NoPrivateKeyError, 'Private Key has not been specified.'
-        end
-
-      end # Credentials
-    end # Helpers
-  end # Api
-end # GroupDocs
+module GroupDocs
+  module Api
+    module Helpers
+      module Credentials
+
+        private
+
+        #
+        # Returns client ID from access hash or GroupDocs class variable.
+        #
+        # @return [String]
+        # @raise [NoClientIdError] If Client ID hasn't been set yet, raise exception.
+        # @api private
+        #
+        def client_id
+          client_id = options[:access][:client_id] || GroupDocs.client_id
+          client_id or raise NoClientIdError, 'Client ID has not been specified.'
+        end
+
+        #
+        # Returns private key from access hash or GroupDocs class variable.
+        #
+        # @return [String]
+        # @raise [NoPrivateKeyError] If private key hasn't been set yet, raise exception.
+        # @api private
+        #
+        def private_key
+          private_key = options[:access][:private_key] || GroupDocs.private_key
+          private_key or raise NoPrivateKeyError, 'Private Key has not been specified.'
+        end
+
+      end # Credentials
+    end # Helpers
+  end # Api
+end # GroupDocs

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

@@ -1,21 +1,21 @@
-require 'mime/types'
-
-module GroupDocs
-  module Api
-    module Helpers
-      module MIME
-
-        private
-
-        #
-        # Returns MIME type for file.
-        # @api private
-        #
-        def mime_type(filepath)
-          ::MIME::Types.type_for(filepath).first
-        end
-
-      end # MIME
-    end # Helpers
-  end # Api
-end # GroupDocs
+require 'mime/types'
+
+module GroupDocs
+  module Api
+    module Helpers
+      module MIME
+
+        private
+
+        #
+        # Returns MIME type for file.
+        # @api private
+        #
+        def mime_type(filepath)
+          ::MIME::Types.type_for(filepath).first
+        end
+
+      end # MIME
+    end # Helpers
+  end # Api
+end # GroupDocs