nhentai-api 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1b6ecef6e264747bde463e1cbd116c7442fafb2b188a932b3a1b8cceaca9d68
-  data.tar.gz: '00069935751c8f2da32d66202d73bc9dc2e9e9faf022e62bdeb64594a1682de1'
+  metadata.gz: f8dd0b6a81d6a3cb6ca3b9ad1327d4753d60fa0a742692f23ef297cf190f1422
+  data.tar.gz: 8f145277e1338775784dd3b297cd747a67ca2257df8012d0353d81993eff338d
 SHA512:
-  metadata.gz: 8977d2bdb5dec34bfb89ffa7d8c9da3f340f232a72a288e30107530137be4017edea3c88f121576dd0f236f43533804120c3696010bce72afca383c82e127c0e
-  data.tar.gz: 1b4c8d969ca11d23d0a8f46c1520689fc63a03f5a15f25ea30d5745970350eb8765892814555212001031fa878ea5c396046e0040eec9d77b00164b904b350f2
+  metadata.gz: 388c4685aaabad1a83f7c150f6a11ebbe2f626d249ef8e355773862e33e5f47ceec707f29fff6fca3bf1e9104ac9a07e4e4d1a9d11de9c8f4a566b4a60c1dea8
+  data.tar.gz: bbbcc5bec9476f012ce8a1c6721f7405063bfcc4bab58ddb03f1ff51dbcb8cb3cf5d5f1f7180e4229632654205f1c906a9d3d7cf3592cc144ebd82a532cca49f

data/lib/nhentai-api.rb

@@ -1,6 +1,5 @@
 require 'net/http'
 require 'time'
-require 'pp'
 
 class Tag
   attr_reader :id, :name, :count, :url
@@ -14,177 +13,373 @@ class Tag
 end
 
 class Doujinshi
-  attr_reader :id, :client, :media_id, :count
+  attr_reader :id, :client, :media_id, :count_pages
 
   def initialize(id)
     @id           = id
     @client       = Net::HTTP.get_response(URI("https://nhentai.net/g/#{@id}/"))
     @media_id     = @client.body.match(%r{\/([0-9]+)\/cover.jpg})[1]
-    @count        = @client.body.match(/([0-9]+) pages/)[1].to_i
+    @count_pages  = @client.body.match(/([0-9]+) pages/)[1].to_i
   end
 
+  #
+  # Check if a doujinshi with the given id exist
+  #
+  # @return [Bool] true if the doujinshi exist, otherwise false
+  # @since 0.1.0
+  # @example
+  #   doujinshi.exists?   #=> true
+  #
   def exists?
     @client.code == 200
   end
 
+  #
+  # Give the title of a doujinshi
+  #
+  # @return [String] the title of a given doujinshi
+  # @since 0.1.0
+  # @example
+  #   doujinshi.title   #=> '[Illumination. (Ogadenmon)] Android no Ecchi na Yatsu | Horny Androids (NieR:Automata) [English] =TLL + mrwayne= [Digital]'
+  #
   def title
     @client.body.match(%r{<div id="info">\s+<h1>(.+)<\/h1>})[1]
   end
 
+  #
+  # Give the cover's URL of a doujinshi
+  #
+  # @return [String] the cover's URL of a given doujinshi
+  # @since 0.1.0
+  # @example
+  #   doujinshi.cover   #=> 'https://t.nhentai.net/galleries/1170172/cover.jpg'
+  #
   def cover
     "https://t.nhentai.net/galleries/#{@media_id}/cover.jpg"
   end
 
+  #
+  # Give the URL of a given page of a doujinshi
+  #
+  # @param [Integer] page a particular page of a doujinshi
+  # @return [String] the URL of a given page of a doujinshi
+  # @since 0.1.0
+  # @example
+  #   doujinshi.get_page        #=> 'https://i.nhentai.net/galleries/1170172/1.jpg'
+  #   doujinshi.get_page(10)    #=> 'https://i.nhentai.net/galleries/1170172/10.jpg'
+  #
   def page(page = 1)
     res = @client.body.match(%r{https://t.nhentai.net/galleries/#{@media_id}/#{page}t\.(.{3})"})
 
     "https://i.nhentai.net/galleries/#{@media_id}/#{page}.#{res[1]}"
   end
 
+  #
+  # Give the URL of a all pages of a doujinshi
+  #
+  # @return [Array] array pages' URL
+  # @since 0.1.0
+  # @example
+  #   doujinshi.pages   #=> ['https://i.nhentai.net/galleries/1170172/1.jpg', ..., 'https://i.nhentai.net/galleries/1170172/31.jpg']
+  #
   def pages
     (1..@count_pages).map { |page| page(page) }
   end
 
+  #
+  # Give the thumbnail's URL of a given page of a doujinshi
+  #
+  # @param [Integer] page a particular page of a doujinshi
+  # @return [String] the thumbnail's URL of a given page of a doujinshi
+  # @since 0.1.0
+  # @example
+  #   doujinshi.get_thumbnail       #=> 'https://t.nhentai.net/galleries/1170172/1t.jpg'
+  #   doujinshi.get_thumbnail(10)   #=> 'https://t.nhentai.net/galleries/1170172/10t.jpg'
+  #
   def thumbnail(page = 1)
     res = @client.body.match(%r{https://t.nhentai.net/galleries/#{@media_id}/(#{page}t\..{3})"})
 
     "https://t.nhentai.net/galleries/#{@media_id}/#{res[1]}"
   end
 
+  #
+  # Give the URL of a all thumbnails of a doujinshi
+  #
+  # @return [Array] an array thumbnails' URL
+  # @since 0.1.0
+  # @example
+  #   doujinshi.thumbnails    #=> ['https://t.nhentai.net/galleries/1170172/1t.jpg',..., 'https://t.nhentai.net/galleries/1170172/31t.jpg']
+  #
   def thumbnails
     (1..@count_pages).map { |page| thumbnail(page) }
   end
 
-  def num_favorites
+  #
+  # Give the number of favorites on a doujinshi
+  #
+  # @return [Integer] a counter of favorites on a given doujinshi
+  # @since 0.1.0
+  # @example
+  #   doujinshi.num_favorites   #=> 13326
+  #
+  def count_favorites
     regex = %r{<span>Favorite <span class="nobold">.(\d+).<\/span><\/span>}
 
     @client.body.match(regex)[1].to_i
   end
 
+  #
+  # Give the upload date of a doujinshi
+  #
+  # @return [Integer] the upload date of a given doujinshi
+  # @since 0.1.0
+  # @example
+  #   doujinshi.upload_date   #=> 2018-01-17 15:56:16 +0000
+  #
   def upload_date
     Time.iso8601(@client.body.match(/datetime="(.+)"/)[1])
   end
 
-  def parse_tags(res)
-    res.split(%r{<a(.+?)<\/a>}).reject(&:empty?).map do |line|
-      id    = line.match(/tag-(\d+)/)[1]
-      name  = line.match(/">(.+?)</)[1].strip
-      count = line.match(/\((.+?)\)</)[1].tr(',', '').to_i
-      url   = line.match(/href=\"(.+?)\"/)[1]
-
-      Tag.new(id, name, count, url)
-    end
-  end
-
+  #
+  # Give all tags of a doujinshi
+  #
+  # @return [Array] of Tag class of a given doujinshi
+  # @since 0.1.0
+  # @example
+  #   doujinshi.tags
+  #
   def tags
     res = @client.body.match(%r{Tags:\s*<span class="tags">(.+)<\/span>})
 
     parse_tags(res[1])
   end
 
+  #
+  # Give a counter of tags
+  #
+  # @return [Integer] of tags
+  # @since 0.1.0
+  # @example
+  #   doujinshi.count_tags    #=> 9
+  #
   def count_tags
     res = @client.body.match(%r{Tags:\s*<span class="tags">(.+)<\/span>})
 
     res.nil? ? 0 : parse_tags(res[1]).length
   end
 
+  #
+  # Check if a particular doujinshi have some tags
+  #
+  # @return [Bool] true if the doujinshi have tags, otherwise false
+  # @since 0.1.0
+  # @example
+  #   doujinshi.tags?   #=> true
+  #
   def tags?
     !@client.body.match(%r{Tags:\s*<span class="tags">(.+)<\/span>}).nil?
   end
 
+  #
+  # Give all parodies of a doujinshi
+  #
+  # @see Doujinshi#tags
+  #
   def parodies
     res = @client.body.match(%r{Parodies:\s+<span class="tags">(.+)<\/span>})
 
     parse_tags(res[1])
   end
 
+  #
+  # Give a counter of parodies
+  #
+  # @see Doujinshi#count_tags
+  #
   def count_parodies
     res = @client.body.match(%r{Parodies:\s+<span class="tags">(.+)<\/span>})
 
     res.nil? ? 0 : parse_tags(res[1]).length
   end
 
+  #
+  # Check if a particular doujinshi have some parodies
+  #
+  # @see Doujinshi#tags?
+  #
   def parodies?
     !@client.body.match(%r{Parodies:\s+<span class="tags">(.+)<\/span>}).nil?
   end
 
+  #
+  # Give all characters of a doujinshi
+  #
+  # @see Doujinshi#tags
+  #
   def characters
     res = @client.body.match(%r{Characters:\s+<span class="tags">(.+)<\/span>})
 
     parse_tags(res[1])
   end
 
+  #
+  # Give a counter of characters
+  #
+  # @see Doujinshi#count_tags
+  #
   def count_characters
     res = @client.body.match(%r{Characters:\s+<span class="tags">(.+)<\/span>})
 
     res.nil? ? 0 : parse_tags(res[1]).length
   end
 
+  #
+  # Check if a particular doujinshi have some characters
+  #
+  # @see Doujinshi#tags?
+  #
   def characters?
     !@client.body.match(%r{Characters:\s+<span class="tags">(.+)<\/span>}).nil?
   end
 
+  #
+  # Give all artists of a doujinshi
+  #
+  # @see Doujinshi#tags
+  #
   def artists
     res = @client.body.match(%r{Artists:\s+<span class="tags">(.+)<\/span>})
 
     parse_tags(res[1])
   end
 
+  #
+  # Give a counter of artists
+  #
+  # @see Doujinshi#count_tags
+  #
   def count_artists
     res = @client.body.match(%r{Artists:\s+<span class="tags">(.+)<\/span>})
 
     res.nil? ? 0 : parse_tags(res[1]).length
   end
 
+  #
+  # Check if a particular doujinshi have some artists
+  #
+  # @see Doujinshi#tags?
+  #
   def artists?
     !@client.body.match(%r{Artists:\s+<span class="tags">(.+)<\/span>}).nil?
   end
 
+  #
+  # Give all groups of a doujinshi
+  #
+  # @see Doujinshi#tags
+  #
   def groups
     res = @client.body.match(%r{Groups:\s+<span class="tags">(.+)<\/span>})
 
     parse_tags(res[1])
   end
 
+  #
+  # Give a counter of groups
+  #
+  # @see Doujinshi#count_tags
+  #
   def count_groups
     res = @client.body.match(%r{Groups:\s+<span class="tags">(.+)<\/span>})
 
     res.nil? ? 0 : parse_tags(res[1]).length
   end
 
+  #
+  # Check if a particular doujinshi have some groups
+  #
+  # @see Doujinshi#tags?
+  #
   def groups?
     !@client.body.match(%r{Groups:\s+<span class="tags">(.+)<\/span>}).nil?
   end
 
+  #
+  # Give all languages of a doujinshi
+  #
+  # @see Doujinshi#tags
+  #
   def languages
     res = @client.body.match(%r{Languages:\s+<span class="tags">(.+)<\/span>})
 
     parse_tags(res[1])
   end
 
+  #
+  # Give a counter of languages
+  #
+  # @see Doujinshi#count_tags
+  #
   def count_languages
     res = @client.body.match(%r{Languages:\s+<span class="tags">(.+)<\/span>})
 
     res.nil? ? 0 : parse_tags(res[1]).length
   end
 
+  #
+  # Check if a particular doujinshi have some languages
+  #
+  # @see Doujinshi#tags?
+  #
   def languages?
     !@client.body.match(%r{Languages:\s+<span class="tags">(.+)<\/span>}).nil?
   end
 
+  #
+  # Give all categories of a doujinshi
+  #
+  # @see Doujinshi#tags
+  #
   def categories
     res = @client.body.match(%r{Categories:\s+<span class="tags">(.+)<\/span>})
 
     parse_tags(res[1])
   end
 
+  #
+  # Give a counter of categories
+  #
+  # @see Doujinshi#count_tags
+  #
   def count_categories
     res = @client.body.match(%r{Categories:\s+<span class="tags">(.+)<\/span>})
 
     res.nil? ? 0 : parse_tags(res[1]).length
   end
 
+  #
+  # Check if a particular doujinshi have some categories
+  #
+  # @see Doujinshi#tags?
+  #
   def categories?
     !@client.body.match(%r{Categories:\s+<span class="tags">(.+)<\/span>}).nil?
   end
+
+  #
+  # @private
+  #
+
+  private
+
+  def parse_tags(res)
+    res.split(%r{<a(.+?)<\/a>}).reject(&:empty?).map do |line|
+      id    = line.match(/tag-(\d+)/)[1]
+      name  = line.match(/">(.+?)</)[1].strip
+      count = line.match(/\((.+?)\)</)[1].tr(',', '').to_i
+      url   = line.match(/href=\"(.+?)\"/)[1]
+
+      Tag.new(id, name, count, url)
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nhentai-api
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Gael Roussel
@@ -21,6 +21,7 @@ homepage: https://rubygems.org/gems/nhentai-api
 licenses:
 - MIT
 metadata:
+  documentation_uri: https://www.rubydoc.info/github/groussel42/nhentai-api
   source_code_uri: https://github.com/groussel42/nhentai-api
 post_install_message: 
 rdoc_options: []