esapiserver 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 02e712cfab8f66fde6adaac61b7362a41c6ab292
-  data.tar.gz: 66c11aacd9b13f8d8d4216bd5b890f91160a1964
+  metadata.gz: d29610e65e8c9fd785f760e9996c5bbcd43d291a
+  data.tar.gz: 3934d0c162adfdf35952d5e63afe4ff068082ddf
 SHA512:
-  metadata.gz: 00825142271faa45b2b06af86dc9498e9729f18c94b7c628b5f7244733addc8a0f62fe037d2d531703d07016ab8e8e3aa521dcedae8ba892a9c37722bb2799e2
-  data.tar.gz: 07347c7bd0d059e58a8aeca639f3008d606ecc668169bb96c52a9c84ff36e50584755b02e76a306559695da670c0159104e8090c0df32db416f4603c96de0aa2
+  metadata.gz: 7f774209bcf0cdf3db811011d47221d9f24dbe076ad04ad93d8d491f821a2fedd9b338bfb562ef49fb9a7728fc9f289ddaad51933cd84cb6d5149ef025dca850
+  data.tar.gz: 5b5989832c12b42cef4255ddb2360ce4e4ee3d3d7dad8bafb3c017ea6d9a68010c5e8525b3e84c9fa73632551abf8b8af0e38889b355c9c9108cc7628d2b94a4

data/README.md

@@ -1,6 +1,8 @@
 # Esapiserver
 
-A Sinatra/MongoDB API server to use for EmberJS development
+A very lightweight Sinatra/MongoDB CRUD API server to be used for EmberJS development and testing. By using MongoDB as the database server, all the tables are created on the fly when POST requests are made, in other words, no tables needs to be created beforehand.
+
+I started out using the fixture and local storage adapter in Ember, but experienced that the limitations that these adapters have, would turn out be a pain in the butt later when it was time to release my app - I wanted to make sure that what I test, was consistant with what I would release, hence the esapiserver. 
 
 ## Installation
 
@@ -9,7 +11,7 @@ Run:
 	Install the gem
     	$ gem install esapiserver
     
-    Start up your mongoDB server    
+    Start up your mongoDB server   
     	$ mongoD
     	
     Start the Ember Sinatra/MongoDB API server
@@ -25,44 +27,45 @@ Database related requests:
 	Reset a db - this will drop and reload the DB
 		http://localhost:4567/reset_db/ember_test_db
 		
-	List a collection of a selected db
+	List the collections of the selected db
 		http://localhost:4567/db_collections
 	
 	
 POST request:
 
-	Creates a new thing
-		http://localhost:4567/api/:thing
+	Creates a new model
+		http://localhost:4567/api/:model
 	
 	
 GET requests:
 
-	Returns a list of things
-		http://localhost:4567/api/:thing
+	Returns a list of models
+		http://localhost:4567/api/:model
 	
-	Returns a list of things that matches a specific query
-		http://localhost:4567/api/:thing?ids[]=id1&ids[]=id2
+	Returns a list of models that matches a specific query
+		http://localhost:4567/api/:model?ids[]=id1&ids[]=id2
 	
-	Returns a thing with a specific key/value
-		http://localhost:4567/api/:thing?key=value
+	Returns a model with a specific key/value
+		http://localhost:4567/api/:model?key=value
 		
-	Returns a thing with a specific id
-		http://localhost:4567/api/:thing/:id
+	Returns a model with a specific id
+		http://localhost:4567/api/:model/:id
 	
 DELETE request:
 
-	Deletes a thing with a specific id
-		http://localhost:4567/api/:thing/:id
+	Deletes a model with a specific id
+		http://localhost:4567/api/:model/:id
 	
 PUT request:
 
-	Updates a thing with a specific id
-		http://localhost:4567/api/:thing/:id
+	Updates a model with a specific id
+		http://localhost:4567/api/:model/:id
+		
+
+EmberJS
 
-## Contributing
+	App.ApplicationAdapter = DS.RESTAdapter.extend
+    	namespace: 'api'
+    	host: 'http://127.0.0.1:4567'
+    	corsWithCredentials: true
 
-1. Fork it ( https://github.com/[my-github-username]/esapiserver/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request

data/lib/esapiserver.rb

@@ -9,9 +9,13 @@ require "esapiserver/version"
 
 module Esapiserver
   class Server < Sinatra::Application
-    mongoDB = Mongo::Connection.new
-    @@db = nil
-
+    POOL_SIZE = 5
+    TIMEOUT = 5
+    
+    $mongoDB = Mongo::Connection.new
+    $db = nil
+    
+    
     #
     #
     #
@@ -35,7 +39,7 @@ module Esapiserver
     # running tests.
     #
     get '/select_db/:db' do
-      @@db = mongoDB.db(params[:db], :pool_size => 5, :timeout => 5)
+      $db = $mongoDB.db(params[:db], :pool_size => POOL_SIZE, :timeout => TIMEOUT)
       "DB #{params[:db]} selected"
     end
 
@@ -43,8 +47,8 @@ module Esapiserver
     # This will drop the DB and reload it - useful for cleaning up when running tests
     #
     get '/reset_db/:db' do
-      mongoDB.drop_database(params[:db])
-      @@db = mongoDB.db(params[:db], :pool_size => 5, :timeout => 5)
+      $mongoDB.drop_database(params[:db])
+      $db = $mongoDB.db(params[:db], :pool_size => POOL_SIZE, :timeout => TIMEOUT)
       "DB #{params[:db]} dropped and reloaded"
     end
 
@@ -52,28 +56,28 @@ module Esapiserver
     # Get a list of collections for a specific DB
     #
     get '/db_collections' do
-      if @@db == nil
+      if $db == nil
         "Please select a DB using /select_db/:db where :db is the name of the database"
       else
-        collections = @@db.collection_names
+        collections = $db.collection_names
         "#{collections}"
       end
     end
 
     #
-    # Returns a list of things or a list of things that matches a specific query
+    # Returns a list of models or a list of models that matches a specific query
     # http://localhost:4567/api/focusareas - will retrieve all the focusareas
     # http://localhost:4567/api/focusareas?theme_id=53bb2eba19cfd247e4000002 - will retrieve all the focusareas
     # belonging to the specified theme.
     # Works only with a single query parameter or multiple ids[] parameters
-    get '/api/:thing' do
+    get '/api/:model' do
       content_type :json
       query = {}
       result = {}
-      collection = @@db.collection(params[:thing])
+      collection = $db.collection(params[:model])
 
       if request.query_string.empty?
-        result = collection.find.to_a.map{|t| frombsonid(t, params[:thing])}.to_json
+        result = collection.find.to_a.map{|t| fromBsonId(t, params[:model])}.to_json
       else
         if request.query_string.include? 'ids[]' or request.query_string.include? 'ids%5B%5D' #don't know why it does not get unescaped
           ids = []
@@ -83,76 +87,76 @@ module Esapiserver
             queries.each do |q|
               key, value = q.split('=')
               if key != 'ids[]' and key != 'ids%5B%5D' #check to see if all the keys match
-                throw 'multiple query parameters not supported yet, except _ids[]='
+                throw 'multiple query parameters not supported yet, except for _ids[]='
               end
-              ids << tobsonid(value)
+              ids << toBsonId(value)
             end            
           else
             key, value = request.query_string.split('=')
-            ids << tobsonid(value)
+            ids << toBsonId(value)
           end
           query = {"_id" => { "$in" => ids }}
         elsif request.query_string.include? '&'
           throw 'multiple query parameters not supported yet, except _ids[]='
         else
           key, value = request.query_string.split('=')
-          query = {modelName(params[:thing]) + "." + key => value}
+          query = {modelName(params[:model]) + "." + key => value}
         end
-        result = collection.find(query).to_a.map{|t| frombsonid(t, params[:thing])}.to_json
+        result = collection.find(query).to_a.map{|t| fromBsonId(t, params[:model])}.to_json
       end
-      serializeJSON(result, params[:thing])
+      serializeJSON(result, params[:model])
     end
 
     #
-    # Returns a thing with a specific id
+    # Returns a model with a specific id
     #
-    get '/api/:thing/:id' do
+    get '/api/:model/:id' do
       content_type :json
-      find_one(params[:thing], params[:id])
+      findOne(params[:model], params[:id])
     end
 
     #
-    # Create a new thing
+    # Create a new model
     #
-    post '/api/:thing' do
+    post '/api/:model' do
       content_type :json
       json = JSON.parse(request.body.read.to_s)
-      oid = @@db.collection(params[:thing]).insert(json)
-      find_one(params[:thing], oid.to_s)
+      oid = $db.collection(params[:model]).insert(json)
+      findOne(params[:model], oid.to_s)
     end
 
     #
-    # Delete a thing with a specific id
+    # Delete a model with a specific id
     #
-    delete '/api/:thing/:id' do
+    delete '/api/:model/:id' do
       content_type :json
-      @@db.collection(params[:thing]).remove({'_id' => tobsonid(params[:id])})
+      $db.collection(params[:model]).remove({'_id' => toBsonId(params[:id])})
       "{}"
     end
 
     #
-    # Update a thing with a specific id
+    # Update a model with a specific id
     #
-    put '/api/:thing/:id' do
+    put '/api/:model/:id' do
       content_type :json
-      selector = {'_id' => tobsonid(params[:id])}
+      selector = {'_id' => toBsonId(params[:id])}
       json = JSON.parse(request.body.read).reject{|k,v| k == 'id'}
       document = {'$set' => json}
-      result = @@db.collection(params[:thing]).update(selector, document)
-      find_one(params[:thing], params[:id])
+      result = $db.collection(params[:model]).update(selector, document)
+      findOne(params[:model], params[:id])
     end
 
     #
     # Convert the id to a BSON object id
     #
-    def tobsonid(id)
+    def toBsonId(id)
       BSON::ObjectId.from_string(id)
     end
 
     #
     # Extract the BSON id, then replacing the '_id' key with a 'id' key
     #
-    def frombsonid(obj, thing)
+    def fromBsonId(obj, model)
       id = obj['_id'].to_s
       obj.delete("_id")
       obj.each{|t| t[1]['id'] = id}
@@ -161,28 +165,28 @@ module Esapiserver
     #
     # Serialize the Mongo JSON to Ember friendly JSON
     #
-    def serializeJSON(json, thing)
+    def serializeJSON(json, model)
       hash = JSON.parse(json)
       jsonArray = []
-      hash.each {|h| jsonArray << h[modelName(params[:thing])]}
-      newJson = {modelName(params[:thing]) => jsonArray}
+      hash.each {|h| jsonArray << h[modelName(params[:model])]}
+      newJson = {modelName(params[:model]) => jsonArray}
       newJson.to_json
     end
 
     #
     # Utility method - find one and the sreialize to Ember Friendly JSON
     #
-    def find_one(thing, id)
-      result = @@db.collection(thing).find_one(tobsonid(id))
+    def findOne(model, id)
+      result = $db.collection(model).find_one(toBsonId(id))
       jsonArray = []
       if result != nil
-        normalizedResult = frombsonid(result, thing).to_json
+        normalizedResult = fromBsonId(result, model).to_json
         hash = JSON.parse(normalizedResult)
-        jsonArray << hash[modelName(thing)]
-        newJson = {modelName(params[:thing]) => jsonArray}
+        jsonArray << hash[modelName(model)]
+        newJson = {modelName(params[:model]) => jsonArray}
       newJson.to_json
       else
-        noResults = {modelName(thing) => jsonArray}
+        noResults = {modelName(model) => jsonArray}
       noResults.to_json
       end
     end
@@ -190,9 +194,9 @@ module Esapiserver
     #
     # Very crude method to singularize the model name.
     #
-    def modelName(thing)
-      #thing.chomp("s")
-      thing.singularize
+    def modelName(model)
+      #model.chomp("s")
+      model.singularize
     end
   end
 end

data/lib/esapiserver/version.rb

@@ -1,3 +1,3 @@
 module Esapiserver
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/spec/esapiserver_spec.rb

@@ -23,7 +23,7 @@ describe 'esapiserver that' do
   end
   
   describe 'handle POST requests that' do
-    it 'creates a new thing' do
+    it 'creates a new model' do
       payload = '{"post": {"name": "test"}}'      
       post '/api/posts', payload, "CONTENT_TYPE" => "application/json"
       expect(last_response).to be_ok
@@ -33,7 +33,7 @@ describe 'esapiserver that' do
   end
   
   describe 'handle GET requests that' do
-    it 'returns a list of things' do
+    it 'returns a list of models' do
       get '/api/posts'
       expect(last_response).to be_ok
       expect(last_response.body).to include('{"post":[{"name":"test","id"')
@@ -41,7 +41,7 @@ describe 'esapiserver that' do
     end
     
     #http://127.0.0.1:4567/api/focusareas?ids%5B%5D=53d7781819cfd232f4000085&ids%5B%5D=53d778e319cfd232f4000087
-    it 'returns a list of things that matches a specific query' do
+    it 'returns a list of models that matches a specific query' do
       #create another post
       payload = '{"post": {"name": "test1"}}'
       post '/api/posts', payload, "CONTENT_TYPE" => "application/json"
@@ -62,14 +62,15 @@ describe 'esapiserver that' do
     end
     
     #http://localhost:4567/api/posts?name=test1
-    it 'returns a thing with a specific key/value' do
+    it 'returns a model with a specific key/value' do
       get '/api/posts?name=test1'
       expect(last_response).to be_ok
       expect(last_response.body).to include('{"post":[{"name":"test1","id"')
     end
     
-    it 'returns a thing with a specific id' do
+    it 'returns a model with a specific id' do
       get '/api/posts'
+      expect(last_response).to be_ok
       json_hash = JSON.parse(last_response.body)            
       id = json_hash["post"][0]["id"]
       get '/api/posts/' + id
@@ -80,22 +81,23 @@ describe 'esapiserver that' do
   end
     
   describe 'handle DELETE requests that' do
-    it 'deletes a thing with a specific id' do
+    it 'deletes a model with a specific id' do
       get '/api/posts'
+      expect(last_response).to be_ok
       json_hash = JSON.parse(last_response.body)
       id = json_hash["post"][1]["id"]
       delete '/api/posts/' + id
-      expect(last_response).to be_ok
       get '/api/posts'
-      json_hash = JSON.parse(last_response.body)
       expect(last_response).to be_ok
+      json_hash = JSON.parse(last_response.body)
       expect(json_hash["post"].length).to equal(1)
     end
   end
   
   describe 'handle PUT requests that' do
-    it 'updates a thing with a specific id' do
+    it 'updates a model with a specific id' do
       get '/api/posts?name=test'
+      expect(last_response).to be_ok
       json_hash = JSON.parse(last_response.body)
       id = json_hash["post"][0]["id"]      
       payload = '{"post": {"name": "updated test"}}'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: esapiserver
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - William Miles
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-30 00:00:00.000000000 Z
+date: 2014-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler