rubyhexagon 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dd11e83da3191060c9511173288f9af58a6750c9
-  data.tar.gz: eaa6a515b4ad4d00d1dff2a0766c735b7873cfa6
+  metadata.gz: db0b8e40637feb6bbf0f6a51172e882da9f50302
+  data.tar.gz: 9313eabbf199ad7131adae13d2c07d7fa898bf1d
 SHA512:
-  metadata.gz: 4aedb99ec447252a7b9abf1e327d339b55ba0472f15606f0bdee32fa968bf092e9deca3025a64413b1179ec089bb9567ffa72fb26632dd171dcecc20f15651a4
-  data.tar.gz: f1923e822369f550161992477889872e8659a25c1f8817d5c373b89e68b16b20fe98a3df3acdb2026fcc9151e391dbb61471289d1f8411f3f928c29681e568c3
+  metadata.gz: 89e0c912d9b3acd09811fb3924af6716c8341effa924853457b44d4354316b05f7358fb337c8d4a1445be40e810d6a17bfbddb6935e8c4064f8755b372a1b60d
+  data.tar.gz: a383b82a2671b960b96f326667d6bfe552017ad83a6c69cb4807521fcd39283b8a0239f090e6e8e920c055d1e1f599b4cdbf9251d15f5d766e983e7b2e0c749f

data/lib/rubyhexagon.rb

@@ -26,9 +26,9 @@ require 'tempfile'
 require_relative 'rubyhexagon/error'
 
 require_relative 'rubyhexagon/artist'
-require_relative 'rubyhexagon/note'
 require_relative 'rubyhexagon/post'
 require_relative 'rubyhexagon/post/flag'
+require_relative 'rubyhexagon/post/note'
 require_relative 'rubyhexagon/post/tag_item'
 require_relative 'rubyhexagon/pool'
 require_relative 'rubyhexagon/post/image'
@@ -48,7 +48,7 @@ module Rubyhexagon
   # Minor version part
   MINOR = 0
   # Patch version part
-  PATCH = 0
+  PATCH = 1
   # Name of gem
   NAME = 'rubyhexagon'
   # Full version string
@@ -62,9 +62,9 @@ E621 = Rubyhexagon
 
 require_relative 'rubyhexagon/api'
 require_relative 'rubyhexagon/api/artist'
-require_relative 'rubyhexagon/api/note'
 require_relative 'rubyhexagon/api/post'
 require_relative 'rubyhexagon/api/post/flag'
+require_relative 'rubyhexagon/api/post/note'
 require_relative 'rubyhexagon/api/post/tag_item'
 require_relative 'rubyhexagon/api/pool'
 require_relative 'rubyhexagon/api/tag'

data/lib/rubyhexagon/api.rb

@@ -73,7 +73,7 @@ module Rubyhexagon
 
     # @author Maxine Michalski
     #
-    # A method to make locking easier and that ensures 1 request per scondd.
+    # A method to make locking easier and that ensures 1 request per scondd
     #
     # @return [Object]
     def self.lock

data/lib/rubyhexagon/api/artist.rb

@@ -20,8 +20,18 @@ module Rubyhexagon
   # A class to interact with the e621 web interface.
   #
   # @author Maxine Michalski
+  # @api public
   # @since 2.0.0
   class Artist
+    # @author Maxine Michalski
+    #
+    # Fetch a list of artists
+    #
+    # @param query [Hsah] Query for fetching artist data
+    # @example Get list of artists
+    #   E621::Artist.list(name: 'artist') #=> Array<E621::Artist>
+    # @return [Array<E621::Artist>]
+    # @see https://e621.net/help/show/api#artists
     def self.list(query)
       raise ArgumentError, 'A Hash is required' unless query.is_a?(Hash)
       E621::API.fetch(:artist, :index, query).map do |artist|

data/lib/rubyhexagon/api/pool.rb

@@ -20,8 +20,19 @@ module Rubyhexagon
   # A class to interact with the e621 web interface.
   #
   # @author Maxine Michalski
+  # @api public
   # @since 1.4.0
   class Pool
+    # @author Maxine Michalski
+    #
+    # Fetch pool information
+    #
+    # @param pool [E621::Pool|Hash] A pool or hash to fetch data for
+    # @param page [Hash]
+    # @example Get pool information
+    #  E621::Pool.show(id: 1, page: 1) #=> E621::Pool
+    # @return [E621::Pool]
+    # @see https://e621.net/help/show/api#pools
     def self.show(pool, page = nil)
       unless (pool.is_a?(Hash) && pool[:id].is_a?(Integer)) ||
              pool.is_a?(E621::Pool)
@@ -34,6 +45,15 @@ module Rubyhexagon
       end
     end
 
+    # @author Maxine Michalski
+    #
+    # Fetch a list of pools
+    #
+    # @param query [Hsah] Query for fetching pool data
+    # @example Get list of pools
+    #   E621::Pool.list(name: 'moo', page: 1) #=> Array<E621::Pool>
+    # @return [Array<E621::Pool>]
+    # @see https://e621.net/help/show/api#pools
     def self.list(query)
       raise ArgumentError, 'A Hash is required' unless query.is_a?(Hash)
       E621::API.fetch(:pool, :index, query).map do |pool|
@@ -41,6 +61,15 @@ module Rubyhexagon
       end
     end
 
+    # @author Maxine Michalski
+    #
+    # Fetch pool information
+    #
+    # @param page [Hash]
+    # @example Get pool information
+    #  poolshow(page: 1) #=> E621::Pool
+    # @return [E621::Pool]
+    # @see https://e621.net/help/show/api#pools
     def show(page)
       page = page[:page]
       E621::API.fetch(:pool, :show, id: @id, page: page)[:posts].map do |post|

data/lib/rubyhexagon/api/post.rb

@@ -20,15 +20,18 @@ module Rubyhexagon
   # A class to interact with the e621 web interface.
   #
   # @author Maxine Michalski
+  # @api public
   # @since 1.4.0
   class Post
     # @author Maxine Michalski
     #
     # Fetch data for post
     #
-    # @param user [Hash|E621::Post] User data to fetch from
-    #
+    # @param post [Hash|E621::Post] User data to fetch from
+    # @example Get Post information
+    #   E621::Post.show(id: 1) #=> E621::Post
     # @return [E621::Post]
+    # @see https://e621.net/help/show/api#posts
     def self.show(post)
       unless (post.is_a?(Hash) && post[:id].is_a?(Integer)) ||
              post.is_a?(E621::Post)
@@ -38,6 +41,16 @@ module Rubyhexagon
       new(E621::API.fetch(:post, :show, id: id))
     end
 
+    # @author Maxine Michalski
+    #
+    # Fetch tag information
+    #
+    # @note This method fetches complete tag information for a post
+    # @param post [Hash|E621::Post] User data to fetch from
+    # @example Get tags for post
+    #   E621::Post.tags(id: 1) #=> Array<E621::Tag>
+    # @return [Array<E621::Tag>]
+    # @see https://e621.net/help/show/api#posts
     def self.tags(post)
       unless (post.is_a?(Hash) && post[:id].is_a?(Integer)) ||
              post.is_a?(E621::Post)
@@ -49,6 +62,14 @@ module Rubyhexagon
       end
     end
 
+    # @author Maxine Michalski
+    #
+    # Fetch a list of posts
+    #
+    # @example Get a list of posts
+    #   E621::Post.list(tags: 'female') #=> Array<E621::Post>
+    # @return [Array<E621::Post>]
+    # @see https://e621.net/help/show/api#posts
     def self.list(query)
       raise ArgumentError, 'A Hash is required' unless query.is_a?(Hash)
       E621::API.fetch(:post, :index, query).map do |post|
@@ -56,6 +77,14 @@ module Rubyhexagon
       end
     end
 
+    # @author Maxine Michalski
+    #
+    # Fetch a list of deleted posts
+    #
+    # @example Get a list of deleted posts
+    #   E621::Post.deleted(page: 1) #=> Array<E621::Post>
+    # @return [Array<E621::Post>]
+    # @see https://e621.net/help/show/api#posts
     def self.deleted(query)
       raise ArgumentError, 'A Hash is required' unless query.is_a?(Hash)
       E621::API.fetch(:post, :deleted_index, query).map do |post|
@@ -63,6 +92,14 @@ module Rubyhexagon
       end
     end
 
+    # @author Maxine Michalski
+    #
+    # Fetch a list of popular posts
+    #
+    # @example Get popular posts, by day
+    #   E621::Post.popular_by(:day) #=> E621::Post
+    # @return [Array<E621::Post>]
+    # @see https://e621.net/help/show/api#posts
     def self.popular_by(period)
       unless %i[day week month].include?(period)
         raise ArgumentError, 'Period must be day, week or month'
@@ -72,10 +109,25 @@ module Rubyhexagon
       end
     end
 
+    # @author Maxine Michalski
+    #
+    # Fetch data for a post
+    #
+    # @example Get post data
+    #   post.show #=> E621::Post
+    # @return [E621::Post]
+    # @see https://e621.net/help/show/api#posts
     def show
       E621::Post.new(E621::API.fetch(:post, :show, id: @id))
     end
 
+    # @author Maxine Michalski
+    #
+    # Download a file from a post
+    #
+    # @example Download file
+    #  post.download(:image) #=> Tempfile
+    # @return [Tempfile]
     def download(which)
       unless %i[image preview sample].include?(which)
         raise ArgumentError, 'Unsupported doanload'
@@ -83,9 +135,17 @@ module Rubyhexagon
       E621::API.download(__send__(which).url)
     end
 
+    # @author Maxine Michalski
+    #
+    # List of notes, that belong to a post
+    #
+    # @example Get nots for a post
+    #   post.notes #=> Array<E621::Post::Note>
+    # @return [E621::Post::Note]
+    # @see https://e621.net/help/show/api#notes
     def notes
       E621::API.fetch(:note, :index, post_id: @id).map do |n|
-        E621::Note.new(n)
+        E621::Post::Note.new(n)
       end
     end
   end

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

@@ -21,8 +21,17 @@ module Rubyhexagon
     # A class to interact with the e621 web interface.
     #
     # @author Maxine Michalski
+    # @api public
     # @since 2.0.0
     class Flag
+      # @author Maxine Michalski
+      #
+      # Fetch a list of flags
+      #
+      # @example Get a list of posts
+      #   E621::Post::Flagi.list(page: 1) #=> Array<E621::Post::Flag>
+      # @return [Array<E621::Flag>]
+      # @see https://e621.net/help/show/api#flaghistory
       def self.list(query)
         unless query.is_a?(Hash)
           raise ArgumentError, 'A Hash or Post object is required'

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

@@ -0,0 +1,77 @@
+# 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/post/tag_item.rb

@@ -21,8 +21,17 @@ module Rubyhexagon
     # A class to interact with the e621 web interface.
     #
     # @author Maxine Michalski
+    # @api public
     # @since 2.0.0
     class TagItem
+      # @author Maxine Michalski
+      #
+      # Fetch a list of tag items
+      #
+      # @example Get a list of posts
+      #   E621::Post::TagItem.list(page: 1) #=> Array<E621::Post::TagItem>
+      # @return [Array<E621::TagItem>]
+      # @see https://e621.net/help/show/api#taghistory
       def self.list(query)
         unless query.is_a?(Hash)
           raise ArgumentError, 'A Hash or Post object is required'

data/lib/rubyhexagon/api/tag.rb

@@ -20,6 +20,7 @@ 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
@@ -27,8 +28,10 @@ module Rubyhexagon
     # 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)
@@ -43,8 +46,10 @@ module Rubyhexagon
     # 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|
@@ -54,8 +59,9 @@ module Rubyhexagon
 
     # @author Maxine Michalski
     #
-    # Return a filled Tag object from a tag.
-    #
+    # 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,

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

@@ -21,6 +21,7 @@ module Rubyhexagon
     # A class to interact with the e621 web interface.
     #
     # @author Maxine Michalski
+    # @api public
     # @since 2.0.0
     class Alias
       # @author Maxine Michalski
@@ -29,7 +30,11 @@ module Rubyhexagon
       #
       # @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|

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

@@ -21,6 +21,7 @@ module Rubyhexagon
     # A class to interact with the e621 web interface.
     #
     # @author Maxine Michalski
+    # @api public
     # @since 2.0.0
     class Implication
       # @author Maxine Michalski
@@ -29,7 +30,11 @@ module Rubyhexagon
       #
       # @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|