opi 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1d5fda4ffbb7acce5d6c4a7f0f0fcc91d9c1cd2f
+  data.tar.gz: 1e27c75791cd7020ae3e94657dca5b42eedeebd6
+SHA512:
+  metadata.gz: 3628bf167bae180b00fc035355e8841b0840eeed852c4e7d040563198fb3b24ac531c637066d40937b1b39692b6ea96954c8a635378e03dc5c39b968a240984c
+  data.tar.gz: 12ebe8eb10d4f4144f841051d03d8a11d6331363d47d8332f4d54e98b61c64ebe44f3bb3bf0b2a734ad210ea52b14a4ee8de8c6a948b97e9d7f20d98d4a68f94

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) Richard Taylor
+
+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.textile

@@ -0,0 +1,99 @@
+h1. Opi - The very opinionated API service library
+
+h2. Install the gem
+
+gem 'opi'
+
+h2. About
+
+Opi is a very opinionated rack-compliant API service library.  In fact, it is
+so opinionated it is very likely to offend.  But that is alright.
+
+Opi was born out of frustration with writing too much boilerplate code for api
+services.
+
+*JSON-only*.  The server CANNOT respond with anything else other than JSON.
+All error responses are JSON out of the box.  You CANNOT respond with HTML.
+The response content type is hardcoded to JSON.
+
+*No Controllers*.  Well.. there are route blocks which are the equivalent
+of the controller but you are strongly encouraged to only ever execute actions
+in these blocks (the server is looking out for those actions as responses).
+The only role of the 'controller' here is to map HTTP inputs to Action inputs.
+
+*Action-based*.  All logic is an action.  Actions validate their own inputs
+and have no access to anything HTTP-related.  These are domain-specific actions
+that can be pulled out and used anywhere.
+
+*No Sessions or Cookies*.  None.
+
+But this has its advantages.  It is *fast* and *simple*.
+
+h2. Example
+
+This simple example doesn't really go into the detail of Actions but it does
+demonstrate the routes, responses, before filters and helpers.
+
+<code>api.rb</code>
+
+<pre><code>module Example
+  class API < Opi::API
+
+    before :authorize!
+
+    get '/ping', :skip => :authorize! do
+      {:pong => Time.now.to_i}
+    end
+
+    get '/meaning' do
+      {:answer => 42}
+    end
+
+    helpers do
+      def authorize!
+        error!('401 Unauthorized', 401) unless params['secret'] == '1234'
+      end
+    end
+
+  end
+end
+</code></pre>
+
+<code>config.ru</code>
+
+<pre><code>require 'opi'
+
+load './api.rb'
+run Example::API.new
+</code></pre>
+
+<code>output</code>
+
+<pre><code>$ curl -i http://0.0.0.0:9292/ping
+HTTP/1.1 200 OK
+Content-Type: application/json
+Transfer-Encoding: chunked
+
+{"pong":1387810814}
+
+$ curl -i http://0.0.0.0:9292/meaning
+HTTP/1.1 401 Unauthorized
+Content-Type: application/json
+Transfer-Encoding: chunked
+
+{"error":"401 Unauthorized"}
+
+$ curl -i http://0.0.0.0:9292/meaning?secret=1234
+HTTP/1.1 200 OK
+Content-Type: application/json
+Transfer-Encoding: chunked
+
+{"answer":42}
+
+$ curl -i http://0.0.0.0:9292/nonexistant
+HTTP/1.1 404 Not Found
+Content-Type: application/json
+Transfer-Encoding: chunked
+
+{"error":"404 Not Found"}
+</code></pre>

data/lib/opi.rb

@@ -0,0 +1,16 @@
+require 'rack'
+require 'colored'
+require 'json'
+require 'mutations'
+
+require_relative './opi/version'
+require_relative './opi/api'
+require_relative './opi/request'
+require_relative './opi/response'
+require_relative './opi/action'
+require_relative './opi/context'
+require_relative './opi/loader'
+
+module Opi
+  VERSION = '1.0'
+end

data/lib/opi/action.rb

@@ -0,0 +1,4 @@
+module Opi
+  class Action < Mutations::Command
+  end
+end

data/lib/opi/api.rb

@@ -0,0 +1,75 @@
+module Opi
+  class API
+
+    class << self
+      def get(path, options={}, &block)
+        route 'GET', path, options, block
+      end
+
+      def post(path, options={}, &block)
+        route 'POST', path, options, block
+      end
+
+      def put(path, &block)
+        route 'PUT', path, options, block
+      end
+
+      def delete(path, options={}, &block)
+        route 'DELETE', path, options, block
+      end
+
+      def route(method, path, options={}, block)
+        # TODO: remove&replace existing routes (on reload)
+        routes.unshift({:method => method, :path => path, :options => options, :block => block})
+      end
+
+      def before(method)
+        before_filters << method
+      end
+
+      def after(method)
+        after_filters << method
+      end
+
+      def before_filters
+        @before_filters ||= []
+      end
+
+      def after_filters
+        @after_filters ||= []
+      end
+
+      def routes
+        @routes ||= []
+      end
+
+      def helpers(&block)
+        mod = Module.new
+        mod.class_eval &block
+        Context.send :include, mod
+      end
+
+    end
+
+    def call(env)
+      begin
+        Loader.reload!
+
+        request = Request.new(env)
+
+        route = self.class.routes.detect{|x| x[:method] == request.method and x[:path] == request.path}
+
+        return [404, {'Content-Type' => 'application/json'}, ["{\"error\":\"404 Not Found\"}", "\n"]] unless route
+
+        context = Context.new(env, route, request, self.class.before_filters, self.class.after_filters)
+        response = context.run
+
+        [response.status, response.header, response.body]
+      rescue Exception => e
+        return [500, {'Content-Type' => 'application/json'}, ["{\"error\":\"500 Internal Server Error\", \"message\":\"#{e.message}\"}", "\n"]]
+      end
+    end
+
+  end
+
+end

data/lib/opi/context.rb

@@ -0,0 +1,63 @@
+module Opi
+  class Context
+
+    attr_reader :env, :route, :request, :response, :before, :after, :error
+
+    def initialize(env, route, request, before, after)
+      @env = env
+      @route = route
+      @request = request
+      @response = Response.new
+      @before = before
+      @after = after
+      @error = nil
+    end
+
+    def params
+      @request.params
+    end
+
+    def error!(message, status)
+      @error = {:message => message, :status => status}
+    end
+
+    def run
+      skip = route[:options][:skip] || []
+      skip = [skip] unless skip.is_a? Array
+
+      route_before = route[:options][:before] || []
+      route_before = [route_before] unless route_before.is_a? Array
+
+      (self.before + route_before).each do |before|
+        next if skip.include? before
+
+        self.send before # execute before filter
+
+        if self.error
+          response.body = ["{\"error\":\"#{error[:message]}\"}", "\n"]
+          response.status = error[:status]
+          return response
+        end
+      end
+
+      # before filters must have succeeded
+      action = instance_eval &route[:block]
+
+      if action.is_a? Opi::Action
+        if action.success?
+          response.status = 200
+          response.body = [action.result.to_json, "\n"]
+        else
+          response.status = 400
+          response.body = [action.errors.symbolic.to_json, "\n"]
+        end
+      else
+        response.status = 200
+        response.body = [action.to_json, "\n"]
+      end
+
+      response
+    end
+
+  end
+end

data/lib/opi/loader.rb

@@ -0,0 +1,41 @@
+module Opi
+  class Loader
+
+    class << self
+
+      def loadcache()
+        @loadcache ||= {}
+      end
+
+      def funkyload(file)
+        begin
+          if cache = loadcache[file]
+            return if ENV['RACK_ENV'] == 'production'
+
+            if (mtime = File.mtime(file)) > cache
+              puts "[Opi::Loader]".green + " reloading: #{file}"
+              load file
+              loadcache[file] = mtime
+            end
+          else
+            puts "[Opi::Loader]".green + " loading: #{file}"
+            load file
+            loadcache[file] = File.mtime(file)
+          end
+        rescue Exception => e
+          puts "[Opi::Loader] Exception loading class [#{file}]: #{e.message}"
+          puts e.backtrace.join("\n")
+          raise e
+        end
+      end
+
+      def reload!
+        Dir["#{@prefix}lib/*.rb"].each { |x| funkyload x }
+        Dir["#{@prefix}actions/**/*.rb"].each { |x| funkyload x }
+        Dir["#{@prefix}*.rb"].each { |x| funkyload x unless x == 'Rakefile.rb' }
+      end
+
+    end
+
+  end
+end

data/lib/opi/request.rb

@@ -0,0 +1,29 @@
+module Opi
+  class Request < Rack::Request
+
+    def user_agent
+      @env['HTTP_USER_AGENT']
+    end
+
+    def accept
+      @env['HTTP_ACCEPT'].to_s.split(',').map { |a| a.strip }
+    end
+
+    def path
+      @env["REQUEST_PATH"]
+    end
+
+    def uri
+      @env["REQUEST_URI"]
+    end
+
+    def method
+      @env['REQUEST_METHOD']
+    end
+
+    def path_components
+      @path_components ||= path.split('/')
+    end
+
+  end
+end

data/lib/opi/response.rb

@@ -0,0 +1,13 @@
+module Opi
+  class Response < Rack::Response
+
+    def initialize
+      @status, @body = 200, ["{}","\n"]
+      @header = Rack::Utils::HeaderHash.new({
+        'Content-Type' => 'application/json'
+        # 'Server' => 'TBD/1.0'
+      })
+    end
+
+  end
+end

data/lib/opi/version.rb

@@ -0,0 +1,3 @@
+module Opi
+  VERSION = "0.1"
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: opi
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Richard Taylor
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+- !ruby/object:Gem::Dependency
+  name: colored
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+- !ruby/object:Gem::Dependency
+  name: mutations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+description: The very opinionated API service library.
+email: moomerman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.textile
+- LICENSE
+- lib/opi.rb
+- lib/opi/action.rb
+- lib/opi/api.rb
+- lib/opi/context.rb
+- lib/opi/loader.rb
+- lib/opi/request.rb
+- lib/opi/response.rb
+- lib/opi/version.rb
+homepage: http://github.com/moomerman/opi
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options:
+- --inline-source
+- --charset=UTF-8
+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: opi
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: The very opinionated API service library.
+test_files: []