rubyhexagon 2.0.1 → 3.0.0

data/lib/rubyhexagon/post/{image.rb → file.rb}

@@ -23,53 +23,57 @@ module Rubyhexagon
     #
     # @api private
     # @author Maxine Michalski
-    # @since 1.0.0
-    class Image
-      # Image url
-      # @return [URI] url of file
+    # @since 3.0.0
+    class File
+      # File url
+      # @return [URI] url of file or nil
       attr_reader :url
 
-      # Image file extension
+      # File file extension
       # @return [String] extension of file
       attr_reader :ext
 
-      # Image width
+      # File width
       # @return [Integer] image/video width
       attr_reader :width
 
-      # Image height
+      # File height
       # @return [Integer] image/video height
       attr_reader :height
 
-      # Image file size
+      # File size
       # @return [Integer] file size in bytes
       attr_reader :size
 
+      # File MD5 hash string
+      # @return [String] MD5 hash
+      attr_reader :md5
+
       # @author Maxine Michalski
       #
-      # Initializer for an Image
+      # Initializer for an File
       #
-      # @param image [Hash] image information
+      # @param image [Hash] file information
       # @option image [String] :url URI location
       # @option image [String] :ext extension string
-      # @option image [Integer] :width of image
-      # @option image [Integer] :height of image
-      # @option image [Integer] :size of image
+      # @option image [Integer] :width of file
+      # @option image [Integer] :height of file
+      # @option image [Integer] :size of file
+      # @option image [String] :md5 of file
       #
       # @return the object
-      def initialize(image)
-        unless image.is_a?(Hash)
-          raise ArgumentError, "#{image.class} is not a Hash"
+      def initialize(file)
+        unless file.is_a?(Hash)
+          raise ArgumentError, "#{file.class} is not a Hash"
         end
-        if image.keys != %i[url ext width height size]
-          mis = %i[url ext width height size] - image.keys
-          raise ArgumentError, "Missing key#{mis.count > 1 ? 's' : ''}: #{mis}"
+        unless file.keys.sort == %i[ext height md5 size url width]
+          raise ArgumentError, 'Missing keys in file Hash.'
         end
-        image.each do |k, v|
-          if %i[ext width height size].include?(k)
+        file.each do |k, v|
+          if %i[width height ext size md5].include?(k)
             instance_variable_set("@#{k}".to_sym, v)
           elsif k == :url
-            @url = URI.parse(v)
+            @url = v.nil? ? nil : URI.parse(v)
           end
         end
       end
@@ -94,20 +98,21 @@ module Rubyhexagon
 
       # @author Maxine Michalski
       #
-      # Comparison method to comapre two Image objects (and sub class objects)
+      # Comparison method to comapre two File objects (and sub class objects)
       #
       # @example Compare two notes, that are unequal
       #   Note.new(id: 1) == Note.new(id: 2) #=> false
       # @return [TrueClass, FalseClass]
       def ==(other)
-        other.is_a?(Image) && @url == other.url && @size == other.size
+        other.is_a?(File) && @md5 == other.md5 && @url == other.url &&
+          @size == other.size
       end
 
       # @author Maxine Michalski
       #
       # Turn object into a hash representation of itself
       #
-      # @example Turn an Image into a Hash
+      # @example Turn an File into a Hash
       #   Note.new(id: 1).to_hash #=> { id: 1 }
       # @return [Hash]
       def to_hash
@@ -118,19 +123,5 @@ module Rubyhexagon
         hash
       end
     end
-
-    # class for samples, that is just a copy of Image
-    #
-    # @api private
-    # @author Maxine Michalski
-    # @since 1.0,0
-    class Sample < Image; end
-
-    # class for previews, that is just a copy of Image
-    #
-    # @api private
-    # @author Maxine Michalski
-    # @since 1.0,0
-    class Preview < Image; end
   end
 end

data/lib/rubyhexagon/{api/post/flag.rb → post/preview.rb}

@@ -18,26 +18,36 @@
 
 module Rubyhexagon
   class Post
-    # A class to interact with the e621 web interface.
+    # Class for post preview data. This is mostly an abstraction to have data
+    # structures in a more Ruby like nature.
     #
+    # @api private
     # @author Maxine Michalski
-    # @api public
-    # @since 2.0.0
-    class Flag
+    # @since 3.0.0
+    class Preview < File
       # @author Maxine Michalski
       #
-      # Fetch a list of flags
+      # Initializer for an Preview
       #
-      # @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'
+      # @param image [Hash] preview information
+      # @option image [String] :url URI location
+      # @option image [Integer] :width of preview
+      # @option image [Integer] :height of preview
+      #
+      # @return the object
+      def initialize(preview)
+        unless preview.is_a?(Hash)
+          raise ArgumentError, "#{preview.class} is not a Hash"
+        end
+        unless preview.keys.sort == %i[height url width]
+          raise ArgumentError, 'Missing keys in preview Hash.'
         end
-        E621::API.fetch(:post_flag_history, :index, query).map do |note|
-          new(note)
+        preview.each do |k, v|
+          if %i[width height].include?(k)
+            instance_variable_set("@#{k}".to_sym, v)
+          elsif k == :url
+            @url = v.nil? ? nil : URI.parse(v)
+          end
         end
       end
     end

data/lib/rubyhexagon/post/sample.rb

@@ -0,0 +1,65 @@
+# 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
+    # Class for post preview data. This is mostly an abstraction to have data
+    # structures in a more Ruby like nature.
+    #
+    # @api private
+    # @author Maxine Michalski
+    # @since 3.0.0
+    class Sample < File
+      # @author Maxine Michalski
+      #
+      # Initializer for an Sample
+      #
+      # @param image [Hash] preview information
+      # @option image [String] :url URI location
+      # @option image [Integer] :width of sample
+      # @option image [Integer] :height of sample
+      # @option image [TrueClass|FalseClass] :has
+      #
+      # @return the object
+      def initialize(sample)
+        unless sample.is_a?(Hash)
+          raise ArgumentError, "#{sample.class} is not a Hash"
+        end
+        unless sample.keys.sort == %i[has height url width]
+          raise ArgumentError, 'Missing keys in sample Hash.'
+        end
+        sample.each do |k, v|
+          if %i[width height has].include?(k)
+            instance_variable_set("@#{k}".to_sym, v)
+          elsif k == :url
+            @url = v.nil? ? nil : URI.parse(v)
+          end
+        end
+      end
+
+      # @author Maxine Michalski
+      #
+      # Show if post has a sample or not.
+      #
+      # @return [TrueClass|FalseClass]
+      def exist?
+        @has
+      end
+    end
+  end
+end

data/lib/rubyhexagon/{api/post/tag_item.rb → post/score.rb}

@@ -18,28 +18,43 @@
 
 module Rubyhexagon
   class Post
-    # A class to interact with the e621 web interface.
+    # Class for post file data. This is mostly an abstraction to have data
+    # structures in a more Ruby like nature.
     #
+    # @api private
     # @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'
+    # @since 3.0.0
+    class Score
+
+      attr_reader :up
+      attr_reader :down
+      attr_reader :total
+
+      def initialize(score)
+        raise ArgumentError, 'Hash required' unless score.is_a?(Hash)
+        unless score.keys.sort == %i[down total up]
+          raise ArgumentError, 'Missing Hash keys.'
         end
-        E621::API.fetch(:post_tag_history, :index, query).map do |note|
-          new(note)
+        score.each do |k, v|
+          instance_variable_set("@#{k}".to_sym, v)
         end
       end
+
+      def to_i
+        @total
+      end
+
+      def positive?
+        @total.positive?
+      end
+
+      def negative?
+        @total.negative?
+      end
+
+      def zero?
+        @total.zero?
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubyhexagon
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 3.0.0
 platform: ruby
 authors:
 - Maxine Michalski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-13 00:00:00.000000000 Z
+date: 2020-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -32,31 +32,13 @@ extra_rdoc_files: []
 files:
 - lib/rubyhexagon.rb
 - lib/rubyhexagon/api.rb
-- lib/rubyhexagon/api/artist.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
-- lib/rubyhexagon/api/tag/implication.rb
-- lib/rubyhexagon/api/user.rb
-- lib/rubyhexagon/artist.rb
 - lib/rubyhexagon/error.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
-- lib/rubyhexagon/tag/alias.rb
-- lib/rubyhexagon/tag/implication.rb
-- lib/rubyhexagon/tag/type.rb
-- lib/rubyhexagon/user.rb
-- lib/rubyhexagon/user/level.rb
+- lib/rubyhexagon/post/file.rb
+- lib/rubyhexagon/post/preview.rb
+- lib/rubyhexagon/post/sample.rb
+- lib/rubyhexagon/post/score.rb
 homepage: https://github.com/maxine-red/rubyhexagon
 licenses:
 - GPL-3.0
@@ -76,8 +58,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Rubyhexagon, Ruby bindings for e621.

data/lib/rubyhexagon/api/artist.rb

@@ -1,42 +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 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|
-        new(artist)
-      end
-    end
-  end
-end

data/lib/rubyhexagon/api/pool.rb

@@ -1,80 +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 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)
-        raise ArgumentError, 'A Hash or pool object are required'
-      end
-      id = pool.is_a?(Hash) ? pool[:id] : pool.id
-      page = page.nil? ? pool[:page] : page[:page]
-      E621::API.fetch(:pool, :show, id: id, page: page)[:posts].map do |post|
-        E621::Post.new(post)
-      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|
-        new(pool)
-      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|
-        E621::Post.new(post)
-      end
-    end
-  end
-end