rubyhexagon 1.6.4 → 2.0.0

data/lib/rubyhexagon/pool.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2014-2018 Maxine Michalski <maxine@furfind.net>
+# Copyright 2014-2018, 2020 Maxine Michalski <maxine@furfind.net>
 #
 # This file is part of rubyhexagon.
 #
@@ -38,8 +38,11 @@ module Rubyhexagon
     # @return [String] returns a description of the current pool
     attr_reader :description
 
-    # @return [User] returns the user, who has created this pool
-    attr_reader :user
+    # @return [Integer] returns number of posts inside pool
+    attr_reader :post_count
+
+    # @return [E621::User] returns the user, who has created this pool
+    attr_reader :creator
 
     # @return [Array<Post>] returns an array of posts, that belong to this pool
     attr_reader :posts
@@ -48,52 +51,26 @@ module Rubyhexagon
     #
     # Initializer for Pool objects
     #
-    # @param id [Integer] ID of this pool
+    # @param pool [Hash] Pool information
     #
     # @return the object
-    def initialize(id)
-      unless id.is_a?(Integer) && id.positive?
-        raise InvalidIDError, "ID out of range: #{id}"
-      end
-      @id = id
-    end
-
-    # @author Maxine Michalski
-    #
-    # @param pool [Hash] pool data, if present
-    #
-    # Fetch data from e621 to current post id
-    def show!(pool = nil)
-      @posts = []
-      if pool.nil?
-        page = 1
-        loop do
-          pool = API.new.fetch('pool', 'show', id: @id, page: page)
-          page += 1
-          @posts += pool[:posts].map do |post|
-            E621::Post.new(post[:id]).show(post)
+    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
-          break if pool[:posts] == []
+          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
-      @name = pool[:name]
-      @created_at = Time.at(pool[:created_at][:s].to_i)
-      @updated_at = Time.at(pool[:updated_at][:s].to_i)
-      @description = pool[:description]
-      @user = User.new(id: pool[:user_id])
-      @is_locked = pool[:is_locked]
-      @is_active = pool[:is_active]
-    end
-
-    # @author Maxine Michalski
-    #
-    # @param pool [Hash] pool data, if present
-    #
-    # Fetch data from e621 to current pool id
-    def show(pool = nil)
-      tmp = Pool.new(@id)
-      tmp.show!(pool)
-      tmp
     end
 
     # @author Maxine Michalski
@@ -122,12 +99,7 @@ module Rubyhexagon
     #
     # @return [TrueClass,FalseClass]
     def ==(other)
-      if @name.nil?
-        other.is_a?(Pool) && @id == other.id
-      else
-        other.is_a?(Pool) && @name == other.name && @id == other.id &&
-          @updated_at == other.updated_at
-      end
+      other.is_a?(Pool) && @id == other.id && @updated_at == other.updated_at
     end
   end
 end

data/lib/rubyhexagon/post.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2014-2018 Maxine Michalski <maxine@furfind.net>
+# Copyright 2014-2018, 2020 Maxine Michalski <maxine@furfind.net>
 #
 # This file is part of rubyhexagon.
 #
@@ -26,7 +26,7 @@ module Rubyhexagon
     # @return [Integer] id of post information
     attr_reader :id
 
-    # @return [User] user object of who uploaded this post
+    # @return [E621::User] user object of who uploaded this post
     attr_reader :author
 
     # @return [Time] creation time of post
@@ -40,15 +40,15 @@ module Rubyhexagon
     #   form
     attr_reader :sources
 
-    # @return [Array<Artist>] array of artists, that work on the image in this
-    #   post
+    # @return [Array<E621::Artist>] array of artists, that work on the image
+    # in this post
     attr_reader :artists
 
     # @return [String] description that's associated with this post
     attr_reader :description
 
     # @return [Integer] number of people, who favorited this post
-    attr_reader :favorites
+    attr_reader :fav_count
 
     # @return [Integer] vote score this post holds
     attr_reader :score
@@ -57,252 +57,233 @@ module Rubyhexagon
     #   :questionable, :explicit
     attr_reader :rating
 
-    # @return [Post] parent of this post
+    # @return [E621:post] parent of this post
     # @return [NilClass]
     attr_reader :parent
 
-    # @return [Array<Post>] Array of child posts
+    # @return [Array<E621::Post>] Array of child posts
     attr_reader :children
 
     # @return [String] MD5 checksum associated with this post
     attr_reader :md5
 
-    # @return [Rubyhexagon::Image] file content of this post
+    # @return [E621::Image] file content of this post
     attr_reader :image
 
-    # @return [Rubyhexagon::Sample] sample data in Rubyhexagon::Sample format
+    # @return [E621::Sample] sample data in E621::Sample format
     attr_reader :sample
 
-    # @return [Rubyhexagon::Preview] preview data in Rubyhexagon::Preview format
+    # @return [E621::Preview] preview data in E621::Preview format
     attr_reader :preview
 
-    # @return [Array<String>] tag names only for convenience
-    attr_reader :tag_names
+    # @return [String|NilClass] reason for deletion, if deleted
+    attr_reader :delreason
+
+    # @return [Array<E621::Tag>] tags of this post
+    attr_reader :tags
 
     # @author Maxine Michalski
     #
     # Initializer for Post.
     #
-    # @param id [Integer] post id on e621
+    # @param post [Hash] post data
     #
     # @return the object
-    def initialize(id)
-      id = id.to_i
+    def initialize(post)
+      raise ArgumentError, "#{post.class} is not a Hash" unless post.is_a?(Hash)
+      post[:id] = post[:id].to_i
+      id = post[:id]
       raise InvalidIDError, "ID out of range: #{id}" unless id.positive?
-      @id = id
+      post.each do |k, v|
+        if %i[rating created_at status sources parent_id children
+              description artist tags].include?(k)
+          __send__("setup_#{k}".to_sym, v)
+        elsif %i[id description score fav_count md5 has_comments has_children
+                 delreason has_notes].include?(k)
+          instance_variable_set("@#{k}".to_sym, v)
+        end
+      end
+      setup_author(post)
+      setup_files(post)
     end
 
     # @author Maxine Michalski
     #
-    # @param post [Hash] post data, if present
+    # Test status with an optional parameter. This is more meant to be used by
+    # alias methods
     #
-    # Fetch data from e621 to current post id
-    def show!(post = nil)
-      post = API.new.fetch('post', 'show', id: @id) if post.nil?
-      @created_at = Time.at(post[:created_at][:s].to_i)
-      @status = post[:status].to_sym
-      setup_author(post)
-      setup_relatives(post)
-      setup_file_data(post)
-      setup_additional_data(post)
+    # @param test_var [Symbol] variable under test
+    #
+    # @return [TrueClass]
+    # @return [FalseClass]
+    def test(test_var = nil)
+      test_var ||= __callee__.to_s.sub(/\?/, '').to_sym
+      test_ar = %i[safe questionable explicit]
+      test_ar.include?(test_var) ? @rating == test_var : @status == test_var
     end
+    alias active? test
+    alias flagged? test
+    alias pending? test
+    alias deleted? test
+    alias safe? test
+    alias questionable? test
+    alias explicit? test
 
     # @author Maxine Michalski
     #
-    # @param post [Hash] post data, if present
+    # Show if post has comments or not
     #
-    # Fetch data from e621 to current post id
-    def show(post = nil)
-      tmp = Post.new(@id)
-      tmp.show!(post)
-      tmp
+    # @return [TrueClass|FalseClass]
+    def comments?
+      return false if @has_comments.nil?
+      @has_comments
     end
 
     # @author Maxine Michalski
     #
-    # Send a vote to e621
+    # Show if post has a parent
     #
-    # @param score [Integer] direction of vote, can be positive or negative
-    def vote!(score)
-      unless score.is_a?(Integer)
-        raise ArgumentError, 'Voting requires a positive/negative number'
-      end
-      raise ArgumentError, "Vote can't be zero" if score.zero?
-      score = score.positive? ? 1 : -1
-      res = API.new.fetch('post', 'vote', { id: @id, score: score }, 'POST')
-      if res[:reason] == 'access denied' && !res[:success]
-        raise Rubyhexagon::AccessDenied, res[:message]
-      end
-      nil
+    # @return [TrueClass|FalseClass]
+    def parent?
+      !@parent.nil?
     end
 
     # @author Maxine Michalski
     #
-    # Upvotes this post
-    def voteup!
-      vote!(1)
-    end
-
-    # @author Maxine Michalski
+    # Show if post has children
     #
-    # Downvotes this post
-    def votedown!
-      vote!(-1)
+    # @return [TrueClass|FalseClass]
+    def children?
+      return false if @has_children.nil?
+      @has_children
     end
 
     # @author Maxine Michalski
     #
-    # Favorite this post
-    def favorite!
-      res = API.new.fetch('favorite', 'create', { id: @id }, 'POST')
-      if res[:reason] == 'access denied' && !res[:success]
-        raise Rubyhexagon::AccessDenied, res[:message]
-      elsif !res[:success] &&
-            res[:reason] == 'You\'ve already favorited this post'
-        raise Rubyhexagon::AlreadyFavorited
-      end
-      nil
+    # Comparison method for posts
+    #
+    # @return [TrueClass, FalseClass]
+    def ==(other)
+      other.is_a?(Post) && @id == other.id
     end
 
     # @author Maxine Michalski
     #
-    # Unfavorite this post
-    def unfavorite!
-      res = API.new.fetch('favorite', 'destroy', { id: @id }, 'POST')
-      if res[:reason] == 'access denied' && !res[:success]
-        raise Rubyhexagon::AccessDenied, res[:message]
-      end
-      nil
+    # Has post notes?
+    #
+    # @return [TrueClass, FalseClass]
+    def notes?
+      @has_notes
     end
 
+    private
+
     # @author Maxine Michalski
     #
-    # Retrieve an Array of this post's tags
+    # Set author information
     #
-    # @return [Array<Tag>] array of tags
-    def tags
-      API.new.fetch('post', 'tags', id: @id).map do |tag|
-        Tag.new(tag[:id]).show(tag)
-      end
+    # @param post [Hash] post data
+    def setup_author(post)
+      return if post[:creator_id].nil?
+      @author = E621::User.new(id: post[:creator_id], name: post[:author])
     end
 
     # @author Maxine Michalski
     #
-    # Test status with an optional parameter. This is more meant to be used by
-    # alias methods
+    # Set rating for post
     #
-    # @param test_var [Symbol] variable under test
-    #
-    # @return [TrueClass]
-    # @return [FalseClass]
-    def test(test_var = nil)
-      test_var ||= __callee__.to_s.sub(/\?/, '').to_sym
-      test_ar = %i[safe questionable explicit]
-      test_ar.include?(test_var) ? @rating == test_var : @status == test_var
+    # @param rating [String] rating of this post
+    def setup_rating(rating)
+      @rating = case rating
+                when 's' then :safe
+                when 'q' then :questionable
+                when 'e' then :explicit
+                end
     end
-    alias active? test
-    alias flagged? test
-    alias pending? test
-    alias deleted? test
-    alias safe? test
-    alias questionable? test
-    alias explicit? test
 
     # @author Maxine Michalski
     #
-    # Comparison method for posts
+    # Set creation time
     #
-    # @return [TrueClass, FalseClass]
-    def ==(other)
-      other.is_a?(Post) && @id == other.id
+    # @param time [Time] Hash that includes creation time in UNIX Epoch on an
+    # `:s` key.
+    def setup_created_at(time)
+      @created_at = Time.at(time[:s]) unless time.nil?
     end
 
-    private
-
     # @author Maxine Michalski
     #
-    # Helper function, to setup post file data
-    def setup_file_data(post)
-      @tag_names = post[:tags].split(/\s+/)
-      @md5 = post[:md5]
-      @image = Image.new(url: post[:file_url], ext: post[:file_ext],
-                         width: post[:width], height: post[:height],
-                         size: post[:file_size])
-      setup_sample(post)
-      setup_preview(post)
+    # Set status of post
+    #
+    # @param status [String] Status of post
+    def setup_status(status)
+      @status = status.to_sym unless status.nil?
     end
 
     # @author Maxine Michalski
     #
-    # Helper function, to setup post sample data
-    def setup_sample(post)
-      @sample = Sample.new(url: post[:sample_url], ext: post[:file_ext],
-                           width: post[:sample_width],
-                           height: post[:sample_height])
+    # Set sources of post
+    #
+    # @param sources [Array<String>] Sources of post
+    def setup_sources(sources)
+      @sources = sources.nil? ? [] : sources
     end
 
     # @author Maxine Michalski
     #
-    # Helper function, to setup post preview data
-    def setup_preview(post)
-      @preview = Preview.new(url: post[:preview_url], ext: 'jpg',
-                             width: post[:preview_width],
-                             height: post[:preview_height])
+    # Set parent post
+    #
+    # @param parent [Integer] Parent post ID
+    #
+    # @notice A parent post is only set with an ID and further information must
+    # be fetched manually.
+    def setup_parent_id(parent)
+      @parent = parent.nil? ? nil : E621::Post.new(id: parent)
     end
 
     # @author Maxine Michalski
     #
-    # Helper function to add additional post data
-    def setup_additional_data(post)
-      @sources = post[:source].nil? ? [] : post[:sources]
-      @artists = post[:artist].map { |a| Artist.new(a) }
-      @description = post[:description]
-      @favorites = post[:fav_count].to_i
-      @score = post[:score].to_i
-      @rating = case post[:rating]
-                when 's' then :safe
-                when 'q' then :questionable
-                when 'e' then :explicit
-                end
+    # Set children posts
+    #
+    # @param children [Array<Integer>] Children post IDs
+    #
+    # @notice All children are only set with an ID and further information must
+    # be fetched manually.
+    def setup_children(children)
+      return [] if children.nil?
+      @children = children.split(',').map { |c| E621::Post.new(id: c) }
     end
 
     # @author Maxine Michalski
     #
-    # Helper function to related posts (children, parent)
-    def setup_relatives(post)
-      @children = post[:children].split(',').map { |i| Post.new(i) }
-      @parent = post[:parent_id].nil? ? nil : Post.new(post[:parent_id])
+    # Set post description
+    #
+    # @param description [String] Post description
+    #
+    # @notice Empty descriptions are set to nil
+    def setup_description(description)
+      @description = !description.nil? && description.empty? ? nil : description
     end
 
-    # @author Maxine Michalski
-    #
-    # Helper function to set author of a post
-    def setup_author(post)
-      @author = User.new(id: post[:creator_id], name: post[:author])
+    def setup_artist(artists)
+      @artists = artists.map { |a| E621::Artist.new(name: CGI.unescape(a)) }
     end
-  end
 
-  # This class holds post information, fetched from e621, and gives access in a
-  # more Ruby like manner.
-  # This is only for deleted posts.
-  #
-  # @author Maxine Michalski
-  # @since 1.0.0
-  class DeletedPost < Post
-    # @return [String] deletion reason, when available
-    attr_reader :reason
+    def setup_tags(tags)
+      @tags = tags.split(' ').map { |t| E621::Tag.new(name: t) }
+    end
 
-    # @author Maxine Michalski
-    #
-    # Initializer for DeletedPost.
-    #
-    # @param id [Integer] post id on e621
-    # @param delreason [String] reason of deletion
-    #
-    # @return the object
-    def initialize(id, delreason)
-      super(id)
-      @reason = delreason
+    def setup_files(post)
+      return if post[:file_url].nil?
+      @image = Image.new(url: post[:file_url], ext: post[:file_ext],
+                         width: post[:width], height: post[:height],
+                         size: post[:file_size])
+      @sample = Sample.new(url: post[:sample_url], ext: post[:file_ext],
+                           width: post[:sample_width],
+                           height: post[:sample_height], size: 0)
+      @preview = Preview.new(url: post[:preview_url], ext: 'jpg',
+                             width: post[:preview_width],
+                             height: post[:preview_height], size: 0)
     end
   end
 end