rubyhexagon 1.6.4 → 2.0.0

data/lib/rubyhexagon/post/flag.rb

@@ -0,0 +1,78 @@
+# 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
+    # @since 2.0.0
+    class Flag
+      # @return [Integer] id of flag
+      attr_reader :id
+
+      # @return [Time] creation time of flag
+      attr_reader :created_at
+      # @return [621::Post] Post this flag is addressed to
+      attr_reader :post
+      # @return [String] reason for flag
+      attr_reader :reason
+      # @return [E621::User] User who flagged
+      attr_reader :user
+
+      # @author Maxine Michalski
+      #
+      # Initializer for flags
+      #
+      # @param flag [Hash] flag data
+      #
+      # @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
+      #
+      # @return [TrueClass, FalseClass]
+      def ==(other)
+        other.is_a?(E621::Post::Flag) && @id == other.id
+      end
+    end
+  end
+end

data/lib/rubyhexagon/post/image.rb

@@ -0,0 +1,114 @@
+# 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 for post file data. This is mostly an abstraction to have data
+    # structures in a more Ruby like nature.
+    #
+    # @api private
+    # @author Maxine Michalski
+    # @since 1.0.0
+    class Image
+      # @return [URI] url of file
+      attr_reader :url
+
+      # @return [String] extension of file
+      attr_reader :ext
+
+      # @return [Integer] image/video width
+      attr_reader :width
+
+      # @return [Integer] image/video height
+      attr_reader :height
+
+      # @return [Integer] file size in bytes
+      attr_reader :size
+
+      # @author Maxine Michalski
+      #
+      # Initializer for an Image.
+      #
+      # @param image [Hash] image information
+      # @option image [String] :url URI location
+      # @option image [String] :ext extension string
+      # @option image [Integer] :width of image
+      # @option image [Integer] :height of image
+      # @option image [Integer] :size of image
+      #
+      # @return the object
+      def initialize(image)
+        unless image.is_a?(Hash)
+          raise ArgumentError, "#{image.class} is not a Hash"
+        end
+        if image.keys != %i[url ext width height size]
+          mis = %i[url ext width height size] - image.keys
+          raise ArgumentError, "Missing key#{mis.count > 1 ? 's' : ''}: #{mis}"
+        end
+        image.each do |k, v|
+          if %i[ext width height size].include?(k)
+            instance_variable_set("@#{k}".to_sym, v)
+          elsif k == :url
+            @url = URI.parse(v)
+          end
+        end
+      end
+
+      # @author Maxine Michalski
+      #
+      # A convenient function to return both width and height.
+      #
+      # @return [Array<Integer>]
+      def resolution
+        [@width, @height]
+      end
+
+      # @author Maxine Michalski
+      #
+      # A convenient function to return the aspect ratio of a given image.
+      #
+      # @return [Float]
+      def aspect_ratio
+        @width / @height.to_f
+      end
+
+      # @author Maxine Michalski
+      #
+      # Comparison method to comapre two Image objects (and sub class objects)
+      #
+      # @return [TrueClass, FalseClass]
+      def ==(other)
+        other.is_a?(Image) && @url == other.url && @size == other.size
+      end
+    end
+
+    # class for samples, that is just a copy of Image
+    #
+    # @api private
+    # @author Maxine Michalski
+    # @since 1.0,0
+    class Sample < Image; end
+
+    # class for previews, that is just a copy of Image
+    #
+    # @api private
+    # @author Maxine Michalski
+    # @since 1.0,0
+    class Preview < Image; end
+  end
+end

data/lib/rubyhexagon/post/tag_item.rb

@@ -0,0 +1,74 @@
+# 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
+    # @since 2.0.0
+    class TagItem
+      # @return [Integer] id of post information
+      attr_reader :id
+      # @return [Integer] id of post information
+      attr_reader :created_at
+      # @return [Integer] id of post information
+      attr_reader :post
+      # @return [Integer] id of post information
+      attr_reader :tags
+      # @return [Integer] id of post information
+      attr_reader :sources
+
+      # @author Maxine Michalski
+      #
+      # Initializer for tag change items
+      #
+      # @param tag_item [Hash] tag item data
+      #
+      # @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
+      #
+      # @return [TrueClass, FalseClass]
+      def ==(other)
+        other.is_a?(E621::Post::TagItem) && @id == other.id
+      end
+    end
+  end
+end

data/lib/rubyhexagon/search/posts.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.
 #
@@ -60,8 +60,8 @@ module Rubyhexagon
       # 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 }
+      def self.list(tags, limit = 320)
+        parameters = { tags: tags, limit: limit }
         posts = fetch_posts(parameters)
         while block_given? && posts != []
           posts.each { |post| yield post }

data/lib/rubyhexagon/tag.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.
 #
@@ -31,73 +31,46 @@ module Rubyhexagon
     # @return [Integer] number of posts that have this tag assigned to them
     attr_reader :count
 
-    # @return [Type] type of this tag
+    # @return [Tag::Type] type of this tag
     attr_reader :type
 
     # @author Maxine Michalski
     #
     # Initializer for Tag.
     #
-    # @raise InvalidIDError
+    # @raise InvalidIDError|ArgumentError
     #
-    # @param id [Integer] tag data, fetched from e621
+    # @param tag [Hash] tag data
     #
     # @return the object
-    def initialize(id)
-      unless id.is_a?(Integer) && id.positive?
-        raise InvalidIDError, "ID out of range: #{id}"
+    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
-      @id = id
-    end
-
-    # @author Maxine Michalski
-    #
-    # Bang method to fill tag data.
-    # @notice If the optional parameter is not given, this method makes an API
-    #   call.
-    #
-    # @param tag [Hash] optional parameter with API call information
-    #
-    # @return [NilClass]
-    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?)
-      nil
-    end
-
-    # @author Maxine Michalski
-    #
-    # Method to return a properly filled Tag object.
-    # @note This makes an additional API call if no argument is given
-    #
-    # @param tag [Hash] optional parameter, if information are ready
-    #
-    # @return [Tag] Tag filled with all information
-    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
     #
     # @param other [Object] object that should be compared
     #
     # @return [TrueClass, FalseClass] test result of comparison
     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
+      @id == other.id && @name == other.name && @type == other.type
     end
   end
 end

data/lib/rubyhexagon/tag/alias.rb

@@ -0,0 +1,87 @@
+# 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
+    # @since 2.0.0
+    class Alias
+      # @return [Integer] id of alias
+      attr_reader :id
+
+      # @return [String] name of alias
+      attr_reader :name
+
+      # @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
+      #
+      # @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.
+      #
+      # @return [TrueClass, FalseClass]
+      def ==(other)
+        other.is_a?(Alias) && @id == other.id
+      end
+
+      # @author Maxine Michalski
+      #
+      # Check if this alias is pending confirmation.
+      #
+      # @return [TrueClass] tag alias is pending
+      # @return [FalseClass] tag alias is not pending
+      def pending?
+        @pending
+      end
+    end
+  end
+end