ananke 1.1.3 → 2.0.0

data/lib/ananke/routing.rb

@@ -1,159 +0,0 @@
-require 'ananke/linking'
-require 'ananke/helpers'
-require 'ananke/serialize'
-require 'ananke/validation'
-
-module Ananke
-  public
-  class << self
-    attr_accessor :routes
-  end
-
-  private
-  @routes = {}
-  
-  def add_route(name, method)
-    Ananke.routes[name.to_sym] ||= []
-    Ananke.routes[name.to_sym] << method.to_sym
-  end
-  
-  def build_route(repository_module, repository_method, verb, route, &block)
-    if repository_module.respond_to? repository_method
-      define_repository_call(repository_module, repository_method)
-      add_route(route.split('/')[1], repository_method)
-      Sinatra::Base.send verb, "#{route}", do
-        @params = collect_params(@params)
-        instance_eval(&block)
-      end
-    else
-      out(:warning, "#{repository_module} does not respond to '#{repository_method.to_s}'")
-    end
-  end
-
-  def make_response_item(path, mod, link_list, link_to_list, obj, key)
-    id = get_id(obj, key)
-    out :info, "#{path} - Cannot find key(#{key}) on object #{obj}" if !id
-    #dic = {path.to_sym => obj}
-    dic = Serialize.to_h(obj)
-    links = build_links(link_list, link_to_list, path, id, mod) if Ananke.settings[:links]
-    dic[:links] = links if links && !links.empty?
-    dic
-  end
-
-  def make_response(path, mod, link_list, link_to_list, obj, key)
-    if obj.class == Array
-      result_list = obj.collect{|item| make_response_item(path, mod, link_list, link_to_list, item, key) if item}.compact
-
-      #dic = result_list.empty? ? {} : {"#{path}_list".to_sym => result_list}
-      dic = result_list.empty? ? {} : {"items".to_sym => result_list}
-      #link_self = build_link_self(path, '') if Ananke.settings[:links]
-      #dic[:links] = link_self if link_self
-
-      Serialize.to_j(dic)
-    else
-      Serialize.to_j(make_response_item(path, mod, link_list, link_to_list, obj, key))
-    end
-  end
-
-  def build(path)
-    mod = get_repository_module(path)
-    if mod.nil?
-      out(:error, "Repository for #{path} not found")
-      return
-    end
-    out :info, "No Id specified for #{path}" if @id.empty?
-    key = @id[:key]
-    fields = @fields
-    link_list = @link_list
-    link_to_list = @link_to_list
-    route_for_list = @route_for_list
-
-    #===========================GET/ID=============================
-    build_route mod, :one, :get, "/#{path}/:#{key}" do
-      param_missing!(key) if params[key].nil?
-
-      obj, obj_status = repository_call(mod, :one, params)
-      error obj_status, obj if obj_status >= 400
-      not_found if obj && obj.class == Array && obj.empty?
-
-      status obj_status
-      make_response(path, mod, link_list, link_to_list, obj, key)
-    end
-
-    #===========================GET================================
-    build_route mod, :all, :get, "/#{path}/?" do
-      obj, obj_status = repository_call(mod, :all)
-      error obj_status, obj if obj_status >= 400
-      not_found if obj && obj.class == Array && obj.empty?
-
-      status obj_status
-      make_response(path, mod, link_list, link_to_list, obj, key)
-    end
-
-    #===========================POST===============================
-    build_route mod, :add, :post, "/#{path}/?" do
-      status, message = validate(fields, params)
-      error status, message unless status.nil?
-
-      obj, obj_status = repository_call(mod, :add, params)
-      error obj_status, obj if obj_status >= 400
-      not_found if obj && obj.class == Array && obj.empty?
-
-      status 201
-      make_response(path, mod, link_list, link_to_list, obj, key)
-    end
-
-    #===========================PUT================================
-    build_route mod, :edit, :put, "/#{path}/:#{key}" do
-      param_missing!(key) if params[key].nil?
-      status, message = validate(fields, params)
-      error status, message unless status.nil?
-
-      obj, obj_status = repository_call(mod, :edit, params)
-      error obj_status, obj if obj_status >= 400
-      not_found if obj && obj.class == Array && obj.empty?
-      
-      status obj_status
-      make_response(path, mod, link_list, link_to_list, obj, key)
-    end
-
-    build_route mod, :edit, :put, "/#{path}/?" do
-      param_missing!(key)
-    end
-
-    #===========================DELETE=============================
-    build_route mod, :delete, :delete, "/#{path}/:#{key}" do
-      param_missing!(key) if params[key].nil?
-      
-      obj, obj_status = repository_call(mod, :delete, params)
-      error obj_status, obj if obj_status >= 400
-      not_found if obj && obj.class == Array && obj.empty?
-
-      status obj_status
-    end
-
-    build_route mod, :delete, :delete, "/#{path}/?" do
-      param_missing!(key)
-    end
-
-    #===========================ROUTE_FOR==========================
-    route_for_list.each do |r|
-      inputs = mod.method(r[:name]).parameters
-      full_path = "/#{path}/#{r[:name]}"
-      full_path << "/:key" if inputs.length == 1
-
-      build_route mod, r[:name], r[:verb], full_path do
-        param_missing!(:key) if inputs.length == 1 && params[:key].nil?
-
-        obj, obj_status = repository_call(mod, r[:name], params)
-        error obj_status, obj if obj_status >= 400
-        not_found if obj && obj.class == Array && obj.empty?
-        
-        obj_list = obj.class == Array ? obj : [obj]
-
-        status obj_status
-        make_response(path, mod, link_list, link_to_list, obj_list, key).gsub("\"/#{path}/\"", "\"#{request.path}\"")
-      end
-    end
-  end
-end

data/lib/ananke/serialize.rb

@@ -1,53 +0,0 @@
-require 'json'
-module Serialize
-
-  def self.can_serialize?(obj)
-    obj.class != Array and obj.instance_variables.empty?#!obj.to_json.start_with?('"#<')
-  end
-
-  def self.unaccent(obj)
-    #obj.class == String ? obj.force_encoding(Encoding::UTF_8) : obj
-    #puts obj.encoding.name if obj.class == String
-    obj
-  end
-
-  def self.to_h(obj)
-    ret = {}
-
-    if obj.class == Hash
-      obj.each do |k, v|
-        ret[k.to_sym] = (can_serialize?(v) ? unaccent(v) : Serialize.to_h(v))
-      end
-    elsif obj.class == Array
-      ret = []
-      obj.each do |i|
-        #ret << (can_serialize?(i) ? i : Serialize.to_hash(i))
-        ret << Serialize.to_h(i)
-      end
-    elsif obj.instance_variables.empty?
-      ret = unaccent(obj)
-    else
-      obj.instance_variables.each do |e|
-        value = obj.instance_variable_get e.to_sym
-        ret[e[1..-1]] = (can_serialize?(value) ? unaccent(value) : Serialize.to_h(value))
-      end
-    end
-    if ret.class == Hash and Ananke.settings[:remove_empty]
-      ret.delete_if {|k,v| v.nil? || v == ''}
-      ret = nil if ret.empty?
-    elsif ret.class == Array and Ananke.settings[:remove_empty]
-      ret.delete_if {|i| i.nil? || i == ''}
-      ret = nil if ret.empty?
-    end
-    ret
-  end
-
-  def self.to_j(obj)
-    Serialize.to_h(obj).to_json
-  end
-
-  def self.to_j_pretty(obj)
-    JSON.pretty_generate(Serialize.to_h(obj), opts = {:indent => '    '})
-  end
-
-end

data/lib/ananke/settings.rb

@@ -1,28 +0,0 @@
-module Ananke
-  class << self
-    attr_accessor :settings
-  end
-
-  private
-
-  @settings = {
-      :output       => true,
-      :info         => true,
-      :warning      => true,
-      :error        => true,
-
-      :links        => true,
-      :remove_empty => false,
-      :repository   => 'Repository'
-  }
-
-  public
-
-  def repository
-    @settings[:repository].to_sym
-  end
-
-  def set(name, val)
-    @settings[name] = val
-  end
-end

data/lib/ananke/validation.rb

@@ -1,37 +0,0 @@
-module Ananke
-  class << self
-    attr_accessor :rules
-  end
-  
-  private
-  
-  @rules = [:length]
-
-  def validate(fields, params)
-    errors = []
-    fields.each do |field|
-      value = params[field[:key]]
-      errors << "Missing Required Parameter: #{field[:key]}" if field[:type] == :required && value.nil?
-      Ananke::Rules.value = value
-      field[:rules].each do |r|
-        res = r.class == Hash ? Ananke::Rules.send("validate_#{r.first[0]}", r.first[1]) : Ananke::Rules.send("validate_#{r}")
-        errors << "#{field[:key]}: #{res}" unless res.nil?
-      end
-    end
-    return 400, errors unless errors.empty?
-  end
-  def param_missing!(key)
-    error 400, "Missing Parameter: #{key.to_s}"
-  end
-
-  #===========================Rules==============================
-  
-  module Rules
-    class << self
-      attr_accessor :value
-    end
-    def self.validate_length(min)
-      value.length >= min ? nil : "Value must be at least #{min} characters long"
-    end
-  end
-end

data/lib/ananke.rb

@@ -1,52 +0,0 @@
-libdir = File.dirname(__FILE__)
-$LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
-
-require 'colored'
-require 'sinatra/base'
-
-require 'ananke/helpers'
-require 'ananke/linking'
-require 'ananke/routing'
-require 'ananke/settings'
-require 'ananke/serialize'
-require 'ananke/validation'
-
-module Ananke
-  private
-
-  public
-  #===========================DSL================================
-  def route(path, &block)
-    @id = {}
-    @fields = []
-    @link_list = []
-    @link_to_list = []
-    @route_for_list = []
-    yield block
-    build path
-  end
-
-  def id(key, *rules)
-    @id = {:key => key, :type => :id, :rules => rules}
-  end
-  def required(key, *rules)
-    @fields << {:key => key, :type => :required, :rules => rules}
-  end
-  def optional(key, *rules)
-    @fields << {:key => key, :type => :optional, :rules => rules}
-  end
-  def linked(rel)
-    @link_list << {:rel => rel}
-  end
-  def link_to(rel)
-    @link_to_list << {:rel => rel}
-  end
-  def route_for(rel, verb = :get)
-    @route_for_list << {:name => rel, :verb => verb}
-  end
-  def rule(name, &block)
-    Ananke::Rules.send(:define_singleton_method, "validate_#{name}", block)
-  end
-end
-
-include Ananke

data/lib/version.rb

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

data/spec/call_chain.rb

@@ -1,23 +0,0 @@
-class CallChain
-  def self.caller_file(depth=1)
-    parse_caller(caller(depth+1).first)[0]
-  end
-  def self.caller_line(depth=1)
-    parse_caller(caller(depth+1).first)[1]
-  end
-  def self.caller_method(depth=1)
-    parse_caller(caller(depth+1).first)[2]
-  end
-
-  private
-
-  #Stolen from ActionMailer, where this was used but was not made reusable
-  def self.parse_caller(at)
-    if /^(.+?):(\d+)(?::in `(.*)')?/ =~ at
-      file   = Regexp.last_match[1]
-      line   = Regexp.last_match[2].to_i
-      method = Regexp.last_match[3]
-      [file, line, method]
-    end
-  end
-end

data/spec/cov_adapter.rb

@@ -1,9 +0,0 @@
-require 'simplecov'
-
-SimpleCov.adapters.define 'cov' do
-  coverage_dir 'public/coverage'
-
-  add_filter '/dump/'
-  add_filter '/public/'
-  add_filter '/spec/'
-end

data/spec/dumping.rb

@@ -1,15 +0,0 @@
-require './spec/call_chain'
-require 'fileutils'
-
-def clear_dump
-  dirname = File.join(File.dirname(__FILE__), "..", "dump")
-  FileUtils::rm_rf(dirname)
-  FileUtils::mkdir(dirname)
-end
-def dump(content, filename)
-  File.open(File.expand_path(File.join(File.dirname(__FILE__), "..", "dump", "#{filename}")), 'w') {|f| f.write(content) }
-end
-def check_status(status)
-  dump(last_response.body, "#{CallChain::caller_file.split('/').last}_#{CallChain::caller_line}.htm") if last_response.status != status
-  last_response.status.should == status
-end

data/spec/lib/ananke_spec.rb

@@ -1,178 +0,0 @@
-require './spec/spec_helper'
-require './lib/ananke'
-
-describe 'Basic Ananke REST' do
-  include Rack::Test::Methods
-  include Ananke
-
-  def app
-    Sinatra::Base
-  end
-
-  before(:all) do
-    Ananke.set :links, false
-  end
-
-  after(:all) do
-    Ananke.set :links, true
-  end
-
-  #----------------------------SETUP--------------------------------------
-  it """
-  Should be able to describe a Valid REST Resource
-  """ do
-    route :user do
-      id :user_id
-    end
-  end
-  
-  it """
-  Should skip creating Routes for Non-Existing Repositories
-  """ do
-    route :invalid do
-    end
-  end
-
-  it """
-  Should setup the defaults for REST
-  """ do
-    Ananke.repository.should == :Repository
-  end
-
-  it """
-  Should setup Routes
-  """ do
-    Sinatra::Base.routes["GET"][-1][0].inspect.include?('user').should == true
-    count = 0
-    Sinatra::Base.routes["GET"].each_index{|i| count += 1 if Sinatra::Base.routes["GET"][i][0].inspect.include?('user')}
-    count.should == 2
-    Sinatra::Base.routes["POST"][-1][0].inspect.include?('user').should == true
-    Sinatra::Base.routes["PUT"][-1][0].inspect.include?('user').should == true
-    Sinatra::Base.routes["DELETE"][-1][0].inspect.include?('user').should == true
-  end
-
-  it """
-  Should expose routes registered
-  """ do
-    Ananke.routes[:user].should include :one
-    Ananke.routes[:user].should include :all
-    Ananke.routes[:user].should include :add
-    Ananke.routes[:user].should include :edit
-    Ananke.routes[:user].should include :delete
-  end
-
-  #----------------------------BASIC--------------------------------------
-  it """
-    GET /user
-      - code:     200
-      - content-type: text/plain
-      - body:     [{:id=>1, :name=>'one'}, {:id => 2, :name => 'two'}]
-  """ do
-    get "/user"
-    check_status(200)
-    last_response.body.should == '{"items":[{"user_id":1,"username":"one"},{"user_id":2,"username":"two"}]}'
-  end
-
-  it """
-    GET /user/1
-      - code:         200
-      - content-type: text/plain
-      - body:         {user_id: ,username: }
-  """ do
-    get "/user/1"
-    check_status(200)
-    last_response.body.should == '{"user_id":1,"username":"one"}'
-  end
-
-  it """
-    POST /user
-      - body:         {user_id: ,username: }
-    RETURN
-      - code:         201
-      - content-type: text/json
-      - body:
-  """ do
-    post "/user", body={:user_id => 3, :username => 'three'}
-    check_status(201)
-  end
-
-  it """
-    PUT /user/3
-      - body:         {user_id: ,username: }
-    RETURN
-      - code:         200
-      - content-type: text/json
-      - body:
-  """ do
-    put "/user/3", body={:username => 'four'}
-    check_status(200)
-  end
-
-  it """
-    DELETE /user/3
-    RETURN
-      - code:         200
-      - content-type: text/json
-      - body:
-  """ do
-    delete "/user/3"
-    check_status(200)
-  end
-
-  #----------------------------FAILS--------------------------------------
-  it """
-    PUT /user
-      - body:         {user_id: ,username: }
-    RETURN
-      - code:         400
-      - content-type: text/json
-      - body:         Missing Parameter: user_id
-  """ do
-    put "/user", body={:username => 'four'}
-    check_status(400)
-    last_response.body.should == 'Missing Parameter: user_id'
-  end
-
-  it """
-    DELETE /user
-    RETURN
-      - code:         400
-      - content-type: text/json
-      - body:         Missing Parameter: user_id
-  """ do
-    delete "/user"
-    check_status(400)
-    last_response.body.should == 'Missing Parameter: user_id'
-  end
-end
-
-module Repository
-  module User
-    @data = [{:user_id => 1, :username => 'one'},
-             {:user_id => 2, :username => 'two'}]
-
-    def self.data
-      @data
-    end
-
-    def self.one(user_id)
-      @data[@data.index{ |d| d[:user_id] == user_id.to_i}]
-    end
-    def self.all
-      @data
-    end
-    def self.add(user_id, username)
-      obj = {:user_id => user_id.to_i, :username => username}
-      @data << obj
-      obj
-    end
-    def self.edit(user_id, username)
-      obj = {:user_id => user_id.to_i, :username => username}
-      @data[@data.index{|i| i[:user_id] == user_id.to_i}] = obj
-      obj
-    end
-    def self.delete(user_id)
-      @data.delete_if { |i| i[:user_id] == user_id.to_i}
-    end
-  end
-end

data/spec/lib/error_spec.rb

@@ -1,73 +0,0 @@
-require './spec/spec_helper'
-require './lib/ananke'
-
-describe 'Resource Route-For' do
-  include Rack::Test::Methods
-  include Ananke
-
-  def app
-    Sinatra::Base
-  end
-
-  it """
-  should return a code 400 for an error raised in the Repository that has a message that starts with  the method name
-  """ do
-    module Repository
-      module Errors
-        def self.exception400(id)
-          raise 'exception400 - Some Exception'
-        end
-      end
-    end
-    route :errors do
-      route_for :exception400
-    end
-
-    get "/errors/exception400/1"
-    check_status(400)
-    last_response.body.should == 'Some Exception'
-  end
-
-  it """
-  should return a code 500 for an error raised in the Repository
-  """ do
-    module Repository
-      module Errors
-        def self.exception500(id)
-          raise 'Some Exception'
-        end
-      end
-    end
-    route :errors do
-      route_for :exception500
-    end
-
-    get "/errors/exception500/1"
-    check_status(500)
-  end
-
-  it """
-  should return a code 404 for an empty Array object returned
-  """ do
-    module Repository
-      module Errors
-        def self.one(id)
-          []
-        end
-        def self.empty(id)
-          []
-        end
-      end
-    end
-    route :errors do
-      id :id
-      route_for :empty
-    end
-
-    get "/errors/empty/1"
-    check_status(404)
-
-    get "/errors/1"
-    check_status(404)
-  end
-end

data/spec/lib/json_spec.rb

@@ -1,51 +0,0 @@
-require './spec/spec_helper'
-
-describe 'Ananke - JSON Body' do
-  include Rack::Test::Methods
-  include Ananke
-
-  def app
-    Sinatra::Base
-  end
-
-  it "should be able to parse a JSON Body in a basic POST route" do
-    post "/json", body={:name => 'one', :surname => 'sur_one'}.to_json
-    check_status(201)
-  end
-
-  it "should be able to parse a JSON Body in a basic PUT route" do
-    put "/json/1", body={:name => 'one', :surname => 'sur_one'}.to_json
-    check_status(200)
-  end
-
-  it "should be able to parse a JSON Body in a Custom Route" do
-    get "/json/custom", body={:name => 'one', :surname => 'sur_one'}.to_json
-    check_status(200)
-  end
-
-  module Repository
-    module Json
-      @data = []
-      def self.add(name, surname)
-        id = @data.empty? && 1 || @data.last[:id] + 1
-        obj = {:id => id, :name => name, :surname => surname}
-        @data << obj
-        obj
-      end
-      def self.edit(id, name, surname)
-        obj = {:id => id, :name => name, :surname => surname}
-        @data[@data.index{|i| i[:id] == id.to_i}] = obj
-        obj
-      end
-      def self.custom(name, surname)
-        @data[@data.index{|i| i[:name] == name && i[:surname] == surname}]
-      end
-    end
-  end
-  route :json do
-    id :id
-    required :name
-    required :surname
-    route_for :custom
-  end
-end