koko_keywords 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e62d0bc41570d8c6b5305979cfb128fe396c6c2fc1215d793fa664d40269823
-  data.tar.gz: eda1f54501da576ca9ba75b1a44a5d1a6ca4b4ad14f4f42c2afc3bbde498870b
+  metadata.gz: 3be8bce1f1c2e626b8694b3b8eece40131f49cfd29b4abe9aff7ea446f8a3b31
+  data.tar.gz: fe6594fca73d9f817cecfe3c2c0bcca2382f9f9b8f7fce821ed86c3d635bee17
 SHA512:
-  metadata.gz: 1b5fd64a6f799415c392befeee91ec9da48ff19e9a73404d96990b864c871e8069bf25864a590c31a7fd2813d20989e487c50efa5ce515b46716cd36202c3a7e
-  data.tar.gz: d25e6bc6dc5e5e36c3635bbadc467945b73ea3808bcc432caedf017a46e2eb817e643635d2584747bd86a87c89944cf734774857fbfa17eb267c70fe08bf4dd0
+  metadata.gz: db1e3bd803325c8637ee1c715024cda62bd218f96505f183809c54baf7614c6d03db2957e633d5a14b4655f262b436895d3173b1e72ac84daab6661cb3881597
+  data.tar.gz: bebb3ed5aa83ed810b866de08dc09d96938e90ca9b5445623ad2c3535ae7d9b29e4bee375adf7aeb24f0531e5bdc6fafa6f717cc2c9cf29a5a8939ef34b95d32

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,9 +1,8 @@
-Koko Keyword Python Client
+Koko Keyword Ruby Client
 ============
 
 A ruby client  for the [Koko Keywords API](https://developers.kokocares.org). The client handles caching to ensure very low latency.
 
-
 ## Install
 
 ```
@@ -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,19 +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")
-```
-
-We do not recommend setting this as we frequently update keywords for better matching performance. 
-
 ## 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

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   # 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)/}) }
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) } + `ls ../clib`.split("\n").map { |s| "clib/#{s}" }
   end
   spec.require_paths = ["lib"]
 

data/lib/koko_keywords/version.rb

@@ -1,3 +1,3 @@
 module KokoKeywords
-  VERSION = "0.1.0"
+  VERSION = "0.3.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.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Kareem Kouddous
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-22 00:00:00.000000000 Z
+date: 2022-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -85,10 +85,10 @@ files:
 - Rakefile
 - 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
@@ -116,7 +116,7 @@ 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 ruby client for the Koko Keywords API