kamiliff 0.7.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 74fdcb1aa9887f7a0768791b79eecafd7ca36f7c9b51f24a4fb8a20912d5910a
+  data.tar.gz: cb374760f4d192b552e84fdfb96d9af1802276400586ac1c7bcd0a93017eb6e8
+SHA512:
+  metadata.gz: 1f1bf7aa4af19d5d40d5906f211e6666ae56e67ef52b8c23d5eb40ee9776edf0b247601c35a45a9a36ad56e4d4dda0f1f308b4878188f159257ed4a093efac65
+  data.tar.gz: 5f8228f4c684d8c11d884c1a312d80d3c64a3d8baa1db2c04d94e61d3f203c73dbc21eb801564c44c6eba7361cd8d00be2fa2d60c8293003ed76cd1dd4a01fc9

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 etrex kuo
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,83 @@
+# Kamiliff
+
+Kamiliff 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
+
+```ruby
+gem 'kamiliff'
+```
+
+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
+
+Kamiliff 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')
+```
+
+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)
+```
+
+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/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Kamiliff'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/assets/javascripts/kamiliff.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/controllers/liff_controller.rb

@@ -0,0 +1,26 @@
+
+class LiffController < ApplicationController
+  layout false
+
+  def entry
+    query = Rack::Utils.parse_nested_query(request.query_string)
+    @body = reserve_route(query["path"], format: :liff)
+  end
+
+  private
+
+  def reserve_route(path, http_method: "GET", request_params: nil, format: nil)
+    request.request_method = http_method
+    request.path_info = path
+    request.format = format if format.present?
+    request.request_parameters = request_params if request_params.present?
+
+    # req = Rack::Request.new
+    # env = {Rack::RACK_INPUT => StringIO.new}
+
+    res = Rails.application.routes.router.serve(request)
+    res[2].body
+  rescue
+    res[2].to_s
+  end
+end

data/app/helpers/liff_helper.rb

@@ -0,0 +1,9 @@
+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}"
+  end
+end

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

@@ -0,0 +1,24 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title><%= yield(:title) || "Todo" %></title>
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+    <meta name="viewport" content="width=device-width, initial-scale=1" >
+    <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track': 'reload' %>
+    <%= javascript_include_tag 'application', '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 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 'kamiliff', 'data-turbolinks-track': 'reload' %>
+  </head>
+
+  <body>
+    <div class="container-fluid">
+      <%= yield %>
+    </div>
+  </body>
+</html>

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

@@ -0,0 +1 @@
+<%= raw @body %>

data/config/initializers/assets.rb

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

data/config/initializers/mime_types.rb

@@ -0,0 +1,6 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf
+
+Mime::Type.register "text/html", :liff

data/config/routes.rb

@@ -0,0 +1,4 @@
+Rails.application.routes.draw do
+  # liff
+  get 'liff', to: 'liff#entry'
+end

data/lib/kamiliff/engine.rb

@@ -0,0 +1,4 @@
+module Kamiliff
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/kamiliff/version.rb

@@ -0,0 +1,3 @@
+module Kamiliff
+  VERSION = '0.7.0'
+end

data/lib/kamiliff.rb

@@ -0,0 +1,5 @@
+require "kamiliff/engine"
+
+module Kamiliff
+  # Your code goes here...
+end

data/lib/tasks/kamiliff_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :kamiliff do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: kamiliff
+version: !ruby/object:Gem::Version
+  version: 0.7.0
+platform: ruby
+authors:
+- etrex kuo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.2
+description: An easy way to use LINE Front-end Framework(LIFF) on rails.
+email:
+- et284vu065k3@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/javascripts/kamiliff.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/kamiliff.rb
+- lib/kamiliff/engine.rb
+- lib/kamiliff/version.rb
+- lib/tasks/kamiliff_tasks.rake
+homepage: https://github.com/etrex/kamiliff
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: An easy way to use LINE Front-end Framework(LIFF) on rails.
+test_files: []