rails_liff 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9bf93438d5059b859e44a4969c6c310f36f60b7cef8b452b4f04520c68a52d11
-  data.tar.gz: 6172757153c6c617eb60fedbbf2966cce60cfdd3614c1d0b64f3481bf7f49e29
+  metadata.gz: 15597087e32963e4ab7b501b976e98da8200efd55a75de25f6ee4344ba8a939b
+  data.tar.gz: c9bcafcf900c22d32b129bf1cb00a59bfb75d1ee95b394ebfe39b22077bc1e1d
 SHA512:
-  metadata.gz: 0dba30d7f7866b67cf6c2bd3fa65e2d03f9e38c38db4eca4d6536c4f87f10924c36af31cbca582b3ca3b4f9a29e54223dace3ba92f93c2341d4aeb8e5278e79f
-  data.tar.gz: 90a8bbc5d12133153f6f0fad9783dbb3d0a7b39830f044e3842530d8744a7f515cd7f19478c23206d3f615a0249b8a004fd0db3f7017e19d289cf82d4581b148
+  metadata.gz: b2707626a0608504b9c8323c9f9110ad4b823246d37973c40f0e0d60269ad66edba31faa53d1339e2bd12616e660bfb933e0f2240318c58f86ab9cafe7c415f1
+  data.tar.gz: 90fbb45bd348dfed1912ce87e56bab753eb55177623472c5277b4b6eb4cb652ed65bbf3ded0b757bf03a528e61e7bcbd67f6b6b88de2a91258ca4bc6dfbfc582

data/README.md

@@ -1,28 +1,83 @@
 # RailsLiff
-Short description and motivation.
 
-## Usage
-How to use my plugin.
+RailsLiff make LIFF easy to use.
+
+# Feature
+- register LIFF once and reuse to your all path.
+- liff_submit event: a hook when LIFF form submit, with form data in js object format.
+- liff_send_text_message: quick send message and close LIFF.
 
 ## Installation
-Add this line to your application's Gemfile:
 
 ```ruby
 gem 'rails_liff'
 ```
 
-And then execute:
-```bash
-$ bundle
+login to line developers, and create 3 LIFF for 3 different size.
+
+- for compact
+  - name: Compact
+  - size: Compact
+  - Endpoint URL: https://yourwebsite/liff
+
+- for tall
+  - name: Tall
+  - size: Tall
+  - Endpoint URL: https://yourwebsite/liff
+
+- for full
+  - name: Full
+  - size: Full
+  - Endpoint URL: https://yourwebsite/liff
+
+and then copy the result to enviroment parameters:
+
+```
+LIFF_COMPACT=line://app/for_compact_liff_id
+LIFF_TALL=line://app/for_tall_liff_id
+LIFF_FULL=line://app/for_full_liff_id
+```
+
+## Usage
+
+### Implement LIFF View
+
+RailsLiff using view format `.liff`, so you can reuse exists controller and model, you can create a LIFF form by only adding a new view file.
+
+Suppose you have a resource `todos`, you want to create a liff form for `todos/new`, so you create a file `app/views/todos/new.liff.erb`, the content is as follows:
+
+```
+<% content_for :title, "new todo" %>
+
+<%= render "todos/form.html", todo: @todo %>
+
+<%= link_to "test", liff_path(path: '/todos/new') %>
+```
+
+You can test the form at [localhost:3000/todos/new.liff](localhost:3000/todos/new.liff)
+
+### Generate LIFF Link
+
+You can change any path to liff by `liff_path` method.
+
+for example:
+
+```
+liff_path(path: '/todos/new')
 ```
 
-Or install it yourself as:
-```bash
-$ gem install rails_liff
+You can choice the liff size by `liff_size` parameter. the default value of liff_size is compact.
+
+```
+liff_path(path: '/todos/new', liff_size: :compact)
+liff_path(path: '/todos/new', liff_size: :tall)
+liff_path(path: '/todos/new', liff_size: :full)
 ```
 
-## Contributing
-Contribution directions go here.
+liff_path method add format :liff automatically.
+
+## Author
+create by [etrex](https://etrex.tw)
 
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/assets/javascripts/rails_liff.js

@@ -0,0 +1,57 @@
+function liff_send_text_message(text){
+  liff.sendMessages(
+    [
+      {
+        type: 'text',
+        text: text
+      }
+    ]
+  ).then(() => {
+    liff.closeWindow();
+  })
+  .catch((err) => {
+    alert('error', err);
+  });
+}
+
+$(function(){
+  function dispatch_liff_event(data){
+    var event = new CustomEvent('liff_submit', { 'detail': data });
+    window.dispatchEvent(event);
+  }
+  $('input[type="submit"]').click(function(e){
+    e.preventDefault();
+    dispatch_liff_event(get_request_text($("form")));
+  })
+
+  function get_request_text(form_element){
+    var data = get_form_data(form_element);
+    var method = form_element.attr("method").toUpperCase();
+    var url = form_element.attr("action");
+    return {
+      data: data,
+      method: method,
+      url: url
+    }
+  }
+
+  function get_form_data(form_element){
+    var excpet = ["utf8","authenticity_token"];
+    var form = form_element.serializeArray();
+    form = form.filter((a)=>{ return !excpet.includes(a.name) })
+    var data = {}
+    form.forEach((a)=>{ set_object_value(data, a.name, a.value) })
+    return data;
+  }
+
+  function set_object_value(object, path, value){
+    var o = object;
+    var p = path.replace(/(\]\[)/g, "[").replace(/]$/g, "").split("[")
+    var last_key = p.pop();
+    p.forEach((key)=>{
+      o[key] = o[key] || {}
+      o = o[key]
+    })
+    o[last_key] = value;
+  }
+});

data/app/helpers/liff_helper.rb

@@ -1,6 +1,8 @@
 module LiffHelper
   def liff_path(params)
-    liff_url = ENV['LIFF_FORM']
+    liff_size = params[:liff_size] || "COMPACT"
+    raise "liff_size should be COMPACT, TALL or FULL." unless liff_size.in? %w[COMPACT TALL FULL]
+    liff_url = ENV["LIFF_#{liff_size}"]
     "#{liff_url}?#{params.to_query}"
   end
 end

data/app/views/layouts/application.liff.erb

@@ -13,64 +13,12 @@
 
     <script src="https://d.line-scdn.net/liff/1.0/sdk.js"></script>
     <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.js"></script>
+    <%= javascript_include_tag 'rails_liff', 'data-turbolinks-track': 'reload' %>
   </head>
 
   <body>
     <div class="container-fluid">
       <%= yield %>
     </div>
-
-    <script>
-      $(function(){
-        $('input[type="submit"]').click(function(e){
-          e.preventDefault();
-          send_message(get_request_text($("form")));
-        })
-
-        function send_message(text){
-          liff.sendMessages(
-            [
-              {
-                type: 'text',
-                text: text
-              }
-            ]
-          ).then(() => {
-            liff.closeWindow();
-          })
-          .catch((err) => {
-            alert('error', err);
-          });
-        }
-
-        function get_request_text(form_element){
-          var data = get_form_data(form_element);
-          var json = JSON.stringify(data);
-          var method = form_element.attr("method").toUpperCase();
-          var url = form_element.attr("action");
-          return `${method} ${url}\n${json}`;
-        }
-
-        function get_form_data(form_element){
-          var excpet = ["utf8","authenticity_token"];
-          var form = form_element.serializeArray();
-          form = form.filter((a)=>{ return !excpet.includes(a.name) })
-          var data = {}
-          form.forEach((a)=>{ set_object_value(data, a.name, a.value) })
-          return data;
-        }
-
-        function set_object_value(object, path, value){
-          var o = object;
-          var p = path.replace(/(\]\[)/g, "[").replace(/]$/g, "").split("[")
-          var last_key = p.pop();
-          p.forEach((key)=>{
-            o[key] = o[key] || {}
-            o = o[key]
-          })
-          o[last_key] = value;
-        }
-      });
-    </script>
   </body>
 </html>

data/config/initializers/assets.rb

@@ -0,0 +1 @@
+Rails.application.config.assets.precompile << "rails_liff.js"

data/lib/rails_liff/version.rb

@@ -1,3 +1,3 @@
 module RailsLiff
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_liff
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - etrex kuo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-11 00:00:00.000000000 Z
+date: 2019-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -34,10 +34,12 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- app/assets/javascripts/rails_liff.js
 - app/controllers/liff_controller.rb
 - app/helpers/liff_helper.rb
 - app/views/layouts/application.liff.erb
 - app/views/liff/entry.html.erb
+- config/initializers/assets.rb
 - config/initializers/mime_types.rb
 - config/routes.rb
 - lib/rails_liff.rb