mongo_api 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6001ced1910df6e81de93e36b958637d92e4e0cb9edc20ca0afa1ca0ec53fa0f
-  data.tar.gz: c07e8e771d53832530d3acc0f5707e7a3970aeb47aabf95d39c4227c1ce735fb
+  metadata.gz: e35665e93037350fedb5c17c84f80cda9524388ec20c1160a6160e233723d1f7
+  data.tar.gz: 20bfae5242c903349258b4ec7fc4532b461eb8ddb0ab606bd4da4aba7d1236ec
 SHA512:
-  metadata.gz: d010ddab038f1603c6d55ba7b79cefeceb1998e49b9aaf0821344f5e99872db5b127a69bf369f96281550b4d1f3ba7ec3d30ee12373958f8f2f078ac3809429f
-  data.tar.gz: 01ef197bcd8f69c308e35b53ce898708e10880cdbc4329d21c16fceddcad82a88cec7c34ce25ca06f574bd6c52e538a4a6d8800f5a76f274a207fce67f6f9cae
+  metadata.gz: f262ed2e54e7965b33137af848d08d2ed9e14efa0e7a2573b9ec829da81be1c02c7e5170ce063f32aa46add1ca2ea114d9de03744e7c7f907a9353b798fa3c61
+  data.tar.gz: d6391c6921483b9a9017c9295995ef531e7c68676f049b068da0a35df37e58617a7c7c19c5492942fb6688fa6fe8dd216fb49636245cb2b249d9c5af160da0e4

data/CHANGELOG.md

@@ -1,5 +1,22 @@
-## [Unreleased]
+# [Release]
 
 ## [0.1.0] - 2023-08-05
 
 - Initial release
+- Add class `MongoApi::Request` and `MongoApi::Base` to handle requests to the API and to handle requests to the database in a simple way on MongoDb Atlas Data API.
+- `MongoApi::Request` methods:
+  - `#find_one`: returns a document from a collection by filter and projection
+  - `#insert_one`: inserts a document into a collection
+  - `#insert_many`: inserts multiple documents into a collection
+  - `#update_one`: updates a document from a collection by filter
+  - `#update_many`: updates multiple documents from a collection by filter
+  - `#replace_one`: replaces a document from a collection by filter
+  - `#delete_one`: deletes a document from a collection by filter
+  - `#delete_many`: deletes multiple documents from a collection by filter
+- `MongoApi::Base` methods:
+  - `#all`: returns all documents from a collection
+  - `#find`: returns a document from a collection by filter, projection, sort and limit
+  - `#insert`: inserts a document into a collection
+  - `#update`: updates a document from a collection by filter
+  - `#replace`: replaces a document from a collection by filter
+  - `#destroy`: deletes a document from a collection by filter

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mongo_api (0.1.0)
+    mongo_api (0.1.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -18,17 +18,76 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 The gem is a simple wrapper around the MongoDb Atlas Data API to make it easier to use in Ruby applications to access data in MongoDb Atlas.
 
+Set environment variables for the MongoDb Atlas API URL, API Key, Database Name, Collection Name and Data Source Name:
+
+```env
+MONGO_ATLAS_API_URL=https://cloud.mongodb.com/api/atlas/v1.0
+MONGO_ATLAS_API_KEY=1234567890
+MONGO_DATABASE_NAME=sample_mflix
+MONGO_COLLECTION_NAME=users
+MONGO_DATASOURCE_NAME=sample_mflix
+```
+
 ### Example
 
 ```ruby
 require 'mongo_api'
 
 class Users < MongoApi::Base
-    base_url ENV['MONGO_ATLAS_API_URL']
+  base_url ENV['MONGO_ATLAS_API_URL']
   default_headers 'Content-Type': 'application/json',
                   'api-key': ENV['MONGO_ATLAS_API_KEY'],
                   'Access-Control-Request-Headers': '*'
 end
+
+# Get all users
+# @param [Hash] filter: The query predicate.
+# @param [Hash] sort: The order in which to return matching documents.
+users = Users.all(limit: 10, sort: { _id: 1 }) # => [ { "_id" => "5f9a9a9a9a9a9a9a9a9a9a9a", "name" => "John Doe" }, ... ]
+
+# Insert a new user
+# @param [Hash] document: The document to insert.
+user = Users.insert({ name: 'Jane Doe' }) # => {"insertedId"=>"64cf1065f549de65c4908375"}
+
+# Find a user by name
+# @param [Hash] filter: The query predicate.
+# @param [Hash] projection: The fields to return in the matching document.
+# @param [Hash] sort: The order in which to return matching documents.
+# @param [Integer] limit: The maximum number of documents to return.
+user = Users.find(filter: { name: 'Jane Doe' }) # => [ { "_id" => "5f9a9a9a9a9a9a9a9a9a9a9a", "name" => "Jane Doe" } ]
+
+# Update a user
+# @param [Hash] where: The query predicate.
+# @param [Hash] set: The fields to update in the matching document.
+user = Users.update(where: { name: 'Jane Doe' }, set: { name: 'Jane Smith' }) # => {"matchedCount"=>1, "modifiedCount"=>1}
+
+# Update All users
+# @param [Hash] where: The query predicate.
+# @param [Hash] set: The fields to update in the matching document.
+user = Users.update_all(where: { name: 'Jane Smith' }, set: { name: 'Jane Doe' }) # => {"matchedCount"=>1, "modifiedCount"=>1}
+
+# Destroy a user
+# @param [Hash] where: The query predicate.
+user = Users.destroy(where: { name: 'Jane Smith' }) # => {"deletedCount"=>1}
+
+# Destroy All users
+# @param [Hash] where: The query predicate.
+user = Users.destroy_all(where: { name: 'Jane Smith' }) # => {"deletedCount"=>1}    
+
+# Count users
+user = Users.count # => 10
+
+# Others methods
+Users.find_one(filter: {}, :projection: {})
+Users.insert_one({})
+Users.insert_many([{}, {}])
+Users.update_one(filter: {}, :update: {}, upsert: false)
+Users.update_many(filter: {}, :update: {}, upsert: false)
+Users.delete_one(filter: {})
+Users.delete_many(filter: {})
+Users.replace_one(filter: {}, replacement: {}, upsert: false)
+Users.aggregate(pipeline: [])
+Users.count
 ```
 
 ## Development

data/lib/mongo_api/base.rb

@@ -90,11 +90,18 @@ module MongoApi
       count
     end
 
+    # This method sets the collection name
+    #
+    # @return [String] the collection name
+    def self.collection_name
+      ancestors.first.to_s.gsub("::", "_").downcase
+    end
+
     class << self
       def body
         {
           database: ENV["MONGO_DATABASE_NAME"],
-          collection: ENV["MONGO_COLLECTION_NAME"],
+          collection: collection_name,
           dataSource: ENV["MONGO_DATASOURCE_NAME"]
         }
       end

data/lib/mongo_api/request.rb

@@ -175,6 +175,10 @@ module MongoApi
     class << self
       private
 
+      # This method is used to parse the response
+      #
+      # @param [Block] block
+      # @return [Hash|Array] the documents array or the response
       def parse_response(&block)
         data = block.call
 

data/lib/mongo_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MongoApi
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/mongo_api.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/mongo_api/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "mongo_api"
+  spec.version = MongoApi::VERSION
+  spec.authors = ["Alef Ojeda de Oliveira"]
+  spec.email = ["alef.oliveira@dimensa.com.br"]
+
+  spec.summary = "MongoApi is a gem to help you to create a REST API using MongoDB Atlas Data API."
+  spec.description = "Use this gem to create a REST API using MongoDB Atlas Data API."
+  spec.homepage = "https://github.com/nemuba/mongo_api"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.2.0"
+
+  spec.metadata["homepage_uri"] = "https://github.com/nemuba/mongo_api"
+  spec.metadata["source_code_uri"] = "https://github.com/nemuba/mongo_api/tree/main"
+  spec.metadata["changelog_uri"] = "https://github.com/nemuba/mongo_api/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongo_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Alef Ojeda de Oliveira
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-08-06 00:00:00.000000000 Z
+date: 2023-10-12 00:00:00.000000000 Z
 dependencies: []
 description: Use this gem to create a REST API using MongoDB Atlas Data API.
 email:
@@ -17,8 +17,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".byebug_history"
-- ".env"
 - ".rspec"
 - ".rubocop.yml"
 - CHANGELOG.md
@@ -31,6 +29,7 @@ files:
 - lib/mongo_api/base.rb
 - lib/mongo_api/request.rb
 - lib/mongo_api/version.rb
+- mongo_api.gemspec
 - sig/mongo_api.rbs
 homepage: https://github.com/nemuba/mongo_api
 licenses:
@@ -54,7 +53,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.12
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: MongoApi is a gem to help you to create a REST API using MongoDB Atlas Data

data/.byebug_history

@@ -1,18 +0,0 @@
-c
-response
-c
-Users.all
-Users.body
-c
-Users.body
-c
-Users.all
-c
-Users.base_url
-.base_url
-Users
-c
-Users.base_url
-Users.all
-Users
-ENV['MONGO_DATABASE_NAME']

data/.env

@@ -1,5 +0,0 @@
-MONGO_ATLAS_API_URL='https://sa-east-1.aws.data.mongodb-api.com/app/data-ixudq/endpoint/data/v1'
-MONGO_ATLAS_API_KEY='y2XeNaFtEH2PtFFvJtHS1v9ZnvzaR6r8vUwdPNhWTgGvJfa9XzxFjlVaVAH6aw3z'
-MONGO_DATABASE_NAME='mongo_api'
-MONGO_COLLECTION_NAME='users'
-MONGO_DATASOURCE_NAME='ojeda'