rubyhexagon 0.4.3 → 1.0.0

data/lib/rubyhexagon/post.rb

@@ -0,0 +1,256 @@
+# Copyright 2014-2018 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 E621
+  # This class holds post information, fetched from e621, and gives access in a
+  # more Ruby like manner.
+  #
+  # @author Maxine Michalski
+  # @since 1.0.0
+  class Post
+    # @return [Integer] id of post information
+    attr_reader :id
+
+    # @return [User] user object of who uploaded this post
+    attr_reader :author
+
+    # @return [Time] creation time of post
+    attr_reader :created_at
+
+    # @return [Symbol] status of post, can be :active, :flagged, :pending or
+    #   :deleted
+    attr_reader :status
+
+    # @return [Array<String>] array of sources. This can contain URI in string
+    #   form
+    attr_reader :sources
+
+    # @return [Array<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
+
+    # @return [Integer] vote score this post holds
+    attr_reader :score
+
+    # @return [Symbol] rating of this post. Can be one of :safe,
+    #   :questionable, :explicit
+    attr_reader :rating
+
+    # @return [Post] parent of this post
+    # @return [NilClass]
+    attr_reader :parent
+
+    # @return [Array<Post>] Array of child posts
+    attr_reader :children
+
+    # @return [String] MD5 checksum associated with this post
+    attr_reader :md5
+
+    # @return [E621::Image] file content of this post
+    attr_reader :image
+
+    # @return [E621::Sample] sample data in E621::Sample format
+    attr_reader :sample
+
+    # @return [E621::Preview] preview data in E621::Preview format
+    attr_reader :preview
+
+    # @author Maxine Michalski
+    #
+    # Initializer for Post.
+    #
+    # @param id [Integer] post id on e621
+    #
+    # @return the object
+    def initialize(id)
+      id = id.to_i
+      unless id.is_a?(Integer) && id > 0
+        raise InvalidIDError, "ID out of range: #{id}"
+      end
+      @id = id
+    end
+
+    # @author Maxine Michalski
+    #
+    # @param post [Hash] post data, if present
+    #
+    # 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)
+    end
+
+    # @author Maxine Michalski
+    #
+    # @param post [Hash] post data, if present
+    #
+    # Fetch data from e621 to current post id
+    def show(post = nil)
+      post = API.new.fetch('post', 'show', id: @id) if post.nil?
+      tmp = Post.new(post[:id].to_i)
+      tmp.show!(post)
+      tmp
+    end
+
+    # @author Maxine Michalski
+    #
+    # Retrieve an Array of this post's tags
+    #
+    # @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
+    end
+
+    # @author Maxine Michalski
+    #
+    # Test status with an optional parameter. This is more meant to be used by
+    # alias methods
+    #
+    # @return [TrueClass]
+    # @return [FalseClass]
+    def test_status(status = nil)
+      status ||= __callee__.to_s.sub(/\?/, '').to_sym
+      @status == status
+    end
+    alias active? test_status
+    alias flagged? test_status
+    alias pending? test_status
+    alias deleted? test_status
+
+    # @author Maxine Michalski
+    #
+    # Check a post for a certain rating. This is rather meant to be used via
+    # alias methids.
+    #
+    # @return [TrueClass]
+    # @return [FalseClass]
+    def test_rating(rating = nil)
+      rating ||= __callee__.to_s.sub(/\?/, '').to_sym
+      @rating == rating
+    end
+    alias safe? test_rating
+    alias questionable? test_rating
+    alias explicit? test_rating
+
+    # @author Maxine Michalski
+    #
+    # Comparison method for posts
+    #
+    # @return [TrueClass, FalseClass]
+    def ==(other)
+      other.is_a?(Post) && @id == other.id
+    end
+
+    private
+
+    # @author Maxine Michalski
+    #
+    # Helper function, to setup post file data
+    def setup_file_data(post)
+      @md5 = post[:md5]
+      @image = E621::Image.new(url: post[:file_url], ext: post[:file_ext],
+                               width: post[:width], height: post[:height])
+      setup_sample(post)
+      setup_preview(post)
+    end
+
+    # @author Maxine Michalski
+    #
+    # Helper function, to setup post sample data
+    def setup_sample(post)
+      @sample = E621::Sample.new(url: post[:sample_url], ext: post[:file_ext],
+                                 width: post[:sample_width],
+                                 height: post[:sample_height])
+    end
+
+    # @author Maxine Michalski
+    #
+    # Helper function, to setup post preview data
+    def setup_preview(post)
+      @preview = E621::Preview.new(url: post[:preview_url], ext: 'jpg',
+                                   width: post[:preview_width],
+                                   height: post[:preview_height])
+    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
+    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])
+    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])
+    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
+
+    # @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
+    end
+  end
+end

data/lib/rubyhexagon/search/posts.rb

@@ -0,0 +1,99 @@
+# Copyright 2014-2018 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 E621
+  # Module to hold search classes
+  #
+  # @author Maxine Michalski
+  # @since 1.0.0
+  module Search
+    # Class to hold methods for Post searches.
+    #
+    # @author Maxine Michalski
+    # @since 1.0.0
+    class Posts
+      # @author Maxine Michalski
+      #
+      # Retrieve a list of deleted post, with deletion reason. Only id and
+      # del_reason is present.
+      # This method accepts blocks and only returns one page without blocks
+      #
+      # @param page [Integer] page of deleted posts to return
+      #
+      # @return [Array<Post>] an array of deleted posts
+      def self.deleted(page = 1)
+        d = fetch_deleted(page)
+        while block_given? && d != []
+          d.each { |del| yield del }
+          d = fetch_deleted(page)
+          page += 1
+        end
+        d
+      end
+
+      # @author Maxine Michalski
+      #
+      # Retrieve a list of post data, which is filtered by arguments.
+      # This method requires a block to be passed to it!
+      #
+      # @param tags [String] this can be any request that can be done on e621
+      #   too
+      # @param limit [Integer] number of posts to return. This has a hard limit
+      #   of 320
+      # @param before_id [Integer] start post ID is lesser than this ID
+      #
+      # This method accepts blocks and only returns one page without blocks
+      #
+      # @return [Array<Post>] an array of posts
+      def self.list(tags, limit = 320, before_id = 2_000_000)
+        parameters = { tags: tags, limit: limit, before_id: before_id }
+        posts = fetch_posts(parameters)
+        while block_given? && posts != []
+          posts.each { |post| yield post }
+          posts = fetch_posts(parameters)
+          parameters[:before_id] = posts.last.nil? ? 0 : posts.last.id
+        end
+        posts
+      end
+
+      # @author Maxine Michalski
+      #
+      # Helper function for deleted posts
+      #
+      # @return [Array<Post>] array of deleted posts
+      def self.fetch_deleted(page)
+        api = API.new
+        api.fetch('post', 'deleted_index', page: page).map do |post|
+          DeletedPost.new(post[:id], post[:delreason])
+        end
+      end
+      private_class_method :fetch_deleted
+
+      # @author Maxine Michalski
+      #
+      # Helper function for posts
+      #
+      # @return [Array<Post>] array of posts
+      def self.fetch_posts(parameters)
+        api = API.new
+        api.fetch('post', 'index', parameters).map do |data|
+          Post.new(data[:id]).show(data)
+        end
+      end
+      private_class_method :fetch_deleted
+    end
+  end
+end

data/lib/rubyhexagon/search/tags.rb

@@ -0,0 +1,65 @@
+# Copyright 2014-2018 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 E621
+  # Module to hold search classes
+  #
+  # @author Maxine Michalski
+  # @since 1.0.0
+  module Search
+    # Class to hold methods for Tag searches.
+    #
+    # @author Maxine Michalski
+    # @since 1.0.0
+    class Tags
+      # @author Maxine Michalski
+      #
+      # Retrieve a list of post data, which is filtered by arguments.
+      # This method accepts a block and returns only one page without one.
+      #
+      # @param name [String] name pattern to search tags with
+      # @param limit [Integer] number of tags to return. This has a hard limit
+      #   of 500
+      # @param after_id [Integer] only look for tags after this ID
+      #
+      # @return [Array<Tag>] array of tags
+      def self.list(name, limit = 500, page = 1)
+        params = { name_pattern: name, order: :date, limit: limit,
+                   page: page }
+        t = fetch_tags(params)
+        while block_given? && t != []
+          t.each { |tag| yield tag }
+          t = fetch_tags(params)
+          params[:page] += 1
+        end
+        t
+      end
+
+      # @author Maxine Michalski
+      #
+      # Helper function to get Tag data
+      #
+      # @return [Array<Tag>] array of tags
+      def self.fetch_tags(params)
+        api = API.new
+        api.fetch('tag', 'index', params).map do |data|
+          Tag.new(data[:id]).show(data)
+        end
+      end
+      private_class_method :fetch_tags
+    end
+  end
+end

data/lib/rubyhexagon/tag.rb

@@ -0,0 +1,89 @@
+# Copyright 2014-2018 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 E621
+  # Class to hold tag information.
+  #
+  # @author Maxine Michalski
+  # @since 1.0.0
+  class Tag
+    # @return [Integer] id of tag
+    attr_reader :id
+
+    # @return [String] name of tag
+    attr_reader :name
+
+    # @return [Integer] number of posts that have this tag assigned to them
+    attr_reader :count
+
+    # @return [Type] type of this tag
+    attr_reader :type
+
+    # @author Maxine Michalski
+    #
+    # Initializer for Tag.
+    #
+    # @raise InvalidIDError
+    #
+    # @param tag [Integer] tag data, fetched from e621
+    #
+    # @return the object
+    def initialize(id)
+      unless id.is_a?(Integer) && id > 0
+        raise InvalidIDError, "ID out of range: #{id}"
+      end
+      @id = id
+    end
+
+    # @author Maxine Michalski
+    #
+    # Bang method to fill tag data. If data is already available at creation,
+    # use the initializer!
+    def show!(tag = nil)
+      tag = API.new.fetch('tag', 'show', id: @id) if tag.nil?
+      @name = tag[:name]
+      @count = tag[:count].to_i
+      @type = (Type.new(tag[:type], tag[:type_locked]) unless tag[:type].nil?)
+    end
+
+    # @author Maxine Michalski
+    #
+    # Bang method to fill tag data. If data is already available at creation,
+    # use the initializer!
+    def show(tag = nil)
+      new_tag = Tag.new(@id)
+      new_tag.show!(tag)
+      new_tag
+    end
+
+    # @author Maxine Michalski
+    #
+    # Comparison operator for Tag, to override the default one.
+    # @note This method looks for same id and same name only.
+    # @note If there is only a an ID set with one argument, then only compare
+    #   IDs
+    #
+    # @return [TrueClass, FalseClass]
+    def ==(other)
+      return false unless other.is_a?(Tag)
+      if @name.nil? || other.name.nil?
+        @id == other.id
+      else
+        @id == other.id && @name == other.name
+      end
+    end
+  end
+end