koko_keywords 0.0.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ce6aee9f3257cdc04c2f66d5c9f613c34ed87a963c9bf941ed507c52d4dbb7e
-  data.tar.gz: 3e031c08ab38963a593b2d77a7f1a25d6d7e58c73b9b7b700975e61b6d7f51bd
+  metadata.gz: e6adf016d74f8bd31fef826d4c86fd5f060b262f8a8b038b12f785a1a3bd22eb
+  data.tar.gz: 70565ac34a07715655fd7e26b93fa43d98bd656b64f0b7197e0a6867407180aa
 SHA512:
-  metadata.gz: fe3a1962ae2adb1ba181ee4e331caa0e4e7b18a04d5880258a69e3a76bb9994ccd511b86f00db4e9a5941fc0df8cf7bd1989088899b19fba0c60fcc25ef5a8a8
-  data.tar.gz: 585366f7875451afb5a75e8c747852e8811d3befcd811898a3000d7431a466f41a856af0fdc43c358b6861aadb29accc2d9842fbfa0d4aad4c13098e53fbfe8e
+  metadata.gz: d9398455e9b4152c94404f5acde8f14ddaa722e50f64d52e3d959761e13e72cf08e3c7f0ff8f7086dbe8d8f70ef8c0b126872a150061b427d0a3a16331dff46b
+  data.tar.gz: e400993968f25eae29896432fc1010ea62968c8407f4a180e190bd29696f68144567da39537d7930456193913847c1f5771b5390dc3743e45d1eccfda255e77f

data/.ruby-version

@@ -1 +1 @@
-3.1.0
+3.1.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    koko_keywords (0.0.1)
+    koko_keywords (0.1.0)
       ffi (~> 1.15)
 
 GEM
@@ -25,6 +25,7 @@ GEM
     rspec-support (3.11.0)
 
 PLATFORMS
+  arm64-darwin-20
   arm64-darwin-21
 
 DEPENDENCIES
@@ -34,4 +35,4 @@ DEPENDENCIES
   rspec (< 3.12)
 
 BUNDLED WITH
-   2.3.9
+   2.3.11

data/README.md

@@ -1,8 +1,7 @@
-Koko Keyword Python Client
+Koko Keyword Ruby Client
 ============
 
-A ruby client  for the [Koko Keywords API](https://r.kokocares.org/koko_keywords/docs). The client handles caching to ensure very low latency.
-
+A ruby client  for the [Koko Keywords API](https://developers.kokocares.org). The client handles caching to ensure very low latency.
 
 ## Install
 
@@ -13,7 +12,7 @@ gem install koko_keywords
 ## Usage
 
 Set the `KOKO_KEYWORDS_AUTH` environment to the authentication string provided
-by Koko (contact us at api@kokocares.org if you would like one).
+by Koko. To get an api key, complete our [sign up form](https://r.kokocares.org/api_signup).
 
 ```
 export KOKO_KEYWORDS_AUTH=username:password
@@ -32,7 +31,7 @@ keyword
 KokoKeywords.match("sewerslide")
 ```
 
-There are two optional params, `filter` and `version`. 
+There is one optional params, `filter`. 
 
 ### Filter
 Filter 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.
@@ -43,17 +42,9 @@ KokoKeywords.match("sewerslide", filter: "category=eating,parenting:confidence=1
 
 This matches "sewerslide" against eating eating and parenting, with a confidence of 1 and 2 and any intensity (as intensity was omitted).
 
-### Version
-Use this to pin to a specific version of the regex otherwise the endpoint returns the latest. e.g.
-
-```py
-KokoKeywords.match("sewerslide", version: "20220206")
-```
-
 ## Performance
 The 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).
 
-
 ## Error Handling
 A RuntimeError will be raised with hints on how to resolve the issue. No exception handling should be necessary.
 

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.2.0"
 end

data/lib/koko_keywords.rb

@@ -7,16 +7,18 @@ module KokoKeywords
     def self.lib_path
       uname = Etc.uname
 
+      filename = 'libkoko_keywords'
+
       if ENV["KOKO_LIB_PATH"]
           return ENV["KOKO_LIB_PATH"]
       elsif uname[:sysname] == 'Darwin' and uname[:machine] == 'arm64'
-          filename = 'libkoko_arm64.dylib'
+          filename = filename + '_arm64.dylib'
       elsif uname[:sysname] == 'Darwin' and uname[:machine] == 'x86_64'
-          filename = 'libkoko_x86_64.dylib'
+          filename = filename + '_x86_64.dylib'
       elsif uname[:sysname] == 'Linux' and uname[:machine] == 'x86_64'
-          filename = 'libkoko_x86_64.so'
+          filename = filename + '_x86_64.so'
       elsif uname[:sysname] == 'Linux' and uname[:machine] == 'arm64'
-          filename = 'libkoko_arm64.so'
+          filename = filename + '_arm64.so'
       else
         raise RuntimeError("Unsupported platform #{uname[:sysname]}, #{uname[:machine]} contact api@kokocares.org for support")
       end
@@ -26,23 +28,16 @@ module KokoKeywords
 
     extend FFI::Library
     ffi_lib lib_path
-    attach_function :c_koko_keywords_match, [:string, :string, :string], :int
+    attach_function :c_koko_keywords_match, [:string, :string], :int
+    attach_function :c_koko_keywords_error_description, [:int], :string
   end
 
 
-  def self.match(text, filters: "", version: nil)
-    match_value = NativeWrapper.c_koko_keywords_match(text, filters, version)
+  def self.match(text, filters: "")
+    match_value = NativeWrapper.c_koko_keywords_match(text, filters)
 
-    if match_value == -1
-      raise RuntimeError.new("KOKO_KEYWORDS_AUTH must be set before importing the library")
-    elsif match_value == -2
-      raise RuntimeError.new("Invalid credentials. Please confirm you are using valid credentials, contact us at api.kokocares.org if you need assistance.")
-    elsif match_value == -3
-      raise RuntimeError.new("Unable to refresh cache. Please try again or contact us at api.kokocares.org if this issue persists.")
-    elsif match_value == -4
-      raise RuntimeError.new("Unable to parse response from API. Please contact us at api.kokocares.org if this issue persists.")
-    elsif match_value == -5
-      raise RuntimeError.new("Invalid url. Please ensure the url used is valid.")
+    if match_value < 0
+      raise RuntimeError.new(NativeWrapper.c_koko_keywords_error_description(match_value))
     end
 
     !match_value.zero?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: koko_keywords
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Kareem Kouddous
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-18 00:00:00.000000000 Z
+date: 2022-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -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: []
@@ -120,16 +86,22 @@ files:
 - bin/console
 - bin/setup
 - clib/libkoko_arm64.dylib
-- clib/libkoko_arm64.so
-- clib/libkoko_x86_64.dylib
-- clib/libkoko_x86_64.so
+- clib/libkoko_keywords_arm64.dylib
+- clib/libkoko_keywords_arm64.so
+- clib/libkoko_keywords_x86_64.dylib
+- clib/libkoko_keywords_x86_64.so
 - koko_keywords.gemspec
 - lib/koko_keywords.rb
 - lib/koko_keywords/version.rb
 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:
@@ -145,9 +117,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.7
 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: []