revoke 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2cce86b0069c6ea07882712a63d598c1a4460295f7c8d477db04d6e2ef145ea5
+  data.tar.gz: 9f93bc55f89db92dd1846a5d1856c8698882eae79d06207ce1a678bfba5d2552
+SHA512:
+  metadata.gz: cef794bbb51b1f6d04d62a83336a9b2092f612b56201af68ed34060e9b339b9c7b2c9316585edbe512420a6501457893568f14f6b7335c753c3d603396fd838a
+  data.tar.gz: 7ae22723e34651a78e61b44eb14bfa95402adf3c9b267b4216e7600802498f83fdfe4be0304e51289138a8cfba1337876cf73e9d2cd08cc4ac778b2b41a5a3a1

data/.byebug_history

@@ -0,0 +1,33 @@
+c
+@subject.respond_to? :revoke_update_handler, true
+c
+@subject.respond_to?(:revoke_update_handler)
+@subject.send(:revoke_update_handler)
+@subject.revoke_update_handler
+@subject
+c
+@subject._update_callbacks.filter
+@subject._update_callbacks
+@subject.:_update_callbacks
+@subject.public_methods(false)
+@subject.public_methods(false).grep /revoke/
+FakeModel.public_methods(false).grep /revoke/
+FakeModel.public_methods(false)
+FakeModel.public_methods
+FakeModel.__callbacks
+@subject.revoke_udpdate_handler
+@subject
+2subject
+c
+@subject.respond_to?(:revoke_update_handler)
+@subject
+c
+subject
+c
+subject
+c
+FakeModel.__callbacks[:update].select { |x| x.instance_variable_get("@filter") == :revoke_update_handler }.first
+FakeModel.__callbacks[:update].select { |x| x.instance_variable_get("@filter") == :revoke_update_handler }
+FakeModel.__callbacks[:update]
+FakeModel.__callbacks
+FakeMode.__callbacks

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in revoke.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    revoke (0.1.0)
+      activerecord
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.1)
+      activesupport (= 5.2.1)
+    activerecord (5.2.1)
+      activemodel (= 5.2.1)
+      activesupport (= 5.2.1)
+      arel (>= 9.0)
+    activesupport (5.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    byebug (10.0.2)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    i18n (1.1.1)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord
+  bundler (~> 1.16)
+  byebug
+  rake (~> 10.0)
+  revoke!
+  rspec (~> 3.7)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Abhishek kanojia
+
+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,79 @@
+![alt text](https://raw.githubusercontent.com/abhishekkanojia/images/master/revoke_gem.png "Revoke Gem")
+# Revoke
+Adding revoke to your application provides you with an ability to prevent create, update and delete of an entity based on some event.
+
+#### Usecase
+Your blog application has comments on articles which you want to be updated only within 10 minutes of creation. Here, `Revoke` gem comes handy to handle this scenario with ease.
+
+# Requirements
+Revoke currently supports **Rails 5.2.0** and **Ruby >= 2.4.1**.
+
+
+# Installation
+Add following line to `Gemfile` and `bundle`
+
+```ruby
+ gem 'revoke'
+ ```
+OR
+```ruby
+gem install revoke
+```
+# How to Use ?
+
+Revoke gem provides two forms of `revoke` class method which can be called in model to prevent create, update or delete based on condition.
+You can revoke 3 actions:
+## Event Revoke
+##### Update
+---
+```ruby
+# Revoke update of object after 10 minutes of its creation.
+ revoke :update, :after, 10.minutes, :creation
+
+ # Revoke destroy of object after 10.minutes of its updation.
+ revoke :destroy, :after, 10.minutes, :updation
+```
+#### Destroy
+---
+```ruby
+# Revoke destroy of object after 10 minutes of its creation.
+ revoke :destroy, :after, 10.minutes, :creation
+```
+`Default error message: '{class_name} can only be {destroyed|updated} for {time_duration} after #{creation|updation}.`
+
+## Conditional Revoke
+```ruby
+revoke :update, if: :some_method?
+```
+
+```ruby
+revoke :create, if: :some_method?
+```
+
+```ruby
+revoke :destroy, if: :some_method?
+```
+`Default error message: "Operation not allowed."`
+## Customizing Error Messages
+
+These error message can be overridden with `message` option passed alongwith `revoke` method.
+
+```ruby
+ revoke :destroy, :after, 10.minutes, :creation, message: 'Cannot destroy.'
+ revoke :update, if: :some_condition?, message: 'Update not allowed.'
+ revoke :destroy, if: :some_condition?, message: 'Destroy not allowed.'
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, update the rspec and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/abhishekkanojia/revoke.
+
+## 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,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "revoke"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/locales/en.yml

@@ -0,0 +1,8 @@
+en:
+  revoke:
+    destroy:
+      after:
+        error: '%{class_name} can only be destroyed for %{time} %{event} %{deciding_event}.'
+    update:
+      after:
+        error: '%{class_name} can only be updated for %{time} %{event} %{deciding_event}.'

data/lib/revoke.rb

@@ -0,0 +1,27 @@
+require "revoke/version"
+require "revoke/constants"
+require "revoke/callback_creator"
+require "revoke/conditional_callback_creator"
+require "revoke/engine" if defined?(Rails)
+
+module Revoke
+
+  include Constants
+
+  def self.included(klass)
+    klass.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    def revoke(*args)
+      if args.size.eql?(2)
+        Revoke::ConditionalCallbackCreator.new(self, args[0], args[1])
+      else
+        Revoke::CallbackCreator.new(self, args[0], args[1], args[2], args[3], args[4])
+      end
+    end
+
+  end
+end
+
+ActiveRecord::Base.send :include, Revoke if defined?(Rails)

data/lib/revoke/callback_creator.rb

@@ -0,0 +1,83 @@
+module Revoke
+  class CallbackCreator
+    def initialize(class_name, callback_name, event, time, deciding_event, options = {})
+
+      if parameters_valid?(callback_name, event, time, deciding_event)
+        error_message = options[:message] if options.present?
+
+        class_name.class_eval do
+
+          send("before_#{callback_name}", :"revoke_#{callback_name}_handler")
+
+          define_method("revoke_#{callback_name}_handler") do
+
+            difference = (Time.current - self.send(Revoke::Constants::ACTION_MAP[deciding_event])).to_i
+
+            if difference.positive? && difference.send(Revoke::Constants::EVENT[event], time)
+              errors.add(:base, (error_message || I18n.t(:error, scope: [:revoke, callback_name, :after], class_name: self.class.name, time: send("allowed_time_to_#{callback_name}?"), event: event, deciding_event: deciding_event)))
+              throw(:abort)
+            end
+          end
+
+          define_method("allowed_time_to_#{callback_name}?") do
+            parts = ActiveSupport::Duration.build(time.to_i).parts
+            ''.tap do |string|
+              parts.each_pair do |key, value|
+                string.concat("#{value} #{key}")
+              end
+              string
+            end
+          end
+
+          private :"revoke_#{callback_name}_handler"
+        end
+      end
+    end
+
+    def parameters_valid?(callback_name, event, time, deciding_event)
+      callback_valid?(callback_name) &&
+      event_valid?(event) &&
+      time_valid?(time) &&
+      deciding_event_valid?(deciding_event)
+    end
+
+    private def callback_valid?(callback_name)
+      if callback_name.in?(Revoke::Constants::ACTION)
+        true
+      else
+        raise_error_message(callback_name, Revoke::Constants::ACTION)
+      end
+    end
+
+    private def event_valid?(event)
+      allowed_event_keys = Revoke::Constants::EVENT.keys
+      if event.in?(allowed_event_keys)
+        true
+      else
+        raise_error_message(event, allowed_event_keys)
+      end
+    end
+
+    private def time_valid?(time)
+      if time.is_a?(ActiveSupport::Duration)
+        true
+      else
+        raise ArgumentError, 'Enter duration like: 10.seconds'
+      end
+    end
+
+    private def deciding_event_valid?(deciding_event)
+      allowed_deciding_events = Revoke::Constants::ACTION_MAP.keys
+      if deciding_event.in?(allowed_deciding_events)
+        true
+      else
+        raise_error_message(deciding_event, allowed_deciding_events)
+      end
+    end
+
+    private def raise_error_message(option, allowed_options)
+      raise ArgumentError, "Invalid option supplied: #{option}\n Allowed Options: #{allowed_options.join(', ')}"
+    end
+
+  end
+end

data/lib/revoke/conditional_callback_creator.rb

@@ -0,0 +1,48 @@
+module Revoke
+  class ConditionalCallbackCreator
+
+    VALID_CALLBACK_NAME = [:create, :update, :destroy].freeze
+    DEFAULT_MESSAGE = 'Operation not allowed'.freeze
+
+    def initialize(class_name, callback_name, options)
+
+      unless callback_name.in?(VALID_CALLBACK_NAME)
+        raise ArgumentError, 'Invalid callback name, valid options are create, update and destroy.'
+      end
+
+      message = options[:message] || DEFAULT_MESSAGE
+
+      class_name.class_eval do
+
+        send("before_#{callback_name}", :"revoke_#{callback_name}_conditional_handler")
+
+        define_method("revoke_#{callback_name}_conditional_handler") do
+          if options[:if].present?
+            callable = options[:if]
+          elsif options[:unless].present?
+            callable = options[:unless]
+          else
+            raise ArgumentError, 'Invalid argument supplied for revoke.'
+          end
+
+          if callable.is_a?(Proc)
+            if callable.call
+              errors.add(:base, message)
+              throw(:abort)
+            end
+          end
+
+          if callable.is_a?(Symbol)
+            if send(callable)
+              errors.add(:base, message)
+              throw(:abort)
+            end
+          end
+        end
+
+        private :"revoke_#{callback_name}_conditional_handler"
+      end
+    end
+
+  end
+end

data/lib/revoke/constants.rb

@@ -0,0 +1,13 @@
+module Revoke
+  module Constants
+    ACTION = %i[update destroy].freeze
+    EVENT = {
+      after: '>'
+    }.freeze
+    ACTION_MAP = {
+      creation: 'created_at',
+      updation: 'updated_at',
+      deletion: 'deleted_at'
+    }.freeze
+  end
+end

data/lib/revoke/engine.rb

@@ -0,0 +1,6 @@
+require 'rails'
+
+module Revoke
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/revoke/version.rb

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

data/revoke.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "revoke/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "revoke"
+  spec.version       = Revoke::VERSION
+  spec.authors       = ["Abhishek kanojia"]
+  spec.email         = ["abhishek.kanojia3193@gmail.com"]
+
+  spec.summary       = %q{Add time based restriction to your rails application with Revoke gem.}
+  spec.description   = %q{Revoke provides easy an easier way to prevent your rail's application model from being updated based on an event.}
+  spec.homepage      = "https://github.com/abhishekkanojia/revoke.git"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'activerecord'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'activerecord'
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'rspec', '~> 3.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: revoke
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Abhishek kanojia
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-11-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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: byebug
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !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'
+description: Revoke provides easy an easier way to prevent your rail's application
+  model from being updated based on an event.
+email:
+- abhishek.kanojia3193@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".byebug_history"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/locales/en.yml
+- lib/revoke.rb
+- lib/revoke/callback_creator.rb
+- lib/revoke/conditional_callback_creator.rb
+- lib/revoke/constants.rb
+- lib/revoke/engine.rb
+- lib/revoke/version.rb
+- revoke.gemspec
+homepage: https://github.com/abhishekkanojia/revoke.git
+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.7.7
+signing_key: 
+specification_version: 4
+summary: Add time based restriction to your rails application with Revoke gem.
+test_files: []