rugroupy-server 0.1.0 → 0.1.1

data/README.rdoc

@@ -3,16 +3,28 @@
 rugroupy-server is a sinatra based server allowing one to interact with the rugroupy library
 over http.
 
-== features
+== Features
  * requests and responses use JSON
  * GET, PUT, DELETE /entity to retrieve, create, or delete entities
  * PUT, DELETE /entity/tags to tag or untag entities
  * GET /entity/similiar to find entities similiar to a given entity sorted by score
  * GET, POST /group to retrieve most similiar entities or initiate a grouping request
 
+== Usage
+
+Extend Groupy::GroupyServer to configure mongo and other settings and then run it
+
+  require 'rugroupy/server'
+  class MyApp < Groupy::GroupyServer 
+    register Sinatra::MongoExtension
+    set :mongo, 'mongo://localhost:27017/mongo_database_name'
+    # optionally set more things (port, etc.) according to http://www.sinatrarb.com/configuration.html
+  end
+  MyApp.run!
+
 == Examples
 
-See http://github.com/rwynn/rugroupy-server/tree/master/test
+See http://github.com/rwynn/rugroupy-server/tree/master/test for example input/output to and from the server
 
 == Requirements
 

data/lib/rugroupy/server.rb

@@ -4,118 +4,126 @@ require 'sinatra/mongo'
 require 'rugroupy'
 require 'json'
 
-module ApplicationHelper
+# Run the server like this by extending GroupyServer and calling run!
+# require 'rugroupy/server'
+# class MyApp < Groupy::GroupyServer 
+#   register Sinatra::MongoExtension
+#   set :mongo, 'mongo://localhost:27017/test'
+#   optionally set more things (port, etc.) according to http://www.sinatrarb.com/configuration.html
+# end
+# MyApp.run!
+
+module Groupy
+  module GroupyServerSupport
   
-  def get_entity(params, create=false)
-    e_json = self.get_entity_json(params)
-    e = Groupy::Entity.new(mongo, e_json['name'], e_json["id"], create)
-    e.get
-  end
+    def get_entity(params, create=false)
+      e_json = self.get_entity_json(params)
+      e = Groupy::Entity.new(mongo, e_json['name'], e_json["id"], create)
+      e.get
+    end
   
-  def get_entity_json(params)
-    JSON.parse(params[:entity])
-  end
+    def get_entity_json(params)
+      JSON.parse(params[:entity])
+    end
   
-  def get_entity_similiar(params)
-    e_json = self.get_entity_json(params)
-    e = Groupy::Entity.new(mongo, e_json['name'], e_json["id"], create=false)
-    e.similiar(e_json["tag"], e_json["skip"], e_json["limit"], e_json["reverse"])
-  end
+    def get_entity_similiar(params)
+      e_json = self.get_entity_json(params)
+      e = Groupy::Entity.new(mongo, e_json['name'], e_json["id"], create=false)
+      e.similiar(e_json["tag"], e_json["skip"], e_json["limit"], e_json["reverse"])
+    end
   
-  def delete_entity(params)
-    e_json = self.get_entity_json(params)
-    e = Groupy::Entity.new(mongo, e_json['name'], e_json["id"], create=create)
-    e.delete
-  end
+    def delete_entity(params)
+      e_json = self.get_entity_json(params)
+      e = Groupy::Entity.new(mongo, e_json['name'], e_json["id"], create=create)
+      e.delete
+    end
   
-  def tag_entity(params, create=true)
-    e_json = self.get_entity_json(params)
-    e = Groupy::Entity.new(mongo, e_json['name'], e_json["id"], create=create)
-    e_json["tags"].each_pair do |name, value|
-      create ? e.tag(name, value) : e.untag(name, value)
+    def tag_entity(params, create=true)
+      e_json = self.get_entity_json(params)
+      e = Groupy::Entity.new(mongo, e_json['name'], e_json["id"], create=create)
+      e_json["tags"].each_pair do |name, value|
+        create ? e.tag(name, value) : e.untag(name, value)
+      end
+      e.get
     end
-    e.get
-  end
   
-  def group_entities(params)
-    e_json = self.get_entity_json(params)
-    g = Groupy::EntityGrouper.new(mongo, e_json["name"])
-    options = {:includeFunction => e_json["include_function"], 
-      :scoreFunction => e_json["score_function"],
-      :dynamicTagFunction => e_json["dynamic_tag_function"]}
-    g.group(options)
-  end
+    def group_entities(params)
+      e_json = self.get_entity_json(params)
+      g = Groupy::EntityGrouper.new(mongo, e_json["name"])
+      options = {:includeFunction => e_json["include_function"], 
+        :scoreFunction => e_json["score_function"],
+        :dynamicTagFunction => e_json["dynamic_tag_function"]}
+      g.group(options)
+    end
 
-  def similiar_entities(params)
-    e_json = self.get_entity_json(params)
-    g = Groupy::EntityGrouper.new(mongo, e_json["name"])
-    g.similiar(e_json["tag"], e_json["skip"], e_json["limit"], e_json["reverse"])
-  end
+    def similiar_entities(params)
+      e_json = self.get_entity_json(params)
+      g = Groupy::EntityGrouper.new(mongo, e_json["name"])
+      g.similiar(e_json["tag"], e_json["skip"], e_json["limit"], e_json["reverse"])
+    end
   
-end
-
-class Application < Sinatra::Base
-  include ApplicationHelper
-  register Sinatra::MongoExtension
-  set :app_file, __FILE__
-  set :mongo, 'mongo://localhost:27017/test'
-  
-  before do 
-    headers "Content-Type"   => "application/json; charset=UTF-8"
   end
+
+  class GroupyServer < Sinatra::Base
+    include GroupyServerSupport
+    #register Sinatra::MongoExtension
+    #set :mongo, 'mongo://localhost:27017/test'
   
-  get '/entity' do
-    response = Hash[:success => true, :entity => self.get_entity(params)]
-    halt 404, JSON.generate({:success => false, 
-      :message => "not found"}) if not response[:entity]
-    JSON.generate(response)
-  end
+    before do 
+      headers "Content-Type"   => "application/json; charset=UTF-8"
+    end
   
-  put '/entity' do
-    response = Hash[:success => true, :entity => self.get_entity(params, true)]
-    halt 500, JSON.generate({:success => false, 
-      :message => "unable to create entity"}) if not response[:entity]
-    status 201
-    JSON.generate(response)
-  end
+    get '/entity' do
+      response = Hash[:success => true, :entity => self.get_entity(params)]
+      halt 404, JSON.generate({:success => false, 
+        :message => "not found"}) if not response[:entity]
+      JSON.generate(response)
+    end
   
-  delete '/entity' do
-    response = Hash[:success => true]
-    self.delete_entity(params)
-    JSON.generate(response)
-  end
+    put '/entity' do
+      response = Hash[:success => true, :entity => self.get_entity(params, true)]
+      halt 500, JSON.generate({:success => false, 
+        :message => "unable to create entity"}) if not response[:entity]
+      status 201
+      JSON.generate(response)
+    end
   
-  put '/entity/tags' do
-    response = Hash[:success => true, :entity => self.tag_entity(params, true)]
-    halt 500, JSON.generate({:success => false, 
-      :message => "unable to create entity tag"}) if not response[:entity]
-    JSON.generate(response)
-  end
+    delete '/entity' do
+      response = Hash[:success => true]
+      self.delete_entity(params)
+      JSON.generate(response)
+    end
   
-  delete '/entity/tags' do
-    response = Hash[:success => true, :entity => self.tag_entity(params, false)]
-    halt 500, JSON.generate({:success => false, 
-      :message => "unable to remove entity tag"}) if not response[:entity]
-    JSON.generate(response)
-  end
+    put '/entity/tags' do
+      response = Hash[:success => true, :entity => self.tag_entity(params, true)]
+      halt 500, JSON.generate({:success => false, 
+        :message => "unable to create entity tag"}) if not response[:entity]
+      JSON.generate(response)
+    end
   
-  get '/entity/similiar' do
-    response = Hash[:success => true, :results => self.get_entity_similiar(params)]
-    JSON.generate(response)
-  end
+    delete '/entity/tags' do
+      response = Hash[:success => true, :entity => self.tag_entity(params, false)]
+      halt 500, JSON.generate({:success => false, 
+        :message => "unable to remove entity tag"}) if not response[:entity]
+      JSON.generate(response)
+    end
   
-  get '/group' do
-    response = Hash[:success => true, 
-      :results => self.similiar_entities(params)]
-    JSON.generate(response)
-  end
+    get '/entity/similiar' do
+      response = Hash[:success => true, :results => self.get_entity_similiar(params)]
+      JSON.generate(response)
+    end
   
-  post '/group' do
-    self.group_entities(params)
-    response = Hash[:success => true, 
-      :result => self.similiar_entities(params)]
-    JSON.generate(response)
-  end
+    get '/group' do
+      response = Hash[:success => true, 
+        :results => self.similiar_entities(params)]
+      JSON.generate(response)
+    end
   
-  run! if app_file == $0
+    post '/group' do
+      self.group_entities(params)
+      response = Hash[:success => true, 
+        :result => self.similiar_entities(params)]
+      JSON.generate(response)
+    end
+  end
 end

data/lib/rugroupy/server_default.rb

@@ -0,0 +1,9 @@
+require 'rugroupy/server'
+
+# This default server is used for testing
+class ServerDefault < Groupy::GroupyServer
+  register Sinatra::MongoExtension
+  set :mongo, 'mongo://localhost:27017/test'
+end
+
+ServerDefault.run!

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rugroupy-server
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Ryan Wynn
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-17 00:00:00 Z
+date: 2011-08-18 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   requirement: &id001 !ruby/object:Gem::Requirement 
@@ -232,6 +232,7 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - lib/rugroupy/server.rb
+- lib/rugroupy/server_default.rb
 - LICENSE.txt
 - README.rdoc
 homepage: http://github.com/rwynn/rugroupy-server