rubyhexagon 2.0.0 → 2.0.1

data/lib/rubyhexagon/post/flag.rb

@@ -21,17 +21,36 @@ module Rubyhexagon
     # Class to represent post flags
     #
     # @author Maxine Michalski
+    # @api public
     # @since 2.0.0
     class Flag
+      # Flag ID
+      # @example Get flag ID
+      #   flag.id #=> Integer
       # @return [Integer] id of flag
       attr_reader :id
 
+      # Creation time of flag
+      # @example Get flag creation time
+      #   flag.created_at #=> Time
       # @return [Time] creation time of flag
       attr_reader :created_at
+
+      # Flag post
+      # @example Get post that this flag references
+      #   flag.post #=> E621::Post
       # @return [621::Post] Post this flag is addressed to
       attr_reader :post
+
+      # Flagging reason
+      # @example Get reason for flagging
+      #   flag.reason #=> String
       # @return [String] reason for flag
       attr_reader :reason
+
+      # User that initiated flagging
+      # @example Get user that flagged post
+      #   flag.user #=> E621::User
       # @return [E621::User] User who flagged
       attr_reader :user
 
@@ -41,6 +60,8 @@ module Rubyhexagon
       #
       # @param flag [Hash] flag data
       #
+      # @example Get instance of flag
+      #   E621::Post::Flag.new(id: 1) #=> E621::Post::Flag instance
       # @return the object
       def initialize(flag)
         unless flag.is_a?(Hash)
@@ -69,10 +90,27 @@ module Rubyhexagon
       #
       # Comparison method for flags
       #
+      # @example Compare two notes, that are unequal
+      #   Note.new(id: 1) == Note.new(id: 2) #=> false
       # @return [TrueClass, FalseClass]
       def ==(other)
         other.is_a?(E621::Post::Flag) && @id == other.id
       end
+
+      # @author Maxine Michalski
+      #
+      # Turn object into a hash representation of itself
+      #
+      # @example Turn a Flag into a Hash
+      #   Note.new(id: 1).to_hash #=> { id: 1 }
+      # @return [Hash]
+      def to_hash
+        hash = {}
+        instance_variables.each do |i|
+          hash.store(i.to_s.sub(/^@/, '').to_sym, instance_variable_get(i))
+        end
+        hash
+      end
     end
   end
 end

data/lib/rubyhexagon/post/image.rb

@@ -25,24 +25,29 @@ module Rubyhexagon
     # @author Maxine Michalski
     # @since 1.0.0
     class Image
+      # Image url
       # @return [URI] url of file
       attr_reader :url
 
+      # Image file extension
       # @return [String] extension of file
       attr_reader :ext
 
+      # Image width
       # @return [Integer] image/video width
       attr_reader :width
 
+      # Image height
       # @return [Integer] image/video height
       attr_reader :height
 
+      # Image file size
       # @return [Integer] file size in bytes
       attr_reader :size
 
       # @author Maxine Michalski
       #
-      # Initializer for an Image.
+      # Initializer for an Image
       #
       # @param image [Hash] image information
       # @option image [String] :url URI location
@@ -71,7 +76,7 @@ module Rubyhexagon
 
       # @author Maxine Michalski
       #
-      # A convenient function to return both width and height.
+      # A convenient function to return both width and height
       #
       # @return [Array<Integer>]
       def resolution
@@ -80,7 +85,7 @@ module Rubyhexagon
 
       # @author Maxine Michalski
       #
-      # A convenient function to return the aspect ratio of a given image.
+      # A convenient function to return the aspect ratio of a given image
       #
       # @return [Float]
       def aspect_ratio
@@ -91,10 +96,27 @@ module Rubyhexagon
       #
       # Comparison method to comapre two Image objects (and sub class objects)
       #
+      # @example Compare two notes, that are unequal
+      #   Note.new(id: 1) == Note.new(id: 2) #=> false
       # @return [TrueClass, FalseClass]
       def ==(other)
         other.is_a?(Image) && @url == other.url && @size == other.size
       end
+
+      # @author Maxine Michalski
+      #
+      # Turn object into a hash representation of itself
+      #
+      # @example Turn an Image into a Hash
+      #   Note.new(id: 1).to_hash #=> { id: 1 }
+      # @return [Hash]
+      def to_hash
+        hash = {}
+        instance_variables.each do |i|
+          hash.store(i.to_s.sub(/^@/, '').to_sym, instance_variable_get(i))
+        end
+        hash
+      end
     end
 
     # class for samples, that is just a copy of Image

data/lib/rubyhexagon/post/note.rb

@@ -0,0 +1,174 @@
+# frozen_string_literal: true
+
+# Copyright 2014-2018, 2020 Maxine Michalski <maxine@furfind.net>
+#
+# This file is part of rubyhexagon.
+#
+# rubyhexagon is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# rubyhexagon is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# You should have received a copy of the GNU General Public License
+# along with rubyhexagon.  If not, see <http://www.gnu.org/licenses/>.
+
+module Rubyhexagon
+  class Post
+    # This class holds note information. Notes are additional information on
+    # posts.
+    #
+    # @author Maxine Michalski
+    # @api public
+    # @since 2.0.0
+    class Note
+      # Note ID
+      # @example Get note ID
+      #   note.id #=> Integer
+      # @return [Integer] id for this note
+      attr_reader :id
+
+      # Note creation time
+      # @example Get time note was created
+      #   note.created_at #=> Time
+      # @return [Time] time of creation
+      attr_reader :created_at
+
+      # Time note was last updated
+      # @example Get time note was last updated
+      # @return [Time] time of last update
+      attr_reader :updated_at
+
+      # Note creator
+      # @example Get creator of note
+      #   note.creator #=> E621::User
+      # @return [E621::User] user object of creator
+      attr_reader :creator
+
+      # X position of note
+      # @example Get x position of note
+      #   note.x #=> Integer
+      # @return [Integer] position x value
+      attr_reader :x
+
+      # Y position of note
+      # @example Get y position of note
+      #   note.y #=> Integer
+      # @return [Integer] position y value
+      attr_reader :y
+
+      # Convenience method for getting the entire point
+      # @example Get position of note as a point
+      #   note.point #=> [x, y]
+      # @return [Array<Integer>] combined position (x, y)
+      attr_reader :point
+
+      # Width of note
+      # @example Get width of note
+      #   note.width #=> Integer
+      # @return [Integer] width of object
+      attr_reader :width
+
+      # Height of note
+      # @example Get height of note
+      #   note.height #=> Integer
+      # @return [Integer] height of object
+      attr_reader :height
+
+      # Describe note position and size via a rectangular
+      # @example Get note position and size
+      #   note.rect #=> [x, y, width, height]
+      # @return [Array<Integer>] combined rectangular (x, y, width, height)
+      attr_reader :rect
+
+      # Post this note belongs to
+      # @example Get post this note belongs to
+      #   note.post #=> E621::Post
+      # @return [E621::Post] post this note belongs to
+      attr_reader :post
+
+      # Text of note
+      # @example Get text of this note
+      #   note.body #=> String
+      # @return [String] text content of note
+      attr_reader :body
+
+      # Version of note
+      # @example Get version of note
+      #   note.version => Integer
+      # @return [Integer] version of this note
+      attr_reader :version
+
+      # @author Maxine Michalski
+      #
+      # Initializer for Note
+      #
+      # @param note [Hash] note information in hash form
+      # @example Get new note instance
+      #   E621::Post::Note.new(id: 1) #=> E621::Post::Note instance
+      # @return the object
+      def initialize(note)
+        unless note.is_a?(Hash)
+          raise ArgumentError, "#{note.class} is not a Hash"
+        end
+        raise ArgumentError, 'An id is required' if note[:id].nil?
+        note.each do |k, v|
+          if %i[id x y width height is_active version body].include?(k)
+            if k == :id && !(v.is_a?(Integer) && v.positive?)
+              raise InvalidIDError, "Invalid id: #{v}"
+            end
+            instance_variable_set("@#{k}".to_sym, v)
+          elsif %i[created_at updated_at].include?(k)
+            instance_variable_set("@#{k}".to_sym, Time.at(v[:s]))
+          elsif k == :post_id
+            @post = E621::Post.new(id: v)
+          elsif k == :creator_id
+            @creator = E621::User.new(id: v)
+          end
+        end
+        @point = [@x, @y]
+        @rect = [@x, @y, @width, @height]
+      end
+
+      # @author Maxine Michalski
+      #
+      # Determine if note is active or not
+      # @example Is note active?
+      #   note.active? #=> true or false
+      # @return [TrueClass|FalseClass] active state of note
+      def active?
+        return false if @is_active.nil?
+        @is_active
+      end
+
+      # @author Maxine Michalski
+      #
+      # Comparison method for Notes, to give a more meaningful comparison
+      # @param other [Object] object that should be compared
+      # @example Compare two notes, that are unequal
+      #   Note.new(id: 1) == Note.new(id: 2) #=> false
+      # @return [TrueClass, FalseClass]
+      def ==(other)
+        other.is_a?(Note) && @id == other.id && @version == other.version
+      end
+
+      # @author Maxine Michalski
+      #
+      # Turn object into a hash representation of itself
+      #
+      # @example Turn a Note into a Hash
+      #   Note.new(id: 1).to_hash #=> { id: 1 }
+      # @return [Hash]
+      def to_hash
+        hash = {}
+        instance_variables.each do |i|
+          hash.store(i.to_s.sub(/^@/, '').to_sym, instance_variable_get(i))
+        end
+        hash
+      end
+    end
+  end
+end

data/lib/rubyhexagon/post/tag_item.rb

@@ -21,17 +21,37 @@ module Rubyhexagon
     # Class to represent post tag_items
     #
     # @author Maxine Michalski
+    # @api public
     # @since 2.0.0
     class TagItem
-      # @return [Integer] id of post information
+      # Tag item ID
+      # @example Get tag item ID
+      #   tag_item.id #=> Integer
+      # @return [Integer] id of tag item
       attr_reader :id
-      # @return [Integer] id of post information
+
+      # Creation time of tag item
+      # @example Get creation time of tag item
+      #   tag_item.created_at #=> Time
+      # @return [Time] creation time of tag item
       attr_reader :created_at
-      # @return [Integer] id of post information
+
+      # Post for this tag item
+      # @example Get post this tag item belongs to
+      #   tag_item.post #=> E621::Post
+      # @return [E621::Post] post for this tag item
       attr_reader :post
-      # @return [Integer] id of post information
+
+      # Changed tags inside tag item
+      # @example Get changed tags of tag item
+      #   tag_item.tags #=> Array<E621::Tag>
+      # @return [Array<E621::Tags>] tags this tag item contains
       attr_reader :tags
-      # @return [Integer] id of post information
+
+      # New sources for post in tag item
+      # @example Get sources of tag item
+      #   tag_item.sources #=> Array<String>
+      # @return [Array<String>] changed sources
       attr_reader :sources
 
       # @author Maxine Michalski
@@ -40,6 +60,9 @@ module Rubyhexagon
       #
       # @param tag_item [Hash] tag item data
       #
+      # @example Get instance of flag
+      #   E621::Post::TagItem.new(id: 1, created_at: 1
+      #   post_id: 1, tags: '', source: '') #=> E621::Post::TagItem instance
       # @return the object
       def initialize(tag_item)
         unless tag_item.is_a?(Hash)
@@ -65,10 +88,27 @@ module Rubyhexagon
       #
       # Comparison method for tag change items
       #
+      # @example Compare two notes, that are unequal
+      #   Note.new(id: 1) == Note.new(id: 2) #=> false
       # @return [TrueClass, FalseClass]
       def ==(other)
         other.is_a?(E621::Post::TagItem) && @id == other.id
       end
+
+      # @author Maxine Michalski
+      #
+      # Turn object into a hash representation of itself
+      #
+      # @example Turn a TagItem into a Hash
+      #   Note.new(id: 1).to_hash #=> { id: 1 }
+      # @return [Hash]
+      def to_hash
+        hash = {}
+        instance_variables.each do |i|
+          hash.store(i.to_s.sub(/^@/, '').to_sym, instance_variable_get(i))
+        end
+        hash
+      end
     end
   end
 end

data/lib/rubyhexagon/tag.rb

@@ -20,27 +20,44 @@ module Rubyhexagon
   # Class to hold tag information.
   #
   # @author Maxine Michalski
+  # @api public
   # @since 1.0.0
   class Tag
+    # Tag ID
+    # @example Get Tag ID
+    #   tag.id #=> Integer
     # @return [Integer] id of tag
     attr_reader :id
 
+    # Tag name
+    # @example Get tag name
+    #   tag.name #=> String
     # @return [String] name of tag
     attr_reader :name
 
+    # Number of posts, this tag is assigned to
+    # @example Get post count of tag
+    #   tag.count #=> Integer
     # @return [Integer] number of posts that have this tag assigned to them
     attr_reader :count
 
-    # @return [Tag::Type] type of this tag
+    # Tag type
+    # @example Get tag type
+    #   tag.type $=> E621::Tag::Type
+    # @return [E621::Tag::Type] type of this tag
     attr_reader :type
 
     # @author Maxine Michalski
     #
-    # Initializer for Tag.
+    # Initializer for Tag
     #
     # @raise InvalidIDError|ArgumentError
     #
     # @param tag [Hash] tag data
+    # @example Get new tag instance by ID
+    #   Tag.new(id: 1) #=> E621::Tag
+    # @example Get new tag instance by name
+    #   E621::Tag.new(name: 'feline') #=> E621::Tag
     #
     # @return the object
     def initialize(tag)
@@ -63,10 +80,26 @@ module Rubyhexagon
 
     # @author Maxine Michalski
     #
-    # Comparison operator for Tag, to override the default one.
+    # Turn object into a hash representation of itself
     #
-    # @param other [Object] object that should be compared
+    # @example Turn a User into a Hash
+    #   Tag.new(id: 1).to_hash #=> { id: 1 }
+    # @return [Hash]
+    def to_hash
+      hash = {}
+      instance_variables.each do |i|
+        hash.store(i.to_s.sub(/^@/, '').to_sym, instance_variable_get(i))
+      end
+      hash
+    end
+
+    # @author Maxine Michalski
+    #
+    # Comparison operator for Tag, to override the default one
     #
+    # @param other [Object] object that should be compared
+    # @example Compare two tags, that are unequal
+    #   Tag.new(id: 1) == Tag.new(id: 2) #=> false
     # @return [TrueClass, FalseClass] test result of comparison
     def ==(other)
       return false unless other.is_a?(Tag)