pixiv 0.0.4 → 0.0.5

data/README.md

@@ -32,6 +32,38 @@ Or install it yourself as:
 
     $ gem install pixiv
 
+## Synopsis
+
+```ruby
+
+pixiv = Pixiv.client('pixiv_id', 'password') {|agent|
+  agent.user_agent_alias = 'Mac Safari'
+}
+
+illust_id = 123
+illust = pixiv.illust(illust_id)
+if illust.manga?
+  pixiv.download_manga(illust, ['manga/', :image_name])
+else
+  pixiv.download_illust(illust, ['illust/', :image_name])
+end
+
+member_id = 456
+member = pixiv.member(member_id)
+member.works.each do |illust|
+  puts illust.title
+  puts illust.caption
+end
+
+me = pixiv.member
+me.bookmarks do |illust|
+  author = illust.member
+  puts author.name
+  puts author.works.count
+end
+
+```
+
 ## Usage
 
 See [a sample script](https://gist.github.com/4362297)

data/console_helper.rb

@@ -51,6 +51,14 @@ def PBL(p = 1)
   $pixiv.private_bookmark_list(p)
 end
 
+def SRL(query, opts = {})
+  $pixiv.search_result_list(query, opts)
+end
+
+def Is(list)
+  $pixiv.illusts(list)
+end
+
 def Ws(member)
   $pixiv.works(member)
 end
@@ -58,3 +66,7 @@ end
 def Bs(member)
   $pixiv.bookmarks(member)
 end
+
+def S(query, opts = {})
+  $pixiv.search(query, opts)
+end

data/lib/pixiv.rb

@@ -1,4 +1,5 @@
 require 'mechanize'
+require 'uri'
 
 module Pixiv
   autoload :BookmarkList,        'pixiv/bookmark_list'
@@ -11,6 +12,7 @@ module Pixiv
   autoload :Page,                'pixiv/page'
   autoload :PageCollection,      'pixiv/page_collection'
   autoload :PrivateBookmarkList, 'pixiv/bookmark_list'
+  autoload :SearchResultList,    'pixiv/search_result_list'
   autoload :WorkList,            'pixiv/work_list'
 
   ROOT_URL = 'http://www.pixiv.net'

data/lib/pixiv/bookmark_list.rb

@@ -8,7 +8,7 @@ module Pixiv
     # @return [Integer]
     lazy_attr_reader(:total_count) {
       node = at!('a[href="/bookmark.php?type=illust_all"]')
-      node.inner_text.match(/\d+/).to_s.to_i
+      node.inner_text[/\d+/].to_i
     }
     # @return [Array<Hash{Symbol=>Object}, nil>]
     lazy_attr_reader(:page_hashes) {
@@ -26,12 +26,12 @@ module Pixiv
       return nil if node.at('img[src*="limit_unknown_s.png"]')
       member_node = node.at('a[href^="member_illust.php?id="]')
       illust_node = node.at('a')
-      illust_id = illust_node['href'].match(/illust_id=(\d+)/).to_a[1].to_i
+      illust_id = illust_node['href'][/illust_id=(\d+)/, 1].to_i
       {
         url: Illust.url(illust_id),
         illust_id: illust_id,
         title: illust_node.inner_text,
-        member_id: member_node['href'].match(/\?id=(\d+)/).to_a[1].to_i,
+        member_id: member_node['href'][/\?id=(\d+)/, 1].to_i,
         member_name: member_node.inner_text,
         small_image_url: illust_node.at('img')['src'],
       }

data/lib/pixiv/client.rb

@@ -83,12 +83,19 @@ module Pixiv
     end
 
     # @param [Pixiv::Member, Integer] member_or_id
-    # @param [Integer] page_num
+    # @param [Integer] page
     # @return [Pixiv::PrivateBookmarkList] private bookmark list bound to +self+
     def private_bookmark_list(member_or_id = member_id, page = 1)
       illust_list_with_class(PrivateBookmarkList, member_or_id, page)
     end
 
+    def search_result_list(query, opts = {})
+      attrs = {query: query, search_opts: opts}
+      SearchResultList.lazy_new(attrs) {
+        agent.get(SearchResultList.url(query, opts))
+      }.bind(self)
+    end
+
     # @param [Pixiv::IllustList] list
     # @!macro [new] opts_and_return
     #   @param [Hash] opts
@@ -119,6 +126,11 @@ module Pixiv
       illusts(private_bookmark_list(member_id, page), opts)
     end
 
+    # (see {SearchResultList.url})
+    def search(query, opts = {})
+      illusts(search_result_list(query, opts))
+    end
+
     # Downloads the image to +io_or_filename+
     # @param [Pixiv::Illust] illust
     # @param [#write, String, Array<String, Symbol, #call>] io_or_filename io or filename or pattern for {#filename_from_pattern}
@@ -209,7 +221,7 @@ module Pixiv
     end
 
     def member_id_from_mypage(doc)
-      doc.at('.profile_area a')['href'].match(/\d+$/).to_s.to_i
+      doc.at('.profile_area a')['href'][/\d+$/].to_i
     end
   end
 

data/lib/pixiv/error.rb

@@ -2,5 +2,6 @@ module Pixiv
   class Error < StandardError; end
   class Error::LoginFailed < Error; end
   class Error::NodeNotFound < Error; end
+  class Error::OutOfBounds < Error; end
 end
 

data/lib/pixiv/illust.rb

@@ -2,6 +2,9 @@
 
 module Pixiv
   class Illust < Page
+    # @!parse
+    # include ::Pixiv::Illust::WithClient
+
     # Returns the URL for given +illust_id+
     # @param [Integer] illust_id
     # @return [String]
@@ -28,14 +31,16 @@ module Pixiv
     lazy_attr_reader(:member_id) { at!('#rpc_u_id')['title'].to_i }
     # @return [String]
     lazy_attr_reader(:member_name) {
-      at!('title').inner_text.match(%r!^「#{Regexp.escape(title)}」/「(.+)」の(?:イラスト|漫画) \[pixiv\]$!).to_a[1]
+      # Note: generally member_name can easily be found at +at('.profile_area a')['title']+
+      # but this is not the case on your own illust page; so this hack.
+      at!('title').inner_text[%r!^「#{Regexp.escape(title)}」/「(.+)」の(?:イラスト|漫画) \[pixiv\]$!, 1]
     }
     # @return [String]
     lazy_attr_reader(:title) { at!('.work-info h1.title').inner_text }
     # @return [Integer, nil]
     lazy_attr_reader(:num_pages) {
       node = doc.at('//ul[@class="meta"]/li[2]')
-      n = node ? node.inner_text.match(/(\d+)P$/).to_a[1] : nil
+      n = node ? node.inner_text[/(\d+)P$/, 1] : nil
       n && n.to_i
     }
     # @return [Array<String>]
@@ -53,6 +58,8 @@ module Pixiv
     lazy_attr_reader(:score) { at!('.score-count').inner_text.to_i }
 
     alias id illust_id
+    alias author_id member_id
+    alias author_name member_name
     alias original_image_referrer original_image_referer # referrer vs. referer
 
     # @return [String]
@@ -74,19 +81,26 @@ module Pixiv
   end
 
   module Illust::WithClient
-    include Page::WithClient
+    include ::Pixiv::Page::WithClient
 
     # @return [Pixiv::Member]
     def member
-      client.member(member_id)
+      attrs = {member_id: member_id, member_name: member_name}
+      Member.lazy_new(attrs) { client.agent.get(Member.url(member_id)) }
     end
 
-    # (see Pixiv::Client#download_illust)
+    alias author member
+
+    # Download illust
+    #
+    # See {Pixiv::Client#download_illust} for the detail.
     def download_illust(io_or_filename, size = :original)
       client.download_illust(self, io_or_filename, size)
     end
 
-    # (see Pixiv::Client#download_manga)
+    # Download manga
+    #
+    # See {Pixiv::Client#download_manga} for the detail.
     def download_manga(pattern, &block)
       client.download_manga(self, pattern, &block)
     end

data/lib/pixiv/illust_list.rb

@@ -1,7 +1,18 @@
 module Pixiv
   # @abstract
   class IllustList < Page
-    include PageCollection
+    # @!parse
+    # include ::Pixiv::IllustList::WithClient
+
+    include ::Pixiv::PageCollection
+
+    def doc
+      unless @doc
+        super
+        check_bounds!
+      end
+      @doc
+    end
 
     # @return [Integer]
     attr_reader :page
@@ -22,18 +33,17 @@ module Pixiv
       page_hashes
     end
 
-    # Ditto.
+    protected
 
-    # URLs extracted from doc
-    # @return [Array<{Symbol=>Object}, nil>]
-    def illust_urls
-      page_urls
+    def check_bounds!
+      max_page = total_count / max_size + 1
+      raise Error::OutOfBounds unless (1..max_page).include?(page)
     end
   end
 
   module IllustList::WithClient
-    include Page::WithClient
-    include Enumerable
+    include ::Pixiv::Page::WithClient
+    include ::Enumerable
 
     # @yieldparam [Illust] illust
     def each
@@ -42,5 +52,16 @@ module Pixiv
         yield Illust.lazy_new(attrs) { client.agent.get(url) }
       end
     end
+
+    # @return [Illust, nil]
+    def next
+      return if last?
+      self.class.lazy_new(next_attrs) { client.agent.get(next_url) }
+    end
+
+    def prev
+      return if first?
+      self.class.lazy_new(next_attrs) { client.agent.get(prev_url) }
+    end
   end
-end
+end

data/lib/pixiv/member.rb

@@ -1,5 +1,8 @@
 module Pixiv
   class Member < Page
+    # @!parse
+    # include ::Pixiv::Member::WithClient
+
     # Returns the URL for given +member_id+
     # @param [Integer] member_id
     # @return [String]
@@ -11,8 +14,11 @@ module Pixiv
     lazy_attr_reader(:name) { at!('.profile_area h2').inner_text }
     # @return [Integer]
     lazy_attr_reader(:member_id) { at!('input[name="user_id"]')['value'].to_i }
-    # return [Integer]
-    lazy_attr_reader(:pixiv_id) { at!('.profile_area img')['src'].match(%r{/profile/([a-z_-]+)/}).to_a[1] }
+    # @return [Integer]
+    lazy_attr_reader(:pixiv_id) { profile_image_url[%r{/profile/([a-z_-]+)/}, 1] }
+    # @return [String]
+    lazy_attr_reader(:profile_image_url) { at!('.profile_area img')['src'] }
+
 
     alias id member_id
 
@@ -21,16 +27,30 @@ module Pixiv
   end
 
   module Member::WithClient
-    include Page::WithClient
+    include ::Pixiv::Page::WithClient
+
+    def work_list(page = 1)
+      client.work_list(self, page)
+    end
+
+    def bookmark_list(page = 1)
+      client.bookmark_list(self, page)
+    end
+
+    def private_bookmark_list(page = 1)
+      client.private_bookmark_list(self, page)
+    end
+
+    def works(page = 1, &block)
+      client.works(self, page, &block)
+    end
 
-    # (see Pixiv::Client#bookmark_list)
-    def bookmark_list(page_num = 1)
-      client.bookmark_list(self, page_num)
+    def bookmarks(page = 1, &block)
+      client.bookmarks(self, page, &block)
     end
 
-    # (see Pixiv::Client#bookmarks)
-    def bookmarks(page_num = 1, &block)
-      client.bookmarks(self, page_num, &block)
+    def private_bookmarks(page = 1, &block)
+      client.private_bookmarks(page, &block)
     end
   end
 end

data/lib/pixiv/owned_illust_list.rb

@@ -5,6 +5,11 @@ module Pixiv
   #
   # Implements common methods for bookmark.php and member_illust.php.
   class OwnedIllustList < IllustList
+    # @!parse
+    # include ::Pixiv::OwnedIllustList::WithClient
+
+    ILLUSTS_PER_PAGE = 20
+
     # Returns the URL for given +member_id+ and +page+
     # @param [Integer] member_id
     # @param [Integer] page
@@ -23,7 +28,7 @@ module Pixiv
     }
     # @return [Integer]
     lazy_attr_reader(:member_id) {
-      doc.body.match(/pixiv\.context\.userId = '(\d+)'/).to_a[1].to_i
+      doc.body[/pixiv\.context\.userId = '(\d+)'/, 1].to_i
     }
 
     # @return [String]
@@ -45,14 +50,25 @@ module Pixiv
     def prev_url
       first? ? nil : self.class.url(member_id, page - 1)
     end
+
+    # @return [Integer]
+    def max_size
+      ILLUSTS_PER_PAGE
+    end
+
+    # @!parse alias owner_id member_id
+    def owner_id; member_id end
   end
 
   module OwnedIllustList::WithClient
-    include IllustList::WithClient
+    include ::Pixiv::IllustList::WithClient
 
     # @return [Pixiv::Member]
     def member
       client.member(member_id)
     end
+
+    # @!parse alias owner member
+    def owner; member end
   end
 end

data/lib/pixiv/page.rb

@@ -1,5 +1,8 @@
 module Pixiv
   class Page
+    # @!parse
+    # include ::Pixiv::Page::WithClient
+
     # A new Page
     # @param [Hash{Symbol=>Object}] attrs
     # @yieldreturn [Nokogiri::XML::Document]

data/lib/pixiv/page_collection.rb

@@ -24,6 +24,14 @@ module Pixiv
       not_implemented!
     end
 
+    def next_attrs
+      {}
+    end
+
+    def prev_attrs
+      {}
+    end
+
     def page_class
       not_implemented!
     end
@@ -32,10 +40,6 @@ module Pixiv
       not_implemented!
     end
 
-    def page_urls
-      page_hashes.map {|h| h[:url] }
-    end
-
     def size
       page_hashes.size
     end
@@ -84,15 +88,18 @@ module Pixiv
       loop do
         yield collection
         next_url = collection.next_url or break
-        collection = collection.class.lazy_new { @client.agent.get(next_url) }
+        next_attrs = collection.next_attrs
+        collection = collection.class.lazy_new(next_attrs) { @client.agent.get(next_url) }
       end
     end
 
-    def count(*item)
-      if item.empty? && !block_given? && @collection.respond_to?(:total_count)
-         @collection.total_count
+    def size
+      if @collection.first? && @collection.respond_to?(:total_count)
+        @collection.total_count
+      elsif @collection.respond_to?(:max_size) && @collection.respond_to?(:total_count)
+        @collection.total_count - (@collection.max_size * (@collection.page - 1))
       else
-        super
+        count { true }
       end
     end
 

data/lib/pixiv/search_result_list.rb

@@ -0,0 +1,128 @@
+module Pixiv
+  class SearchResultList < IllustList
+    ILLUSTS_PER_PAGE = 20
+
+=begin Coming Real Soon Now
+    # @param [String, Array<query>, Set<query>] query
+    #
+    # @option opts [query, nil] :tag (nil) same as +url(query, mode: :tag)+
+    # @option opts [query, nil] :word (nil) same as +url(query, mode: :word)+
+    # @option opts [:tag, :word] :mode (:tag)
+    # @option opts [Boolean] :exact (false) perform exact match (for tag mode only)
+    #
+    # @option opts [:illust, :manga, :both, nil] :type (nil)
+    #   * +:illust+: search only for non-manga illust
+    #    *+:manga+: search only for manga
+    #   * +:both+ or +nil+: search for the both type
+    #
+    # @option opts [:tall, :wide, :square, nil] :ratio (nil)
+    # @option opts [String, nil] :tool tool name
+    # @option opts [Boolean] :r18 (false) X-rated only
+    # @option opts [Date, nil] :since (nil)
+    # @option opts [Integer, nil] :page (nil)
+    #
+    # @option opts [Array<(Integer, Integer)>, nil] :max_size (nil)
+    #   maximum size as +[width, height]+ (either +width+ or +height+ can be +nil+)
+    # @option opts [Array<(Integer, Integer)>, nil] :min_size (nil)
+    #   minimum size as +[width, height]+ (either +width+ or +height+ can be +nil+)
+    # @option opts [:small, :medium, :large, nil] :size (nil)
+    #   * +:small+ for +:max_size => [1000, 1000]+
+    #   * +:medium+ for +:max_size => [3000, 3000], :min_size => [1001, 1001]+
+    #   * +:large+ for +:min_size => +[3001, 3001]+
+    #
+    # @example
+    #   s = SearchResultList
+    #   # Query
+    #   s.url('tag1')
+    #   s.url(%w[tag1 tag2]) # tag1 AND tag2
+    #   s.url([Set.new('tag1', 'tag2'), 'tag3']) # (tag1 OR tag2) AND tag3
+    #   # Mode
+    #   s.url(%w[tag1 tag2]) # implicitly searches by tags
+    #   s.url(%w[tag1 tag2], mode: :tag) # or explicitly
+    #   s.url(tag: %w[tag1 tag2]) # same as above
+    #   s.url('word', mode: :word) # searches by words
+    #   s.url(word: 'word') # same as above
+    #   # Options
+    #   # s.url(%w[tag1 tag2], exact: true, type: :illust, r18: false, size: :large)
+    #
+=end
+
+    #
+    def self.url(query, opts = {})
+      word = URI::encode_www_form({word: query})
+      "#{ROOT_URL}/search.php?s_mode=s_tag&#{word}&p=#{opts[:page] || 1}" # FIXME
+    end
+
+    def initialize(doc_or_doc_creator, attrs = {})
+      raise ArgumentError, "`attrs[:query]' must be present" unless attrs[:query]
+      raise ArgumentError, "`attrs[:search_opts]' must be present" unless attrs[:search_opts]
+      super
+    end
+
+    attr_reader :query
+    attr_reader :search_opts
+
+    lazy_attr_reader(:page) {
+      at!('.pager li.current').inner_text.to_i
+    }
+    lazy_attr_reader(:last?) {
+      doc.at('//nav[@class="pager"]//a[@rel="next"]').nil?
+    }
+    lazy_attr_reader(:total_count) {
+      at!('.info > .count').inner_text.to_i
+    }
+    lazy_attr_reader(:page_hashes) {
+      search!('#search-result li.image').map {|n| hash_from_list_item(n) }
+    }
+
+    def url
+      self.class.url(query, search_opts)
+    end
+
+    def first?
+      page == 1
+    end
+
+    def next_url
+      return if last?
+      opts = search_opts.dup
+      opts[:page] = page + 1
+      self.class.url(query, opts)
+    end
+
+    def prev_url
+      return if first?
+      opts = query_opts.dup
+      opts[:page] = page - 1
+      self.class.url(query, opts)
+    end
+
+    def next_attrs
+      {query: query, search_opts: search_opts, page: page + 1}
+    end
+
+    def prev_attrs
+      {query: query, search_opts: search_opts, page: page - 1}
+    end
+
+    def max_size
+      ILLUSTS_PER_PAGE
+    end
+
+    private
+
+    def hash_from_list_item(node)
+      member_node = node.at('p.user a')
+      illust_node = node.at('a')
+      illust_id = illust_node['href'][/illust_id=(\d+)/, 1].to_i
+      {
+        url: Illust.url(illust_id),
+        illust_id: illust_id,
+        title: illust_node.at('h2').inner_text,
+        member_id: member_node['href'][/\?id=(\d+)/, 1].to_i,
+        member_name: member_node.inner_text,
+        small_image_url: illust_node.at('img')['src'],
+      }
+    end
+  end
+end

data/lib/pixiv/version.rb

@@ -1,3 +1,3 @@
 module Pixiv
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/lib/pixiv/work_list.rb

@@ -8,7 +8,7 @@ module Pixiv
     # @return [Integer]
     lazy_attr_reader(:total_count) {
       node = at!('.layout-cell .count-badge')
-      node.inner_text.match(/\d+/).to_s.to_i
+      node.inner_text[/\d+/].to_i
     }
     # @return [Array<Hash{Symbol=>Object}, nil>]
     lazy_attr_reader(:page_hashes) {
@@ -24,7 +24,7 @@ module Pixiv
     def hash_from_list_item(node)
       return nil if node.at('img[src*="limit_unknown_s.png"]')
       illust_node = node.at('a')
-      illust_id = illust_node['href'].match(/illust_id=(\d+)/).to_a[1].to_i
+      illust_id = illust_node['href'][/illust_id=(\d+)/, 1].to_i
       {
           url: Illust.url(illust_id),
           illust_id: illust_id,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pixiv
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-26 00:00:00.000000000 Z
+date: 2012-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mechanize
@@ -99,6 +99,7 @@ files:
 - lib/pixiv/owned_illust_list.rb
 - lib/pixiv/page.rb
 - lib/pixiv/page_collection.rb
+- lib/pixiv/search_result_list.rb
 - lib/pixiv/version.rb
 - lib/pixiv/work_list.rb
 - pixiv.gemspec
@@ -121,12 +122,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -4267183313172500808
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -4267183313172500808
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -141,4 +148,3 @@ test_files:
 - spec/pixiv/member_spec.rb
 - spec/pixiv/page_spec.rb
 - spec/spec_helper.rb
-has_rdoc: