ananke 1.1.3 → 2.0.0

data/lib/sinatra/ananke.rb

@@ -0,0 +1,181 @@
+require 'json'
+require 'sinatra/base'
+
+module Sinatra
+  module Ananke
+
+    class Serialize
+      class << self
+        def can_serialize?(obj) obj.class != Array and obj.instance_variables.empty? end
+
+        def to_h(obj, options = {})
+          ret = {}
+          if obj.class == Hash
+            obj.each do |k, v|
+              ret[k.to_sym] = (can_serialize?(v) ? v : Serialize.to_h(v, options))
+            end
+          elsif obj.class == Array
+            ret = obj.collect {|i| Serialize.to_h(i, options)}
+          elsif obj.instance_variables.empty?
+            ret = obj
+          else
+            obj.instance_variables.each do |e|
+              value = obj.instance_variable_get e.to_sym
+              ret[e[1..-1]] = (can_serialize?(value) ? value : Serialize.to_h(value, options))
+            end
+          end
+          if ret.respond_to? :delete_if
+            ret.delete_if {|k,v| v.nil? || v == ''} if ret.class == Hash && options[:remove_empty]
+            ret.delete_if {|i| i.nil? || i == ''} if ret.class == Array && options[:remove_empty]
+            ret = {} if ret.empty?
+          end
+          ret
+        end
+
+        def to_a(obj, options = {}) ret = Serialize.to_h(obj, options); ret.class == Array && ret || [ret] end
+        def to_j(obj, options = {}) Serialize.to_h(obj, options).to_json end
+        def to_j_pretty(obj, options = {}) JSON.pretty_generate(Serialize.to_h(obj, options), opts = {:indent => '    '}) end
+      end
+    end
+    
+    module Helpers
+      def collect_input_params(params, &block)
+        block_params = block.parameters.collect {|p| p[1]}
+        block_params.collect do |param|
+          error(400, "Missing parameter - #{param}") unless params.has_key? param.to_s
+          value = params[param]
+          case
+            when value.to_i.to_s == value; value.to_i
+            when value.to_f.to_s == value; value.to_f
+            else value
+          end
+        end
+      end
+
+      def inject_app(resource_classes)
+        resource_classes.each do |klass|
+          klass.send :define_method, :app, do klass.class_variable_get :@@app end unless klass.method_defined? :app
+          klass.send :class_variable_set, :@@app, self
+        end
+      end
+    end
+
+    public
+
+    class << self
+      attr_accessor :resource_module
+    end
+
+    def self.registered(app)
+      app.helpers Ananke::Helpers
+    end
+
+    attr_reader :resource_name, :resource_id, :resource_items, :resource_link_to, :resource_classes, :resource_mime, :resource_remove_empty
+    def resource_link_self?() @resource_link_self end
+
+    def make_resource(name, options = {})
+      reset!
+      options[:id]        ||= :id
+      options[:items]     ||= :items
+      options[:link_self]   = options.has_key?(:link_self) ? options[:link_self] : true
+      options[:link_to]   ||= []
+      options[:classes]   ||= []
+
+      @resource_name      = name
+      @resource_id        = options[:id]
+      @resource_items     = options[:items]
+      @resource_link_self = options[:link_self]
+      @resource_link_to   = options[:link_to]
+      @resource_classes   ||= []
+      @resource_mime      = options[:mime]
+      @resource_remove_empty      = options.has_key?(:remove_empty) ? options[:remove_empty] : false
+
+      options[:classes].each {|c| add_class c}
+    end
+
+    def add_class(klass)
+      @resource_classes << klass
+      klass.public_instance_methods(false).each do |method_name|
+        block = klass.new.method(method_name).to_proc
+        if [:one,:all,:add,:edit,:trash].include? method_name
+          method(method_name).call({}, &block)
+        else
+          get!(method_name, {}, &block) if block.arity <= 1
+          post!(method_name, {}, &block) if block.arity > 1
+        end
+      end
+    end
+
+    def get!(path, options={}, &block) rest :get, path, options, &block end
+    def post!(path, options={}, &block) rest :post, path, options, &block end
+    def put!(path, options={}, &block) rest :put, path, options, &block end
+    def delete!(path, options={}, &block) rest :delete, path, options, &block end
+
+    def one(options={}, &block) rest :get, ":#{resource_id}", options, &block end
+    def all(options={}, &block) rest :get, '?', options, &block end
+    def add(options={}, &block) rest :post, '?', options, &block end
+    def edit(options={}, &block) rest :put, ":#{resource_id}", options, &block end
+    def trash(options={}, &block) rest :delete, ":#{resource_id}", options, &block end
+
+    private
+
+    def rest(type, path, options={}, &block)
+      res = {
+          :name => resource_name,
+          :id => resource_id,
+          :items => resource_items,
+          :link_self => resource_link_self?,
+          :link_to => resource_link_to,
+          :classes => resource_classes,
+          :remove_empty => resource_remove_empty
+      }
+      block_params = block.parameters.collect {|p| p[1]}
+      path = "#{path}/:#{block_params[0]}" if [:get,:put,:delete].include?(type) && block_params.length >= 1 && path != ":#{block_params[0]}"
+      method(type).call "/#{resource_name}/#{path}", options, do
+        inject_app(res[:classes])
+        input_params = collect_input_params(params, &block)
+
+        result = instance_exec(*input_params, &block)
+        result = Serialize.to_a(result, :remove_empty => res[:remove_empty])
+        result = result.empty? && {} || {res[:items] => Serialize.to_h(result, :remove_empty => res[:remove_empty])}
+
+        #inject links
+        result[res[:items]].each do |item|
+          next unless item.respond_to?(:has_key?) && item.has_key?(res[:id])
+          links = []
+          links << {:rel => :self, :href => "/#{res[:name]}/#{item[res[:id]]}"} if res[:link_self]
+          links.concat(res[:link_to].collect { |link| {:rel => link, :href => "/#{link}/#{res[:name]}/#{item[res[:id]]}"}})
+          item[:links] = links unless links.empty?
+        end
+
+        content_type :json
+        Serialize.to_j result
+      end
+    end
+
+  end
+
+  register Ananke
+  helpers Ananke::Helpers
+end
+
+module DSL
+  def resource(name, options={}, &block)
+    resource_module = Sinatra::Ananke.resource_module && Sinatra::Ananke.resource_module.to_s.capitalize.to_sym || nil
+    Object.const_set(resource_module, Module::new) if resource_module && !Object.const_get(resource_module)
+    Object.const_set(options[:module].to_s.capitalize, Module::new) if options[:module] && [String, Symbol].include?(options[:module].class)
+    container = options[:module] ? Object.const_get(options[:module].to_s.capitalize) : self.respond_to?(:name) ? self : resource_module ? Object.const_get(resource_module) : Object
+    full_name = name.capitalize.to_sym
+    container::const_set(full_name, Class::new(Sinatra::Base) do
+      register Sinatra::Ananke
+    end) unless container::const_defined?(full_name)
+
+    klass = container::const_get(full_name)
+    klass.make_resource name, options
+    klass.instance_eval(&block) if block_given?
+  end
+end
+
+include DSL
+#Defaults
+Sinatra::Ananke.resource_module=nil

data/lib/sinatra/version.rb

@@ -0,0 +1,3 @@
+module Ananke
+  VERSION = "2.0.0"
+end

metadata

@@ -2,7 +2,7 @@
 name: ananke
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.1.3
+  version: 2.0.0
 platform: ruby
 authors: 
 - Andries Coetzee
@@ -10,40 +10,39 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-28 00:00:00 +02:00
-default_executable: 
+date: 2011-09-13 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: sinatra
+  name: colored
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 1.1.2
+        version: "1.2"
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: colored
+  name: json
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: "1.2"
+        version: 1.6.0
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: json
+  name: sinatra
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 1.5.1
+        version: 1.2.6
   type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
@@ -54,7 +53,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 0.5.6
+        version: 0.6.1
   type: :development
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
@@ -65,7 +64,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 0.8.7
+        version: 0.9.2
   type: :development
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
@@ -76,7 +75,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 2.5.0
+        version: 2.6.0
   type: :development
   version_requirements: *id006
 - !ruby/object:Gem::Dependency 
@@ -87,59 +86,28 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 0.3.9
+        version: 0.5.2
   type: :development
   version_requirements: *id007
-description: Full REST Implementation on top of Sinatra
-email: andriesc@mixtel.com
+description: Ananke enables a new kind of ReST implementation
+email: 
+- andriesc@lime-square.net
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- README.rdoc
+extra_rdoc_files: []
+
 files: 
-- lib/ananke.rb
-- lib/version.rb
-- lib/ananke/settings.rb
-- lib/ananke/linking.rb
-- lib/ananke/routing.rb
-- lib/ananke/validation.rb
-- lib/ananke/helpers.rb
-- lib/ananke/serialize.rb
-- spec/dumping.rb
-- spec/cov_adapter.rb
-- spec/lib/ananke_spec.rb
-- spec/lib/validation_spec.rb
-- spec/lib/out_spec.rb
-- spec/lib/json_spec.rb
-- spec/lib/serialize_spec.rb
-- spec/lib/link_to_spec.rb
-- spec/lib/route_for_spec.rb
-- spec/lib/error_spec.rb
-- spec/lib/linked_spec.rb
-- spec/spec_helper.rb
-- spec/call_chain.rb
-- spec/nice_formatter.rb
-- Gemfile
-- Rakefile
+- lib/sinatra/ananke.rb
+- lib/sinatra/version.rb
 - README.rdoc
-has_rdoc: true
-homepage: https://github.com/HasAndries/ananke
+homepage: http://github.com/hasandries/ananke
 licenses: []
 
-post_install_message: |
-  **************************************************
-  
-    Thank you for installing ananke-1.1.3
-  
-    Please be sure to look at README.rdoc to see what might have changed
-    since the last release and how to use this GEM.
-  
-  **************************************************
+post_install_message: 
+rdoc_options: []
 
-rdoc_options: 
-- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -151,28 +119,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
+  - - ~>
     - !ruby/object:Gem::Version 
-      version: "0"
+      version: 1.8.10
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.0
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: ananke-1.1.3
-test_files: 
-- spec/dumping.rb
-- spec/cov_adapter.rb
-- spec/lib/ananke_spec.rb
-- spec/lib/validation_spec.rb
-- spec/lib/out_spec.rb
-- spec/lib/json_spec.rb
-- spec/lib/serialize_spec.rb
-- spec/lib/link_to_spec.rb
-- spec/lib/route_for_spec.rb
-- spec/lib/error_spec.rb
-- spec/lib/linked_spec.rb
-- spec/spec_helper.rb
-- spec/call_chain.rb
-- spec/nice_formatter.rb
+summary: The Awesome ReST framework
+test_files: []
+

data/Gemfile

@@ -1,15 +0,0 @@
-source "http://rubygems.org"
-
-gem "colored", "~>1.2"
-gem "json", "~>1.5.1"
-gem "sinatra", "~>1.1.2"
-
-#group :development, :test do
-  gem "rack-test", "~>0.5.6"
-  gem "rake", "~>0.8.7"
-  gem "rspec", "~>2.5.0"
-  gem 'simplecov', '~>0.4.0'
-#end
-
-
-

data/Rakefile

@@ -1,65 +0,0 @@
-require 'rubygems'
-require "rake"
-require "rake/rdoctask"
-require 'rake/gempackagetask'
-require "rspec/core/rake_task"
-
-require File.expand_path("../lib/version", __FILE__)
-gemspec = Gem::Specification.new do |gem|
-  gem.name        = "ananke"
-  gem.version     = Ananke::VERSION
-  gem.platform    = Gem::Platform::RUBY
-  gem.authors     = ["Andries Coetzee"]
-  gem.email       = "andriesc@mixtel.com"
-  gem.summary     = "#{gem.name}-#{Ananke::VERSION}"
-  gem.description = "Full REST Implementation on top of Sinatra"
-  gem.homepage    = "https://github.com/HasAndries/ananke"
-
-  gem.rubygems_version   = "1.5.0"
-
-  gem.files            = FileList['lib/**/*', 'spec/**/*', 'Gemfile', 'Rakefile', 'README.rdoc']
-  gem.test_files       = FileList['spec/**/*']
-  gem.extra_rdoc_files = [ "README.rdoc" ]
-  gem.rdoc_options     = ["--charset=UTF-8"]
-  gem.require_path     = "lib"
-
-  gem.post_install_message = %Q{**************************************************
-
-  Thank you for installing #{gem.summary}
-
-  Please be sure to look at README.rdoc to see what might have changed
-  since the last release and how to use this GEM.
-
-**************************************************
-}
-  gem.add_dependency              "sinatra",   "~> 1.1.2"
-  gem.add_dependency              "colored",   "~> 1.2"
-  gem.add_dependency              "json",      "~> 1.5.1"
-
-  gem.add_development_dependency  "rack-test", "~> 0.5.6"
-  gem.add_development_dependency  "rake",      "~> 0.8.7"
-  gem.add_development_dependency  "rspec",     "~> 2.5.0"
-  gem.add_development_dependency  "simplecov", "~> 0.3.9"
-end
- 
-Rake::GemPackageTask.new(gemspec) do |pkg| 
-  pkg.need_tar = true
-end
-
-desc %{Build the gemspec file.}
-task :gemspec do
-  gemspec.validate
-  File.open("#{gemspec.name}.gemspec", 'w'){|f| f.write gemspec.to_ruby }
-end
-
-RSpec::Core::RakeTask.new(:test) do |t|
-  t.rspec_opts = ["-c", "-f progress", "-r ./spec/spec_helper.rb"]
-  t.pattern = 'spec/**/*_spec.rb'
-end
-
-RSpec::Core::RakeTask.new(:doc) do |t|
-  t.rspec_opts = ["-c" "-r ./spec/nice_formatter.rb", "-f NiceFormatter", "-o doc.htm"]
-  t.pattern = 'spec/**/*_spec.rb'
-end
-
-task :default => [:test]

data/lib/ananke/helpers.rb

@@ -1,85 +0,0 @@
-require 'json'
-module Ananke
-
-  extend Colored
-
-  public
-
-  def get_repository_module(path)
-    repository = nil
-    repository = Module.const_get(Ananke.repository) if Module.const_defined?(Ananke.repository)
-    repository = repository.const_get("#{path.capitalize}".to_sym) if !repository.nil? && repository.const_defined?("#{path.capitalize}".to_sym)
-    repository
-  end
-
-  def get_id(obj, key)
-    if !key
-      out :warning, "Cannot get id on object #{obj}, key is nil"
-      return nil
-    end
-    obj.class == Hash && obj.has_key?(key) ? obj[key] : obj.respond_to?(key) ? obj.instance_variable_get("@#{key}") : nil
-  end
-
-  def out(type, message)
-    return if !Ananke.settings[:output]
-    message = case
-      when type == :info && Ananke.settings[:info]
-        message.blue
-      when type == :warning && Ananke.settings[:warning]
-        message.yellow
-      when type == :error && Ananke.settings[:error]
-        message.red
-    end
-    puts message unless message.nil?
-    message
-  end
-
-  def symbolize_keys(hash)
-    new_hash = {}
-    hash.each{|k,v| new_hash[k.to_sym] = Hash === v ? symbolize_keys(v) : v}
-    new_hash
-  end
-
-  def collect_params(params)
-    new_params = {}
-    params.each do |k,v|
-      json = symbolize_keys(JSON.parse(k)) if v.nil?
-      if !json.nil? && !json.empty?
-        new_params.merge!(json)
-      else
-        new_params[k.to_sym] = v
-      end
-    end
-    new_params
-  end
-
-  def define_repository_call(mod, method_name)
-    inputs = mod.method(method_name).parameters
-    repository_name = mod.name.split('::').last.downcase
-    call_def = "def self.call_#{repository_name}_#{method_name}(params)\n"
-    case inputs.length
-      when 0
-        call_def << "  #{mod}.send(:#{method_name})\n"
-      when 1
-        call_def << "  param = params[:key] ? params[:key] : params.values.first\n"
-        call_def << "  #{mod}.send(:#{method_name}, param)\n"
-      else
-        input_array = []
-        inputs.each{|i| input_array << "params[:#{i[1]}]"}
-        call_def << "  #{mod}.send(:#{method_name}, #{input_array.join(',')})\n"
-    end
-    call_def << "end"
-    Ananke.send(:eval, call_def)
-  end
-
-  def repository_call(mod, method_name, params = {})
-    repository_name = mod.name.split('::').last.downcase
-    begin
-      return Ananke.send("call_#{repository_name}_#{method_name}", params), 200
-    rescue StandardError => error
-      raise if !error.message.start_with?(method_name.to_s)
-      message = error.message.split(method_name.to_s).last.split('-').last.split(':').last.strip
-      return message, 400
-    end
-  end
-end

data/lib/ananke/linking.rb

@@ -1,35 +0,0 @@
-module Ananke
-  def build_links(link_list, link_to_list, path, id, repository)
-    return if !Ananke.settings[:links]
-
-    links = id ? build_link_self(path, id) : []
-    links += build_link_list(path, id, repository, link_list)
-    links += build_link_to_list(path, id, link_to_list)
-
-    links
-  end
-  #===========================SELF===============================
-  def build_link_self(path, id)
-    uri = "/#{path.to_s}"
-    uri << "/#{id}" if id
-    [{:rel => 'self', :uri => uri}]
-  end
-  #===========================LINKED=============================
-  def build_link_list(path, id, repository, link_list)
-    links = []
-    link_list.each do |link|
-      repository_method = "#{link[:rel]}_id_list"
-      if repository.respond_to?(repository_method)
-        id_list = repository.send(repository_method, id)
-        links = id_list.collect{|i| {:rel => "#{link[:rel]}", :uri => "/#{link[:rel]}/#{i}"}}
-      else
-        out :error, "#{path} - #{repository} does not respond to '#{repository_method.to_s}'"
-      end
-    end
-    links
-  end
-  #===========================LINK_TO============================
-  def build_link_to_list(path, id, link_to_list)
-    link_to_list.collect { |link| {:rel => "#{link[:rel]}", :uri => "/#{link[:rel]}/#{path.to_s.split('/')[0]}/#{id}"} }
-  end
-end