schemaless_rest_api 0.3.1 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3731a9bf8d9709cc8590747fa3393be24b2bbf08dcbf369885f6117020c55044
-  data.tar.gz: f9688d82dd36200103071c0145d9ba30d51e66df14ef4d25b3ba586bd62aad84
+  metadata.gz: 1c6884db983603d3fe99853d2daf2448c5a112535d427c4dcf93085c03d0d572
+  data.tar.gz: 233cf6a115128268144a612ff02e5de53c32b4f1dc0cb3e46a53f15ebc776e9d
 SHA512:
-  metadata.gz: b890245a0f5a8d6ef1882bd6a84836bbffd392727b6451e163aaf10cefbc42421866308e03cd06ff285ffa849e52ef2bd96ae5752f4c1fa191f4253b6c406e47
-  data.tar.gz: a70a459a193612c444da3ecacc54f6484abc7a8104d3f2e3dca20a168eb6fa586319fe36d03a387f8b270fe0fb0db918ce04cbf732afde1ac61bd1291e4a62e6
+  metadata.gz: 6fddf98f70498d9efee708f86ba28a3ddc4da8b53c029886c964ba8be2078d8bc459d025c50236bb11c9992a8a4ef5edd62d3a05491d8686ac481c2d6a61238a
+  data.tar.gz: ad73ffe9c66723853b0e0a9dc6ecaeb30371b7b12ceb33267715de10dcac052bb3d2107ad3fd4d93bff978239077d2a9434e526b8a32dc550676145b4d0b7db9

data/lib/schemaless_rest_api/mongo_client.rb

@@ -1,4 +1,6 @@
-require 'mongo'
+require "mongo"
+
+# typed: false - MongoClient new
 
 module MongoClient
   class << self
@@ -7,11 +9,11 @@ module MongoClient
 
     def insert(model, data, id)
       collection = MongoClient.client[model]
-      collection.insert_one({ id: id, **data})
+      collection.insert_one({ id: id, **data })
     end
 
     def find(model, id)
-      find_all(model, { id: id } )
+      find_all(model, { id: id })
     end
 
     def get_all(model)
@@ -24,7 +26,7 @@ module MongoClient
 
     def find_all(model, query)
       collection = MongoClient.client[model]
-      collection.find( query ).collect do |match|
+      collection.find(query).collect do |match|
         match.delete("_id")
         match
       end
@@ -32,7 +34,7 @@ module MongoClient
 
     def update(model, id, data)
       collection = MongoClient.client[model]
-      collection.update_one({ id: id }, { id: id, **data})
+      collection.update_one({ id: id }, { id: id, **data })
     end
 
     def delete(model, id)
@@ -42,13 +44,15 @@ module MongoClient
   end
 end
 
-if ENV['mongo_root_password']
-MongoClient.client = Mongo::Client.new(
-    [ "#{ENV['mongodb']}:27017" ],
-    database: 'api', password: ENV['mongo_root_password'],
-    user: 'root')
-else
-  MongoClient.client = Mongo::Client.new(
-      [ "#{ENV['mongodb']}:27017" ],
-      database: 'api')
-end
+MongoClient.client = if ENV["mongo_root_password"]
+                       Mongo::Client.new(
+                         ["#{ENV["mongodb"]}:27017"],
+                         database: "api", password: ENV["mongo_root_password"],
+                         user: "root"
+                       )
+                     else
+                       Mongo::Client.new(
+                         ["#{ENV["mongodb"]}:27017"],
+                         database: "api"
+                       )
+                     end

data/lib/schemaless_rest_api/rest_server.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
 require "sinatra"
-require 'docdsl'
+require "docdsl"
 require "puma"
-require 'route_downcaser'
+require "route_downcaser"
 
+# Server with endpoints generated based on Entities with CRUD operations for them
 class RestServer < Sinatra::Base
   set :server, :puma
   enable :logging if ENV["debug"] == "true"
@@ -35,8 +36,8 @@ class RestServer < Sinatra::Base
   end
   get "/" do
     summary = { models: Entities.models.keys.to_s,
-                docs_url: '<a href=/docs>/docs</a>' }
-    summary[:db] = MongoClient.client.summary.to_s if ENV['mongodb']
+                docs_url: "<a href=/docs>/docs</a>" }
+    summary[:db] = MongoClient.client.summary.to_s if ENV["mongodb"]
     JSON.generate(summary)
   rescue Exception => e
     [500, e.message]
@@ -49,15 +50,17 @@ class RestServer < Sinatra::Base
       status 201
     end
     post "/#{model.downcase}" do
+      response["Access-Control-Allow-Origin"] = "*"
+      SchemalessRestApi.logger.info "POST #{request.fullpath}"
       data = JSON.parse(request.body.read)
-      id = ''
-      if (data['id'])
-        id = data['id'].to_s
+      id = ""
+      if data["id"]
+        id = data["id"].to_s
       else
         id = SecureRandom.uuid
-        data['id'] = id
+        data["id"] = id
       end
-      if ENV['mongodb']
+      if ENV["mongodb"]
         MongoClient.insert(model, data, id)
       else
         Entities.models[model][id] = data
@@ -65,14 +68,22 @@ class RestServer < Sinatra::Base
       [201, JSON.generate({ id: id })]
     end
 
+    options "/#{model.downcase}" do
+      response["Allow"] = "*"
+      response["Access-Control-Allow-Origin"] = "*"
+      response["Access-Control-Allow-Methods"] = "*"
+      response["Access-Control-Allow-Headers"] = "*"
+    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']
+      response["Access-Control-Allow-Origin"] = "*"
+      SchemalessRestApi.logger.info "GET #{request.fullpath}"
+      if ENV["mongodb"]
         if params == {}
           JSON.generate(MongoClient.get_all(model))
         else
@@ -81,7 +92,10 @@ class RestServer < Sinatra::Base
       else
         return JSON.generate(Entities.models[model].values) if params == {}
 
-        Entities.models[model].values.find_all { |val| val[params.keys[0]] == params.values[0] }
+        matching_values = Entities.models[model].values.find_all do |val|
+          val[params.keys[0]].to_s == params.values[0]
+        end
+        return JSON.generate(matching_values)
       end
     rescue Exception => e
       [404, "Nothing found using #{params}. Only first param considered. #{e.message}"]
@@ -93,10 +107,12 @@ class RestServer < Sinatra::Base
       status 404
     end
     get "/#{model.downcase}/:id" do |id|
-      puts request.path.downcase
-      if ENV['mongodb']
+      response["Access-Control-Allow-Origin"] = "*"
+      SchemalessRestApi.logger.info "GET #{request.fullpath}"
+      if ENV["mongodb"]
         results = MongoClient.find(model, id)
         return not_have(id) unless results.first
+
         JSON.generate(results.first)
       else
         return not_have(id) unless has_id?(model, id)
@@ -105,6 +121,13 @@ class RestServer < Sinatra::Base
       end
     end
 
+    options "/#{model.downcase}/:id" do
+      response["Allow"] = "*"
+      response["Access-Control-Allow-Origin"] = "*"
+      response["Access-Control-Allow-Methods"] = "*"
+      response["Access-Control-Allow-Headers"] = "*"
+    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}"
@@ -112,11 +135,13 @@ class RestServer < Sinatra::Base
       status 404
     end
     put "/#{model.downcase}/:id" do |id|
-      puts request.path.downcase
+      response["Access-Control-Allow-Origin"] = "*"
+      SchemalessRestApi.logger.info "PUT #{request.fullpath}"
       data = JSON.parse(request.body.read)
-      if ENV['mongodb']
+      if ENV["mongodb"]
         results = MongoClient.find(model, id)
         return not_have(id) unless results.first
+
         MongoClient.update(model, id, data)
       else
         return not_have(id) unless has_id?(model, id)
@@ -131,10 +156,12 @@ class RestServer < Sinatra::Base
       status 204
     end
     delete "/#{model.downcase}/:id" do |id|
-      puts request.path.downcase
-      if ENV['mongodb']
+      response["Access-Control-Allow-Origin"] = "*"
+      SchemalessRestApi.logger.info "DEL #{request.fullpath}"
+      if ENV["mongodb"]
         results = MongoClient.find(model, id)
         return not_have(id) unless results.first
+
         MongoClient.delete(model, id)
       else
         return not_have(id) unless has_id?(model, id)

data/lib/schemaless_rest_api/version.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# typed: true
+
 module SchemalessRestApi
-  VERSION = "0.3.1"
+  VERSION = "0.3.4"
 end

data/lib/schemaless_rest_api.rb

@@ -1,28 +1,43 @@
 # frozen_string_literal: true
 
+# typed: true
+
 require_relative "schemaless_rest_api/version"
 require_relative "schemaless_rest_api/entities"
+require "tapioca"
+require "logger"
 
 require "json"
 require "securerandom"
 
+# Global params for Schemalass REST API
+module SchemalessRestApi
+  @logger = Logger.new($stdout)
+  class << self
+    # @return Logger
+    attr_accessor :logger
+  end
+
+  class Error < StandardError; end
+end
+
 def models_env_not_set
-  !ENV["models"] || ENV["models"].empty?
+  !ENV["models"] || T.must(ENV["models"]).empty?
 end
 
 def extract_models
-  return [] if (!Entities.models.empty? && models_env_not_set)
-  
+  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 or create 'db.json'. #{error_msg}" if ENV["models"].nil?
 
-  models = eval(ENV["models"])
+  models = eval(T.must(ENV["models"])) # rubocop:disable Security/Eval
   raise error_msg unless models.is_a? Array
 
   models
 end
 
-SEED_FILE = 'db.json'.freeze
+SEED_FILE = "db.json"
 
 if File.exist? SEED_FILE
   puts "Seeding db based on '#{SEED_FILE}'"
@@ -31,10 +46,11 @@ if File.exist? SEED_FILE
     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
+        next unless value["id"]
+
+        Entities.models[entity.to_sym][value["id"].to_s] = value
       end
-    else 
+    else
       puts "Entity 'entity' doesn't have array, skipping"
     end
   end
@@ -46,15 +62,10 @@ end
 
 puts "Modelling #{Entities.models.keys}"
 
-if ENV['mongodb']
-  require_relative 'schemaless_rest_api/mongo_client'
+if ENV["mongodb"]
+  require_relative "schemaless_rest_api/mongo_client"
 else
   puts "[INFO] Using in memory storage. Pass in 'mongodb' ENV variable to store
 in db"
 end
 require_relative "schemaless_rest_api/rest_server"
-
-module SchemalessRestApi
-  class Error < StandardError; end
-  # Your code goes here...
-end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: schemaless_rest_api
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.4
 platform: ruby
 authors:
 - Samuel Garratt
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-22 00:00:00.000000000 Z
+date: 2024-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rackup
+  name: mongo
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mongo
+  name: puma
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sinatra
+  name: rackup
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sinatra-docdsl
+  name: route_downcaser
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: puma
+  name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: sinatra-docdsl
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: route_downcaser
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="