rubyhexagon 2.0.0 → 2.0.1

data/lib/rubyhexagon/tag/alias.rb

@@ -21,20 +21,30 @@ module Rubyhexagon
     # 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.
+      # Initializer for Alias
       #
       # @raise InvalidIDError if alias ID is not valid
       # @raise ArgumentError hash not valid
@@ -44,7 +54,9 @@ module Rubyhexagon
       # @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)
@@ -66,8 +78,9 @@ module Rubyhexagon
 
       # @author Maxine Michalski
       #
-      # Comparison method for Types, to give a more meaningful comparison.
-      #
+      # 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
@@ -75,13 +88,29 @@ module Rubyhexagon
 
       # @author Maxine Michalski
       #
-      # Check if this alias is pending confirmation.
-      #
+      # 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

@@ -21,20 +21,30 @@ module Rubyhexagon
     # 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.
+      # Initializer for Implication
       #
       # @raise InvalidIDError if implication ID is not valid
       # @raise ArgumentError hash not valid
@@ -44,7 +54,9 @@ module Rubyhexagon
       # @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)
@@ -70,8 +82,9 @@ module Rubyhexagon
 
       # @author Maxine Michalski
       #
-      # Comparison method for Types, to give a more meaningful comparison.
-      #
+      # 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
@@ -79,13 +92,30 @@ module Rubyhexagon
 
       # @author Maxine Michalski
       #
-      # Check if this implication is pending confirmation.
+      # 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

data/lib/rubyhexagon/tag/type.rb

@@ -24,17 +24,17 @@ module Rubyhexagon
     # @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.
-      #
-      # @raise ArgumentError if type ID is not valid
+      # 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
@@ -57,7 +57,7 @@ module Rubyhexagon
 
       # @author Maxine Michalski
       #
-      # Comparison method for Types, to give a more meaningful comparison.
+      # Comparison method for Types, to give a more meaningful comparison
       #
       # @return [TrueClass, FalseClass]
       def ==(other)
@@ -67,13 +67,28 @@ module Rubyhexagon
 
       # @author Maxine Michalski
       #
-      # Check if this type is locked for the tag who has it assigned.
+      # 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

@@ -22,30 +22,51 @@ 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
 
-    # @return [Level] level of access, this user holds
+    # 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.
+    # 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
@@ -70,8 +91,24 @@ module Rubyhexagon
 
     # @author Maxine Michalski
     #
-    # Comparison method for User objects
+    # 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

data/lib/rubyhexagon/user/level.rb

@@ -24,16 +24,17 @@ module Rubyhexagon
     # @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. This is just to have a more Ruby
-      # like interface to it.
+      # Initializer for Level a user can have
       #
       # @param level [Hash] level a user can have.
       #
@@ -63,7 +64,16 @@ module Rubyhexagon
 
       # @author Maxine Michalski
       #
-      # Test function for level names.
+      # 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubyhexagon
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Maxine Michalski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-11 00:00:00.000000000 Z
+date: 2020-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -33,10 +33,10 @@ files:
 - lib/rubyhexagon.rb
 - lib/rubyhexagon/api.rb
 - lib/rubyhexagon/api/artist.rb
-- lib/rubyhexagon/api/note.rb
 - lib/rubyhexagon/api/pool.rb
 - lib/rubyhexagon/api/post.rb
 - lib/rubyhexagon/api/post/flag.rb
+- lib/rubyhexagon/api/post/note.rb
 - lib/rubyhexagon/api/post/tag_item.rb
 - lib/rubyhexagon/api/tag.rb
 - lib/rubyhexagon/api/tag/alias.rb
@@ -44,11 +44,11 @@ files:
 - lib/rubyhexagon/api/user.rb
 - lib/rubyhexagon/artist.rb
 - lib/rubyhexagon/error.rb
-- lib/rubyhexagon/note.rb
 - lib/rubyhexagon/pool.rb
 - lib/rubyhexagon/post.rb
 - lib/rubyhexagon/post/flag.rb
 - lib/rubyhexagon/post/image.rb
+- lib/rubyhexagon/post/note.rb
 - lib/rubyhexagon/post/tag_item.rb
 - lib/rubyhexagon/search/posts.rb
 - lib/rubyhexagon/tag.rb

data/lib/rubyhexagon/api/note.rb

@@ -1,50 +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
-  # @since 2.0.0
-  class Note
-    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
-
-    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
-
-    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

data/lib/rubyhexagon/note.rb

@@ -1,112 +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
-  # This class holds note information. Notes are additional information on
-  # posts.
-  #
-  # @author Maxine Michalski
-  # @since 2.0.0
-  class Note
-    # @return [Integer] id for this note
-    attr_reader :id
-
-    # @return [Time] time of creation
-    attr_reader :created_at
-
-    # @return [Time] time of last update
-    attr_reader :updated_at
-
-    # @return [E621::User] user object of creator
-    attr_reader :creator
-
-    # @return [Integer] position x value
-    attr_reader :x
-
-    # @return [Integer] position y value
-    attr_reader :y
-
-    # @return [Array<Integer>] combined position (x, y)
-    attr_reader :point
-
-    # @return [Integer] width of object
-    attr_reader :width
-
-    # @return [Integer] height of object
-    attr_reader :height
-
-    # @return [Array<Integer>] combined rectangular (x, y, width, height)
-    attr_reader :rect
-
-    # @return [E621::Post] post this note belongs to
-    attr_reader :post
-
-    # @return [String] text content of note
-    attr_reader :body
-
-    # @return [Integer] version of this note
-    attr_reader :version
-
-    # @author Maxine Michalski
-    #
-    # Initializer for Note.
-    #
-    # @param note [Hash] note information in hash form
-    #
-    # @return the object
-    def initialize(note)
-      raise ArgumentError, "#{note.class} is not a Hash" unless note.is_a?(Hash)
-      raise ArgumentError, 'An id is required' if note[:id].nil?
-      note.each do |k, v|
-        if %i[id x y width height is_active version body].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 %i[created_at updated_at].include?(k)
-          instance_variable_set("@#{k}".to_sym, Time.at(v[:s]))
-        elsif k == :post_id
-          @post = E621::Post.new(id: v)
-        elsif k == :creator_id
-          @creator = E621::User.new(id: v)
-        end
-      end
-      @point = [@x, @y]
-      @rect = [@x, @y, @width, @height]
-    end
-
-    # @author Maxine Michalski
-    #
-    # Determine if note is active or not.
-    #
-    # @return [TrueClass|FalseClass] active state of note
-    def active?
-      return false if @is_active.nil?
-      @is_active
-    end
-
-    # @author Maxine Michalski
-    #
-    # Comparison method for Notes, to give a more meaningful comparison.
-    #
-    # @return [TrueClass, FalseClass]
-    def ==(other)
-      other.is_a?(Note) && @id == other.id && @version == other.version
-    end
-  end
-end