submit_once 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 85f1c862b474d561aa9f068ddabc0026584f6845
+  data.tar.gz: 8a5bf24515387032b101532da5e4ac85f01ba945
+SHA512:
+  metadata.gz: 259325e8da4ae1cdffd80d59bab01e4fa6b03e7a5b76ce9f1fe89cf54e8571602fe447a68b3624c9062c9050be39bae22d5278893913e418b3e55cfa6339e389
+  data.tar.gz: 304b8c1466fe831110bd6c912cfcd413829694f78d989fb1bcb19efcde804068532d1e34a03777264f789429d192305501c265b14b620d14f9649f49dc131afb

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea
+/bin
+/spec/dummy/tmp
+/spec/dummy/db/*.sqlite3
+/spec/dummy/log/*.log

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at bastengao@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in submit_once.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 bastengao
+
+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,68 @@
+# SubmitOnce
+
+Prevent from submitting form twice for Rails.
+
+Scenario: when user wanna add a post, usually go to *new* page first, input some information and submit,
+it will redirect to success page if these is no error. However after all if user click backward button on browser, it will render history page(the new page before), user could submit same form again.
+
+`SubmitOnce` gem resolve this problem. Form could be submitted only browser fetch a new fresh one.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'submit_once'
+```
+
+## Usage
+
+posts/new.html.erb
+```erb
+<%= form_for @post do |f| %>
+  <!-- token tag here -->
+  <%= form_token_tag %>
+
+  <%= f.text_field :title %>
+  ...
+  <%= f.submit %>
+<% end %>
+```
+
+posts_controller.rb
+```ruby
+class PostsController < ApplicationController
+  # return to root_url when form submit again
+  before_action :check_form_token!, only: [:create]
+  
+  # OR custom before action 
+  # before_action :custom_check_form_token
+
+  def index
+  end
+
+  def new
+  end
+
+  def create
+    ...
+  end
+  
+  private
+  def custom_check_form_token
+    # using `check_form_token`
+    unless check_form_token
+      redirect_to posts_url, alert: 'Invalid form token'
+    end
+  end
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/submit_once. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,22 @@
+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    = 'DummyPlugin'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/submit_once/controller_helper.rb

@@ -0,0 +1,35 @@
+require 'active_support/concern'
+
+module SubmitOnce
+  module ControllerHelper
+    extend ActiveSupport::Concern
+
+    included do
+      if respond_to?(:helper_method)
+        helper_method :gen_form_token
+      end
+    end
+
+    # TODO: force or no
+    def check_form_token
+      if session[TOKEN_KEY] == params[TOKEN_KEY]
+        session[TOKEN_KEY] = nil
+        true
+      else
+        false
+      end
+    end
+
+    def check_form_token!
+      unless check_form_token
+        # TODO: path, and i18n
+        redirect_to '/', notice: "Couldn't repeat submit form"
+      end
+    end
+
+    def gen_form_token
+      @__form_token ||=
+      (session[TOKEN_KEY] = Digest::SHA1.hexdigest((Time.now.to_i + rand(0xffffff)).to_s)[0..39])
+    end
+  end
+end

data/lib/submit_once/railtie.rb

@@ -0,0 +1,18 @@
+require 'rails'
+require 'submit_once/controller_helper'
+require 'submit_once/View_helper'
+
+module SubmitOnce
+  class Railtie < Rails::Railtie
+    initializer "submit_once.controller_helper" do
+      ActiveSupport.on_load :action_controller do
+        include ControllerHelper
+      end
+
+      ActiveSupport.on_load :action_view do
+        puts 'load action view'
+        include ViewHelper
+      end
+    end
+  end
+end

data/lib/submit_once/version.rb

@@ -0,0 +1,3 @@
+module SubmitOnce
+  VERSION = "0.1.0"
+end

data/lib/submit_once/view_helper.rb

@@ -0,0 +1,8 @@
+module SubmitOnce
+  module ViewHelper
+
+    def form_token_tag
+      hidden_field_tag(TOKEN_KEY, gen_form_token)
+    end
+  end
+end

data/lib/submit_once.rb

@@ -0,0 +1,4 @@
+TOKEN_KEY = :__form_token
+
+require "submit_once/version"
+require 'submit_once/railtie' if defined?(Rails)

data/submit_once.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'submit_once/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "submit_once"
+  spec.version       = SubmitOnce::VERSION
+  spec.authors       = ["bastengao"]
+  spec.email         = ["bastengao@gmail.com"]
+
+  spec.summary       = %q{Prevent from submitting form twice for rails.}
+  spec.description   = %q{Prevent from submitting form twice for rails.}
+  spec.homepage      = "https://github.com/bastengao/submit_once"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(bin|test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'rails', '>= 3.2', '< 5'
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'rspec-rails'
+  spec.add_development_dependency 'sqlite3'
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: submit_once
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- bastengao
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Prevent from submitting form twice for rails.
+email:
+- bastengao@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/submit_once.rb
+- lib/submit_once/controller_helper.rb
+- lib/submit_once/railtie.rb
+- lib/submit_once/version.rb
+- lib/submit_once/view_helper.rb
+- submit_once.gemspec
+homepage: https://github.com/bastengao/submit_once
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Prevent from submitting form twice for rails.
+test_files: []