kagi-api 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d75c5cc76c25528a0d8b03cdbd37b498c0e3a99f6a349b16fcca2deaf7d997d7
-  data.tar.gz: 8916021276b36793878675e07a17d87c0133c5205a618ccb5df44a787dbc365e
+  metadata.gz: b5a6cd75a9dd52bc9bcdd945345ef999f1e211ba0b58544435cce1febb126127
+  data.tar.gz: 8b8f608ddb63d597d490e7fb226769f771cdc68079e866198e0a9593be0a93b8
 SHA512:
-  metadata.gz: a109a93bda6740d5ff4294c940954717a4d1b7cc143d6ecf4838ab6787b58cce7356e3851344f4fea0d6a247bdaaf492e7b4df0689e81308bb9122daf3ed5164
-  data.tar.gz: a986438e6e5ebc0ccefcca9d6c507c43e635d10e896fa9cf7e214114c9b74e50b4cc9ee972f56449141e42e872b9dab7bbdc5c28d7717d96e935b892bc13bdf2
+  metadata.gz: ae44593cf9d78fe872b948e03afa12bb85002b8a33cf2cf40951ec10fb63ee5ec15024120b3206c8233570f570bc9595ec5f57eb97e1676ad0be71e57d3979f6
+  data.tar.gz: '0934fa25e546489da85eb10ee9efb7611c68652e530fcd088f85c5fbd905e340f1d9639ab5721007aff1162a6ed6cc2305044566bf3fb636674c2e0e2ba6f82c'

data/README.adoc

@@ -10,6 +10,8 @@
 
 A monadic API client for {kagi_link} privacy focused information. This allows you to access the full Kagi API using a fault tolerant pipeline to yield whole value objects (i.e. {data_link}) for immediate interaction within your own applications.
 
+⚠️ *Roughly ~2% of funds go to Yandex search results that Kagi uses in their searches. Unfortunately, Yandex is a Russian company that helps fund corrupt propaganda, the killing of Ukrainians, and other despicable acts. I was not aware of this when I wrote this API client which also violates my software license. More can be found link:https://kagifeedback.org/d/5445-reconsider-yandex-integration-due-to-the-geopolitical-status-quo[here].*
+
 toc::[]
 
 == Features
@@ -61,7 +63,7 @@ This client provides access to multiple endpoints. Each endpoint will answer eit
 
 [source,ruby]
 ----
-client = Kagi::API::Client.new
+client = Kagi::API.new
 
 case client.fast query: "Ruby"
   in Success(payload) then puts payload
@@ -78,7 +80,7 @@ You can configure the client using a block and adjusting the `content_type`, `to
 
 [source,ruby]
 ----
-client = Kagi::API::Client.new do |settings| settings.token = "secret" }
+client = Kagi::API.new do |settings| settings.token = "secret" }
 client.fast query: "Ruby"
 ----
 
@@ -86,7 +88,7 @@ If you don't configure the client, then the following defaults will be used:
 
 [source,ruby]
 ----
-client = Kagi::API::Client.new do |settings|
+client = Kagi::API.new do |settings|
   settings.content_type = "application/json"
   settings.token = nil
   settings.uri = "https://kagi.com/api/v0"

data/kagi-api.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "kagi-api"
-  spec.version = "0.0.0"
+  spec.version = "0.1.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://alchemists.io/projects/kagi-api"
@@ -29,6 +29,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "http", "~> 5.2"
   spec.add_dependency "infusible", "~> 4.3"
   spec.add_dependency "initable", "~> 0.4"
+  spec.add_dependency "inspectable", "~> 0.3"
   spec.add_dependency "pipeable", "~> 1.3"
   spec.add_dependency "zeitwerk", "~> 2.7"
 

data/lib/kagi/api/configuration/content.rb

@@ -1,10 +1,14 @@
 # frozen_string_literal: true
 
+require "inspectable"
+
 module Kagi
   module API
     module Configuration
       # Defines customizable API configuration content.
       Content = Struct.new :content_type, :token, :uri do
+        include Inspectable[token: :redact]
+
         def headers = {"Content-Type" => content_type}.compact
       end
     end

data/lib/kagi/api/endpoints/enrich/news.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "dry/monads"
+require "inspectable"
 require "pipeable"
 
 module Kagi
@@ -19,6 +20,7 @@ module Kagi
 
           include Dry::Monads[:result]
           include Pipeable
+          include Inspectable[contract: :class, error_contract: :class]
 
           def call(**params)
             result = requester.get("enrich/news", **params)

data/lib/kagi/api/endpoints/enrich/web.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "dry/monads"
+require "inspectable"
 require "pipeable"
 
 module Kagi
@@ -19,6 +20,7 @@ module Kagi
 
           include Dry::Monads[:result]
           include Pipeable
+          include Inspectable[contract: :class, error_contract: :class]
 
           def call(**params)
             result = requester.get("enrich/web", **params)

data/lib/kagi/api/endpoints/fast.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "dry/monads"
+require "inspectable"
 require "pipeable"
 
 module Kagi
@@ -18,6 +19,7 @@ module Kagi
 
         include Dry::Monads[:result]
         include Pipeable
+        include Inspectable[contract: :class, error_contract: :class]
 
         def call(**params)
           result = requester.post("fastgpt", **params)

data/lib/kagi/api/endpoints/search.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "dry/monads"
+require "inspectable"
 require "pipeable"
 
 module Kagi
@@ -18,6 +19,7 @@ module Kagi
 
         include Dry::Monads[:result]
         include Pipeable
+        include Inspectable[contract: :class, error_contract: :class]
 
         def call(**params)
           result = requester.get("search", **params)

data/lib/kagi/api/endpoints/summarize.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "dry/monads"
+require "inspectable"
 require "pipeable"
 
 module Kagi
@@ -18,6 +19,7 @@ module Kagi
 
         include Dry::Monads[:result]
         include Pipeable
+        include Inspectable[contract: :class, error_contract: :class]
 
         def call(**params)
           result = requester.post("summarize", **params)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kagi-api
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -119,6 +119,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: inspectable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: pipeable
   requirement: !ruby/object:Gem::Requirement
@@ -214,7 +228,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.8
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A Kagi API client for privacy focused information.
 test_files: []