schemaless_rest_api 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 772e554afa1851f8a505754ce97e174218f28b2fdfa7cb8cea9e20483fe1a0a0
-  data.tar.gz: 442745cdc52411aa5e2db5d20fc9474188314ef94282db4b620675114a84f1ba
+  metadata.gz: 5970ba634fc9a47c750d7716b380b5af871942554a0f06b9927cb1f612a39d5d
+  data.tar.gz: 2b6734f5b0f5b102e39d488e8f27ca2270d3fdff20b0f3a04b4cdf903163e8d0
 SHA512:
-  metadata.gz: 9c5f723fba1e431ee358afadfb6ed5d96bd081f8849d565fd23e31474c720c2ecf39b3f7e43e2eecef8bb896686e0e4d4a8a4837b4a1a35c565c253ab95015c1
-  data.tar.gz: cb903faf022ce6d7605ae3ea60e570a548f2db2b5c246d67a1fff1c405b85854d49b4dde11b89390b7f2b855dcbf75f7e0ec74cfd3dc99b90c0f5ad2cdec902b
+  metadata.gz: f879739e486794d5464584cad902a764e0eeb8c9a90c1c92f607eef8773a2fb8739260bffff5b8a2c94bb0db2a594f6f267c8b97bd5df7bf7beef140efc00d64
+  data.tar.gz: f5ff9ddf4bf0f7f3870fb6a21354397913b8a6b158ca5dc0078e547d50b84097aa179dadae37daaa96960bb1c38cdbf828f7d4c77aff062115cdf4e61bb3a2d4

data/lib/schemaless_rest_api/mongo_client.rb

@@ -42,6 +42,13 @@ module MongoClient
   end
 end
 
+if ENV['mongo_root_password']
 MongoClient.client = Mongo::Client.new(
     [ "#{ENV['mongodb']}:27017" ],
-    :database => 'api')
+    database: 'api', password: ENV['mongo_root_password'],
+    user: 'root')
+else
+  MongoClient.client = Mongo::Client.new(
+      [ "#{ENV['mongodb']}:27017" ],
+      database: 'api')
+end

data/lib/schemaless_rest_api/rest_server.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "sinatra"
+require 'docdsl'
 require "puma"
 require 'route_downcaser'
 
@@ -10,6 +11,17 @@ class RestServer < Sinatra::Base
   set :bind, "0.0.0.0"
   use RouteDowncaser::DowncaseRouteMiddleware
 
+  register Sinatra::DocDsl
+
+  page do
+    title "Schmaless REST API"
+    header "REST API using models #{Entities.models.keys}"
+    introduction "REST APIs allowing CRUD on:
+#{Entities.models.keys.join("\n")}"
+  end
+
+  doc_endpoint "/docs"
+
   def has_id?(model, id)
     Entities.models[model].key?(id)
   end
@@ -18,8 +30,12 @@ class RestServer < Sinatra::Base
     [404, JSON.generate({ error: "'#{id}' not found" })]
   end
 
+  documentation "Get summary" do
+    response "Basic basic summary of API"
+  end
   get "/" do
-    summary = { models: Entities.models.keys.to_s }
+    summary = { models: Entities.models.keys.to_s,
+                docs_url: '<a href=/docs>/docs</a>' }
     summary[:db] = MongoClient.client.summary.to_s if ENV['mongodb']
     JSON.generate(summary)
   rescue Exception => e
@@ -27,17 +43,33 @@ class RestServer < Sinatra::Base
   end
 
   Entities.models.each_key do |model|
+    documentation "Create instance of #{model}" do
+      payload "Whatever JSON you want. Needs to be valid JSON"
+      response "Id of created #{model}"
+      status 201
+    end
     post "/#{model.downcase}" do
-      id = SecureRandom.uuid
       data = JSON.parse(request.body.read)
+      id = ''
+      if (data['id'])
+        id = data['id'].to_s
+      else
+        id = SecureRandom.uuid
+        data['id'] = id
+      end
       if ENV['mongodb']
         MongoClient.insert(model, data, id)
       else
         Entities.models[model][id] = data
       end
-      [201, id]
+      [201, JSON.generate({ id: id })]
     end
 
+    documentation "Retrieve all instances of #{model} or filtered by query param" do
+      response "Data in #{model}"
+      query_param :key_to_search_in_data, "Value of key"
+      status 200
+    end
     get "/#{model.downcase}" do
       puts request.path.downcase
       if ENV['mongodb']
@@ -47,7 +79,7 @@ class RestServer < Sinatra::Base
           [200, JSON.generate(MongoClient.find_all(model, params))]
         end
       else
-        return [200, Entities.models[model].to_s] if params == {}
+        return JSON.generate(Entities.models[model].values) if params == {}
 
         Entities.models[model].values.find_all { |val| val[params.keys[0]] == params.values[0] }
       end
@@ -55,6 +87,11 @@ class RestServer < Sinatra::Base
       [404, "Nothing found using #{params}. Only first param considered. #{e.message}"]
     end
 
+    documentation "Retrieve specific instance of #{model} by id" do
+      response "Data in #{model}"
+      status 200
+      status 404
+    end
     get "/#{model.downcase}/:id" do |id|
       puts request.path.downcase
       if ENV['mongodb']
@@ -68,6 +105,12 @@ class RestServer < Sinatra::Base
       end
     end
 
+    documentation "Update id of #{model} to be provided data" do
+      payload "Whatever JSON you want updated to be. Needs to be valid JSON"
+      response "Data in #{model}"
+      status 204
+      status 404
+    end
     put "/#{model.downcase}/:id" do |id|
       puts request.path.downcase
       data = JSON.parse(request.body.read)
@@ -83,6 +126,10 @@ class RestServer < Sinatra::Base
       204
     end
 
+    documentation "Update id of #{model} to be deleted" do
+      response "Empty"
+      status 204
+    end
     delete "/#{model.downcase}/:id" do |id|
       puts request.path.downcase
       if ENV['mongodb']

data/lib/schemaless_rest_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SchemalessRestApi
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/lib/schemaless_rest_api.rb

@@ -6,9 +6,15 @@ require_relative "schemaless_rest_api/entities"
 require "json"
 require "securerandom"
 
+def models_env_not_set
+  !ENV["models"] || ENV["models"].empty?
+end
+
 def extract_models
+  return [] if (!Entities.models.empty? && models_env_not_set)
+  
   error_msg = "Make 'models' environment variable an array (e.g ['model1', 'model2'])"
-  raise "Please set 'models' ENV variable. #{error_msg}" if ENV["models"].nil?
+  raise "Please set 'models' ENV variable or create 'db.json'. #{error_msg}" if ENV["models"].nil?
 
   models = eval(ENV["models"])
   raise error_msg unless models.is_a? Array
@@ -16,6 +22,24 @@ def extract_models
   models
 end
 
+SEED_FILE = 'db.json'.freeze
+
+if File.exist? SEED_FILE
+  puts "Seeding db based on '#{SEED_FILE}'"
+  seed_data = JSON.parse(File.read(SEED_FILE))
+  seed_data.each do |entity, values|
+    Entities.models[entity.to_sym] = {} unless Entities.models[entity.to_sym]
+    if values.is_a? Array
+      values.each do |value|
+        next unless value['id']
+        Entities.models[entity.to_sym][value['id'].to_s] = value
+      end
+    else 
+      puts "Entity 'entity' doesn't have array, skipping"
+    end
+  end
+end
+
 extract_models.each do |model|
   Entities.models[model.to_sym] = {}
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: schemaless_rest_api
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Samuel Garratt
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-14 00:00:00.000000000 Z
+date: 2024-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongo