cargobull 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8afc99ac65f76c719411449cec7fffb3117f2c80
+  data.tar.gz: fd4ad2a39ecd949df7233668ddd57b435f7cefe2
+SHA512:
+  metadata.gz: 5396ab2ec3a1ce7e4966bcad1320e49f48fbef53923d033a0806b5fc5f041aa6ab23840b37410406d02eb909b7c4d7bd5af3723389f749943deefb970d3e9d6d
+  data.tar.gz: 0571ae1fa809f89bc63f0e9dbce8bcd520253cd628202d6e77bca0752768fa54054c58e08142729665cdf2eb75a4d7089b3f08cc5f8cf9c66a073f947cb2c895

data/LICENSE.md

@@ -0,0 +1,23 @@
+Copyright (c) 2014, Matthias Geier
+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.
+
+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/lib/cargobull.rb

@@ -0,0 +1,11 @@
+require 'cargobull/extensions/string'
+require 'cargobull/env'
+require 'cargobull/service'
+require 'cargobull/dispatch'
+require 'cargobull/rackup'
+
+if File.exist?('./setup.rb')
+  require 'cargobull/initialize'
+  require './setup'
+  Cargobull::Initialize.init_all
+end

data/lib/cargobull/dispatch.rb

@@ -0,0 +1,47 @@
+
+module Cargobull
+  module Dispatch
+    def self.translate_method_call(method)
+      return case method.to_s.downcase
+      when "get", "post"
+        :read
+      when "put"
+        :create
+      when "patch"
+        :update
+      when "delete"
+        :delete
+      else
+        raise RuntimeError.new("Unsupported method: #{method}")
+      end
+    end
+
+    def self.translate_action_call(action)
+      klass = Service.dispatch_to(action)
+      if klass.nil?
+        raise RuntimeError.new("Unsupported action: #{action}")
+      end
+      return klass
+    end
+
+    def self.call(method, action, *args)
+      klass = self.translate_action_call(action)
+
+      blk = Cargobull.env.transform_in
+      args = [blk.call(*args)] if blk
+
+      obj = klass.new(*args)
+      method = self.translate_method_call(method)
+      unless obj.respond_to?(method)
+        raise RuntimeError.new("#{action} does not respond to #{method}")
+      end
+
+      return self.transform(obj.send(method))
+    end
+
+    def self.transform(data)
+      blk = Cargobull.env.transform_out
+      return blk ? blk.call(data) : data
+    end
+  end
+end

data/lib/cargobull/env.rb

@@ -0,0 +1,31 @@
+
+module Cargobull
+  def self.env
+    return Env
+  end
+
+  class Env
+    class << self
+      attr_reader :dispatch_url, :serve_url, :transform_out, :transform_in
+      attr_accessor :default_files
+    end
+
+    @dispatch_url = "/"
+    @serve_url = "/files"
+    @default_files = ['index.html', 'index.htm']
+
+    def self.dispatch_url=(url)
+      sanitized_url = (url || "").split('/').reject(&:empty?).first
+      @dispatch_url = sanitized_url ? "/#{sanitized_url}" : "/"
+      @serve_url = sanitized_url ? "/" : "/files"
+    end
+
+    def self.transform_out=(blk)
+      @transform_out = blk
+    end
+
+    def self.transform_in=(blk)
+      @transform_in = blk
+    end
+  end
+end

data/lib/cargobull/extensions/string.rb

@@ -0,0 +1,55 @@
+# = String class extension
+#
+# A string that is supposed to becode a Module, Class or similar can be
+# transformed by using #constantize
+#
+#   "Array".constantize
+#   => Array
+#
+# When writing file names in ruby, they are usually an underscore (snakecase)
+# representation of the class name. It can be transformed with #camelize and
+# in place with #camelize!
+#
+#   "file_reader".camelize
+#   => "FileReader"
+#
+#   s = "file_reader"
+#   s.camelize!
+#   s
+#   => "FileReader"
+#
+# The backwards transformation from a class name to snakecase is done with
+# #underscore and in place with #underscore!
+#
+#   "FileReader".underscore
+#   => "file_reader"
+#
+#   s = "FileReader".underscore
+#   s.underscore!
+#   s
+#   => "file_reader"
+#
+#
+#
+class String
+  def constantize
+    return self.to_s.split('::').reduce(Module){ |m, c| m.const_get(c) }
+  end
+
+  def camelize
+    return self.to_s.split(/_/).map(&:capitalize).join
+  end
+
+  def camelize!
+    self.replace(self.to_s.camelize)
+  end
+
+  def underscore
+    return self.to_s.split(/([A-Z]?[^A-Z]*)/).reject(&:empty?).
+      map(&:downcase).join('_')
+  end
+
+  def underscore!
+    self.replace(self.to_s.underscore)
+  end
+end

data/lib/cargobull/initialize.rb

@@ -0,0 +1,35 @@
+
+module Cargobull
+  module Initialize
+    @file_map = []
+
+    def self.sanitize_file_name(file_name)
+      return "./#{File.basename(file_name)}"
+    end
+
+    def self.dir(*args)
+      sanitized_args = args.map{ |d| sanitize_file_name(d).sub(/\/$/, '') }.
+        select{ |d| File.directory?(d) }
+
+      sanitized_args.each do |dir|
+        ruby_files = Dir["#{dir}/*.rb"]
+        @file_map = ruby_files.reduce(@file_map) do |acc, f|
+          file_name = File.basename(f).sub(/\.rb$/, '')
+          Object.autoload(file_name.camelize, f)
+          acc << f
+        end
+      end
+    end
+
+    def self.file(klass_str, file_name)
+      file_name = sanitize_file_name(file_name)
+      return unless File.file?(file_name)
+      Object.autoload(klass_str, file_name)
+      @file_map << file_name
+    end
+
+    def self.init_all
+      @file_map.each{ |file| require file }
+    end
+  end
+end

data/lib/cargobull/rackup.rb

@@ -0,0 +1,47 @@
+
+module Cargobull
+  class Rackup
+    def file(env)
+      path = env["REQUEST_PATH"]
+      path.gsub!(/\/\.+/, '')
+      path.sub!(/^#{Cargobull.env.serve_url}\/?/i, '')
+      if path.empty?
+        path = Cargobull.env.default_files.detect do |f|
+          File.file?("./files/#{f}")
+        end
+      end
+      path = "./files/#{path}"
+      if File.file?(path)
+        return [200, {}, File.open(path, File::RDONLY)]
+      else
+        return [404, {}, "Not found"]
+      end
+    end
+
+    def dispatch(env)
+      req = Rack::Request.new(env)
+      action = env["REQUEST_PATH"].sub(/^#{Cargobull.env.dispatch_url}\/?/, '').
+        gsub(/\/[^\/]+/, '')
+      params = req.POST.merge(req.GET)
+      data = Cargobull::Dispatch.call(env["REQUEST_METHOD"], action, params)
+      return [200, {}, data]
+    rescue RuntimeError
+      return [404, {}, "Not found"]
+    end
+
+    def self.routes
+      routes = [
+        [/^#{Cargobull.env.serve_url}\/?/i, :file],
+        [/^#{Cargobull.env.dispatch_url}\/?/i, :dispatch]
+      ]
+      routes.reverse! if Cargobull.env.serve_url == '/'
+      return routes.unshift([/^\/favicon/i, :file])
+    end
+
+    def call(env)
+      path = env["REQUEST_PATH"]
+      _, match_method = self.class.routes.detect{ |pattern, _| path =~ pattern }
+      return self.send(match_method, env)
+    end
+  end
+end

data/lib/cargobull/service.rb

@@ -0,0 +1,28 @@
+
+module Cargobull
+  module Service
+    @dispatch = []
+
+    def self.dispatch
+      return @dispatch
+    end
+
+    def self.dispatch_to(action)
+      return self.dispatch.detect do |klass|
+        next klass.name.underscore == action.to_s
+      end
+    end
+
+    def self.register(klass)
+      @dispatch << klass
+    end
+
+    def self.included(base)
+      self.register base
+    end
+
+    def initialize(*args)
+      @params = args.shift
+    end
+  end
+end

data/lib/cargobull/test_helper.rb

@@ -0,0 +1,37 @@
+require 'cargobull'
+
+module Cargobull
+  module TestHelper
+    def response
+      return @response || ""
+    end
+
+    [:get, :post, :put, :patch, :delete].each do |m|
+      define_method(m) do |action, *args|
+        @response = nil
+        @response = Cargobull::Dispatch.call(m, action, *args)
+      end
+    end
+
+    def assert_raise(except_klass)
+      begin
+        yield
+      rescue except_klass
+        assert true
+        return
+      end
+      assert false
+    end
+
+    def assert_nothing_raised
+      begin
+        yield
+        assert true
+      rescue
+        assert false
+      end
+    end
+  end
+end
+
+include Cargobull::TestHelper

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: cargobull
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matthias Geier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-01 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- lib/cargobull.rb
+- lib/cargobull/dispatch.rb
+- lib/cargobull/env.rb
+- lib/cargobull/extensions/string.rb
+- lib/cargobull/initialize.rb
+- lib/cargobull/rackup.rb
+- lib/cargobull/service.rb
+- lib/cargobull/test_helper.rb
+homepage: https://github.com/matthias-geier/cargobull
+licenses:
+- BSD-2
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.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: Multipurpose dispatcher for RESTful services
+test_files: []