rubyhexagon 2.0.1 → 3.0.0

data/lib/rubyhexagon/pool.rb

@@ -1,151 +0,0 @@
-# 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
-  # This class holds post information, fetched from e621, and gives access in a
-  # more Ruby like manner.
-  #
-  # @author Maxine Michalski
-  # @api public
-  # @since 1.4.0
-  class Pool
-    # Pool ID
-    # @example Get pool ID
-    #   pool.id #=> Integer
-    # @return [Integer] returns this pool's ID
-    attr_reader :id
-
-    # Pool name
-    # @example Get pool name
-    #   pool.name #=> String
-    # @return [String] returns name of current pool
-    attr_reader :name
-
-    # Pool creation time
-    # @example Get pool creation time
-    #   pool.created_at #=> Time
-    # @return [Time] returns creation time
-    attr_reader :created_at
-
-    # Time of last update to pool
-    # @example Get last update time of pool
-    #   pool.updated_at #=> Time
-    # @return [Time] returns time of last update
-    attr_reader :updated_at
-
-    # Pool description
-    # @example Get pool description
-    #   pool.description #=> String
-    # @return [String] returns a description of the current pool
-    attr_reader :description
-
-    # Number of posts, inside pool
-    # @example Get number of posts, pool has
-    #   pool.post_count #=> Integer
-    # @return [Integer] returns number of posts inside pool
-    attr_reader :post_count
-
-    # User who created pool
-    # @example Get user that created pool
-    #   pool.creator #=> E621::User
-    # @return [E621::User] returns the user, who has created this pool
-    attr_reader :creator
-
-    # Posts of pool
-    #
-    # @example Get posts of pool
-    #   pool.posts #=> Array<E621::Post>
-    # @return [Array<E621::Post>] returns an array of posts, that belong to
-    # this pool
-    attr_reader :posts
-
-    # @author Maxine Michalski
-    #
-    # Initializer for Pool objects
-    #
-    # @param pool [Hash] Pool information
-    # @example Get new pool instance
-    #   E621::Pool.new(id: 1) #=> E621::Pool instance
-    # @return the object
-    def initialize(pool)
-      raise ArgumentError, "#{pool.class} is not a Hash" unless pool.is_a?(Hash)
-      raise ArgumentError, 'Hash must include :id' if pool[:id].nil?
-      pool.each do |k, v|
-        if %i[id name post_count is_active is_locked description].include?(k)
-          if k == :id && !(v.is_a?(Integer) && v.positive?)
-            raise InvalidIDError, "ID out of range: #{v}"
-          end
-          instance_variable_set("@#{k}".to_sym, v)
-        elsif %i[updated_at created_at].include?(k)
-          instance_variable_set("@#{k}".to_sym, Time.at(v[:s]))
-        elsif k == :user_id
-          @creator = E621::User.new(id: v)
-        elsif k == :posts
-          @posts = v.map { |post| E621::Post.new(post) }
-        end
-      end
-    end
-
-    # @author Maxine Michalski
-    #
-    # Returns locking status
-    # @example Test if pool is locked
-    #   pool.locked? #=> true or false
-    # @return [TrueClass|FalseClass]
-    def locked?
-      @is_locked
-    end
-
-    # @author Maxine Michalski
-    #
-    # Returns active status
-    # @example Test if pool is active or not
-    #   pool.active? #=> true or false
-    # @return [TrueClass|FalseClass]
-    def active?
-      @is_active
-    end
-
-    # @author Maxine Michalski
-    #
-    # Comparison method for Pool objects
-    #
-    # @param other [Object] other object to compare
-    # @example Comapring two unequal pools
-    #   Pool.new(id: 1) == Pool.new(id: 2) #=> false
-    # @return [TrueClass|FalseClass]
-    def ==(other)
-      other.is_a?(Pool) && @id == other.id && @updated_at == other.updated_at
-    end
-
-    # @author Maxine Michalski
-    #
-    # Turn object into a hash representation of itself
-    #
-    # @example Turn a User into a Hash
-    #   E621::Pool.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

data/lib/rubyhexagon/post/flag.rb

@@ -1,116 +0,0 @@
-# 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
-    # 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
-
-      # @author Maxine Michalski
-      #
-      # Initializer for flags
-      #
-      # @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)
-          raise ArgumentError, "#{flag.class} is not a Hash"
-        end
-        unless flag.key?(:id)
-          raise ArgumentError, 'Not all required keys available!'
-        end
-        flag.each do |k, v|
-          if %i[id reason].include?(k)
-            if k == :id && !(v.is_a?(Integer) && v.positive?)
-              raise InvalidIDError, "ID out of range: #{v}"
-            end
-            instance_variable_set("@#{k}".to_sym, v)
-          elsif k == :created_at
-            @created_at = Time.at(v)
-          elsif k == :post_id
-            @post = E621::Post.new(id: v)
-          elsif k == :user_id
-            @user = E621::User.new(id: v)
-          end
-        end
-      end
-
-      # @author Maxine Michalski
-      #
-      # 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/note.rb

@@ -1,174 +0,0 @@
-# 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

@@ -1,114 +0,0 @@
-# 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
-    # Class to represent post tag_items
-    #
-    # @author Maxine Michalski
-    # @api public
-    # @since 2.0.0
-    class TagItem
-      # Tag item ID
-      # @example Get tag item ID
-      #   tag_item.id #=> Integer
-      # @return [Integer] id of tag item
-      attr_reader :id
-
-      # 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
-
-      # 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
-
-      # 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
-
-      # 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
-      #
-      # Initializer for tag change items
-      #
-      # @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)
-          raise ArgumentError, "#{tag_item.class} is not a Hash"
-        end
-        unless (miss = %i[id created_at post_id tags source] -
-            tag_item.keys).empty?
-          raise ArgumentError, 'Not all required keys available! '\
-            "Missing: #{miss}"
-        end
-        id = tag_item[:id]
-        unless id.is_a?(Integer) && id.positive?
-          raise InvalidIDError, "ID out of range: #{id}"
-        end
-        @id = id
-        @created_at = Time.at(tag_item[:created_at])
-        @post = E621::Post.new(id: tag_item[:post_id])
-        @tags = tag_item[:tags].split(' ').map { |t| E621::Tag.new(name: t) }
-        @sources = tag_item[:source].split($INPUT_RECORD_SEPARATOR)
-      end
-
-      # @author Maxine Michalski
-      #
-      # 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