ananke 0.0.2 → 0.0.3

data/README.rdoc

@@ -49,26 +49,103 @@ The Default Repository can be changed:
  ananke.default_repository = 'MyRepository'
 
 == HyperMedia
-Current HyperMedia support is very limited. The following example demostrates it's use:
+=== Linked
 
   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
+   module Repository
+    module User
+      def self.one(id)
+        [Return User for User Id]
+      end
+      def self.computer_id_list(id)
+        [Return an array of single value id's]
+      end
+    end
+   end
+
+Repository Method:
+
+  [ResourceRepository].[linked name]_id_list
 
-  def self.computer_id_list
-    [Return an array of single value id's]
+Routes Available/Registered:
+
+  /user/:id
+
+Output:
+
+  {
+    user: {
+            user_id: "1"
+            name: "One"
+          }
+    links:  [
+              {
+                rel: "self"
+                uri: "/user/1"
+              },
+              {
+                rel: "computer"
+                uri: "/computer/2"
+              }
+            ]
+  }
+
+The Respository for User needs to have a method that returns an array of id's for use in the HyperMedia links.
+The link to <b>Self</b> uses this method. The output will be something like this:
+
+=== Link To and Route For
+
+  rest :user do
+    id :id
+    link_to :computer
+  end
+  rest :computer do
+    id :id
+    route_for :user
+  end
+
+  module Repository
+    module User
+      def self.one(id)
+        [Return User for User Id]
+      end
+    end
+    module Computer
+      def self.user(id)
+        [Return List of Computers for User Id]
+      end
+    end
   end
 
-It get called:
+Routes Available/Registered:
+
+  /user/:id
+  /computer/user/:id
+
+Output:
 
-  [ResourceRepository].[link name]_id_list
+  {
+    user: {
+            user_id: "1"
+            name: "One"
+          }
+    links:  [
+              {
+                rel: "self"
+                uri: "/user/1"
+              },
+              {
+                rel: "computer"
+                uri: "/computer/user/1"
+              }
+            ]
+  }
 
-We are working on adding lots more HyperMedia Support, especially to get around problems that
-the current HyperMedia is giving. Stay tuned...
+This way of linking solves a lot of problems, and can also be used for searching support.
 
 == Media Type
 The REST media type can be built up:
@@ -128,7 +205,6 @@ A short list of future development:
   - Refactor!
   - Return Value Strategy
   - Resource Exposes Media Type
-  - HyperMedia
   - Lots more `bullet-proofing`
   - ETag Support
 

data/Rakefile

@@ -32,14 +32,14 @@ gemspec = Gem::Specification.new do |gem|
 
 **************************************************
 }
-  gem.add_dependency             "sinatra",   "~> 1.1.2"
+  gem.add_dependency              "sinatra",   "~> 1.1.2"
+  gem.add_dependency              "colored",   "~> 1.2"
+  gem.add_dependency              "json",      "~> 1.5.1"
 
-  gem.add_development_dependency "colored",   "~> 1.2"
-  gem.add_development_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"
+  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| 

data/lib/ananke.rb

@@ -44,7 +44,7 @@ module Ananke
     mod
   end
 
-  def get_json(path, obj)
+  def get_json(path, obj, links)
     if obj.nil?
       out :error, "#{path} - No return object"
       ''
@@ -52,10 +52,17 @@ module Ananke
       out :error, "#{path} - Return object cannot be converted to JSON"
       ''
     else
-      obj.to_json
+      root_path = path.to_s.split('/')[0]
+      dic = {root_path.to_sym => obj}
+      dic[:links] = links unless links.nil?
+      dic.to_json
     end
   end
 
+  def get_id(obj, key)
+    obj.respond_to?(key) ? obj.instance_variable_get(key) : obj.class == Hash && obj.has_key?(key) ? obj[key] : nil
+  end
+
   #===========================BUILDUP============================
   def build_route(mod, mod_method, verb, route, &block)
     if mod.respond_to? mod_method
@@ -75,15 +82,17 @@ module Ananke
     end
     key = @id[:key]
     fields = @fields
-    linkups = @linkups
+    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 = mod.one(params[key])
 
-      json = get_json(path, obj)
-      inject_links!(json, linkups, path, params[key], mod)
+      links = build_links(link_list, link_to_list, path, params[key], mod)
+      json = get_json(path, obj, links)
 
       status 200
       json
@@ -94,18 +103,24 @@ module Ananke
       obj_list = mod.all
 
       status 200
-      json_list = []
+      #json_list = []
+      result_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
+        id = get_id(obj, key)
         if !id.nil?
-          json = get_json(path, obj)
-          inject_links!(json, linkups, path, id, mod)
-          json_list << json
+          dic = {path.to_sym => obj}
+          links = build_links(link_list, link_to_list, path, id, mod) if Ananke.settings[:links]
+          dic[:links] = links unless links.nil?
+          result_list << dic
         else
           out :error, "#{path} - Cannot find key(#{key}) on object #{obj}"
         end
       end
-      "[#{json_list.join(',')}]"
+      dic = {"#{path}_list".to_sym => result_list}
+      link_self = build_link_self(path, '') if Ananke.settings[:links]
+      dic[:links] = link_self unless link_self.nil?
+
+      dic.to_json
     end
 
     #===========================POST===============================
@@ -114,8 +129,8 @@ module Ananke
       error status, message unless status.nil?
       obj = mod.add(params)
 
-      json = get_json(path, obj)
-      inject_links!(json, linkups, path, params[key], mod)
+      links = build_links(link_list, link_to_list, path, params[key], mod)
+      json = get_json(path, obj, links)
 
       status 201
       json
@@ -128,8 +143,8 @@ module Ananke
       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)
+      links = build_links(link_list, link_to_list, path, params[key], mod)
+      json = get_json(path, obj, links)
 
       status 200
       json
@@ -149,6 +164,20 @@ module Ananke
     build_route mod, :delete, :delete, "/#{path}/?" do
       param_missing!(key)
     end
+
+    #===========================ROUTE_FOR==========================
+    route_for_list.each do |r|
+      build_route mod, r[:name], :get, "/#{path}/#{r[:name]}/:key" do
+        param_missing!(:key) if params[:key].nil?
+        obj = mod.send(r[:name], params[:key])
+
+        links = build_links(link_list, link_to_list, "#{path}/#{r[:name]}", params[:key], mod)
+        json = get_json("#{path}/#{r[:name]}", obj, links)
+
+        status 200
+        json
+      end
+    end
   end
 
   #===========================Validation=========================
@@ -169,34 +198,51 @@ module Ananke
     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|
+  #===========================LINKS==============================
+  def build_links(link_list, link_to_list, path, id, mod)
+    return if !Ananke.settings[:links]
+
+    links = build_link_self(path, id)
+    links += build_link_list(path, id, mod, link_list)
+    links += build_link_to_list(path, id, link_to_list)
+    
+    links
+  end
+  #===========================SELF===============================
+  def build_link_self(path, id)
+    [{:rel => 'self', :uri => "/#{path}/#{id}"}]
+  end
+  #===========================LINKED=============================
+  def build_link_list(path, id, mod, link_list)
+    links = []
+    link_list.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}"}}
+        id_list.each{|i| links << {:rel => "#{l[:rel]}", :uri => "/#{l[:rel]}/#{i}"}}
       else
         out :error, "#{path} - #{mod} does not respond to '#{mod_method.to_s}'"
       end
     end
-    ret
+    links
   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}")
+  #===========================LINK_TO============================
+  def build_link_to_list(path, id, link_to_list)
+    links = []
+    link_to_list.each do |l|
+      links << {:rel => "#{l[:rel]}", :uri => "/#{l[:rel]}/#{path}/#{id}"}
+    end
+    links
   end
 
   public
-
   #===========================DSL================================
   def rest(path, &block)
     @id = {}
     @fields = []
-    @linkups = []
+    @link_list = []
+    @link_to_list = []
+    @route_for_list = []
     yield block
     build path
   end
@@ -210,8 +256,14 @@ module Ananke
   def optional(key, *rules)
     @fields << {:key => key, :type => :optional, :rules => rules}
   end
-  def linkup(rel)
-    @linkups << {:rel => rel}
+  def linked(rel)
+    @link_list << {:rel => rel}
+  end
+  def link_to(rel)
+    @link_to_list << {:rel => rel}
+  end
+  def route_for(rel)
+    @route_for_list << {:name => rel}
   end
   def rule(name, &block)
     Ananke::Rules.send(:define_singleton_method, "validate_#{name}", block)

data/lib/version.rb

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

data/spec/lib/ananke_link_to_spec.rb

@@ -0,0 +1,31 @@
+require './spec/spec_helper'
+require './lib/ananke'
+
+describe 'Link-To Resource' do
+  include Rack::Test::Methods
+  include Ananke
+
+  def app
+    Sinatra::Base
+  end
+
+  it """
+  Should be able to Output link to link_to
+  """ do
+    module Repository
+      module Link_to
+        def self.one(id)
+          {:link_id => id}
+        end
+      end
+    end
+    rest :link_to do
+      id :link_id
+      link_to :to
+    end
+
+    get "/link_to/1"
+    check_status(200)
+    last_response.body.should == '{"link_to":{"link_id":"1"},"links":[{"rel":"self","uri":"/link_to/1"},{"rel":"to","uri":"/to/link_to/1"}]}'
+  end
+end

data/spec/lib/{ananke_links_spec.rb → ananke_linked_spec.rb}

@@ -26,7 +26,7 @@ describe 'Resource' do
 
     post "/self", body={:user_id => 1, :username => '1234'}
     check_status(201)
-    last_response.body.should == '{"user_id":1,"links":[{"rel":"self","uri":"/self/1"}]}'
+    last_response.body.should == '{"self":{"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]
@@ -35,7 +35,7 @@ describe 'Resource' do
   end
 
   module Repository
-    module Linkup
+    module Linked
       def self.one(id)
         {:user_id => 1}
       end
@@ -56,20 +56,20 @@ describe 'Resource' do
       def self.one(id) end
     end
   end
-  rest :linkup do
+  rest :linked do
     id :user_id
-    linkup :line
+    linked :line
   end
   rest :line do
     id :line_id
   end
 
   it """
-  Should be able to Output links to linkups and Call those links
+  Should be able to Output links to linkeds and Call those links
   """ do
-    post "/linkup", body={:user_id => 1, :username => '1234'}
+    post "/linked", 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"}]}'
+    last_response.body.should == '{"linked":{"user_id":1},"links":[{"rel":"self","uri":"/linked/1"},{"rel":"line","uri":"/line/1"},{"rel":"line","uri":"/line/2"}]}'
 
     hash = JSON.parse(last_response.body)
     hash['links'].each do |l|
@@ -79,29 +79,29 @@ describe 'Resource' do
   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"}]}'
+    get "/linked/1"
+    check_status(200)
+    last_response.body.should == '{"linked":{"user_id":1},"links":[{"rel":"self","uri":"/linked/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
+      module Linked_fail
         def self.one(id) end
         def self.add(data)
           {:user_id => 1}
         end
       end
     end
-    rest :linkup_fail do
+    rest :linked_fail do
       id :user_id
-      linkup :line
+      linked :line
     end
 
-    post "/linkup_fail", body={:user_id => 1, :username => '1234'}
+    post "/linked_fail", body={:user_id => 1, :username => '1234'}
     check_status(201)
-    last_response.body.should == '{"user_id":1,"links":[{"rel":"self","uri":"/linkup_fail/1"}]}'
+    last_response.body.should == '{"linked_fail":{"user_id":1},"links":[{"rel":"self","uri":"/linked_fail/1"}]}'
   end
 end

data/spec/lib/ananke_route_for_spec.rb

@@ -0,0 +1,31 @@
+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 be able to accept route_for Registrations
+  """ do
+    module Repository
+      module Route_for
+        def self.custom(id)
+          {:content => 'Test'}
+        end
+      end
+    end
+    rest :route_for do
+      id :link_id
+      route_for :custom
+    end
+
+    get "/route_for/custom/1"
+    check_status(200)
+    last_response.body.should == '{"route_for":{"content":"Test"},"links":[{"rel":"self","uri":"/route_for/custom/1"}]}'
+  end
+end

data/spec/lib/ananke_spec.rb

@@ -60,41 +60,41 @@ describe 'Basic Ananke REST' do
   """ do
     get "/user"
     check_status(200)
-    last_response.body.should == Repository::User.data.to_json
+    last_response.body.should == '{"user_list":[{"user":{"user_id":1,"username":"one"}},{"user":{"user_id":2,"username":"two"}}]}'
   end
 
   it """
     GET /user/1
       - code:         200
       - content-type: text/plain
-      - body:         {user_id: ,username: ,email: ,country: }
+      - body:         {user_id: ,username: }
   """ do
     get "/user/1"
     check_status(200)
-    last_response.body.should == Repository::User.data[0].to_json
+    last_response.body.should == '{"user":{"user_id":1,"username":"one"}}'
   end
 
   it """
     POST /user
-      - body:         {user_id: ,username: ,email: ,country: }
+      - body:         {user_id: ,username: }
     RETURN
       - code:         201
       - content-type: text/json
       - body:
   """ do
-    post "/user", body={:user_id => 3, :username => 'three', :email => '3@three.com', :country => 'USA'}
+    post "/user", body={:user_id => 3, :username => 'three'}
     check_status(201)
   end
 
   it """
     PUT /user/3
-      - body:         {user_id: ,username: ,email: ,country: }
+      - body:         {user_id: ,username: }
     RETURN
       - code:         200
       - content-type: text/json
       - body:
   """ do
-    put "/user/3", body={:user_id => 3, :username => 'four', :email => '4@four.com', :country => 'Russia'}
+    put "/user/3", body={:user_id => 3, :username => 'four'}
     check_status(200)
   end
 
@@ -112,13 +112,13 @@ describe 'Basic Ananke REST' do
   #----------------------------FAILS--------------------------------------
   it """
     PUT /user
-      - body:         {user_id: ,username: ,email: ,country: }
+      - body:         {user_id: ,username: }
     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'}
+    put "/user", body={:user_id => 3, :username => 'four'}
     check_status(400)
     last_response.body.should == 'Missing Parameter: user_id'
   end
@@ -138,8 +138,8 @@ end
 
 module Repository
   module User
-    @data = [{:user_id => 1, :username => 'one', :email => '1@one.com', :country => 'South Africa'},
-             {:user_id => 2, :username => 'two', :email => '2@two.com', :country => 'England'}]
+    @data = [{:user_id => 1, :username => 'one'},
+             {:user_id => 2, :username => 'two'}]
 
     def self.data
       @data

metadata

@@ -2,7 +2,7 @@
 name: ananke
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Andries Coetzee
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-10 00:00:00 +02:00
+date: 2011-02-11 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -33,7 +33,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version 
         version: "1.2"
-  type: :development
+  type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: json
@@ -44,7 +44,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version 
         version: 1.5.1
-  type: :development
+  type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: rack-test
@@ -104,9 +104,11 @@ files:
 - spec/dumping.rb
 - spec/cov_adapter.rb
 - spec/lib/ananke_spec.rb
+- spec/lib/ananke_linked_spec.rb
 - spec/lib/ananke_out_spec.rb
-- spec/lib/ananke_links_spec.rb
 - spec/lib/validation_spec.rb
+- spec/lib/ananke_link_to_spec.rb
+- spec/lib/ananke_route_for_spec.rb
 - spec/spec_helper.rb
 - spec/call_chain.rb
 - spec/nice_formatter.rb
@@ -120,7 +122,7 @@ licenses: []
 post_install_message: |
   **************************************************
   
-    Thank you for installing ananke-0.0.2
+    Thank you for installing ananke-0.0.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.
@@ -149,14 +151,16 @@ rubyforge_project:
 rubygems_version: 1.5.0
 signing_key: 
 specification_version: 3
-summary: ananke-0.0.2
+summary: ananke-0.0.3
 test_files: 
 - spec/dumping.rb
 - spec/cov_adapter.rb
 - spec/lib/ananke_spec.rb
+- spec/lib/ananke_linked_spec.rb
 - spec/lib/ananke_out_spec.rb
-- spec/lib/ananke_links_spec.rb
 - spec/lib/validation_spec.rb
+- spec/lib/ananke_link_to_spec.rb
+- spec/lib/ananke_route_for_spec.rb
 - spec/spec_helper.rb
 - spec/call_chain.rb
 - spec/nice_formatter.rb