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.
- data/.gitignore +4 -0
- data/Gemfile +4 -0
- data/Gemfile.lock +30 -0
- data/LICENCE +35 -0
- data/README.md +43 -0
- data/Rakefile +53 -0
- data/doc/Atom/Collection.html +837 -0
- data/doc/Atom/Element.html +197 -0
- data/doc/Atom/Entry.html +1795 -0
- data/doc/Atom/Feed.html +297 -0
- data/doc/Atom/Service.html +363 -0
- data/doc/Atom.html +158 -0
- data/doc/Gemfile.html +125 -0
- data/doc/Object.html +165 -0
- data/doc/REXML/Element.html +493 -0
- data/doc/REXML.html +158 -0
- data/doc/Rakefile.html +123 -0
- data/doc/Sword2Ruby/Atom.html +169 -0
- data/doc/Sword2Ruby/AutoDiscover.html +327 -0
- data/doc/Sword2Ruby/Connection.html +274 -0
- data/doc/Sword2Ruby/DepositReceipt.html +331 -0
- data/doc/Sword2Ruby/Exception.html +168 -0
- data/doc/Sword2Ruby/SwordAccept.html +169 -0
- data/doc/Sword2Ruby/SwordStatementOAIORE.html +277 -0
- data/doc/Sword2Ruby/User.html +272 -0
- data/doc/Sword2Ruby/Utility.html +1101 -0
- data/doc/Sword2Ruby.html +213 -0
- data/doc/created.rid +29 -0
- data/doc/images/add.png +0 -0
- data/doc/images/brick.png +0 -0
- data/doc/images/brick_link.png +0 -0
- data/doc/images/bug.png +0 -0
- data/doc/images/bullet_black.png +0 -0
- data/doc/images/bullet_toggle_minus.png +0 -0
- data/doc/images/bullet_toggle_plus.png +0 -0
- data/doc/images/date.png +0 -0
- data/doc/images/delete.png +0 -0
- data/doc/images/find.png +0 -0
- data/doc/images/loadingAnimation.gif +0 -0
- data/doc/images/macFFBgHack.png +0 -0
- data/doc/images/package.png +0 -0
- data/doc/images/page_green.png +0 -0
- data/doc/images/page_white_text.png +0 -0
- data/doc/images/page_white_width.png +0 -0
- data/doc/images/plugin.png +0 -0
- data/doc/images/ruby.png +0 -0
- data/doc/images/tag_blue.png +0 -0
- data/doc/images/tag_green.png +0 -0
- data/doc/images/transparent.png +0 -0
- data/doc/images/wrench.png +0 -0
- data/doc/images/wrench_orange.png +0 -0
- data/doc/images/zoom.png +0 -0
- data/doc/index.html +118 -0
- data/doc/js/darkfish.js +153 -0
- data/doc/js/jquery.js +18 -0
- data/doc/js/navigation.js +142 -0
- data/doc/js/search.js +94 -0
- data/doc/js/search_index.js +1 -0
- data/doc/js/searcher.js +228 -0
- data/doc/rdoc.css +543 -0
- data/doc/spec/fixtures/example_txt.html +125 -0
- data/doc/table_of_contents.html +267 -0
- data/lib/sword2ruby/auto_discover.rb +71 -0
- data/lib/sword2ruby/collection.rb +261 -0
- data/lib/sword2ruby/connection.rb +37 -0
- data/lib/sword2ruby/constant.rb +35 -0
- data/lib/sword2ruby/deposit_receipt.rb +52 -0
- data/lib/sword2ruby/element.rb +12 -0
- data/lib/sword2ruby/entry.rb +602 -0
- data/lib/sword2ruby/exception.rb +7 -0
- data/lib/sword2ruby/feed.rb +34 -0
- data/lib/sword2ruby/rexml_element.rb +79 -0
- data/lib/sword2ruby/service.rb +79 -0
- data/lib/sword2ruby/sword_accept.rb +10 -0
- data/lib/sword2ruby/sword_statement_oai_ore.rb +38 -0
- data/lib/sword2ruby/user.rb +25 -0
- data/lib/sword2ruby/utility.rb +232 -0
- data/lib/sword2ruby/version.rb +4 -0
- data/lib/sword2ruby.rb +32 -0
- data/spec/auto_discover_spec.rb +30 -0
- data/spec/collection_spec.rb +33 -0
- data/spec/connection_spec.rb +21 -0
- data/spec/end_to_end_spec.rb +235 -0
- data/spec/fixtures/example.txt +3 -0
- data/spec/fixtures/snowflake.png +0 -0
- data/spec/fixtures/zip-test.zip +0 -0
- data/spec/service_spec.rb +38 -0
- data/spec/statement_spec.rb +53 -0
- data/spec/test_constants.rb +32 -0
- data/sword2ruby.gemspec +42 -0
- data/sword2ruby.tmproj +27 -0
- metadata +197 -0
data/doc/Rakefile.html
ADDED
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
|
|
3
|
+
<html>
|
|
4
|
+
<head>
|
|
5
|
+
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
|
|
6
|
+
|
|
7
|
+
<title>Rakefile - 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 class="file">
|
|
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="project-metadata">
|
|
47
|
+
<nav id="fileindex-section" class="section project-section">
|
|
48
|
+
<h3 class="section-header">Pages</h3>
|
|
49
|
+
|
|
50
|
+
<ul>
|
|
51
|
+
|
|
52
|
+
<li class="file"><a href="./Gemfile.html">Gemfile</a>
|
|
53
|
+
|
|
54
|
+
<li class="file"><a href="./Rakefile.html">Rakefile</a>
|
|
55
|
+
|
|
56
|
+
<li class="file"><a href="./spec/fixtures/example_txt.html">example</a>
|
|
57
|
+
|
|
58
|
+
</ul>
|
|
59
|
+
</nav>
|
|
60
|
+
|
|
61
|
+
<nav id="classindex-section" class="section project-section">
|
|
62
|
+
<h3 class="section-header">Class and Module Index</h3>
|
|
63
|
+
|
|
64
|
+
<ul class="link-list">
|
|
65
|
+
|
|
66
|
+
<li><a href="./Sword2Ruby.html">Sword2Ruby</a>
|
|
67
|
+
|
|
68
|
+
<li><a href="./Sword2Ruby/Atom.html">Sword2Ruby::Atom</a>
|
|
69
|
+
|
|
70
|
+
<li><a href="./Sword2Ruby/AutoDiscover.html">Sword2Ruby::AutoDiscover</a>
|
|
71
|
+
|
|
72
|
+
<li><a href="./Sword2Ruby/Connection.html">Sword2Ruby::Connection</a>
|
|
73
|
+
|
|
74
|
+
<li><a href="./Sword2Ruby/DepositReceipt.html">Sword2Ruby::DepositReceipt</a>
|
|
75
|
+
|
|
76
|
+
<li><a href="./Sword2Ruby/Exception.html">Sword2Ruby::Exception</a>
|
|
77
|
+
|
|
78
|
+
<li><a href="./Sword2Ruby/SwordAccept.html">Sword2Ruby::SwordAccept</a>
|
|
79
|
+
|
|
80
|
+
<li><a href="./Sword2Ruby/SwordStatementOAIORE.html">Sword2Ruby::SwordStatementOAIORE</a>
|
|
81
|
+
|
|
82
|
+
<li><a href="./Sword2Ruby/User.html">Sword2Ruby::User</a>
|
|
83
|
+
|
|
84
|
+
<li><a href="./Sword2Ruby/Utility.html">Sword2Ruby::Utility</a>
|
|
85
|
+
|
|
86
|
+
<li><a href="./Atom.html">Atom</a>
|
|
87
|
+
|
|
88
|
+
<li><a href="./Atom/Collection.html">Atom::Collection</a>
|
|
89
|
+
|
|
90
|
+
<li><a href="./Atom/Element.html">Atom::Element</a>
|
|
91
|
+
|
|
92
|
+
<li><a href="./Atom/Entry.html">Atom::Entry</a>
|
|
93
|
+
|
|
94
|
+
<li><a href="./Atom/Feed.html">Atom::Feed</a>
|
|
95
|
+
|
|
96
|
+
<li><a href="./Atom/Service.html">Atom::Service</a>
|
|
97
|
+
|
|
98
|
+
<li><a href="./REXML.html">REXML</a>
|
|
99
|
+
|
|
100
|
+
<li><a href="./REXML/Element.html">REXML::Element</a>
|
|
101
|
+
|
|
102
|
+
<li><a href="./Object.html">Object</a>
|
|
103
|
+
|
|
104
|
+
</ul>
|
|
105
|
+
</nav>
|
|
106
|
+
|
|
107
|
+
</div>
|
|
108
|
+
</nav>
|
|
109
|
+
|
|
110
|
+
<div id="documentation" class="description">
|
|
111
|
+
|
|
112
|
+
<p>require “bundler/gem_tasks”</p>
|
|
113
|
+
|
|
114
|
+
</div>
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
<footer id="validator-badges">
|
|
119
|
+
<p><a href="http://validator.w3.org/check/referer">[Validate]</a>
|
|
120
|
+
<p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.
|
|
121
|
+
<p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
|
|
122
|
+
</footer>
|
|
123
|
+
|
|
@@ -0,0 +1,169 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
|
|
3
|
+
<html>
|
|
4
|
+
<head>
|
|
5
|
+
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
|
|
6
|
+
|
|
7
|
+
<title>module Sword2Ruby::Atom - 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="module">
|
|
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.rb
|
|
51
|
+
</ul>
|
|
52
|
+
</nav>
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
</div>
|
|
56
|
+
|
|
57
|
+
<div id="class-metadata">
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
</div>
|
|
63
|
+
|
|
64
|
+
<div id="project-metadata">
|
|
65
|
+
<nav id="fileindex-section" class="section project-section">
|
|
66
|
+
<h3 class="section-header">Pages</h3>
|
|
67
|
+
|
|
68
|
+
<ul>
|
|
69
|
+
|
|
70
|
+
<li class="file"><a href="../Gemfile.html">Gemfile</a>
|
|
71
|
+
|
|
72
|
+
<li class="file"><a href="../Rakefile.html">Rakefile</a>
|
|
73
|
+
|
|
74
|
+
<li class="file"><a href="../spec/fixtures/example_txt.html">example</a>
|
|
75
|
+
|
|
76
|
+
</ul>
|
|
77
|
+
</nav>
|
|
78
|
+
|
|
79
|
+
<nav id="classindex-section" class="section project-section">
|
|
80
|
+
<h3 class="section-header">Class and Module Index</h3>
|
|
81
|
+
|
|
82
|
+
<ul class="link-list">
|
|
83
|
+
|
|
84
|
+
<li><a href="../Sword2Ruby.html">Sword2Ruby</a>
|
|
85
|
+
|
|
86
|
+
<li><a href="../Sword2Ruby/Atom.html">Sword2Ruby::Atom</a>
|
|
87
|
+
|
|
88
|
+
<li><a href="../Sword2Ruby/AutoDiscover.html">Sword2Ruby::AutoDiscover</a>
|
|
89
|
+
|
|
90
|
+
<li><a href="../Sword2Ruby/Connection.html">Sword2Ruby::Connection</a>
|
|
91
|
+
|
|
92
|
+
<li><a href="../Sword2Ruby/DepositReceipt.html">Sword2Ruby::DepositReceipt</a>
|
|
93
|
+
|
|
94
|
+
<li><a href="../Sword2Ruby/Exception.html">Sword2Ruby::Exception</a>
|
|
95
|
+
|
|
96
|
+
<li><a href="../Sword2Ruby/SwordAccept.html">Sword2Ruby::SwordAccept</a>
|
|
97
|
+
|
|
98
|
+
<li><a href="../Sword2Ruby/SwordStatementOAIORE.html">Sword2Ruby::SwordStatementOAIORE</a>
|
|
99
|
+
|
|
100
|
+
<li><a href="../Sword2Ruby/User.html">Sword2Ruby::User</a>
|
|
101
|
+
|
|
102
|
+
<li><a href="../Sword2Ruby/Utility.html">Sword2Ruby::Utility</a>
|
|
103
|
+
|
|
104
|
+
<li><a href="../Atom.html">Atom</a>
|
|
105
|
+
|
|
106
|
+
<li><a href="../Atom/Collection.html">Atom::Collection</a>
|
|
107
|
+
|
|
108
|
+
<li><a href="../Atom/Element.html">Atom::Element</a>
|
|
109
|
+
|
|
110
|
+
<li><a href="../Atom/Entry.html">Atom::Entry</a>
|
|
111
|
+
|
|
112
|
+
<li><a href="../Atom/Feed.html">Atom::Feed</a>
|
|
113
|
+
|
|
114
|
+
<li><a href="../Atom/Service.html">Atom::Service</a>
|
|
115
|
+
|
|
116
|
+
<li><a href="../REXML.html">REXML</a>
|
|
117
|
+
|
|
118
|
+
<li><a href="../REXML/Element.html">REXML::Element</a>
|
|
119
|
+
|
|
120
|
+
<li><a href="../Object.html">Object</a>
|
|
121
|
+
|
|
122
|
+
</ul>
|
|
123
|
+
</nav>
|
|
124
|
+
|
|
125
|
+
</div>
|
|
126
|
+
</nav>
|
|
127
|
+
|
|
128
|
+
<div id="documentation">
|
|
129
|
+
<h1 class="module">module Sword2Ruby::Atom</h1>
|
|
130
|
+
|
|
131
|
+
<div id="description" class="description">
|
|
132
|
+
|
|
133
|
+
<p>Extensions to the <a href="https://github.com/bct/atom-tools/wiki">Atom
|
|
134
|
+
module</a> to support Sword2 operations. These methods are additive to
|
|
135
|
+
those supplied by the atom-tools gem.</p>
|
|
136
|
+
|
|
137
|
+
<p>For more information on the <a
|
|
138
|
+
href="https://github.com/bct/atom-tools/wiki">Atom module</a>, please see
|
|
139
|
+
the <a
|
|
140
|
+
href="http://rdoc.info/github/bct/atom-tools/master/frames">atom-tools
|
|
141
|
+
documentation</a> for a complete list of attributes and methods.</p>
|
|
142
|
+
|
|
143
|
+
</div><!-- description -->
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
<!-- Methods -->
|
|
158
|
+
|
|
159
|
+
</section><!-- 5Buntitled-5D -->
|
|
160
|
+
|
|
161
|
+
</div><!-- documentation -->
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
<footer id="validator-badges">
|
|
165
|
+
<p><a href="http://validator.w3.org/check/referer">[Validate]</a>
|
|
166
|
+
<p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.
|
|
167
|
+
<p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
|
|
168
|
+
</footer>
|
|
169
|
+
|
|
@@ -0,0 +1,327 @@
|
|
|
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::AutoDiscover - 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/auto_discover.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::AutoDiscover</h1>
|
|
146
|
+
|
|
147
|
+
<div id="description" class="description">
|
|
148
|
+
|
|
149
|
+
<p><a href="AutoDiscover.html">AutoDiscover</a> requires the <a
|
|
150
|
+
href="https://github.com/hpricot/hpricot/wiki">hpricot</a> gem.</p>
|
|
151
|
+
|
|
152
|
+
</div><!-- description -->
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
<!-- Attributes -->
|
|
166
|
+
<section id="attribute-method-details" class="method-section section">
|
|
167
|
+
<h3 class="section-header">Attributes</h3>
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
<div id="attribute-i-deposit_endpoint_uri" class="method-detail">
|
|
171
|
+
<div class="method-heading attribute-method-heading">
|
|
172
|
+
<span class="method-name">deposit_endpoint_uri</span><span
|
|
173
|
+
class="attribute-access-type">[R]</span>
|
|
174
|
+
</div>
|
|
175
|
+
|
|
176
|
+
<div class="method-description">
|
|
177
|
+
|
|
178
|
+
<p>The Deposit Endpoint URI string discovered in the HTML document, or nil if
|
|
179
|
+
it could not be discovered.</p>
|
|
180
|
+
|
|
181
|
+
<p>For more information, see the Sword2 specification: <a
|
|
182
|
+
href="http://sword-app.svn.sourceforge.net/viewvc/sword-app/spec/tags/sword-2.0/SWORDProfile.html?revision=377#autodiscovery_deposit">section
|
|
183
|
+
13.2. “For Deposit Endpoints”</a>.</p>
|
|
184
|
+
|
|
185
|
+
</div>
|
|
186
|
+
</div>
|
|
187
|
+
|
|
188
|
+
<div id="attribute-i-entry_edit_uris" class="method-detail">
|
|
189
|
+
<div class="method-heading attribute-method-heading">
|
|
190
|
+
<span class="method-name">entry_edit_uris</span><span
|
|
191
|
+
class="attribute-access-type">[R]</span>
|
|
192
|
+
</div>
|
|
193
|
+
|
|
194
|
+
<div class="method-description">
|
|
195
|
+
|
|
196
|
+
<p>An array of <a href="Atom.html">Atom</a> Entry Edit URI hashes discovered
|
|
197
|
+
in the HTML document, or an empty array [ ] if none found.</p>
|
|
198
|
+
|
|
199
|
+
<h3 id="attribute-i-entry_edit_uris-label-Example">Example</h3>
|
|
200
|
+
|
|
201
|
+
<pre class="ruby">[ {:<span class="ruby-identifier">href=</span><span class="ruby-operator">></span><span class="ruby-string">"http://some.url.org/edit/mycollection"</span>, <span class="ruby-identifier">type</span>=<span class="ruby-operator">></span><span class="ruby-keyword">nil</span>} ]
|
|
202
|
+
</pre>
|
|
203
|
+
|
|
204
|
+
<p>For more information, see the Sword2 specification: <a
|
|
205
|
+
href="http://sword-app.svn.sourceforge.net/viewvc/sword-app/spec/tags/sword-2.0/SWORDProfile.html?revision=377#autodiscovery_resources">section
|
|
206
|
+
13.3. “For Resources”</a>. attr_reader :resource_edit_uris</p>
|
|
207
|
+
|
|
208
|
+
</div>
|
|
209
|
+
</div>
|
|
210
|
+
|
|
211
|
+
<div id="attribute-i-service_document_uri" class="method-detail">
|
|
212
|
+
<div class="method-heading attribute-method-heading">
|
|
213
|
+
<span class="method-name">service_document_uri</span><span
|
|
214
|
+
class="attribute-access-type">[R]</span>
|
|
215
|
+
</div>
|
|
216
|
+
|
|
217
|
+
<div class="method-description">
|
|
218
|
+
|
|
219
|
+
<p>The Service Document URI string discovered in the HTML document, or nil if
|
|
220
|
+
it could not be discovered.</p>
|
|
221
|
+
|
|
222
|
+
<p>For more information, see the Sword2 specification: <a
|
|
223
|
+
href="http://sword-app.svn.sourceforge.net/viewvc/sword-app/spec/tags/sword-2.0/SWORDProfile.html?revision=377#autodiscovery_servicedocuments">section
|
|
224
|
+
13.1. “For Service Documents”</a>.</p>
|
|
225
|
+
|
|
226
|
+
</div>
|
|
227
|
+
</div>
|
|
228
|
+
|
|
229
|
+
<div id="attribute-i-sword_statement_links" class="method-detail">
|
|
230
|
+
<div class="method-heading attribute-method-heading">
|
|
231
|
+
<span class="method-name">sword_statement_links</span><span
|
|
232
|
+
class="attribute-access-type">[R]</span>
|
|
233
|
+
</div>
|
|
234
|
+
|
|
235
|
+
<div class="method-description">
|
|
236
|
+
|
|
237
|
+
<p>An array of Sword Statement URI hashes discovered in the HTML document, or
|
|
238
|
+
an empty array [ ] if none found.</p>
|
|
239
|
+
|
|
240
|
+
<h3 id="attribute-i-sword_statement_links-label-Example">Example</h3>
|
|
241
|
+
|
|
242
|
+
<pre class="ruby">[ {:<span class="ruby-identifier">href=</span><span class="ruby-operator">></span><span class="ruby-string">"http://some.url.org/myfeed.atom"</span>, <span class="ruby-identifier">type</span>=<span class="ruby-operator">></span><span class="ruby-string">"application/atom+xml;type=feed"</span>},
|
|
243
|
+
{:<span class="ruby-identifier">href=</span><span class="ruby-operator">></span><span class="ruby-string">"http://some.url.org/myfeed.rdf"</span>, <span class="ruby-identifier">type</span>=<span class="ruby-operator">></span><span class="ruby-string">"application/rdf+xml"</span>} ]
|
|
244
|
+
</pre>
|
|
245
|
+
|
|
246
|
+
<p>For more information, see the Sword2 specification: <a
|
|
247
|
+
href="http://sword-app.svn.sourceforge.net/viewvc/sword-app/spec/tags/sword-2.0/SWORDProfile.html?revision=377#autodiscovery_resources">section
|
|
248
|
+
13.3. “For Resources”</a>.</p>
|
|
249
|
+
|
|
250
|
+
</div>
|
|
251
|
+
</div>
|
|
252
|
+
|
|
253
|
+
</section><!-- attribute-method-details -->
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
<!-- Methods -->
|
|
257
|
+
|
|
258
|
+
<section id="public-class-5Buntitled-5D-method-details" class="method-section section">
|
|
259
|
+
<h3 class="section-header">Public Class Methods</h3>
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
<div id="method-c-new" class="method-detail ">
|
|
263
|
+
|
|
264
|
+
<div class="method-heading">
|
|
265
|
+
<span class="method-name">new</span><span
|
|
266
|
+
class="method-args">(discover_uri)</span>
|
|
267
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
268
|
+
</div>
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
<div class="method-description">
|
|
272
|
+
|
|
273
|
+
<p>Perform an Auto-Discovery on the URI supplied (which should point to an
|
|
274
|
+
html document). The document will be retreived and parsed using hpricot.
|
|
275
|
+
Service Document, Deposit Endpoint and Resource URIs will be extracted
|
|
276
|
+
where identified.</p>
|
|
277
|
+
|
|
278
|
+
<p>For more information, see the Sword2 specification: <a
|
|
279
|
+
href="http://sword-app.svn.sourceforge.net/viewvc/sword-app/spec/tags/sword-2.0/SWORDProfile.html?revision=377#autodiscovery">section
|
|
280
|
+
13 “Auto-Discovery”</a>.</p>
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
<div class="method-source-code" id="new-source">
|
|
285
|
+
<pre><span class="ruby-comment"># File lib/sword2ruby/auto_discover.rb, line 40</span>
|
|
286
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">discover_uri</span>)
|
|
287
|
+
<span class="ruby-identifier">doc</span> = <span class="ruby-constant">Hpricot</span>(<span class="ruby-identifier">open</span>(<span class="ruby-identifier">discover_uri</span>))
|
|
288
|
+
|
|
289
|
+
<span class="ruby-ivar">@service_document_uri</span> = <span class="ruby-identifier">get_attribute</span>(<span class="ruby-identifier">doc</span>.<span class="ruby-identifier">at</span>(<span class="ruby-string">"//link[@rel='http://purl.org/net/sword/discovery/service-document']"</span>), <span class="ruby-string">"href"</span>)
|
|
290
|
+
<span class="ruby-ivar">@service_document_uri</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">get_attribute</span>(<span class="ruby-identifier">doc</span>.<span class="ruby-identifier">at</span>(<span class="ruby-string">"//link[@rel='sword']"</span>), <span class="ruby-string">"href"</span>) <span class="ruby-comment">#Old sword 1.3</span>
|
|
291
|
+
|
|
292
|
+
<span class="ruby-ivar">@deposit_endpoint_uri</span> = <span class="ruby-identifier">get_attribute</span>(<span class="ruby-identifier">doc</span>.<span class="ruby-identifier">at</span>(<span class="ruby-string">"//link[@rel='http://purl.org/net/sword/terms/deposit']"</span>), <span class="ruby-string">"href"</span>)
|
|
293
|
+
|
|
294
|
+
<span class="ruby-ivar">@entry_edit_uris</span> = []
|
|
295
|
+
<span class="ruby-ivar">@sword_statement_links</span> = []
|
|
296
|
+
|
|
297
|
+
<span class="ruby-identifier">doc</span>.<span class="ruby-identifier">search</span>(<span class="ruby-string">"//link[@rel='http://purl.org/net/sword/terms/edit']"</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">e</span><span class="ruby-operator">|</span>
|
|
298
|
+
<span class="ruby-ivar">@entry_edit_uris</span> <span class="ruby-operator"><<</span> {<span class="ruby-value">:href</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">get_attribute</span>(<span class="ruby-identifier">e</span>, <span class="ruby-string">"href"</span>), <span class="ruby-value">:type=</span><span class="ruby-operator">></span> <span class="ruby-identifier">get_attribute</span>(<span class="ruby-identifier">e</span>, <span class="ruby-string">"type"</span>)}
|
|
299
|
+
<span class="ruby-keyword">end</span>
|
|
300
|
+
|
|
301
|
+
<span class="ruby-identifier">doc</span>.<span class="ruby-identifier">search</span>(<span class="ruby-string">"//link[@rel='http://purl.org/net/sword/terms/statement']"</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">e</span><span class="ruby-operator">|</span>
|
|
302
|
+
<span class="ruby-ivar">@sword_statement_links</span> <span class="ruby-operator"><<</span> {<span class="ruby-value">:href</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">get_attribute</span>(<span class="ruby-identifier">e</span>, <span class="ruby-string">"href"</span>), <span class="ruby-value">:type=</span><span class="ruby-operator">></span> <span class="ruby-identifier">get_attribute</span>(<span class="ruby-identifier">e</span>, <span class="ruby-string">"type"</span>)}
|
|
303
|
+
<span class="ruby-keyword">end</span>
|
|
304
|
+
<span class="ruby-keyword">end</span></pre>
|
|
305
|
+
</div><!-- new-source -->
|
|
306
|
+
|
|
307
|
+
</div>
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
</div><!-- new-method -->
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
</section><!-- public-class-method-details -->
|
|
316
|
+
|
|
317
|
+
</section><!-- 5Buntitled-5D -->
|
|
318
|
+
|
|
319
|
+
</div><!-- documentation -->
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
<footer id="validator-badges">
|
|
323
|
+
<p><a href="http://validator.w3.org/check/referer">[Validate]</a>
|
|
324
|
+
<p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.
|
|
325
|
+
<p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
|
|
326
|
+
</footer>
|
|
327
|
+
|