--- !ruby/object:Gem::Specification
name: koko_keywords
version: !ruby/object:Gem::Version
  version: 0.0.1
platform: ruby
authors:
- Kareem Kouddous
autorequire:
bindir: bin
cert_chain: []
date: 2022-03-18 00:00:00.000000000 Z
dependencies:
- !ruby/object:Gem::Dependency
  name: ffi
  requirement: !ruby/object:Gem::Requirement
    requirements:
    - - "~>"
      - !ruby/object:Gem::Version
        version: '1.15'
  type: :runtime
  prerelease: false
  version_requirements: !ruby/object:Gem::Requirement
    requirements:
    - - "~>"
      - !ruby/object:Gem::Version
        version: '1.15'
- !ruby/object:Gem::Dependency
  name: bundler
  requirement: !ruby/object:Gem::Requirement
    requirements:
    - - "<"
      - !ruby/object:Gem::Version
        version: '2.4'
  type: :development
  prerelease: false
  version_requirements: !ruby/object:Gem::Requirement
    requirements:
    - - "<"
      - !ruby/object:Gem::Version
        version: '2.4'
- !ruby/object:Gem::Dependency
  name: rake
  requirement: !ruby/object:Gem::Requirement
    requirements:
    - - "<"
      - !ruby/object:Gem::Version
        version: '13.1'
  type: :development
  prerelease: false
  version_requirements: !ruby/object:Gem::Requirement
    requirements:
    - - "<"
      - !ruby/object:Gem::Version
        version: '13.1'
- !ruby/object:Gem::Dependency
  name: rspec
  requirement: !ruby/object:Gem::Requirement
    requirements:
    - - "<"
      - !ruby/object:Gem::Version
        version: '3.12'
  type: :development
  prerelease: false
  version_requirements: !ruby/object:Gem::Requirement
    requirements:
    - - "<"
      - !ruby/object:Gem::Version
        version: '3.12'
description: "Koko Keyword Python Client\n============\n\nA ruby client  for the [Koko
  Keywords API](https://r.kokocares.org/koko_keywords/docs). The client handles caching
  to ensure very low latency.\n\n\n## Install\n\n```\ngem install koko_keywords\n```\n\n##
  Usage\n\nSet the `KOKO_KEYWORDS_AUTH` environment to the authentication string provided\nby
  Koko (contact us at api@kokocares.org if you would like one).\n\n```\nexport KOKO_KEYWORDS_AUTH=username:password\n```\n\nRequire
  the gem or add it to you Bundle\n\n```py\nrequire 'koko_keywords'\n```\n\nThen use
  the `match` function to check whether a query prompt matches a risky\nkeyword\n\n```py\nKokoKeywords.match(\"sewerslide\")\n```\n\nThere
  are two optional params, `filter` and `version`. \n\n### Filter\nFilter the keyword
  based on the taxonomy using a colon delimited list of “dimension=value” filters.
  Omitting a dimension does not filter by that dimension e.g.\n\n```py\nKokoKeywords.match(\"sewerslide\",
  filter: \"category=eating,parenting:confidence=1,2\")\n```\n\nThis matches \"sewerslide\"
  against eating eating and parenting, with a confidence of 1 and 2 and any intensity
  (as intensity was omitted).\n\n### Version\nUse this to pin to a specific version
  of the regex otherwise the endpoint returns the latest. e.g.\n\n```py\nKokoKeywords.match(\"sewerslide\",
  version: \"20220206\")\n```\n\n## Performance\nThe underlying library is written
  in Rust and cross-compiled to the four major CPU targets. Regexes are cached based
  on the cache expiration headers (currently set to an hour). This ensures very low
  latency and overhead (< 1μs/req).\n\n\n## Error Handling\nA RuntimeError will be
  raised with hints on how to resolve the issue. No exception handling should be necessary.\n\n##
  Logging\nMinimal log messages are logged to STDERR\n\n## License\n\n```\nWWWWWW||WWWWWW\n
  W W W||W W W\n      ||\n    ( OO )__________\n     /  |           \\\n    /o o|
  \   MIT     \\\n    \\___/||_||__||_|| *\n         || ||  || ||\n        _||_||
  _||_||\n       (__|__|(__|__|\n```\n\n(The MIT License)\n\nCopyright (c) 2017 Koko
  AI Inc. <us@kokocares.org>\n\nPermission 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:\n\nThe above copyright notice and
  this permission notice shall be included in all copies or substantial portions of
  the Software.\n\nTHE 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.\n"
email:
- kkouddous@gmail.com
executables: []
extensions: []
extra_rdoc_files: []
files:
- ".gitignore"
- ".rspec"
- ".ruby-version"
- CODE_OF_CONDUCT.md
- Gemfile
- Gemfile.lock
- LICENSE.txt
- README.md
- Rakefile
- bin/console
- bin/setup
- clib/libkoko_arm64.dylib
- clib/libkoko_arm64.so
- clib/libkoko_x86_64.dylib
- clib/libkoko_x86_64.so
- koko_keywords.gemspec
- lib/koko_keywords.rb
- lib/koko_keywords/version.rb
homepage: https://api-docs.kokocares.org
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: []
rubygems_version: 3.3.3
signing_key:
specification_version: 4
summary: A python client  for the Koko Keywords API. The client handles caching to
  ensure very low latency.
test_files: []