rubyhexagon 1.6.4 → 2.0.0

data/lib/rubyhexagon/image.rb

@@ -1,122 +0,0 @@
-# frozen_string_literal: true
-
-# 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 Rubyhexagon
-  # 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 [String] MD5 hash sum
-    attr_reader :md5
-
-    # @return [Integer] file size in bytes
-    attr_reader :size
-
-    # @author Maxine Michalski
-    #
-    # Initializer for a File. This is not a Ruby file class, but an abstraction
-    # of e621 file information.
-    #
-    # @param file [Hash] file information
-    #
-    # @return the object
-    def initialize(file)
-      @url = URI.parse(file[:url])
-      @md5 = File.basename(file[:url]).sub(/\.\w{3,4}$/, '')
-      @ext = file[:ext]
-      @width = file[:width].to_i
-      @height = file[:height].to_i
-      @size = file[:size].to_i
-      @user_agent = { 'User-Agent' =>
-                     "#{Rubyhexagon::NAME}/#{Rubyhexagon::VERSION} "\
-                      '(by maxine_red on e621' }
-    end
-
-    # @author Maxine Michalski
-    #
-    # Comparison method to comapre two Image objects (and sub class objects)
-    #
-    # @return [TrueClass, FalseClass]
-    def ==(other)
-      other.is_a?(Image) && @md5 == other.md5
-    end
-
-    # @author Maxine Michalski
-    #
-    # Retrieve data from e621 and save it to file.
-    #
-    # @param dirname [String] path where to save. This needs be an existing
-    #   directory. This overwrites existing files.
-    # @param filename [String] name of file, without extension
-    #
-    # @raise [ArgumentError] Argument given is not an existing directory
-    def save!(dirname = './', filename = nil)
-      raise ArgumentError, 'Not a directory!' unless File.directory?(dirname)
-      filename ||= @md5
-      loop do
-        stream = @url.open(@user_agent).read
-        File.open("#{dirname}/#{filename}.#{@ext}", 'w') do |f|
-          f.print stream
-        end
-        break if Digest::MD5.hexdigest(stream) == @md5
-      end
-    end
-  end
-  class Sample < Image; end
-
-  # Class for post file data. This is mostly an abstraction to have data
-  # structures in a more Ruby like nature.
-  # This class just holds an adapted version of #save!, to handle the case of
-  # preview images having a different MD5 hash sum attribute than they actually
-  # should have.
-  # That is an e621 issue though.
-  #
-  # @api private
-  # @author Maxine Michalski
-  # @since 1.0.0
-  class Preview < Image
-    # @author Maxine Michalski
-    #
-    # Retrieve data from e621 and save it to file.
-    #
-    # @param dirname [String] path where to save. This needs be an existing
-    #   directory. This overwrites existing files.
-    # @raise [ArgumentError] Argument given is not an existing directory
-    def save!(dirname = './')
-      raise ArgumentError, 'Not a directory!' unless File.directory?(dirname)
-      File.open("#{dirname}/#{File.basename(@url.path)}", 'w') do |f|
-        f.print @url.open(@user_agent).read
-      end
-    end
-  end
-end

data/lib/rubyhexagon/level.rb

@@ -1,58 +0,0 @@
-# frozen_string_literal: true
-
-# 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 Rubyhexagon
-  # Class to hold level information.
-  #
-  # @api private
-  # @author Maxine Michalski
-  # @since 1.0.0
-  class Level
-    # @return [Integer] id of level
-    attr_reader :id
-
-    # @return [String] name of level
-    attr_reader :name
-
-    # @author Maxine Michalski
-    #
-    # Initializer for Level a user can have. This is just to have a more Ruby
-    # like interface to it.
-    #
-    # @param level [Hash] level a user can have.
-    #
-    # @return the object
-    def initialize(level)
-      @id = level
-      @name = if @id.between?(31, 39)
-                [nil, nil, :contributor, :'former staff', :janotor][@id - 30]
-              else
-                %i[unactivated blocked member privileged mod admin][@id / 10]
-              end
-    end
-
-    # @author Maxine Michalski
-    #
-    # Comparison method for Level objects
-    #
-    # @return [TrueClass, FalseClass]
-    def ==(other)
-      other.is_a?(Level) && @id == other.id && @name == other.name
-    end
-  end
-end

data/lib/rubyhexagon/search/flag_history.rb

@@ -1,62 +0,0 @@
-# frozen_string_literal: true
-
-# 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 Rubyhexagon
-  # Module to hold search classes
-  #
-  # @author Maxine Michalski
-  # @since 1.0.0
-  module Search
-    # Class to hold methods for fetching a list of flagged posts.
-    #
-    # @author Maxine Michalski
-    # @since 1.4.0
-    class FlagHistory
-      # @author Maxine Michalski
-      #
-      # Retrieve a list of flagged posts, with flag 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<DeletedPost>] an array of deleted posts
-      def self.list(page = 1)
-        d = fetch_list(page)
-        while block_given? && d != []
-          d.each { |del| yield del }
-          page += 1
-          d = fetch_list(page)
-        end
-        d
-      end
-
-      # @author Maxine Michalski
-      #
-      # Helper function for flagged posts
-      #
-      # @return [Array<DeletedPost>] array of deleted posts
-      def self.fetch_list(page)
-        API.new.fetch('post_flag_history', 'index', page: page).map do |post|
-          DeletedPost.new(post[:id], post[:reason])
-        end
-      end
-      private_class_method :fetch_list
-    end
-  end
-end

data/lib/rubyhexagon/search/pools.rb

@@ -1,62 +0,0 @@
-# frozen_string_literal: true
-
-# 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 Rubyhexagon
-  # Module to hold search classes
-  #
-  # @author Maxine Michalski
-  # @since 1.0.0
-  module Search
-    # Class to hold methods for Pool searches.
-    #
-    # @author Maxine Michalski
-    # @since 1.4.0
-    class Pools
-      # @author Maxine Michalski
-      #
-      # Retrieve a list of pools.
-      # This method accepts blocks and only returns one page without blocks
-      #
-      # @param page [Integer] page of deleted pools to return
-      #
-      # @return [Array<Pool>] an array of deleted pools
-      def self.list(query, page = 1)
-        parameters = { query: query, page: page }
-        pools = fetch_pools(parameters)
-        while block_given? && pools != []
-          pools.each { |pool| yield pool }
-          parameters[:page] += 1
-          pools = fetch_pools(parameters)
-        end
-        pools
-      end
-
-      # @author Maxine Michalski
-      #
-      # Helper function for pools
-      #
-      # @return [Array<Pool>] array of pools
-      def self.fetch_pools(parameters)
-        API.new.fetch('pool', 'index', parameters).map do |data|
-          Pool.new(data[:id]).show(data)
-        end
-      end
-      private_class_method :fetch_pools
-    end
-  end
-end

data/lib/rubyhexagon/search/tag_history.rb

@@ -1,61 +0,0 @@
-# frozen_string_literal: true
-
-# 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 Rubyhexagon
-  # Module to hold search classes
-  #
-  # @author Maxine Michalski
-  # @since 1.0.0
-  module Search
-    # Class to hold methods for fetching tag changes.
-    #
-    # @author Maxine Michalski
-    # @since 1.4.0
-    class TagHistory
-      # @author Maxine Michalski
-      #
-      # Retrieve a list of posts with changed tags
-      # 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.list(page = 1)
-        d = fetch_list(page)
-        while block_given? && d != []
-          d.each { |del| yield del }
-          page += 1
-          d = fetch_list(page)
-        end
-        d
-      end
-
-      # @author Maxine Michalski
-      #
-      # Helper function for flagged posts
-      #
-      # @return [Array<DeletedPost>] array of deleted posts
-      def self.fetch_list(page)
-        API.new.fetch('post_tag_history', 'index', page: page).map do |post|
-          TagChange.new(post)
-        end
-      end
-      private_class_method :fetch_list
-    end
-  end
-end

data/lib/rubyhexagon/search/tags.rb

@@ -1,139 +0,0 @@
-# frozen_string_literal: true
-
-# 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 Rubyhexagon
-  # 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 page [Integer] page to retieve
-      #
-      # @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 }
-          params[:page] += 1
-          t = fetch_tags(params)
-        end
-        t
-      end
-
-      # @author Maxine Michalski
-      #
-      # Retrieve information about implicated tags.
-      # @param name [String] name pattern to search tags with
-      # @param page [Integer] page to retrieve
-      #
-      # @raise ObjectNotFilledError if no name is present
-      #
-      # @return [Array<Tag>] array of implicated tags for this tag
-      def self.implications(name, page = 1)
-        params = { implied_to: name, page: page }
-        tags = fetch_implications(params)
-        while block_given? && tags != []
-          tags.each { |tag| yield tag unless tag.nil? }
-          tags = fetch_implications(params)
-          params[:page] += 1
-        end
-        tags.compact
-      end
-
-      # @author Maxine Michalski
-      #
-      # Retrieve information about aliased tags.
-      # @param name [String] name pattern to search tags with
-      # @param page [Integer] page to retrieve
-      #
-      # @raise ObjectNotFilledError if no name is present
-      #
-      # @return [Array<Tag>] array of implicated tags for this tag
-      def self.aliases(name, page = 1)
-        params = { aliased_to: name, approved: true, page: page }
-        tags = fetch_aliases(params)
-        while block_given? && tags != []
-          tags.each { |tag| yield tag unless tag.nil? }
-          tags = fetch_aliases(params)
-          params[:page] += 1
-        end
-        tags.compact
-      end
-
-      # @author Maxine Michalski
-      #
-      # Helper function to get Tag data
-      #
-      # @return [Array<Tag>] array of tags
-      def self.fetch_tags(params)
-        API.new.fetch('tag', 'index', params).map do |data|
-          Tag.new(data[:id]).show(data)
-        end
-      end
-      private_class_method :fetch_tags
-
-      # @author Maxine Michalski
-      #
-      # Helper function to fetch implicated tags
-      #
-      # @param params [Hash] parameter for API call
-      #
-      # @return [Array<Tag>] array of implicated tags
-      def self.fetch_implications(params)
-        tag_params = { name: params[:implied_to], order: :date, limit: 1,
-                       page: 1 }
-        implied_tag = fetch_tags(tag_params).first
-        API.new.fetch('tag_implication', 'index', params).map do |tag|
-          if tag[:consequent_id] == implied_tag.id && !tag[:pending]
-            Tag.new(tag[:predicate_id])
-          end
-        end
-      end
-      private_class_method :fetch_implications
-
-      # @author Maxine Michalski
-      #
-      # Helper function to fetch aliased tags
-      #
-      # @param params [Hash] parameter for API call
-      #
-      # @return [Array<Tag>] array of implicated tags
-      def self.fetch_aliases(params)
-        API.new.fetch('tag_alias', 'index', params).map do |tag|
-          Tag.new(tag[:alias_id])
-        end
-      end
-      private_class_method :fetch_aliases
-    end
-  end
-end