kamiliff 0.14.0 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3933c1a48a8b3bb9e4183e265af686ad270789d6012f927d19c54fa4be23f834
-  data.tar.gz: 53418c89721917f2cdc97eb43436edf6be8cf4128298c97b55397d78c1df69ce
+  metadata.gz: 498ccd4075fc6cdf241d6ec11ecc943a1d5a18799677baf5a4b665585eca0658
+  data.tar.gz: ce48f53be68d877bb2efacc71eb264e8d6d74a499287bd9b1ba478bc10e12ea9
 SHA512:
-  metadata.gz: 3939f22ba9d727197e37c8e579791bc515f519dca6b206579965264d463108682768b4336da6c9ec2ec46b5c7f6b97899c28fe96dce5a00cb49768275973ce76
-  data.tar.gz: af3c5a49dc6445f6278394ae8db02cb9dc0abe5541383ed91f538af9a284875809fac6a0e05d68510ae3869715ae00f088693b0a79bc8d6337028160994f5a26
+  metadata.gz: ecd86a4de7d7e18be3a9ba5049ab36bdee3ebfa246ce07225a632d6739d86758dd71dc4e6aaa072110d750653029adc341e1c1bec06450e4c12eef0c14f7975e
+  data.tar.gz: 1538d204048373fa00fc63e9f8046039b2e8312ad48525d6505d3155fa381871339ad76d61c43dfe1088e06201c121e4cd15e38ec33491aaea0f56a814b98566

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/controllers/liff_controller.rb

@@ -1,17 +1,18 @@
 
-class LiffController < ApplicationController
+class LiffController < ActionController::Base
   layout false, only: :route
 
-
   def entry
     query = Rack::Utils.parse_nested_query(request.query_string)
 
-    # fix liff 2.0 path issue
-    if query["liff.state"].present?
-      query = Rack::Utils.parse_nested_query(query["liff.state"][1..-1])
+    # fix liff 2.0 redirect issue
+    @need_reload = query["liff.state"].present?
+    if(@need_reload)
+      querystring = query["liff.state"][(query["liff.state"].index('?')+1)..-1]
+      query = Rack::Utils.parse_nested_query(querystring)
     end
 
-    @path = query["path"]
+    @liff = LiffService.new(query)
   end
 
   def route
@@ -31,9 +32,12 @@ class LiffController < ApplicationController
     # env = {Rack::RACK_INPUT => StringIO.new}
 
     res = Rails.application.routes.router.serve(request)
+    # res[0]: http state code
+    # res[1]: headers
+    # res[2]: response
     res[2].body
-  rescue
-    res[2].to_s
+  rescue NoMethodError => e
+    res&.to_s || e.full_message
   end
 
   def source_info
@@ -44,11 +48,14 @@ class LiffController < ApplicationController
     source_group_id = context["roomId"] || context["groupId"] || context["userId"]
     source_user_id = context["userId"]
 
+    profile = params["profile"]
+
     {
       platform_type: 'line',
       source_type: source_type,
       source_group_id: source_group_id,
       source_user_id: source_user_id,
+      profile: profile
     }
   end
 end

data/app/helpers/liff_helper.rb

@@ -1,9 +1,10 @@
 module LiffHelper
   def liff_path(params)
-    liff_size = params[:liff_size] || :compact
-    liff_size = liff_size.to_s.upcase
-    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}"
+    liff = LiffService.new(params)
+    if ENV["LIFF_MODE"]&.downcase == "replace"
+      return "#{liff.url}/liff_entry?#{params.to_query}"
+    end
+    # liff mode is Concatenate
+    "#{liff.url}?#{params.to_query}"
   end
 end

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

@@ -5,14 +5,29 @@
     <%= csrf_meta_tags %>
     <%= csp_meta_tag %>
     <meta name="viewport" content="width=device-width, initial-scale=1" >
-    <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>
+    <script src="https://static.line-scdn.net/liff/edge/versions/2.5.0/sdk.js"></script>
 
-    <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track': 'reload' %>
-    <%= javascript_include_tag 'application', 'data-turbolinks-track': 'reload' %>
+    <% asset_application_js_path = Dir.glob("#{Rails.root}/app/assets/javascripts/application.*").first %>
+    <% if asset_application_js_path.present? %>
+      <%= javascript_include_tag 'application', 'data-turbolinks-track': 'reload' %>
+    <% end %>
+
+    <% webpacker_application_js_path = Dir.glob("#{Rails.root}/app/javascript/packs/application.*").first %>
+    <% if webpacker_application_js_path.present? %>
+      <%= javascript_pack_tag 'application', 'data-turbolinks-track': 'reload' %>
+    <% end %>
+
+    <% has_jquery = [asset_application_js_path, webpacker_application_js_path].compact.map do |path|
+      (File.read(path) =~ /jquery/i).present?
+    end.any? %>
 
+    <% unless has_jquery %>
+      <script src="https://code.jquery.com/jquery-1.12.4.js"></script>
+      <script> alert("has no jquery") </script>
+    <% end %>
+
+    <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track': 'reload' %>
     <link href="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-ggOyR0iXCbMQv3Xipma34MD+dH/1fQ784/j6cY/iJTQUOhcWr7x9JvoRxT2MZw1T" crossorigin="anonymous">
-    <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/js/bootstrap.min.js" integrity="sha384-JjSmVgyd0p3pXB1rRibZUAYoIIy6OrQ6VrjIEaFf/nJGzIxFDsf4x0xIM+B07jRM" crossorigin="anonymous"></script>
     <script>
       function liff_send_text_message(text){
         liff.sendMessages(

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

@@ -42,15 +42,29 @@
     });
   }
 
-  liff.init(
-    data => {
-      data.path = '<%= @path %>';
-      route(data);
-    },
-    err => {
-      alert("Please open this url in Line.");
-    }
-  );
+  window.onload = function() {
+    liff.init({
+      liffId: "<%= @liff.id %>"
+    })
+    .then(() => {
+      if (!liff.isLoggedIn()) {
+        liff.login();
+      }else{
+        liff.getProfile().then(profile => {
+          const data = {};
+          data.context = liff.getContext();
+          data.profile = profile;
+          data.path = "<%= @liff.path %>";
+          <% if !@need_reload %>
+            route(data);
+          <% end %>
+        })
+      }
+    })
+    .catch((err) => {
+      console.log(err.code, err.message);
+    });
+  };
 })();
 </script>
 <% end %>

data/lib/kamiliff.rb

@@ -1,4 +1,5 @@
 require "kamiliff/engine"
+require "kamiliff/services/liff_service"
 
 module Kamiliff
   # Your code goes here...

data/lib/kamiliff/services/liff_service.rb

@@ -0,0 +1,26 @@
+class LiffService
+
+  # rails routes path
+  attr_accessor :path
+
+  # size
+  # COMPACT TALL FULL
+  attr_accessor :size
+
+  # liff app url
+  # https://liff.line.me/app/#{liff_id}
+  attr_accessor :url
+
+  # liff id
+  attr_accessor :id
+
+  def initialize(options)
+    self.path = options[:path] || options['path'] || "/"
+    self.size = options[:liff_size] || options['liff_size'] || :compact
+    self.size = size.to_s.upcase
+    raise "liff_size should be compact, tall or full." unless size.in? %w[COMPACT TALL FULL]
+    self.url = ENV["LIFF_#{size}"]
+    raise "LIFF_#{size} should be in the env variables" if url.empty?
+    self.id = url[(url.rindex('/')+1)..-1]
+  end
+end

data/lib/kamiliff/version.rb

@@ -1,3 +1,3 @@
 module Kamiliff
-  VERSION = '0.14.0'
+  VERSION = '0.19.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kamiliff
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.19.0
 platform: ruby
 authors:
 - etrex kuo
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-02 00:00:00.000000000 Z
+date: 2020-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -46,6 +46,7 @@ files:
 - config/routes.rb
 - lib/kamiliff.rb
 - lib/kamiliff/engine.rb
+- lib/kamiliff/services/liff_service.rb
 - lib/kamiliff/version.rb
 - lib/tasks/kamiliff_tasks.rake
 homepage: https://github.com/etrex/kamiliff
@@ -53,7 +54,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -68,8 +69,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: An easy way to use LINE Front-end Framework(LIFF) on rails.
 test_files: []