rubyhexagon 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3b33b5997c2add67eddbfeea3016cc29e5699996b7dc38a2653ed692bbdeb0f
-  data.tar.gz: d5df5106fef14164a6e33ce3e0b35a80836b2902b299cbc53d574944f32894f6
+  metadata.gz: f88455b4dbcc7ad6e9a36d8f377147f71dd116ecce985fcc59d424fc39804ac3
+  data.tar.gz: aa44c7453d967144605930ae31899c5851ef7606e38e4de4a2614f6625ffc1bb
 SHA512:
-  metadata.gz: a9abec7cf7b10ac58e7c11cf6ad5fb7ed660af4c29153d2cab8082d738345d1f5cc67004d2c3ccc7bf196089a157f0a7f2370f7508309b65a2223df0bb2cfd5b
-  data.tar.gz: ff325c1d8f244e1ddf40eea8590fa339f5007f848033feb73ef18fe82fe0a5b95db11df3cde327ef2f5583d273eff354707a437e8a2b7d9500ed58f2cb041f89
+  metadata.gz: 2073477e49ba4cd8a7abc52d91713365e1eec77dfc9449f9d732c78188e94bd9daf742973a86ee4afd60b5677be6f6c1475672acfc06e777003e392e5fbf80b0
+  data.tar.gz: 017dc526b07aeadfecbd128c0578816880fb3145c7bfed57106343b76b0e3444bbd30578c7e2b77ef916b64fe04675132621c40f47d28920b8ea3b1a8563b004

data/lib/rubyhexagon.rb

@@ -37,7 +37,7 @@ require 'rubyhexagon/search/tags'
 # @since 0.4.3
 module E621
   MAJOR = 1
-  MINOR = 1
+  MINOR = 2
   PATCH = 0
   NAME = 'rubyhexagon'.freeze
   VERSION = "#{MAJOR}.#{MINOR}.#{PATCH}".freeze

data/lib/rubyhexagon/error.rb

@@ -19,3 +19,9 @@
 # @author Maxine Michalski
 # @since 1.0.0
 class InvalidIDError < StandardError; end
+
+# Error class to show that an object misses an important parameter
+#
+# @author Maxine Michalski
+# @since 1.0.0
+class ObjectNotFilledError < StandardError; end

data/lib/rubyhexagon/helper/api.rb

@@ -39,10 +39,12 @@ module E621
     def initialize(rspec = false)
       @user_agent = { 'User-Agent' =>
                      "#{E621::NAME}/#{E621::VERSION} (by maxine_red on e621" }
-      @base = 'https://e621.net'
+      @rspec = rspec
+      @base = if @rspec || !defined? RSpec then 'https://e621.net'
+              else 'spec/data'
+              end
       lock_path = '/tmp/rubyhexagon.lock'
       @lock_file = File.open(lock_path, 'a')
-      @rspec = rspec
     end
 
     # @author Maxine Michalski
@@ -58,13 +60,13 @@ module E621
     # @return [Hash] JSON parsed response.
     def fetch(noun, action, query)
       query = query.to_a.map { |q| "#{q.first}=#{q.last}" }.join('&')
+      query = "?#{query}" unless query == ''
+      uri = "#{@base}/#{noun}/#{action}.json#{query}"
       lock do
         if @rspec || !defined? RSpec
-          JSON.parse(open("#{@base}/#{noun}/#{action}.json?#{query}",
-                          @user_agent).read, symbolize_names: true)
+          JSON.parse(open(uri, @user_agent).read, symbolize_names: true)
         else # In RSpec environment?
-          JSON.parse(open("spec/data/#{noun}/#{action}.json?#{query}")
-                            .read, symbolize_names: true)
+          JSON.parse(open(uri).read, symbolize_names: true)
         end
       end
     end

data/lib/rubyhexagon/search/posts.rb

@@ -69,14 +69,30 @@ module E621
         posts
       end
 
+      # @author Maxine Michalski
+      #
+      # Fetch popular posts by day, week or month
+      #
+      # @param timespan [Symbol] can be :day, :week or :month
+      # @raise ArgumentError if no valid symbol is given
+      #
+      # @return [Array<Post>]
+      def self.popular(timespan = :day)
+        unless %i[day week month].include?(timespan)
+          raise ArgumentError, "Unknown time span: #{timespan}"
+        end
+        API.new.fetch('post', "popular_by_#{timespan}", {}).map do |post|
+          Post.new(post[:id]).show(post)
+        end
+      end
+
       # @author Maxine Michalski
       #
       # Helper function for deleted posts
       #
       # @return [Array<Post>] array of deleted posts
       def self.fetch_deleted(page)
-        api = API.new
-        api.fetch('post', 'deleted_index', page: page).map do |post|
+        API.new.fetch('post', 'deleted_index', page: page).map do |post|
           DeletedPost.new(post[:id], post[:delreason])
         end
       end
@@ -88,8 +104,7 @@ module E621
       #
       # @return [Array<Post>] array of posts
       def self.fetch_posts(parameters)
-        api = API.new
-        api.fetch('post', 'index', parameters).map do |data|
+        API.new.fetch('post', 'index', parameters).map do |data|
           Post.new(data[:id]).show(data)
         end
       end

data/lib/rubyhexagon/search/tags.rb

@@ -33,7 +33,7 @@ module E621
       # @param name [String] name pattern to search tags with
       # @param limit [Integer] number of tags to return. This has a hard limit
       #   of 500
-      # @param after_id [Integer] only look for tags after this ID
+      # @param page [Integer] page to retieve
       #
       # @return [Array<Tag>] array of tags
       def self.list(name, limit = 500, page = 1)
@@ -48,18 +48,90 @@ module E621
         t
       end
 
+      # @author Maxine Michalski
+      #
+      # Retrieve information about implicated tags.
+      # @param name [String] name pattern to search tags with
+      # @param page [Integer] page to retrieve
+      #
+      # @raise ObjectNotFilledError if no name is present
+      #
+      # @return [Array<Tag>] array of implicated tags for this tag
+      def self.implications(name, page = 1)
+        params = { implied_to: name, page: page }
+        tags = fetch_implications(params)
+        while block_given? && tags != []
+          tags.each { |tag| yield tag unless tag.nil? }
+          tags = fetch_implications(params)
+          params[:page] += 1
+        end
+        tags.compact
+      end
+
+      # @author Maxine Michalski
+      #
+      # Retrieve information about aliased tags.
+      # @param name [String] name pattern to search tags with
+      # @param page [Integer] page to retrieve
+      #
+      # @raise ObjectNotFilledError if no name is present
+      #
+      # @return [Array<Tag>] array of implicated tags for this tag
+      def self.aliases(name, page = 1)
+        params = { aliased_to: name, approved: true, page: page }
+        tags = fetch_aliases(params)
+        while block_given? && tags != []
+          tags.each { |tag| yield tag unless tag.nil? }
+          tags = fetch_aliases(params)
+          params[:page] += 1
+        end
+        tags.compact
+      end
+
       # @author Maxine Michalski
       #
       # Helper function to get Tag data
       #
       # @return [Array<Tag>] array of tags
       def self.fetch_tags(params)
-        api = API.new
-        api.fetch('tag', 'index', params).map do |data|
+        API.new.fetch('tag', 'index', params).map do |data|
           Tag.new(data[:id]).show(data)
         end
       end
       private_class_method :fetch_tags
+
+      # @author Maxine Michalski
+      #
+      # Helper function to fetch implicated tags
+      #
+      # @param params [Hash] parameter for API call
+      #
+      # @return [Array<Tag>] array of implicated tags
+      def self.fetch_implications(params)
+        tag_params = { name: params[:implied_to], order: :date, limit: 1,
+                       page: 1 }
+        implied_tag = fetch_tags(tag_params).first
+        API.new.fetch('tag_implication', 'index', params).map do |tag|
+          if tag[:consequent_id] == implied_tag.id && !tag[:pending]
+            Tag.new(tag[:predicate_id])
+          end
+        end
+      end
+      private_class_method :fetch_implications
+      
+      # @author Maxine Michalski
+      #
+      # Helper function to fetch aliased tags
+      #
+      # @param params [Hash] parameter for API call
+      #
+      # @return [Array<Tag>] array of implicated tags
+      def self.fetch_aliases(params)
+        API.new.fetch('tag_alias', 'index', params).map do |tag|
+          Tag.new(tag[:alias_id])
+        end
+      end
+      private_class_method :fetch_aliases
     end
   end
 end

data/lib/rubyhexagon/tag.rb

@@ -38,7 +38,7 @@ module E621
     #
     # @raise InvalidIDError
     #
-    # @param tag [Integer] tag data, fetched from e621
+    # @param id [Integer] tag data, fetched from e621
     #
     # @return the object
     def initialize(id)
@@ -50,19 +50,29 @@ module E621
 
     # @author Maxine Michalski
     #
-    # Bang method to fill tag data. If data is already available at creation,
-    # use the initializer!
+    # Bang method to fill tag data.
+    # @notice If the optional parameter is not given, this method makes an API
+    #   call.
+    #
+    # @param tag [Hash] optional parameter with API call information
+    #
+    # @return [NilClass]
     def show!(tag = nil)
       tag = API.new.fetch('tag', 'show', id: @id) if tag.nil?
       @name = tag[:name]
       @count = tag[:count].to_i
       @type = (Type.new(tag[:type], tag[:type_locked]) unless tag[:type].nil?)
+      nil
     end
 
     # @author Maxine Michalski
     #
-    # Bang method to fill tag data. If data is already available at creation,
-    # use the initializer!
+    # Method to return a properly filled Tag object.
+    # @note This makes an additional API call if no argument is given
+    #
+    # @param tag [Hash] optional parameter, if information are ready
+    #
+    # @return [Tag] Tag filled with all information
     def show(tag = nil)
       new_tag = Tag.new(@id)
       new_tag.show!(tag)
@@ -76,7 +86,9 @@ module E621
     # @note If there is only a an ID set with one argument, then only compare
     #   IDs
     #
-    # @return [TrueClass, FalseClass]
+    # @param other [Object] object that should be compared
+    #
+    # @return [TrueClass, FalseClass] test result of comparison
     def ==(other)
       return false unless other.is_a?(Tag)
       if @name.nil? || other.name.nil?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubyhexagon
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Maxine Michalski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-26 00:00:00.000000000 Z
+date: 2018-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json