ed_fi_client 0.1.0 → 0.1.1

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 (28) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +2 -2
  3. data/docs/EdFi.html +6 -4
  4. data/docs/EdFi/Client.html +94 -72
  5. data/docs/EdFi/Client/AccessToken.html +15 -15
  6. data/docs/EdFi/Client/ArgumentError.html +3 -3
  7. data/docs/EdFi/Client/Auth.html +39 -33
  8. data/docs/EdFi/Client/Error.html +3 -3
  9. data/docs/EdFi/Client/Proxy.html +18 -18
  10. data/docs/EdFi/Client/Response.html +36 -22
  11. data/docs/EdFi/Client/UnableToAuthenticateError.html +3 -3
  12. data/docs/_index.html +4 -4
  13. data/docs/css/style.css +4 -7
  14. data/docs/file.README.html +95 -24
  15. data/docs/frames.html +1 -1
  16. data/docs/index.html +95 -24
  17. data/docs/js/app.js +44 -0
  18. data/docs/method_list.html +32 -32
  19. data/docs/top-level-namespace.html +3 -3
  20. data/lib/ed_fi/client.rb +2 -0
  21. data/lib/ed_fi/client/access_token.rb +1 -0
  22. data/lib/ed_fi/client/auth.rb +1 -0
  23. data/lib/ed_fi/client/errors.rb +1 -0
  24. data/lib/ed_fi/client/proxy.rb +1 -0
  25. data/lib/ed_fi/client/response.rb +1 -0
  26. data/lib/ed_fi/client/version.rb +1 -1
  27. data/lib/ed_fi_client.rb +2 -0
  28. metadata +2 -2
data/docs/_index.html CHANGED
@@ -4,7 +4,7 @@
4
4
  <meta charset="utf-8">
5
5
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
6
  <title>
7
- Documentation by YARD 0.9.12
7
+ Documentation by YARD 0.9.14
8
8
 
9
9
  </title>
10
10
 
@@ -52,7 +52,7 @@
52
52
  <div class="clear"></div>
53
53
  </div>
54
54
 
55
- <div id="content"><h1 class="noborder title">Documentation by YARD 0.9.12</h1>
55
+ <div id="content"><h1 class="noborder title">Documentation by YARD 0.9.14</h1>
56
56
  <div id="listing">
57
57
  <h1 class="alphaindex">Alphabetic Index</h1>
58
58
 
@@ -193,9 +193,9 @@
193
193
  </div>
194
194
 
195
195
  <div id="footer">
196
- Generated on Thu May 24 18:35:37 2018 by
196
+ Generated on Thu Jun 21 17:02:41 2018 by
197
197
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
198
- 0.9.12 (ruby-2.5.1).
198
+ 0.9.14 (ruby-2.5.1).
199
199
  </div>
200
200
 
201
201
  </div>
data/docs/css/style.css CHANGED
@@ -245,6 +245,7 @@ ul.toplevel { list-style: none; padding-left: 0; font-size: 1.1em; }
245
245
 
246
246
  dl.constants { margin-left: 10px; }
247
247
  dl.constants dt { font-weight: bold; font-size: 1.1em; margin-bottom: 5px; }
248
+ dl.constants.compact dt { display: inline-block; font-weight: normal }
248
249
  dl.constants dd { width: 75%; white-space: pre; font-family: monospace; margin-bottom: 18px; }
249
250
  dl.constants .docstring .note:first-child { margin-top: 5px; }
250
251
 
@@ -326,13 +327,9 @@ ul.summary a, ul.summary a:visited {
326
327
  text-decoration: none; font-size: 1.1em;
327
328
  }
328
329
  ul.summary li { margin-bottom: 5px; }
329
- .summary .summary_signature {
330
- padding: 4px 8px;
331
- background: #f8f8f8;
332
- border: 1px solid #f0f0f0;
333
- border-radius: 5px;
334
- }
330
+ .summary_signature { padding: 4px 8px; background: #f8f8f8; border: 1px solid #f0f0f0; border-radius: 5px; }
335
331
  .summary_signature:hover { background: #CFEBFF; border-color: #A4CCDA; cursor: pointer; }
332
+ .summary_signature.deprecated { background: #ffe5e5; border-color: #e9dada; }
336
333
  ul.summary.compact li { display: inline-block; margin: 0px 5px 0px 0px; line-height: 2.6em;}
337
334
  ul.summary.compact .summary_signature { padding: 5px 7px; padding-right: 4px; }
338
335
  #content .summary_signature:hover a,
@@ -485,7 +482,7 @@ pre.code .rubyid_nth_ref { color: #6D79DE; }
485
482
  pre.code .regexp, .dregexp { color: #036A07; }
486
483
  pre.code a { border-bottom: 1px dotted #bbf; }
487
484
  /* inline code */
488
- p > code {
485
+ *:not(pre) > code {
489
486
  padding: 1px 3px 1px 3px;
490
487
  border: 1px solid #E1E1E8;
491
488
  background: #F7F7F9;
data/docs/file.README.html CHANGED
@@ -6,7 +6,7 @@
6
6
  <title>
7
7
  File: README
8
8
 
9
- &mdash; Documentation by YARD 0.9.12
9
+ &mdash; Documentation by YARD 0.9.14
10
10
 
11
11
  </title>
12
12
 
@@ -58,14 +58,10 @@
58
58
  </div>
59
59
 
60
60
  <div id="content"><div id='filecontents'>
61
- <h1 id="label-EdFiClient">EdFiClient</h1>
61
+ <h1 id="label-EdFi-3A-3AClient+rdoc-image-3Ahttps-3A-2F-2Fbadge.fury.io-2Frb-2Fed_fi_client.svg">EdFi::Client <a href="https://badge.fury.io/rb/ed_fi_client"><img src="https://badge.fury.io/rb/ed_fi_client.svg"></a></h1>
62
62
 
63
- <p>Welcome to your new gem! In this directory, you&#39;ll find the files you
64
- need to be able to package up your Ruby library into a gem. Put your Ruby
65
- code in the file <code>lib/ed_fi_client</code>. To experiment with that
66
- code, run <code>bin/console</code> for an interactive prompt.</p>
67
-
68
- <p>TODO: Delete this and the text above, and describe your gem</p>
63
+ <p>A utility class for authenticating to and making CRUD calls against an
64
+ Ed-Fi ODS API.</p>
69
65
 
70
66
  <h2 id="label-Installation">Installation</h2>
71
67
 
@@ -84,28 +80,103 @@ code, run <code>bin/console</code> for an interactive prompt.</p>
84
80
  <pre class="code ruby"><code class="ruby">$ gem install ed_fi_client
85
81
  </code></pre>
86
82
 
87
- <h2 id="label-Usage">Usage</h2>
83
+ <h2 id="label-Using+EdFi-3A-3AClient">Using EdFi::Client</h2>
84
+
85
+ <h3 id="label-Basic+Usage-3A+Reading+Data">Basic Usage: Reading Data</h3>
86
+
87
+ <pre class="code ruby"><code class="ruby"><span class='comment'>## Establish a connection to an Ed-Fi ODS / API.
88
+ </span><span class='comment'>## (We&#39;ll use the Alliance-hosted Ed-Fi ODS / API sandbox instance.)
89
+ </span>
90
+ <span class='id identifier rubyid_sandbox'>sandbox</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="EdFi.html" title="EdFi (module)">EdFi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="EdFi/Client.html" title="EdFi::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="EdFi/Client.html#initialize-instance_method" title="EdFi::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span>
91
+ <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>https://api.ed-fi.org/api/</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
92
+ <span class='label'>client_id:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>RvcohKz9zHI4</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
93
+ <span class='label'>client_secret:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>E1iEFusaNf81xzCxwHfbolkC</span><span class='tstring_end'>&#39;</span></span>
94
+ <span class='rparen'>)</span>
95
+
96
+ <span class='id identifier rubyid_sandbox'>sandbox</span> <span class='op'>=</span> <span class='id identifier rubyid_sandbox'>sandbox</span><span class='period'>.</span><span class='id identifier rubyid_v2'>v2</span><span class='lparen'>(</span><span class='int'>2017</span><span class='rparen'>)</span> <span class='comment'>## For purposes of these samples, we&#39;re only
97
+ </span> <span class='comment'>## concerned with 2017-2018 school-year data.
98
+ </span>
99
+
100
+ <span class='comment'>## Let&#39;s pull some assorted values!
101
+ </span>
102
+ <span class='id identifier rubyid_sandbox'>sandbox</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>schools</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>query:</span> <span class='lbrace'>{</span> <span class='label'>school_id:</span> <span class='int'>255901001</span> <span class='rbrace'>}</span><span class='rparen'>)</span> <span class='comment'>## Get school 255901001.
103
+ </span>
104
+ <span class='id identifier rubyid_sandbox'>sandbox</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>disciplineIncidents</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span> <span class='comment'>## Get all discipline incidents.
105
+ </span><span class='id identifier rubyid_sandbox'>sandbox</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>disciplineIncidents</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_sample'>sample</span><span class='period'>.</span><span class='id identifier rubyid_school'>school</span> <span class='comment'>## A random incident&#39;s school.
106
+ </span>
107
+ <span class='id identifier rubyid_all_schools'>all_schools</span> <span class='op'>=</span> <span class='id identifier rubyid_sandbox'>sandbox</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>schools</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span> <span class='comment'>## All schools.
108
+ </span><span class='id identifier rubyid_all_schools'>all_schools</span><span class='period'>.</span><span class='id identifier rubyid_sample'>sample</span><span class='period'>.</span><span class='id identifier rubyid_name_of_institution'>name_of_institution</span> <span class='comment'>## A random school&#39;s name.
109
+ </span><span class='id identifier rubyid_all_schools'>all_schools</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_i'>i</span><span class='op'>|</span> <span class='lbracket'>[</span><span class='id identifier rubyid_i'>i</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='id identifier rubyid_i'>i</span><span class='period'>.</span><span class='id identifier rubyid_school_id'>school_id</span><span class='rbracket'>]</span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_h'>to_h</span> <span class='comment'>## Maps ODS IDs to school IDs.
110
+ </span></code></pre>
111
+ <hr>
112
+
113
+ <h3 id="label-Basic+Usage-3A+Writing+Data">Basic Usage: Writing Data</h3>
114
+
115
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_sandbox'>sandbox</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="EdFi.html" title="EdFi (module)">EdFi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="EdFi/Client.html" title="EdFi::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="EdFi/Client.html#initialize-instance_method" title="EdFi::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span>
116
+ <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>https://api.ed-fi.org/api/</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
117
+ <span class='label'>client_id:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>RvcohKz9zHI4</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
118
+ <span class='label'>client_secret:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>E1iEFusaNf81xzCxwHfbolkC</span><span class='tstring_end'>&#39;</span></span>
119
+ <span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_v2'><span class='object_link'><a href="EdFi/Client.html#v2-instance_method" title="EdFi::Client#v2 (method)">v2</a></span></span><span class='lparen'>(</span><span class='int'>2017</span><span class='rparen'>)</span>
120
+
121
+ <span class='id identifier rubyid_school'>school</span> <span class='op'>=</span> <span class='id identifier rubyid_sandbox'>sandbox</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>schools</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_sample'>sample</span>
122
+ <span class='id identifier rubyid_original_name'>original_name</span> <span class='op'>=</span> <span class='id identifier rubyid_school'>school</span><span class='period'>.</span><span class='id identifier rubyid_name_of_institution'>name_of_institution</span> <span class='comment'>## So we can leave it like we found it.
123
+ </span>
124
+
125
+ <span class='comment'>## Via PUT ...
126
+ </span>
127
+ <span class='id identifier rubyid_school'>school</span><span class='period'>.</span><span class='id identifier rubyid_name_of_institution'>name_of_institution</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>New Name, via PUT</span><span class='tstring_end'>&#39;</span></span>
128
+ <span class='id identifier rubyid_sandbox'>sandbox</span><span class='period'>.</span><span class='id identifier rubyid_put'>put</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>schools/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_school'>school</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>payload:</span> <span class='id identifier rubyid_school'>school</span><span class='rparen'>)</span>
129
+ <span class='id identifier rubyid_sandbox'>sandbox</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>schools/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_school'>school</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_name_of_institution'>name_of_institution</span> <span class='comment'>## =&gt; &quot;New Name, via PUT&quot;
130
+ </span>
131
+
132
+ <span class='comment'>## Via POST ...
133
+ </span>
134
+ <span class='id identifier rubyid_school'>school</span><span class='period'>.</span><span class='id identifier rubyid_name_of_institution'>name_of_institution</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>New Name, via POST</span><span class='tstring_end'>&#39;</span></span>
135
+ <span class='id identifier rubyid_sandbox'>sandbox</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>schools</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>payload:</span> <span class='id identifier rubyid_school'>school</span><span class='period'>.</span><span class='id identifier rubyid_except'>except</span><span class='lparen'>(</span><span class='symbol'>:id</span><span class='rparen'>)</span><span class='rparen'>)</span>
136
+ <span class='id identifier rubyid_sandbox'>sandbox</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>schools/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_school'>school</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_name_of_institution'>name_of_institution</span> <span class='comment'>## =&gt; &quot;New Name, via POST&quot;
137
+ </span>
138
+
139
+ <span class='comment'>## Let&#39;s leave things like we found them.
140
+ </span>
141
+ <span class='id identifier rubyid_school'>school</span><span class='period'>.</span><span class='id identifier rubyid_name_of_institution'>name_of_institution</span> <span class='op'>=</span> <span class='id identifier rubyid_original_name'>original_name</span>
142
+ <span class='id identifier rubyid_sandbox'>sandbox</span><span class='period'>.</span><span class='id identifier rubyid_put'>put</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>schools/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_school'>school</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>payload:</span> <span class='id identifier rubyid_school'>school</span><span class='rparen'>)</span>
143
+ </code></pre>
144
+ <hr>
145
+
146
+ <p><a
147
+ href="http://nestor-custodio.github.io/ed_fi_client/EdFi/Client.html">Consult
148
+ the repo docs for the full EdFi::Client documentation.</a></p>
88
149
 
89
- <p>TODO: Write usage instructions here</p>
150
+ <h2 id="label-Feature+Roadmap+-2F+Future+Development">Feature Roadmap / Future Development</h2>
90
151
 
91
- <h2 id="label-Development">Development</h2>
152
+ <p>Additional features/options coming in the future:</p>
153
+ <ul><li>
154
+ <p>Cleaner handling of non-body-returning calls.</p>
155
+ </li><li>
156
+ <p>Use the given base endpoint&#39;s Swagger API definition file (if present)
157
+ to make collections/resources more easily reachable: <code>#schools</code>,
158
+ <code>#discipline_incidents</code>, etc.</p>
159
+ </li><li>
160
+ <p>Allow for easier manipulation of resources via AR-like methods
161
+ (<code>#find</code>, <code>#find_by</code>, <code>#where</code>,
162
+ <code>#create</code>, <code>#update</code>, etc).</p>
163
+ </li></ul>
164
+
165
+ <h2 id="label-Contribution+-2F+Development">Contribution / Development</h2>
166
+
167
+ <p>Bug reports and pull requests are welcome on GitHub at <a
168
+ href="https://github.com/nestor-custodio/ed_fi_client">github.com/nestor-custodio/ed_fi_client</a>.</p>
92
169
 
93
170
  <p>After checking out the repo, run <code>bin/setup</code> to install
94
171
  dependencies. Then, run <code>rake spec</code> to run the tests. You can
95
172
  also run <code>bin/console</code> for an interactive prompt that will allow
96
173
  you to experiment.</p>
97
174
 
98
- <p>To install this gem onto your local machine, run <code>bundle exec rake
99
- install</code>. To release a new version, update the version number in
100
- <code>version.rb</code>, and then run <code>bundle exec rake
101
- release</code>, which will create a git tag for the version, push git
102
- commits and tags, and push the <code>.gem</code> file to <a
103
- href="https://rubygems.org">rubygems.org</a>.</p>
104
-
105
- <h2 id="label-Contributing">Contributing</h2>
106
-
107
- <p>Bug reports and pull requests are welcome on GitHub at <a
108
- href="https://github.com/[USERNAME]/ed_fi_client">github.com/[USERNAME]/ed_fi_client</a>.</p>
175
+ <p>Linting is courtesy of <a
176
+ href="https://github.com/bbatsov/rubocop">Rubocop</a> and documentation is
177
+ built using <a href="https://yardoc.org/">Yard</a>. Neither is included in
178
+ the Gemspec; you&#39;ll need to install these locally (<code>gem install
179
+ rubocop yard</code>) to take advantage.</p>
109
180
 
110
181
  <h2 id="label-License">License</h2>
111
182
 
@@ -114,9 +185,9 @@ href="https://opensource.org/licenses/MIT">MIT License</a>.</p>
114
185
  </div></div>
115
186
 
116
187
  <div id="footer">
117
- Generated on Thu May 24 18:35:37 2018 by
188
+ Generated on Thu Jun 21 17:02:41 2018 by
118
189
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
119
- 0.9.12 (ruby-2.5.1).
190
+ 0.9.14 (ruby-2.5.1).
120
191
  </div>
121
192
 
122
193
  </div>
data/docs/frames.html CHANGED
@@ -2,7 +2,7 @@
2
2
  <html>
3
3
  <head>
4
4
  <meta charset="utf-8">
5
- <title>Documentation by YARD 0.9.12</title>
5
+ <title>Documentation by YARD 0.9.14</title>
6
6
  </head>
7
7
  <script type="text/javascript" charset="utf-8">
8
8
  var match = unescape(window.location.hash).match(/^#!(.+)/);
data/docs/index.html CHANGED
@@ -6,7 +6,7 @@
6
6
  <title>
7
7
  File: README
8
8
 
9
- &mdash; Documentation by YARD 0.9.12
9
+ &mdash; Documentation by YARD 0.9.14
10
10
 
11
11
  </title>
12
12
 
@@ -58,14 +58,10 @@
58
58
  </div>
59
59
 
60
60
  <div id="content"><div id='filecontents'>
61
- <h1 id="label-EdFiClient">EdFiClient</h1>
61
+ <h1 id="label-EdFi-3A-3AClient+rdoc-image-3Ahttps-3A-2F-2Fbadge.fury.io-2Frb-2Fed_fi_client.svg">EdFi::Client <a href="https://badge.fury.io/rb/ed_fi_client"><img src="https://badge.fury.io/rb/ed_fi_client.svg"></a></h1>
62
62
 
63
- <p>Welcome to your new gem! In this directory, you&#39;ll find the files you
64
- need to be able to package up your Ruby library into a gem. Put your Ruby
65
- code in the file <code>lib/ed_fi_client</code>. To experiment with that
66
- code, run <code>bin/console</code> for an interactive prompt.</p>
67
-
68
- <p>TODO: Delete this and the text above, and describe your gem</p>
63
+ <p>A utility class for authenticating to and making CRUD calls against an
64
+ Ed-Fi ODS API.</p>
69
65
 
70
66
  <h2 id="label-Installation">Installation</h2>
71
67
 
@@ -84,28 +80,103 @@ code, run <code>bin/console</code> for an interactive prompt.</p>
84
80
  <pre class="code ruby"><code class="ruby">$ gem install ed_fi_client
85
81
  </code></pre>
86
82
 
87
- <h2 id="label-Usage">Usage</h2>
83
+ <h2 id="label-Using+EdFi-3A-3AClient">Using EdFi::Client</h2>
84
+
85
+ <h3 id="label-Basic+Usage-3A+Reading+Data">Basic Usage: Reading Data</h3>
86
+
87
+ <pre class="code ruby"><code class="ruby"><span class='comment'>## Establish a connection to an Ed-Fi ODS / API.
88
+ </span><span class='comment'>## (We&#39;ll use the Alliance-hosted Ed-Fi ODS / API sandbox instance.)
89
+ </span>
90
+ <span class='id identifier rubyid_sandbox'>sandbox</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="EdFi.html" title="EdFi (module)">EdFi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="EdFi/Client.html" title="EdFi::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="EdFi/Client.html#initialize-instance_method" title="EdFi::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span>
91
+ <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>https://api.ed-fi.org/api/</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
92
+ <span class='label'>client_id:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>RvcohKz9zHI4</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
93
+ <span class='label'>client_secret:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>E1iEFusaNf81xzCxwHfbolkC</span><span class='tstring_end'>&#39;</span></span>
94
+ <span class='rparen'>)</span>
95
+
96
+ <span class='id identifier rubyid_sandbox'>sandbox</span> <span class='op'>=</span> <span class='id identifier rubyid_sandbox'>sandbox</span><span class='period'>.</span><span class='id identifier rubyid_v2'>v2</span><span class='lparen'>(</span><span class='int'>2017</span><span class='rparen'>)</span> <span class='comment'>## For purposes of these samples, we&#39;re only
97
+ </span> <span class='comment'>## concerned with 2017-2018 school-year data.
98
+ </span>
99
+
100
+ <span class='comment'>## Let&#39;s pull some assorted values!
101
+ </span>
102
+ <span class='id identifier rubyid_sandbox'>sandbox</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>schools</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>query:</span> <span class='lbrace'>{</span> <span class='label'>school_id:</span> <span class='int'>255901001</span> <span class='rbrace'>}</span><span class='rparen'>)</span> <span class='comment'>## Get school 255901001.
103
+ </span>
104
+ <span class='id identifier rubyid_sandbox'>sandbox</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>disciplineIncidents</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span> <span class='comment'>## Get all discipline incidents.
105
+ </span><span class='id identifier rubyid_sandbox'>sandbox</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>disciplineIncidents</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_sample'>sample</span><span class='period'>.</span><span class='id identifier rubyid_school'>school</span> <span class='comment'>## A random incident&#39;s school.
106
+ </span>
107
+ <span class='id identifier rubyid_all_schools'>all_schools</span> <span class='op'>=</span> <span class='id identifier rubyid_sandbox'>sandbox</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>schools</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span> <span class='comment'>## All schools.
108
+ </span><span class='id identifier rubyid_all_schools'>all_schools</span><span class='period'>.</span><span class='id identifier rubyid_sample'>sample</span><span class='period'>.</span><span class='id identifier rubyid_name_of_institution'>name_of_institution</span> <span class='comment'>## A random school&#39;s name.
109
+ </span><span class='id identifier rubyid_all_schools'>all_schools</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_i'>i</span><span class='op'>|</span> <span class='lbracket'>[</span><span class='id identifier rubyid_i'>i</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='id identifier rubyid_i'>i</span><span class='period'>.</span><span class='id identifier rubyid_school_id'>school_id</span><span class='rbracket'>]</span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_h'>to_h</span> <span class='comment'>## Maps ODS IDs to school IDs.
110
+ </span></code></pre>
111
+ <hr>
112
+
113
+ <h3 id="label-Basic+Usage-3A+Writing+Data">Basic Usage: Writing Data</h3>
114
+
115
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_sandbox'>sandbox</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="EdFi.html" title="EdFi (module)">EdFi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="EdFi/Client.html" title="EdFi::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="EdFi/Client.html#initialize-instance_method" title="EdFi::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span>
116
+ <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>https://api.ed-fi.org/api/</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
117
+ <span class='label'>client_id:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>RvcohKz9zHI4</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
118
+ <span class='label'>client_secret:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>E1iEFusaNf81xzCxwHfbolkC</span><span class='tstring_end'>&#39;</span></span>
119
+ <span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_v2'><span class='object_link'><a href="EdFi/Client.html#v2-instance_method" title="EdFi::Client#v2 (method)">v2</a></span></span><span class='lparen'>(</span><span class='int'>2017</span><span class='rparen'>)</span>
120
+
121
+ <span class='id identifier rubyid_school'>school</span> <span class='op'>=</span> <span class='id identifier rubyid_sandbox'>sandbox</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>schools</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_sample'>sample</span>
122
+ <span class='id identifier rubyid_original_name'>original_name</span> <span class='op'>=</span> <span class='id identifier rubyid_school'>school</span><span class='period'>.</span><span class='id identifier rubyid_name_of_institution'>name_of_institution</span> <span class='comment'>## So we can leave it like we found it.
123
+ </span>
124
+
125
+ <span class='comment'>## Via PUT ...
126
+ </span>
127
+ <span class='id identifier rubyid_school'>school</span><span class='period'>.</span><span class='id identifier rubyid_name_of_institution'>name_of_institution</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>New Name, via PUT</span><span class='tstring_end'>&#39;</span></span>
128
+ <span class='id identifier rubyid_sandbox'>sandbox</span><span class='period'>.</span><span class='id identifier rubyid_put'>put</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>schools/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_school'>school</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>payload:</span> <span class='id identifier rubyid_school'>school</span><span class='rparen'>)</span>
129
+ <span class='id identifier rubyid_sandbox'>sandbox</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>schools/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_school'>school</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_name_of_institution'>name_of_institution</span> <span class='comment'>## =&gt; &quot;New Name, via PUT&quot;
130
+ </span>
131
+
132
+ <span class='comment'>## Via POST ...
133
+ </span>
134
+ <span class='id identifier rubyid_school'>school</span><span class='period'>.</span><span class='id identifier rubyid_name_of_institution'>name_of_institution</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>New Name, via POST</span><span class='tstring_end'>&#39;</span></span>
135
+ <span class='id identifier rubyid_sandbox'>sandbox</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>schools</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>payload:</span> <span class='id identifier rubyid_school'>school</span><span class='period'>.</span><span class='id identifier rubyid_except'>except</span><span class='lparen'>(</span><span class='symbol'>:id</span><span class='rparen'>)</span><span class='rparen'>)</span>
136
+ <span class='id identifier rubyid_sandbox'>sandbox</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>schools/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_school'>school</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_name_of_institution'>name_of_institution</span> <span class='comment'>## =&gt; &quot;New Name, via POST&quot;
137
+ </span>
138
+
139
+ <span class='comment'>## Let&#39;s leave things like we found them.
140
+ </span>
141
+ <span class='id identifier rubyid_school'>school</span><span class='period'>.</span><span class='id identifier rubyid_name_of_institution'>name_of_institution</span> <span class='op'>=</span> <span class='id identifier rubyid_original_name'>original_name</span>
142
+ <span class='id identifier rubyid_sandbox'>sandbox</span><span class='period'>.</span><span class='id identifier rubyid_put'>put</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>schools/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_school'>school</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>payload:</span> <span class='id identifier rubyid_school'>school</span><span class='rparen'>)</span>
143
+ </code></pre>
144
+ <hr>
145
+
146
+ <p><a
147
+ href="http://nestor-custodio.github.io/ed_fi_client/EdFi/Client.html">Consult
148
+ the repo docs for the full EdFi::Client documentation.</a></p>
88
149
 
89
- <p>TODO: Write usage instructions here</p>
150
+ <h2 id="label-Feature+Roadmap+-2F+Future+Development">Feature Roadmap / Future Development</h2>
90
151
 
91
- <h2 id="label-Development">Development</h2>
152
+ <p>Additional features/options coming in the future:</p>
153
+ <ul><li>
154
+ <p>Cleaner handling of non-body-returning calls.</p>
155
+ </li><li>
156
+ <p>Use the given base endpoint&#39;s Swagger API definition file (if present)
157
+ to make collections/resources more easily reachable: <code>#schools</code>,
158
+ <code>#discipline_incidents</code>, etc.</p>
159
+ </li><li>
160
+ <p>Allow for easier manipulation of resources via AR-like methods
161
+ (<code>#find</code>, <code>#find_by</code>, <code>#where</code>,
162
+ <code>#create</code>, <code>#update</code>, etc).</p>
163
+ </li></ul>
164
+
165
+ <h2 id="label-Contribution+-2F+Development">Contribution / Development</h2>
166
+
167
+ <p>Bug reports and pull requests are welcome on GitHub at <a
168
+ href="https://github.com/nestor-custodio/ed_fi_client">github.com/nestor-custodio/ed_fi_client</a>.</p>
92
169
 
93
170
  <p>After checking out the repo, run <code>bin/setup</code> to install
94
171
  dependencies. Then, run <code>rake spec</code> to run the tests. You can
95
172
  also run <code>bin/console</code> for an interactive prompt that will allow
96
173
  you to experiment.</p>
97
174
 
98
- <p>To install this gem onto your local machine, run <code>bundle exec rake
99
- install</code>. To release a new version, update the version number in
100
- <code>version.rb</code>, and then run <code>bundle exec rake
101
- release</code>, which will create a git tag for the version, push git
102
- commits and tags, and push the <code>.gem</code> file to <a
103
- href="https://rubygems.org">rubygems.org</a>.</p>
104
-
105
- <h2 id="label-Contributing">Contributing</h2>
106
-
107
- <p>Bug reports and pull requests are welcome on GitHub at <a
108
- href="https://github.com/[USERNAME]/ed_fi_client">github.com/[USERNAME]/ed_fi_client</a>.</p>
175
+ <p>Linting is courtesy of <a
176
+ href="https://github.com/bbatsov/rubocop">Rubocop</a> and documentation is
177
+ built using <a href="https://yardoc.org/">Yard</a>. Neither is included in
178
+ the Gemspec; you&#39;ll need to install these locally (<code>gem install
179
+ rubocop yard</code>) to take advantage.</p>
109
180
 
110
181
  <h2 id="label-License">License</h2>
111
182
 
@@ -114,9 +185,9 @@ href="https://opensource.org/licenses/MIT">MIT License</a>.</p>
114
185
  </div></div>
115
186
 
116
187
  <div id="footer">
117
- Generated on Thu May 24 18:35:37 2018 by
188
+ Generated on Thu Jun 21 17:02:41 2018 by
118
189
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
119
- 0.9.12 (ruby-2.5.1).
190
+ 0.9.14 (ruby-2.5.1).
120
191
  </div>
121
192
 
122
193
  </div>
data/docs/js/app.js CHANGED
@@ -120,6 +120,49 @@ function summaryToggle() {
120
120
  } else { localStorage.summaryCollapsed = "expand"; }
121
121
  }
122
122
 
123
+ function constantSummaryToggle() {
124
+ $('.constants_summary_toggle').click(function(e) {
125
+ e.preventDefault();
126
+ localStorage.summaryCollapsed = $(this).text();
127
+ $('.constants_summary_toggle').each(function() {
128
+ $(this).text($(this).text() == "collapse" ? "expand" : "collapse");
129
+ var next = $(this).parent().parent().nextAll('dl.constants').first();
130
+ if (next.hasClass('compact')) {
131
+ next.toggle();
132
+ next.nextAll('dl.constants').first().toggle();
133
+ }
134
+ else if (next.hasClass('constants')) {
135
+ var list = $('<dl class="constants compact" />');
136
+ list.html(next.html());
137
+ list.find('dt').each(function() {
138
+ $(this).addClass('summary_signature');
139
+ $(this).text( $(this).text().split('=')[0]);
140
+ if ($(this).has(".deprecated").length) {
141
+ $(this).addClass('deprecated');
142
+ };
143
+ });
144
+ // Add the value of the constant as "Tooltip" to the summary object
145
+ list.find('pre.code').each(function() {
146
+ console.log($(this).parent());
147
+ var dt_element = $(this).parent().prev();
148
+ var tooltip = $(this).text();
149
+ if (dt_element.hasClass("deprecated")) {
150
+ tooltip = 'Deprecated. ' + tooltip;
151
+ };
152
+ dt_element.attr('title', tooltip);
153
+ });
154
+ list.find('.docstring, .tags, dd').remove();
155
+ next.before(list);
156
+ next.toggle();
157
+ }
158
+ });
159
+ return false;
160
+ });
161
+ if (localStorage.summaryCollapsed == "collapse") {
162
+ $('.constants_summary_toggle').first().click();
163
+ } else { localStorage.summaryCollapsed = "expand"; }
164
+ }
165
+
123
166
  function generateTOC() {
124
167
  if ($('#filecontents').length === 0) return;
125
168
  var _toc = $('<ol class="top"></ol>');
@@ -241,6 +284,7 @@ $(document).ready(function() {
241
284
  searchFrameButtons();
242
285
  linkSummaries();
243
286
  summaryToggle();
287
+ constantSummaryToggle();
244
288
  generateTOC();
245
289
  mainFocus();
246
290
  });
data/docs/method_list.html CHANGED
@@ -54,16 +54,16 @@
54
54
 
55
55
  <li class="even ">
56
56
  <div class="item">
57
- <span class='object_link'><a href="EdFi/Client/Proxy.html#delete-instance_method" title="EdFi::Client::Proxy#delete (method)">#delete</a></span>
58
- <small>EdFi::Client::Proxy</small>
57
+ <span class='object_link'><a href="EdFi/Client.html#delete-instance_method" title="EdFi::Client#delete (method)">#delete</a></span>
58
+ <small>EdFi::Client</small>
59
59
  </div>
60
60
  </li>
61
61
 
62
62
 
63
63
  <li class="odd ">
64
64
  <div class="item">
65
- <span class='object_link'><a href="EdFi/Client.html#delete-instance_method" title="EdFi::Client#delete (method)">#delete</a></span>
66
- <small>EdFi::Client</small>
65
+ <span class='object_link'><a href="EdFi/Client/Proxy.html#delete-instance_method" title="EdFi::Client::Proxy#delete (method)">#delete</a></span>
66
+ <small>EdFi::Client::Proxy</small>
67
67
  </div>
68
68
  </li>
69
69
 
@@ -78,80 +78,80 @@
78
78
 
79
79
  <li class="odd ">
80
80
  <div class="item">
81
- <span class='object_link'><a href="EdFi/Client/Proxy.html#get-instance_method" title="EdFi::Client::Proxy#get (method)">#get</a></span>
82
- <small>EdFi::Client::Proxy</small>
81
+ <span class='object_link'><a href="EdFi/Client.html#get-instance_method" title="EdFi::Client#get (method)">#get</a></span>
82
+ <small>EdFi::Client</small>
83
83
  </div>
84
84
  </li>
85
85
 
86
86
 
87
87
  <li class="even ">
88
88
  <div class="item">
89
- <span class='object_link'><a href="EdFi/Client.html#get-instance_method" title="EdFi::Client#get (method)">#get</a></span>
90
- <small>EdFi::Client</small>
89
+ <span class='object_link'><a href="EdFi/Client/Proxy.html#get-instance_method" title="EdFi::Client::Proxy#get (method)">#get</a></span>
90
+ <small>EdFi::Client::Proxy</small>
91
91
  </div>
92
92
  </li>
93
93
 
94
94
 
95
95
  <li class="odd ">
96
96
  <div class="item">
97
- <span class='object_link'><a href="EdFi/Client/Response.html#initialize-instance_method" title="EdFi::Client::Response#initialize (method)">#initialize</a></span>
98
- <small>EdFi::Client::Response</small>
97
+ <span class='object_link'><a href="EdFi/Client.html#initialize-instance_method" title="EdFi::Client#initialize (method)">#initialize</a></span>
98
+ <small>EdFi::Client</small>
99
99
  </div>
100
100
  </li>
101
101
 
102
102
 
103
103
  <li class="even ">
104
104
  <div class="item">
105
- <span class='object_link'><a href="EdFi/Client/AccessToken.html#initialize-instance_method" title="EdFi::Client::AccessToken#initialize (method)">#initialize</a></span>
106
- <small>EdFi::Client::AccessToken</small>
105
+ <span class='object_link'><a href="EdFi/Client/Auth.html#initialize-instance_method" title="EdFi::Client::Auth#initialize (method)">#initialize</a></span>
106
+ <small>EdFi::Client::Auth</small>
107
107
  </div>
108
108
  </li>
109
109
 
110
110
 
111
111
  <li class="odd ">
112
112
  <div class="item">
113
- <span class='object_link'><a href="EdFi/Client/Auth.html#initialize-instance_method" title="EdFi::Client::Auth#initialize (method)">#initialize</a></span>
114
- <small>EdFi::Client::Auth</small>
113
+ <span class='object_link'><a href="EdFi/Client/Response.html#initialize-instance_method" title="EdFi::Client::Response#initialize (method)">#initialize</a></span>
114
+ <small>EdFi::Client::Response</small>
115
115
  </div>
116
116
  </li>
117
117
 
118
118
 
119
119
  <li class="even ">
120
120
  <div class="item">
121
- <span class='object_link'><a href="EdFi/Client.html#initialize-instance_method" title="EdFi::Client#initialize (method)">#initialize</a></span>
122
- <small>EdFi::Client</small>
121
+ <span class='object_link'><a href="EdFi/Client/AccessToken.html#initialize-instance_method" title="EdFi::Client::AccessToken#initialize (method)">#initialize</a></span>
122
+ <small>EdFi::Client::AccessToken</small>
123
123
  </div>
124
124
  </li>
125
125
 
126
126
 
127
127
  <li class="odd ">
128
128
  <div class="item">
129
- <span class='object_link'><a href="EdFi/Client/Proxy.html#patch-instance_method" title="EdFi::Client::Proxy#patch (method)">#patch</a></span>
130
- <small>EdFi::Client::Proxy</small>
129
+ <span class='object_link'><a href="EdFi/Client.html#patch-instance_method" title="EdFi::Client#patch (method)">#patch</a></span>
130
+ <small>EdFi::Client</small>
131
131
  </div>
132
132
  </li>
133
133
 
134
134
 
135
135
  <li class="even ">
136
136
  <div class="item">
137
- <span class='object_link'><a href="EdFi/Client.html#patch-instance_method" title="EdFi::Client#patch (method)">#patch</a></span>
138
- <small>EdFi::Client</small>
137
+ <span class='object_link'><a href="EdFi/Client/Proxy.html#patch-instance_method" title="EdFi::Client::Proxy#patch (method)">#patch</a></span>
138
+ <small>EdFi::Client::Proxy</small>
139
139
  </div>
140
140
  </li>
141
141
 
142
142
 
143
143
  <li class="odd ">
144
144
  <div class="item">
145
- <span class='object_link'><a href="EdFi/Client/Proxy.html#post-instance_method" title="EdFi::Client::Proxy#post (method)">#post</a></span>
146
- <small>EdFi::Client::Proxy</small>
145
+ <span class='object_link'><a href="EdFi/Client.html#post-instance_method" title="EdFi::Client#post (method)">#post</a></span>
146
+ <small>EdFi::Client</small>
147
147
  </div>
148
148
  </li>
149
149
 
150
150
 
151
151
  <li class="even ">
152
152
  <div class="item">
153
- <span class='object_link'><a href="EdFi/Client.html#post-instance_method" title="EdFi::Client#post (method)">#post</a></span>
154
- <small>EdFi::Client</small>
153
+ <span class='object_link'><a href="EdFi/Client/Proxy.html#post-instance_method" title="EdFi::Client::Proxy#post (method)">#post</a></span>
154
+ <small>EdFi::Client::Proxy</small>
155
155
  </div>
156
156
  </li>
157
157
 
@@ -166,16 +166,16 @@
166
166
 
167
167
  <li class="even ">
168
168
  <div class="item">
169
- <span class='object_link'><a href="EdFi/Client/Proxy.html#put-instance_method" title="EdFi::Client::Proxy#put (method)">#put</a></span>
170
- <small>EdFi::Client::Proxy</small>
169
+ <span class='object_link'><a href="EdFi/Client.html#put-instance_method" title="EdFi::Client#put (method)">#put</a></span>
170
+ <small>EdFi::Client</small>
171
171
  </div>
172
172
  </li>
173
173
 
174
174
 
175
175
  <li class="odd ">
176
176
  <div class="item">
177
- <span class='object_link'><a href="EdFi/Client.html#put-instance_method" title="EdFi::Client#put (method)">#put</a></span>
178
- <small>EdFi::Client</small>
177
+ <span class='object_link'><a href="EdFi/Client/Proxy.html#put-instance_method" title="EdFi::Client::Proxy#put (method)">#put</a></span>
178
+ <small>EdFi::Client::Proxy</small>
179
179
  </div>
180
180
  </li>
181
181
 
@@ -190,16 +190,16 @@
190
190
 
191
191
  <li class="odd ">
192
192
  <div class="item">
193
- <span class='object_link'><a href="EdFi/Client/AccessToken.html#token-instance_method" title="EdFi::Client::AccessToken#token (method)">#token</a></span>
194
- <small>EdFi::Client::AccessToken</small>
193
+ <span class='object_link'><a href="EdFi/Client/Auth.html#token-instance_method" title="EdFi::Client::Auth#token (method)">#token</a></span>
194
+ <small>EdFi::Client::Auth</small>
195
195
  </div>
196
196
  </li>
197
197
 
198
198
 
199
199
  <li class="even ">
200
200
  <div class="item">
201
- <span class='object_link'><a href="EdFi/Client/Auth.html#token-instance_method" title="EdFi::Client::Auth#token (method)">#token</a></span>
202
- <small>EdFi::Client::Auth</small>
201
+ <span class='object_link'><a href="EdFi/Client/AccessToken.html#token-instance_method" title="EdFi::Client::AccessToken#token (method)">#token</a></span>
202
+ <small>EdFi::Client::AccessToken</small>
203
203
  </div>
204
204
  </li>
205
205