cotoha 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7d75565f18d6d0e4add6af4cee5d4888abd1800d53d88f825e0588f66658b9b3
+  data.tar.gz: af67aa75718d6f410ab55b4278ceafac6b9eb72e47220261547d328b61bdbe30
+SHA512:
+  metadata.gz: 5c5969e24220a18f1505ff382d34dae419b3265cc09973cba630bc67124cf5172eec021f060c6be5abcd64a1eff3409d731d7e49d7aa2ff590edadce9d888d14
+  data.tar.gz: f057e2b4a3f69f5b367f7f3ad8875493c519b23c48aca7bf9170c4eca2a38241789dd19f8d5083d3c18fa0957b95ef2792416c291d63b6ebf94e6aad4281df0b

data/.github/workflows/rspec.yml

@@ -0,0 +1,20 @@
+name: RSpec
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - name: Build and test with RSpec
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bundle exec rspec

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+/vendor
+Gemfile.lock

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 2.1.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 tanaka.kentaro.kk1222@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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in cotoha.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem "webmock"
+gem "vcr"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 tanaken0515
+
+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,88 @@
+# Cotoha
+
+[COTOHA API](https://api.ce-cotoha.com/contents/index.html) client for Ruby (unofficial)
+
+![RSpec](https://github.com/tanaken0515/cotoha-ruby/workflows/RSpec/badge.svg?branch=master)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cotoha'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install cotoha
+
+## Usage
+
+### Authentication
+
+```ruby
+# https://api.ce-cotoha.com/home  
+client_id = 'xxxxx'
+client_secret = 'xxxxx'
+
+client = Cotoha::Client.new(client_id: client_id, client_secret: client_secret)
+client.create_access_token
+# => {"access_token"=>"xxxxx", "token_type"=>"bearer", "expires_in"=>"86399", "scope"=>"", "issued_at"=>"1582159764808"}
+```
+
+Or, if you have identified the token in advance, 
+
+```ruby
+client = Cotoha::Client.new(token: 'xxxxx')
+```
+
+### Supported API Endpoints
+`cotoha` gem provides APIs as instance method.
+
+Example:
+```ruby
+client.user_attribute(document: '渋谷でエンジニアとして働いています。')
+# {"result"=>
+#   {"civilstatus"=>"既婚",
+#    "hobby"=>["COOKING", "INTERNET", "MOVIE", "SHOPPING"],
+#    "location"=>"関東",
+#    "moving"=>["RAILWAY"],
+#    "occupation"=>"会社員"},
+#  "status"=>0,
+#  "message"=>"OK"}
+
+client.sentiment(sentence: 'ゲームをするのが好きです。')
+# {"result"=>
+#   {"sentiment"=>"Positive",
+#    "score"=>0.4714220003626205,
+#    "emotional_phrase"=>[{"form"=>"好きです", "emotion"=>"P"}]},
+#  "status"=>0,
+#  "message"=>"OK"}
+```
+
+Refer to the [lib/cotoha/endpoint](https://github.com/tanaken0515/cotoha-ruby/tree/master/lib/cotoha/endpoint) for the list of all available endpoints.
+
+Also check out the official [API reference \| COTOHA API](https://api.ce-cotoha.com/contents/reference/apireference.html).
+
+## 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/tanaken0515/cotoha-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/cotoha/blob/master/CODE_OF_CONDUCT.md).
+
+
+## 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 Cotoha project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/cotoha/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 "cotoha"
+
+# 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/cotoha.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/cotoha/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cotoha"
+  spec.version       = Cotoha::VERSION
+  spec.authors       = ["tanaken0515"]
+  spec.email         = ["tanaka.kentaro.kk1222@gmail.com"]
+
+  spec.summary       = %q{COTOHA API client for Ruby}
+  spec.description   = %q{COTOHA API client for Ruby}
+  spec.homepage      = "https://github.com/tanaken0515/cotoha-ruby"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # 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_dependency 'faraday', '~> 0.17'
+  spec.add_dependency 'faraday_middleware'
+end

data/lib/cotoha.rb

@@ -0,0 +1,5 @@
+require 'cotoha/version'
+require 'cotoha/client'
+
+module Cotoha
+end

data/lib/cotoha/client.rb

@@ -0,0 +1,17 @@
+require 'cotoha/connection'
+require 'cotoha/endpoint'
+
+module Cotoha
+  class Client
+    include Connection
+    include Endpoint
+    BASE_URL = 'https://api.ce-cotoha.com'
+
+    def initialize(url: nil, client_id: nil, client_secret: nil, token: nil)
+      @url = url || BASE_URL
+      @client_id = client_id
+      @client_secret = client_secret
+      @token = token
+    end
+  end
+end

data/lib/cotoha/connection.rb

@@ -0,0 +1,45 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'cotoha/error'
+
+module Cotoha
+  module Connection
+    def get(path, **params)
+      request(:get, path, params)
+    end
+
+    def post(path, **params)
+      request(:post, path, params)
+    end
+
+    def put(path, **params)
+      request(:put, path, params)
+    end
+
+    def delete(path, **params)
+      request(:delete, path, params)
+    end
+
+    private
+
+    def request(method, path, params)
+      response = connection.public_send(method, path, params) do |request|
+        request.headers['Authorization'] = "Bearer #{@token}" if @token
+      end
+
+      error = Error.from_response(response)
+      raise error if error
+
+      response.body
+    end
+
+    def connection
+      @connection ||= Faraday.new(url: @url) do |c|
+        c.request :json
+        c.response :json, content_type: /\bjson$/
+        c.adapter Faraday.default_adapter
+        c.headers['User-Agent'] = "Cotoha Ruby Gem #{VERSION} (#{RUBY_ENGINE}#{RUBY_VERSION})"
+      end
+    end
+  end
+end

data/lib/cotoha/endpoint.rb

@@ -0,0 +1,29 @@
+require 'cotoha/endpoint/access_token'
+require 'cotoha/endpoint/parse'
+require 'cotoha/endpoint/named_entity'
+require 'cotoha/endpoint/coreference'
+require 'cotoha/endpoint/keyword'
+require 'cotoha/endpoint/similarity'
+require 'cotoha/endpoint/sentence_type'
+require 'cotoha/endpoint/user_attribute'
+require 'cotoha/endpoint/remove_filler'
+require 'cotoha/endpoint/misrecognition'
+require 'cotoha/endpoint/sentiment'
+require 'cotoha/endpoint/summary'
+
+module Cotoha
+  module Endpoint
+    include AccessToken
+    include Parse
+    include NamedEntity
+    include Coreference
+    include Keyword
+    include Similarity
+    include SentenceType
+    include UserAttribute
+    include RemoveFiller
+    include Misrecognition
+    include Sentiment
+    include Summary
+  end
+end

data/lib/cotoha/endpoint/access_token.rb

@@ -0,0 +1,13 @@
+module Cotoha
+  module Endpoint
+    module AccessToken
+      def create_access_token(**params)
+        params = {grantType: 'client_credentials', clientId: @client_id, clientSecret: @client_secret}.merge(params)
+        response = post('/v1/oauth/accesstokens', **params)
+        response.tap do |res|
+          @token = res['access_token']
+        end
+      end
+    end
+  end
+end

data/lib/cotoha/endpoint/coreference.rb

@@ -0,0 +1,9 @@
+module Cotoha
+  module Endpoint
+    module Coreference
+      def coreference(document:, type: nil, do_segment: false)
+        post('/api/dev/nlp/v1/coreference', document: document, type: type, do_segment: do_segment)
+      end
+    end
+  end
+end

data/lib/cotoha/endpoint/keyword.rb

@@ -0,0 +1,16 @@
+module Cotoha
+  module Endpoint
+    module Keyword
+      def keywords(document:, type: nil, do_segment: false, max_keyword_num: nil, dic_type: nil)
+        params = {
+          document: document,
+          type: type,
+          do_segment: do_segment,
+          max_keyword_num: max_keyword_num,
+          dic_type: dic_type
+        }
+        post('/api/dev/nlp/v1/keyword', **params)
+      end
+    end
+  end
+end

data/lib/cotoha/endpoint/misrecognition.rb

@@ -0,0 +1,9 @@
+module Cotoha
+  module Endpoint
+    module Misrecognition
+      def detect_misrecognition(sentence:)
+        post('/api/dev/nlp/beta/detect_misrecognition', sentence: sentence)
+      end
+    end
+  end
+end

data/lib/cotoha/endpoint/named_entity.rb

@@ -0,0 +1,9 @@
+module Cotoha
+  module Endpoint
+    module NamedEntity
+      def named_entities(sentence:, type: nil, dict_type: nil)
+        post('/api/dev/nlp/v1/ne', sentence: sentence, type: type, dict_type: dict_type)
+      end
+    end
+  end
+end

data/lib/cotoha/endpoint/parse.rb

@@ -0,0 +1,9 @@
+module Cotoha
+  module Endpoint
+    module Parse
+      def parse(sentence:, type: nil, dict_type: nil)
+        post('/api/dev/nlp/v1/parse', sentence: sentence, type: type, dict_type: dict_type)
+      end
+    end
+  end
+end

data/lib/cotoha/endpoint/remove_filler.rb

@@ -0,0 +1,9 @@
+module Cotoha
+  module Endpoint
+    module RemoveFiller
+      def remove_filler(text:, do_segment: false)
+        post('/api/dev/nlp/beta/remove_filler', text: text, do_segment: do_segment)
+      end
+    end
+  end
+end

data/lib/cotoha/endpoint/sentence_type.rb

@@ -0,0 +1,9 @@
+module Cotoha
+  module Endpoint
+    module SentenceType
+      def sentence_type(sentence:, type: nil)
+        post('/api/dev/nlp/v1/sentence_type', sentence: sentence, type: type)
+      end
+    end
+  end
+end

data/lib/cotoha/endpoint/sentiment.rb

@@ -0,0 +1,9 @@
+module Cotoha
+  module Endpoint
+    module Sentiment
+      def sentiment(sentence:)
+        post('/api/dev/nlp/v1/sentiment', sentence: sentence)
+      end
+    end
+  end
+end

data/lib/cotoha/endpoint/similarity.rb

@@ -0,0 +1,9 @@
+module Cotoha
+  module Endpoint
+    module Similarity
+      def similarity(s1:, s2:, type: nil, dic_type: nil)
+        post('/api/dev/nlp/v1/similarity', s1: s1, s2: s2, type: type, dic_type: dic_type)
+      end
+    end
+  end
+end

data/lib/cotoha/endpoint/summary.rb

@@ -0,0 +1,9 @@
+module Cotoha
+  module Endpoint
+    module Summary
+      def summary(document:, sent_len:)
+        post('/api/dev/nlp/beta/summary', document: document, sent_len: sent_len)
+      end
+    end
+  end
+end

data/lib/cotoha/endpoint/user_attribute.rb

@@ -0,0 +1,9 @@
+module Cotoha
+  module Endpoint
+    module UserAttribute
+      def user_attribute(document:, type: nil, do_segment: false)
+        post('/api/dev/nlp/beta/user_attribute', document: document, type: type, do_segment: do_segment)
+      end
+    end
+  end
+end

data/lib/cotoha/error.rb

@@ -0,0 +1,45 @@
+module Cotoha
+  class Error < StandardError
+    def self.from_response(response)
+      klass =
+        case response.status
+          when 400 then BadRequest
+          when 401 then Unauthorized
+          when 403 then Forbidden
+          when 404 then NotFound
+          when 400..499 then ClientError
+          when 500 then InternalServerError
+          when 502 then BadGateway
+          when 503 then ServiceUnavailable
+          when 500..599 then ServerError
+          else nil
+        end
+      klass.new(response) if klass
+    end
+
+    def initialize(response = nil)
+      @response = response
+      super(build_error_message)
+    end
+
+    private
+
+    def build_error_message
+      return nil if @response.nil?
+
+      "#{@response.env.method.upcase} #{@response.env.url}: " \
+      "#{@response.status} - #{@response.body}"
+    end
+  end
+
+  class ClientError < Error; end
+  class BadRequest < Error; end
+  class Unauthorized < Error; end
+  class Forbidden < Error; end
+  class NotFound < Error; end
+
+  class ServerError < Error; end
+  class InternalServerError < Error; end
+  class BadGateway < Error; end
+  class ServiceUnavailable < Error; end
+end

data/lib/cotoha/version.rb

@@ -0,0 +1,3 @@
+module Cotoha
+  VERSION = "0.2.0"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: cotoha
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- tanaken0515
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-02-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+- !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'
+description: COTOHA API client for Ruby
+email:
+- tanaka.kentaro.kk1222@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/rspec.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cotoha.gemspec
+- lib/cotoha.rb
+- lib/cotoha/client.rb
+- lib/cotoha/connection.rb
+- lib/cotoha/endpoint.rb
+- lib/cotoha/endpoint/access_token.rb
+- lib/cotoha/endpoint/coreference.rb
+- lib/cotoha/endpoint/keyword.rb
+- lib/cotoha/endpoint/misrecognition.rb
+- lib/cotoha/endpoint/named_entity.rb
+- lib/cotoha/endpoint/parse.rb
+- lib/cotoha/endpoint/remove_filler.rb
+- lib/cotoha/endpoint/sentence_type.rb
+- lib/cotoha/endpoint/sentiment.rb
+- lib/cotoha/endpoint/similarity.rb
+- lib/cotoha/endpoint/summary.rb
+- lib/cotoha/endpoint/user_attribute.rb
+- lib/cotoha/error.rb
+- lib/cotoha/version.rb
+homepage: https://github.com/tanaken0515/cotoha-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/tanaken0515/cotoha-ruby
+  source_code_uri: https://github.com/tanaken0515/cotoha-ruby
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: COTOHA API client for Ruby
+test_files: []