kamiflex 0.11.7 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe841ee1b9e6c5637e5ee7b6a6a66cef70ce7c1899cc7876a8dbf86fd4ac5194
-  data.tar.gz: 69f86b0ec3744c9e06dc3dc216ca717e9d6341350ac379cac2de81bc49c1bf9d
+  metadata.gz: 6f3a0c28faa7246ac46c30d299399e4a052238fd65ffbcf3876f3d212b5f8c7a
+  data.tar.gz: 23cff523a92f3eaa2519a295a4c29f31c2306a45016e3fa7e6cd9b5017637ffe
 SHA512:
-  metadata.gz: 2126b8e315dada2ede98b69fb2f15c44a57ccb66bd73066952f257f70b88dd914877415611a95decb34afd772edf0c8a7401605518743468088dd91880b8ca94
-  data.tar.gz: 424d2d48c700b8f27699144821ca689afb2a2be8ebc3334f904b80ecb748db8ceb3855d1360bf001886138d3606c883b5d80196bbd52af8b5759cd8eea0854a4
+  metadata.gz: fb297062b3e7037e25079f35597a616021a51d13244d6d157a1f71d2d04d38ec6af4cff3e6ed9c8ae3dba608c6fc360bd9878b7f62e0162f3678f292724ccd5c
+  data.tar.gz: 73de7d71fad0c304d603e8f1899f699abcf050e6f82ec9e0e72ab1d877bb0690eac743898c54c34a58fc79988fa88b1940ca47651da1f444f703d615fed80202

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

@@ -6,7 +6,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 +15,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,24 @@ 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
       }
+
+      if params[:desktop].present?
+        action[:altUri] = {
+          desktop: params[:desktop]
+        }
+      end
+
+      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[:desktop].present?
+        action[:altUri] = {
+          desktop: params[:desktop]
         }
+        params = params.reject {|key, value| key == :desktop }
+      end
+
+      @flex_contents << {
+        type: "button",
+        action: action
       }.merge(params)
     end
 

data/lib/kamiflex/core.rb

@@ -6,7 +6,7 @@ module Kamiflex
         type: "flex",
         altText: "this is a flex message",
         contents: _contents.first
-      }.merge(attributes.slice(:quickReply))
+      }.merge(attributes.slice(:quickReply, :altText))
     end
 
     def bubble(**params)
@@ -70,6 +70,15 @@ module Kamiflex
       }.merge(params)
     end
 
+    # style
+    def styles(params)
+      @flex_attributes[:styles] = params
+    end
+
+    def alt_text(text)
+      @flex_attributes[:altText] = text
+    end
+
     # container
     def horizontal_box(resources = [nil], **params)
       resources.each_with_index do |resource, index|
@@ -82,11 +91,6 @@ module Kamiflex
       end
     end
 
-    # style
-    def styles(params)
-      @flex_attributes[:styles] = params
-    end
-
     def vertical_box(resources = [nil], **params, &block)
       horizontal_box(resources, layout: "vertical", **params, &block)
     end

data/lib/kamiflex/version.rb

@@ -1,3 +1,3 @@
 module Kamiflex
-  VERSION = '0.11.7'
+  VERSION = '0.14.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kamiflex
 version: !ruby/object:Gem::Version
-  version: 0.11.7
+  version: 0.14.0
 platform: ruby
 authors:
 - etrex kuo
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-11-01 00:00:00.000000000 Z
+date: 2021-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -49,7 +49,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -64,8 +64,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: 'Kamiflex: generate JSON objects for Line flex message with a Builder-style
   DSL'