searchyj 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7dd43ee6cf14a41b52906a501cbcb0035e32cb5c
-  data.tar.gz: 407ba21943c025b50d2882b4f709aaa14fbba083
+  metadata.gz: a23769233d6904d18accdf9c7f560d750f6fd276
+  data.tar.gz: 65ce5afcec37ed5d17ba548c53c63b51c3b2a85b
 SHA512:
-  metadata.gz: 5ac674566cb5abbffb71ba270a7cb75c260b14136d881219eaa1a11a6edc0b4b96b12b2e629fec105d517f4158b31817fee8b273782ed59ed8fb4a421011596f
-  data.tar.gz: 0240303f9607f2b3c2697fa988761e8a5d41cec2290fcab0532a3995c441e48a1440e0848fc1f36db971df879bfe660d3b61d836f63d7d1412d98663eb17056f
+  metadata.gz: 76169acf83749d560ec56b4ab5043d6888aea93c6e88ab238a279972c505c1c7eb8b3a25c293524aa92139cd621f33c2e10e534327a2997b9e30ea8181535086
+  data.tar.gz: e0315aadfb6c7954b04ab5ac08dc2a9484718cca25435db21b1ae0b58253d5e660c7186d091503f37ee13163e9b496557662f861a582725af354c5ec701dbfda

data/README.ja.md

@@ -1,5 +1,4 @@
-SearchYJ
-====
+# SearchYJ
 
 Search on Yahoo Japan.
 
@@ -7,9 +6,9 @@ Search on Yahoo Japan.
 
 Gemfile に次の一行を書き加えてください。
 
-```ruby
+~~~ruby
 gem 'searchyj'
-```
+~~~
 
 そして以下を実行。
 
@@ -24,19 +23,12 @@ gem 'searchyj'
 出力結果は基本的に JSON 形式で、以下のパラメータを持ちます。
 
 - uri
-  - ウェブサイトの URI。
-
-
 - title
-  - ウェブサイトのタイトル。
-  - 検索結果のタイトルをそのまま使っているため、省略形の場合があります。
-
-
+  - 検索結果のタイトルをそのまま収集するため、省略されている場合があります。
 - rank
   - 検索順位。
   - SearchYJ では検索に混じる広告を排除しながらレコードを拾っています。この機能が貧弱なため、多少値がずれることがあります。
 
-
 ### list
 
 検索結果を指定の個数揃えて出力します。
@@ -51,12 +43,11 @@ gem 'searchyj'
 
 一度の検索でこの値に満たなかった場合、この値に届くまで検索を繰り返します。値に到達するより先に検索が最後まで到達した場合には、それまでに集めた検索結果を返します。
 
-未設定時は 10 です。
+省略時の値は 10 です。
 
 #### --from, -f
 
-指定の検索順位から検索を開始します。
-
+指定の順位から検索を開始します。
 
 ### detect
 
@@ -64,19 +55,23 @@ gem 'searchyj'
 
     $ searchyj detect [options] <SearchTerm>
 
-検索にひとつも引っかからない場合は文字列 null が出力されます。
+検索にひとつも引っかからない場合は文字列 _null_ が出力されます。
 
 #### --regexp, -r
 
-マッチさせたい正規表現用の文字列です。
+マッチさせたい正規表現用の文字列です。マッチさせるパラメータの種類は _--key_ オプションに依存しています。
 
 必須です。
 
 #### --key, -k
 
-比較対象のキー名です。 'title' か 'uri' を渡すことができます。
+比較対象のキー名です。 _title_ か _uri_ を渡すことができます。
+
+省略時の値は _title_ です。
 
-未設定時は 'title' となります。
+#### --from, -f
+
+指定の順位から検索を開始します。
 
 ### rank
 
@@ -84,17 +79,17 @@ gem 'searchyj'
 
     $ searchyj rank [options] <SearchTerm>
 
-検索にひとつも引っかからない場合は文字列 null が出力されます。
+検索にひとつも引っかからない場合は文字列 _null_ が出力されます。
 
 #### --rank, -r
 
-出力したい順位です。
+出力したいレコードの順位です。
 
-必須です。
+省略時の値は 1 です。
 
 ## Usage (Programming)
 
-'lib/searchyj.rb' やその他を読んでください。
+_lib/searchyj.rb_ やその他を読んでください。
 
 ## Author
 

data/README.md

@@ -1,15 +1,15 @@
-SearchYJ
-====
+# SearchYJ
 
 Search on Yahoo Japan.
 
-## Installation
+Installation
+----
 
 Add this line to your application's Gemfile:
 
-```ruby
+~~~ruby
 gem 'searchyj'
-```
+~~~
 
 And then execute:
 
@@ -21,85 +21,78 @@ Or install it yourself as:
 
 ## Usage (CLI)
 
-The output format is generally JSON.
-
-It has parameters the followings.
+The format of the search result is JSON which includes parameters the followings.
 
 - uri
-  - The URI of the web site。
-
-
 - title
-  - The title of the web site.
-  - The title might be abbreviation.
-
-
+  - The title might be abbreviated because its source string is from the list of the search result.
 - rank
-  - The rank order in the search ranking.
-  - This number might have a slight error. As a reason for that, SearchYJ pick up the records which has excepted the advertisements in the search result. The exception feature is rough machining yet.
-
+  - The number of the rank order in the search result.
+  - This number might have a slight error. The records collected by SearchYJ is excepted some advertisements from the search result. The feature of exception is rough yet.
 
 ### list
 
-Print the search results that has collected the ordered number.
+Print the search result.
 
     $ searchyj list [options] <SearchTerm>
 
-If the search result was nothing, print a string of an empty Array.
+If the number of the result is none, SearchYJ print an empty array in the form of string.
 
 #### --size, -s
 
-The size of the result records.
+This number is the size of the result records.
 
-If a number of the search result is less than this option's value, search for next page until the sum of the results reach to option's value.
+SearchYJ continues searching and to collecting records until the sum of the records reach the size value.
 
-If reach the end of searching before reach to option's value, print the collected records at that time.
+If searching is over or become unable to get new records, before reach the size value, SearchYJ print the collected records at that time.
 
 The default value is 10.
 
-
 #### --from, -f
 
-Start to search from this number of the search ranking.
-
+The searching process starts from this number of the search ranking.
 
 ### detect
 
-Print a record of the search result that has matched own arguments.
+Get the record matched first with the option value.
 
     $ searchyj detect [options] <SearchTerm>
 
-If the search result was nothing or did not find, print a string of null.
+If the matching record is none, SearchYJ print a _null_ in the form of string.
 
 #### --regexp, -r
 
-A string as a regular expression that want to match with value of a record[key].
+This value is a regular expression to extract from the search result. The matching target in the parameters is depended on the value of _--key_ option.
 
-The option is required.
+The value is required.
 
 #### --key, -k
 
-The key name for comparing values. You can pass any of 'title' or 'uri'. 
+This value is the name of the matching target which a key name of parameters in records. This option receives any of _title_ or _uri_.
+
+The default value is _title_.
+
+#### --from, -f
 
-The default value is 'title'.
+The searching process starts from this number of the search ranking.
 
 ### rank
 
-Print a record of the search result at a particular rank order in the search ranking.
+Print a particular record extracted from the search result by the number of rank order.
 
     $ searchyj rank [options] <SearchTerm>
 
-If the search result was nothing or did not find, print a string of null.
+If the matching record is none, SearchYJ print a _null_ in the form of string.
 
 #### --rank, -r
 
-The rank order in the search ranking.
+This value is the number of rank order in the search result.
 
-The option is required.
+The default value is _1_.
 
 ## Usage (Programming)
 
-Please read 'lib/searchyj.rb' and others.
+Please read _lib/searchyj.rb_ and others.
 
 ## Author
 

data/TODO.md

@@ -1,8 +1,4 @@
-TODO
-====
+# TODO
 
-## Feature
-
-- Use cookie.
-  - Increase the fetching records at once.
-  
+- HTTPS
+- RSpec

data/lib/searchyj.rb

@@ -5,18 +5,18 @@ require "searchyj/cli"
 module SearchYJ
   module_function
 
-  def list(term, size = 10, start_index = 1)
+  def list(term, size = 10, **args)
     mgr = SearchYJ::Main.new
-    mgr.list(term, size, start_index)
+    mgr.list(term, size, args)
   end
 
-  def rank(term, rank)
+  def rank(term, rank, **args)
     mgr = SearchYJ::Main.new
-    mgr.rank(term, rank)
+    mgr.rank(term, rank, args)
   end
 
-  def detect(term, regexp, key = :title)
+  def detect(term, regexp, key = :title, **args)
     mgr = SearchYJ::Main.new
-    mgr.detect(term, regexp, key)
+    mgr.detect(term, regexp, key, args)
   end
 end

data/lib/searchyj/cli.rb

@@ -4,66 +4,78 @@ require 'json'
 
 module SearchYJ
   class CLI < Thor
+    class_option \
+        :from,
+        type:    :numeric,
+        default: 1,
+        aliases: '-f',
+        desc: \
+            'The searching process starts ' \
+            'from this number of the search ranking.'
+
     desc 'detect',
-         "Detect a first record that\n" \
-         'meet the conditions of a regexp and a key.'
+         "Get the record matched first with the option value."
     option :regexp,
            type:     :string,
            required: true,
            aliases:  '-r',
-           desc:     'Regexp that want to match with value of a record'
+           desc:     'Regexp to extract from the search result.'
     option :key,
            type:    :string,
            default: 'title',
            aliases: '-k',
            desc: \
-               'The key name for comparing values. ' \
-               'You can pass any of \'title\' or \'uri\'. '
+               "The key name of the matching target\n" \
+               "This option receives any of 'title' or 'uri'."
     def detect(term)
-      key    = options[:key]
-      regexp = Regexp.new(options[:regexp])
+      opt    = symbolized_options
+      key    = opt.delete(:key)
+      regexp = Regexp.new(opt.delete(:regexp))
 
       puts JSON.dump(
-          SearchYJ.detect(term, regexp, key)
+          SearchYJ.detect(term, regexp, key, opt)
       )
     end
 
     desc 'list',
-         'Get records of the search result.'
+         'Print the search result.'
     option :size,
            type:    :numeric,
            default: 10,
            aliases: '-s',
            desc:    'The size of the returner'
-    option :from,
-           type:    :numeric,
-           default: 1,
-           aliases: '-f',
-           desc: \
-               'Start to search from this number of the search ranking'
     def list(term)
-      size = options[:size]
-      from = options[:from]
+      opt  = symbolized_options
+      size = opt.delete(:size)
 
       puts JSON.dump(
-          SearchYJ.list(term, size, from)
+          SearchYJ.list(term, size, opt)
       )
     end
 
     desc 'rank',
-         "Get a record in the search result\n" \
-         'at a particular rank order in the search ranking.'
+         "Print a particular record extracted " \
+         "from the search result by the number of rank order."
     option :rank,
            type:     :numeric,
-           required: true,
+           default:  1,
            aliases:  '-r',
            desc:     'The rank order in the search ranking'
     def rank(term)
-      rank = options[:rank]
+      opt  = symbolized_options
+      rank = opt.delete(:rank)
 
       puts JSON.dump(
-          SearchYJ.rank(term, rank)
+          SearchYJ.rank(term, rank, opt)
       )
     end
+
+    private
+
+    def symbolized_options
+      options.map do |key, value|
+        [key.to_sym, value]
+      end.to_h
+    end
   end
 end

data/lib/searchyj/main.rb

@@ -11,10 +11,10 @@ module SearchYJ
     # @return [Hash]
     #   A result record if matched the arguments
     #   Else nil
-    def detect(term, regexp, key = :title)
+    def detect(term, regexp, key = :title, **args)
       key = key.to_sym unless key.is_a?(Symbol)
 
-      searcher = Searcher.new
+      searcher = Searcher.new(args)
       searcher.uri.search_term = term
       searcher.pager.size      = 100
 
@@ -30,15 +30,13 @@ module SearchYJ
     # Get records of the search result.
     # @param term [String]  Search term
     # @param size [Integer] The size of the returner
-    # @param from [Integer]
-    #   Start to search from this number of the search ranking
+    # @param args [Hash]
     #
     # @return [Array]
     #   Includes the result records
-    def list(term, size = 10, start_index = 1)
-      searcher = Searcher.new
+    def list(term, size = 10, **args)
+      searcher = Searcher.new(args)
       searcher.uri.search_term = term
-      searcher.uri.index       = start_index
       searcher.pager.size      = size
       list = []
 
@@ -58,8 +56,9 @@ module SearchYJ
     # @return [Hash]
     #   A result record if matched the arguments
     #   Else nil
-    def rank(term, rank)
-      result = list(term, 1, rank)
+    def rank(term, rank, **args)
+      args[:from] = rank
+      result = list(term, 1, args)
       (result.size > 0) ? result[0] : nil
     end
   end

data/lib/searchyj/searcher.rb

@@ -19,8 +19,6 @@ module SearchYJ
         :limit_loop, :user_agent, :sleep_time
 
     ENCODING   = 'UTF-8'
-    LIMIT_LOOP = 50
-    SLEEP_TIME = 1
     USER_AGENT = \
         'Mozilla/5.0 (Windows NT 6.1; WOW64; rv:38.0)' \
         'Gecko/20100101 Firefox/38.0'
@@ -28,13 +26,29 @@ module SearchYJ
     OpenUriError = Class.new(StandardError)
 
     # Initialize myself.
-    def initialize
+    # @param encoding [String]
+    #   The character encoding that is used to parse HTML
+    # @param from [Integer]
+    #   Start to search from this number of the search ranking
+    # @param sleep_time [Integer]
+    #   The time of sleep after fetching from internet
+    # @param limit_loop [Integer]
+    #   The number of limit that is connectable in one process
+    # @param user_agent [String]
+    #   Specify the user agent when open uri
+    def initialize(
+        encoding:   ENCODING,
+        from:       1,
+        sleep_time: 1,
+        limit_loop: 50,
+        user_agent: USER_AGENT)
       @pager      = PageSizeAdjuster.new
       @uri        = UriManager.new
-      @encoding   = ENCODING
-      @limit_loop = LIMIT_LOOP
-      @sleep_time = SLEEP_TIME
-      @user_agent = USER_AGENT
+      @uri.index  = from
+      @encoding   = encoding
+      @limit_loop = limit_loop
+      @sleep_time = sleep_time
+      @user_agent = user_agent
     end
 
     def run(&block)

data/lib/searchyj/version.rb

@@ -1,3 +1,3 @@
 module SearchYJ
-  VERSION = "0.6.0"
+  VERSION = "0.6.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: searchyj
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - indeep-xyz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-23 00:00:00.000000000 Z
+date: 2015-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri