iegrip 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb4eb46a0774e719a6a2b3e0588cc92c1039ca43
-  data.tar.gz: 13a01ce09f4cc574732c4b2c857dbf1ee3f3f432
+  metadata.gz: bad1519ed0c9644a166661626f2d418ece5578ff
+  data.tar.gz: 4aa306785e14ae58fc458bac757e0b5badb865de
 SHA512:
-  metadata.gz: e293f99a1b2a773cb24a5ebf47d8fe7f11e224d4101ccc18b12bae282e0fe659ea811f92d72bf0b31c26f1630e3e3fc3b1650c855189f1d36772c6be9289fbb3
-  data.tar.gz: 9202f17bb72b3d69607928d55b4b0c1f8c414a8e54883cba8332ec9ff7d6573374f72250cc14a97067f40f1140c81574e0ecdc3c5e34c49544022a411dad1cff
+  metadata.gz: 2b4922586a8b386a573521ffaeb374b7dd87ddc07308071e30ed4ea1d4f4b6dd66ca3abf560acc2f7a7fe7a7611d6af91addad8a060bd19b96017113a1c1e418
+  data.tar.gz: 57c9bacf0af9175952fd4d11de9c92d1962897426795ffd84c32647433f5dbb5a561ae5100ba76d48440cf22d6c5fc471f99768ff6281e12f867c403cd5b767c

data/README.rdoc

@@ -0,0 +1,199 @@
+= 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
+In RubyDoc.Info, all Notesgrip classes are Listed.
+http://rubydoc.info/gems/notesgrip/
+
+== 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
+    }
+[each_view {|view| block}]
+  Calls the given block for each view in database.
+    db.each_view {|view|
+      p view
+    }
+[each_form {|form| block}]
+  Calls the given block for each form in database.
+    db.each_form {|form|
+      p form
+    }
+[each_agent {|agent| agent}]
+  Calls the given block for each agent in database.
+    db.each_agent {|agent|
+      p agent
+    }
+[each_profile {|profile| block}]
+  Calls the given block for each profile in database.
+    db.each_profile {|profile|
+      p profile
+    }
+  
+== 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.
+[each_entry {|entry| block}]
+  Calls the given block for each entry in the view.
+    view = db.view("All")
+    view.each_entry {|entry|
+      p entry
+    }
+[each_column {|column| block}]
+  Calls the given block for each column in the view.
+    view = db.view("All")
+    view.each_column {|entry|
+      p entry
+    }
+[UNID]
+  Alias of UniversalID().
+[count]
+[size]
+  Return count of entries of view.
+  
+=== 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.
+  If item type is richtext, return Notesgrip::NotesRichTextItem object.
+[[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.
+[to_s]
+  Return text string in the field.
+[EmbeddedObjects]
+  Return [], because the field type is TEXT.
+
+== Notesgrip:NotesRichTextItem class
+Wrap NotesRichTextItem object. This class is sub class of Notesgrip::NotesItem.
+  ns = NotesGrip::NotesSession.new
+  db = ns.getDatabase("servername", "dbname.nsf")
+  view = db.view("All")
+  doc = view.GetFirstDocument
+  doc["Body"].add_file("./sample.pdf")  # Body is RichText Field.
+  doc.save
+===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.
+[to_s]
+  Return text string in the field.
+[EmbeddedObjects]
+  Return array of Notesgrip::NotesEmbeddedObject in the RichText field.
+  Return [] if this field has no Embedded object.
+[each_embeddedFile]
+  Calls the given block for each file type embedded object in the field.
+[each_embeddedLink]
+  Calls the given block for each link type embedded object in the field.
+[each_embeddedOLE]
+  Calls the given block for each OLE type embedded object in the field.
+
+  
+= Author
+notesgrip@tech-notes.dyndns.org
+
+= License
+MIT

data/lib/iegrip/version.rb

@@ -1,3 +1,3 @@
 module IEgrip
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end

data/lib/iegrip.rb

@@ -62,7 +62,7 @@ module IEgrip
         target = proc.call
         #puts "  in retryGetTarget(), target = #{target.inspect}"
         if target
-          puts "retryGetTarget() Success fin."
+          #puts "retryGetTarget() Success fin."
           return target 
         end
         sleep RETRY_INTERVAL

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: iegrip
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - yac4423
@@ -49,6 +49,7 @@ files:
 - Gemfile
 - LICENSE.txt
 - README.md
+- README.rdoc
 - Rakefile
 - iegrip-0.0.2.gem
 - iegrip-0.0.9.gem