rubyhexagon 2.0.1 → 3.0.0

data/lib/rubyhexagon/search/posts.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
-  # 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 }
-          page += 1
-          d = fetch_deleted(page)
-        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)
-        parameters = { tags: tags, limit: limit }
-        posts = fetch_posts(parameters)
-        while block_given? && posts != []
-          posts.each { |post| yield post }
-          parameters[:before_id] = posts.last.nil? ? 0 : posts.last.id
-          posts = fetch_posts(parameters)
-        end
-        posts
-      end
-
-      # @author Maxine Michalski
-      #
-      # Fetch popular posts by day, week or month
-      #
-      # @param timespan [Symbol] can be :day, :week or :month
-      # @raise ArgumentError if no valid symbol is given
-      #
-      # @return [Array<Post>]
-      def self.popular(timespan = :day)
-        unless %i[day week month].include?(timespan)
-          raise ArgumentError, "Unknown time span: #{timespan}"
-        end
-        API.new.fetch('post', "popular_by_#{timespan}", {}).map do |post|
-          Post.new(post[:id]).show(post)
-        end
-      end
-
-      # @author Maxine Michalski
-      #
-      # Helper function for deleted posts
-      #
-      # @return [Array<Post>] array of deleted posts
-      def self.fetch_deleted(page)
-        API.new.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.new.fetch('post', 'index', parameters).map do |data|
-          Post.new(data[:id]).show(data)
-        end
-      end
-      private_class_method :fetch_posts
-    end
-  end
-end

data/lib/rubyhexagon/tag.rb

@@ -1,109 +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 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
-
-    # 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
-    #
-    # @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)
-      raise ArgumentError, "#{tag.class} is not a Hash" unless tag.is_a?(Hash)
-      if tag[:id].nil? && tag[:name].nil?
-        raise ArgumentError, 'At least :id or :name must be given!'
-      end
-      tag[:type_locked] = false if tag[:type_locked].nil?
-      tag.each do |k, v|
-        if %i[id name count].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 == :type
-          @type = E621::Tag::Type.new(id: v, locked: tag[:type_locked])
-        end
-      end
-    end
-
-    # @author Maxine Michalski
-    #
-    # Turn object into a hash representation of itself
-    #
-    # @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)
-      @id == other.id && @name == other.name && @type == other.type
-    end
-  end
-end

data/lib/rubyhexagon/tag/alias.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 Tag
-    # Class to hold alias information.
-    #
-    # @author Maxine Michalski
-    # @api public
-    # @since 2.0.0
-    class Alias
-      # Alias ID
-      # @example Get alias ID
-      #  alias.id #=> Integer
-      # @return [Integer] id of alias
-      attr_reader :id
-
-      # Alias name
-      # @example Get alias name
-      #   alias.name #=> String
-      # @return [String] name of alias
-      attr_reader :name
-
-      # Tag this alias is for
-      # @example Get aliased tag
-      #   alias.alias_to #=> E621::Tag
-      # @return [E621::Tag] tag this alias is aliased to
-      attr_reader :alias_to
-
-      # @author Maxine Michalski
-      #
-      # Initializer for Alias
-      #
-      # @raise InvalidIDError if alias ID is not valid
-      # @raise ArgumentError hash not valid
-      #
-      # @param ali [Hash] alias data, fetched from e621
-      # @option ali [Integer] :id alias ID
-      # @option ali [String] :name alias for tag
-      # @option ali [Integer] :alias_id ID of tag to alias
-      # @option ali [TrueClass|FalseClass] :pending statud
-      # @example Get alias isntance
-      #   E621::Tag::Alias.new(id: 1, name: 'test', alias_id: 1,
-      #    pending: false) #=> E621::Tag::Alias instance
-      # @return the object
-      def initialize(ali)
-        raise ArgumentError, "#{ali.class} is not a Hash" unless ali.is_a?(Hash)
-        if ali.keys != %i[id name alias_id pending]
-          mis = %i[id name alias_id pending] - ali.keys
-          raise ArgumentError, "Missing key#{mis.count > 1 ? 's' : ''}: #{mis}"
-        end
-        ali.each do |k, v|
-          if %i[id name pending].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 k == :alias_id
-            @alias_to = E621::Tag.new(id: v)
-          end
-        end
-      end
-
-      # @author Maxine Michalski
-      #
-      # Comparison method for Types, to give a more meaningful comparison
-      # @example Compare two tags, that are unequal
-      #   Tag.new(id: 1) == Tag.new(id: 2) #=> false
-      # @return [TrueClass, FalseClass]
-      def ==(other)
-        other.is_a?(Alias) && @id == other.id
-      end
-
-      # @author Maxine Michalski
-      #
-      # Check if this alias is pending confirmation
-      # @example Is alias pending?
-      #   alias.pending? #=> true or false
-      # @return [TrueClass] tag alias is pending
-      # @return [FalseClass] tag alias is not pending
-      def pending?
-        @pending
-      end
-
-      # @author Maxine Michalski
-      #
-      # Turn object into a hash representation of itself
-      #
-      # @example Turn an Alias 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
-    end
-  end
-end

data/lib/rubyhexagon/tag/implication.rb

@@ -1,121 +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 Tag
-    # Class to hold implication information.
-    #
-    # @author Maxine Michalski
-    # @api public
-    # @since 2.0.0
-    class Implication
-      # Implication ID
-      # @example Get implication ID
-      #   implication.id #=> Integer
-      # @return [Integer] id of implication
-      attr_reader :id
-
-      # Tag that implies another tag
-      # @example Get implying tag
-      #   implication.tag #=> E621::Tag
-      # @return [E621::Tag] implying tag
-      attr_reader :tag
-
-      # Tag that is implied
-      # @example Get implied tag
-      #   implication.implied #=> E621::Tag
-      # @return [E621::Tag] implied tag
-      attr_reader :implies
-
-      # @author Maxine Michalski
-      #
-      # Initializer for Implication
-      #
-      # @raise InvalidIDError if implication ID is not valid
-      # @raise ArgumentError hash not valid
-      #
-      # @param imply [Hash] implication data, fetched from e621
-      # @option imply [Integer] :id implication ID
-      # @option imply [Integer] :consequent_id implying tag ID
-      # @option imply [Integer] :predicate_id implied tag ID
-      # @option imply [TrueClass|FalseClass] :pending statud
-      # @example Get new implication instance
-      #   E621::Tag::Implication.new(id: 1, consequent_id: 1, predicate_id: 2,
-      #   pending: false) #=> E621::Tag::Implication
-      # @return the object
-      def initialize(imply)
-        unless imply.is_a?(Hash)
-          raise ArgumentError, "#{imply.class} is not a Hash"
-        end
-        if imply.keys != %i[id consequent_id predicate_id pending]
-          mis = %i[id consequent_id predicate_id pending] - imply.keys
-          raise ArgumentError, "Missing key#{mis.count > 1 ? 's' : ''}: #{mis}"
-        end
-        imply.each do |k, v|
-          if %i[id pending].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 k == :consequent_id
-            @tag = E621::Tag.new(id: v)
-          elsif k == :predicate_id
-            @implies = E621::Tag.new(id: v)
-          end
-        end
-      end
-
-      # @author Maxine Michalski
-      #
-      # Comparison method for Types, to give a more meaningful comparison
-      # @example Compare two tags, that are unequal
-      #   Tag.new(id: 1) == Tag.new(id: 2) #=> false
-      # @return [TrueClass, FalseClass]
-      def ==(other)
-        other.is_a?(Implication) && @id == other.id
-      end
-
-      # @author Maxine Michalski
-      #
-      # Check if this implication is pending confirmation
-      #
-      # @example Is implication pending?
-      #   implication.pending? #=> true or false
-      # @return [TrueClass] tag implication is pending
-      # @return [FalseClass] tag implication is not pending
-      def pending?
-        @pending
-      end
-
-      # @author Maxine Michalski
-      #
-      # Turn object into a hash representation of itself
-      #
-      # @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
-    end
-  end
-end