rubyhexagon 2.0.1 → 3.0.0

data/lib/rubyhexagon/tag/type.rb

@@ -1,94 +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 type information.
-    #
-    # @api private
-    # @author Maxine Michalski
-    # @since 1.0.0
-    class Type
-      # Type ID
-      # @return [Integer] id of type
-      attr_reader :id
-
-      # Type name
-      # @return [String] name of type
-      attr_reader :name
-
-      # @author Maxine Michalski
-      #
-      # Initializer for Type
-      #
-      # @param type [Hash] type data, fetched from e621
-      # @option type [Integer] :id Type ID (can be one of 0, 1, 3, 4 or 5
-      # @option locked [TrueClass|FalseClass] :locked status
-      #
-      # @return the object
-      def initialize(type)
-        unless type.is_a?(Hash)
-          raise ArgumentError, "#{type.class} is not a Hash"
-        end
-        raise ArgumentError, 'Missing :locked key' if type[:locked].nil?
-        unless [0, 1, 3, 4, 5].include?(type[:id])
-          raise InvalidIDError, "Unkown type id: #{type[:id].inspect}"
-        end
-        @id     = type[:id]
-        @name   = [:general, :artist, nil, :copyright, :character,
-                   :species][@id]
-        @locked = type[:locked] ? true : false
-      end
-
-      # @author Maxine Michalski
-      #
-      # Comparison method for Types, to give a more meaningful comparison
-      #
-      # @return [TrueClass, FalseClass]
-      def ==(other)
-        other.is_a?(Type) && @id == other.id && @name == other.name &&
-          @locked == other.locked?
-      end
-
-      # @author Maxine Michalski
-      #
-      # Check if this type is locked for the tag who has it assigned
-      #
-      # @return [TrueClass] tag type is locked
-      # @return [FalseClass] tag type is not locked
-      def locked?
-        @locked
-      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

data/lib/rubyhexagon/user.rb

@@ -1,117 +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/>.
-
-require 'time'
-
-module Rubyhexagon
-  # Class to hold user information for users on e621.
-  #
-  # @author Maxine Michalski
-  # @api public
-  # @since 1.0.0
-  class User
-    # User ID
-    # @example Get ID from user
-    #   user.id #=> Integer
-    # @return [Integer] id of user
-    attr_reader :id
-
-    # User name
-    # @example Get name from user
-    #   user.name #=> String
-    # @return [String] name of user
-    attr_reader :name
-
-    # User access level
-    # @example Get user access level
-    #   user.level #=> E621::User::Level
-    # @return [E621::User::Level] level of access, this user holds
-    attr_reader :level
-
-    # Time user was created
-    # @example Get user creation time
-    #   user.created_at #=> Time
-    # @return [Time] registration time of this user
-    attr_reader :created_at
-
-    # Avatar post that user chosen
-    # @example Get user avatar post
-    #   user.avatar #=> E621::Post
-    # @return [E621::Post] avatar set by user
-    attr_reader :avatar
-
-    # Artists tags, that belong to user
-    # @example Get artist tags
-    #   user.artist_tags #=> Array<E621::Tag>
-    # @return [Array<E621::Tag>] an array of artist tags, associated with user
-    attr_reader :artist_tags
-
-    # @author Maxine Michalski
-    #
-    # Initializer for User
-    #
-    # @example Get a new user instance
-    #   User.new(:id) #=> E621::User instance
-    # @param user [Hash] user data, fetched from e621
-    #
-    # @return the object
-    def initialize(user)
-      raise ArgumentError, "#{user.class} is not a Hash" unless user.is_a?(Hash)
-      raise ArgumentError, 'Hash must include :id' if user[:id].nil?
-      user.each do |k, v|
-        if %i[id name].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[created_at].include?(k)
-          instance_variable_set("@#{k}".to_sym, Time.parse(v))
-        elsif k == :artist_tags
-          @artist_tags = v.map { |t| E621::Tag.new(name: t) }
-        elsif k == :avatar_id
-          @avatar = E621::Post.new(id: v)
-        end
-      end
-    end
-
-    # @author Maxine Michalski
-    #
-    # Turn object into a hash representation of itself
-    #
-    # @example Turn a User into a Hash
-    #   User.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 method for User objects
-    # @example Check two different users
-    #   User.new(id: 1) == User.new(id: 2) #=> false
-    # @return [TrueClass, FalseClass]
-    def ==(other)
-      other.is_a?(User) && @id == other.id
-    end
-  end
-end

data/lib/rubyhexagon/user/level.rb

@@ -1,102 +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 User
-    # Class to hold level information.
-    #
-    # @api private
-    # @author Maxine Michalski
-    # @since 1.0.0
-    class Level
-      # User level ID
-      # @return [Integer] id of level
-      attr_reader :id
-
-      # User level name
-      # @return [String] name of level
-      attr_reader :name
-
-      # @author Maxine Michalski
-      #
-      # Initializer for Level a user can have
-      #
-      # @param level [Hash] level a user can have.
-      #
-      # @return the object
-      def initialize(level)
-        raise ArgumentError, 'No has given.' unless level.is_a?(Hash)
-        raise ArgumentError, 'Hash requires an :id key' if level[:id].nil?
-        unless [0, 10, 20, 30, 32, 33, 34, 40, 50].include?(level[:id])
-          raise InvalidIDError, "Unknown level ID: #{level[:id]}"
-        end
-        @id = level[:id]
-        @name = if @id.between?(31, 39)
-                  [nil, nil, :contributor, :former_staff, :janitor][@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
-
-      # @author Maxine Michalski
-      #
-      # Turn object into a hash representation of itself
-      #
-      # @return [Hash]
-      def to_hash
-        { id: @id, name: @name }
-      end
-
-      # @author Maxine Michalski
-      #
-      # Test function for level names
-      #
-      # @return [TrueClass|FalseClass]
-      def test
-        __callee__.to_s.sub(/\?/, '').to_sym == @name
-      end
-      # @see test
-      alias unactivated? test
-      # @see test
-      alias blocked? test
-      # @see test
-      alias member? test
-      # @see test
-      alias privileged? test
-      # @see test
-      alias contributor? test
-      # @see test
-      alias former_staff? test
-      # @see test
-      alias janitor? test
-      # @see test
-      alias mod? test
-      # @see test
-      alias admin? test
-    end
-  end
-end