easymongo 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e410057d0345f4702f71a094005449ca511dafca
+  data.tar.gz: 8b2dab525f5da96fedc58715b2ecd1ead20ed93f
+SHA512:
+  metadata.gz: 18c0bb86735521dbf4baf0b67ae551120989c4ee0848bdf62a93ebefd19ea3420638641d12ef4e24ae60b1d5478693d835aa4409aa34db27e7d49678765a65e5
+  data.tar.gz: f70bb4fedf16b5e3355cd0e18f14c1ff2b3055acdfb46c15212eba09ed10a6bc7075adf166f1d03905559edb5089c7f8af80168898dbc4a8690911e2b45ee962

data/.gitignore

@@ -0,0 +1,2 @@
+.bundle
+Gemfile.lock

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+**Version 0.0.1** - *2017-07-12*
+
+- Initial version

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'rerun'
+  gem 'rb-fsevent'
+  gem 'terminal-notifier'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Fugroup
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# Easymongo
+Super easy MongoDB Ruby client. This is the way mongo should be.
+
+If you need something closer to pure Mongo, have a look at [Minimongo.](https://github.com/fugroup/minimongo)
+
+We also have [Mongocore](https://github.com/fugroup/mongocore) if you're looking for a full ORM.
+
+### Installation
+```
+gem install easymongo
+```
+or add to Gemfile.
+
+### Usage
+```ruby
+# All commands supported
+# https://docs.mongodb.com/ruby-driver/master/quick-start
+
+# Connect
+$db = Easymongo::Query.new(['127.0.0.1:27017'], :database => "easymongo_#{ENV['RACK_ENV']}")
+
+# First
+$db.collection.get.first
+
+# Last
+$db.collection.get.last
+
+# All
+$db.collection.get.all
+
+# Insert / Update
+$db.collection.set(:name => name)
+
+# Delete
+$db.domains.delete(id)
+
+```
+
+Created and maintained by [Fugroup Ltd.](https://www.fugroup.net) We are the creators of [CrowdfundHQ.](https://crowdfundhq.com)
+
+`@authors: Vidar`

data/config/boot.rb

@@ -0,0 +1,13 @@
+require 'bundler/setup'
+Bundler.require(:default, :development)
+
+MODE = ENV['RACK_ENV'] || 'development'
+
+require './lib/easymongo.rb'
+
+Mongo::Logger.logger.level = ::Logger::FATAL
+
+# Connect
+$db = Easymongo::Query.new(['127.0.0.1:27017'], :database => "easymongo_#{MODE}")
+
+include Futest::Helpers

data/easymongo.gemspec

@@ -0,0 +1,22 @@
+Gem::Specification.new do |s|
+  s.name        = 'easymongo'
+  s.version     = '0.0.1'
+  s.date        = '2017-07-12'
+  s.summary     = "Super Easy MongoDB client"
+  s.description = "The way MongoDB for Ruby should be, can't get easier than this"
+  s.authors     = ["Fugroup Limited"]
+  s.email       = 'vidar@fugroup.net'
+
+  s.add_runtime_dependency 'mongo', '>= 2.2'
+  s.add_runtime_dependency 'activesupport', '>= 4.0'
+  s.add_runtime_dependency 'request_store', '>= 1.2'
+  s.add_development_dependency 'futest', '>= 0'
+
+  s.homepage    = 'https://github.com/fugroup/easymongo'
+  s.license     = 'MIT'
+
+  s.require_paths = ['lib']
+  s.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+end

data/lib/easymongo/document.rb

@@ -0,0 +1,56 @@
+# The mongodb document
+
+module Easymongo
+  class Document
+
+    attr_accessor :doc, :values
+
+    # Takes a BSON::Document
+    def initialize(doc)
+
+      # Replace _id with id
+      doc['id'] = doc.delete('_id')
+
+      # Convert all BSON::ObjectId to string
+      doc.each{|k, v| doc[k] = v.to_s if v.is_a?(BSON::ObjectId)}
+
+      # Symbolize keys
+      self.doc = doc.symbolize_keys
+    end
+
+    # Get bson id
+    def bson_id
+      @bson_id ||= BSON::ObjectId.from_string(doc[:id])
+    end
+
+    # Creation date
+    def date
+      bson_id.generation_time
+    end
+
+    # Read value
+    def [](key)
+      doc[key.to_sym]
+    end
+
+    # Write value
+    def []=(key, value)
+      doc[key.to_sym] = value
+    end
+
+    # Make the doc user friendly with dot notation
+    # Provides access to doc object methods too
+    def method_missing(name, *args, &block)
+
+      # Write value
+      return doc[name[0..-2].to_sym] = args.first if args.size == 1 and name[-1] == '='
+
+      # Read value
+      return doc[name] if doc.has_key?(name)
+
+      # Run method on doc object
+      return doc.send(name, *args) if doc.respond_to?(name)
+    end
+
+  end
+end

data/lib/easymongo/query.rb

@@ -0,0 +1,146 @@
+# This is the easiest possible implementation of a mongodb client.
+# We got rid of the ObjectID and the underscore, and made mongodb super easy to use.
+# Use BSON::ObjectId.new.generation_time as timestamp if you need that
+#
+# If you need something close to pure Mongo, check out https://github.com/fugroup/minimongo
+# If you need models for Easymongo, check out https://github.com/fugroup/modelize
+# If you need an ORM, check out https://github.com/fugroup/mongocore
+
+require 'mongo'
+require 'active_support'
+require 'active_support/core_ext'
+require 'request_store'
+
+module Easymongo
+  class Query
+
+    attr_accessor :client
+
+    # Set up connection
+    def initialize(uri, options)
+      self.client = Mongo::Client.new(uri, options)
+    end
+
+    # Set up collection, stored in the thread
+    def method_missing(name, *args, &block)
+      s[:coll] = name; self
+    end
+
+    # Set values
+    def set(*args)
+
+      # Insert, add oid
+      data, values = args.size == 1 ? [{'_id' => oid}, *args] : args
+
+      # Using set and unset so we don't store nil in the db
+      options = {
+        :$set => values.select{|k, v| !v.nil?}, :$unset => values.select{|k, v| v.nil?}
+      }.delete_if{|k, v| v.empty?}
+
+      # Normalize data
+      data = ids(data)
+
+      # Update the collection
+      result = client[coll].update_one(data, options, :upsert => true)
+
+      # Return result
+      Easymongo::Result.new(result, data, values, options)
+    end
+
+    # Get values, store cursor in thread
+    def get(data = {})
+      s[:cursor] = client[coll].find(ids(data)); self
+    end
+
+    # Limit
+    def limit(n)
+      g!; s[:cursor] = cursor.limit(n.to_i); self
+    end
+
+    # Sort
+    def sort(data)
+      g!; s[:cursor] = cursor.sort(data); self
+    end
+
+    # Get first
+    def first
+      g!; cursor.first.tap{|r| return ed(r) if r; c!}
+    end
+
+    # Get last
+    def last
+      g!; cursor.sort(:$natural => -1).first.tap{|r| return ed(r) if r; c!}
+    end
+
+    # Get all
+    def all
+      g!; cursor.to_a.map{|r| ed(r)}.tap{ c!}
+    end
+
+    # Count
+    def count
+      g!; cursor.count.tap{ c!}
+    end
+
+    # Remove
+    def rm(data)
+
+      # Normalize data
+      data = ids(data)
+
+      # Delete doc
+      result = client[coll].delete_one(data)
+
+      # Return result
+      Easymongo::Result.new(result, data).tap{ c!}
+    end
+
+    # Make sure dataever passed works
+    def ids(data)
+
+      # Just return if nothing to do
+      return data if data.empty?
+
+      # Support passing id as string
+      data = {'_id' => data} if data.is_a?(String)
+
+      # Turn all keys to string
+      data = data.stringify_keys
+
+      # Convert id to _id for mongo
+      data['_id'] = data.delete('id') if data['id']
+
+      # Convert ids to BSON ObjectId
+      data.each{|k, v| data[k] = oid(v) if v.is_a?(String) and v =~ /^[0-9a-fA-F]{24}$/}
+
+      # Return data
+      data
+    end
+
+    # Convert to BSON ObjectId or make a new one
+    def oid(v = nil)
+      return BSON::ObjectId.new if v.nil?; BSON::ObjectId.from_string(v) rescue v
+    end
+
+    private
+
+    # Get the request store
+    def s; RequestStore.store; end
+
+    # Clear request store
+    def c!; RequestStore.clear!; end
+
+    # Run get if no cursor
+    def g!; get unless cursor; end
+
+    # Get the collection
+    def coll; s[:coll]; end
+
+    # Get the cursor
+    def cursor; s[:cursor]; end
+
+    # Short cut for creating documents
+    def ed(r); Easymongo::Document.new(r); end
+
+  end
+end

data/lib/easymongo/result.rb

@@ -0,0 +1,36 @@
+module Easymongo
+  class Result
+
+    attr_accessor :result, :data, :values, :options
+
+    # Init takes a Mongo::Operation::Result
+    def initialize(result, data, values = nil, options = nil)
+      self.result = result
+      self.data = data
+      self.values = values
+      self.options = options
+    end
+
+    # Get the id as BSON::ObjectId
+    def bson_id
+      result.upserted_id || data['_id']
+    end
+
+    # Get the id if available
+    def id
+      bson_id ? bson_id.to_s : nil
+    end
+
+    # Creation date
+    def date
+      bson_id ? bson_id.generation_time : nil
+    end
+
+    # For the mongo operation result
+    def method_missing(name, *args, &block)
+      return result.send(name, *args) if result.respond_to?(name)
+      super
+    end
+
+  end
+end

data/lib/easymongo.rb

@@ -0,0 +1,26 @@
+require 'mongo'
+
+module Easymongo
+
+  # # # # # #
+  # Easymongo MongoDB tiny Ruby library.
+  # @homepage: https://github.com/fugroup/easymongo
+  # @author:   Vidar <vidar@fugroup.net>, Fugroup Ltd.
+  # @license:  MIT, contributions are welcome.
+  # # # # # #
+
+  class << self; attr_accessor :db; end
+end
+
+require_relative 'easymongo/document'
+require_relative 'easymongo/result'
+require_relative 'easymongo/query'
+
+# Indexing
+# $db.client[:profiles].indexes.create_one({:key => 1}, :unique => true)
+
+# Info on MongoDB Driver
+# https://docs.mongodb.com/ruby-driver/master/quick-start/
+# http://zetcode.com/db/mongodbruby/
+# http://recipes.sinatrarb.com/p/databases/mongo
+# https://github.com/steveren/ruby-driver-sample-app/blob/master/lib/neighborhood.rb

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: easymongo
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Fugroup Limited
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: request_store
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: futest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: The way MongoDB for Ruby should be, can't get easier than this
+email: vidar@fugroup.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- config/boot.rb
+- easymongo.gemspec
+- lib/easymongo.rb
+- lib/easymongo/document.rb
+- lib/easymongo/query.rb
+- lib/easymongo/result.rb
+homepage: https://github.com/fugroup/easymongo
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: Super Easy MongoDB client
+test_files: []