nico_search 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b310857d9ed1c09d750a0fa04246e87a9133cec8
+  data.tar.gz: 804d1a945517e23c49984659016cadf3e1b8d266
+SHA512:
+  metadata.gz: 682c800aa9f3143235be94e9c7bedace1dc70456bb3301ce0cd2aa4f2a8a5a6979b2219abf11b55313e03bfa9938d74a20ecf160199f8d86014dda650a996a26
+  data.tar.gz: '090e1e5d9d84d1c1f7e4f0e5fee12c1caa63cb2e83cd053ae3c07928bf69acf4e1910e3d4c762107032586c3a625daa071544558fc96a9e172069c402c880088'

data/.gitignore

@@ -0,0 +1,52 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+### https://raw.github.com/github/gitignore/f5875713439b01eb9dd4c50188c7805d4670f4e9/Ruby.gitignore
+
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.14.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in nico_search.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 itkq
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,135 @@
+# NicoSearch
+
+Ruby interface for Niconico search API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nico_search'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nico_search
+
+## Usage
+
+### `NicoSearch::Client#search(service, params)`
+- `service` (String)
+  - Select one from the following:
+    - `video`, `live`, `illust`, `manga`, `book`, `channel`, `channelarticle`, `news`
+- `params` (Hash)
+  - [**required**] `q` (String)
+    - Search keyword (you can use multiple keyword like Google search)
+  - [**required**] `targets` (Array)
+    - Target field to search.
+  - [**required**] `fields` (Array)
+    - Field to be acquired.
+  - [**required**] `_sort` (String)
+    - Field to be used for sorting.
+  - `filters` (Hash)
+  - `_offset` (Integer)
+    - Maximum: 1600
+    - Default: 0
+  - `_limit` (Integer)
+    - Default: 10
+  - `_context` (String)
+    - Application name.
+
+### field
+- contentId
+- title
+- description
+- tags
+- tagsExact
+- categoryTags
+- viewCounter (Integer)
+- mylistCounter (Integer)
+- startTime (Time)
+- thumbnailUrl
+- communityIcon
+- scoreTimeshiftReserved
+- liveStatus
+
+Detailed in: https://www59.atwiki.jp/nicoapi/pages/51.html (Japanese)
+
+### filtering
+#### String
+Example:
+```ruby
+params = {
+  tags: [
+    'hoge', 'fuga'
+  ]
+}
+```
+
+#### Integer or Time
+It can be narrowed down by range. Example:
+```ruby
+params = {
+  filters: {
+    # 1000000 <= viewCounter < 2000000
+    viewCounter: {
+      gte: 1000000,
+      lt: 2000000,
+    }
+  }
+}
+```
+
+
+## Example
+- Get scheduled live broadcast
+  - include '小澤亜李' in title or description or tags
+  - order by startTime limit 2
+```ruby
+require 'nico_search'
+params = {
+  q: '小澤亜李',
+  targets: %w(title description tags),
+  fields: %w(contentId title description tags start_time thumbnailUrl),
+  filters: {
+    startTime: {
+      gte: '2017-03-29T00:00:00-09:00',
+    },
+    liveStatus: 'reserved',
+  },
+  _sort: '+startTime',
+  _limit: 2,
+  _context: 'nigo_search gem',
+}
+NicoSearch::Client.search('live', params)
+# => {"meta"=>{"status"=>200, "totalCount"=>2, "id"=>"c7b7f1cf-e92d-4111-8044-6b9c01a2252c"},
+#  "data"=>
+#   [{"startTime"=>"2017-03-30T21:00:00+09:00",
+#     "description"=>
+#      "自他ともに認めるマイペース声優？大橋彩香が、自由な進行に合わせてくれる優しいゲストを招き、<br />\r\nＭＣとなって“気楽に”＆“等身大で”まわしていく番組、それが…「大橋彩香の へごまわし！」\r\n<br />\r\n大橋彩香自身が興味・関心のあるものだけをクローズアップしつつ極めてマイペースな“まわし”ぶりをお楽しみいただく1時間番組です！<br /><br />\r\n<b>『大橋彩香の へごまわし！』はチャンネル会員向けの生放送番組です。冒頭15分はどなたでも無料でご覧いただけます。チャンネル会員になると最後までご覧いただくことができます。</b><br /><br />\r\n<b>■出演</b><br />\r\nメインMC：大橋彩香<br />\r\nゲスト：小澤亜李<br /><br />\r\n<b>■メッセージ募集中！</b><br />\r\n宛先→hegomawashi@bouncy.jp<br /><br />\r\n<b>■Twitter</b><br />\r\nhttps://twitter.com/hegomawashi<br />\r\n番組ハッシュタグ #へごまわし",
+#     "tags"=>"一般(その他) 大橋彩香 へごまわし バラエティ 大橋彩香のへごまわし！ 声優 小澤亜李 一般",
+#     "contentId"=>"lv294290727",
+#     "title"=>"【ゲスト：小澤亜李】大橋彩香の へごまわし！ 第4回",
+#     "thumbnailUrl"=>"http://nicolive.cdn.nimg.jp/live/simg/img/a382/1145962.999d5e.jpg"},
+#    {"startTime"=>"2017-04-02T19:00:00+09:00",
+#     "description"=>
+#      "<b>名古屋の魅力を発信する『project758』</b> <br /> \r\n<br /> \r\n今回の放送は羽二重 きよめ役小澤亜李さんをゲストにお招きします。\r\n<br />\r\nお楽しみに!\r\n<br /> \r\n<br /> \r\nTwitterアカウント<br /> \r\nhttp://twitter.com/prj758<br /> \r\n<br /> \r\nWebサイト<br /> \r\nhttp://p758.jp<br /> \r\n<br /></b></b>",
+#     "tags"=>"Project758 小澤亜李 一般(その他) 一般",
+#     "contentId"=>"lv294246759",
+#     "title"=>"【ゲスト:小澤亜李】project758 おめでとうSP",
+#     "thumbnailUrl"=>"http://nicolive.cdn.nimg.jp/live/simg/img/a382/1145794.92f99a.jpg"}]}
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/itkq/nico_search.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/nico_search/client.rb

@@ -0,0 +1,72 @@
+require 'net/http'
+require 'cgi'
+require 'json'
+require 'uri'
+
+module NicoSearch
+  class Client
+    ENDPOINT = "http://api.search.nicovideo.jp/api/v2/%s/contents/search".freeze
+    SERVICES = %w(video live illust manga book channel channelarticle news).freeze
+
+    class UnavailableServiceError < StandardError; end
+
+    class << self
+      def search(service, params = {})
+        check_available_service(service)
+        url = ENDPOINT % service
+        get_json(url, params)
+      end
+
+      private
+
+      def get_json(url, params)
+        uri = URI.parse(url)
+        resp = Net::HTTP.start(uri.host, uri.port) do |http|
+          http.open_timeout = 5
+          http.read_timeout = 10
+          http.get(uri.request_uri + query_string(params))
+        end
+
+        resp.value # raise if status code is not 2xx
+
+        json = resp.body
+        JSON.parse(json)
+      end
+
+      def query_string(params)
+        return '' if params.empty?
+
+        '?' + params.map{|k,v|
+          if k == :filters
+            filter_string(v)
+          else
+            "#{k}=#{CGI::escape([v].flatten.join(','))}"
+          end
+        }.join('&')
+      end
+
+      def filter_string(filters)
+        filters.map{|k,v|
+          if v.is_a?(Hash)
+            v.map{|kk,vv|
+              "[#{k}][#{kk}]=#{CGI::escape(vv.to_s)}"
+            }
+          elsif v.is_a?(Array)
+            v.map{|vv|
+              "[#{k}][]=#{CGI::escape(vv.to_s)}"
+            }
+          else
+            "[#{k}][]=#{CGI::escape(v.to_s)}"
+          end
+        }.flatten.map{|s| 'filters' + s}.join('&')
+      end
+
+      def check_available_service(service)
+        unless SERVICES.include?(service)
+          raise UnavailableServiceError
+        end
+      end
+
+    end
+  end
+end

data/lib/nico_search/version.rb

@@ -0,0 +1,3 @@
+module NicoSearch
+  VERSION = "0.1.0"
+end

data/lib/nico_search.rb

@@ -0,0 +1,3 @@
+require "nico_search/client"
+require "nico_search/cli"
+require "nico_search/version"

data/nico_search.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nico_search/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "nico_search"
+  spec.version       = NicoSearch::VERSION
+  spec.authors       = ["itkq"]
+  spec.email         = ["kuogsi@gmail.com"]
+
+  spec.summary       = "Ruby interface for Niconico search API"
+  spec.description   = "Ruby interface for Niconico search API"
+  spec.homepage      = "https://github.com/itkq/nico_search"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "thor"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: nico_search
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- itkq
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Ruby interface for Niconico search API
+email:
+- kuogsi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/nico_search.rb
+- lib/nico_search/client.rb
+- lib/nico_search/version.rb
+- nico_search.gemspec
+homepage: https://github.com/itkq/nico_search
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Ruby interface for Niconico search API
+test_files: []