condo-couchbase 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b347cc0c0a2a2d934ddf7d33e4cf3b7d6ccb6b2a
+  data.tar.gz: 29f1b0b523bedbeb893c5cb145166b883f0d8a1a
+SHA512:
+  metadata.gz: 6687f5520477e5e1fac3ff0dca2c234bb9d096fc36a7b7f827be9307d765af56836fb08a0ae1dd21bb38253774c306d3d87b9af4961366e9e45217de6eebeb93
+  data.tar.gz: 84c3bb485fe31f640acf87ca9b5695fb0ef2f4b395440a7d49f8b37f5a3b14c59e01d800afae0767d22fb059be3fa50baeeca80e4c6183bbf498e929c00dca3e

data/LGPL3-LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.textile

@@ -0,0 +1,4 @@
+h1. Condo Couchbase Backend
+
+Include in your gem file: @gem 'condo-couchbase'@
+Assumes you are using "couchbase-model":https://github.com/couchbase/couchbase-ruby-model/

data/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'CondoActiveRecord'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/condo-couchbase.rb

@@ -0,0 +1,7 @@
+require 'condo'
+require 'couchbase-id'
+require 'condo-couchbase/engine'
+require 'condo/backend/couchbase'
+
+#::Condo::Application.backend = Condo::Backend::Couchbase
+silence_warnings { ::Condo.const_set(:Store, Condo::Backend::Couchbase) }

data/lib/condo-couchbase/engine.rb

@@ -0,0 +1,17 @@
+module CondoCouchbase
+    class Engine < ::Rails::Engine
+        engine_name :condo_couchbase
+
+        config.after_initialize do |app|
+            model_conf = Couchbase::Model::Configuration
+            temp = model_conf.design_documents_paths
+
+            path = File.expand_path(File.join(File.dirname(__FILE__), '../condo/backend'))
+            model_conf.design_documents_paths = [path]
+            
+            ::Condo::Backend::Couchbase.ensure_design_document!
+
+            model_conf.design_documents_paths = temp
+        end
+    end
+end

data/lib/condo-couchbase/version.rb

@@ -0,0 +1,3 @@
+module CondoCouchbase
+    VERSION = "2.0.0"
+end

data/lib/condo/backend/co_upld/by_user_id/map.js

@@ -0,0 +1,5 @@
+function(doc) {
+    if(doc.type === 'co_upld') {
+        emit(doc.user_id, null);
+    }
+}

data/lib/condo/backend/couchbase.rb

@@ -0,0 +1,133 @@
+require 'digest/sha2'
+
+module Condo
+    module Backend
+        
+        #
+        # The following data needs to be stored in any backend
+        # => provider_namespace (for handling multiple upload controllers, defaults to global)
+        # => provider_name        (amazon, rackspace, google, azure etc)
+        # => provider_location    (US West (Oregon) Region, Asia Pacific (Singapore) Region etc)
+        # => user_id            (the identifier for the current user as a string)
+        # => file_name            (the original upload file name)
+        # => file_size            (the file size as indicated by the client)
+        # => file_id            (some sort of identifying hash provided by the client)
+        # => bucket_name        (the name of the users bucket)
+        # => object_key            (the path to the object in the bucket)
+        # => object_options        (custom options that were applied to this object - public/private etc)
+        # => resumable_id        (the id of the chunked upload)
+        # => resumable            (true if a resumable upload - must be set)
+        # => date_created        (the date the upload was started)
+        #
+        # => Each backend should have an ID that uniquely identifies an entry - id or upload_id
+        #
+        #
+        #
+        # Backends should inherit this class, set themselves as the backend and define the following:
+        #
+        # Class Methods:
+        # => check_exists        ({user_id, upload_id})                            returns nil or an entry where all fields match
+        #         check_exists    ({user_id, file_name, file_size, file_id})        so same logic for this
+        # => add_entry ({user_id, file_name, file_size, file_id, provider_name, provider_location, bucket_name, object_key})
+        #
+        #            
+        #
+        # Instance Methods:
+        # => update_entry ({upload_id, resumable_id})
+        # => remove_entry (upload_id)
+        #
+        class Couchbase < ::Couchbase::Model
+            design_document :co_upld
+            before_create :generate_id
+
+
+            attribute :created_at,      default: lambda { Time.now.to_i }
+            attribute :user_id, :file_name, :file_size, :file_id, 
+                :provider_namespace, :provider_name, :provider_location, :bucket_name,
+                :object_key, :object_options, :resumable_id, :resumable, :file_path,
+                :part_list, :part_data
+
+
+            # Checks for an exact match in the database given a set of parameters
+            def self.check_exists(params)
+                params[:upload_id] ||= "upld-#{params[:user_id]}-#{Digest::SHA256.hexdigest("#{params[:file_id]}-#{params[:file_name]}-#{params[:file_size]}")}"
+                self.find_by_id(params[:upload_id])
+            end
+
+            # Adds a new upload entry into the database
+            def self.add_entry(params)
+                model = self.new(params)
+                model.object_options = params[:object_options]
+                model.create!
+                model
+            end
+
+            # Return a list of Uploads that were last updated before a particular time
+            view :by_user_id
+            def self.find_by_user_id(user_id)
+                self.by_user_id key: user_id, stale: false
+            end
+
+            def self.older_than(time)
+                old_upload = time.to_i
+                uploads = []
+                self.all_uploads.each do |upload|
+                    uploads << upload if upload.created_at < old_upload
+                end
+                uploads
+            end
+
+            def self.all_uploads
+                self.by_user_id(stale: false)
+            end
+
+
+            # Updates self with the passed in parameters
+            def update_entry(params)
+                self.update_attributes(params)
+                result = self.save
+                raise ActiveResource::ResourceInvalid if result == false
+                self
+            end
+
+            # Deletes references to the upload
+            def remove_entry
+                self.delete
+            end
+
+            # Attribute accessors to comply with the backend spec
+            def upload_id
+                self.id
+            end
+            
+            def date_created
+                @date_created ||= Time.at(self.created_at)
+            end
+
+            # Provide a clean up function that uses the condo strata to delete itself
+            # NOTE:: this won't work with completely dynamic providers so is really just here
+            #  as a helper if you have pre-defined storage providers
+            def cleanup
+                options = {}
+                options[:namespace] = self.provider_namespace if self.provider_namespace
+                options[:location] = self.provider_location if self.provider_location
+                residence = ::Condo::Configuration.get_residence(self.provider_name, options)
+
+                if residence
+                    residence.destroy(self)
+                    self.remove_entry
+                else
+                    raise NotImplementedError, 'unable to find static residence'
+                end
+            end
+
+
+            protected
+
+
+            def generate_id
+                self.id = "upld-#{self.user_id}-#{Digest::SHA256.hexdigest("#{self.file_id}-#{self.file_name}-#{self.file_size}")}"
+            end
+        end
+    end
+end

data/lib/tasks/condo_couchbase_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :condo_active_record do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: condo-couchbase
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Stephen von Takach
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: condo
+  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: couchbase-id
+  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: Provides database storage utilising Couchbase.
+email:
+- steve@cotag.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LGPL3-LICENSE
+- README.textile
+- Rakefile
+- lib/condo-couchbase.rb
+- lib/condo-couchbase/engine.rb
+- lib/condo-couchbase/version.rb
+- lib/condo/backend/co_upld/by_user_id/map.js
+- lib/condo/backend/couchbase.rb
+- lib/tasks/condo_couchbase_tasks.rake
+homepage: http://cotag.me/
+licenses: []
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Couchbase backend for the Condo project.
+test_files: []
+has_rdoc: