rubyhexagon 0.4.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a0ba6239bf1b972497e5a67367385ee5078361e5
-  data.tar.gz: 2dbb6830d9893988e6b08bea317ad1b44e0d1321
+SHA256:
+  metadata.gz: 1920d433c32360d24b4091fa37a7132f9fac4ccf36b400e034b2491679bee5b0
+  data.tar.gz: 7abdf32fcfaf560525b03697b7c68e63faff335bb6677c3569631b6d6b71b69e
 SHA512:
-  metadata.gz: 60745e307ebad26cff032df12f73b0c9d8315869193f2de75e5accc3f1d7bdd72f5d6cb29ab62c22360bf853c887a9b9d239d0c9a19a42bfd2e1be6a470f1149
-  data.tar.gz: 7cbec7dcd77f387ef16d5a44377de26985c5af75a2deaad789ca3b433a1dd2973712389604765c3e782ee4de59eed57da1fe2d97a55f583f813a6853596fdaff
+  metadata.gz: 8a682ee7cba26e33eed44ddc234d41ea8ea31fd8e1dc06d9838ad2096aecc0fb97bcd47721dfb4731181ee02f675c283d4948a98a73957636239d8a1b5b639b5
+  data.tar.gz: 23b285239417e638de6b8873d8023b0840cb2039fb778382f367d7c9e8542da653737ea002108307fc9bfcbf6dd0790d72fc5b387ab62e6365e2aa4eeb73000c

data/lib/rubyhexagon.rb

@@ -1,33 +1,41 @@
-=begin
-  Copyright 2014, 2015, 2017 Maxine Michalski <maxine@furfind.net>
+#  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/>.
 
-  This file is part of rubyhexagon.
+require 'open-uri'
+require 'uri'
+require 'json'
+require 'digest/md5'
 
-  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/>.
-=end
-
-require "standard/string"
-require "standard/int"
-require "standard/error"
-require "standard/time"
-
-require "api"
-require "container"
-require "search"
-require "pool"
+require 'rubyhexagon/helper/api'
+require 'rubyhexagon/error'
+require 'rubyhexagon/user'
+require 'rubyhexagon/tag'
+require 'rubyhexagon/artist'
+require 'rubyhexagon/type'
+require 'rubyhexagon/image'
+require 'rubyhexagon/level'
+require 'rubyhexagon/post'
+require 'rubyhexagon/search/posts'
+require 'rubyhexagon/search/tags'
 
+# Namespace for all classes in this gem.
+# @author Maxine Michalski
+# @since 0.4.3
 module E621
-  Name = "rubyhexagon"
-  Version = "0.4.3"
+  NAME = 'rubyhexagon'.freeze
+  VERSION = '1.0.0'.freeze
 end

data/lib/rubyhexagon/artist.rb

@@ -0,0 +1,92 @@
+# 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 E621
+  # Class to hold information about an artist on e621
+  #
+  # @author Maxine Michalski
+  # @since 1.0.0
+  class Artist
+    # @return [Integer] id of artist
+    attr_reader :id
+
+    # @return [String] name of artist
+    attr_reader :name
+
+    # @return [Array<String>] alternative names for artist
+    attr_reader :alternative_names
+
+    # @return [Array<URI>] links to find artist
+    attr_reader :urls
+
+    # @author Maxine Michalski
+    #
+    # Initializer for Artist.
+    #
+    # @param artist [Hash] artist data, fetched from e621
+    #
+    # @return the object
+    def initialize(artist)
+      @name = artist
+    end
+
+    # @author Maxine Michalski
+    #
+    # Fills this object with additional artist data
+    def show!
+      artist = API.new.fetch('artist', 'index', name: @name).first
+      @id = artist[:id].to_i
+      @alternative_names = artist[:other_names].split(/,\s+/)
+      @urls = artist[:urls].map { |u| URI(u) }
+      @active = artist[:is_active]
+    end
+
+    # @author Maxine Michalski
+    #
+    # Returns a filled Artist object
+    #
+    # @return [Artist] filled out artist object
+    def show
+      artist = Artist.new(@name)
+      artist.show!
+      artist
+    end
+
+    # @author Maxine Michalski
+    #
+    # Comparison method for artists
+    #
+    # @return [TrueClass, FalseClass]
+    def ==(other)
+      return false unless other.is_a?(Artist)
+      if @id && other.id
+        @id == other.id && @name == other.name
+      else
+        @name == other.name
+      end
+    end
+
+    # @author Maxine Michalski
+    #
+    # Check if this artist is active
+    #
+    # @return [TrueClass] artist is active
+    # @return [FalseClass] artist is not active
+    def active?
+      @active
+    end
+  end
+end

data/lib/rubyhexagon/error.rb

@@ -0,0 +1,21 @@
+# 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/>.
+
+# Error class to show an ID is out of range or not an Integer
+#
+# @author Maxine Michalski
+# @since 1.0.0
+class InvalidIDError < StandardError; end

data/lib/rubyhexagon/helper/api.rb

@@ -0,0 +1,93 @@
+# 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 E621
+  # 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(rspec = false)
+      @user_agent = { 'User-Agent' =>
+                     "#{E621::NAME}/#{E621::VERSION} (by maxine_red on e621" }
+      @base = 'https://e621.net'
+      lock_path = '/tmp/rubyhexagon.lock'
+      @lock_file = File.open(lock_path, 'a')
+      @rspec = rspec
+    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)
+      query = query.to_a.map { |q| "#{q.first}=#{q.last}" }.join('&')
+      lock do
+        if @rspec || !defined? RSpec
+          JSON.parse(open("#{@base}/#{noun}/#{action}.json?#{query}",
+                          @user_agent).read, symbolize_names: true)
+        else # In RSpec environment?
+          JSON.parse(open("spec/data/#{noun}/#{action}.json?#{query}")
+                            .read, symbolize_names: true)
+        end
+      end
+    end
+
+    private
+
+    # @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
+        data = yield
+        # There is a hard limit of 2 requests per second, but to be nice we wait
+        # a whole second between requests.
+        sleep 1 if @rspec || !defined? RSpec
+      ensure
+        @lock_file.flock(File::LOCK_UN)
+      end
+      data
+    end
+  end
+end

data/lib/rubyhexagon/image.rb

@@ -0,0 +1,112 @@
+# 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 E621
+  # 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
+  # @since 1.0.0
+  class Image
+    # @return [URI] url of file
+    attr_reader :url
+
+    # @return [String] extension of file
+    attr_reader :ext
+
+    # @return [Integer] image/video width
+    attr_reader :width
+
+    # @return [Integer] image/video height
+    attr_reader :height
+
+    # @return [String] MD5 hash sum
+    attr_reader :md5
+
+    # @author Maxine Michalski
+    #
+    # Initializer for a File. This is not a Ruby file class, but an abstraction
+    # of e621 file information.
+    #
+    # @param file [Hash] file information
+    #
+    # @return the object
+    def initialize(file)
+      @url = URI(file[:url])
+      @md5 = File.basename(file[:url]).sub(/\.\w{3,4}$/, '')
+      @ext = file[:ext]
+      @width = file[:width].to_i
+      @height = file[:height].to_i
+      @user_agent = { 'User-Agent' =>
+                     "#{E621::NAME}/#{E621::VERSION} (by maxine_red on e621" }
+    end
+
+    # @author Maxine Michalski
+    #
+    # Comparison method to comapre two Image objects (and sub class objects)
+    #
+    # @return [TrueClass, FalseClass]
+    def ==(other)
+      other.is_a?(Image) && @md5 == other.md5
+    end
+
+    # @author Maxine Michalski
+    #
+    # Retrieve data from e621 and save it to file.
+    #
+    # @param dirname [String] path where to save. This needs be an existing
+    #   directory. This overwrites existing files.
+    # @raise [ArgumentError] Argument given is not an existing directory
+    def save!(dirname = './')
+      raise ArgumentError, 'Not a directory!' unless File.directory?(dirname)
+      loop do
+        stream = open(@url, @user_agent).read
+        File.open("#{dirname}/#{File.basename(@url.path)}", 'w') do |f|
+          f.print stream
+        end
+        break if Digest::MD5.hexdigest(stream) == @md5
+      end
+    end
+  end
+  class Sample < Image; end
+
+  # Class for post file data. This is mostly an abstraction to have data
+  # structures in a more Ruby like nature.
+  # This class just holds an adapted version of #save!, to handle the case of
+  # preview images having a different MD5 hash sum attribute than they actually
+  # should have.
+  # That is an e621 issue though.
+  #
+  # @api private
+  # @author Maxine Michalski
+  # @since 1.0.0
+  class Preview < Image
+    # @author Maxine Michalski
+    #
+    # Retrieve data from e621 and save it to file.
+    #
+    # @param dirname [String] path where to save. This needs be an existing
+    #   directory. This overwrites existing files.
+    # @raise [ArgumentError] Argument given is not an existing directory
+    def save!(dirname = './')
+      raise ArgumentError, 'Not a directory!' unless File.directory?(dirname)
+      File.open("#{dirname}/#{File.basename(@url.path)}", 'w') do |f|
+        f.print open(@url, @user_agent).read
+      end
+    end
+  end
+end

data/lib/rubyhexagon/level.rb

@@ -0,0 +1,56 @@
+# 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 E621
+  # 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)
+      @id = level
+      @name = if @id.between?(31, 39)
+                [nil, nil, :contributor, :'former staff', :janotor][@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
+  end
+end