notesgrip 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b676a1689361bfcebe0f0338b221ac5cbb4e73f6
+  data.tar.gz: 9427cc161f8ca57ed443cfa121255fdd42121814
+SHA512:
+  metadata.gz: 3546f023c13c764a1be6af9dc906671b1e26edce7e4066bd4b293e3cc80cc1d4e2b6c1cb7b7aea7d927d7ed742f64b9345e342f0c3a8d29acc746d6b8efabe1e
+  data.tar.gz: 52e46c40e4702d5841fa0cded02eb4416dfa39f8e42ad642351ca3daf37d8f1d510ffbca30e712deec77d5692e5512f2036d2a3510a31349d73f759d63675f48

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in notesgrip.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 yac4423
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 yac4423
+
+MIT License
+
+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.rdoc

@@ -0,0 +1,135 @@
+= NotesGrip
+Notesgrip is Ruby library to handle all Notes classes.
+* Windows Only
+* Necessary Notes Clinet(all version OK. R4.6-R9)
+
+= Installation
+  # gem install notesgrip
+
+= Usage
+  require 'notesgrip'
+  ns = Notesgrip::NotesSession.new
+  db = ns.database("myserver", "mydb.nsf")
+  db.each_document {|doc|
+    p doc
+  }
+
+= Documentation
+== Notesgrip::Notes_Wrapper
+Base class of all Notesgrip classes. 
+This class wraps a various Notes objects.
+=== Methods
+[raw]
+  Return raw Notes object which is wrapped by Notesgrip object.
+
+== Notesgrip::NotesSession class
+Wrap NotesSession object to use all properties and methods of NotesSession class.
+  ns = NotesGrip::NotesSession.new
+  p ns.NotesVersion # -> "Release 9.0|March 08, 2013             "
+  db = ns.getDatabase("servername", "dbname.nsf")
+
+=== Additional Methods
+[database(server, dbfilename, createonfail=false)]
+  Alias of GetDatabse().
+[each_database(server) {|database| block}]
+  Calls the given block for each database on server.
+    ns = NotesGrip::NotesSession.new
+    ns.each_database("myserver") {|db|
+      p db
+    }
+
+== Notesgrip:NotesDatabase class
+Wrap NotesDatabase object.
+  ns = NotesGrip::NotesSession.new
+  db = ns.getDatabase("servername", "dbname.nsf")
+  puts "Title:#{db.Title}, Size:#{db.Size}" # Title:tech's Directory, Size:23330816.0
+  
+=== Additional Methods
+[CreateDocument(formName=nil)]
+  Create new NotesDocument and set form name. Return Notesgrip::NotesDocument.
+[name()]
+  Alias of Title().
+[open?()]
+  Alias of IsOpen().
+[each_document {|doc| block}]
+  Calls the given block for each document in database.
+    db.each_document {|doc|
+      p doc
+    }
+
+== Notesgrip:NotesView class
+Wrap NotesView object.
+  ns = NotesGrip::NotesSession.new
+  db = ns.getDatabase("servername", "dbname.nsf")
+  view = db.view("All")
+  p view.Count
+=== Additional Methods
+[each_document {|doc| block}]
+  Calls the given block for each document in the view.
+    view = db.view("All")
+    view.each_document {|doc|
+      p doc
+    }
+[[index]]
+  Return the document at index.
+
+=== Notesgrip:NotesDocumentCollection class
+Wrap NotesDocumentCollection object.
+  ns = NotesGrip::NotesSession.new
+  db = ns.getDatabase("servername", "dbname.nsf")
+  view = db.view("ByDate")
+  docList = view.GetAllDocumentsByKey("2014/04/20", true)
+  p docList.size # count of documents in NotesDocumentCollection
+=== Additional Methods
+[each_document {|doc| block}]
+  Calls the given block for each document in the view.
+    docList = view.GetAllDocumentsByKey("2014/04/20", true)
+    docList.each_document {|doc|
+      p doc
+    }
+[[index]]
+  Return the document at index.
+
+== Notesgrip:NotesDocument class
+Wrap NotesDocument object.
+  ns = NotesGrip::NotesSession.new
+  db = ns.getDatabase("servername", "dbname.nsf")
+  doc = db.CreateDocument("main")
+  doc['subject'].text = "Sample-001"
+  doc.save
+=== Additional Methods
+[unid]
+  Alias of UniversalID().
+[[itemname]]
+  Return Notesgrip::NotesItem object which is identified by itemname in the document.
+[[itemname]=other_item]
+  Copy other NotesItem with given item name.
+[each_item{|item| block}]
+  Calls the given block for each NotesItem in my document.
+
+== Notesgrip:NotesItem class
+Wrap NotesItem object.
+  ns = NotesGrip::NotesSession.new
+  db = ns.getDatabase("servername", "dbname.nsf")
+  db.each_document {|doc|
+    item = doc["subject"]
+    p item.text
+  }
+===Additional Methods
+[Values=item_value, text=item_value]
+  Copy item_value into my field. You can set Array into the field.
+[each_value {|value| block}]
+  Calls the given block for each item value in the field.
+[richitem_attached?]
+  Return true if Embeded oject in the field.
+[to_s]
+  Return text string in the field.
+
+  
+= Author
+notesgrip@tech-notes.dyndns.org
+
+
+
+= License
+MIT

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/Sample/sample_NotesDatabase.rb

@@ -0,0 +1,77 @@
+require 'notesgrip'
+
+ns = Notesgrip::NotesSession.new
+db = ns.database("technotes", "names.nsf")
+p db # <Notesgrip::NotesDatabase, Name:"tech's Directory", FilePath:"names.nsf">
+
+# Scan all documents in database
+db.each_document {|doc|
+  p doc
+}
+
+# Scan all views in database
+db.each_view {|view|
+  p view
+}
+
+# Get View
+view = db.view("People")
+p view
+
+# Scan all form in database
+db.each_form {|form|
+  p form
+}
+
+# Database Search
+docList = db.FTSearch("[LastName] CONTAINS tech-notes")
+p docList
+docList.each {|doc|
+  puts "-----"
+  p doc
+  doc.each_item {|item|
+    p item
+  }
+}
+
+# Read/Unread Document Collection
+readDocList = db.GetAllReadDocuments()
+unreadDocList = db.GetAllUnreadDocuments()
+puts "readDocList.size = #{readDocList.size}"
+puts "unreadDocList.size = #{unreadDocList.size}"
+
+# get document by ID/UNID
+doc = db.GetDocumentByID("12AE")
+p doc
+doc = db.GetDocumentByUNID("F8B3C89EA5A15408852572E500656D34")
+p doc
+
+# Get Form
+form = db.GetForm("person")
+p form
+
+# Get Option
+p db.GetOption(Notesgrip::NotesDatabase::DBOPT_SOFTDELETE)
+
+# ACL
+acl = db.ACL
+acl.each_entry {|entry|
+  p entry
+}
+
+# ACL Activity
+db.ACLActivityLog.each {|log|
+  p log
+}
+
+# Agents
+db.each_agent {|agent|
+  p agent
+}
+
+# Profile Collection
+db.each_profile {|doc|
+  p doc
+}
+
+

data/Sample/sample_NotesSession.rb

@@ -0,0 +1,17 @@
+require 'notesgrip'
+
+ns = Notesgrip::NotesSession.new
+p ns.UserName
+p ns.AddressBooks # Array of Local names.nsf and Server names.nsf
+p ns.CurrentDatabase
+
+# Get database
+db = ns.database("myServer", "names.nsf")
+
+# Create NotesName
+userName = ns.CreateName("CN=Administrator/O=tech")
+
+# ListUp Databases on server
+ns.each_database("technotes") {|db|
+  p db
+}

data/Sample/sample_NotesView.rb

@@ -0,0 +1,63 @@
+require 'notesgrip'
+
+ns = Notesgrip::NotesSession.new
+db = ns.database("technotes", "names.nsf")
+
+view = db.view("People")
+p view
+p view.Aliases
+
+# Column
+view.each_column {|column|
+  p column
+}
+
+# ViewEntry
+view.each_entry {|entry|
+  p entry
+}
+
+# ViewNavigator
+viewNav = view.CreateViewNav()
+p viewNav
+
+# FTSearch
+match_count = view.FTSearch("miwa_dankichi.tech-notes.dyndns.org")
+puts "match_count = #{match_count}"
+puts "After FTSearch, view.size = #{view.size}"
+view.each_document {|doc|
+  p doc
+}
+view.clear
+puts "After clear, view.size = #{view.size}"
+
+# GetAllDocumentsByKey
+docList = view.GetAllDocumentsByKey(["Administrator"], false)
+puts "docList.size = #{docList.size}"
+docList.each {|doc|
+  p doc
+}
+
+# GetAllEntriesByKey
+entryList = view.GetAllEntriesByKey(["Administrator"], false)
+puts "entryList.size = #{entryList.size}"
+entryList.each {|entry|
+  p entry
+}
+
+# GetAllReadEntries
+entryList = view.GetAllReadEntries()
+puts "GetAllReadEntries, entryList.size = #{entryList.size}"
+
+# GetDocumentByKey
+doc = view.GetDocumentByKey(["Administrator"])
+p doc
+
+# GetEntryByKey
+entry = view.GetEntryByKey(["Administrator"])
+p entry
+
+# GetNthDocument
+doc = view.GetNthDocument(2)
+p doc['FullName']
+

data/lib/notesgrip/DocCollection.rb

@@ -0,0 +1,53 @@
+module Notesgrip
+  module DocCollection
+    def each_document
+      raw_doc = @raw_object.GetFirstDocument
+      while raw_doc
+        next_doc = @raw_object.GetNextDocument(raw_doc)
+        yield NotesDocument.new(raw_doc)
+        raw_doc = next_doc
+      end
+    end
+    alias each each_document
+    
+    def [](index)
+      if index >= 0
+        raw_doc = @raw_object.GetNthDocument( index + 1)  # GetNthDocument(1) is the first doc
+      else
+        docs_number = self.Count()
+        raw_index = docs_number - index.abs
+        return nil if raw_index < 0
+        raw_doc = @raw_object.GetNthDocument( raw_index + 1)
+      end
+      raw_doc ? NotesDocument.new(raw_doc) : nil
+    end
+    
+    def GetFirstDocument
+      self[0]
+    end
+    def GetLastDocument
+      raw_doc = @raw_object.GetLastDocument
+      raw_doc ? NotesDocument.new(raw_doc) : nil
+    end
+    
+    def GetNthDocument(index)
+      if index >= 1
+        self[index-1]
+      else
+        nil
+      end
+    end
+    
+    def GetNextDocument(document)
+      raw_doc = toRaw(document)
+      raw_nextDoc = @raw_object.GetNextDocument(raw_doc)
+      raw_nextDoc ? NotesDocument.new(raw_nextDoc) : nil
+    end
+    
+    def GetPrevDocument( document )
+      raw_doc = toRaw(document)
+      raw_prevDoc = @raw_object.GetPrevDocument(raw_doc)
+      raw_prevDoc ? NotesDocument.new(raw_prevDoc) : nil
+    end
+  end
+end

data/lib/notesgrip/GripWrapper.rb

@@ -0,0 +1,43 @@
+module Notesgrip
+  class GripWrapper
+    def initialize(raw_object)
+      if raw_object.methods.include?("raw")
+        @raw_object = raw_object.raw
+      else
+        @raw_object = raw_object
+      end
+    end
+    
+    def raw
+      @raw_object
+    end
+    
+    def inspect()
+      "<#{self.class}>"
+    end
+    
+    private
+    
+    OLE_METHODS = [:Type, :Initialize]
+    def method_missing(m_id, *params)
+      unless OLE_METHODS.include?(m_id)
+        missing_method_name = m_id.to_s.downcase
+        methods.each {|method|
+          if method.to_s.downcase == missing_method_name
+            return send(method, *params)
+          end
+        }
+      end
+      # Undefined Method is throwed to raw_object
+      begin
+        @raw_object.send(m_id, *params)
+      rescue
+        raise $!,$!.message, caller
+      end
+    end
+    
+    def toRaw(target_obj)
+      target_obj.respond_to?("raw") ? target_obj.raw : target_obj
+    end
+  end
+end