rubyhexagon 2.0.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: db0b8e40637feb6bbf0f6a51172e882da9f50302
-  data.tar.gz: 9313eabbf199ad7131adae13d2c07d7fa898bf1d
+SHA256:
+  metadata.gz: 6453fec0dc8f9b3d540143a8936b0763364a4dd5420f1ccbc80009750d682d58
+  data.tar.gz: 5b7ea88cfc326811a8685110774c58da34b741c7cfc7de49a5bf76ac23694bd4
 SHA512:
-  metadata.gz: 89e0c912d9b3acd09811fb3924af6716c8341effa924853457b44d4354316b05f7358fb337c8d4a1445be40e810d6a17bfbddb6935e8c4064f8755b372a1b60d
-  data.tar.gz: a383b82a2671b960b96f326667d6bfe552017ad83a6c69cb4807521fcd39283b8a0239f090e6e8e920c055d1e1f599b4cdbf9251d15f5d766e983e7b2e0c749f
+  metadata.gz: 5e25bdd04582b1ae1607dd85e27a38311f4095240f1a11aad3eaf5eaa13776e79d9f7073f780663c6b17eb4749e8620589ad01f3e8b334e501fa7799bd9e4674
+  data.tar.gz: 8f277204edd5a36565ea9fbbf03f774fd2a718b6230695b135d8084704428f53f4c89f70682307a2db8e7c0efcfd6d6a2d7959f7743d1c0caaf54d07ecbde40a

data/lib/rubyhexagon.rb

@@ -25,49 +25,29 @@ require 'tempfile'
 
 require_relative 'rubyhexagon/error'
 
-require_relative 'rubyhexagon/artist'
 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'
-require_relative 'rubyhexagon/tag'
-require_relative 'rubyhexagon/tag/alias'
-require_relative 'rubyhexagon/tag/implication'
-require_relative 'rubyhexagon/tag/type'
-require_relative 'rubyhexagon/user'
-require_relative 'rubyhexagon/user/level'
+require_relative 'rubyhexagon/post/file'
+require_relative 'rubyhexagon/post/preview'
+require_relative 'rubyhexagon/post/sample'
+require_relative 'rubyhexagon/post/score'
 
 # Namespace for all classes in this gem.
 # @author Maxine Michalski
 # @since 0.4.3
 module Rubyhexagon
   # Major version part
-  MAJOR = 2
+  MAJOR = 3
   # Minor version part
   MINOR = 0
   # Patch version part
-  PATCH = 1
+  PATCH = 0
   # Name of gem
   NAME = 'rubyhexagon'
   # Full version string
   VERSION = "#{MAJOR}.#{MINOR}.#{PATCH}"
 end
 
-# Compatibility assignment, so that I can move module to a new name and don't
-# break old code.
-# Both module names can be used.
 E621 = Rubyhexagon
 
 require_relative 'rubyhexagon/api'
-require_relative 'rubyhexagon/api/artist'
 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'
-require_relative 'rubyhexagon/api/tag/alias'
-require_relative 'rubyhexagon/api/tag/implication'
-require_relative 'rubyhexagon/api/user'

data/lib/rubyhexagon/api.rb

@@ -41,16 +41,23 @@ module Rubyhexagon
     # @param query [Hash] query hash for interface
     #
     # @return [Hash|Array] A decoded JSON string
-    def self.fetch(noun, action, query)
-      unless noun.is_a?(Symbol) && action.is_a?(Symbol) && query.is_a?(Hash)
-        raise ArgumentError, 'Two symbols and a hash are required!'
+    def self.fetch(noun, query)
+      unless noun.is_a?(Symbol) && query.is_a?(Hash)
+        raise ArgumentError, 'A symbol and a hash are required!'
       end
       http = Net::HTTP.new('e621.net', 443)
       http.use_ssl = true
-      query = query.map { |k, v| "#{k}=#{v}" }.join('&')
-      lock do
-        data = http.get("/#{noun}/#{action}.json?#{query}", USER_AGENT).body
-        JSON.parse(data, symbolize_names: true)
+      if query.key?(:id)
+        lock do
+          data = http.get("/#{noun}/#{query[:id]}.json", USER_AGENT).body
+          JSON.parse(data, symbolize_names: true)
+        end
+      else
+        query = query.map { |k, v| "#{k}=#{v}" }.join('&')
+        lock do
+          data = http.get("/#{noun}.json?#{query}", USER_AGENT).body
+          JSON.parse(data, symbolize_names: true)
+        end
       end
     end
 

data/lib/rubyhexagon/api/post.rb

@@ -38,28 +38,7 @@ module Rubyhexagon
         raise ArgumentError, 'A Hash or post data object are required'
       end
       id = post.is_a?(Hash) ? post[:id] : post.id
-      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)
-        raise ArgumentError, 'A Hash or post data object are required'
-      end
-      id = post.is_a?(Hash) ? post[:id] : post.id
-      E621::API.fetch(:post, :tags, id: id).map do |t|
-        E621::Tag.new(t)
-      end
+      new(E621::API.fetch(:posts, id: id)[:post])
     end
 
     # @author Maxine Michalski
@@ -72,39 +51,7 @@ module Rubyhexagon
     # @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|
-        new(post)
-      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|
-        new(post)
-      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'
-      end
-      E621::API.fetch(:post, "popular_by_#{period}".to_sym, {}).map do |post|
+      E621::API.fetch(:posts, query)[:posts].map do |post|
         new(post)
       end
     end
@@ -118,7 +65,7 @@ module Rubyhexagon
     # @return [E621::Post]
     # @see https://e621.net/help/show/api#posts
     def show
-      E621::Post.new(E621::API.fetch(:post, :show, id: @id))
+      E621::Post.new(E621::API.fetch(:posts, id: @id)[:post])
     end
 
     # @author Maxine Michalski
@@ -129,24 +76,10 @@ module Rubyhexagon
     #  post.download(:image) #=> Tempfile
     # @return [Tempfile]
     def download(which)
-      unless %i[image preview sample].include?(which)
+      unless %i[file preview sample].include?(which)
         raise ArgumentError, 'Unsupported doanload'
       end
       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::Post::Note.new(n)
-      end
-    end
   end
 end

data/lib/rubyhexagon/post.rb

@@ -30,113 +30,54 @@ module Rubyhexagon
     # @return [Integer] id of post information
     attr_reader :id
 
-    # Post author
-    # @example Get post creator
-    #   post.author #=> E621::User
-    # @return [E621::User] user object of who uploaded this post
-    attr_reader :author
-
     # Time post was created at
     # @example Get creation time
     #   post.created_at #=> Time
     # @return [Time] creation time of post
     attr_reader :created_at
 
-    # Post status
-    # @example Get post status
-    #   post.status #=> Symbol
-    # @return [Symbol] status of post, can be :active, :flagged, :pending or
-    #   :deleted
-    attr_reader :status
-
-    # Post sources
-    # @example Get post sources
-    #   post.sources #=> Array<String>
-    # @return [Array<String>] array of sources. This can contain URI in string
-    #   form
-    attr_reader :sources
+    # Time post was last updated
+    # @example Get last update time
+    #   post.updated_at #=> Time
+    # @return [Time] last update time of post
+    attr_reader :updated_at
 
-    # Post artists
-    #
-    # @example Get post artists
-    #   post.artists #=> Array<E621::Artist>
-    # @return [Array<E621::Artist>] array of artists, that work on the image
-    # in this post
-    attr_reader :artists
+    # File of post
+    # @example Get post's file
+    #   post.file #=> E621::Post::File
+    # @return [E621::Post::File] file content of this post
+    attr_reader :file
 
-    # Post desciption
-    # @example Get post description
-    #   post.description #=> String|nil
-    # @return [String|NilClass] description that's associated with this post
-    attr_reader :description
+    # Preview of post
+    # @example Get post's preview
+    #   post.preview #=> E621::Post::Preview
+    # @return [E621::Post::Preview] preview content of this post
+    attr_reader :preview
 
-    # Count of users who favorited this post
-    # @example Get favorite count
-    #   post.fav_count #=> Integer
-    # @return [Integer] number of people, who favorited this post
-    attr_reader :fav_count
+    # Sample of post
+    # @example Get post's sample
+    #   post.sample #=> E621::Post::Sample
+    # @return [E621::Post::Sample] sample content of this post
+    attr_reader :sample
 
-    # Post score
-    # @example Get score assigned to post
-    #   post.score #=> Integer
-    # @return [Integer] vote score this post holds
+    # Score for post
+    # @example Get post's score
+    #   post.score #=> E621::Post::Score
+    # @return [E621::Post::Score] score information of this post
     attr_reader :score
 
-    # Post rating
-    # @example Get post rating
-    #   post.rating #=> Symbol
-    # @return [Symbol] rating of this post. Can be one of :safe,
-    #   :questionable, :explicit
+    attr_reader :tags
+    attr_reader :locked_tags
+    attr_reader :change_seq
     attr_reader :rating
-
-    # Post parent
-    # @example Get parent of post
-    #   post.parent #=> E621::Post or nil
-    # @return [E621:post] parent of this post
-    # @return [NilClass]
+    attr_reader :fav_count
+    attr_reader :sources
     attr_reader :parent
-
-    # Post children
-    # @example Get post's children
-    #   post.children #=> [] or Array<E621::Post>
-    # @return [Array<E621::Post>] Array of child posts
     attr_reader :children
-
-    # Post MD5 checksum
-    # @example Get post's MD5 checksum
-    #   post.md5 #=> String
-    # @return [String] MD5 checksum associated with this post
-    attr_reader :md5
-
-    # Image of post
-    # @example Get post's image
-    #   post.image #=> E621::Image
-    # @return [E621::Image] file content of this post
-    attr_reader :image
-
-    # Sample of post
-    # @example Get post's image
-    #   post.sample #=> E621::Sample
-    # @return [E621::Sample] sample data in E621::Sample format
-    attr_reader :sample
-
-    # Preview of post
-    # @example Get post's image
-    #   post.preview #=> E621::Preview
-    # @return [E621::Preview] preview data in E621::Preview format
-    attr_reader :preview
-
-    # Deletion reason of post, if any
-    # @example Get deletion reason of post
-    #   post.delreason #=> String or nil
-    # @return [String|NilClass] reason for deletion, if deleted
-    attr_reader :delreason
-
-    # Tags of post
-    # @example Get tags of post, without web interaction
-    #   post.tags #=> Array<E621::Tag>
-    # @return [Array<E621::Tag>] tags of this post
-    attr_reader :tags
+    attr_reader :approver
+    attr_reader :uploader
+    attr_reader :description
+    attr_reader :comment_count
 
     # @author Maxine Michalski
     #
@@ -148,88 +89,19 @@ module Rubyhexagon
     # @return the object
     def initialize(post)
       raise ArgumentError, "#{post.class} is not a Hash" unless post.is_a?(Hash)
+      raise ArgumentError, 'Not a proper post Hash' if post.key?(:post)
       post[:id] = post[:id].to_i
       id = post[:id]
       raise InvalidIDError, "ID out of range: #{id}" unless id.positive?
       post.each do |k, v|
-        if %i[rating created_at status sources parent_id children
-              description artist tags].include?(k)
+        if %i[created_at updated_at file sample preview score flags
+              rating relationships].include?(k)
           __send__("setup_#{k}".to_sym, v)
-        elsif %i[id description score fav_count md5 has_comments has_children
-                 delreason has_notes].include?(k)
-          instance_variable_set("@#{k}".to_sym, v)
+        elsif %i[id tags change_seq sources fav_count description
+                 comment_count is_favorited].include?(k)
+          instance_variable_set("@#{k}", v)
         end
       end
-      setup_author(post)
-      setup_files(post)
-    end
-
-    # @author Maxine Michalski
-    #
-    # Test status with an optional parameter
-    #
-    # @param test_var [Symbol] variable under test
-    # @api private
-    # @example Get rating status
-    #   post.explicit? #=> true or false
-    # @return [TrueClass|FalseClass]
-    def test(test_var = nil)
-      test_var ||= __callee__.to_s.sub(/\?/, '').to_sym
-      test_ar = %i[safe questionable explicit]
-      test_ar.include?(test_var) ? @rating == test_var : @status == test_var
-    end
-    # @see test
-    # @api public
-    alias active? test
-    # @api public
-    # @see test
-    alias flagged? test
-    # @api public
-    # @see test
-    alias pending? test
-    # @api public
-    # @see test
-    alias deleted? test
-    # @api public
-    # @see test
-    alias safe? test
-    # @api public
-    # @see test
-    alias questionable? test
-    # @api public
-    # @see test
-    alias explicit? test
-
-    # @author Maxine Michalski
-    #
-    # Show if post has comments or not
-    # @example Get if post has comments
-    #   post.comments? #=> true or false
-    # @return [TrueClass|FalseClass]
-    def comments?
-      return false if @has_comments.nil?
-      @has_comments
-    end
-
-    # @author Maxine Michalski
-    #
-    # Show if post has a parent
-    # @example Has post a parent?
-    #   post.parent? #=> true or false
-    # @return [TrueClass|FalseClass]
-    def parent?
-      !@parent.nil?
-    end
-
-    # @author Maxine Michalski
-    #
-    # Show if post has children
-    # @example Has post children?
-    #   post.children? #=> true or false
-    # @return [TrueClass|FalseClass]
-    def children?
-      return false if @has_children.nil?
-      @has_children
     end
 
     # @author Maxine Michalski
@@ -242,16 +114,6 @@ module Rubyhexagon
       other.is_a?(Post) && @id == other.id
     end
 
-    # @author Maxine Michalski
-    #
-    # Has post notes?
-    # @example Post has notes?
-    #   post.notes? #=> true or false
-    # @return [TrueClass|FalseClass]
-    def notes?
-      @has_notes
-    end
-
     # @author Maxine Michalski
     #
     # Turn object into a hash representation of itself
@@ -267,18 +129,41 @@ module Rubyhexagon
       hash
     end
 
-    private
+    def test
+      instance_variable_get("@#{__callee__.to_s.sub('?', '')}")
+    end
 
-    # @author Maxine Michalski
-    #
-    # Set author information
-    # @api private
-    # @param post [Hash] post data
-    # @return [E621::User]
-    def setup_author(post)
-      return if post[:creator_id].nil?
-      @author = E621::User.new(id: post[:creator_id], name: post[:author])
+    alias pending? test
+    alias flagged? test
+    alias note_locked? test
+    alias status_locked? test
+    alias rating_locked? test
+    alias deleted? test
+
+    def safe?
+      @rating == :safe
+    end
+
+    def questionable?
+      @rating == :questionable
+    end
+
+    def explicit?
+      @rating == :explicit
+    end
+
+    def children?
+      @has_children
+    end
+
+    def active_children?
+      @has_active_children
+    end
+
+    def favorited?
+      @is_favorited
     end
+    private
 
     # @author Maxine Michalski
     #
@@ -299,111 +184,80 @@ module Rubyhexagon
     # Set creation time
     #
     # @api private
-    # @param time [Time] Hash that includes creation time in UNIX Epoch on an
-    # `:s` key
+    # @param time [String] Hash that includes creation time
     # @return [Time]
     def setup_created_at(time)
-      @created_at = Time.at(time[:s]) unless time.nil?
+      @created_at = Time.parse(time) unless time.nil?
     end
 
     # @author Maxine Michalski
     #
-    # Set status of post
-    # @api private
-    # @param status [String] Status of post
-    # @return [Symbol]
-    def setup_status(status)
-      @status = status.to_sym unless status.nil?
-    end
-
-    # @author Maxine Michalski
+    # Set update time
     #
-    # Set sources of post
     # @api private
-    # @param sources [Array<String>] Sources of post
-    # @return [Array<String>]
-    def setup_sources(sources)
-      @sources = sources.nil? ? [] : sources
+    # @param time [String] Hash that includes update time
+    # @return [Time]
+    def setup_updated_at(time)
+      @updated_at = Time.parse(time) unless time.nil?
     end
 
     # @author Maxine Michalski
     #
-    # Set parent post
+    # Set file information
     #
-    # @param parent [Integer] Parent post ID
     # @api private
-    # @note A parent post is only set with an ID and further information must
-    # be fetched manually.
-    # @return [E621::Post|NilClass]
-    def setup_parent_id(parent)
-      @parent = parent.nil? ? nil : E621::Post.new(id: parent)
+    # @param file [Hash] Information about post file
+    # @return [E621::Post::File]
+    def setup_file(file)
+      @file = E621::Post::File.new(file)
     end
 
     # @author Maxine Michalski
     #
-    # Set children posts
+    # Set sample information
     #
-    # @param children [Array<Integer>] Children post IDs
     # @api private
-    # @note All children are only set with an ID and further information must
-    # be fetched manually.
-    # @return [Array<E621::Post>]
-    def setup_children(children)
-      return [] if children.nil?
-      @children = children.split(',').map { |c| E621::Post.new(id: c) }
+    # @param sample [Hash] Information about post sample
+    # @return [E621::Post::Sample]
+    def setup_sample(sample)
+      @sample = E621::Post::Sample.new(sample)
     end
 
     # @author Maxine Michalski
     #
-    # Set post description
+    # Set preview information
     #
-    # @param description [String] Post description
     # @api private
-    # @note Empty descriptions are set to nil
-    # @return [String|NilClass]
-    def setup_description(description)
-      @description = !description.nil? && description.empty? ? nil : description
+    # @param preview [Hash] Information about post preview
+    # @return [E621::Post::Preview]
+    def setup_preview(preview)
+      @preview = E621::Post::Preview.new(preview)
     end
-
+    
     # @author Maxine Michalski
     #
-    # Setup artist for post
+    # Set score information
     #
-    # @param artists [Array<String>] array of artist names
     # @api private
-    # @return [Array<E621::Artist>]
-    def setup_artist(artists)
-      @artists = artists.map { |a| E621::Artist.new(name: CGI.unescape(a)) }
+    # @param score [Hash] Information about post score
+    # @return [E621::Post::Score]
+    def setup_score(score)
+      @score = E621::Post::Score.new(score)
     end
 
-    # @author Maxine Michalski
-    #
-    # Setup tags for post
-    # @param tags [String] String that contains tags, separated by spaces
-    # @api private
-    # @note These tags can only be read by #tags
-    # @return [Array<E621::Tag>
-    def setup_tags(tags)
-      @tags = tags.split(' ').map { |t| E621::Tag.new(name: t) }
+    def setup_flags(flags)
+      flags.each do |k, v|
+        instance_variable_set("@#{k}", v)
+      end
     end
 
-    # @author Maxine Michalski
-    #
-    # Setup files for posts
-    # @param post [Hash] post data
-    # @api private
-    # @return [E621::Post::Image|E621::Post::Sample|E621::Post::Preview]
-    def setup_files(post)
-      return if post[:file_url].nil?
-      @image = Image.new(url: post[:file_url], ext: post[:file_ext],
-                         width: post[:width], height: post[:height],
-                         size: post[:file_size])
-      @sample = Sample.new(url: post[:sample_url], ext: post[:file_ext],
-                           width: post[:sample_width],
-                           height: post[:sample_height], size: 0)
-      @preview = Preview.new(url: post[:preview_url], ext: 'jpg',
-                             width: post[:preview_width],
-                             height: post[:preview_height], size: 0)
+    def setup_relationships(rel)
+      @parent = rel[:parent_id].nil? ? nil : E621::Post.new(id: rel[:parent_id])
+      @has_children = rel[:has_children]
+      @has_active_children = rel[:has_active_children]
+      @children = rel[:children].map do |c|
+        E621::Post.new(id: c)
+      end
     end
   end
 end