rubyhexagon 2.0.1 → 3.0.0

data/lib/rubyhexagon/api/post/note.rb

@@ -1,77 +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 Post
-    # A class to interact with the e621 web interface.
-    #
-    # @author Maxine Michalski
-    # @api public
-    # @since 2.0.0
-    class Note
-      # @author Maxine Michalski
-      #
-      # Fetch a list of notes
-      #
-      # @example Get a list of notes
-      #   E621::Post::Note.list(id: 1) #=> Array<E621::Post::Note>
-      # @return [Array<E621::Note>]
-      # @see https://e621.net/help/show/api#notes
-      def self.list(post)
-        unless post.is_a?(Hash) || post.is_a?(E621::Post)
-          raise ArgumentError, 'A Hash or Post object is required'
-        end
-        post.store(:post_id, post.delete(:id)) if post.is_a?(Hash)
-        post = { post_id: post.id } if post.is_a?(E621::Post)
-        E621::API.fetch(:note, :index, post).map do |note|
-          new(note)
-        end
-      end
-
-      # @author Maxine Michalski
-      #
-      # Search for notes
-      #
-      # @example Get a list of notes
-      #   E621::Post::Note.search(query: 'moo') #=> Array<E621::Post::Note>
-      # @return [Array<E621::Note>]
-      # @see https://e621.net/help/show/api#notes
-      def self.search(query)
-        raise ArgumentError, 'A Hash is required' unless query.is_a?(Hash)
-        E621::API.fetch(:note, :search, query).map do |note|
-          new(note)
-        end
-      end
-
-      # @author Maxine Michalski
-      #
-      # Fetch a list of note versions
-      #
-      # @example Get a list of notes
-      #   E621::Post::Note.list(post_id: 1) #=> Array<E621::Post::Note>
-      # @return [Array<E621::Note>]
-      # @see https://e621.net/help/show/api#notes
-      def self.history(query)
-        raise ArgumentError, 'A Hash is required' unless query.is_a?(Hash)
-        E621::API.fetch(:note, :history, query).map do |note|
-          new(note)
-        end
-      end
-    end
-  end
-end

data/lib/rubyhexagon/api/tag.rb

@@ -1,71 +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
-  # A class to interact with the e621 web interface.
-  #
-  # @author Maxine Michalski
-  # @api public
-  # @since 1.4.0
-  class Tag
-    # @author Maxine Michalski
-    #
-    # Fetch tag data
-    #
-    # @param tag [Hash|E621::Tag] a hash or tag object
-    # @example Get tag information
-    #   E621::Tag.show(id: 1) #=> E621::Tag
-    # @return [E621::Tag]
-    # @see https://e621.net/help/show/api#tags
-    def self.show(tag)
-      unless (tag.is_a?(Hash) && tag[:id].is_a?(Integer)) ||
-             tag.is_a?(E621::Tag)
-        raise ArgumentError, 'A Hash or tag data object are required'
-      end
-      id = tag.is_a?(Hash) ? tag[:id] : tag.id
-      new(E621::API.fetch(:tag, :show, id: id))
-    end
-
-    # @author Maxine Michalski
-    #
-    # Fetch a list of tags
-    #
-    # @param query [Hash] query data
-    # @example Get list of tags
-    #   E621::Tag.list(name: 'feline') #=> Array<E621::Tag>
-    # @return [Array<E621::Tag>]
-    # @see https://e621.net/help/show/api#tags
-    def self.list(query)
-      raise ArgumentError, 'A Hash is required' unless query.is_a?(Hash)
-      E621::API.fetch(:tag, :index, query).map do |tag|
-        new(tag)
-      end
-    end
-
-    # @author Maxine Michalski
-    #
-    # Return a filled Tag object from a tag
-    # @example Gwt tag information
-    #   tag.show #=> E621::Tag
-    # @return [E621::Tag]
-    def show
-      E621::Tag.new(E621::API.fetch(:tag, :show,
-                                    @id.nil? ? { name: @name } : { id: @id }))
-    end
-  end
-end

data/lib/rubyhexagon/api/tag/alias.rb

@@ -1,46 +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
-    # A class to interact with the e621 web interface.
-    #
-    # @author Maxine Michalski
-    # @api public
-    # @since 2.0.0
-    class Alias
-      # @author Maxine Michalski
-      #
-      # Fetch tag aliases
-      #
-      # @param query [Hash] Parameter for query
-      #
-      # @example Get a list of posts
-      #   E621::Tag::Alias.list(implied_to: 'feline',
-      #   page: 1) #=> Array<E621::Tag::Alias>
-      # @return [Array[E621::Tag::Alias]
-      # @see https://e621.net/help/show/api#aliases
-      def self.list(query)
-        raise ArgumentError, 'A Hash is required' unless query.is_a?(Hash)
-        E621::API.fetch(:tag_alias, :index, query).map do |tag|
-          new(tag)
-        end
-      end
-    end
-  end
-end

data/lib/rubyhexagon/api/tag/implication.rb

@@ -1,46 +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
-    # A class to interact with the e621 web interface.
-    #
-    # @author Maxine Michalski
-    # @api public
-    # @since 2.0.0
-    class Implication
-      # @author Maxine Michalski
-      #
-      # Fetch tag implications
-      #
-      # @param query [Hash] Parameter for query
-      #
-      # @example Get a list of posts
-      #   E621::Tag::Implication.list(implied_to: 'feline',
-      #   page: 1) #=> Array<E621::Tag::Implication>
-      # @return [Array[E621::Tag::Implication]
-      # @see https://e621.net/help/show/api#implications
-      def self.list(query)
-        raise ArgumentError, 'A Hash is required' unless query.is_a?(Hash)
-        E621::API.fetch(:tag_implication, :index, query).map do |tag|
-          new(tag)
-        end
-      end
-    end
-  end
-end

data/lib/rubyhexagon/api/user.rb

@@ -1,67 +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
-  # A class to interact with the e621 web interface.
-  #
-  # @author Maxine Michalski
-  # @api public
-  # @since 1.4.0
-  class User
-    # @author Maxine Michalski
-    #
-    # Fetch data for user
-    #
-    # @param user [Hash|E621::User] User data to fetch from
-    # @example Get user information
-    #   E621::User.show(id: 1) #=> E621::User
-    # @return [E621::User]
-    def self.show(user)
-      unless (user.is_a?(Hash) && user[:id].is_a?(Integer)) ||
-             user.is_a?(E621::User)
-        raise ArgumentError, 'A Hash or user object are required'
-      end
-      user = user.is_a?(Hash) ? user : { id: user.id }
-      new(E621::API.fetch(:user, :show, user))
-    end
-
-    # @author Maxine Michalski
-    #
-    # Fetch a list of users
-    #
-    # @example Get list of users
-    #   E621::User.list(name: 'purple') #=> Array<E621::User>
-    # @return [E621::User]
-    def self.list(query)
-      raise ArgumentError, 'A Hash is required' unless query.is_a?(Hash)
-      E621::API.fetch(:user, :index, query).map do |user|
-        new(user)
-      end
-    end
-
-    # @author Maxine Michalski
-    #
-    # User information
-    # @example Get User Information
-    #   user.show #=> E621::User
-    # @return [E621::User]
-    def show
-      E621::User.new(E621::API.fetch(:user, :show, id: @id))
-    end
-  end
-end

data/lib/rubyhexagon/artist.rb

@@ -1,166 +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 information about an artist on e621
-  #
-  # @author Maxine Michalski
-  # @api public
-  # @since 1.0.0
-  class Artist
-    # Artist ID
-    # @example Get artist ID
-    #   artist.id #=> Integer
-    # @return [Integer] id of artist
-    attr_reader :id
-
-    # Artist name
-    # @example Get artist name
-    #   artist.name #=> String
-    # @return [String] name of artist
-    attr_reader :name
-
-    # Alternative names for artist
-    # @example Get alternative names for artist
-    #   artist.other_names #=> [] or Array<String>
-    # @return [Array<String>] alternative names for artist
-    attr_reader :other_names
-
-    # Group name for artist
-    # @example Get group name for artist
-    #   artist.group_name #=> String
-    # @return [String] group name for artist
-    attr_reader :group_name
-
-    # URLs to find artist
-    # @example Get parsed URIs for artist
-    #   artist.urls #=> Array<URI> or []
-    # @return [Array<URI>] links to find artist
-    attr_reader :urls
-
-    # Version of artist information
-    # @example Get version of this artist's information
-    #   artist.version #=> Integer
-    # @return [Integer] version of artist information
-    attr_reader :version
-
-    # Updating user for this artist
-    # @example Get the user, who last updated this artist
-    #   artist.updater #=> E621::User
-    # @return [E621::User] updating user
-    attr_reader :updater
-
-    # @author Maxine Michalski
-    #
-    # Initializer for Artist
-    #
-    # @param artist [Hash] artist data
-    # @example Get an artist instance
-    #   E621::Artist.new(id: 1) #=> E621::Artist instance
-    #   E621::Artist.new(name: 'artist') #=> E621::Artist instance
-    # @return the object
-    def initialize(artist)
-      unless artist.is_a?(Hash)
-        raise ArgumentError, "#{artist.class} is not a Hash"
-      end
-      if artist[:id].nil? && artist[:name].nil?
-        raise ArgumentError, 'At least :id or :name must be given!'
-      end
-      artist.each do |k, v|
-        if %i[id name group_name version is_active].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 %i[other_names urls updater_id].include?(k)
-          __send__("setup_#{k}".to_sym, v)
-        end
-      end
-    end
-
-    # @author Maxine Michalski
-    #
-    # Comparison method for artists
-    # @example Compare two tags, that are unequal
-    #   Tag.new(id: 1) == Tag.new(id: 2) #=> false
-    # @return [TrueClass, FalseClass]
-    def ==(other)
-      return false unless other.is_a?(Artist)
-      @id == other.id && @name == other.name && @version == other.version
-    end
-
-    # @author Maxine Michalski
-    #
-    # Check if this artist is active
-    # @example Is artist active?
-    #   artist.active? #=> true or false
-    # @return [TrueClass|FalseClass] depending on active status
-    def active?
-      @is_active
-    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
-
-    private
-
-    # @author Maxine Michalski
-    #
-    # Setup other names for artist
-    #
-    # @param names [String] comma separated list of names
-    # @api private
-    # @return [Array<String>]
-    def setup_other_names(names)
-      @other_names = names.split(',')
-    end
-
-    # @author Maxine Michalski
-    #
-    # Parsed URI to find artist
-    #
-    # @param urls [Array<String>] urls to parse
-    # @api private
-    # @return [Array<URI>]
-    def setup_urls(urls)
-      @urls = urls.map { |u| URI.parse(u) }
-    end
-
-    # @author Maxine Michalski
-    #
-    # Setup updating user
-    # @param updater [Integer] ID of the user who last updated
-    # @api private
-    # @return [E621::User]
-    def setup_updater_id(updater)
-      @updater = E621::User.new(id: updater)
-    end
-  end
-end