kamiflex 0.12.2 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: abe7d79a2da6e406553d0ac0affcf3d68e8bfc11eeb708b0491b76da8181a29a
-  data.tar.gz: 4f17979f04de0cbf1ac0239800c16a12b6ec40280c4d923a78e4fe1de4ecd99b
+  metadata.gz: 3aebab2a944c48f712b4a67eb0e647f681752c5e6a12d0ad0643dcf94aef3100
+  data.tar.gz: 1cfcd6b3b0608f67dd4194544b77040d9637a5dcb3a94408163c0a9f536c9326
 SHA512:
-  metadata.gz: a7d6689a1430d5f072cd4cf98ce57b94a6ce08f0f67e95e053328ca8c4f1a885ee17393a20d457f80a803d002cdde8aacc39419198a0928a83f6767f5849c656
-  data.tar.gz: b6ba2c19320da472a198382773329254d10a1900b7e281d8f848776dc818a04e4cab47eb4213afbc0f41031d2884c250db194ddf56e11be5130f639399e5d5e0
+  metadata.gz: 25a72620cf4bc5a5f06ab54254eb4697c0fc212b7946d924a61a09232123a75dae3d6a07db165f46f2631dcb7b90f34ba4902d819f385add4e80fedb48aa1968
+  data.tar.gz: fd76b82aa9368e3a00cc3c38aae6bf73b07460d067e9258ad17a36eac286b21f7995794ebbb3ce2bfb1d97c1f63ec6d038b8a015c2c14bfc5d365de3a8942bc7

data/README.md

@@ -1,44 +1,81 @@
 # Kamiflex
 Kamiflex provide a pretty DSL to build your [flex message of line messaging api](https://developers.line.biz/en/docs/messaging-api/using-flex-messages/) like this:
 
+
+# Live Demo
+
+[Kamiflex Simulator](https://kamiflex.etrex.tw/)
+
 #### in pure ruby
+
+# [example/show_cases/cards.rb](example/show_cases/cards.rb)
+
 ``` ruby
-# example/todos_index.rb
 require 'kamiflex'
 
-@todos = [
+@products = [
   {
-    id: 1,
-    name: "ruby"
+    name: "kamigo",
+    star: 4,
+    place: "https://github.com/etrex/kamigo",
+    time: "10:00 - 23:00",
+    contact_url: "https://github.com/etrex/kamigo",
+    product_url: "https://github.com/etrex/kamigo"
   },
   {
-    id: 2,
-    name: "rails"
+    name: "kamiliff",
+    star: 3,
+    place: "https://github.com/etrex/kamiliff",
+    time: "11:00 - 23:00",
+    contact_url: "https://github.com/etrex/kamiliff",
+    product_url: "https://github.com/etrex/kamiliff"
   },
   {
-    id: 3,
-    name: "kamiflex"
-  }
+    name: "kamiflex",
+    star: 5,
+    place: "https://github.com/etrex/kamiflex",
+    time: "09:00 - 23:00",
+    contact_url: "https://github.com/etrex/kamiflex",
+    product_url: "https://github.com/etrex/kamiflex"
+  },
 ]
 
+def star(num)
+  baseline_box margin: :md do
+    (0...num).each do
+      icon "https://scdn.line-apps.com/n/channel_devcenter/img/fx/review_gold_star_28.png", size: :sm
+    end
+    (num...5).each do
+      icon "https://scdn.line-apps.com/n/channel_devcenter/img/fx/review_gray_star_28.png", size: :sm
+    end
+    text "#{num}.0", size: :sm, color: "#999999", margin: :md, flex: 0
+  end
+end
+
+def field(key, value)
+  baseline_box spacing: :sm do
+    text key, "color":"#aaaaaa","size":"sm","flex":1
+    text value, "wrap":true,"color":"#666666","size":"sm","flex":5
+  end
+end
+
 json = Kamiflex.build(self) do
-  bubble do
-    body do
-      horizontal_box do
-        text "🍔", flex: 0, action: message_action("/")
-        text "Todos"
-        text "🆕", align: "end", action: uri_action(new_todo_path))
-      end
-      separator
-      if @todos.present?
-        vertical_box margin: "lg" do
-          horizontal_box @todos, margin: "lg" do |todo|
-            text todo[:name], action: message_action("/todos/#{todo[:id]}")
-            text "❌", align: "end", action: message_action("DELETE /todos/#{todo[:id]}")
-          end
+  carousel do
+    bubbles @products do |product|
+      hero "https://scdn.line-apps.com/n/channel_devcenter/img/fx/01_1_cafe.png",
+        size: :full, aspectRatio: "20:13", aspectMode: :cover, action: uri_action("http://linecorp.com/")
+      body do
+        text product[:name], weight: :bold, size: :xl
+        star(product[:star])
+        vertical_box margin: :lg, spacing: :sm do
+          field "Place", product[:place]
+          field "Time", product[:time]
         end
-      else
-        text "no contents yet", margin: "lg"
+      end
+      footer spacing: :sm, flex: 0 do
+        url_button "CALL", product[:contact_url], style: :link, height: :sm
+        url_button "WEBSITE", product[:product_url], style: :link, height: :sm
+        spacer size: :sm
       end
     end
   end
@@ -47,20 +84,18 @@ end
 puts json
 ```
 
-The render result looks like this:
-
-![](image/todos_index.png)
+![](image/show_cases/cards.png)
 
 #### in rails
 ``` ruby
 # todos/index.line.erb
-<%= raw(Kamiflex.build(self) do
+<%= raw Kamiflex.build(self) do
   bubble do
     body do
       horizontal_box do
         text "🍔", flex: 0, action: message_action("/")
         text "Todos"
-        text "🆕", align: "end", action: uri_action(new_todo_path))
+        text "🆕", align: "end", action: uri_action(new_todo_path)
       end
       separator
       if @todos.present?
@@ -75,7 +110,7 @@ The render result looks like this:
       end
     end
   end
-end )%>
+end %>
 ```
 
 I will make a template name `flex` for rails in the future.
@@ -89,7 +124,7 @@ bubble do
     horizontal_box do
       text "🍔", flex: 0, action: message_action("/")
       text "Todos"
-      text "🆕", align: "end", action: uri_action(new_todo_path))
+      text "🆕", align: "end", action: uri_action(new_todo_path)
     end
     separator
     if @todos.present?

data/lib/kamiflex.rb

@@ -1,4 +1,5 @@
 require "json"
+require_relative "./kamiflex/version"
 require_relative "./kamiflex/core"
 require_relative "./kamiflex/basic_elements"
 require_relative "./kamiflex/actions"
@@ -6,7 +7,7 @@ require_relative "./kamiflex/quick_reply"
 require_relative "./kamiflex/custom"
 
 module Kamiflex
-  def self.to_hash(parent)
+  def self.hash(parent, &block)
     parent.class.include Kamiflex::Core
     parent.class.include Kamiflex::BasicElements
     parent.class.include Kamiflex::Actions
@@ -15,24 +16,25 @@ module Kamiflex
 
     parent.instance_exec do
       flex do
-        yield
+        parent.instance_exec(&block)
       end
     end
   end
 
-  def self.build(parent)
-    parent.class.include Kamiflex::Core
-    parent.class.include Kamiflex::BasicElements
-    parent.class.include Kamiflex::Actions
-    parent.class.include Kamiflex::QuickReply
-    parent.class.include Kamiflex::Custom
+  def self.to_hash(parent, &block)
+    self.hash(parent, &block)
+  end
 
-    hash = parent.instance_exec do
-      flex do
-        yield
-      end
-    end
-    JSON.pretty_generate hash
+  def self.build(parent, &block)
+    JSON.pretty_generate self.hash(parent, &block)
+  end
+
+  def self.json(parent, &block)
+    self.build(parent, &block)
+  end
+
+  def self.compact_json(parent, &block)
+    self.to_hash(parent, &block).to_json
   end
 end
 

data/lib/kamiflex/actions.rb

@@ -4,19 +4,25 @@ module Kamiflex
       {
         type: "message",
         label: label,
-        text: label
+        text: params[:text] || label
       }.merge(params)
     end
 
     def uri_action(uri, **params)
-      {
+      action = {
         type: "uri",
         label: uri[0...40],
-        uri: uri,
-        # altUri: {
-        #   desktop: uri
-        # }
+        uri: uri
       }
+
+      return action if params.nil?
+      return action if params[:desktop].nil?
+
+      action[:altUri] = {
+        desktop: params[:desktop]
+      }
+
+      action
     end
 
     def postback_action(data, **params)

data/lib/kamiflex/basic_elements.rb

@@ -1,8 +1,23 @@
 module Kamiflex
   module BasicElements
-    def text(message, **params)
+    def text(message = nil, **params)
+      if block_given?
+        _attributes, contents = flex_scope{ yield }
+        @flex_contents << {
+          type: "text",
+          contents: contents,
+        }.merge(params)
+      else
+        @flex_contents << {
+          type: "text",
+          text: message
+        }.merge(params)
+      end
+    end
+
+    def span(message, **params)
       @flex_contents << {
-        "type": "text",
+        "type": "span",
         "text": message
       }.merge(params)
     end
@@ -43,13 +58,22 @@ module Kamiflex
     end
 
     def url_button(label, url, **params)
-      @flex_contents << {
-        "type": "button",
-        "action": {
-          "type": "uri",
-          "label": label,
-          "uri": url
+      action = {
+        type: "uri",
+        label: label,
+        uri: url,
+      }
+
+      if params&.dig(:desktop)
+        action[:altUri] = {
+          desktop: params&.dig(:desktop)
         }
+        params = params.reject {|key, value| key == :desktop }
+      end
+
+      @flex_contents << {
+        type: "button",
+        action: action
       }.merge(params)
     end
 

data/lib/kamiflex/core.rb

@@ -82,11 +82,11 @@ module Kamiflex
     # container
     def horizontal_box(resources = [nil], **params)
       resources.each_with_index do |resource, index|
-        _attributes, contents = flex_scope{ yield(resource, index) }
+        _attributes, contents = flex_scope{ yield(resource, index) } if block_given?
         @flex_contents << {
           type: "box",
           layout: "horizontal",
-          contents: contents
+          contents: contents || []
         }.merge(params)
       end
     end

data/lib/kamiflex/version.rb

@@ -1,3 +1,3 @@
 module Kamiflex
-  VERSION = '0.12.2'
+  VERSION = '0.17.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kamiflex
 version: !ruby/object:Gem::Version
-  version: 0.12.2
+  version: 0.17.0
 platform: ruby
 authors:
 - etrex kuo
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-27 00:00:00.000000000 Z
+date: 2021-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json