Permalink
Browse files

documentation update

  • Loading branch information...
1 parent 7e9cb25 commit 9178ab35a909882e7f18eebed2c8cdd31998da43 Michele Franzin committed Apr 10, 2012
Showing with 187 additions and 41 deletions.
  1. +9 −7 ChangeLog
  2. +14 −8 README.rdoc
  3. +157 −20 doc/index.html
  4. +7 −6 lib/sapnwrfc.rb
View
@@ -1,6 +1,12 @@
-2007-01-24 Piers Harding <piers@ompka.net>
+2012-04-10 Michele Franzin <michele.franzin@gmail.com>
+ * rdocs & build toolchain updates
+
+2011-05-27 Michele Franzin <michele.franzin@gmail.com>
+ * create github project
+ * upgrade to ruby 1.9.x
- * Initial Release
+2007-01-24 Piers Harding <piers@ompka.net>
+ * Initial Release
This is the first release of sapnw for Ruby
it contains support for full interface discovery, and all SAP ABAP datatypes
in structures or parameters, and some support for deep structures
@@ -15,11 +21,7 @@ Fri Jun 1 16:42:30 BST 2007
* add in nested table support: parameter -> field -> table ...
Thu Jun 26 18:51:20 NZST 2008
- * removed connection attributes that are nolonger supported
+ * removed connection attributes that are no longer supported
Thu Dec 11 09:51:47 NZDT 2008
* make sure that close cannot be called twice
-
-2011-05-27 Michele Franzin <michele.franzin@gmail.com>
- * create github project
- * upgrade to ruby 1.9.x
View
@@ -4,9 +4,13 @@
Welcome to the sapnwrfc Ruby package. This package is intended to facilitate RFC calls to an SAP R/3 system of release NW2004x and above. It may work for earlier versions but it hasn't been tested.
The fundamental purpose of the production of this package, is to provide a clean object oriented interface to RFC calls from within Ruby. This will hopefully have a number of effects:
+
(1) make it really easy to do RFC calls to SAP from Ruby in an object oriented fashion (Doh!)
+
(2) promote Ruby as the interface/scripting/glue language of choice for interaction with SAP R/3.
+
(3) make the combination of Linux, Apache, and Ruby the killer app for internet connectivity with SAP.
+
(4) Establish a small fun open source project that people are more than welcome to contribute to, if they so wish.
== Installation
@@ -19,21 +23,21 @@ In brief, the following should work on most systems:
if your rfcsdk is not findable in the system search path, then use the command line switches
for mkmf/setup.rb like so:
-ruby setup.rb config --with-nwrfcsdk-dir=/path/to/rfcsdk
-ruby setup.rb setup
+ ruby setup.rb config --with-nwrfcsdk-dir=/path/to/rfcsdk
+ ruby setup.rb setup
Now you can either install like so:
-ruby setup.rb install
+ ruby setup.rb install
or build the gem and install that like so:
-gem build sapnwrfc.linux.gemspec
-gem uninstall sapnwrfc
-gem install sapnwrfc-<version>-<architecture>.gem
+ gem build sapnwrfc.linux.gemspec
+ gem uninstall sapnwrfc
+ gem install sapnwrfc-<version>-<architecture>.gem
VERY IMPORTANT - make sure that you add the library path to LD_LIBRARY_PATH
eg - mine is:
- export LD_LIBRARY_PATH=/home/piers/code/sap/nwrfcsdk/lib
+ export LD_LIBRARY_PATH=/home/piers/code/sap/nwrfcsdk/lib
== Documents and Tests
@@ -55,7 +59,9 @@ saprfc is Copyright (c) 2006-2008 Piers Harding. It is free software, and
may be redistributed under the terms specified in the README file of
the Ruby distribution.
-One last thing - The SAP RFCSDK is a prerequisite for this perl package to work. The RFCSDK is proprietrary software owned by SAP AG. For this reason I will not supply ANY component part of the RFCSDK with this perl package, and further more you must obtain it through the normal channels with SAP AG - ie. you must have a licensed SAP R/3 installation at your disposal.
+One last thing - The SAP RFCSDK is a prerequisite for this perl package to work.
+The RFCSDK is proprietrary software owned by SAP AG.
+For this reason I will not supply ANY component part of the RFCSDK with this perl package, and further more you must obtain it through the normal channels with SAP AG - ie. you must have a licensed SAP R/3 installation at your disposal.
= Other stuff
View
@@ -1,24 +1,161 @@
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+<title>
+ File: README
+
+ &mdash; Documentation by YARD 0.7.5
+
+</title>
-<!--
+ <link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
- sapnwrfc Documentation
+ <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
- -->
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>sapnwrfc Documentation</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
-</head>
-<frameset rows="20%, 80%">
- <frameset cols="25%,35%,45%">
- <frame src="fr_file_index.html" title="Files" name="Files" />
- <frame src="fr_class_index.html" name="Classes" />
- <frame src="fr_method_index.html" name="Methods" />
- </frameset>
- <frame src="files/lib/sapnwrfc_rb.html" name="docwin" />
-</frameset>
+<script type="text/javascript" charset="utf-8">
+ relpath = '';
+ if (relpath != '') relpath += '/';
+</script>
+
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+
+ <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+
+ </head>
+ <body>
+ <script type="text/javascript" charset="utf-8">
+ if (window.top.frames.main) document.body.className = 'frames';
+ </script>
+
+ <div id="header">
+ <div id="menu">
+
+ <a href="_index.html" title="Index">Index</a> &raquo;
+ <span class="title">File: README</span>
+
+
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+
+ <div id="search">
+
+ <a id="class_list_link" href="#">Class List</a>
+
+ <a id="method_list_link" href="#">Method List</a>
+
+ <a id="file_list_link" href="#">File List</a>
+
+</div>
+ <div class="clear"></div>
+ </div>
+
+ <iframe id="search_frame"></iframe>
+
+ <div id="content"><div id='filecontents'>
+<h1>sapnwrfc - SAP Netweaver RFC support for Ruby 1.9.x</h1>
+
+<h2>Summary</h2>
+
+<p>Welcome to the sapnwrfc Ruby package. This package is intended to
+facilitate RFC calls to an SAP R/3 system of release NW2004x and above. It
+may work for earlier versions but it hasn’t been tested. The fundamental
+purpose of the production of this package, is to provide a clean object
+oriented interface to RFC calls from within Ruby. This will hopefully have
+a number of effects:</p>
+
+<p>(1) make it really easy to do RFC calls to SAP from Ruby in an object
+oriented fashion (Doh!)</p>
+
+<p>(2) promote Ruby as the interface/scripting/glue language of choice for
+interaction with SAP R/3.</p>
+
+<p>(3) make the combination of Linux, Apache, and Ruby the killer app for
+internet connectivity with SAP.</p>
+
+<p>(4) Establish a small fun open source project that people are more than
+welcome to contribute to, if they so wish.</p>
+
+<h2>Installation</h2>
+
+<p>After you have unpacked your kit, you should have all the files listed in
+the MANIFEST.</p>
+
+<p>In brief, the following should work on most systems:</p>
+
+<pre class="code ruby"><code><span class='id identifier rubyid_ruby'>ruby</span> <span class='id identifier rubyid_setup'>setup</span><span class='period'>.</span><span class='id identifier rubyid_rb'>rb</span></code></pre>
+
+<p>if your rfcsdk is not findable in the system search path, then use the
+command line switches for mkmf/setup.rb like so:</p>
+
+<pre class="code ruby"><code><span class='id identifier rubyid_ruby'>ruby</span> <span class='id identifier rubyid_setup'>setup</span><span class='period'>.</span><span class='id identifier rubyid_rb'>rb</span> <span class='id identifier rubyid_config'>config</span> <span class='op'>-</span><span class='op'>-</span><span class='id identifier rubyid_with'>with</span><span class='op'>-</span><span class='id identifier rubyid_nwrfcsdk'>nwrfcsdk</span><span class='op'>-</span><span class='id identifier rubyid_dir'>dir</span><span class='op'>=</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>path</span><span class='regexp_end'>/to</span></span><span class='op'>/</span><span class='id identifier rubyid_rfcsdk'>rfcsdk</span>
+<span class='id identifier rubyid_ruby'>ruby</span> <span class='id identifier rubyid_setup'>setup</span><span class='period'>.</span><span class='id identifier rubyid_rb'>rb</span> <span class='id identifier rubyid_setup'>setup</span></code></pre>
+
+<p>Now you can either install like so:</p>
+
+<pre class="code ruby"><code><span class='id identifier rubyid_ruby'>ruby</span> <span class='id identifier rubyid_setup'>setup</span><span class='period'>.</span><span class='id identifier rubyid_rb'>rb</span> <span class='id identifier rubyid_install'>install</span></code></pre>
+
+<p>or build the gem and install that like so:</p>
+
+<pre class="code ruby"><code>gem build sapnwrfc.linux.gemspec
+gem uninstall sapnwrfc
+gem install sapnwrfc-&lt;version&gt;-&lt;architecture&gt;.gem</code></pre>
+
+<p>VERY IMPORTANT - make sure that you add the library path to LD_LIBRARY_PATH
+eg - mine is:</p>
+
+<pre class="code ruby"><code><span class='id identifier rubyid_export'>export</span> <span class='const'>LD_LIBRARY_PATH</span><span class='op'>=</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>home</span><span class='regexp_end'>/piers</span></span><span class='op'>/</span><span class='id identifier rubyid_code'>code</span><span class='op'>/</span><span class='id identifier rubyid_sap'>sap</span><span class='op'>/</span><span class='id identifier rubyid_nwrfcsdk'>nwrfcsdk</span><span class='op'>/</span><span class='id identifier rubyid_lib'>lib</span></code></pre>
+
+<h2>Documents and Tests</h2>
+<dl class="rdoc-list"><dt>doc/*</dt>
+<dd>
+<p>Module Documentation</p>
+</dd><dt>tests/*.rb</dt>
+<dd>
+<p>Test basic connection, and some rfc call examples</p>
+</dd></dl>
+
+<h2>Credits</h2>
+<table class="rdoc-list"><tr><td class="rdoc-term"><p>GitHub repo</p></td>
+<td>
+<p>Michele Franzin &lt;michele@franzin.net&gt;</p>
+</td></tr><tr><td class="rdoc-term"><p>Ruby 1.9.x porting</p></td>
+<td>
+<p>Michele Franzin &lt;michele@franzin.net&gt;</p>
+</td></tr></table>
+
+<h2>License</h2>
+
+<p>saprfc is Copyright © 2006-2008 Piers Harding. It is free software, and
+may be redistributed under the terms specified in the README file of the
+Ruby distribution.</p>
+
+<p>One last thing - The SAP RFCSDK is a prerequisite for this perl package to
+work. The RFCSDK is proprietrary software owned by SAP AG. For this reason
+I will not supply ANY component part of the RFCSDK with this perl package,
+and further more you must obtain it through the normal channels with SAP AG
+- ie. you must have a licensed SAP R/3 installation at your disposal.</p>
+
+<h1>Other stuff</h1>
+<table class="rdoc-list"><tr><td class="rdoc-term"><p>Author</p></td>
+<td>
+<p>Piers Harding &lt;piers@ompka.net&gt;</p>
+</td></tr><tr><td class="rdoc-term"><p>Requires</p></td>
+<td>
+<p>Ruby 1.9.x or later</p>
+</td></tr><tr><td class="rdoc-term"><p>License</p></td>
+<td>
+<p>Copyright © 2006-2008 Piers Harding Released under Ruby’s License</p>
+</td></tr></table>
+</div></div>
+
+ <div id="footer">
+ Generated on Tue Apr 10 11:11:30 2012 by
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+ 0.7.5 (ruby-1.9.3).
+</div>
+
+ </body>
</html>
View
@@ -9,9 +9,9 @@
#
# = Download and Documentation
#
-# Documentation at: http://www.piersharding.com/download/ruby/sapnwrfc/doc/
+# Documentation at: http://rubydoc.info/github/fuzziness/sapnwrfc/frames
#
-# Project and Download at: http://raa.ruby-lang.org/project/sapnwrfc
+# Project and Download at: https://github.com/fuzziness/sapnwrfc
#
# = Functionality
#
@@ -166,17 +166,18 @@
#
# = Thanks to:
#
-# * Olivier Boudry - an Open Source guy
-# * Craig Cmehil - SAP, and SDN
-# * Ulrich Schmidt - SAP
+# * Olivier Boudry - an Open Source guy
+# * Craig Cmehil - SAP, and SDN
+# * Ulrich Schmidt - SAP
+# * Michele Franzin - ruby 1.9.x porting
# For their help in making this possible.
#
#
#
#
# Author:: Piers Harding <piers@ompka.net>
# License:: Copyright (c) 2006-2008 Piers Harding. sapnwrfc is free software, and may be redistributed under the terms specified in the README file of the Ruby distribution.
-# Requires:: Ruby 1.9.0 or later
+# Requires:: Ruby 1.9.x or later
#

0 comments on commit 9178ab3

Please sign in to comment.