groupdocs 0.1.0

data/lib/groupdocs/document/annotation.rb

@@ -0,0 +1,215 @@
+module GroupDocs
+  class Document::Annotation < GroupDocs::Api::Entity
+
+    TYPES = {
+      text:  0,
+      area:  1,
+      point: 2,
+    }
+
+    require 'groupdocs/document/annotation/reply'
+
+    # @attr [GroupDocs::Document] document
+    attr_accessor :document
+    # @attr [Integer] id
+    attr_accessor :id
+    # @attr [String] guid
+    attr_accessor :guid
+    # @attr [String] sessionGuid
+    attr_accessor :sessionGuid
+    # @attr [String] documentGuid
+    attr_accessor :documentGuid
+    # @attr [String] replyGuid
+    attr_accessor :replyGuid
+    # @attr [Time] createdOn
+    attr_accessor :createdOn
+    # @attr [Symbol] type
+    attr_accessor :type
+    # @attr [Symbol] access
+    attr_accessor :access
+    # @attr [GroupDocs::Document::Rectangle] box
+    attr_accessor :box
+    # @attr [Array<GroupDocs::Document::Annotation::Reply>] replies
+    attr_accessor :replies
+
+    # Compatibility with response JSON
+    alias_method :annotationGuid=, :guid=
+
+    # Human-readable accessors
+    alias_method :session_guid,     :sessionGuid
+    alias_method :session_guid=,    :sessionGuid=
+    alias_method :document_guid,    :documentGuid
+    alias_method :document_guid=,   :documentGuid=
+    alias_method :reply_guid,       :replyGuid
+    alias_method :reply_guid=,      :replyGuid=
+    alias_method :created_on,       :createdOn
+    alias_method :created_on=,      :createdOn=
+
+    #
+    # Creates new GroupDocs::Document::Annotation.
+    #
+    # @raise [ArgumentError] If document is not passed or is not an instance of GroupDocs::Document
+    #
+    def initialize(options = {}, &blk)
+      super(options, &blk)
+      document.is_a?(GroupDocs::Document) or raise ArgumentError,
+        "You have to pass GroupDocs::Document object: #{document.inspect}."
+    end
+
+    #
+    # Updates type with machine-readable format.
+    #
+    # @param [Symbol] type
+    # @raise [ArgumentError] if type is unknown
+    #
+    def type=(type)
+      if type.is_a?(Symbol)
+        TYPES.keys.include?(type) or raise ArgumentError, "Unknown type: #{type.inspect}"
+        type = TYPES[type]
+      end
+
+      @type = type
+    end
+
+    #
+    # Returns field type in human-readable format.
+    #
+    # @return [Symbol]
+    #
+    def type
+      TYPES.invert[@type]
+    end
+
+    #
+    # Converts timestamp which is return by API server to Time object.
+    #
+    # @return [Time]
+    #
+    def created_on
+      Time.at(@createdOn / 1000)
+    end
+
+    #
+    # Coverts passed hash to GroupDocs::Document::Rectangle object.
+    #
+    # @param [Hash] options
+    # @return [GroupDocs::Document::Rectangle]
+    #
+    def box=(options)
+      @box = GroupDocs::Document::Rectangle.new(options)
+    end
+
+    #
+    # Converts each reply to GroupDocs::Document::Annotation::Reply object.
+    #
+    # @param [Array<GroupDocs::Document::Annotation::Reply, Hash>] replies
+    #
+    def replies=(replies)
+      if replies
+        @replies = replies.map do |reply|
+          if reply.is_a?(GroupDocs::Document::Annotation::Reply)
+            reply
+          else
+            reply.merge!(annotation: self)
+            GroupDocs::Document::Annotation::Reply.new(reply)
+          end
+        end
+      end
+    end
+
+    #
+    # Adds reply to annotation.
+    #
+    # @param [GroupDocs::Document::Annotation::Reply] reply
+    # @raise [ArgumentError] if reply is not GroupDocs::Document::Annotation::Reply object
+    #
+    def add_reply(reply)
+      reply.is_a?(GroupDocs::Document::Annotation::Reply) or raise ArgumentError,
+        "Reply should be GroupDocs::Document::Annotation::Reply object, received: #{reply.inspect}"
+
+      @replies ||= Array.new
+      @replies << reply
+    end
+
+    #
+    # Creates new annotation.
+    #
+    # @example
+    #   document = GroupDocs::Document.find!(:name, 'CV.doc')
+    #   annotation = GroupDocs::Document::Annotation.new(document: document)
+    #   annotation.create!
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def create!(access = {})
+      json = GroupDocs::Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :POST
+        request[:path] = "/ant/{{client_id}}/files/#{document.file.guid}/annotations"
+        request[:request_body] = to_hash
+      end.execute!
+
+      json.each do |field, value|
+        send(:"#{field}=", value) if respond_to?(:"#{field}=")
+      end
+    end
+
+    #
+    # Sets annotation collaborators to given emails.
+    #
+    # @param [Array] emails List of collaborators' email addresses
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [Array<GroupDocs::User>]
+    #
+    def collaborators_set!(emails, access = {})
+      json = GroupDocs::Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :PUT
+        request[:path] = "/ant/{{client_id}}/files/#{document.file.guid}/collaborators"
+        request[:request_body] = emails
+      end.execute!
+
+      json[:collaborators].map do |collaborator|
+        GroupDocs::User.new(collaborator)
+      end
+    end
+    # note that aliased version cannot accept access credentials hash
+    alias_method :collaborators=, :collaborators_set!
+
+    #
+    # Removes annotation.
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def remove!(access = {})
+      GroupDocs::Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :DELETE
+        request[:path] = "/ant/{{client_id}}/annotations/#{guid}"
+      end.execute!
+    end
+
+    #
+    # Return an array of replies..
+    #
+    # @param [Hash] options
+    # @option options [Time] :after
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [Array<GroupDocs::Document::Annotation::Reply>]
+    #
+    # @raise [ArgumentError] If :after option is passed but it's not an instance of Time
+    #
+    def replies!(options = {}, access = {})
+      GroupDocs::Document::Annotation::Reply.get!(self, options, access)
+    end
+
+  end # Document::Annotation
+end # GroupDocs

data/lib/groupdocs/document/annotation/reply.rb

@@ -0,0 +1,167 @@
+module GroupDocs
+  class Document::Annotation::Reply < GroupDocs::Api::Entity
+
+    #
+    # Return an array of replies for given annotation.
+    #
+    # @param [GroupDocs::Document::Annotation] annotation
+    # @param [Hash] options
+    # @option options [Time] :after
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [Array<GroupDocs::Document::Annotation::Reply>]
+    #
+    # @raise [ArgumentError] If annotation is not passed or is not an instance of GroupDocs::Document::Annotation
+    # @raise [ArgumentError] If :after option is passed but it's not an instance of Time
+    #
+    def self.get!(annotation, options = {}, access = {})
+      annotation.is_a?(GroupDocs::Document::Annotation) or raise ArgumentError,
+        "You have to pass GroupDocs::Document::Annotation object: #{annotation.inspect}."
+      (options[:after] && !options[:after].is_a?(Time)) and raise ArgumentError,
+        "Option :after should be an instance of Time, received: #{options[:after].inspect}"
+
+      options[:after] = (options[:after].to_i * 1000) if options[:after]
+
+      api = GroupDocs::Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = "/ant/{{client_id}}/annotations/#{annotation.guid}/replies"
+      end
+      api.add_params(options)
+      json = api.execute!
+
+      json[:replies].map do |reply|
+        reply.merge!(annotation: annotation)
+        GroupDocs::Document::Annotation::Reply.new(reply)
+      end
+    end
+
+    # @attr [GroupDocs::Document::Annotation] annotation
+    attr_accessor :annotation
+    # @attr [String] text
+    attr_accessor :text
+    # @attr [String] guid
+    attr_accessor :guid
+    # @attr [String] annotationGuid
+    attr_accessor :annotationGuid
+    # @attr [String] userGuid
+    attr_accessor :userGuid
+    # @attr [String] userName
+    attr_accessor :userName
+    # @attr [String] text
+    attr_accessor :text
+    # @attr [Time] repliedOn
+    attr_accessor :repliedOn
+
+    # Human-readable accessors
+    alias_method :annotation_guid,  :annotationGuid
+    alias_method :annotation_guid=, :annotationGuid=
+    alias_method :user_guid,        :userGuid
+    alias_method :user_guid=,       :userGuid=
+    alias_method :user_name,        :userName
+    alias_method :user_name=,       :userName=
+    alias_method :replied_on,       :repliedOn
+    alias_method :replied_on=,      :repliedOn=
+
+    #
+    # Creates new GroupDocs::Document::Annotation.
+    #
+    # @raise [ArgumentError] If annotation is not passed or is not an instance of GroupDocs::Document::Annotation
+    #
+    def initialize(options = {}, &blk)
+      super(options, &blk)
+      annotation.is_a?(GroupDocs::Document::Annotation) or raise ArgumentError,
+        "You have to pass GroupDocs::Document::Annotation object: #{annotation.inspect}."
+    end
+
+    #
+    # Converts timestamp which is return by API server to Time object.
+    #
+    # @return [Time]
+    #
+    def replied_on
+      Time.at(@repliedOn / 1000)
+    end
+
+    #
+    # Creates reply.
+    #
+    # @example
+    #   document = GroupDocs::Document.find!(:name, 'CV.doc')
+    #   annotation = GroupDocs::Document::Annotation.new(document: document)
+    #   reply = GroupDocs::Document::Annotation::Reply.new(annotation: annotation)
+    #   reply.text = "Reply text"
+    #   reply.create!
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    # @raise [NameError] if annotation or annotation_guid are not set
+    #
+    def create!(access = {})
+      json = GroupDocs::Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :POST
+        request[:path] = "/ant/{{client_id}}/annotations/#{get_annotation_guid}/replies"
+        request[:request_body] = text
+      end.execute!
+
+      self.guid            = json[:replyGuid]
+      self.annotation_guid = json[:annotationGuid]
+    end
+
+    #
+    # Edits reply.
+    #
+    # @example
+    #   document = GroupDocs::Document.find!(:name, 'CV.doc')
+    #   annotation = document.annotations!.first
+    #   reply = annotation.replies!.first
+    #   reply.text = "New reply text"
+    #   reply.edit!
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def edit!(access = {})
+      GroupDocs::Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :PUT
+        request[:path] = "/ant/{{client_id}}/replies/#{guid}"
+        request[:request_body] = text
+      end.execute!
+    end
+
+    #
+    # Removes reply.
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    # @todo currently not implemented in API
+    #
+    def remove!(access = {})
+      GroupDocs::Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :DELETE
+        request[:path] = "/ant/{{client_id}}/replies/#{guid}"
+      end.execute!
+    end
+
+    private
+
+    #
+    # Returns annotation guid.
+    #
+    # @returns [String]
+    #
+    def get_annotation_guid
+      annotation_guid || annotation.guid
+    end
+
+  end # Document::Annotation::Reply
+end # GroupDocs

data/lib/groupdocs/document/change.rb

@@ -0,0 +1,35 @@
+module GroupDocs
+  class Document::Change < GroupDocs::Api::Entity
+
+    # @attr [Integer] id
+    attr_accessor :id
+    # @attr [Symbol] type
+    attr_accessor :type
+    # @attr [GroupDocs::Document::Rectangle] box
+    attr_accessor :box
+    # @attr [String] text
+    attr_accessor :text
+    # @attr [Integer] page
+    attr_accessor :page
+
+    #
+    # Returns type as symbol.
+    #
+    # @return [Symbol]
+    #
+    def type
+      @type.to_sym
+    end
+
+    #
+    # Coverts passed hash to GroupDocs::Document::Rectangle object.
+    #
+    # @param [Hash] options
+    # @return [GroupDocs::Document::Rectangle]
+    #
+    def box=(options)
+      @box = GroupDocs::Document::Rectangle.new(options)
+    end
+
+  end # Document::Change
+end # GroupDocs

data/lib/groupdocs/document/field.rb

@@ -0,0 +1,27 @@
+module GroupDocs
+  class Document::Field < GroupDocs::Api::Entity
+
+    # @attr [Integer] page
+    attr_accessor :page
+    # @attr [String] name
+    attr_accessor :name
+    # @attr [String] type
+    attr_accessor :type
+    # @attr [GroupDocs::Document::Rectangle] rectangle
+    attr_accessor :rectangle
+
+    #
+    # Coverts passed hash to GroupDocs::Document::Rectangle object.
+    #
+    # @param [Hash] options
+    # @return [GroupDocs::Document::Rectangle]
+    #
+    def rectangle=(options)
+      @rectangle = GroupDocs::Document::Rectangle.new(options)
+    end
+
+    # Compatibility with response JSON
+    alias_method :rect=, :rectangle=
+
+  end # Document::Field
+end # GroupDocs

data/lib/groupdocs/document/metadata.rb

@@ -0,0 +1,26 @@
+module GroupDocs
+  class Document::MetaData < GroupDocs::Api::Entity
+
+    # @attr [Integer] id
+    attr_accessor :id
+    # @attr [String] guid
+    attr_accessor :guid
+    # @attr [Integer] page_count
+    attr_accessor :page_count
+    # @attr [Integer] views_count
+    attr_accessor :views_count
+    # @attr [Hash] last_view
+    attr_accessor :last_view
+
+    #
+    # Coverts passed hash to GroupDocs::Document::View object.
+    #
+    # @param [Hash] options
+    # @return [GroupDocs::Document::View]
+    #
+    def last_view=(options)
+      @last_view = GroupDocs::Document::View.new(options)
+    end
+
+  end # Document::Metadata
+end # GroupDocs