klaro-client 0.4.2 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54667fabd1bba720bee0b48f06b3b458848d4a6c89fc2a0555885fa6212dca97
-  data.tar.gz: e0d420d06f919d06a33ed4ab4320bb694a44000f938e084027c215b232a9f6a7
+  metadata.gz: aff7c0b9a6e72271bf8ee2cba3f1e26e7756ed2c8bf04281dd7e77543ab2dc69
+  data.tar.gz: e7465eb2440bfb672ea28e3b28a0230574645e340df369f52b5b312689ac5cfe
 SHA512:
-  metadata.gz: 7eae47d9090069b8e31e1bd727572efe05573ad60f01bc18ee69658b493c91b5f399b807789ca5fd9b1982aba2e467a69dbbf5f94ff49000d228fc91cf46c2c8
-  data.tar.gz: 106659a3ca72d394e31b1fa6e56e7d60b807f9e95d3e58147f9d963d30d178efe3afc0934ebc82f13f13efbc2756961791de87845bcf0e480944efcede357ed0
+  metadata.gz: bbe36e8a3f91eefb31cb1024e2f7232f972d781d3127cba53e11c72b8b73638c27ad624506d24e49ae214c8167e981a595104b7b46b3ddb31f65d7570253b14c
+  data.tar.gz: 89383833c59d6923706040ec8641252beee2822bb7d7b1451b3d22497eb16e61562aee044d06ad08af40da24b0890d7b281d398a764b7e489b02712e11d99d01

data/lib/klaro/client.rb

@@ -11,32 +11,40 @@ module Klaro
       @request = RequestHandler.new(base_url)
     end
 
+    def absolute_url(url)
+      request.base_url + url
+    end
+
     def with_token(*args, &bl)
       request.with_token(*args, &bl)
     end
 
+    def with_project(*args, &bl)
+      request.with_project(*args, &bl)
+    end
+
     def login(*args, &bl)
       request.authenticate(*args, &bl)
     end
 
     def dimension(code_or_id)
-      Dimension.dress(request.get("/api/dimensions/#{code_or_id}"))
+      Dimension.dress(request.get("/api/dimensions/#{code_or_id}"), self)
     end
 
     def dimensions
-      Dimensions.dress(request.get('/api/dimensions'))
+      Dimensions.dress(request.get('/api/dimensions'), self)
     end
 
     def board(location_or_id)
-      Board.dress(request.get("/api/boards/#{location_or_id}"))
+      Board.dress(request.get("/api/boards/#{location_or_id}"), self)
     end
 
     def board_stories(location_or_id)
-      Stories.dress(request.get("/api/boards/#{location_or_id}/stories/"))
+      Stories.dress(request.get("/api/boards/#{location_or_id}/stories/"), self)
     end
 
     def story(id_or_identifier)
-      Story.dress(request.get("/api/stories/#{id_or_identifier}"))
+      Story.dress(request.get("/api/stories/#{id_or_identifier}"), self)
     end
 
     def upload_image(image_path)

data/lib/klaro/client/request_handler.rb

@@ -6,8 +6,9 @@ module Klaro
       attr_reader :base_url, :token
 
       def initialize(url)
-        @base_url = url
+        @base_url = url.gsub(/\/api\/?$/, "")
         @token = nil
+        @subdomain = nil
       end
 
       def authenticated?
@@ -19,6 +20,11 @@ module Klaro
         self
       end
 
+      def with_project(subdomain)
+        @subdomain = subdomain
+        self
+      end
+
       def authenticate(user, password)
         @token = get_token Http
         .headers({
@@ -65,12 +71,16 @@ module Klaro
       end
 
       def http
-        Http.headers(
-          {
-            "Authorization" => @token,
-            "Content-Type" => "application/json"
-          }
-        )
+        Http.headers(http_headers)
+      end
+
+      def http_headers
+        hs = {
+          "Authorization" => @token,
+          "Content-Type" => "application/json"
+        }
+        hs['Klaro-Project-Subdomain'] = @subdomain if @subdomain
+        hs
       end
 
       def info(msg)

data/lib/klaro/client/resource.rb

@@ -2,16 +2,32 @@ module Klaro
   class Client
     class Resource < OpenStruct
 
-      class << self
-        alias :dress :new
+      def initialize(data, client)
+        super(data)
+        @client = client
       end
 
+      class << self
+
+        def symbolize_keys(data)
+          Hash[data.each_pair.map{|k,v|
+            [k.to_sym, v]
+          }]
+        end
+
+        def dress(data, client)
+          new(symbolize_keys(data), client)
+        end
+
+      end # class << self
+
     end # class Resource
     class Collection
       include Enumerable
 
-      def initialize(items)
+      def initialize(items, client)
         @items = items.map{|i| self.class.dress_one(i) }
+        @client = client
       end
 
       def each(*args, &bl)
@@ -26,7 +42,7 @@ module Klaro
         end
 
         def dress_one(item)
-          @item_class.dress(item)
+          @item_class.dress(item, @client)
         end
       end
 
@@ -34,6 +50,7 @@ module Klaro
   end # class Client
 end # module Klaro
 require_relative 'resource/story'
+require_relative 'resource/attachment'
 require_relative 'resource/stories'
 require_relative 'resource/dimension'
 require_relative 'resource/dimension_value'

data/lib/klaro/client/resource/attachment.rb

@@ -0,0 +1,15 @@
+module Klaro
+  class Client
+    class Attachment < Resource
+
+      def absUrl
+        @client.absolute_url(self.url)
+      end
+
+      def absThumbnailUrl
+        @client.absolute_url(self.thumbnailUrl)
+      end
+
+    end # class Attachment
+  end # class Client
+end # module Klaro

data/lib/klaro/client/resource/dimension.rb

@@ -4,7 +4,7 @@ module Klaro
 
       def values
         @values ||= super
-          .map{|v| DimensionValue.dress(v) }
+          .map{|v| DimensionValue.dress(v, @client) }
           .sort{|v1,v2| v1.ordering <=> v2.ordering }
       end
 

data/lib/klaro/client/resource/story.rb

@@ -3,18 +3,32 @@ module Klaro
     class Story < Resource
 
       def title
-        @title ||= MdText.new(self.description.split("\n").first)
+        @title ||= MdText.new(self.description.split("\n").first, :summary)
       end
 
       def summary
-        @summary ||= MdText.new(self.description.split("\n")[1..-1].join("\n"))
+        @summary ||= MdText.new(self.description.split("\n")[1..-1].join("\n"), :summary)
       end
 
       def specification
-        @specification ||= MdText.new(super)
+        @specification ||= MdText.new(super, :details)
       end
       alias :details :specification
 
+      def linked_cards
+        @linked_cards ||= (self.linked || []).map{|s| Story.dress(s, @client) }
+      end
+
+      def attachments
+        @attachments || super.map{|a| Attachment.dress(a, @client) }
+      end
+
+      def cover_attachment(force = false)
+        got = (self.attachments || []).find{|a| a[:isCover] }
+        got = (self.attachments || []).first if got.nil? and force
+        got
+      end
+
       def to_url(with_identifier = true)
         I18n.config.available_locales = [:en, :fr]
         url = I18n.transliterate(title.to_s)
@@ -25,14 +39,14 @@ module Klaro
 
       def download_and_relocate_attachments(root_path, target_folder, client)
         as = self.attachments.map do |attachment|
-          url = attachment["url"]
-          url += "?n=" + URI.encode_www_form_component(attachment["filename"]) unless url =~ /\?n=/
+          url = attachment.url
+          url += "?n=" + URI.encode_www_form_component(attachment.filename) unless url =~ /\?n=/
           path = handle_image(url, root_path, target_folder, client)
-          attachment.merge("url" => path)
+          attachment.merge(url => path)
         end
-        self.class.new(self.to_h.merge(
+        self.class.dress(self.to_h.merge(
           attachments: as
-        ))
+        ), @client)
       end
 
       def download_and_relocate_images(root_path, target_folder, client)
@@ -42,9 +56,9 @@ module Klaro
           image_relative_path = handle_image(url, root_path, target_folder, client)
           "![#{label}](#{image_relative_path})"
         end
-        self.class.new(self.to_h.merge(
+        self.class.dress(self.to_h.merge(
           specification: spec
-        ))
+        ), @client)
       end
 
     private

data/lib/klaro/client/support/md_text.rb

@@ -2,19 +2,30 @@ module Klaro
   class Client
     class MdText
 
-      RENDERER = Redcarpet::Render::HTML.new({
+      SHARED_OPTIONS = {
         filter_html: true,
-        hard_wrap: true,
         no_links: false,
         no_styles: true,
         safe_links_only: true,
         with_toc_data: false
-      })
+      }
 
-      MARKDOWN = Redcarpet::Markdown.new(RENDERER)
+      VARIANTS = {
+        :summary => Redcarpet::Markdown.new(
+          Redcarpet::Render::HTML.new(SHARED_OPTIONS.merge({
+            hard_wrap: true,
+          }))
+        ),
+        :details => Redcarpet::Markdown.new(
+          Redcarpet::Render::HTML.new(SHARED_OPTIONS.merge({
+            hard_wrap: false,
+          }))
+        )
+      }
 
-      def initialize(src)
+      def initialize(src, variant)
         @src = src
+        @renderer = VARIANTS[variant]
       end
 
       def to_s
@@ -22,7 +33,7 @@ module Klaro
       end
 
       def to_html
-        MARKDOWN.render(to_s).strip
+        @renderer.render(to_s).strip.gsub(/<a href/, '<a target="_blank" href')
       end
 
     end # class MdText

data/lib/klaro/client/version.rb

@@ -2,8 +2,8 @@ module Klaro
   class Client
     module Version
       MAJOR = 0
-      MINOR = 4
-      TINY  = 2
+      MINOR = 5
+      TINY  = 1
     end
     VERSION = "#{Version::MAJOR}.#{Version::MINOR}.#{Version::TINY}"
   end # class Client

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: klaro-client
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.1
 platform: ruby
 authors:
 - enspirit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-07 00:00:00.000000000 Z
+date: 2020-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -127,6 +127,7 @@ files:
 - lib/klaro/client/errors.rb
 - lib/klaro/client/request_handler.rb
 - lib/klaro/client/resource.rb
+- lib/klaro/client/resource/attachment.rb
 - lib/klaro/client/resource/board.rb
 - lib/klaro/client/resource/dimension.rb
 - lib/klaro/client/resource/dimension_value.rb
@@ -154,8 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Klaro Client