koko_keywords 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ce6aee9f3257cdc04c2f66d5c9f613c34ed87a963c9bf941ed507c52d4dbb7e
-  data.tar.gz: 3e031c08ab38963a593b2d77a7f1a25d6d7e58c73b9b7b700975e61b6d7f51bd
+  metadata.gz: 3aadfea96947cbf401385d94e65dcfbe8d9a4defd9eadf57dd9cac46e8b9a63e
+  data.tar.gz: e8138d816e62343b6f5f5b7b508e43fb7a0a8ff5f8fef5eda7bf901f5466f69f
 SHA512:
-  metadata.gz: fe3a1962ae2adb1ba181ee4e331caa0e4e7b18a04d5880258a69e3a76bb9994ccd511b86f00db4e9a5941fc0df8cf7bd1989088899b19fba0c60fcc25ef5a8a8
-  data.tar.gz: 585366f7875451afb5a75e8c747852e8811d3befcd811898a3000d7431a466f41a856af0fdc43c358b6861aadb29accc2d9842fbfa0d4aad4c13098e53fbfe8e
+  metadata.gz: '010670498399fb89f3600e4886917431775e7d727cd3c6d82dd401035301c9518cd467d92dfc9b615d0d580fa9cc78dbc486473e8d76fc40c6bfdf890e851370'
+  data.tar.gz: a750eed1189eb9f4ca7a3adcf5c58248013c63703cd7e54167cafc36c8d56459f6b5e95d9114862e973aaf0550f3afbae3f5a3d651534205b445472b07521b37

data/koko_keywords.gemspec

@@ -9,10 +9,17 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Kareem Kouddous"]
   spec.email         = ["kkouddous@gmail.com"]
 
-  spec.summary       = "A python client  for the Koko Keywords API. The client handles caching to ensure very low latency."
-  spec.description   = File.open('README.md').read
+  spec.summary       = "A ruby client for the Koko Keywords API"
+  spec.description   = "A ruby client for the Koko Keywords API. The client handles caching to ensure very low latency."
   spec.homepage      = "https://api-docs.kokocares.org"
   spec.license       = "MIT"
+  spec.metadata      = {
+    'bug_tracker_uri' => 'https://github.com/kokocares/keywords-client/issues',
+    'changelog_uri' => 'https://api-docs.kokocares.org/docs/changelog',
+    'documentation_uri' => 'https://api-docs.kokocares.org/docs/python',
+    'homepage_uri' => 'https://api-docs.kokocares.org',
+    "source_code_uri" => "https://github.com/kokocares/keywords-client/tree/main/clients/ruby"
+  }
 
   # 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.

data/lib/koko_keywords/version.rb

@@ -1,3 +1,3 @@
 module KokoKeywords
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: koko_keywords
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Kareem Kouddous
@@ -66,42 +66,8 @@ dependencies:
     - - "<"
       - !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"
+description: A ruby client for the Koko Keywords API. The client handles caching to
+  ensure very low latency.
 email:
 - kkouddous@gmail.com
 executables: []
@@ -129,7 +95,12 @@ files:
 homepage: https://api-docs.kokocares.org
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/kokocares/keywords-client/issues
+  changelog_uri: https://api-docs.kokocares.org/docs/changelog
+  documentation_uri: https://api-docs.kokocares.org/docs/python
+  homepage_uri: https://api-docs.kokocares.org
+  source_code_uri: https://github.com/kokocares/keywords-client/tree/main/clients/ruby
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -148,6 +119,5 @@ 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.
+summary: A ruby client for the Koko Keywords API
 test_files: []