alf-rest 0.14.0

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# 0.14.0 / 2013-10-01
+
+* Enhancements
+
+  * Birthday!

data/Gemfile

@@ -0,0 +1,21 @@
+source 'http://rubygems.org'
+
+group :runtime do
+  gem "alf-core", "~> 0.14.0"
+  gem "sinatra", "~> 1.3", ">= 1.3.2"
+  gem "rack-accept", "~> 0.4.5"
+end
+
+group :development do
+  gem "rake",  "~> 10.0"
+  gem "rspec", "~> 2.12"
+end
+
+group :test do
+  gem "cucumber",  "~> 1.2"
+  #gem "rack-test", "~> 0.6.1"
+  gem "rack-test",  :git => "git://github.com/brynary/rack-test.git"
+  gem "alf-sequel", "~> 0.14.0"
+  gem "sqlite3", "~> 1.3",      :platforms => ['mri', 'rbx']
+  gem "jdbc-sqlite3", "~> 3.7", :platforms => ['jruby']
+end

data/Gemfile.lock

@@ -0,0 +1,71 @@
+GIT
+  remote: git://github.com/brynary/rack-test.git
+  revision: 280ff54f50d25dd70e2ec1c55049e5ef7de126f3
+  specs:
+    rack-test (0.6.2)
+      rack (>= 1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    alf-core (0.14.0)
+      domain (~> 1.0)
+      myrrha (~> 3.0)
+      path (~> 1.3)
+      sexpr (~> 0.5.1)
+    alf-sequel (0.14.0)
+      alf-core (~> 0.14.0)
+      sequel (~> 3.48)
+    builder (3.2.2)
+    cucumber (1.3.5)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.12.0)
+      multi_json (~> 1.7.5)
+      multi_test (>= 0.0.2)
+    diff-lcs (1.2.4)
+    domain (1.0.0)
+    gherkin (2.12.0)
+      multi_json (~> 1.3)
+    multi_json (1.7.7)
+    multi_test (0.0.2)
+    myrrha (3.0.0)
+      domain (~> 1.0)
+    path (1.3.3)
+    rack (1.5.2)
+    rack-accept (0.4.5)
+      rack (>= 0.4)
+    rack-protection (1.5.0)
+      rack
+    rake (10.1.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.4)
+    rspec-expectations (2.14.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.1)
+    sequel (3.48.0)
+    sexpr (0.5.1)
+    sinatra (1.4.3)
+      rack (~> 1.4)
+      rack-protection (~> 1.4)
+      tilt (~> 1.3, >= 1.3.4)
+    sqlite3 (1.3.7)
+    tilt (1.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  alf-core (~> 0.14.0)
+  alf-sequel (~> 0.14.0)
+  cucumber (~> 1.2)
+  jdbc-sqlite3 (~> 3.7)
+  rack-accept (~> 0.4.5)
+  rack-test!
+  rake (~> 10.0)
+  rspec (~> 2.12)
+  sinatra (~> 1.3, >= 1.3.2)
+  sqlite3 (~> 1.3)

data/LICENCE.md

@@ -0,0 +1,22 @@
+# The MIT Licence
+
+    Copyright (c) 2012 - Bernard Lambeau
+
+    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/Manifest.txt

@@ -0,0 +1,12 @@
+rest.gemspec
+rest.noespec
+CHANGELOG.md
+Gemfile
+Gemfile.lock
+lib/**/*
+LICENCE.md
+Manifest.txt
+Rakefile
+README.md
+spec/**/*
+tasks/**/*

data/README.md

@@ -0,0 +1,11 @@
+# Alf::Rest
+
+[![Build Status](https://secure.travis-ci.org/alf-tool/alf-rest.png)](http://travis-ci.org/alf-tool/alf-rest)
+[![Dependency Status](https://gemnasium.com/alf-tool/alf-rest.png)](https://gemnasium.com/alf-tool/alf-rest)
+
+Put your alf relational database on the web quickly, simply, safely.
+
+## Links
+
+http://github.com/alf-tool/alf
+http://github.com/alf-tool/alf-rest

data/Rakefile

@@ -0,0 +1,11 @@
+# We run tests by default
+task :default => :test
+
+#
+# Install all tasks found in tasks folder
+#
+# See .rake files there for complete documentation.
+#
+Dir["tasks/*.rake"].each do |taskfile|
+  load taskfile
+end

data/lib/alf-rest.rb

@@ -0,0 +1 @@
+require_relative "alf/rest"

data/lib/alf/rest.rb

@@ -0,0 +1,30 @@
+require_relative 'rest/version'
+require_relative 'rest/loader'
+require_relative 'rest/errors'
+require_relative 'rest/alf-ext/renderer'
+require_relative 'rest/alf-ext/unit_of_work'
+module Alf
+  module Rest
+
+    # there are circular dependencies due to config default values :-(
+    class Agent;    end
+    class ErrorApp < Sinatra::Base; end
+
+    RACK_CONFIG_KEY = 'alf-rest-config'
+
+    RACK_ERROR_KEY = 'alf-rest-error'
+
+    def self.new(app, config = Config.new)
+      yield(config) if block_given?
+      Middleware.new(app, config)
+    end
+
+  end # module Rest
+end # module Alf
+require_relative 'rest/payload'
+require_relative 'rest/request'
+require_relative 'rest/response'
+require_relative 'rest/helpers'
+
+require_relative 'rest/config'
+require_relative 'rest/middleware'

data/lib/alf/rest/alf-ext/renderer.rb

@@ -0,0 +1,16 @@
+module Alf
+  class Renderer
+
+    def self.supported_media_types
+      each.map{|(_,_,r)| r.mime_type}.compact.sort
+    end
+
+    def self.from_http_accept(accept)
+      media_type = Rack::Accept::MediaType.new(accept)
+      if best = media_type.best_of(supported_media_types)
+        each.find{|(name,_,r)| r.mime_type == best }.last
+      end
+    end
+
+  end # class Renderer
+end # module Alf

data/lib/alf/rest/alf-ext/unit_of_work.rb

@@ -0,0 +1,3 @@
+require_relative 'unit_of_work/insert'
+require_relative 'unit_of_work/update'
+require_relative 'unit_of_work/delete'

data/lib/alf/rest/alf-ext/unit_of_work/delete.rb

@@ -0,0 +1,21 @@
+module Alf
+  module Sequel
+    module UnitOfWork
+      class Delete
+
+        def rack_status
+          200
+        end
+
+        def rack_body
+          {status: "success", message: "deleted"}
+        end
+
+        def rack_location(request)
+          nil
+        end
+
+      end # class Delete
+    end # module UnitOfWork
+  end # module Sequel
+end # module Alf

data/lib/alf/rest/alf-ext/unit_of_work/insert.rb

@@ -0,0 +1,22 @@
+module Alf
+  module Sequel
+    module UnitOfWork
+      class Insert
+
+        def rack_status
+          201
+        end
+
+        def rack_body
+          {status: "success", message: "created"}
+        end
+
+        def rack_location(request)
+          ids = matching_relation.tuple_extract.to_hash.values
+          "#{request.path}/#{ids.join(',')}"
+        end
+
+      end # class Insert
+    end # module UnitOfWork
+  end # module Sequel
+end # module Alf

data/lib/alf/rest/alf-ext/unit_of_work/update.rb

@@ -0,0 +1,22 @@
+module Alf
+  module Sequel
+    module UnitOfWork
+      class Update
+
+        def rack_status
+          200
+        end
+
+        def rack_body
+          {status: "success", message: "updated"}
+        end
+
+        def rack_location(request)
+          ids = pk_matching_relation.tuple_extract.to_hash.values
+          "#{request.path}/#{ids.join(',')}"
+        end
+
+      end # class Insert
+    end # module UnitOfWork
+  end # module Sequel
+end # module Alf

data/lib/alf/rest/config.rb

@@ -0,0 +1,55 @@
+module Alf
+  module Rest
+    class Config < Support::Config
+
+      # The database instance to use for obtaining connections
+      option :database, Database, nil
+
+      # The connection options to use
+      option :connection_options, Hash, {}
+
+      # Enclose all requests in a single database transaction
+      option :transactional, Boolean, true
+
+      # The logger instance to use for logging
+      option :logger, Object, Logger.new(STDOUT)
+
+      # The current database connection
+      attr_reader :connection
+
+      # Yields the block with the database connection
+      def connect(&bl)
+        return yield unless database
+        database.connect(connection_options) do |conn|
+          @connection = conn
+          if transactional?
+            conn.in_transaction{ yield(conn) }
+          else
+            yield(conn)
+          end
+        end
+      end
+
+      # Reconnect
+      def reconnect(opts)
+        connection.reconnect(opts)
+      end
+
+      # Sets the database, coercing it if required
+      def database=(db)
+        @database = db.is_a?(Database) ? db : Alf.database(db)
+      end
+
+      # Returns the default viewpoint to use
+      def viewpoint
+        connection_options[:viewpoint]
+      end
+
+      # Sets the default viewpoint on connection options
+      def viewpoint=(vp)
+        connection_options[:viewpoint] = vp
+      end
+
+    end # class Config
+  end # module Rest
+end # module Alf

data/lib/alf/rest/errors.rb

@@ -0,0 +1,5 @@
+module Alf
+  class FactAssertionError
+    attr_accessor :http_error_status
+  end
+end

data/lib/alf/rest/helpers.rb

@@ -0,0 +1,68 @@
+module Alf
+  module Rest
+    module Helpers
+      extend Forwardable
+
+      def alf_config
+        env[Rest::RACK_CONFIG_KEY]
+      end
+
+      def db_conn
+        alf_config.connection
+      end
+
+      def with_db_conn
+        yield(db_conn)
+      end
+
+      def_delegators :db_conn, :relvar,
+                               :query,
+                               :tuple_extract
+
+      def to_location(url, ids)
+        ids = ids.matching_relation if ids.respond_to?(:matching_relation)
+        ids = ids.tuple_extract     if ids.respond_to?(:tuple_extract)
+        ids = ids.to_hash.values
+        "#{url}/#{ids.join(',')}"
+      end
+
+      def location_set?
+        response.headers["Location"]
+      end
+
+      def assert!(msg='an assertion failed', status=nil, &bl)
+        db_conn.assert!(msg, &bl)
+      rescue FactAssertionError => ex
+        ex.http_error_status = status
+        raise
+      end
+
+      def deny!(msg='an assertion failed', status=nil, &bl)
+        db_conn.deny!(msg, &bl)
+      rescue FactAssertionError => ex
+        ex.http_error_status = status
+        raise
+      end
+
+      def fact!(msg='an assertion failed', status=nil, &bl)
+        db_conn.fact!(msg, &bl)
+      rescue FactAssertionError => ex
+        ex.http_error_status = status
+        raise
+      end
+
+      def no_duplicate!(&bl)
+        found = relvar(&bl)
+        unless found.empty?
+          ids = found.project(found.keys.first.to_attr_list)
+          halt Alf::Rest::Response.new(env){|r|
+            r.status = 200
+            r.body = {'status' => 'success', 'message' => 'skipped'}
+            r["Location"] = to_location(request.path, ids)
+          }.finish
+        end
+      end
+
+    end
+  end
+end

data/lib/alf/rest/loader.rb

@@ -0,0 +1,5 @@
+require 'json'
+require 'logger'
+require "alf-core"
+require "sinatra"
+require "rack/accept"

data/lib/alf/rest/middleware.rb

@@ -0,0 +1,19 @@
+module Alf
+  module Rest
+    class Middleware
+
+      def initialize(app, config)
+        @app    = app
+        @config = config
+      end
+
+      def call(env)
+        env[Rest::RACK_CONFIG_KEY] = cfg = @config.dup
+        cfg.connect do
+          @app.call(env)
+        end
+      end
+
+    end # class Middleware
+  end # module Rest
+end # module Alf