sword2ruby 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (92) hide show
  1. data/.gitignore +4 -0
  2. data/Gemfile +4 -0
  3. data/Gemfile.lock +30 -0
  4. data/LICENCE +35 -0
  5. data/README.md +43 -0
  6. data/Rakefile +53 -0
  7. data/doc/Atom/Collection.html +837 -0
  8. data/doc/Atom/Element.html +197 -0
  9. data/doc/Atom/Entry.html +1795 -0
  10. data/doc/Atom/Feed.html +297 -0
  11. data/doc/Atom/Service.html +363 -0
  12. data/doc/Atom.html +158 -0
  13. data/doc/Gemfile.html +125 -0
  14. data/doc/Object.html +165 -0
  15. data/doc/REXML/Element.html +493 -0
  16. data/doc/REXML.html +158 -0
  17. data/doc/Rakefile.html +123 -0
  18. data/doc/Sword2Ruby/Atom.html +169 -0
  19. data/doc/Sword2Ruby/AutoDiscover.html +327 -0
  20. data/doc/Sword2Ruby/Connection.html +274 -0
  21. data/doc/Sword2Ruby/DepositReceipt.html +331 -0
  22. data/doc/Sword2Ruby/Exception.html +168 -0
  23. data/doc/Sword2Ruby/SwordAccept.html +169 -0
  24. data/doc/Sword2Ruby/SwordStatementOAIORE.html +277 -0
  25. data/doc/Sword2Ruby/User.html +272 -0
  26. data/doc/Sword2Ruby/Utility.html +1101 -0
  27. data/doc/Sword2Ruby.html +213 -0
  28. data/doc/created.rid +29 -0
  29. data/doc/images/add.png +0 -0
  30. data/doc/images/brick.png +0 -0
  31. data/doc/images/brick_link.png +0 -0
  32. data/doc/images/bug.png +0 -0
  33. data/doc/images/bullet_black.png +0 -0
  34. data/doc/images/bullet_toggle_minus.png +0 -0
  35. data/doc/images/bullet_toggle_plus.png +0 -0
  36. data/doc/images/date.png +0 -0
  37. data/doc/images/delete.png +0 -0
  38. data/doc/images/find.png +0 -0
  39. data/doc/images/loadingAnimation.gif +0 -0
  40. data/doc/images/macFFBgHack.png +0 -0
  41. data/doc/images/package.png +0 -0
  42. data/doc/images/page_green.png +0 -0
  43. data/doc/images/page_white_text.png +0 -0
  44. data/doc/images/page_white_width.png +0 -0
  45. data/doc/images/plugin.png +0 -0
  46. data/doc/images/ruby.png +0 -0
  47. data/doc/images/tag_blue.png +0 -0
  48. data/doc/images/tag_green.png +0 -0
  49. data/doc/images/transparent.png +0 -0
  50. data/doc/images/wrench.png +0 -0
  51. data/doc/images/wrench_orange.png +0 -0
  52. data/doc/images/zoom.png +0 -0
  53. data/doc/index.html +118 -0
  54. data/doc/js/darkfish.js +153 -0
  55. data/doc/js/jquery.js +18 -0
  56. data/doc/js/navigation.js +142 -0
  57. data/doc/js/search.js +94 -0
  58. data/doc/js/search_index.js +1 -0
  59. data/doc/js/searcher.js +228 -0
  60. data/doc/rdoc.css +543 -0
  61. data/doc/spec/fixtures/example_txt.html +125 -0
  62. data/doc/table_of_contents.html +267 -0
  63. data/lib/sword2ruby/auto_discover.rb +71 -0
  64. data/lib/sword2ruby/collection.rb +261 -0
  65. data/lib/sword2ruby/connection.rb +37 -0
  66. data/lib/sword2ruby/constant.rb +35 -0
  67. data/lib/sword2ruby/deposit_receipt.rb +52 -0
  68. data/lib/sword2ruby/element.rb +12 -0
  69. data/lib/sword2ruby/entry.rb +602 -0
  70. data/lib/sword2ruby/exception.rb +7 -0
  71. data/lib/sword2ruby/feed.rb +34 -0
  72. data/lib/sword2ruby/rexml_element.rb +79 -0
  73. data/lib/sword2ruby/service.rb +79 -0
  74. data/lib/sword2ruby/sword_accept.rb +10 -0
  75. data/lib/sword2ruby/sword_statement_oai_ore.rb +38 -0
  76. data/lib/sword2ruby/user.rb +25 -0
  77. data/lib/sword2ruby/utility.rb +232 -0
  78. data/lib/sword2ruby/version.rb +4 -0
  79. data/lib/sword2ruby.rb +32 -0
  80. data/spec/auto_discover_spec.rb +30 -0
  81. data/spec/collection_spec.rb +33 -0
  82. data/spec/connection_spec.rb +21 -0
  83. data/spec/end_to_end_spec.rb +235 -0
  84. data/spec/fixtures/example.txt +3 -0
  85. data/spec/fixtures/snowflake.png +0 -0
  86. data/spec/fixtures/zip-test.zip +0 -0
  87. data/spec/service_spec.rb +38 -0
  88. data/spec/statement_spec.rb +53 -0
  89. data/spec/test_constants.rb +32 -0
  90. data/sword2ruby.gemspec +42 -0
  91. data/sword2ruby.tmproj +27 -0
  92. metadata +197 -0
data/doc/Sword2Ruby/User.html ADDED
@@ -0,0 +1,272 @@
1
+ <!DOCTYPE html>
2
+
3
+ <html>
4
+ <head>
5
+ <meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
6
+
7
+ <title>class Sword2Ruby::User - RDoc Documentation</title>
8
+
9
+ <link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet">
10
+
11
+ <script type="text/javascript">
12
+ var rdoc_rel_prefix = "../";
13
+ </script>
14
+
15
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
16
+ <script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script>
17
+ <script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script>
18
+ <script type="text/javascript" charset="utf-8" src="../js/search.js"></script>
19
+ <script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script>
20
+ <script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script>
21
+
22
+
23
+ <body id="top" class="class">
24
+ <nav id="metadata">
25
+ <nav id="home-section" class="section">
26
+ <h3 class="section-header">
27
+ <a href="../index.html">Home</a>
28
+ <a href="../table_of_contents.html#classes">Classes</a>
29
+ <a href="../table_of_contents.html#methods">Methods</a>
30
+ </h3>
31
+ </nav>
32
+
33
+
34
+ <nav id="search-section" class="section project-section" class="initially-hidden">
35
+ <form action="#" method="get" accept-charset="utf-8">
36
+ <h3 class="section-header">
37
+ <input type="text" name="search" placeholder="Search" id="search-field"
38
+ title="Type to search, Up and Down to navigate, Enter to load">
39
+ </h3>
40
+ </form>
41
+
42
+ <ul id="search-results" class="initially-hidden"></ul>
43
+ </nav>
44
+
45
+
46
+ <div id="file-metadata">
47
+ <nav id="file-list-section" class="section">
48
+ <h3 class="section-header">Defined In</h3>
49
+ <ul>
50
+ <li>lib/sword2ruby/user.rb
51
+ </ul>
52
+ </nav>
53
+
54
+
55
+ </div>
56
+
57
+ <div id="class-metadata">
58
+
59
+ <nav id="parent-class-section" class="section">
60
+ <h3 class="section-header">Parent</h3>
61
+
62
+ <p class="link"><a href="../Object.html">Object</a>
63
+
64
+ </nav>
65
+
66
+
67
+ <!-- Method Quickref -->
68
+ <nav id="method-list-section" class="section">
69
+ <h3 class="section-header">Methods</h3>
70
+
71
+ <ul class="link-list">
72
+
73
+ <li><a href="#method-c-new">::new</a>
74
+
75
+ </ul>
76
+ </nav>
77
+
78
+ </div>
79
+
80
+ <div id="project-metadata">
81
+ <nav id="fileindex-section" class="section project-section">
82
+ <h3 class="section-header">Pages</h3>
83
+
84
+ <ul>
85
+
86
+ <li class="file"><a href="../Gemfile.html">Gemfile</a>
87
+
88
+ <li class="file"><a href="../Rakefile.html">Rakefile</a>
89
+
90
+ <li class="file"><a href="../spec/fixtures/example_txt.html">example</a>
91
+
92
+ </ul>
93
+ </nav>
94
+
95
+ <nav id="classindex-section" class="section project-section">
96
+ <h3 class="section-header">Class and Module Index</h3>
97
+
98
+ <ul class="link-list">
99
+
100
+ <li><a href="../Sword2Ruby.html">Sword2Ruby</a>
101
+
102
+ <li><a href="../Sword2Ruby/Atom.html">Sword2Ruby::Atom</a>
103
+
104
+ <li><a href="../Sword2Ruby/AutoDiscover.html">Sword2Ruby::AutoDiscover</a>
105
+
106
+ <li><a href="../Sword2Ruby/Connection.html">Sword2Ruby::Connection</a>
107
+
108
+ <li><a href="../Sword2Ruby/DepositReceipt.html">Sword2Ruby::DepositReceipt</a>
109
+
110
+ <li><a href="../Sword2Ruby/Exception.html">Sword2Ruby::Exception</a>
111
+
112
+ <li><a href="../Sword2Ruby/SwordAccept.html">Sword2Ruby::SwordAccept</a>
113
+
114
+ <li><a href="../Sword2Ruby/SwordStatementOAIORE.html">Sword2Ruby::SwordStatementOAIORE</a>
115
+
116
+ <li><a href="../Sword2Ruby/User.html">Sword2Ruby::User</a>
117
+
118
+ <li><a href="../Sword2Ruby/Utility.html">Sword2Ruby::Utility</a>
119
+
120
+ <li><a href="../Atom.html">Atom</a>
121
+
122
+ <li><a href="../Atom/Collection.html">Atom::Collection</a>
123
+
124
+ <li><a href="../Atom/Element.html">Atom::Element</a>
125
+
126
+ <li><a href="../Atom/Entry.html">Atom::Entry</a>
127
+
128
+ <li><a href="../Atom/Feed.html">Atom::Feed</a>
129
+
130
+ <li><a href="../Atom/Service.html">Atom::Service</a>
131
+
132
+ <li><a href="../REXML.html">REXML</a>
133
+
134
+ <li><a href="../REXML/Element.html">REXML::Element</a>
135
+
136
+ <li><a href="../Object.html">Object</a>
137
+
138
+ </ul>
139
+ </nav>
140
+
141
+ </div>
142
+ </nav>
143
+
144
+ <div id="documentation">
145
+ <h1 class="class">class Sword2Ruby::User</h1>
146
+
147
+ <div id="description" class="description">
148
+
149
+ </div><!-- description -->
150
+
151
+
152
+
153
+
154
+ <section id="5Buntitled-5D" class="documentation-section">
155
+
156
+
157
+
158
+
159
+
160
+
161
+
162
+ <!-- Attributes -->
163
+ <section id="attribute-method-details" class="method-section section">
164
+ <h3 class="section-header">Attributes</h3>
165
+
166
+
167
+ <div id="attribute-i-on_behalf_of" class="method-detail">
168
+ <div class="method-heading attribute-method-heading">
169
+ <span class="method-name">on_behalf_of</span><span
170
+ class="attribute-access-type">[RW]</span>
171
+ </div>
172
+
173
+ <div class="method-description">
174
+
175
+ <p>On-Behalf-Of username for authenticating with the Sword server</p>
176
+
177
+ </div>
178
+ </div>
179
+
180
+ <div id="attribute-i-password" class="method-detail">
181
+ <div class="method-heading attribute-method-heading">
182
+ <span class="method-name">password</span><span
183
+ class="attribute-access-type">[RW]</span>
184
+ </div>
185
+
186
+ <div class="method-description">
187
+
188
+ <p>Password for authenticating with the Sword server</p>
189
+
190
+ </div>
191
+ </div>
192
+
193
+ <div id="attribute-i-username" class="method-detail">
194
+ <div class="method-heading attribute-method-heading">
195
+ <span class="method-name">username</span><span
196
+ class="attribute-access-type">[RW]</span>
197
+ </div>
198
+
199
+ <div class="method-description">
200
+
201
+ <p>Username for authenticating with the Sword server</p>
202
+
203
+ </div>
204
+ </div>
205
+
206
+ </section><!-- attribute-method-details -->
207
+
208
+
209
+ <!-- Methods -->
210
+
211
+ <section id="public-class-5Buntitled-5D-method-details" class="method-section section">
212
+ <h3 class="section-header">Public Class Methods</h3>
213
+
214
+
215
+ <div id="method-c-new" class="method-detail ">
216
+
217
+ <div class="method-heading">
218
+ <span class="method-name">new</span><span
219
+ class="method-args">(username=nil, password=nil, on_behalf_of=nil)</span>
220
+ <span class="method-click-advice">click to toggle source</span>
221
+ </div>
222
+
223
+
224
+ <div class="method-description">
225
+
226
+ <p>Creates a new <a href="User.html">User</a> object.</p>
227
+
228
+ <h3 id="method-c-new-label-Parameters">Parameters</h3>
229
+ <dl class="rdoc-list note-list"><dt>username
230
+ <dd>
231
+ <p>(optional) string value of the username.</p>
232
+ </dd><dt>password
233
+ <dd>
234
+ <p>(optional) string value of the password.</p>
235
+ </dd><dt><a href="User.html#attribute-i-on_behalf_of">#on_behalf_of</a>
236
+ <dd>
237
+ <p>(optional) string value indicating the username on whos behalf the actions
238
+ will be performed.</p>
239
+ </dd></dl>
240
+
241
+
242
+
243
+ <div class="method-source-code" id="new-source">
244
+ <pre><span class="ruby-comment"># File lib/sword2ruby/user.rb, line 18</span>
245
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">username</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">password</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">on_behalf_of</span>=<span class="ruby-keyword">nil</span>)
246
+ <span class="ruby-ivar">@username</span> = <span class="ruby-identifier">username</span>;
247
+ <span class="ruby-ivar">@password</span> = <span class="ruby-identifier">password</span>;
248
+ <span class="ruby-ivar">@on_behalf_of</span> = <span class="ruby-identifier">on_behalf_of</span>;
249
+ <span class="ruby-keyword">end</span></pre>
250
+ </div><!-- new-source -->
251
+
252
+ </div>
253
+
254
+
255
+
256
+
257
+ </div><!-- new-method -->
258
+
259
+
260
+ </section><!-- public-class-method-details -->
261
+
262
+ </section><!-- 5Buntitled-5D -->
263
+
264
+ </div><!-- documentation -->
265
+
266
+
267
+ <footer id="validator-badges">
268
+ <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
269
+ <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.
270
+ <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
271
+ </footer>
272
+