ananke 0.0.1 → 0.0.2

data/Gemfile

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

data/README.rdoc

@@ -43,15 +43,40 @@ based on what's available in it's respective Repository. Routes are:
   put     '/name/id'  -> Repository::Capitalize(name).edit(id, data)
   delete  '/name/id'  -> Repository::Capitalize(name).delete(id)
 
+== Repositories
+The Default Repository can be changed:
+
+ ananke.default_repository = 'MyRepository'
+
+== HyperMedia
+Current HyperMedia support is very limited. The following example demostrates it's use:
+
+  rest :user do
+    id :id
+    linked :computer
+   end
+
+To support the above example, the Respository for User needs to have a method that returns an
+array of id's for use in the HyperMedia links. The method signature is as follows
+
+  def self.computer_id_list
+    [Return an array of single value id's]
+  end
+
+It get called:
+
+  [ResourceRepository].[link name]_id_list
+
+We are working on adding lots more HyperMedia Support, especially to get around problems that
+the current HyperMedia is giving. Stay tuned...
+
+== Media Type
 The REST media type can be built up:
 
   required :name
   optional :country
 
-== Repositories
-The Default Repository can be changed:
-
- ananke.default_repository = 'MyRepository'
+Exposing the Media Type is on the cards.
 
 == Validation
 Validation can be added on any field by providing arguments after a field declaration:

data/lib/ananke.rb

@@ -1,62 +1,158 @@
+require 'colored'
+require 'json'
 require 'sinatra/base'
 
 module Ananke
   class << self
-    attr_accessor :default_repository, :rules
+    attr_accessor :default_repository, :rules, :settings
   end
-
+  
   private
+  extend Colored
+  
   @default_repository = 'Repository'
   @rules = [:length]
+  @settings = {
+      :output   => true,
+      :info     => true,
+      :warning  => true,
+      :error    => true,
+
+      :links    => true
+  }
+
+  #===========================OUTPUT=============================
+  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
+
+  #===========================HELPERS============================
+  def get_mod(path)
+    mod = nil
+    rep = Module.const_get(Ananke.default_repository.to_sym) if Module.const_defined?(Ananke.default_repository.to_sym)
+    mod = rep.const_get("#{path.capitalize}".to_sym) if !rep.nil? && rep.const_defined?("#{path.capitalize}".to_sym)
+    mod
+  end
+
+  def get_json(path, obj)
+    if obj.nil?
+      out :error, "#{path} - No return object"
+      ''
+    elsif !obj.respond_to?(:to_json)
+      out :error, "#{path} - Return object cannot be converted to JSON"
+      ''
+    else
+      obj.to_json
+    end
+  end
 
+  #===========================BUILDUP============================
+  def build_route(mod, mod_method, verb, route, &block)
+    if mod.respond_to? mod_method
+      Sinatra::Base.send verb, "#{route}", do
+        instance_eval(&block)
+      end
+    else
+      out(:warning, "#{mod} does not respond to '#{mod_method.to_s}'")
+    end
+  end
+  
   def build(path)
-    #TODO - Check if Modules Exist
-    mod = Module.const_get(Ananke.default_repository.to_sym).const_get("#{path.capitalize}".to_sym)
+    mod = get_mod(path)
+    if mod.nil?
+      out(:error, "Repository for #{path} not found")
+      return
+    end
     key = @id[:key]
     fields = @fields
-    links = @links
+    linkups = @linkups
+
+    #===========================GET/ID=============================
+    build_route mod, :one, :get, "/#{path}/:#{key}" do
+      param_missing!(key) if params[key].nil?
+      obj = mod.one(params[key])
 
-    #TODO - Check if Repository Supports Resource
-    Sinatra::Base.get "/#{path}/:#{key}" do
-      ret = mod.one(params[key]) if !params[key].nil?
-      #TODO - Hyper Links(Common place maybe?)
-      ret.respond_to?(:to_json) ? ret.to_json : ret
+      json = get_json(path, obj)
+      inject_links!(json, linkups, path, params[key], mod)
+
+      status 200
+      json
     end
 
-    #TODO - Check if Repository Supports Resource
-    Sinatra::Base.get "/#{path}/?" do
-      ret = mod.all
-      #TODO - Hyper Links(Common place maybe?)
-      ret.respond_to?(:to_json) ? ret.to_json : ret
+    #===========================GET================================
+    build_route mod, :all, :get, "/#{path}/?" do
+      obj_list = mod.all
+
+      status 200
+      json_list = []
+      obj_list.each do |obj|
+        id = obj.respond_to?(key) ? obj.instance_variable_get(key) : obj.class == Hash && obj.has_key?(key) ? obj[key] : nil
+        if !id.nil?
+          json = get_json(path, obj)
+          inject_links!(json, linkups, path, id, mod)
+          json_list << json
+        else
+          out :error, "#{path} - Cannot find key(#{key}) on object #{obj}"
+        end
+      end
+      "[#{json_list.join(',')}]"
     end
 
-    #TODO - Check if Repository Supports Resource
-    Sinatra::Base.post "/#{path}/?" do
-      #TODO - Parameter Validation
-      status, message = validate!(fields, params)
+    #===========================POST===============================
+    build_route mod, :add, :post, "/#{path}/?" do
+      status, message = validate(fields, params)
       error status, message unless status.nil?
-      ret = mod.new(params)
+      obj = mod.add(params)
+
+      json = get_json(path, obj)
+      inject_links!(json, linkups, path, params[key], mod)
+
       status 201
-      #TODO - Hyper Links for Created Resource
+      json
     end
 
-    #TODO - Check if Repository Supports Resource
-    Sinatra::Base.put "/#{path}/:#{key}" do
-      #TODO - Parameter Validation
-      mod.edit(params[key], params) if !params[key].nil?
+    #===========================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 = mod.edit(params[key], params)
+
+      json = get_json(path, obj)
+      inject_links!(json, linkups, path, params[key], mod)
+
       status 200
-      #TODO - Hyper Links
+      json
+    end
+
+    build_route mod, :edit, :put, "/#{path}/?" do
+      param_missing!(key)
     end
 
-    #TODO - Check if Repository Supports Resource
-    Sinatra::Base.delete "/#{path}/:#{key}" do
-      #TODO - Parameter Validation
+    #===========================DELETE=============================
+    build_route mod, :delete, :delete, "/#{path}/:#{key}" do
+      param_missing!(key) if params[key].nil?
       mod.delete(params[key]) if !params[key].nil?
       status 200
     end
+
+    build_route mod, :delete, :delete, "/#{path}/?" do
+      param_missing!(key)
+    end
   end
 
-  def validate!(fields, params)
+  #===========================Validation=========================
+  def validate(fields, params)
     errors = []
     fields.each do |field|
       value = params[field[:key].to_s]
@@ -69,13 +165,38 @@ module Ananke
     end
     return 400, errors unless errors.empty?
   end
+  def param_missing!(key)
+    error 400, "Missing Parameter: #{key.to_s}"
+  end
+
+  #===========================LINKING============================
+  def build_links(path, id, mod, linkups)
+    ret = [{:rel => 'self', :uri => "/#{path}/#{id}"}]
+    linkups.each do |l|
+      mod_method = "#{l[:rel]}_id_list"
+      if mod.respond_to?(mod_method)
+        id_list = mod.send(mod_method, id)
+        id_list.each{|i| ret << {:rel => "#{l[:rel]}", :uri => "/#{l[:rel]}/#{i}"}}
+      else
+        out :error, "#{path} - #{mod} does not respond to '#{mod_method.to_s}'"
+      end
+    end
+    ret
+  end
+
+  def inject_links!(json, linkups, path, id, mod)
+    return if !Ananke.settings[:links]
+    links = build_links(path, id, mod, linkups)
+    json.insert(json.length-1, ",\"links\":#{links.to_json}")
+  end
 
   public
 
+  #===========================DSL================================
   def rest(path, &block)
     @id = {}
     @fields = []
-    @links = []
+    @linkups = []
     yield block
     build path
   end
@@ -89,13 +210,14 @@ module Ananke
   def optional(key, *rules)
     @fields << {:key => key, :type => :optional, :rules => rules}
   end
-  def media(rel, method, resource, field)
-    @links << {:rel => rel, :method => method, :resource => resource, :field => field}
+  def linkup(rel)
+    @linkups << {:rel => rel}
   end
   def rule(name, &block)
     Ananke::Rules.send(:define_singleton_method, "validate_#{name}", block)
   end
 
+  #===========================Rules==============================
   module Rules
     class << self
       attr_accessor :value
@@ -104,6 +226,11 @@ module Ananke
       value.length >= min ? nil : "Value must be at least #{min} characters long"
     end
   end
+
+  #===========================Settings===========================
+  def set(name, val)
+    @settings[name] = val
+  end
 end
 
 include Ananke

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Ananke
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/call_chain.rb

@@ -0,0 +1,23 @@
+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/dumping.rb

@@ -0,0 +1,15 @@
+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_links_spec.rb

@@ -0,0 +1,107 @@
+require './spec/spec_helper'
+require './lib/ananke'
+
+describe 'Resource' do
+  include Rack::Test::Methods
+  include Ananke
+
+  def app
+    Sinatra::Base
+  end
+
+  it """
+  Should be able to Output link to Self and Call that link
+  """ do
+    module Repository
+      module Self
+        def self.one(id) end
+        def self.add(data)
+          {:user_id => 1}
+        end
+      end
+    end
+    rest :self do
+      id :user_id
+    end
+
+    post "/self", body={:user_id => 1, :username => '1234'}
+    check_status(201)
+    last_response.body.should == '{"user_id":1,"links":[{"rel":"self","uri":"/self/1"}]}'
+
+    hash = JSON.parse(last_response.body)
+    uri = hash['links'].map{|l| l['uri'] if l['rel'] == 'self'}[0]
+    get uri
+    check_status(200)
+  end
+
+  module Repository
+    module Linkup
+      def self.one(id)
+        {:user_id => 1}
+      end
+      def self.all
+        [{:user_id => 1}, {:user_id => 2}]
+      end
+      def self.add(data)
+        {:user_id => 1}
+      end
+      def self.edit(id, data)
+        {:user_id => 1}
+      end
+      def self.line_id_list(user_id)
+        [1,2]
+      end
+    end
+    module Line
+      def self.one(id) end
+    end
+  end
+  rest :linkup do
+    id :user_id
+    linkup :line
+  end
+  rest :line do
+    id :line_id
+  end
+
+  it """
+  Should be able to Output links to linkups and Call those links
+  """ do
+    post "/linkup", body={:user_id => 1, :username => '1234'}
+    check_status(201)
+    last_response.body.should == '{"user_id":1,"links":[{"rel":"self","uri":"/linkup/1"},{"rel":"line","uri":"/line/1"},{"rel":"line","uri":"/line/2"}]}'
+
+    hash = JSON.parse(last_response.body)
+    hash['links'].each do |l|
+      get l['uri']
+      check_status(200)
+    end
+  end
+
+  it "Should return links on Get One" do
+    #get "/linkup/1"
+    #check_status(200)
+    #last_response.body.should == '{"user_id":1,"links":[{"rel":"self","uri":"/linkup/1"},{"rel":"line","uri":"/line/1"},{"rel":"line","uri":"/line/2"}]}'
+  end
+
+  it """
+  Should not inject links where it cannot find Repository Id lookup method
+  """ do
+    module Repository
+      module Linkup_fail
+        def self.one(id) end
+        def self.add(data)
+          {:user_id => 1}
+        end
+      end
+    end
+    rest :linkup_fail do
+      id :user_id
+      linkup :line
+    end
+
+    post "/linkup_fail", body={:user_id => 1, :username => '1234'}
+    check_status(201)
+    last_response.body.should == '{"user_id":1,"links":[{"rel":"self","uri":"/linkup_fail/1"}]}'
+  end
+end

data/spec/lib/ananke_out_spec.rb

@@ -0,0 +1,20 @@
+require './spec/spec_helper'
+require './lib/ananke'
+
+describe 'Ananke Console Output' do
+  include Ananke
+
+  it """
+  Should be able to output in different Colors
+  """ do
+    output = Ananke.settings[:output]
+    Ananke.set :output, true
+
+    Ananke.send(:out, :info, 'test').should == 'test'.blue
+    Ananke.send(:out, :error, 'test').should == 'test'.red
+    Ananke.send(:out, :warning, 'test').should == 'test'.yellow
+    Ananke.send(:out, :some_other, 'test').should == nil
+
+    Ananke.set :output, output
+  end
+end

data/spec/lib/ananke_spec.rb

@@ -1,7 +1,7 @@
 require './spec/spec_helper'
 require './lib/ananke'
 
-describe 'Resource' do
+describe 'Basic Ananke REST' do
   include Rack::Test::Methods
   include Ananke
 
@@ -10,18 +10,31 @@ describe 'Resource' do
   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
     rest :user do
       id :user_id
-      required :username
-      required 'email'
-      optional :country
-
-      media "Get All Vehicles", :get, :vehicles, :user_id
+    end
+  end
+  
+  it """
+  Should skip creating Routes for Non-Existing Repositories
+  """ do
+    rest :invalid do
     end
   end
 
   it """
-  Should setup the defaults for ReST
+  Should setup the defaults for REST
   """ do
     Ananke.default_repository.should == 'Repository'
   end
@@ -30,7 +43,9 @@ describe 'Resource' do
   Should setup Routes
   """ do
     Sinatra::Base.routes["GET"][-1][0].inspect.include?('user').should == true
-    Sinatra::Base.routes["GET"].length.should == 2
+    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
@@ -44,7 +59,7 @@ describe 'Resource' do
       - body:     [{:id=>1, :name=>'one'}, {:id => 2, :name => 'two'}]
   """ do
     get "/user"
-    last_response.status.should == 200
+    check_status(200)
     last_response.body.should == Repository::User.data.to_json
   end
 
@@ -55,7 +70,7 @@ describe 'Resource' do
       - body:         {user_id: ,username: ,email: ,country: }
   """ do
     get "/user/1"
-    last_response.status.should == 200
+    check_status(200)
     last_response.body.should == Repository::User.data[0].to_json
   end
 
@@ -68,8 +83,7 @@ describe 'Resource' do
       - body:
   """ do
     post "/user", body={:user_id => 3, :username => 'three', :email => '3@three.com', :country => 'USA'}
-    last_response.status.should == 201
-    last_response.body.should == ''
+    check_status(201)
   end
 
   it """
@@ -81,8 +95,7 @@ describe 'Resource' do
       - body:
   """ do
     put "/user/3", body={:user_id => 3, :username => 'four', :email => '4@four.com', :country => 'Russia'}
-    last_response.status.should == 200
-    last_response.body.should == ''
+    check_status(200)
   end
 
   it """
@@ -93,8 +106,33 @@ describe 'Resource' do
       - body:
   """ do
     delete "/user/3"
-    last_response.status.should == 200
-    last_response.body.should == ''
+    check_status(200)
+  end
+
+  #----------------------------FAILS--------------------------------------
+  it """
+    PUT /user
+      - body:         {user_id: ,username: ,email: ,country: }
+    RETURN
+      - code:         400
+      - content-type: text/json
+      - body:         Missing Parameter: user_id
+  """ do
+    put "/user", body={:user_id => 3, :username => 'four', :email => '4@four.com', :country => 'Russia'}
+    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
 
@@ -113,11 +151,13 @@ module Repository
     def self.all
       @data
     end
-    def self.new(data)
+    def self.add(data)
       @data << data
+      data
     end
     def self.edit(id, data)
       @data.each { |d| d = data if d[:user_id] == id}
+      data
     end
     def self.delete(id)
       @data.delete_if { |i| i[:user_id] == id}

data/spec/lib/validation_spec.rb

@@ -16,7 +16,7 @@ describe 'Resource' do
   """ do
     module Repository
       module Basic
-        def self.new(data)end
+        def self.add(data)end
       end
     end
     rest :basic do
@@ -25,11 +25,11 @@ describe 'Resource' do
     end
 
     post "/basic", body={:user_id => 1, :username => ''}
-    last_response.status.should == 400
+    check_status(400)
     last_response.body.should == 'username: Value must be at least 4 characters long'
 
     post "/basic", body={:user_id => 1, :username => '1234'}
-    last_response.status.should == 201
+    check_status(201)
   end
 
   it """
@@ -46,7 +46,7 @@ describe 'Resource' do
 
     module Repository
       module Explicit
-        def self.new(data)end
+        def self.add(data)end
       end
     end
     rest :explicit do
@@ -55,11 +55,11 @@ describe 'Resource' do
     end
 
     post "/explicit", body={:user_id => 1, :email => 'some'}
-    last_response.status.should == 400
+    check_status(400)
     last_response.body.should == 'email: Invalid Email: some'
 
     post "/explicit", body={:user_id => 1, :email => 'some1@some.com'}
-    last_response.status.should == 201
+    check_status(201)
   end
 
   it """
@@ -70,7 +70,7 @@ describe 'Resource' do
     end
     module Repository
       module Added
-        def self.new(data)end
+        def self.add(data)end
       end
     end
     rest :added do
@@ -80,10 +80,10 @@ describe 'Resource' do
     Ananke::Rules.respond_to?('validate_country').should == true
 
     post "/added", body={:user_id => 1, :country => 'England'}
-    last_response.status.should == 400
+    check_status(400)
     last_response.body.should == 'country: Not from South Africa'
 
     post "/added", body={:user_id => 1, :country => 'South Africa'}
-    last_response.status.should == 201
+    check_status(201)
   end
 end

data/spec/spec_helper.rb

@@ -8,10 +8,20 @@ require 'json'
 require 'rack'
 require 'rspec'
 require 'rack/test'
+require './lib/ananke'
 
 extend Colored
 
 #==================SETUP TEST ENVIRONMENT======================
 ENV['RACK_ENV'] = 'test'
 
+Ananke.set :output, false
+Ananke.set :info, true
+Ananke.set :warning, true
+Ananke.set :error, true
+
 $LOAD_PATH.unshift File.expand_path(File.join(File.dirname(__FILE__), ".."))
+
+#==================FOR DUMPING HTTP REQUESTS===================
+require './spec/dumping'
+clear_dump

metadata

@@ -2,7 +2,7 @@
 name: ananke
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Andries Coetzee
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-07 00:00:00 +02:00
+date: 2011-02-10 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -101,10 +101,14 @@ extra_rdoc_files:
 files: 
 - lib/ananke.rb
 - lib/version.rb
+- spec/dumping.rb
 - spec/cov_adapter.rb
 - spec/lib/ananke_spec.rb
+- spec/lib/ananke_out_spec.rb
+- spec/lib/ananke_links_spec.rb
 - spec/lib/validation_spec.rb
 - spec/spec_helper.rb
+- spec/call_chain.rb
 - spec/nice_formatter.rb
 - Gemfile
 - Rakefile
@@ -116,7 +120,7 @@ licenses: []
 post_install_message: |
   **************************************************
   
-    Thank you for installing ananke-0.0.1
+    Thank you for installing ananke-0.0.2
   
     Please be sure to look at README.rdoc to see what might have changed
     since the last release and how to use this GEM.
@@ -145,10 +149,14 @@ rubyforge_project:
 rubygems_version: 1.5.0
 signing_key: 
 specification_version: 3
-summary: ananke-0.0.1
+summary: ananke-0.0.2
 test_files: 
+- spec/dumping.rb
 - spec/cov_adapter.rb
 - spec/lib/ananke_spec.rb
+- spec/lib/ananke_out_spec.rb
+- spec/lib/ananke_links_spec.rb
 - spec/lib/validation_spec.rb
 - spec/spec_helper.rb
+- spec/call_chain.rb
 - spec/nice_formatter.rb