cinii 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bdddfda97f7ce4c7b87252fe855ee475709426aea97af3ec34e63a18058c223c
+  data.tar.gz: 694ead145ae17211646dc394633a1e1ddaf601bd31faef6a7859e3ee5f5b7e83
+SHA512:
+  metadata.gz: 473165ce82370e7e47145a52873d16ea4285af9c19cf5c150edcb37dce5c3876c5c6bb453ea514a325ab4ca3480cee524cdf26af9dbeb66a5de0d9fed41637ea
+  data.tar.gz: '00187c8dbeedd3eba48fb8932fddb6806719f1f6a763a4fdb5d96a2a493771d3c6853390abcaf3c5c76b91d98565e321cef0c70079bbee3dec0118b217334cf7'

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.idea

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.17.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at nashirox@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in cinii-ruby.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,42 @@
+PATH
+  remote: .
+  specs:
+    cinii (0.1.0)
+      faraday
+      faraday_middleware
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    faraday (0.15.4)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.13.1)
+      faraday (>= 0.7.4, < 1.0)
+    multipart-post (2.0.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  cinii!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Daisuke Nashiro
+
+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,171 @@
+# Cinii
+
+Cinii API client library, written in Ruby
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cinii'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cinii
+
+https://support.nii.ac.jp/ja/cinii/api/developer
+
+## Usage
+### CiNii Articles
+#### Initialization
+
+```ruby
+client = Cinii::Client::Article.new(app_id: 'YOUR_APP_ID')
+```
+
+#### Search article
+
+```ruby
+result = client.list_articles(q: 'computer science')
+#=> Cinii::SearchResult::Article object
+
+# First article in search result
+article = result.items.first
+#=> Cinii::Item::Article object
+# 
+# Article title
+article.title
+#=> "Effect of storage and aging conditions on the flexural strength and flexural modulus of CAD/CAM materials"
+
+article.link
+#=> "https://ci.nii.ac.jp/naid/130007529119"
+```
+#### Full-text search
+Just pass `full_text: true` to `list_articles` method.
+
+```ruby
+result = client.list_articles(q: 'computer science', full_text: true)
+```
+
+#### Search author
+
+```ruby
+result = client.list_authors(q: '山中伸弥')
+#=> Cinii::SearchResult::Article object
+
+author = result.items.first
+#=> Cinii::Item::Author object
+
+author.link
+#=> "https://ci.nii.ac.jp/nrid/1000010295694"
+```
+
+### CiNii Books
+#### Initialization
+```ruby
+# Initialization
+client = Cinii::Client::Book.new(app_id: 'YOUR_APP_ID')
+```
+
+#### Search books
+
+```ruby
+result = client.list_books(q: '機械学習')
+#=> Cinii::SearchResult::Book object
+
+book = result.items.first
+#=> Cinii::Item::Book object
+
+book.title
+#=> "Rによる機械学習入門"
+
+book.link
+#=> "http://ci.nii.ac.jp/ncid/BB24928243"
+```
+
+#### Search authors
+
+```ruby
+result = client.list_authors(name: '山中')
+#=> Cinii::SearchResult::Book object
+```
+
+#### Search libraries
+
+```ruby
+result = client.list_libraries(name: '東京')
+#=> Cinii::SearchResult::Book object
+
+library = result.items[10]
+#=> Cinii::Item::Library object
+
+library.title
+#=> "東京音楽大学 付属図書館"
+```
+
+#### Search holders
+
+```ruby
+result = client.list_holders(ncid: 'BB24928243')
+#=> Cinii::SearchResult::Book object
+
+library = result.items[25]
+#=> Cinii::Item::Library object
+
+library.title
+#=> "島根大学 附属図書館"
+```
+
+### CiNii Dissertation
+#### Initialization
+```ruby
+# Initialization
+client = Cinii::Client::Dissertation.new(app_id: 'YOUR_APP_ID')
+```
+
+#### Search dissertation
+
+```ruby
+result = client.list_dissertations(author: '落合, 陽一')
+#=> Cinii::SearchResult::Book object
+
+dissertation = result.items.first
+#=> Cinii::Item::Dissertation object
+
+dissertation.title
+#=> "Graphics by Computational Acoustic Fields"
+
+dissertation.publisher
+#=> "University of Tokyo(東京大学)"
+
+dissertation.source
+#=> [{:id=>"http://dl.ndl.go.jp/info:ndljp/pid/10981946", :title=>"NDLデジタルコレクション"}, {:id=>"http://hdl.handle.net/2261/00072859", :title=>"東京大学"}]
+```
+
+## TODO
+- Add test
+- Write API documents
+- Add rest of Web API
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/nashirox/cinii. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Cinii project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/cinii-ruby/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cinii"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cinii.gemspec

@@ -0,0 +1,42 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "cinii/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "cinii"
+  spec.version       = Cinii::VERSION
+  spec.authors       = ["Daisuke Nashiro"]
+  spec.email         = ["nashirox@gmail.com"]
+
+  spec.summary       = %q{Cinii API cilent library, Written in Ruby}
+  spec.description   = %q{Cinii API cilent library, Written in Ruby}
+  spec.homepage      = "https://github.com/nashirox/cinii-ruby"
+  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["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/nashirox/cinii-ruby"
+    spec.metadata["changelog_uri"] = "https://github.com/nashirox/cinii-ruby"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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 "faraday"
+  spec.add_runtime_dependency "faraday_middleware"
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/cinii.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday_middleware'
+
+require 'cinii/version'
+require 'cinii/client'
+require 'cinii/search_result'
+require 'cinii/item'

data/lib/cinii/client.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'cinii/client/base'
+require 'cinii/client/article'
+require 'cinii/client/book'
+require 'cinii/client/dissertation'

data/lib/cinii/client/article.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module Cinii
+  class Client
+    class Article < Base
+      ARTICLE_REQUIRED_KEYS = %I(
+          q title author author_id issn publisher affiliation journal volume
+          issue page references year_from year_to
+        )
+
+      # https://support.nii.ac.jp/ja/cia/api/a_opensearch
+      # https://support.nii.ac.jp/ja/cia/api/a_opensearch_full
+      def list_articles(**params)
+        if params[:full_text] == true
+          raise ArgumentError unless has_required_params?(params, [:q])
+
+          response = send_get('/opensearch/fulltext', full_text_params(params))
+        else
+          raise ArgumentError unless has_required_params?(params, ARTICLE_REQUIRED_KEYS)
+
+          response = send_get('/opensearch/search', article_params(params))
+        end
+
+        Cinii::SearchResult::Article.new(response)
+      end
+
+      # https://support.nii.ac.jp/ja/cia/api/a_opensearch_auth
+      def list_authors(**params)
+        raise ArgumentError unless has_required_params?(params, [:q])
+
+        response = send_get('/opensearch/author', author_params(params))
+
+        Cinii::SearchResult::Article.new(response)
+      end
+
+      # https://support.nii.ac.jp/ja/cia/api/a_json
+      def article(naid)
+        raise 'Not implemented yet.'
+
+        response = send_get("/naid/#{naid}")
+      end
+
+      # https://support.nii.ac.jp/ja/cia/api/a_json_auth
+      def author(nrid)
+        raise 'Not implemented yet.'
+
+        response = send_get("/nrid/#{nrid}")
+      end
+
+      private
+
+        def article_params(params)
+          {
+            q:           params[:q],
+            count:       params[:count],
+            lang:        params[:lang],
+            start:       params[:start],
+            title:       params[:title],
+            author:      params[:author],
+            authorid:    params[:author_id],
+            issn:        params[:issn],
+            publisher:   params[:publisher],
+            affiliation: params[:affiliation],
+            journal:     params[:journal],
+            volume:      params[:volume],
+            issue:       params[:issue],
+            page:        params[:page],
+            references:  params[:references],
+            year_from:   params[:year_from],
+            year_to:     params[:year_to],
+            range:       params[:range],
+            sortorder:   params[:sortorder]
+          }.compact
+        end
+
+        def full_text_params(params)
+          {
+            q:         params[:q],
+            count:     params[:count],
+            lang:      params[:lang],
+            start:     params[:start],
+            sortorder: params[:sortorder]
+          }.compact
+        end
+
+        def author_params(params)
+          {
+            q:         params[:q],
+            count:     params[:count],
+            lang:      params[:lang],
+            start:     params[:start],
+            sortorder: params[:sortorder]
+          }.compact
+        end
+    end
+  end
+end

data/lib/cinii/client/base.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require 'cinii/errors'
+
+module Cinii
+  class Client
+    class Base
+      def initialize(app_id: nil)
+        @app_id = app_id
+      end
+
+      def send_get(path, params = nil)
+        send_request(:get, path, params)
+      end
+
+      def has_required_params?(params, required_keys)
+        !!required_keys.find { |p| params[p] }
+      end
+
+      private
+
+        def send_request(method, path, params = nil)
+          params = params ? default_params.merge(params) : default_params
+          response = cinii_connection.send(method, path, params)
+          raise RemoteURLNotAvailableError, "#{path} is not available." unless response.status == 200
+          response
+        end
+
+        def cinii_connection
+          @cinii_connection ||= Faraday.new(faraday_options) do |con|
+            con.request  :json
+            con.response :json
+            con.adapter  Faraday.default_adapter
+            con.response :logger do | logger |
+              logger.filter(/(appid=)(\w+)/,'\1[REMOVED]')
+            end
+          end
+        end
+
+        def default_params
+          {
+            appid:  app_id,
+            format: 'json'
+          }
+        end
+
+        def faraday_options
+          {
+            url: faraday_url,
+            headers: faraday_headers
+          }
+        end
+
+        def faraday_url
+          'https://ci.nii.ac.jp'
+        end
+
+        def faraday_headers
+          {
+            'Accept'       => 'application/json',
+            'User-Agent'   => "Cinii Ruby Gem #{Cinii::VERSION}"
+          }
+        end
+
+        def app_id
+          @app_id || ENV['CINII_APP_ID']
+        end
+    end
+  end
+end

data/lib/cinii/client/book.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+module Cinii
+  class Client
+    class Book < Base
+      # https://support.nii.ac.jp/ja/cib/api/b_opensearch
+      def list_books(**params)
+        response = send_get('/books/opensearch/search', book_params(params))
+        Cinii::SearchResult::Book.new(response)
+      end
+
+      # https://support.nii.ac.jp/ja/cib/api/b_opensearch_auth
+      def list_authors(**params)
+        raise ArgumentError unless has_required_params?(params, [:name])
+
+        response = send_get('/books/opensearch/author', author_params(params))
+        Cinii::SearchResult::Book.new(response)
+      end
+
+      # https://support.nii.ac.jp/ja/cib/api/b_opensearch_lib
+      def list_libraries(**params)
+        raise ArgumentError unless has_required_params?(params, [:name])
+
+        response = send_get('/books/opensearch/library', library_params(params))
+        Cinii::SearchResult::Book.new(response)
+      end
+
+      # https://support.nii.ac.jp/ja/cib/api/b_opensearch_hold
+      def list_holders(**params)
+        raise ArgumentError unless has_required_params?(params, [:ncid])
+
+        response = send_get('/books/opensearch/holder', holder_params(params))
+        Cinii::SearchResult::Book.new(response)
+      end
+
+      # https://support.nii.ac.jp/ja/cib/api/b_json
+      def book(ncid)
+        raise 'Not implemented yet.'
+      end
+
+      # https://support.nii.ac.jp/ja/cib/api/b_json_auth
+      def author(author_id)
+        raise 'Not implemented yet.'
+      end
+
+      # https://support.nii.ac.jp/ja/cib/api/b_json
+      def library(library_id)equal?
+        raise 'Not implemented yet.'
+      end
+
+      private
+
+        def book_params(params)
+          {
+            q:             params[:q],
+            title:         params[:title],
+            title_exact:   params[:title_exact],
+            include_utl:   params[:include_utl],
+            author:        params[:author],
+            include_alias: params[:include_alias],
+            publisher:     params[:publisher],
+            subject:       params[:subject],
+            note:          params[:note],
+            authorid:      params[:author_id],
+            utid:          params[:utid],
+            isbn:          params[:isbn],
+            issn:          params[:issn],
+            ncid:          params[:ncid],
+            clas:          params[:clas],
+            gmd:           params[:gmd],
+            lang:          params[:lang],
+            fano:          params[:fano],
+            kid:           params[:kid],
+            area:          params[:area],
+            year_from:     params[:year_from],
+            year_to:       params[:year_to],
+            type:          params[:type],
+            sortorder:     params[:sortorder],
+            p:             params[:page],
+            count:         params[:count]
+          }.compact
+        end
+
+        def author_params(params)
+          {
+            name:      params[:name],
+            sortorder: params[:sortorder],
+            p:         params[:page],
+            count:     params[:count]
+          }.compact
+        end
+
+        def library_params(params)
+          author_params(params)
+        end
+
+        def holder_params(params)
+          {
+            ncid:       params[:ncid],
+            ill:        params[:ill],
+            ill_stat:   params[:ill_stat],
+            ill_copys:  params[:ill_copys],
+            ill_loans:  params[:ill_loans],
+            ill_faxs:   params[:ill_faxs],
+            ill_oclc:   params[:ill_oclc],
+            ill_keris:  params[:ill_keris],
+            ill_offset: params[:ill_offset],
+            fano:       params[:fano],
+            year:       params[:year],
+            vol:        params[:vol],
+            issue:      params[:issue],
+            count:      params[:count]
+          }.compact
+        end
+    end
+  end
+end

data/lib/cinii/client/dissertation.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Cinii
+  class Client
+    class Dissertation < Base
+      # https://support.nii.ac.jp/ja/cid/api/d_opensearch
+      def list_dissertations(**params)
+        response = send_get('/d/search', dissertation_params(params))
+        Cinii::SearchResult::Dissertation.new(response)
+      end
+
+      # https://support.nii.ac.jp/ja/cid/api/d_json
+      def book(naid)
+        raise 'Not implemented yet.'
+      end
+
+      private
+
+        def dissertation_params(params)
+          {
+            q:           params[:q],
+            title:       params[:title],
+            description: params[:description],
+            author:      params[:author],
+            grantor:     params[:grantor],
+            grantorid:   params[:grantor_id],
+            grantid:     params[:grant_id],
+            degreename:  params[:degree_name],
+            year_from:   params[:year_from],
+            year_to:     params[:year_to],
+            fulltext:    params[:full_text],
+            range:       params[:range],
+            sortorder:   params[:sortorder],
+            p:           params[:page],
+            count:       params[:count]
+          }.compact
+        end
+    end
+  end
+end

data/lib/cinii/errors.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Cinii
+  class CiniiError < StandardError; end
+  class RemoteURLNotAvailableError < CiniiError; end
+  class APIResponseError < CiniiError; end
+  class UnKnownResponseTypeError < CiniiError; end
+end

data/lib/cinii/item.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'cinii/item/base'
+require 'cinii/item/article'
+require 'cinii/item/author'
+require 'cinii/item/book'
+require 'cinii/item/dissertation'
+require 'cinii/item/library'

data/lib/cinii/item/article.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Cinii
+  class Item
+    class Article < Base
+      attr_reader :creator, :publisher, :publication_date, :publication_name,
+                  :issn, :volume, :number, :starting_page, :ending_page, :page_range,
+                  :description
+
+      def initialize(item)
+        @creator          = item['dc:creator'].map { |c| c['@value'] }
+        @publisher        = item['dc:publisher']
+        @publication_date = item['prism:publicationDate']
+        @publication_name = item['prism:publicationName']
+        @issn             = item['prism:issn']
+        @volume           = item['prism:volume']
+        @number           = item['prism:number']
+        @starting_page    = item['prism:startingPage']
+        @ending_page      = item['prism:endingPage']
+        @page_range       = item['prism:pageRange']
+        @description      = item['description']
+
+        super(item)
+      end
+    end
+  end
+end

data/lib/cinii/item/author.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Cinii
+  class Item
+    class Author < Base
+      attr_reader :description, :subject
+
+      def initialize(item)
+        @description = item['description']
+        @subject     = item['dc:subject']
+
+        super(item)
+      end
+    end
+  end
+end

data/lib/cinii/item/base.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Cinii
+  class Item
+    class Base
+      attr_reader :id, :type, :title, :link, :see_also, :date
+
+      def initialize(item)
+        @id       = item['@id']
+        @type     = item['@type']
+        @title    = item['title']
+        @link     = item['link']['@id']
+        @see_also = item['rdfs:seeAlso']['@id']
+        @date     = item['dc:date']
+      end
+    end
+  end
+end

data/lib/cinii/item/book.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Cinii
+  class Item
+    class Book < Base
+      attr_reader :creator, :publisher, :publication_date, :is_part, :has_part, :owner_count
+
+      def initialize(item)
+        @publisher        = item['dc:publisher']
+        @publication_date = item['prism:publicationDate']
+        @creator          = item['dc:creator']
+        @is_part          = item['dcterms:isPartOf']&.map { |c| { id: c['@id'], title: c['dc:title']} }
+        @has_part         = item['dcterms:hasPart']&.map { |c| c['@id'] }
+        @owner_count      = item['cinii:ownerCount']
+
+        super(item)
+      end
+    end
+  end
+end

data/lib/cinii/item/dissertation.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Cinii
+  class Item
+    class Dissertation < Base
+      attr_reader :creator, :publisher, :degree_name, :dissertation_number, :source
+
+      def initialize(item)
+        @creator             = item['dc:creator'].map { |c| c['@value'] }
+        @publisher           = item['dc:publisher']
+        @degree_name         = item['ndl:degreeName']
+        @dissertation_number = item['ndl:dissertationNumber']
+        @source              = item['dc:source']&.map { |c| { id: c['@id'], title: c['dc:title']} }
+
+        super(item)
+      end
+    end
+  end
+end

data/lib/cinii/item/library.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Cinii
+  class Item
+    class Library < Base
+      def initialize(item)
+        super(item)
+      end
+    end
+  end
+end

data/lib/cinii/search_result.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'cinii/search_result/base'
+require 'cinii/search_result/article'
+require 'cinii/search_result/book'
+require 'cinii/search_result/dissertation'

data/lib/cinii/search_result/article.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Cinii
+  class SearchResult
+    class Article < Base
+      def items
+        items = graph['items']
+
+        @items ||= items ? items.map { |i| item_class.new(i) } : []
+      end
+
+      private
+
+        def item_class
+          case title
+          when /CiNii OpenSearch/
+            Cinii::Item::Article
+          when /CiNii Author OpenSearch/
+            Cinii::Item::Author
+          when /CiNii FullText OpenSearch/
+            Cinii::Item::Article
+          else
+            raise UnKnownResponseTypeError
+          end
+        end
+    end
+  end
+end

data/lib/cinii/search_result/base.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require 'date'
+
+module Cinii
+  class SearchResult
+    class Base
+      def initialize(faraday_response)
+        @raw_body = faraday_response.body
+
+        raise APIResponseError, 'レスポンスに@graph属性が含まれていません' unless body['@graph']
+      end
+
+      def items
+        raise 'This method must be overridden.'
+      end
+
+      # タイトル
+      def title
+        @title ||= graph['title']
+      end
+
+      # タイトルと同じ
+      def description
+        @description ||= graph['description']
+      end
+
+      # リクエストURI
+      def link
+        @link ||= graph['link']['@id']
+      end
+
+      # 検索日時
+      def date
+        @date ||= DateTime.parse(graph['dc:date'])
+      end
+
+      # 検索結果総数
+      def total_items
+        @total_items ||= graph['opensearch:totalResults'].to_i
+      end
+
+      # 検索結果の開始番号
+      def start_index
+        @start_index ||= graph['opensearch:startIndex'].to_i
+      end
+
+      # 検索結果件数
+      def items_per_page
+        @items_per_page ||= graph['opensearch:itemsPerPage'].to_i
+      end
+
+      # 現在のページ数
+      def current_page
+        (start_index.to_f / items_per_page.to_f).ceil
+      end
+
+      # 全てのページ数
+      def total_pages
+        (total_items.to_f / items_per_page.to_f).ceil
+      end
+
+      # 最初のページ判定
+      def first_page?
+        start_index.between?(1, items_per_page)
+      end
+
+      # 最終ページ判定
+      def last_page?
+        start_index.between?(last_page_start_index, total_items)
+      end
+
+      # 次ページの開始番号
+      def next_page_start_index
+        start_index + items_per_page
+      end
+
+      # 前ページの開始番号
+      def prev_page_start_index
+        index = start_index - items_per_page
+        index >= 1 ? index : 1
+      end
+
+      # 最終ページの開始番号
+      def last_page_start_index
+        total_items - items_per_page
+      end
+
+      private
+
+        def body
+          @raw_body
+        end
+
+        def graph
+          body['@graph'].first
+        end
+    end
+  end
+end

data/lib/cinii/search_result/book.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Cinii
+  class SearchResult
+    class Book < Base
+      def items
+        items = graph['items']
+
+        @items ||= items ? items.map { |i| item_class.new(i) } : []
+      end
+
+      private
+
+      def item_class
+        case title
+        when /CiNii Books OpenSearch/
+          Cinii::Item::Book
+        when /CiNii Books Author/
+          Cinii::Item::Author
+        when /CiNii Books Library/
+          Cinii::Item::Library
+        when /CiNii Books Holder/
+          Cinii::Item::Library
+        else
+          raise UnKnownResponseTypeError
+        end
+      end
+    end
+  end
+end

data/lib/cinii/search_result/dissertation.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Cinii
+  class SearchResult
+    class Dissertation < Base
+      def items
+        items = graph['items']
+
+        @items ||= items ? items.map { |i| Cinii::Item::Dissertation.new(i) } : []
+      end
+    end
+  end
+end

data/lib/cinii/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Cinii
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: cinii
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daisuke Nashiro
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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: faraday_middleware
+  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.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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: Cinii API cilent library, Written in Ruby
+email:
+- nashirox@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cinii.gemspec
+- lib/cinii.rb
+- lib/cinii/client.rb
+- lib/cinii/client/article.rb
+- lib/cinii/client/base.rb
+- lib/cinii/client/book.rb
+- lib/cinii/client/dissertation.rb
+- lib/cinii/errors.rb
+- lib/cinii/item.rb
+- lib/cinii/item/article.rb
+- lib/cinii/item/author.rb
+- lib/cinii/item/base.rb
+- lib/cinii/item/book.rb
+- lib/cinii/item/dissertation.rb
+- lib/cinii/item/library.rb
+- lib/cinii/search_result.rb
+- lib/cinii/search_result/article.rb
+- lib/cinii/search_result/base.rb
+- lib/cinii/search_result/book.rb
+- lib/cinii/search_result/dissertation.rb
+- lib/cinii/version.rb
+homepage: https://github.com/nashirox/cinii-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/nashirox/cinii-ruby
+  source_code_uri: https://github.com/nashirox/cinii-ruby
+  changelog_uri: https://github.com/nashirox/cinii-ruby
+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: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: Cinii API cilent library, Written in Ruby
+test_files: []