spine-actions 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b5a593ef11624c695a463658e22a0fb0504190ee
+  data.tar.gz: bda9eae42751da87a9474b12399d2d3e155d9228
+SHA512:
+  metadata.gz: cf07c4502b41fe436f9136519bcce0b218c53e937222dec6f8b10344e4a53cedf1c49484742998f922277eb889718edeee23e10db2e94d37d95030b5ca5f1fcc
+  data.tar.gz: 4f66b317abd7bfdbcb3350a172374dee7297152e789b1940dac11be72a4bb12d109fd81982fb3d797bceb938fcf69ad149aa026b207937ac6bcf01c3594d8472

data/.gitignore

@@ -0,0 +1,36 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/bin/
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+Changelog
+=========
+
+0.1.0
+-----
+-   First public release

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,23 @@
+PATH
+  remote: .
+  specs:
+    spine-actions (0.1.0)
+      rack (~> 1.6)
+      spine-content_types (~> 0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    multi_json (1.11.0)
+    rack (1.6.1)
+    rake (10.4.2)
+    spine-content_types (0.1.0)
+      multi_json (~> 1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.7)
+  rake (~> 10.0)
+  spine-actions!

data/LICENSE

@@ -0,0 +1,12 @@
+Copyright (c) 2015, TOGGL LLC
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. 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.
+
+3. Neither the name of the TOGGL LLC 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,79 @@
+# Spine::Actions
+
+[![Gem Version](https://badge.fury.io/rb/spine-actions.svg)](http://badge.fury.io/rb/spine-actions)
+[![Dependency Status](https://gemnasium.com/rspine/actions.svg)](https://gemnasium.com/rspine/actions)
+[![Code Climate](https://codeclimate.com/github/rspine/actions/badges/gpa.svg)](https://codeclimate.com/github/rspine/actions)
+
+HTTP endpoint action with before and after callbacks, response builder.
+
+## Installation
+
+To install it, add the gem to your Gemfile:
+
+```ruby
+gem 'spine-actions'
+```
+
+Then run `bundle`. If you're not using Bundler, just `gem install spine-actions`.
+
+## Usage
+
+Each action can access Rack `env`, `request` and `response`.
+
+Action provides following methods to respond: `respond(content, options)`,
+`redirect(url, options)` and `send_data(binary, options)`. Options include
+`:status`, `:content_type`, `:data` and `:filename`.
+
+Response headers can be set using `response['header-name'] = 'value'`
+before running response.
+
+```ruby
+class Status < Spine::Actions::Action
+  before :authenticate
+  after :close_connections
+
+  # It will be used as response type. Default is Spine::ContentTypes::Html
+  def format
+    Spine::ContentTypes::Json
+  end
+
+  def action
+    # ...
+    respond({ status: 'OK' }, status: 200)
+  end
+
+  def authenticate
+    # ...
+  end
+
+  def close_connections
+    # ...
+  end
+end
+
+
+Status.call(env)
+```
+
+### Using with default Rack routing
+
+```ruby
+# config.ru
+
+map 'status' do
+  run Status
+end
+```
+
+### Using with Spine::Routing
+
+```ruby
+# config.ru
+
+router = Spine::Routing::Router.new
+router.configure do
+  get :status, to: Status
+end
+
+run router
+```

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/spine/actions/action.rb

@@ -0,0 +1,31 @@
+module Spine
+  module Actions
+    class Action
+      extend Filters
+      include Responder
+      include Formats
+      include Parameters
+
+      attr_reader :env, :request, :response
+
+      def initialize(env)
+        @env = env
+        @request = Rack::Request.new(env)
+        @response = Rack::Response.new
+      end
+
+      def self.call(env)
+        handler = new(env)
+
+        process_filters(handler, before_filters_with_parents)
+        return handler.response.finish if handler.responded?
+
+        handler.action
+        process_filters(handler, after_filters_with_parents)
+
+        raise StandardError.new('No response defined') unless handler.responded?
+        handler.response.finish
+      end
+    end
+  end
+end

data/lib/spine/actions/filters.rb

@@ -0,0 +1,44 @@
+module Spine
+  module Actions
+    module Filters
+      def before(method_name)
+        before_filters << method_name
+      end
+
+      def after(method_name)
+        after_filters << method_name
+      end
+
+      def process_filters(handler, filters)
+        filters.detect do |name|
+          handler.public_send(name) if handler.respond_to?(name)
+          handler.responded?
+        end
+      end
+
+      def before_filters
+        @before_filters ||= []
+      end
+
+      def before_filters_with_parents
+        if superclass.respond_to?(:before_filters_with_parents)
+          superclass.before_filters_with_parents + before_filters
+        else
+          before_filters
+        end
+      end
+
+      def after_filters
+        @after_filters ||= []
+      end
+
+      def after_filters_with_parents
+        if superclass.respond_to?(:after_filters_with_parents)
+          after_filters + superclass.after_filters_with_parents
+        else
+          after_filters
+        end
+      end
+    end
+  end
+end

data/lib/spine/actions/formats.rb

@@ -0,0 +1,11 @@
+require 'spine/content_types'
+
+module Spine
+  module Actions
+    module Formats
+      def format
+        ContentTypes::Html
+      end
+    end
+  end
+end

data/lib/spine/actions/parameters.rb

@@ -0,0 +1,9 @@
+module Spine
+  module Actions
+    module Parameters
+      def params
+        request.params
+      end
+    end
+  end
+end

data/lib/spine/actions/responder.rb

@@ -0,0 +1,56 @@
+require 'rack'
+require 'uri'
+
+module Spine
+  module Actions
+    module Responder
+      def responded?
+        @responded
+      end
+
+      def respond(content, options = {})
+        response[Rack::CONTENT_TYPE] = options.fetch(:content_type) {
+          format.mime_type
+        }
+        response.status = options[:status] if options[:status]
+        response.write(format.dump(content))
+
+        finish_response
+      end
+
+      def send_data(binary, options = {})
+        response['Content-Transfer-Encoding'] = 'binary'
+        response[Rack::CONTENT_TYPE] = options.fetch(:content_type, 'application/octet-stream')
+
+        if options[:filename]
+          response['Content-Disposition'] = "inline; filename='#{ options[:filename] }'"
+        end
+        response.write(binary)
+
+        finish_response
+      end
+
+      def redirect(url, options = {})
+        response[Rack::CONTENT_TYPE] = 'application/x-www-form-urlencoded'
+        response.redirect(
+          build_url(url, options.fetch(:data, {})),
+          options.fetch(:status, 302)
+        )
+
+        finish_response
+      end
+
+      def finish_response
+        @responded = true
+        response
+      end
+
+      def build_url(url, data)
+        uri = URI(url)
+        query = URI.decode_www_form(uri.query || '') || []
+        uri.query = URI.encode_www_form(query + data.to_a)
+        uri.to_s
+      end
+    end
+  end
+end

data/lib/spine/actions/version.rb

@@ -0,0 +1,5 @@
+module Spine
+  module Actions
+    VERSION = "0.1.0"
+  end
+end

data/lib/spine/actions.rb

@@ -0,0 +1,9 @@
+module Spine
+  module Actions
+    autoload :Action, 'spine/actions/action'
+    autoload :Parameters, 'spine/actions/parameters'
+    autoload :Filters, 'spine/actions/filters'
+    autoload :Formats, 'spine/actions/formats'
+    autoload :Responder, 'spine/actions/responder'
+  end
+end

data/spine-actions.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'spine/actions/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "spine-actions"
+  spec.version       = Spine::Actions::VERSION
+  spec.authors       = ["TOGGL LLC"]
+  spec.email         = ["support@toggl.com"]
+  spec.summary       = 'Web application request handlers.'
+  spec.description   = ''
+  spec.homepage      = 'https://github.com/rspine/actions'
+  spec.license       = 'BSD-3-Clause'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'rack', "~> 1.6"
+  spec.add_dependency 'spine-content_types', "~> 0.1"
+
+  spec.add_development_dependency 'bundler', "~> 1.7"
+  spec.add_development_dependency 'rake', "~> 10.0"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: spine-actions
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- TOGGL LLC
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: spine-content_types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.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: ''
+email:
+- support@toggl.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/spine/actions.rb
+- lib/spine/actions/action.rb
+- lib/spine/actions/filters.rb
+- lib/spine/actions/formats.rb
+- lib/spine/actions/parameters.rb
+- lib/spine/actions/responder.rb
+- lib/spine/actions/version.rb
+- spine-actions.gemspec
+homepage: https://github.com/rspine/actions
+licenses:
+- BSD-3-Clause
+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.5
+signing_key: 
+specification_version: 4
+summary: Web application request handlers.
+test_files: []