kamiflex 0.12.1 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 071ab7c633d8d7a5a420593aa91354f7ae75ef494fe1f737d685e3a158c44174
-  data.tar.gz: aff944e65d5af0a26712db2ef11655049eb3e48e668706866e488083df90c984
+  metadata.gz: f720f54831cd629b5e9ac62071f89fe6bf94c048724a09855a42f925651b95b1
+  data.tar.gz: 74803c3a50ae3b7815f5129198957fa14da4795575980d5d3205866c690addaa
 SHA512:
-  metadata.gz: 46e3424571adeb2eed428baad0325227bea035f340f5c9f6ddbd78c779731a4f7ed27809c317f04eff0b90d0f8db302dff10ddfb64bb7e2e393fda90b7995c80
-  data.tar.gz: 30162106bf30c8e7231b238d98fb30e802fba2f1f22583caab14342ee8f15f2ebd1c1f02cc1f8257044557203cf9977c3ae8b3eb0dabae087779a7934d2a81b3
+  metadata.gz: 382b0159bd2c5b8690429197c70c9abddc0c6544094efed5ca40700dcdad3c2adc138d432f52b92ce312d3393a2c7c3ac9d1bc43217ce039bde37854e2ccef6a
+  data.tar.gz: 9ec944b733f1d561ceea2c0bb3e598887946a8906ae6bcf365d7f1606f168fef92d19642890b5d58573ca1dcb717aa8b291a08330e8c28b989712d3bc67142eb

data/README.md

@@ -2,43 +2,75 @@
 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:
 
 #### 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 +79,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 +105,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 +119,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

@@ -43,13 +43,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

@@ -4,9 +4,9 @@ module Kamiflex
       attributes, _contents = flex_scope{ yield }
       {
         type: "flex",
-        altText: attributes[:alt_text] || "this is a flex message",
+        altText: "this is a flex message",
         contents: _contents.first
-      }.merge(attributes.slice(:quickReply))
+      }.merge(attributes.slice(:quickReply, :altText))
     end
 
     def bubble(**params)

data/lib/kamiflex/version.rb

@@ -1,3 +1,3 @@
 module Kamiflex
-  VERSION = '0.12.1'
+  VERSION = '0.16.0'
 end

metadata

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