klaro-client 0.7.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42126059ba59e044d7d25c44aa0a9d86769071ffcea570c564b7e9ddaa0b92c8
-  data.tar.gz: 0af95727702d75a8a7830b920efcd36b43def5642461b46aed86419b9ca71e16
+  metadata.gz: 5e0d58edb131f5c4a730b22fd2be431f152e5a1073e4ab7e5f2bee5e58f2cec1
+  data.tar.gz: 9a85e1f21c2bd441cfb09b21d9cb42113a8dd5f12c84546499206ba4a51d66f5
 SHA512:
-  metadata.gz: a99dbe5bcfba816260d8e68a0174ab48f688b00fa28b98356060fb34ab32e96b97694c402477347b81cb01b56d10fa6f7df0efb2da3d470678fc49ca303ae4f5
-  data.tar.gz: b360ded9145f755cca8249181ffd65eb5c5ee103b061b70ee439ee9703e79262c2f1cf58ae734487ee7e88b47c08c88cf9f914094eb29454bf6721450e528aa2
+  metadata.gz: 7f788fb52455d7166a30dfa75539a028c5f5f8f4710bfa4b39fc10ae4286891d21fd41e62118fbe5d385ea122ab8bb1c4b0ffcf4f2161c88a417e66ee095e7b9
+  data.tar.gz: 281c57cd4b29756c5e041059f609bffe0a9a12d94733952a663aba84b8ea19d65a881be0751dc4ab66078abc7f08574c933637d512c8efb68d1c3baad93ffd05

data/lib/klaro/client/request_handler.rb

@@ -10,6 +10,7 @@ module Klaro
         @token = nil
         @subdomain = nil
         @workspace = nil
+        @caching_options = nil
       end
 
       def authenticated?
@@ -26,6 +27,11 @@ module Klaro
         self
       end
 
+      def with_cache(caching_options)
+        @caching_options = caching_options
+        self
+      end
+
       def authenticate(user, password, workspace = nil)
         @workspace = workspace
         @token = get_token(
@@ -40,12 +46,29 @@ module Klaro
       def get(endpoint, raw = false)
         url = "#{base_url}#{endpoint}"
         info("GET `#{url}`")
-        response = http.get(url, ssl_context: http_ctx)
-        raise Error::NoSuchBoardFound if response.status >= 300 || response.status <200
-
+        response = get_in_cache(url) do
+          res = http.get(url, ssl_context: http_ctx)
+          raise Error::NoSuchBoardFound unless res.status == 200
+          res.to_s
+        end
         raw ? response.to_s : JSON.parse(response.to_s)
       end
 
+      def get_in_cache(url, &bl)
+        return bl.call unless @caching_options
+
+        sha = Digest::SHA1.hexdigest(url)
+        file = @caching_options[:path]/sha
+        if file.file?
+          file.read
+        else
+          str = bl.call
+          file.parent.mkdir_p
+          file.write(str)
+          str
+        end
+      end
+
       def post(endpoint, body)
         url = "#{base_url}#{endpoint}"
         info("POST `#{url}`")
@@ -53,6 +76,7 @@ module Klaro
       end
 
     private
+
       def get_token(response)
         raise Error::AuthenticationFailed if response.status >= 300 || response.status <200
 
@@ -74,8 +98,8 @@ module Klaro
         OpenSSL::SSL::SSLContext.new
       end
 
-      def http
-        Http.headers(http_headers)
+      def http(headers = {})
+        Http.headers(http_headers.merge(headers))
       end
 
       def http_headers

data/lib/klaro/client/version.rb

@@ -2,7 +2,7 @@ module Klaro
   class Client
     module Version
       MAJOR = 0
-      MINOR = 7
+      MINOR = 9
       TINY  = 0
     end
     VERSION = "#{Version::MAJOR}.#{Version::MINOR}.#{Version::TINY}"

data/lib/klaro/client.rb

@@ -2,6 +2,8 @@ require 'http'
 require 'path'
 require 'commonmarker'
 require 'i18n'
+require 'digest'
+require 'ostruct'
 
 module Klaro
   class Client
@@ -11,6 +13,11 @@ module Klaro
       @request = RequestHandler.new(base_url)
     end
 
+    def with_caching(options)
+      @request = request.with_cache(options)
+      self
+    end
+
     def absolute_url(url)
       request.base_url + url
     end
@@ -43,6 +50,13 @@ module Klaro
       Stories.dress(request.get("/api/boards/#{location_or_id}/stories/"), self)
     end
 
+    def board_stories_full(location_or_id)
+      hs = { 'Accept': 'application/vnd+klaro.stories.full+json' }
+      Stories.dress(
+        request.get("/api/boards/#{location_or_id}/stories/", false, hs),
+        self)
+    end
+
     def story(id_or_identifier)
       Story.dress(request.get("/api/stories/#{id_or_identifier}"), self)
     end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: klaro-client
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.9.0
 platform: ruby
 authors:
 - enspirit
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-08 00:00:00.000000000 Z
+date: 2025-02-09 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: dotenv
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.7'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
@@ -50,20 +36,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.26'
+        version: '2.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.26'
+        version: '2.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
@@ -78,6 +64,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: path
   requirement: !ruby/object:Gem::Requirement
@@ -120,8 +120,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.7'
-description: 
-email: 
+description:
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -141,11 +141,11 @@ files:
 - lib/klaro/client/resource/story.rb
 - lib/klaro/client/support/md_text.rb
 - lib/klaro/client/version.rb
-homepage: 
+homepage:
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -160,8 +160,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
-signing_key: 
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
 summary: Klaro Client
 test_files: []