klaro-client 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9612e0a404f699dce37fa9d937c7c5b79758834f058aa125074107f9b5a70468
-  data.tar.gz: cb0fe33f9ecf1a43839d162738b5d29e36072179e03c1cf05c44185de85d353d
+  metadata.gz: 1a258ae74415243864b134896b5dbd98ec2d73220cac4a8199089614db5f66d8
+  data.tar.gz: a2bc070c56903aeffedc957e82806e9fe41224b736766448211b27b0574aa886
 SHA512:
-  metadata.gz: fedd2867b05272d285640f822b26cd45b732fa75665525699b51abd5e1da04b2c8f644b177d3547e4e39ca37b1d4d42e626d87193504631f3b8731e01881e830
-  data.tar.gz: 046d46ade148f02cac554f74df9cdb45d80f74172941720eec79af395e62fbd357a5969a6c69c71c3224ff45601cbf5767c9b5903dee3e279081d24ec846c809
+  metadata.gz: 4f244ffb939719fe8ead74b056cb953885a919bd0fe31d36d45d5ea14b71dd3e922aa9850a49dd8f41a196cf7b72530bc3dcdaa8277de8d711e642b69ea40952
+  data.tar.gz: e833371db1db694bd8b8c5987c332c088356235334f1556583137cca0f745707547586e102631bd77bed15af2786d702add4752dff32e448afdeba34bb0e39f4

data/lib/klaro/client.rb

@@ -1,5 +1,6 @@
 require 'http'
 require 'path'
+require 'redcarpet'
 
 module Klaro
   class Client
@@ -9,20 +10,32 @@ module Klaro
       @request = RequestHandler.new(base_url)
     end
 
-    def login(user, password)
-      request.authenticate(user, password)
+    def with_token(*args, &bl)
+      request.with_token(*args, &bl)
     end
 
-    def stories(board)
-      stories_list = request.get("/api/boards/#{board}/stories/")
-      stories_list.map do |s|
-        Story.new(request.get("/api/stories/#{s['id']}"))
-      end
+    def login(*args, &bl)
+      request.authenticate(*args, &bl)
     end
 
-    def dimensions(code: nil)
-      return request.get('/api/dimensions') unless code
-      request.get("/api/dimensions/#{code}")
+    def dimension(code_or_id)
+      Dimension.dress(request.get("/api/dimensions/#{code_or_id}"))
+    end
+
+    def dimensions
+      Dimensions.dress(request.get('/api/dimensions'))
+    end
+
+    def board(location_or_id)
+      Board.dress(request.get("/api/boards/#{location_or_id}"))
+    end
+
+    def board_stories(location_or_id)
+      Stories.dress(request.get("/api/boards/#{location_or_id}/stories/"))
+    end
+
+    def story(id_or_identifier)
+      Story.dress(request.get("/api/stories/#{id_or_identifier}"))
     end
 
     def upload_image(image_path)
@@ -36,6 +49,8 @@ module Klaro
     end
   end
 end
+require_relative 'client/version'
 require_relative 'client/errors'
+require_relative 'client/support/md_text'
 require_relative 'client/request_handler'
 require_relative 'client/resource'

data/lib/klaro/client/request_handler.rb

@@ -1,11 +1,22 @@
 module Klaro
   class Client
     class RequestHandler
+      Http = HTTP
 
       attr_reader :base_url, :token
 
       def initialize(url)
         @base_url = url
+        @token = nil
+      end
+
+      def authenticated?
+        not(@token.nil?)
+      end
+
+      def with_token(token_type, access_token)
+        @token = "#{token_type} #{access_token}"
+        self
       end
 
       def authenticate(user, password)
@@ -56,7 +67,8 @@ module Klaro
       def http
         Http.headers(
           {
-            Authorization: @token
+            "Authorization" => @token,
+            "Content-Type" => "application/json"
           }
         )
       end

data/lib/klaro/client/resource.rb

@@ -1,7 +1,41 @@
 module Klaro
   class Client
     class Resource < OpenStruct
+
+      class << self
+        alias :dress :new
+      end
+
     end # class Resource
+    class Collection
+      include Enumerable
+
+      def initialize(items)
+        @items = items.map{|i| self.class.dress_one(i) }
+      end
+
+      def each(*args, &bl)
+        @items.each(*args, &bl)
+      end
+
+      class << self
+        alias :dress :new
+
+        def item(clazz)
+          @item_class = clazz
+        end
+
+        def dress_one(item)
+          @item_class.dress(item)
+        end
+      end
+
+    end
   end # class Client
 end # module Klaro
 require_relative 'resource/story'
+require_relative 'resource/stories'
+require_relative 'resource/dimension'
+require_relative 'resource/dimension_value'
+require_relative 'resource/dimensions'
+require_relative 'resource/board'

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

@@ -0,0 +1,6 @@
+module Klaro
+  class Client
+    class Board < Resource
+    end # class Dimension
+  end # class Client
+end # module Klaro

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

@@ -0,0 +1,13 @@
+module Klaro
+  class Client
+    class Dimension < Resource
+
+      def values
+        @values ||= super
+          .map{|v| DimensionValue.dress(v) }
+          .sort{|v1,v2| v1.ordering <=> v2.ordering }
+      end
+
+    end # class Dimension
+  end # class Client
+end # module Klaro

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

@@ -0,0 +1,6 @@
+module Klaro
+  class Client
+    class DimensionValue < Resource
+    end # class Dimension
+  end # class Client
+end # module Klaro

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

@@ -0,0 +1,7 @@
+module Klaro
+  class Client
+    class Dimensions < Collection
+      item(Dimension)
+    end # class Dimensions
+  end # class Client
+end # module Klaro

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

@@ -0,0 +1,7 @@
+module Klaro
+  class Client
+    class Stories < Collection
+      item(Story)
+    end # class Stories
+  end # class Client
+end # module Klaro

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

@@ -2,6 +2,14 @@ module Klaro
   class Client
     class Story < Resource
 
+      def title
+        @title ||= MdText.new(self.description.split("\n").first)
+      end
+
+      def summary
+        @summary ||= MdText.new(self.description.split("\n")[1..-1].join("\n"))
+      end
+
       def download_and_relocate_attachments(root_path, target_folder, client)
         as = self.attachments.map do |attachment|
           url = attachment["url"]
@@ -12,10 +20,6 @@ module Klaro
         self.class.new(self.to_h.merge(
           attachments: as
         ))
-      rescue => ex
-        puts ex.message
-        puts ex.backtrace.join("\n")
-        raise
       end
 
       def download_and_relocate_images(root_path, target_folder, client)

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

@@ -0,0 +1,30 @@
+module Klaro
+  class Client
+    class MdText
+
+      RENDERER = Redcarpet::Render::HTML.new({
+        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)
+
+      def initialize(src)
+        @src = src
+      end
+
+      def to_s
+        @src
+      end
+
+      def to_html
+        MARKDOWN.render(to_s).strip
+      end
+
+    end # class MdText
+  end # class Client
+end # module Klaro

data/lib/klaro/client/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: klaro-client
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - enspirit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-06 00:00:00.000000000 Z
+date: 2020-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -30,14 +30,34 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: path
   requirement: !ruby/object:Gem::Requirement
@@ -93,7 +113,14 @@ files:
 - lib/klaro/client/errors.rb
 - lib/klaro/client/request_handler.rb
 - lib/klaro/client/resource.rb
+- lib/klaro/client/resource/board.rb
+- lib/klaro/client/resource/dimension.rb
+- lib/klaro/client/resource/dimension_value.rb
+- lib/klaro/client/resource/dimensions.rb
+- lib/klaro/client/resource/stories.rb
 - lib/klaro/client/resource/story.rb
+- lib/klaro/client/support/md_text.rb
+- lib/klaro/client/version.rb
 homepage: 
 licenses:
 - MIT