sinatra-monk 0.0.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: adb6107dab9b741150f7b27cdd1d117747384816
+  data.tar.gz: 827bd3d7689803a6df5e1a0509ddc161b387712d
+SHA512:
+  metadata.gz: 0fb87d0466fcffb17d5048e9c65bed64e0e8129cce80573a3e8c229d53328b7b2c25b3ebbd244eb3503b4ab9e729a6e520374f705e03ce388ca417f82559a2dc
+  data.tar.gz: 9e8584f65f88d31da5ad0794954c57222a5baa91f3d7e6002d1712d7d218cd98e9f475e3a78c4947cabbeee8000f862ca5bbadaa59b48c651cb746473977f025

data/lib/sinatra-monk.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+##
+# Copyright (c) 2013 Christian Ferraz Lemos de Sousa
+#
+# 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.
+####
+# Sinatra's Monk was done with Ruby 1.9 ('cause of a bug with bson_ext),
+# but we provide 2.0 automatic named args support.
+##
+
+require 'sinatra-monk/base'
+require 'sinatra-monk/2.0' if RUBY_VERSION.chr == '2'

data/lib/sinatra-monk/2.0.rb

@@ -0,0 +1,60 @@
+#!/usr/bin/env ruby
+##
+# Copyright (c) 2013 Christian Ferraz Lemos de Sousa
+#
+# 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.
+####
+
+# Bunch of function redefinition to make use
+# of Ruby 2.0 new standard. Also, require this
+# file to enforce the use of Ruby 2.0.
+
+# ensure that we have monk
+require 'sinatra-monk/base'
+
+module Sinatra
+  module Monk
+    class MBase
+      # monk base class args are fully optional
+      alias _ol_initialize initialize
+      def initialize(user:'', pass:'', database:'local', host:'localhost',
+                     port:27017, opts:{:connect => false})
+        _ol_initialize(user, pass, database, host, port, opts)
+      end
+    end
+
+    class HBase
+      # monk base class args are fully optional
+      alias _ol_initialize initialize
+      def initialize(name:'monk', user:'', pass:'', database:'local', host:'localhost',
+                     port:27017, opts:{:connect => false})
+        _ol_initialize(name, user, pass, database, host, port, opts)
+      end
+    end
+
+    def monk(user:'', pass:'', database:'local', host:'localhost',
+             port:27017, opts:{:connect => false})
+      return MBase.new(user, pass, database, host, port, opts)
+    end
+
+    def hmonk(name:'monk', user:'', pass:'', database:'local', host:'localhost',
+              port:27017, opts:{:connect => false})
+      return MHash.new(name, user, pass, database, host, port, opts)
+    end
+  end
+end

data/lib/sinatra-monk/base.rb

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+##
+# Copyright (c) 2013 Christian Ferraz Lemos de Sousa
+#
+# 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.
+####
+# a standard way to require monk cross compatible
+# monk (between 2x and 19x series)
+##
+require 'sinatra-monk/monk'
+require 'sinatra-monk/helpers'

data/lib/sinatra-monk/helpers.rb

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+##
+# Copyright (c) 2013 Christian Ferraz Lemos de Sousa
+#
+# 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.
+####
+# Some helpers to make life easier on Sinatra.
+##
+
+# helpers need sinatra
+require 'sinatra-monk/base'
+require 'sinatra/base'
+
+module Sinatra
+  module Monk
+    def monk user = '', pass = '', database = 'local', host = 'localhost',
+             port = 27017, opts = {:connect => false}
+      return MBase.new(user, pass, database, host, port, opts)
+    end
+
+    def hmonk name = 'monk', user = '', pass = '', database = 'local',
+              host = 'localhost', port = 27017, opts = {:save => true}
+      return MHash.new(name, user, pass, database, host, port, opts)
+    end
+  end
+  helpers Monk
+end

data/lib/sinatra-monk/monk.rb

@@ -0,0 +1,176 @@
+#!/usr/bin/env ruby
+##
+# Copyright (c) 2013 Christian Ferraz Lemos de Sousa
+#
+# 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.
+####
+# Base Monk classes
+##
+
+# monk needs mongo (duh)
+require 'mongo'
+
+module Sinatra
+  module Monk
+    # Base provides a base class for mongo database management it is the simplest way
+    # to connect to it. It is intented to keep sinatra's philosofy of keeping it simple
+    class MBase
+      attr_reader :client, :database, :username, :password
+
+      # monk base class args are fully optional
+      def initialize user = '', pass = '', database = 'local', host = 'localhost',
+                     port = 27017, opts = {:connect => false}
+        # these data can't just be changed runtime
+        @client        = Mongo::MongoClient.new 'localhost', 27017
+        @database      = @client[database]
+        @database_name = database
+
+        # non persistent data (can be changed before connect)
+        @username      = user
+        @password      = pass
+
+        # connect if asked
+        connect if opts[:connect]
+      end
+
+      def close
+        @client.close
+      end
+
+      def connected?
+        return @client.connected?
+      end
+
+      def connect user = @username, pass = @password
+        return true if connected?
+        @client.connect
+        @username  = user
+        @password  = pass
+        return @database.authenticate @username, @password
+      end
+    end
+
+    # Monk::Hash is a Monk that acts like a Hash, it
+    # was made to look very native.
+    class MHash < MBase
+      attr_reader :local, :name, :collection
+      attr_accessor :sync
+
+      class InexistentKey < StandardError
+      end
+
+      # force to connect
+      def initialize name = 'monk', user = '', pass = '', database = 'local',
+        host = 'localhost', port = 27017, opts = {:save => true}
+        # forced premature connection (option override)
+        opts[:connect]= true
+
+        # HashMonk special data
+        @name        = name         # collection name
+        @sync        = opts[:save]  # autosave collection
+        @local       = Hash.new     # local information
+
+        # need update flag (writes local data to db)
+        @need_sync   = false
+
+        # build our monk
+        super host, port, user, pass, opts
+
+        install if connect
+      end
+
+      # install the collection in the database
+      # (may not install if already exists)
+      private
+      def install
+        if @database.collection_names.include? @name
+          # setup for use existent collection
+          @collection = @database[@name].find_one({'name'=>@name})
+        else
+          # install collection
+          @database.create_collection @name
+          @database[@name].insert([{'name' => @name,
+                                           'content' => {}}])
+          @collection = @database[@name].find_one({'name'=>@name})
+          need_sync!
+        end
+      end
+
+      def connect user = @username, pass = @password
+        return true if connected?
+        @client.connect
+        @username  = user
+        @password  = pass
+        return @database.authenticate @username, @password
+      end
+
+      # setup for sync
+      def need_sync!
+        @need_sync = true
+        sync if @sync # autosync
+      end
+
+      public
+      # save data, may be called automagically
+      # if autosave mode is on
+      def sync
+        if @need_sync
+          @database[@name].save(@collection)
+          @need_sync = false
+          return true
+        end
+        return false
+      end
+
+      # return true if db need to sync
+      def need_sync?
+        return @need_sync
+      end
+
+      def include?(key)
+        return @collection['content'].has_key? key
+      end
+
+      def inspect
+        return @collection['content'].inspect
+      end
+
+      def delete(key)
+        raise TypeError, "#{key} can't be coerced into String" unless key.is_a? String
+        if @collection['content'].has_key? key
+          @collection['content'].delete key
+          need_sync!
+          return true
+        end
+        return false
+      end
+
+      def [](key)
+        raise TypeError, "#{key} can't be coerced into String" unless key.is_a? String
+        return @collection['content'][key] if @collection['content'].has_key? key
+        raise InexistentKey, "Field #{key} not found."
+      end
+
+      def []=(key, value)
+        raise TypeError, "#{key} can't be coerced into String" unless key.is_a? String
+        @collection['content'][key] = value
+        need_sync!
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: sinatra-monk
+version: !ruby/object:Gem::Version
+  version: 0.0.8
+platform: ruby
+authors:
+- Christian Ferraz Lemos de Sousa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mongo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A (very) simple wrapper for Mongo driver.
+email: cferraz95@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/sinatra-monk.rb
+- lib/sinatra-monk/2.0.rb
+- lib/sinatra-monk/base.rb
+- lib/sinatra-monk/monk.rb
+- lib/sinatra-monk/helpers.rb
+homepage: http://rubygems.org/gems/sinatra-monk
+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.0.0
+signing_key: 
+specification_version: 4
+summary: Add some Mongo helpers to sinatra.
+test_files: []
+has_rdoc: