rack-transaction 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7344d9a199dd181db1cef5252d21aa6b4b11ff51
+  data.tar.gz: 4e50793aef557b46c300ce3f0fa2940ae8af2d93
+SHA512:
+  metadata.gz: db561213fd61612450a54cfb64a5ca4905d22e5d01210e7a0b7be7ae9094f1ae9606e321a4d12288641938c040a31690374e0a4c704854bd7093f78e55654ac6
+  data.tar.gz: 2d91aa10d58c39b847c99543af4ef29f05b517d8aeb9de4f439ebfe1a5f327efe114620a39a01f96bbae41091372ad614aec704bac88ce14052a9ae3a22968d3

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+vendor/bundle
+*.swp

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'rack-test'
+  gem 'rake'
+  gem 'sequel'
+  gem 'sqlite3'
+end

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'minitest' do
+  watch(%r|^spec/.+_spec\.rb|)
+  watch(%r|^lib/(.+)\.rb$|)     { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r|^spec/spec_helper\.rb|)    { "spec" }
+end

data/LICENSE

@@ -0,0 +1,28 @@
+Copyright (c) 2015, peer60
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+- Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+- Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+- Neither the name of Katalus nor the names of its contributors may be used
+  to endorse or promote products derived from this software without specific
+  prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
+THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,54 @@
+# Rack::Transaction #
+
+Rack::Transaction is a rack middleware that automatically wraps any incoming
+requests with potential side effects (i.e. POST, PUT, or DELETE).
+
+## Installation
+
+Add this line to your Gemfile:
+
+```ruby
+gem 'rack-transaction', :require => 'rack/transaction'
+```
+
+or
+
+```
+gem install rack-transaction
+```
+
+## Usage
+
+Add the following:
+
+```ruby
+use Rack::Transaction,
+  provider: Sequel.connect('sqlite:///')  #required
+  rollback: Sequel::Rollback              #required (it also accepts the string version of the constant)
+```
+
+Do note that `:rollback` will use the type specified to raise an error, which
+in turn, causes the transaction to rollback. Depending on the `:provider`
+providing the transaction, you may want to specify an error type provided by
+the library being used to allow for more graceful error handling. For example,
+Sequel has `Sequel::Rollback` and ActiveRecord has `ActiveRecord::Rollback`.
+
+It also supports an optional error callback to check for errors in the
+environment outside of the normal client or server errors. For example, Sinatra
+sets `sinatra.error` on the `env` in the event of an error, so we'll probably
+want to rollback.  We can check for this by specifying the `:error` setting.
+
+```ruby
+use Rack::Transaction,
+  provider: Sequel.connect('sqlite:///')
+  rollback: Sequel::Rollback
+  error: ->(env){ env['sinatra.error'] }
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs = ['spec', 'lib']
+  t.pattern = 'spec/**/*_spec.rb'
+end

data/lib/rack/transaction.rb

@@ -0,0 +1,40 @@
+module Rack
+  class Transaction
+    VERSION = "0.1.0".freeze
+
+    def initialize(inner, settings)
+      @inner = inner
+      @provider = settings.fetch(:provider)
+      @rollback = settings.fetch(:rollback)
+      @error = settings[:error]
+    end
+
+    def call(env)
+      return @inner.call(env) unless use_transaction?(env)
+
+      result = nil
+      @provider.transaction do
+        result = @inner.call(env)
+        rollback if has_error?(env, *result)
+      end
+      result
+    end
+
+    private
+
+    def has_error?(env, status, headers, body)
+      response = Response.new body, status, headers
+      response.client_error? || response.server_error? || (@error.respond_to?(:call) && @error.call(env))
+    end
+
+    def rollback
+      klass = @rollback.is_a?(String) ? Object.const_get(@rollback) : @rollback
+      raise klass
+    end
+
+    def use_transaction?(env)
+      request = Request.new env
+      !(request.get? || request.head? || request.options?)
+    end
+  end
+end

data/rack-transaction.gemspec

@@ -0,0 +1,15 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/rack/transaction', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.author        = 'vyrak.bunleang@gmail.com'
+  gem.homepage      = 'https://github.com/p60/rack-transaction'
+  gem.description   = 'Middleware for transactions'
+  gem.summary       = 'Middleware for transactions'
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = 'rack-transaction'
+  gem.require_paths = ["lib"]
+  gem.version       = Rack::Transaction::VERSION
+end

data/spec/rack/transaction_spec.rb

@@ -0,0 +1,103 @@
+require 'spec_helper'
+require 'rack/transaction'
+
+describe Rack::Transaction do
+  let(:inner){ mock }
+  let(:env){ {'field' => 'variable'} }
+  let(:table_name){ :rack }
+  let(:dataset){ connection[table_name] }
+  let(:rollback){ Sequel::Rollback }
+  let(:settings){ {provider: connection, rollback: rollback} }
+
+  subject { Rack::Transaction.new inner, settings }
+
+  before do
+    connection.create_table table_name do
+      column :name, String, null: false
+    end
+  end
+
+  after do
+    connection.drop_table table_name
+    inner.verify
+  end
+
+  def expect_call(status)
+    inner.expect :call, [status, {}, []] do |(environment), *args|
+      dataset.insert(name: 'insert') if args.empty? && environment == env
+    end
+  end
+
+  it 'wont rollback when ok' do
+    expect_call 200
+    result = subject.call env
+    result.must_equal [200, {}, []]
+    dataset.wont_be :empty?
+  end
+
+  it 'wont roll back on redirect' do
+    expect_call 301
+    result = subject.call env
+    result.must_equal [301, {}, []]
+    dataset.wont_be :empty?
+  end
+
+  it 'rolls back on server error' do
+    expect_call 500
+    result = subject.call env
+    result.must_equal [500, {}, []]
+    dataset.must_be :empty?
+  end
+
+  it 'rolls back on client error' do
+    expect_call 400
+    result = subject.call env
+    result.must_equal [400, {}, []]
+    dataset.must_be :empty?
+  end
+
+  it 'rolls back on custom error callback' do
+    args = nil
+    settings[:error] = ->(*a){ args = a; true }
+    expect_call 200
+    result = subject.call env
+    result.must_equal [200, {}, []]
+    dataset.must_be :empty?
+    args.must_equal [env]
+  end
+
+  it 'rolls back on string rollback' do
+    settings[:rollback] = "Sequel::Rollback"
+    expect_call 400
+    result = subject.call env
+    result.must_equal [400, {}, []]
+    dataset.must_be :empty?
+  end
+
+  %w{ GET HEAD OPTIONS }.each do |method|
+    # shouldn't be modifying anything on these types of requests; modifying for assertion purposes
+
+    describe "on #{method} request" do
+      before { env['REQUEST_METHOD'] = method }
+
+      it 'wont rollback on custom error callback' do
+        settings[:error] = ->{ true }
+        expect_call 200
+        subject.call env
+        dataset.wont_be :empty?
+      end
+
+      it 'wont rollback on server error' do
+        expect_call 500
+        subject.call env
+        dataset.wont_be :empty?
+      end
+
+      it 'wont rollback on client error' do
+        expect_call 400
+        subject.call env
+        dataset.wont_be :empty?
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'bundler/setup'
+Bundler.require :development
+
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'minitest/pride'
+require 'minitest/autorun'
+
+class Minitest::Spec
+  def mock
+    Minitest::Mock.new
+  end
+
+  def connection
+    @connection ||= Sequel.connect 'sqlite:///'
+  end
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: rack-transaction
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- vyrak.bunleang@gmail.com
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-28 00:00:00.000000000 Z
+dependencies: []
+description: Middleware for transactions
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/rack/transaction.rb
+- rack-transaction.gemspec
+- spec/rack/transaction_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/p60/rack-transaction
+licenses: []
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Middleware for transactions
+test_files:
+- spec/rack/transaction_spec.rb
+- spec/spec_helper.rb