rubyhexagon 1.6.4 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: e2917bb296b7de0e3037e5d5bcc42c35453f07a9857e06e317b2612164b3e216
-  data.tar.gz: f6af1287f5c4a38251b3e47656655e45d677f40a0d2aefab0cdadf54525aac74
+SHA1:
+  metadata.gz: dd11e83da3191060c9511173288f9af58a6750c9
+  data.tar.gz: eaa6a515b4ad4d00d1dff2a0766c735b7873cfa6
 SHA512:
-  metadata.gz: f15e5974d2fbefb56b0a509dd34e55611e8209a1aab23b4ef84dfd24c0f5f5d3d3abacf0bd1c462ab66c653886c0970974fc31097d140e0804d72b5ee49e8e6d
-  data.tar.gz: 08e271ac11e45c9430d39047a0a25d335a3bdf3ce18cab4d2170334842c8c23e1645ed0c418934af1005709e1a01ef17ed5542bb5296e7610c43669337d1c4c2
+  metadata.gz: 4aedb99ec447252a7b9abf1e327d339b55ba0472f15606f0bdee32fa968bf092e9deca3025a64413b1179ec089bb9567ffa72fb26632dd171dcecc20f15651a4
+  data.tar.gz: f1923e822369f550161992477889872e8659a25c1f8817d5c373b89e68b16b20fe98a3df3acdb2026fcc9151e391dbb61471289d1f8411f3f928c29681e568c3

data/lib/rubyhexagon.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.
 #
@@ -20,34 +20,38 @@
 require 'net/http'
 require 'uri'
 require 'json'
-require 'digest/md5'
+require 'cgi'
+require 'tempfile'
 
-require_relative 'rubyhexagon/helper/api'
 require_relative 'rubyhexagon/error'
-require_relative 'rubyhexagon/user'
-require_relative 'rubyhexagon/tag'
+
 require_relative 'rubyhexagon/artist'
-require_relative 'rubyhexagon/type'
-require_relative 'rubyhexagon/image'
-require_relative 'rubyhexagon/level'
+require_relative 'rubyhexagon/note'
 require_relative 'rubyhexagon/post'
+require_relative 'rubyhexagon/post/flag'
+require_relative 'rubyhexagon/post/tag_item'
 require_relative 'rubyhexagon/pool'
-require_relative 'rubyhexagon/login'
-require_relative 'rubyhexagon/tag_change'
-require_relative 'rubyhexagon/search/posts'
-require_relative 'rubyhexagon/search/pools'
-require_relative 'rubyhexagon/search/tags'
-require_relative 'rubyhexagon/search/flag_history'
-require_relative 'rubyhexagon/search/tag_history'
+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'
 
 # Namespace for all classes in this gem.
 # @author Maxine Michalski
 # @since 0.4.3
 module Rubyhexagon
-  MAJOR = 1
-  MINOR = 6
-  PATCH = 4
+  # Major version part
+  MAJOR = 2
+  # Minor version part
+  MINOR = 0
+  # Patch version part
+  PATCH = 0
+  # Name of gem
   NAME = 'rubyhexagon'
+  # Full version string
   VERSION = "#{MAJOR}.#{MINOR}.#{PATCH}"
 end
 
@@ -55,3 +59,15 @@ end
 # break old code.
 # Both module names can be used.
 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/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

@@ -0,0 +1,96 @@
+# 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
+  # General API helper class.
+  #
+  # Not to be used directly!
+  #
+  # @api private
+  # @author Maxine Michalski
+  # @since 0.4.3
+  class API
+    # User agent to send with every request
+    USER_AGENT = { 'User-Agent' =>
+                   "#{Rubyhexagon::NAME}/#{Rubyhexagon::VERSION} "\
+                    '(by maxine_red on e621' }.freeze
+    # Lock path for locking file. This is needed to ensure API request limits.
+    LOCK_PATH = '/var/lock/rubyhexagon.lock'
+
+    # @author Maxine Michalski
+    #
+    # Fetch data from the e621 web interface
+    #
+    # @param noun [Symbol] first part of interface, like 'post', 'tag', etc.
+    # @param action [Symbol] second part of interface, like 'show', 'index'
+    # @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!'
+      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)
+      end
+    end
+
+    # @author Maxine Michalski
+    #
+    # Download from a URI, needed for image download
+    #
+    # @param uri [URI] URI to download
+    #
+    # @return [Tempfile] A temporary file, that holds downloaded data.
+    def self.download(uri)
+      raise ArgumentError, 'URI required' unless uri.is_a?(URI)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true if uri.port == 443
+      temp = Tempfile.new(File.basename(uri.path))
+      temp.write(http.get("#{uri.path}?#{uri.query}", USER_AGENT).body)
+      temp.rewind
+      temp
+    end
+
+    # @author Maxine Michalski
+    #
+    # A method to make locking easier and that ensures 1 request per scondd.
+    #
+    # @return [Object]
+    def self.lock
+      lock_file = File.open(LOCK_PATH, 'a', 0o666)
+      lock_file.flock(File::LOCK_EX)
+      lock_file.truncate(0)
+      lock_file.print $PROCESS_ID
+      begin
+        data = yield
+        sleep 1
+      ensure
+        lock_file.flock(File::LOCK_UN)
+        lock_file.close
+      end
+      data
+    end
+    private_class_method :new
+    private_class_method :lock
+  end
+end

data/lib/rubyhexagon/{login.rb → api/artist.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.
 #
@@ -13,30 +13,20 @@
 # 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/>.
 
-require 'singleton'
-
 module Rubyhexagon
-  # A singleton class to store API login credentials. This is used to make sure
-  # that those data can be used on outgoing API calls, but also centralizes
-  # their use.
+  # A class to interact with the e621 web interface.
   #
   # @author Maxine Michalski
-  # @since 1.5.0
-  class Login
-    include Singleton
-
-    # @return [String] login name for user
-    attr_accessor :login
-
-    # @return [String] api key for calls
-    attr_accessor :password_hash
-
-    def setup?
-      !(@login.nil? || @password_hash.nil?)
+  # @since 2.0.0
+  class Artist
+    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/note.rb

@@ -0,0 +1,50 @@
+# 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/api/pool.rb

@@ -0,0 +1,51 @@
+# 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 1.4.0
+  class Pool
+    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
+
+    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
+
+    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

data/lib/rubyhexagon/api/post.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
+  # A class to interact with the e621 web interface.
+  #
+  # @author Maxine Michalski
+  # @since 1.4.0
+  class Post
+    # @author Maxine Michalski
+    #
+    # Fetch data for post
+    #
+    # @param user [Hash|E621::Post] User data to fetch from
+    #
+    # @return [E621::Post]
+    def self.show(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
+      new(E621::API.fetch(:post, :show, id: id))
+    end
+
+    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
+    end
+
+    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
+
+    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
+
+    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|
+        new(post)
+      end
+    end
+
+    def show
+      E621::Post.new(E621::API.fetch(:post, :show, id: @id))
+    end
+
+    def download(which)
+      unless %i[image preview sample].include?(which)
+        raise ArgumentError, 'Unsupported doanload'
+      end
+      E621::API.download(__send__(which).url)
+    end
+
+    def notes
+      E621::API.fetch(:note, :index, post_id: @id).map do |n|
+        E621::Note.new(n)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# 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
+    # @since 2.0.0
+    class Flag
+      def self.list(query)
+        unless query.is_a?(Hash)
+          raise ArgumentError, 'A Hash or Post object is required'
+        end
+        E621::API.fetch(:post_flag_history, :index, query).map do |note|
+          new(note)
+        end
+      end
+    end
+  end
+end