html/classes/GoogleCalendar/Service.html in gcalapi-0.0.3 vs html/classes/GoogleCalendar/Service.html in gcalapi-0.0.4
- old
+ new
@@ -90,21 +90,25 @@
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
- <a href="#M000018">calendar_list</a>
- <a href="#M000019">calendars</a>
- <a href="#M000021">delete</a>
- <a href="#M000022">insert</a>
- <a href="#M000017">new</a>
+ <a href="#M000022">calendar_list</a>
+ <a href="#M000023">calendars</a>
+ <a href="#M000025">delete</a>
+ <a href="#M000026">insert</a>
+ <a href="#M000021">new</a>
<a href="#M000013">proxy_addr</a>
<a href="#M000014">proxy_addr=</a>
+ <a href="#M000019">proxy_pass</a>
+ <a href="#M000020">proxy_pass=</a>
<a href="#M000015">proxy_port</a>
<a href="#M000016">proxy_port=</a>
- <a href="#M000020">query</a>
- <a href="#M000023">update</a>
+ <a href="#M000017">proxy_user</a>
+ <a href="#M000018">proxy_user=</a>
+ <a href="#M000024">query</a>
+ <a href="#M000027">update</a>
</div>
</div>
</div>
@@ -160,25 +164,25 @@
<!-- if method_list -->
<div id="methods">
<h3 class="section-bar">Public Class methods</h3>
- <div id="method-M000017" class="method-detail">
- <a name="M000017"></a>
+ <div id="method-M000021" class="method-detail">
+ <a name="M000021"></a>
<div class="method-heading">
- <a href="#M000017" class="method-signature">
+ <a href="#M000021" class="method-signature">
<span class="method-name">new</span><span class="method-args">(email, pass)</span>
</a>
</div>
<div class="method-description">
<p><a class="source-toggle" href="#"
- onclick="toggleCode('M000017-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000017-source">
+ onclick="toggleCode('M000021-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000021-source">
<pre>
-<span class="ruby-comment cmt"># File lib/googlecalendar/service.rb, line 48</span>
+<span class="ruby-comment cmt"># File lib/googlecalendar/service.rb, line 69</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">email</span>, <span class="ruby-identifier">pass</span>)
<span class="ruby-ivar">@email</span> = <span class="ruby-identifier">email</span>
<span class="ruby-ivar">@pass</span> = <span class="ruby-identifier">pass</span>
<span class="ruby-ivar">@session</span> = <span class="ruby-keyword kw">nil</span>
<span class="ruby-ivar">@cookie</span> = <span class="ruby-keyword kw">nil</span>
@@ -233,10 +237,56 @@
</pre>
</div>
</div>
</div>
+ <div id="method-M000019" class="method-detail">
+ <a name="M000019"></a>
+
+ <div class="method-heading">
+ <a href="#M000019" class="method-signature">
+ <span class="method-name">proxy_pass</span><span class="method-args">()</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000019-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000019-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/googlecalendar/service.rb, line 60</span>
+ <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">proxy_pass</span>
+ <span class="ruby-ivar">@@proxy_pass</span>
+ <span class="ruby-keyword kw">end</span>
+</pre>
+ </div>
+ </div>
+ </div>
+
+ <div id="method-M000020" class="method-detail">
+ <a name="M000020"></a>
+
+ <div class="method-heading">
+ <a href="#M000020" class="method-signature">
+ <span class="method-name">proxy_pass=</span><span class="method-args">(pass)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000020-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000020-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/googlecalendar/service.rb, line 64</span>
+ <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">proxy_pass=</span>(<span class="ruby-identifier">pass</span>)
+ <span class="ruby-ivar">@@proxy_pass</span> = <span class="ruby-identifier">pass</span>
+ <span class="ruby-keyword kw">end</span>
+</pre>
+ </div>
+ </div>
+ </div>
+
<div id="method-M000015" class="method-detail">
<a name="M000015"></a>
<div class="method-heading">
<a href="#M000015" class="method-signature">
@@ -279,72 +329,118 @@
</pre>
</div>
</div>
</div>
- <h3 class="section-bar">Public Instance methods</h3>
+ <div id="method-M000017" class="method-detail">
+ <a name="M000017"></a>
+ <div class="method-heading">
+ <a href="#M000017" class="method-signature">
+ <span class="method-name">proxy_user</span><span class="method-args">()</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000017-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000017-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/googlecalendar/service.rb, line 50</span>
+ <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">proxy_user</span>
+ <span class="ruby-ivar">@@proxy_user</span>
+ <span class="ruby-keyword kw">end</span>
+</pre>
+ </div>
+ </div>
+ </div>
+
<div id="method-M000018" class="method-detail">
<a name="M000018"></a>
<div class="method-heading">
<a href="#M000018" class="method-signature">
+ <span class="method-name">proxy_user=</span><span class="method-args">(user)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000018-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000018-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/googlecalendar/service.rb, line 54</span>
+ <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">proxy_user=</span>(<span class="ruby-identifier">user</span>)
+ <span class="ruby-ivar">@@proxy_user</span> = <span class="ruby-identifier">user</span>
+ <span class="ruby-keyword kw">end</span>
+</pre>
+ </div>
+ </div>
+ </div>
+
+ <h3 class="section-bar">Public Instance methods</h3>
+
+ <div id="method-M000022" class="method-detail">
+ <a name="M000022"></a>
+
+ <div class="method-heading">
+ <a href="#M000022" class="method-signature">
<span class="method-name">calendar_list</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
get the list of user’s calendars and returns http response object
</p>
<p><a class="source-toggle" href="#"
- onclick="toggleCode('M000018-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000018-source">
+ onclick="toggleCode('M000022-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000022-source">
<pre>
-<span class="ruby-comment cmt"># File lib/googlecalendar/service.rb, line 59</span>
+<span class="ruby-comment cmt"># File lib/googlecalendar/service.rb, line 80</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">calendar_list</span>
<span class="ruby-identifier">auth</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@auth</span>
<span class="ruby-identifier">uri</span> = <span class="ruby-constant">URI</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-constant">CALENDAR_LIST_PATH</span> <span class="ruby-operator">+</span> <span class="ruby-ivar">@email</span>)
<span class="ruby-identifier">do_get</span>(<span class="ruby-identifier">uri</span>, <span class="ruby-value str">"Authorization"</span> =<span class="ruby-operator">></span> <span class="ruby-node">"GoogleLogin auth=#{@auth}"</span>)
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
- <div id="method-M000019" class="method-detail">
- <a name="M000019"></a>
+ <div id="method-M000023" class="method-detail">
+ <a name="M000023"></a>
<div class="method-heading">
<span class="method-name">calendars</span><span class="method-args">()</span>
</div>
<div class="method-description">
<p>
-Alias for <a href="Service.html#M000018">calendar_list</a>
+Alias for <a href="Service.html#M000022">calendar_list</a>
</p>
</div>
</div>
- <div id="method-M000021" class="method-detail">
- <a name="M000021"></a>
+ <div id="method-M000025" class="method-detail">
+ <a name="M000025"></a>
<div class="method-heading">
- <a href="#M000021" class="method-signature">
+ <a href="#M000025" class="method-signature">
<span class="method-name">delete</span><span class="method-args">(feed)</span>
</a>
</div>
<div class="method-description">
<p>
delete an event.
</p>
<p><a class="source-toggle" href="#"
- onclick="toggleCode('M000021-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000021-source">
+ onclick="toggleCode('M000025-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000025-source">
<pre>
-<span class="ruby-comment cmt"># File lib/googlecalendar/service.rb, line 92</span>
+<span class="ruby-comment cmt"># File lib/googlecalendar/service.rb, line 115</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">delete</span>(<span class="ruby-identifier">feed</span>)
<span class="ruby-identifier">auth</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@auth</span>
<span class="ruby-identifier">uri</span> = <span class="ruby-constant">URI</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-identifier">feed</span>)
<span class="ruby-identifier">do_post</span>(<span class="ruby-identifier">uri</span>,
{<span class="ruby-value str">"X-HTTP-Method-Override"</span> =<span class="ruby-operator">></span> <span class="ruby-value str">"DELETE"</span>,
@@ -354,28 +450,28 @@
</pre>
</div>
</div>
</div>
- <div id="method-M000022" class="method-detail">
- <a name="M000022"></a>
+ <div id="method-M000026" class="method-detail">
+ <a name="M000026"></a>
<div class="method-heading">
- <a href="#M000022" class="method-signature">
+ <a href="#M000026" class="method-signature">
<span class="method-name">insert</span><span class="method-args">(feed, event)</span>
</a>
</div>
<div class="method-description">
<p>
insert an event
</p>
<p><a class="source-toggle" href="#"
- onclick="toggleCode('M000022-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000022-source">
+ onclick="toggleCode('M000026-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000026-source">
<pre>
-<span class="ruby-comment cmt"># File lib/googlecalendar/service.rb, line 104</span>
+<span class="ruby-comment cmt"># File lib/googlecalendar/service.rb, line 127</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">insert</span>(<span class="ruby-identifier">feed</span>, <span class="ruby-identifier">event</span>)
<span class="ruby-identifier">auth</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@auth</span>
<span class="ruby-identifier">uri</span> = <span class="ruby-constant">URI</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-identifier">feed</span>)
<span class="ruby-identifier">do_post</span>(<span class="ruby-identifier">uri</span>,
{<span class="ruby-value str">"Authorization"</span> =<span class="ruby-operator">></span> <span class="ruby-node">"GoogleLogin auth=#{@auth}"</span>,
@@ -385,35 +481,62 @@
</pre>
</div>
</div>
</div>
- <div id="method-M000020" class="method-detail">
- <a name="M000020"></a>
+ <div id="method-M000024" class="method-detail">
+ <a name="M000024"></a>
<div class="method-heading">
- <a href="#M000020" class="method-signature">
+ <a href="#M000024" class="method-signature">
<span class="method-name">query</span><span class="method-args">(cal_url, conditions)</span>
</a>
</div>
<div class="method-description">
<p>
send query for events of a calendar and returns http response object.
-available condtions: :q => query string :max-results => max contents
-count. (default: 25) :start-index => 1-based index of the first result
-to be retrieved :orderby => the order of retrieved data. :published-min
-=> Bounds on the entry publication date(oldest) :published-max =>
-Bounds on the entry publication date(newest) :updated-min => Bounds on
-the entry update date(oldest) :updated-max => Bounds on the entry update
-date(newest) :author => Entry author
+available condtions are
</p>
+<ul>
+<li>:q => query string
+
+</li>
+<li>:max-results => max contents count. (default: 25)
+
+</li>
+<li>:start-index => 1-based index of the first result to be retrieved
+
+</li>
+<li>:orderby => the order of retrieved data.
+
+</li>
+<li>:published-min => Bounds on the entry publication date(oldest)
+
+</li>
+<li>:published-max => Bounds on the entry publication date(newest)
+
+</li>
+<li>:updated-min => Bounds on the entry update date(oldest)
+
+</li>
+<li>:updated-max => Bounds on the entry update date(newest)
+
+</li>
+<li>:author => Entry author
+
+</li>
+</ul>
+<p>
+For detail, see <a
+href="http://code.google.com/apis/gdata/protocol.html#Queries">code.google.com/apis/gdata/protocol.html#Queries</a>
+</p>
<p><a class="source-toggle" href="#"
- onclick="toggleCode('M000020-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000020-source">
+ onclick="toggleCode('M000024-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000024-source">
<pre>
-<span class="ruby-comment cmt"># File lib/googlecalendar/service.rb, line 80</span>
+<span class="ruby-comment cmt"># File lib/googlecalendar/service.rb, line 103</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">query</span>(<span class="ruby-identifier">cal_url</span>, <span class="ruby-identifier">conditions</span>)
<span class="ruby-identifier">auth</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@auth</span>
<span class="ruby-identifier">uri</span> = <span class="ruby-constant">URI</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-identifier">cal_url</span>)
<span class="ruby-identifier">uri</span>.<span class="ruby-identifier">query</span> = <span class="ruby-identifier">conditions</span>.<span class="ruby-identifier">map</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">key</span>, <span class="ruby-identifier">val</span><span class="ruby-operator">|</span>
<span class="ruby-node">"#{key}=#{URI.escape(val.kind_of?(Time) ? val.getutc.iso8601 : val.to_s)}"</span>
@@ -423,27 +546,27 @@
</pre>
</div>
</div>
</div>
- <div id="method-M000023" class="method-detail">
- <a name="M000023"></a>
+ <div id="method-M000027" class="method-detail">
+ <a name="M000027"></a>
<div class="method-heading">
- <a href="#M000023" class="method-signature">
+ <a href="#M000027" class="method-signature">
<span class="method-name">update</span><span class="method-args">(feed, event)</span>
</a>
</div>
<div class="method-description">
<p>
update an event.
</p>
<p><a class="source-toggle" href="#"
- onclick="toggleCode('M000023-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000023-source">
+ onclick="toggleCode('M000027-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000027-source">
<pre>
-<span class="ruby-comment cmt"># File lib/googlecalendar/service.rb, line 116</span>
+<span class="ruby-comment cmt"># File lib/googlecalendar/service.rb, line 139</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">update</span>(<span class="ruby-identifier">feed</span>, <span class="ruby-identifier">event</span>)
<span class="ruby-identifier">auth</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@auth</span>
<span class="ruby-identifier">uri</span> = <span class="ruby-constant">URI</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-identifier">feed</span>)
<span class="ruby-identifier">do_post</span>(<span class="ruby-identifier">uri</span>,
{<span class="ruby-value str">"X-HTTP-Method-Override"</span> =<span class="ruby-operator">></span> <span class="ruby-value str">"PUT"</span>,
\ No newline at end of file