tinkit 0.0.0

data/LICENSE

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

data/README

@@ -0,0 +1,11 @@
+Bufs
+
+The current core classes give the ability to synchronize a file system to the backend repository (a couch database) in such a way that tagging (called categories) is allowed.  These categories aren't your run of the mill tags, they can also be used to categorize categories as well as content (i.e., you can tag the tags).  This allows you to organize data organically.
+
+Future developments will be to provide a web interface, and also a file system "view" where the directory structure mirrors the category organization.
+
+Topics to cover in more detail
+Node Synchonization
+  - Can synchronize but must be unique Class-Namespace combination
+Abstract Node Format 
+  - namespace

data/Rakefile

@@ -0,0 +1,75 @@
+#The specs in this rake file deal only with the core
+#bufs libraries
+
+require 'rake'
+require 'spec/rake/spectask'
+
+
+#Allows clearing of the task environment
+class Rake::Task
+  def abandon
+    @actions.clear
+  end
+end
+#task :default => ['specs_with_rcov']
+
+#Tests that fail in rake but work standalone
+spec_set_0 = ['spec/tk_escape_spec.rb']
+
+#fixture tests
+spec_set_1 = ['spec/couchdb_running_spec.rb', 
+              'spec/bufs_sample_dataset_spec.rb']
+
+#data structure tests (currently not working)
+spec_set_2 = ['spec/node_element_operations_spec.rb']
+
+#model tests for multi-user
+spec_set_3 = ['spec/tinkit_node_factory_spec.rb']
+
+#These tests would share common variable namespaces
+#and will clobber each other if ran in a common environment
+spec_set_3aa = ['spec/couchrest_attachment_handler_spec.rb']
+              #'spec/bufs_base_node_spec.rb',
+spec_set_3a =  [ 'spec/bufs_couchrest_spec.rb']
+
+spec_set_3b = ['spec/bufs_filesystem_spec.rb']
+
+#Set up rake specs by spec sets"
+spec_sets = { "spec_set_0" => spec_set_0, 
+              "spec_set_1" => spec_set_1,
+              "spec_set_2" => spec_set_2,
+              "spec_set_3" => spec_set_3,
+              "spec_set_3a"=> spec_set_3a,
+              "spec_set_3aa"=>spec_set_3aa,
+              "spec_set_3b"=> spec_set_3b
+            }
+              
+
+#creates spec task spec_set_##
+spec_sets.each do |name, set|
+  desc "Run  #{name}"
+     Spec::Rake::SpecTask.new(name) do |t|
+        puts "Creating set: #{name}"
+        t.spec_files = spec_sets[name]
+        t.rcov = false
+     end
+end
+      
+
+desc "Runs all specs in their environments and continues if error is encountered" 
+task :spec_sets do
+  spec_sets.each do |name, set|
+    puts "Running Test on #{name}"
+    begin
+      Rake::Task[name].invoke
+    rescue => e
+      puts "Rake Task #{name} Failed" 
+      puts "Error message: #{e.inspect}"
+      #puts "Trace:\n #{e.backtrace}"
+      puts "Moving on to next set"
+      next
+    end
+    puts "Clearing Task"
+    Rake::Task[name].abandon
+  end
+end

data/lib/glue_envs/couchrest/couchrest_attachment_handler.rb

@@ -0,0 +1,260 @@
+require 'cgi'
+require 'couchrest'
+
+#Tinkit directory organization defined in lib/helpers/require_helper.rb
+require Tinkit.helpers 'tk_escape'
+require Tinkit.helpers 'mime_types_new'
+
+#Performs manipulations ont file attachment structures and metadata
+module CouchrestAttachmentHelpers
+
+  #Attachment data format: attachment_name => attachment info
+  #attachment info format: { 'data' => attachment data, 'md' => attachment metadata }
+  #attachment data is sorted into the data and metadata CouchDB attachments can handle natively
+  #and the additional metadata that CouchDB attachments do not handle (boo, hiss)
+  # 
+  # Usage Example:
+  #   CouchrestAttachmentHelpers.sort_attachment_data(attachments)
+  #   #=> { 'data_by_name' => { attachment_1 => raw_attachment_data1,
+  #                           attachment_2 => raw_attachment_data2 }.
+  #       'att_md_by_name' => { attachment_1 => CouchDB metadata fields1,
+  #                             attachment_2 => CouchDB metadata fields2}
+  #       'cust_md_by_name' => { attachment_1 => Custom metadata fields1,
+  #                             attachment_2 => Custom metadata fields2}
+  #      }
+  def self.sort_attachment_data(attachments)
+    all_couch_attach_params = {}
+    all_custom_attach_params = {}
+    all_attach_data = {}
+    attachments.each do |att_name, att_info|
+      #att_info: 'data' => att data, 'md' => att metadata
+      esc_att_name = TkEscape.escape(att_name)
+      att_params = {}
+      obj_params = {}
+      attach_data = nil
+      att_info.each do |info, info_value|
+        if info == 'data'
+          attach_data = info_value
+        elsif info == 'md'
+          #md holds all file metadata (both couch and custom)
+          split_metadata = self.split_attachment_metadata(info_value)
+          att_params = split_metadata['att_md']
+          obj_params = split_metadata['cust_md']
+        end
+      end
+      all_couch_attach_params[esc_att_name] = att_params
+      all_custom_attach_params[esc_att_name] = obj_params
+      all_attach_data[esc_att_name] = attach_data
+    end
+    sorted =  {'data_by_name' => all_attach_data,
+      'att_md_by_name' => all_couch_attach_params,
+      'cust_md_by_name' => all_custom_attach_params}
+    return sorted
+  end
+
+  #Escapes attachment names in a CouchDB compatible way
+  def self.escape_names_in_attachments(unesc_attachments)
+    escaped_attachments = {}
+    unesc_attachments.each do |unesc_key, val|
+      esc_key = TkEscape.escape(unesc_key)
+      escaped_attachments[esc_key] = val
+    end
+    return escaped_attachments
+  end
+
+  #Unescapes attachment names in a CouchDb compatible way
+  def self.unescape_names_in_attachments(esc_attachments)
+    unescaped_attachments = {}
+    #esc_attachments = esc_attachments || []
+    esc_attachments.each do |esc_key, val|
+      unesc_key = CGI.unescape(esc_key)
+      unescaped_attachments[unesc_key] = val
+    end
+    return unescaped_attachments
+  end
+
+  private
+
+  #Takes the abstracted attachment data and splits it into
+  #the data used by this class and the underlying CouchDB format
+  def self.split_attachment_metadata(combined_metadata)
+    split_metadata = {'cust_md' => {}, 'att_md' => {}}
+    combined_metadata.each do |param, param_value|
+      if CouchrestAttachment::CouchDBAttachParams.include? param
+        split_metadata['att_md'][param] = param_value
+      else
+        split_metadata['cust_md'][param] = param_value
+      end
+    end
+    return split_metadata
+  end
+
+end
+
+
+  #Converts from Tinkit attachment format to closer to the metal
+  #couchrest/CouchDB attachment format.  The reason this is needed is because
+  #CouchDB cannot support custom metadata for attachments.  So custom metadata is held
+  #in the CouchrestAttachment document.  This document will also hold the
+  #attachments and its built in metadata (such as content-type and modified times
+  # Attachment structure:
+  # attachments =>{ attachment_1 => { 'data1' => raw attachment data1,
+  #                                   'md1' => combined attachment metadata1 },
+  #                 attachment_2 => { 'data2' => raw attachment data2,
+  #                                   'md2' => combined attachment metadata2 }
+  # }
+  #
+
+class CouchrestAttachment < CouchRest::ExtendedDocument
+  
+  #CouchDB attachment metadata parameters supported by CouchrestAttachment
+  CouchDBAttachParams = ['content_type', 'stub']
+  
+  #changing this will result in existing persisted data being lost
+  #(unless the persisted data is updated as well)
+  AttachmentID = "_attachments"
+
+  #create the attachment document id to be used
+  def self.uniq_att_doc_id(doc_id)
+    uniq_id = doc_id + AttachmentID if doc_id#bufs_node.class.attachment_base_id 
+  end
+  
+  def self.add_attachment_package(doc_id, attach_class, attachments)
+    raise "No class definition provided for attachments" unless attach_class
+    raise "No id found for the document" unless doc_id #bufs_node._model_metadata[:_id]
+    raise "No attachments provided for attaching" unless attachments
+    att_doc_id = self.uniq_att_doc_id(doc_id)
+    att_doc = self.get(att_doc_id)
+    rtn = if att_doc
+      self.update_attachment_package(att_doc, attachments)
+    else
+      self.create_attachment_package(att_doc_id, attach_class, attachments)
+    end
+    return rtn
+  end
+
+   #Create an attachment for a particular BUFS document
+  def self.create_attachment_package(att_doc_id, attach_class, attachments)
+    raise "No class definition provided for attachments" unless attach_class
+    raise "No id found for the document" unless att_doc_id 
+    raise "No attachments provided for attaching" unless attachments
+    
+    sorted_attachments = CouchrestAttachmentHelpers.sort_attachment_data(attachments)
+    custom_metadata_doc_params = {'_id' => att_doc_id, 'md_attachments' => sorted_attachments['cust_md_by_name']}
+    att_doc = attach_class.new(custom_metadata_doc_params)
+    att_doc.save
+    
+    sorted_attachments['att_md_by_name'].each do |att_name, params|
+      esc_att_name = TkEscape.escape(att_name)
+      att_doc.put_attachment(esc_att_name, sorted_attachments['data_by_name'][esc_att_name],params)
+    end
+    
+    #returns the updated document from the database
+    return self.get(att_doc_id)
+  end
+
+  #not used? (2010-11-04)
+  #def update_attachment_package(att_doc_id, attach_class, new_attachments)
+  #  #bufs_doc.my_GlueEnv.attachClass.update_attachment_package(self, new_attachments)
+  #  self.update_attachment_package(att_doc_id, attach_class, new_attachments)
+  #end
+
+  #Update the attachment data for a particular BUFS document
+  #  Important Note: Currently existing data is only updated if new data has been modified more recently than the existing data.
+  def self.update_attachment_package(att_doc, new_attachments)
+    existing_attachments = att_doc.get_attachments
+    most_recent_attachment = {}
+    if existing_attachments
+      new_attachments.each do |new_att_name, new_data|
+      esc_new_att_name = TkEscape.escape(new_att_name)
+        working_doc = att_doc.class.get(att_doc['_id'])
+        if existing_attachments.keys.include? esc_new_att_name
+          #filename already exists as an attachment
+          fresh_attachment =self.find_most_recent_attachment(existing_attachments[esc_new_att_name], new_attachments[new_att_name]['md'])
+          most_recent_attachment[esc_new_att_name] = fresh_attachment
+          
+          #re-add the if statement to prevent old from overwriting newer files
+          ###if most_recent_attachment[esc_new_att_name] != existing_attachments[esc_new_att_name]
+            #update that file and metadata
+            sorted_attachments = CouchrestAttachmentHelpers.sort_attachment_data(esc_new_att_name => new_data)
+            #update doc
+            working_doc['md_attachments'] = working_doc['md_attachments'].merge(sorted_attachments['cust_md_by_name'])
+            #update attachments
+            working_doc.save
+            #Add Couch attachment data
+            att_data = sorted_attachments['data_by_name'][esc_new_att_name]
+            att_md =  sorted_attachments['att_md_by_name'][esc_new_att_name]
+            working_doc.put_attachment(esc_new_att_name, att_data,att_md)
+          ###else
+            #do anything here?
+            #puts "Warning, didn't update the attachment because current attachment is older than present one"
+          ###end
+        else #filename does not exist in attachment
+          #puts "Attachment Name not found in Attachment Document, adding #{esc_new_att_name}"
+          sorted_attachments = CouchrestAttachmentHelpers.sort_attachment_data(esc_new_att_name => new_data)
+          #update doc
+          working_doc['md_attachments'] = working_doc['md_attachments'].merge(sorted_attachments['cust_md_by_name'])
+          #update attachments
+          working_doc.save
+          #Add Couch attachment data
+          att_data = sorted_attachments['data_by_name'][esc_new_att_name]
+          att_md =  sorted_attachments['att_md_by_name'][esc_new_att_name]
+          working_doc.put_attachment(esc_new_att_name, att_data,att_md)
+          #working_doc does not have attachment
+          
+        end
+        
+      end
+    end
+    return att_doc.class.get(att_doc['_id'])
+  end
+
+  #retrieves document attachments for a particular document 
+  def self.get_attachments(att_doc)
+    return nil unless att_doc
+    custom_md = att_doc['md_attachments']
+    esc_couch_md = att_doc['_attachments']
+    couch_md = CouchrestAttachmentHelpers.unescape_names_in_attachments(esc_couch_md)
+    if custom_md.keys.sort != couch_md.keys.sort
+      raise "data integrity error, attachment metadata inconsistency\n"\
+             "in memory: #{custom_md.inspect} \n persisted: #{couch_md.inspect}"
+    end
+    (attachment_data = custom_md.dup).merge(couch_md) {|k,v_custom, v_couch| v_custom.merge(v_couch)}
+  end
+
+  #retrieves document attachments for this document
+  def get_attachments
+    self.class.get_attachments(self) 
+  end
+
+  def remove_attachment(attachment_names)
+    attachment_names = [attachment_names].flatten
+    attachment_names.each do |att_name|
+      att_name = TkEscape.escape(att_name)
+      self['md_attachments'].delete(att_name)
+      self['_attachments'].delete(att_name)
+    end
+    resp = self.save
+    atts = self.class.get_attachments(self)
+    raise "Remove Attachment Operation Failed with response: #{resp.inspect}" unless resp == true
+    self
+  end
+
+  private
+
+  def self.find_most_recent_attachment(attachment_data1, attachment_data2)
+    #"Finding most recent attachment"
+    most_recent_attachment_data = nil
+    if attachment_data1 && attachment_data2
+      if attachment_data1['file_modified'] >= attachment_data2['file_modified']
+        most_recent_attachment_data = attachment_data1
+      else
+        most_recent_attachment_data = attachment_data2
+      end
+    else
+      most_recent_attachment_data = attachment_data1 || attachment_data2
+    end
+    most_recent_attachment_data
+  end#def
+
+end#class