kamiliff 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e1a6426cb9312e84ac551da647721c6a63c4def94bbda616618e219a1bf5b61
-  data.tar.gz: 1290e1aa4a8fba4c814836992b1271cc722fbc4017298584971d7eb72f7ab565
+  metadata.gz: 923af087cbb7e01f33610fa15c0f57c28d7d341f57e21ab0e896e6daa66f2301
+  data.tar.gz: c215fab6cc29f24acdd7cf94b308e7a3561edd3818335a8f0da208ead09fe238
 SHA512:
-  metadata.gz: c1dae23952d71fc92ce40301baf1d8a4b1b40681c3545333d2f024aec282466730c0b762181dbb9bb57c28034ecf0682e19791f5a00bb37705daa98a2e1f0a0a
-  data.tar.gz: 570d689c3734d11b6adc4ddc67323f0e190fc710be3c2cba95029351e776da307c7bcd1a1dc14eeb6802db75ef8e8e35b56ef997491b8c8f017d1fa6358c8e62
+  metadata.gz: 5d2aa3a7ac569d545d8aa6b83b1479ed3f260951bef938aaa8661f36aa48dfadfe0ad50cd62696d36ee5358bb0cbb5ba8e1c5e757b00e7c6eb36ddac23b0e4dc
+  data.tar.gz: 87cf2a57d14ac68b80c914a302a483d714972ff5bba961788841bbadf50d31ca55ee066645286713afa57db3cf2d018890e83021c91132bec249f242e7d42887

data/README.md

@@ -1,5 +1,4 @@
 # Kamiliff
-
 Kamiliff make LIFF easy to use.
 
 # Feature
@@ -8,7 +7,113 @@ Kamiliff make LIFF easy to use.
 - liff_send_text_message: quick send message and close LIFF.
 
 ## Installation & Usage
+### Create a new rails repository:
+
+```bash
+# create rails repository
+rails new kamiliff_demo
+# change directory
+cd kamiliff_demo
+# install gem
+bundle add kamiliff
+bundle add dotenv-rails
+```
+
+### Add LIFF Endpoint URL
+Login to LINE Developers, and create 3 LIFF for 3 different size.
+
+- For compact
+  - LIFF app name: Compact
+  - Size: Compact
+  - Endpoint URL: https://yourwebsite/liff_entry
+
+- For tall
+  - LIFF app name: Tall
+  - Size: Tall
+  - Endpoint URL: https://yourwebsite/liff_entry
+
+- For full
+  - LIFF app name: Full
+  - Size: Full
+  - Endpoint URL: https://yourwebsite/liff_entry
+
+Since the compact size is default. You could only create the compact one.
+
+**NOTICE:** As LINE announcement, due to a function enhancement with LIFF v2, you should add LIFF apps to LINE Login channel. The LIFF apps added to Messaging API channels are still allowed to use.
+
+### Set environment variables
+Create a file `.env` with the following content under the root directory. Kamiliff provides two setting ways, you can choose the one based on the position where LIFF apps added.
+
+- LIFF apps added to Messaging API channel (v1)
+```
+LIFF_COMPACT=line://app/{FOR_COMPACT_LIFF_ID}
+LIFF_TALL=line://app/{FOR_TALL_LIFF_ID}
+LIFF_FULL=line://app/{FOR_FULL_LIFF_ID}
+```
+
+- LIFF apps added to LINE Login channel (v2)
+```
+LIFF_COMPACT=https://liff.line.me/{FOR_COMPACT_LIFF_ID}
+LIFF_TALL=https://liff.line.me/{FOR_TALL_LIFF_ID}
+LIFF_FULL=https://liff.line.me/{FOR_FULL_LIFF_ID}
+```
+
+You could choose another setting method.
+
+### Generate simple todo resource
+Create todo resource:
+
+```bash
+rails g scaffold todo name desc
+rails db:migrate
+```
+
+### Create LIFF view
+Create liff view for new action at `app/views/todos/new.liff.erb`.
+
+```
+<%= render "todos/form.html", todo: @todo %>
+
+<script>
+document.title = "new todo";
+
+window.addEventListener("liff_submit", function(event){
+  var json = JSON.stringify(event.detail.data);
+  var url = event.detail.url;
+  var method = event.detail.method;
+  var request_text = method + " " + url + "\n" + json;
+  liff_send_text_message(request_text);
+});
+</script>
+```
+
+The javascript listen to submit button click, and build the message from form data, and send to current LINE chatroom, and then close the LIFF webview.
+
+You could modify those javascript to change the format.
+
+### Test LIFF view
+Add following content into `app/views/todos/index.html.erb`.
+
+```
+<%= liff_path(path: new_todo_path) %>
+```
+
+Copy this url and paste to any LINE chatroom.
+
+Click this url in LINE app.
+
+The correct usage is put this url into Rich Manu or Flex Message or Template Message with url action.
+
+### How to change LIFF size
+You can change the size of LIFF by adding a parameter to the helper method, like this:
+
+```
+<%= liff_path(path: new_todo_path, liff_size: :compact) %>
+<%= liff_path(path: new_todo_path, liff_size: :tall) %>
+<%= liff_path(path: new_todo_path, liff_size: :full) %>
+```
 
+## Apps use Kamiliff
 See my kamiliff demo: [https://github.com/etrex/kamiliff_demo](https://github.com/etrex/kamiliff_demo)
 
 ## Author

data/app/views/liff/entry.html.erb

@@ -42,24 +42,26 @@
     });
   }
 
-  liff.init({
-    liffId: "<%= @liff.id %>"
-  })
-  .then(() => {
-    if (!liff.isLoggedIn()) {
-      liff.login();
-    }else{
-      const data = {};
-      data.context = liff.getContext();
-      data.path = "<%= @liff.path %>";
-      <% if !@need_reload %>
-        route(data);
-      <% end %>
-    }
-  })
-  .catch((err) => {
-    console.log(err.code, err.message);
-  });
+  window.onload = function() {
+    liff.init({
+      liffId: "<%= @liff.id %>"
+    })
+    .then(() => {
+      if (!liff.isLoggedIn()) {
+        liff.login();
+      }else{
+        const data = {};
+        data.context = liff.getContext();
+        data.path = "<%= @liff.path %>";
+        <% if !@need_reload %>
+          route(data);
+        <% end %>
+      }
+    })
+    .catch((err) => {
+      console.log(err.code, err.message);
+    });
+  };
 })();
 </script>
 <% end %>

data/lib/kamiliff/version.rb

@@ -1,3 +1,3 @@
 module Kamiliff
-  VERSION = '0.15.0'
+  VERSION = '0.16.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kamiliff
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.16.0
 platform: ruby
 authors:
 - etrex kuo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-03 00:00:00.000000000 Z
+date: 2020-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails