groupdocs 2.2.0 → 2.3.0

data/lib/groupdocs/api/request.rb

@@ -1,91 +1,91 @@
-module GroupDocs
-  module Api
-    class Request
-
-      include Api::Helpers::Credentials
-      include Api::Helpers::URL
-      include Api::Helpers::REST
-
-      # @attr_reader [RestClient::Resource] resource Entry point for all API requests
-      attr_reader :resource
-      # @attr [String] response Response from server in JSON format
-      attr_accessor :response
-      # @attr [Hash] options Hash of options
-      attr_accessor :options
-      # @attr [Hash] access Hash of access credentials
-      attr_accessor :access
-
-      #
-      # Creates new API request.
-      #
-      # @example
-      #   api = GroupDocs::Api::Request.new do |request|
-      #     request[:method] = :POST
-      #     request[:path] = "/storage/{{client_id}}/info"
-      #   end
-      #
-      # @param [Hash] options
-      # @option options [Symbol, String] :method HTTP method. One of :GET, :DOWNLOAD, :POST, :PUT or :DELETE.
-      # @option options [String] :path Path to send request to
-      # @option options [Hash] :headers Additional HTTP headers
-      # @option options [Hash] :access Access credentials hash
-      # @option options [Hash, String, Array, File] :request_body payload
-      # @option options [Boolean] :plain Send payload as plain text (i.e. do not convert to JSON). Defaults to false.
-      # @option options [Boolean] :sign Should URL be signed. Defaults to true.
-      #
-      # @yieldparam [Hash] options
-      #
-      def initialize(options = {}, &blk)
-        @options = options
-        yield @options if block_given?
-        @options[:access] ||= {}
-        @options[:sign] = true if @options[:sign].nil?
-        @resource = RestClient::Resource.new(GroupDocs.api_server)
-      end
-
-      #
-      # Prepares, signs and returns absolute URL.
-      #
-      # It performs the following actions step by step:
-      #   * Parses path (i.e. replaces client ID)
-      #   * URL encodes path
-      #   * Signs URL
-      #
-      # @return [String]
-      #
-      def prepare_and_sign_url
-        unless @signed
-          # the order is important here and if client_id is replaced after path
-          # is encoded, there might be bad requests
-          replace_client_id if @options[:sign]
-          url_encode_path
-          sign_url          if @options[:sign]
-          @signed = true
-        end
-
-        options[:path]
-      end
-
-      #
-      # Executes API request to server.
-      #
-      # It performs the following actions step by step:
-      #   * Prepends path with version if it's set
-      #   * Prepares and signs URL
-      #   * Prepare request (add headers, converts payload to JSON, etc.)
-      #   * Sends request to server
-      #   * Parses response
-      #
-      # @return [Hash, String] Parsed response
-      #
-      def execute!
-        prepend_version
-        prepare_and_sign_url
-        prepare_request
-        send_request
-        parse_response
-      end
-
-    end # Request
-  end # Api
-end # GroupDocs
+module GroupDocs
+  module Api
+    class Request
+
+      include Api::Helpers::Credentials
+      include Api::Helpers::URL
+      include Api::Helpers::REST
+
+      # @attr_reader [RestClient::Resource] resource Entry point for all API requests
+      attr_reader :resource
+      # @attr [String] response Response from server in JSON format
+      attr_accessor :response
+      # @attr [Hash] options Hash of options
+      attr_accessor :options
+      # @attr [Hash] access Hash of access credentials
+      attr_accessor :access
+
+      #
+      # Creates new API request.
+      #
+      # @example
+      #   api = GroupDocs::Api::Request.new do |request|
+      #     request[:method] = :POST
+      #     request[:path] = "/storage/{{client_id}}/info"
+      #   end
+      #
+      # @param [Hash] options
+      # @option options [Symbol, String] :method HTTP method. One of :GET, :DOWNLOAD, :POST, :PUT or :DELETE.
+      # @option options [String] :path Path to send request to
+      # @option options [Hash] :headers Additional HTTP headers
+      # @option options [Hash] :access Access credentials hash
+      # @option options [Hash, String, Array, File] :request_body payload
+      # @option options [Boolean] :plain Send payload as plain text (i.e. do not convert to JSON). Defaults to false.
+      # @option options [Boolean] :sign Should URL be signed. Defaults to true.
+      #
+      # @yieldparam [Hash] options
+      #
+      def initialize(options = {}, &blk)
+        @options = options
+        yield @options if block_given?
+        @options[:access] ||= {}
+        @options[:sign] = true if @options[:sign].nil?
+        @resource = RestClient::Resource.new(GroupDocs.api_server)
+      end
+
+      #
+      # Prepares, signs and returns absolute URL.
+      #
+      # It performs the following actions step by step:
+      #   * Parses path (i.e. replaces client ID)
+      #   * URL encodes path
+      #   * Signs URL
+      #
+      # @return [String]
+      #
+      def prepare_and_sign_url
+        unless @signed
+          # the order is important here and if client_id is replaced after path
+          # is encoded, there might be bad requests
+          replace_client_id if @options[:sign]
+          url_encode_path
+          sign_url          if @options[:sign]
+          @signed = true
+        end
+
+        options[:path]
+      end
+
+      #
+      # Executes API request to server.
+      #
+      # It performs the following actions step by step:
+      #   * Prepends path with version if it's set
+      #   * Prepares and signs URL
+      #   * Prepare request (add headers, converts payload to JSON, etc.)
+      #   * Sends request to server
+      #   * Parses response
+      #
+      # @return [Hash, String] Parsed response
+      #
+      def execute!
+        prepend_version
+        prepare_and_sign_url
+        prepare_request
+        send_request
+        parse_response
+      end
+
+    end # Request
+  end # Api
+end # GroupDocs

data/lib/groupdocs/datasource.rb

@@ -1,249 +1,249 @@
-module GroupDocs
-  class DataSource < Api::Entity
-
-    require 'groupdocs/datasource/field'
-
-    #
-    # Returns datasource by given identifier.
-    #
-    # @param [Integer] id
-    # @param [Hash] options
-    # @option options [Array] :field Array of field names to be returned. All by default
-    # @param [Hash] access Access credentials
-    # @option access [String] :client_id
-    # @option access [String] :private_key
-    # @return [GroupDocs::DataSource, nil]
-    #
-    def self.get!(id, options = {}, access = {})
-      api = Api::Request.new do |request|
-        request[:access] = access
-        request[:method] = :GET
-        request[:path] = "/merge/{{client_id}}/datasources/#{id}"
-      end
-      api.add_params(options)
-      json = api.execute!
-
-      DataSource.new(json[:datasource])
-    rescue RestClient::ResourceNotFound
-      nil
-    end
-
-    # @attr [Integer] id
-    attr_accessor :id
-    # @attr [String] descr
-    attr_accessor :descr
-    # @attr [Integer] questionnaire_id
-    attr_accessor :questionnaire_id
-    # @attr [Time] created_on
-    attr_accessor :created_on
-    # @attr [Time] modified_on
-    attr_accessor :modified_on
-    # @attr [Array<GroupDocs::DataSource::Field>] fields
-    attr_accessor :fields
-
-    # Human-readable accessors
-    alias_accessor :description, :descr
-
-    #
-    # Converts timestamp which is return by API server to Time object.
-    #
-    # @return [Time]
-    #
-    def created_on
-      Time.at(@created_on / 1000)
-    end
-
-    #
-    # Converts timestamp which is return by API server to Time object.
-    #
-    # @return [Time]
-    #
-    def modified_on
-      Time.at(@modified_on / 1000)
-    end
-
-    #
-    # Converts each field to GroupDocs::DataSource::Field object.
-    #
-    # @param [Array<GroupDocs::DataSource::Field, Hash>] fields
-    #
-    def fields=(fields)
-      if fields
-        @fields = fields.map do |field|
-          if field.is_a?(GroupDocs::DataSource::Field)
-            field
-          else
-            DataSource::Field.new(field)
-          end
-        end
-      end
-    end
-
-    #
-    # Adds field to datasource.
-    #
-    # @param [GroupDocs::DataSource::Field] question
-    # @raise [ArgumentError] if field is not GroupDocs::DataSource::Field object
-    #
-    def add_field(field)
-      field.is_a?(GroupDocs::DataSource::Field) or raise ArgumentError,
-        "Field should be GroupDocs::DataSource::Field object, received: #{field.inspect}"
-
-      @fields ||= Array.new
-      @fields << field
-    end
-
-    #
-    # Adds datasource.
-    #
-    # @example
-    #   field = GroupDocs::DataSource::Field.new(name: 'test', values: %w(test test))
-    #   datasource = GroupDocs::DataSource.new
-    #   datasource.add_field(field)
-    #   datasource.add!
-    #
-    # @param [Hash] access Access credentials
-    # @option access [String] :client_id
-    # @option access [String] :private_key
-    #
-    def add!(access = {})
-      json = Api::Request.new do |request|
-        request[:access] = access
-        request[:method] = :POST
-        request[:path] = '/merge/{{client_id}}/datasources'
-        request[:request_body] = to_hash
-      end.execute!
-
-      self.id = json[:datasource_id]
-    end
-
-    #
-    # Updates datasource.
-    #
-    # @example
-    #   field = GroupDocs::DataSource::Field.new(field: 'test', values: %w(test test))
-    #   datasource = GroupDocs::DataSource.get!(180)
-    #   datasource.add_field(field)
-    #   datasource.update!
-    #
-    # @param [Hash] access Access credentials
-    # @option access [String] :client_id
-    # @option access [String] :private_key
-    #
-    def update!(access = {})
-      Api::Request.new do |request|
-        request[:access] = access
-        request[:method] = :PUT
-        request[:path] = "/merge/{{client_id}}/datasources/#{id}"
-        request[:request_body] = to_hash
-      end.execute!
-    end
-
-    #
-    # Updates datasource.
-    #
-    # @example
-    #   field = GroupDocs::DataSource::Field.new(field: 'test', values: %w(test test))
-    #   datasource = GroupDocs::DataSource.get!(180)
-    #   datasource.add_field(field)
-    #   datasource.update_fields!
-    #
-    # @param [Hash] access Access credentials
-    # @option access [String] :client_id
-    # @option access [String] :private_key
-    #
-    def update_fields!(access = {})
-      Api::Request.new do |request|
-        request[:access] = access
-        request[:method] = :PUT
-        request[:path] = "/merge/{{client_id}}/datasources/#{id}/fields"
-        request[:request_body] = to_hash
-      end.execute!
-    end
-
-    #
-    # Removes datasource.
-    #
-    # @param [Hash] access Access credentials
-    # @option access [String] :client_id
-    # @option access [String] :private_key
-    #
-    def remove!(access = {})
-      Api::Request.new do |request|
-        request[:access] = access
-        request[:method] = :DELETE
-        request[:path] = "/merge/{{client_id}}/datasources/#{id}"
-      end.execute!
-    # TODO: fix this in API - http://scotland.groupdocs.com/jira/browse/CORE-387
-    rescue RestClient::BadRequest
-      nil
-    end
-
-    #
-    # Add job document datasource.
-    #
-    # @example
-    # file = GroupDocs::Storage::File.new(guid => "(file guid)").to_document
-    # field = GroupDocs::DataSource::Field.new(:name => "test")
-    # datasource = GroupDocs::DataSource.new
-    # datasource.add_field(field).add!()
-    # job = GroupDocs::Job.create!()
-    # file_id = job.add_document!(file)
-    # datasource = add_datasourse!(job, file_id, datasource)
-    #
-    # @param [GroupDocs::DataSource] datasource
-    # @param [String] jobId Job identifier
-    # @param [String] fileId File identifier
-    # @param [String] datasourceId
-    # @param [Hash] access Access credentials
-    # @option access [String] :client_id
-    # @option access [String] :private_key
-    #
-    def add_datasource!(job, file_id, datasource, access = {})
-      datasource.is_a?(GroupDocs::DataSource) or raise ArgumentError,
-                                                       "Datasource should be GroupDocs::DataSource object, received: #{datasource.inspect}"
-
-      Api::Request.new do |request|
-        request[:access] = access
-        request[:method] = :PUT
-        request[:path] = "/merge/{{client_id}}/jobs/#{job.id}/files/#{file_id}/datasources/#{datasource.id}"
-      end.execute!
-    end
-
-    #
-    # Add job document datasource fields.
-    #
-    #
-    # @example
-    # file = GroupDocs::Storage::File.new(guid => "(file guid)").to_document
-    # field = GroupDocs::DataSource::Field.new(:name => "test")
-    # datasource = GroupDocs::DataSource.new
-    # datasource.add_field(field)
-    # job = GroupDocs::Job.create!()
-    # file_id = job.add_document!(file)
-    # datasource = add_datasourse!(job, file_id, datasource)
-    #
-    #
-    #
-    # @param [String] jobId Job identifier
-    # @param [String] fileId File identifier
-    # @param [Array] datasourceFields
-    # @param [Hash] access Access credentials
-    # @option access [String] :client_id
-    # @option access [String] :private_key
-    #
-    def add_datasource_fields!(job, file_id, datasource, access = {})
-      datasource.is_a?(GroupDocs::DataSource) or raise ArgumentError,
-                                                       "Datasource should be GroupDocs::DataSource object, received: #{datasource.inspect}"
-      Api::Request.new do |request|
-        request[:access] = access
-        request[:method] = :PUT
-        request[:path] = "/merge/{{client_id}}/jobs/#{job.id}/files/#{file_id}/datasources"
-        request[:request_body] = datasource.fields
-      end.execute!
-    end
-
-
-
-  end # DataSource
-end # GroupDocs
+module GroupDocs
+  class DataSource < Api::Entity
+
+    require 'groupdocs/datasource/field'
+
+    #
+    # Returns datasource by given identifier.
+    #
+    # @param [Integer] id
+    # @param [Hash] options
+    # @option options [Array] :field Array of field names to be returned. All by default
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [GroupDocs::DataSource, nil]
+    #
+    def self.get!(id, options = {}, access = {})
+      api = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = "/merge/{{client_id}}/datasources/#{id}"
+      end
+      api.add_params(options)
+      json = api.execute!
+
+      DataSource.new(json[:datasource])
+    rescue RestClient::ResourceNotFound
+      nil
+    end
+
+    # @attr [Integer] id
+    attr_accessor :id
+    # @attr [String] descr
+    attr_accessor :descr
+    # @attr [Integer] questionnaire_id
+    attr_accessor :questionnaire_id
+    # @attr [Time] created_on
+    attr_accessor :created_on
+    # @attr [Time] modified_on
+    attr_accessor :modified_on
+    # @attr [Array<GroupDocs::DataSource::Field>] fields
+    attr_accessor :fields
+
+    # Human-readable accessors
+    alias_accessor :description, :descr
+
+    #
+    # Converts timestamp which is return by API server to Time object.
+    #
+    # @return [Time]
+    #
+    def created_on
+      Time.at(@created_on / 1000)
+    end
+
+    #
+    # Converts timestamp which is return by API server to Time object.
+    #
+    # @return [Time]
+    #
+    def modified_on
+      Time.at(@modified_on / 1000)
+    end
+
+    #
+    # Converts each field to GroupDocs::DataSource::Field object.
+    #
+    # @param [Array<GroupDocs::DataSource::Field, Hash>] fields
+    #
+    def fields=(fields)
+      if fields
+        @fields = fields.map do |field|
+          if field.is_a?(GroupDocs::DataSource::Field)
+            field
+          else
+            DataSource::Field.new(field)
+          end
+        end
+      end
+    end
+
+    #
+    # Adds field to datasource.
+    #
+    # @param [GroupDocs::DataSource::Field] question
+    # @raise [ArgumentError] if field is not GroupDocs::DataSource::Field object
+    #
+    def add_field(field)
+      field.is_a?(GroupDocs::DataSource::Field) or raise ArgumentError,
+        "Field should be GroupDocs::DataSource::Field object, received: #{field.inspect}"
+
+      @fields ||= Array.new
+      @fields << field
+    end
+
+    #
+    # Adds datasource.
+    #
+    # @example
+    #   field = GroupDocs::DataSource::Field.new(name: 'test', values: %w(test test))
+    #   datasource = GroupDocs::DataSource.new
+    #   datasource.add_field(field)
+    #   datasource.add!
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def add!(access = {})
+      json = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :POST
+        request[:path] = '/merge/{{client_id}}/datasources'
+        request[:request_body] = to_hash
+      end.execute!
+
+      self.id = json[:datasource_id]
+    end
+
+    #
+    # Updates datasource.
+    #
+    # @example
+    #   field = GroupDocs::DataSource::Field.new(field: 'test', values: %w(test test))
+    #   datasource = GroupDocs::DataSource.get!(180)
+    #   datasource.add_field(field)
+    #   datasource.update!
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def update!(access = {})
+      Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :PUT
+        request[:path] = "/merge/{{client_id}}/datasources/#{id}"
+        request[:request_body] = to_hash
+      end.execute!
+    end
+
+    #
+    # Updates datasource.
+    #
+    # @example
+    #   field = GroupDocs::DataSource::Field.new(field: 'test', values: %w(test test))
+    #   datasource = GroupDocs::DataSource.get!(180)
+    #   datasource.add_field(field)
+    #   datasource.update_fields!
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def update_fields!(access = {})
+      Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :PUT
+        request[:path] = "/merge/{{client_id}}/datasources/#{id}/fields"
+        request[:request_body] = to_hash
+      end.execute!
+    end
+
+    #
+    # Removes datasource.
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def remove!(access = {})
+      Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :DELETE
+        request[:path] = "/merge/{{client_id}}/datasources/#{id}"
+      end.execute!
+    # TODO: fix this in API - http://scotland.groupdocs.com/jira/browse/CORE-387
+    rescue RestClient::BadRequest
+      nil
+    end
+
+    #
+    # Add job document datasource.
+    #
+    # @example
+    # file = GroupDocs::Storage::File.new(guid => "(file guid)").to_document
+    # field = GroupDocs::DataSource::Field.new(:name => "test")
+    # datasource = GroupDocs::DataSource.new
+    # datasource.add_field(field).add!()
+    # job = GroupDocs::Job.create!()
+    # file_id = job.add_document!(file)
+    # datasource = add_datasourse!(job, file_id, datasource)
+    #
+    # @param [GroupDocs::DataSource] datasource
+    # @param [String] jobId Job identifier
+    # @param [String] fileId File identifier
+    # @param [String] datasourceId
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def add_datasource!(job, file_id, datasource, access = {})
+      datasource.is_a?(GroupDocs::DataSource) or raise ArgumentError,
+                                                       "Datasource should be GroupDocs::DataSource object, received: #{datasource.inspect}"
+
+      Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :PUT
+        request[:path] = "/merge/{{client_id}}/jobs/#{job.id}/files/#{file_id}/datasources/#{datasource.id}"
+      end.execute!
+    end
+
+    #
+    # Add job document datasource fields.
+    #
+    #
+    # @example
+    # file = GroupDocs::Storage::File.new(guid => "(file guid)").to_document
+    # field = GroupDocs::DataSource::Field.new(:name => "test")
+    # datasource = GroupDocs::DataSource.new
+    # datasource.add_field(field)
+    # job = GroupDocs::Job.create!()
+    # file_id = job.add_document!(file)
+    # datasource = add_datasourse!(job, file_id, datasource)
+    #
+    #
+    #
+    # @param [String] jobId Job identifier
+    # @param [String] fileId File identifier
+    # @param [Array] datasourceFields
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def add_datasource_fields!(job, file_id, datasource, access = {})
+      datasource.is_a?(GroupDocs::DataSource) or raise ArgumentError,
+                                                       "Datasource should be GroupDocs::DataSource object, received: #{datasource.inspect}"
+      Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :PUT
+        request[:path] = "/merge/{{client_id}}/jobs/#{job.id}/files/#{file_id}/datasources"
+        request[:request_body] = datasource.fields
+      end.execute!
+    end
+
+
+
+  end # DataSource
+end # GroupDocs