rubyhexagon 1.6.4 → 2.0.0

data/lib/rubyhexagon/tag/implication.rb

@@ -0,0 +1,91 @@
+# 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 implication information.
+    #
+    # @author Maxine Michalski
+    # @since 2.0.0
+    class Implication
+      # @return [Integer] id of implication
+      attr_reader :id
+
+      # @return [E621::Tag] implying tag
+      attr_reader :tag
+
+      # @return [E621::Tag] implied tag
+      attr_reader :implies
+
+      # @author Maxine Michalski
+      #
+      # Initializer for Implication.
+      #
+      # @raise InvalidIDError if implication ID is not valid
+      # @raise ArgumentError hash not valid
+      #
+      # @param imply [Hash] implication data, fetched from e621
+      # @option imply [Integer] :id implication ID
+      # @option imply [Integer] :consequent_id implying tag ID
+      # @option imply [Integer] :predicate_id implied tag ID
+      # @option imply [TrueClass|FalseClass] :pending statud
+      #
+      # @return the object
+      def initialize(imply)
+        unless imply.is_a?(Hash)
+          raise ArgumentError, "#{imply.class} is not a Hash"
+        end
+        if imply.keys != %i[id consequent_id predicate_id pending]
+          mis = %i[id consequent_id predicate_id pending] - imply.keys
+          raise ArgumentError, "Missing key#{mis.count > 1 ? 's' : ''}: #{mis}"
+        end
+        imply.each do |k, v|
+          if %i[id pending].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 k == :consequent_id
+            @tag = E621::Tag.new(id: v)
+          elsif k == :predicate_id
+            @implies = E621::Tag.new(id: v)
+          end
+        end
+      end
+
+      # @author Maxine Michalski
+      #
+      # Comparison method for Types, to give a more meaningful comparison.
+      #
+      # @return [TrueClass, FalseClass]
+      def ==(other)
+        other.is_a?(Implication) && @id == other.id
+      end
+
+      # @author Maxine Michalski
+      #
+      # Check if this implication is pending confirmation.
+      #
+      # @return [TrueClass] tag implication is pending
+      # @return [FalseClass] tag implication is not pending
+      def pending?
+        @pending
+      end
+    end
+  end
+end

data/lib/rubyhexagon/tag/type.rb

@@ -0,0 +1,79 @@
+# 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
+      # @return [Integer] id of type
+      attr_reader :id
+
+      # @return [String] name of type
+      attr_reader :name
+
+      # @author Maxine Michalski
+      #
+      # Initializer for Type.
+      #
+      # @raise ArgumentError if type ID is not valid
+      #
+      # @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
+    end
+  end
+end

data/lib/rubyhexagon/user.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2014-2018 Maxine Michalski <maxine@furfind.net>
+# Copyright 2014-2018, 2020 Maxine Michalski <maxine@furfind.net>
 #
 # This file is part of rubyhexagon.
 #
@@ -36,6 +36,12 @@ module Rubyhexagon
     # @return [Time] registration time of this user
     attr_reader :created_at
 
+    # @return [E621::Post] avatar set by user
+    attr_reader :avatar
+
+    # @return [Array<E621::Tag>] an array of artist tags, associated with user
+    attr_reader :artist_tags
+
     # @author Maxine Michalski
     #
     # Initializer for User.
@@ -44,30 +50,22 @@ module Rubyhexagon
     #
     # @return the object
     def initialize(user)
-      @id = user[:id].to_i
-      @name = user[:name]
-    end
-
-    # @author Maxine Michalski
-    #
-    # Fill this object with user data.
-    def show!
-      user = API.new.fetch('user', 'show', id: @id)
-      @id         = user[:id].to_i
-      @name       = user[:name]
-      @level      = Level.new(user[:level].to_i)
-      @created_at = Time.parse(user[:created_at])
-    end
-
-    # @author Maxine Michalski
-    #
-    # Returns a filled User object
-    #
-    # @return [User] filled out user object
-    def show
-      user = User.new(id: @id, name: @name)
-      user.show!
-      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
@@ -76,11 +74,7 @@ module Rubyhexagon
     #
     # @return [TrueClass, FalseClass]
     def ==(other)
-      if @name.nil?
-        other.is_a?(User) && @id == other.id
-      else
-        other.is_a?(User) && @id == other.id && @name == other.name
-      end
+      other.is_a?(User) && @id == other.id
     end
   end
 end

data/lib/rubyhexagon/user/level.rb

@@ -0,0 +1,92 @@
+# 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
+      # @return [Integer] id of level
+      attr_reader :id
+
+      # @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.
+      #
+      # @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
+      #
+      # 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubyhexagon
 version: !ruby/object:Gem::Version
-  version: 1.6.4
+  version: 2.0.0
 platform: ruby
 authors:
 - Maxine Michalski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-11 00:00:00.000000000 Z
+date: 2020-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -31,23 +31,32 @@ extensions: []
 extra_rdoc_files: []
 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/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/helper/api.rb
-- lib/rubyhexagon/image.rb
-- lib/rubyhexagon/level.rb
-- lib/rubyhexagon/login.rb
+- lib/rubyhexagon/note.rb
 - lib/rubyhexagon/pool.rb
 - lib/rubyhexagon/post.rb
-- lib/rubyhexagon/search/flag_history.rb
-- lib/rubyhexagon/search/pools.rb
+- lib/rubyhexagon/post/flag.rb
+- lib/rubyhexagon/post/image.rb
+- lib/rubyhexagon/post/tag_item.rb
 - lib/rubyhexagon/search/posts.rb
-- lib/rubyhexagon/search/tag_history.rb
-- lib/rubyhexagon/search/tags.rb
 - lib/rubyhexagon/tag.rb
-- lib/rubyhexagon/tag_change.rb
-- lib/rubyhexagon/type.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
 homepage: https://github.com/maxine-red/rubyhexagon
 licenses:
 - GPL-3.0
@@ -68,7 +77,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.5.2.1
 signing_key: 
 specification_version: 4
 summary: Rubyhexagon, Ruby bindings for e621.

data/lib/rubyhexagon/helper/api.rb

@@ -1,99 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright 2014-2018 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
-  # An interface class, to unify calls from other code to e621 [dot] net.
-  # This class handles rate limiting, as well as provides a more uniform
-  # approach in making requests.
-  # It also ensures that a proper user agent is sent, as required by the e621
-  # API.
-  #
-  # @api private
-  # @author Maxine Michalski
-  # @since 0.4.3
-  class API
-    # User agent, used to identify this gem against e621.
-    #
-    # @return [Hash] hash that can be used with open-uri
-    attr_reader :user_agent
-
-    # @author Maxine Michalski
-    #
-    # Initializer for API. All methods are instance methods.
-    #
-    # @return the object
-    def initialize
-      @user_agent = { 'User-Agent' =>
-                     "#{Rubyhexagon::NAME}/#{Rubyhexagon::VERSION} "\
-                      '(by maxine_red on e621' }
-      @http = Net::HTTP.new('e621.net', 443)
-      @http.use_ssl = true
-      lock_path = '/tmp/rubyhexagon.lock'
-      @lock_file = File.open(lock_path, 'a', 0o666)
-    end
-
-    # @author Maxine Michalski
-    #
-    # @param noun [String] the e621 noun (post, tag, user, artist, etc.)
-    # @param action [String] action to be performed on noun (list, show, etc.)
-    # @param query [Hash] a hash with extra information, which is dependent on
-    #   noun and action
-    #
-    # Fetches information from e621 and returns data to caller. This also takes
-    # into account rate limiting.
-    #
-    # @return [Hash] JSON parsed response.
-    def fetch(noun, action, query, method = 'GET')
-      if Login.instance.setup?
-        query.store(:login, Login.instance.login)
-        query.store(:password_hash, Login.instance.password_hash)
-      end
-      query = query.map { |k, v| "#{k}=#{v}" }.join('&')
-      lock do
-        data = if method == 'GET'
-                 @http.get("/#{noun}/#{action}.json?#{query}", @user_agent).body
-               else
-                 @http.post("/#{noun}/#{action}.json", query, @user_agent).body
-               end
-        JSON.parse(data, symbolize_names: true)
-      end
-    end
-
-    # @author Maxine Michalski
-    #
-    # (see #fetch)
-    # A wrapper for actual requests, to minimize method length.
-    def lock
-      @lock_file.flock(File::LOCK_EX)
-      @lock_file.truncate(0)
-      @lock_file.print $PROCESS_ID
-      begin
-        s = Time.now
-        data = yield
-        # There is a hard limit of 2 requests per second, but to be nice we wait
-        # a whole second between requests.
-        w = 1 - (Time.now - s)
-        sleep w if w.positive?
-      ensure
-        @lock_file.flock(File::LOCK_UN)
-      end
-      data
-    end
-  end
-end