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.
- checksums.yaml +4 -4
- data/Gemfile.lock +2 -2
- data/docs/EdFi.html +6 -4
- data/docs/EdFi/Client.html +94 -72
- data/docs/EdFi/Client/AccessToken.html +15 -15
- data/docs/EdFi/Client/ArgumentError.html +3 -3
- data/docs/EdFi/Client/Auth.html +39 -33
- data/docs/EdFi/Client/Error.html +3 -3
- data/docs/EdFi/Client/Proxy.html +18 -18
- data/docs/EdFi/Client/Response.html +36 -22
- data/docs/EdFi/Client/UnableToAuthenticateError.html +3 -3
- data/docs/_index.html +4 -4
- data/docs/css/style.css +4 -7
- data/docs/file.README.html +95 -24
- data/docs/frames.html +1 -1
- data/docs/index.html +95 -24
- data/docs/js/app.js +44 -0
- data/docs/method_list.html +32 -32
- data/docs/top-level-namespace.html +3 -3
- data/lib/ed_fi/client.rb +2 -0
- data/lib/ed_fi/client/access_token.rb +1 -0
- data/lib/ed_fi/client/auth.rb +1 -0
- data/lib/ed_fi/client/errors.rb +1 -0
- data/lib/ed_fi/client/proxy.rb +1 -0
- data/lib/ed_fi/client/response.rb +1 -0
- data/lib/ed_fi/client/version.rb +1 -1
- data/lib/ed_fi_client.rb +2 -0
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: c59da3d3aa411bde8d463709defa33b7bbd9239fe9b5ad8cd8a52d7e58e2ed4e
|
4
|
+
data.tar.gz: 702fae4dd6f7ea2b75ae7dac1bdc6e876a5b080bf6c2e0ae6fe7d47341179cac
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 85ca58392363775ce0a8954205130b072e554c5bd9b38289a740887416cde8949849ca61ce17433e6a4997b0dc241e74eb7fd9f1f84df648fe5c9cdbd24fc83b
|
7
|
+
data.tar.gz: 2b505d9ad25f963d0b1de3f8c6e3396111b00e0d3da8989dd3dc981dbf07e87491d46d904d1037f3469a9b8183e2b22850a1e21738ed163c1a581dfba23544e8
|
data/Gemfile.lock
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
PATH
|
2
2
|
remote: .
|
3
3
|
specs:
|
4
|
-
ed_fi_client (0.1.
|
4
|
+
ed_fi_client (0.1.1)
|
5
5
|
activesupport (~> 5.2.0)
|
6
6
|
crapi (~> 0.1)
|
7
7
|
|
@@ -16,7 +16,7 @@ GEM
|
|
16
16
|
byebug (10.0.2)
|
17
17
|
coderay (1.1.2)
|
18
18
|
concurrent-ruby (1.0.5)
|
19
|
-
crapi (0.1.
|
19
|
+
crapi (0.1.3)
|
20
20
|
activesupport (~> 5.2.0)
|
21
21
|
diff-lcs (1.3)
|
22
22
|
i18n (1.0.1)
|
data/docs/EdFi.html
CHANGED
@@ -6,7 +6,7 @@
|
|
6
6
|
<title>
|
7
7
|
Module: EdFi
|
8
8
|
|
9
|
-
— Documentation by YARD 0.9.
|
9
|
+
— Documentation by YARD 0.9.14
|
10
10
|
|
11
11
|
</title>
|
12
12
|
|
@@ -78,7 +78,9 @@
|
|
78
78
|
|
79
79
|
<dl>
|
80
80
|
<dt>Defined in:</dt>
|
81
|
-
<dd>lib/ed_fi/client/version.rb
|
81
|
+
<dd>lib/ed_fi/client/version.rb<span class="defines">,<br />
|
82
|
+
lib/ed_fi/client.rb,<br /> lib/ed_fi_client.rb,<br /> lib/ed_fi/client/auth.rb,<br /> lib/ed_fi/client/proxy.rb,<br /> lib/ed_fi/client/errors.rb,<br /> lib/ed_fi/client/response.rb,<br /> lib/ed_fi/client/access_token.rb</span>
|
83
|
+
</dd>
|
82
84
|
</dl>
|
83
85
|
|
84
86
|
</div>
|
@@ -117,9 +119,9 @@ should also house future EdFi tooling.</p>
|
|
117
119
|
</div>
|
118
120
|
|
119
121
|
<div id="footer">
|
120
|
-
Generated on Thu
|
122
|
+
Generated on Thu Jun 21 17:02:42 2018 by
|
121
123
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
122
|
-
0.9.
|
124
|
+
0.9.14 (ruby-2.5.1).
|
123
125
|
</div>
|
124
126
|
|
125
127
|
</div>
|
data/docs/EdFi/Client.html
CHANGED
@@ -6,7 +6,7 @@
|
|
6
6
|
<title>
|
7
7
|
Class: EdFi::Client
|
8
8
|
|
9
|
-
— Documentation by YARD 0.9.
|
9
|
+
— Documentation by YARD 0.9.14
|
10
10
|
|
11
11
|
</title>
|
12
12
|
|
@@ -97,7 +97,7 @@
|
|
97
97
|
<dl>
|
98
98
|
<dt>Defined in:</dt>
|
99
99
|
<dd>lib/ed_fi/client.rb<span class="defines">,<br />
|
100
|
-
lib/ed_fi/client/
|
100
|
+
lib/ed_fi/client/auth.rb,<br /> lib/ed_fi/client/proxy.rb,<br /> lib/ed_fi/client/errors.rb,<br /> lib/ed_fi/client/version.rb,<br /> lib/ed_fi/client/response.rb,<br /> lib/ed_fi/client/access_token.rb</span>
|
101
101
|
</dd>
|
102
102
|
</dl>
|
103
103
|
|
@@ -131,18 +131,19 @@ generators.</p>
|
|
131
131
|
|
132
132
|
</p>
|
133
133
|
|
134
|
-
|
135
|
-
|
136
|
-
|
137
|
-
<
|
138
|
-
|
134
|
+
|
135
|
+
<h2>
|
136
|
+
Constant Summary
|
137
|
+
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
|
138
|
+
</h2>
|
139
|
+
|
140
|
+
<dl class="constants">
|
141
|
+
|
142
|
+
<dt id="PROFILE_MIME_TYPE-constant" class="">PROFILE_MIME_TYPE =
|
143
|
+
<div class="docstring">
|
139
144
|
<div class="discussion">
|
140
145
|
|
141
|
-
<p>The
|
142
|
-
|
143
|
-
<p>This should only ever be updated <em>immediately</em> before a release; the
|
144
|
-
commit that updates this value should be pushed <strong>by</strong> the
|
145
|
-
<code>rake release</code> process.</p>
|
146
|
+
<p>The “profile” header content-type template.</p>
|
146
147
|
|
147
148
|
|
148
149
|
</div>
|
@@ -151,14 +152,18 @@ commit that updates this value should be pushed <strong>by</strong> the
|
|
151
152
|
|
152
153
|
|
153
154
|
</div>
|
154
|
-
|
155
|
-
|
156
|
-
|
157
|
-
|
158
|
-
|
155
|
+
</dt>
|
156
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>application/vnd.ed-fi.%<resource>s.%<profile>s.%<access>s+json</span><span class='tstring_end'>'</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
|
157
|
+
|
158
|
+
<dt id="VERSION-constant" class="">VERSION =
|
159
|
+
<div class="docstring">
|
159
160
|
<div class="discussion">
|
160
161
|
|
161
|
-
<p>The
|
162
|
+
<p>The canonical <strong>ed_fi_client</strong> gem version.</p>
|
163
|
+
|
164
|
+
<p>This should only ever be updated <em>immediately</em> before a release; the
|
165
|
+
commit that updates this value should be pushed <strong>by</strong> the
|
166
|
+
<code>rake release</code> process.</p>
|
162
167
|
|
163
168
|
|
164
169
|
</div>
|
@@ -167,10 +172,11 @@ commit that updates this value should be pushed <strong>by</strong> the
|
|
167
172
|
|
168
173
|
|
169
174
|
</div>
|
170
|
-
|
171
|
-
|
172
|
-
|
173
|
-
|
175
|
+
</dt>
|
176
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>0.1.1</span><span class='tstring_end'>'</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
|
177
|
+
|
178
|
+
</dl>
|
179
|
+
|
174
180
|
|
175
181
|
|
176
182
|
|
@@ -384,7 +390,7 @@ calls.</p>
|
|
384
390
|
<li class="public ">
|
385
391
|
<span class="summary_signature">
|
386
392
|
|
387
|
-
<a href="#v2-instance_method" title="#v2 (instance method)">#<strong>v2</strong>(period) ⇒ EdFi::Client::Proxy </a>
|
393
|
+
<a href="#v2-instance_method" title="#v2 (instance method)">#<strong>v2</strong>(period = nil) ⇒ EdFi::Client::Proxy </a>
|
388
394
|
|
389
395
|
|
390
396
|
|
@@ -399,8 +405,8 @@ calls.</p>
|
|
399
405
|
|
400
406
|
|
401
407
|
<span class="summary_desc"><div class='inline'>
|
402
|
-
<p>Convenience proxy generator for v2.0 API access,
|
403
|
-
year you'd like to access.</p>
|
408
|
+
<p>Convenience proxy generator for v2.0 API access, also addomg the school
|
409
|
+
year you'd like to access, if given.</p>
|
404
410
|
</div></span>
|
405
411
|
|
406
412
|
</li>
|
@@ -570,8 +576,6 @@ generate headers, if any.</p>
|
|
570
576
|
<pre class="lines">
|
571
577
|
|
572
578
|
|
573
|
-
41
|
574
|
-
42
|
575
579
|
43
|
576
580
|
44
|
577
581
|
45
|
@@ -584,10 +588,12 @@ generate headers, if any.</p>
|
|
584
588
|
52
|
585
589
|
53
|
586
590
|
54
|
587
|
-
55
|
591
|
+
55
|
592
|
+
56
|
593
|
+
57</pre>
|
588
594
|
</td>
|
589
595
|
<td>
|
590
|
-
<pre class="code"><span class="info file"># File 'lib/ed_fi/client.rb', line
|
596
|
+
<pre class="code"><span class="info file"># File 'lib/ed_fi/client.rb', line 43</span>
|
591
597
|
|
592
598
|
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_base_uri'>base_uri</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
593
599
|
<span class='id identifier rubyid_required_opts'>required_opts</span> <span class='op'>=</span> <span class='qsymbols_beg'>%i[</span><span class='tstring_content'>client_id</span><span class='words_sep'> </span><span class='tstring_content'>client_secret</span><span class='tstring_end'>]</span></span>
|
@@ -646,13 +652,13 @@ Crapi::Proxy#delete.</p>
|
|
646
652
|
<pre class="lines">
|
647
653
|
|
648
654
|
|
649
|
-
121
|
650
|
-
122
|
651
655
|
123
|
652
|
-
124
|
656
|
+
124
|
657
|
+
125
|
658
|
+
126</pre>
|
653
659
|
</td>
|
654
660
|
<td>
|
655
|
-
<pre class="code"><span class="info file"># File 'lib/ed_fi/client.rb', line
|
661
|
+
<pre class="code"><span class="info file"># File 'lib/ed_fi/client.rb', line 123</span>
|
656
662
|
|
657
663
|
<span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>headers:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>query:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
658
664
|
<span class='lparen'>(</span><span class='id identifier rubyid_headers'>headers</span><span class='comma'>,</span> <span class='id identifier rubyid_query'>query</span><span class='rparen'>)</span> <span class='op'>=</span> <span class='id identifier rubyid_preprocess'>preprocess</span><span class='lparen'>(</span><span class='id identifier rubyid_headers'>headers</span><span class='comma'>,</span> <span class='id identifier rubyid_query'>query</span><span class='rparen'>)</span>
|
@@ -693,13 +699,13 @@ Crapi::Proxy#get.</p>
|
|
693
699
|
<pre class="lines">
|
694
700
|
|
695
701
|
|
696
|
-
131
|
697
|
-
132
|
698
702
|
133
|
699
|
-
134
|
703
|
+
134
|
704
|
+
135
|
705
|
+
136</pre>
|
700
706
|
</td>
|
701
707
|
<td>
|
702
|
-
<pre class="code"><span class="info file"># File 'lib/ed_fi/client.rb', line
|
708
|
+
<pre class="code"><span class="info file"># File 'lib/ed_fi/client.rb', line 133</span>
|
703
709
|
|
704
710
|
<span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>headers:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>query:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
705
711
|
<span class='lparen'>(</span><span class='id identifier rubyid_headers'>headers</span><span class='comma'>,</span> <span class='id identifier rubyid_query'>query</span><span class='rparen'>)</span> <span class='op'>=</span> <span class='id identifier rubyid_preprocess'>preprocess</span><span class='lparen'>(</span><span class='id identifier rubyid_headers'>headers</span><span class='comma'>,</span> <span class='id identifier rubyid_query'>query</span><span class='rparen'>)</span>
|
@@ -740,13 +746,13 @@ to Crapi::Proxy#patch.</p>
|
|
740
746
|
<pre class="lines">
|
741
747
|
|
742
748
|
|
743
|
-
141
|
744
|
-
142
|
745
749
|
143
|
746
|
-
144
|
750
|
+
144
|
751
|
+
145
|
752
|
+
146</pre>
|
747
753
|
</td>
|
748
754
|
<td>
|
749
|
-
<pre class="code"><span class="info file"># File 'lib/ed_fi/client.rb', line
|
755
|
+
<pre class="code"><span class="info file"># File 'lib/ed_fi/client.rb', line 143</span>
|
750
756
|
|
751
757
|
<span class='kw'>def</span> <span class='id identifier rubyid_patch'>patch</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>headers:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>query:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>payload:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
752
758
|
<span class='lparen'>(</span><span class='id identifier rubyid_headers'>headers</span><span class='comma'>,</span> <span class='id identifier rubyid_query'>query</span><span class='comma'>,</span> <span class='id identifier rubyid_payload'>payload</span><span class='rparen'>)</span> <span class='op'>=</span> <span class='id identifier rubyid_preprocess'>preprocess</span><span class='lparen'>(</span><span class='id identifier rubyid_headers'>headers</span><span class='comma'>,</span> <span class='id identifier rubyid_query'>query</span><span class='comma'>,</span> <span class='id identifier rubyid_payload'>payload</span><span class='rparen'>)</span>
|
@@ -787,13 +793,13 @@ to Crapi::Proxy#post.</p>
|
|
787
793
|
<pre class="lines">
|
788
794
|
|
789
795
|
|
790
|
-
151
|
791
|
-
152
|
792
796
|
153
|
793
|
-
154
|
797
|
+
154
|
798
|
+
155
|
799
|
+
156</pre>
|
794
800
|
</td>
|
795
801
|
<td>
|
796
|
-
<pre class="code"><span class="info file"># File 'lib/ed_fi/client.rb', line
|
802
|
+
<pre class="code"><span class="info file"># File 'lib/ed_fi/client.rb', line 153</span>
|
797
803
|
|
798
804
|
<span class='kw'>def</span> <span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>headers:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>query:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>payload:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
799
805
|
<span class='lparen'>(</span><span class='id identifier rubyid_headers'>headers</span><span class='comma'>,</span> <span class='id identifier rubyid_query'>query</span><span class='comma'>,</span> <span class='id identifier rubyid_payload'>payload</span><span class='rparen'>)</span> <span class='op'>=</span> <span class='id identifier rubyid_preprocess'>preprocess</span><span class='lparen'>(</span><span class='id identifier rubyid_headers'>headers</span><span class='comma'>,</span> <span class='id identifier rubyid_query'>query</span><span class='comma'>,</span> <span class='id identifier rubyid_payload'>payload</span><span class='rparen'>)</span>
|
@@ -852,12 +858,12 @@ generate headers.</p>
|
|
852
858
|
<pre class="lines">
|
853
859
|
|
854
860
|
|
855
|
-
|
856
|
-
|
857
|
-
|
861
|
+
65
|
862
|
+
66
|
863
|
+
67</pre>
|
858
864
|
</td>
|
859
865
|
<td>
|
860
|
-
<pre class="code"><span class="info file"># File 'lib/ed_fi/client.rb', line
|
866
|
+
<pre class="code"><span class="info file"># File 'lib/ed_fi/client.rb', line 65</span>
|
861
867
|
|
862
868
|
<span class='kw'>def</span> <span class='id identifier rubyid_profile='>profile=</span><span class='lparen'>(</span><span class='id identifier rubyid_profile'>profile</span><span class='rparen'>)</span>
|
863
869
|
<span class='ivar'>@profile</span> <span class='op'>=</span> <span class='id identifier rubyid_profile'>profile</span><span class='op'>&.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='op'>&.</span><span class='id identifier rubyid_downcase'>downcase</span>
|
@@ -897,13 +903,13 @@ to Crapi::Proxy#put.</p>
|
|
897
903
|
<pre class="lines">
|
898
904
|
|
899
905
|
|
900
|
-
161
|
901
|
-
162
|
902
906
|
163
|
903
|
-
164
|
907
|
+
164
|
908
|
+
165
|
909
|
+
166</pre>
|
904
910
|
</td>
|
905
911
|
<td>
|
906
|
-
<pre class="code"><span class="info file"># File 'lib/ed_fi/client.rb', line
|
912
|
+
<pre class="code"><span class="info file"># File 'lib/ed_fi/client.rb', line 163</span>
|
907
913
|
|
908
914
|
<span class='kw'>def</span> <span class='id identifier rubyid_put'>put</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>headers:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>query:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>payload:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
909
915
|
<span class='lparen'>(</span><span class='id identifier rubyid_headers'>headers</span><span class='comma'>,</span> <span class='id identifier rubyid_query'>query</span><span class='comma'>,</span> <span class='id identifier rubyid_payload'>payload</span><span class='rparen'>)</span> <span class='op'>=</span> <span class='id identifier rubyid_preprocess'>preprocess</span><span class='lparen'>(</span><span class='id identifier rubyid_headers'>headers</span><span class='comma'>,</span> <span class='id identifier rubyid_query'>query</span><span class='comma'>,</span> <span class='id identifier rubyid_payload'>payload</span><span class='rparen'>)</span>
|
@@ -991,15 +997,15 @@ optional.</p>
|
|
991
997
|
<pre class="lines">
|
992
998
|
|
993
999
|
|
994
|
-
82
|
995
|
-
83
|
996
1000
|
84
|
997
1001
|
85
|
998
1002
|
86
|
999
|
-
87
|
1003
|
+
87
|
1004
|
+
88
|
1005
|
+
89</pre>
|
1000
1006
|
</td>
|
1001
1007
|
<td>
|
1002
|
-
<pre class="code"><span class="info file"># File 'lib/ed_fi/client.rb', line
|
1008
|
+
<pre class="code"><span class="info file"># File 'lib/ed_fi/client.rb', line 84</span>
|
1003
1009
|
|
1004
1010
|
<span class='kw'>def</span> <span class='id identifier rubyid_read'>read</span><span class='lparen'>(</span><span class='id identifier rubyid_resource'>resource</span><span class='comma'>,</span> <span class='label'>as:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
1005
1011
|
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_profile'>profile</span> <span class='op'>=</span> <span class='id identifier rubyid_as'>as</span> <span class='kw'>if</span> <span class='id identifier rubyid_as'>as</span><span class='period'>.</span><span class='id identifier rubyid_present?'>present?</span>
|
@@ -1015,7 +1021,7 @@ optional.</p>
|
|
1015
1021
|
<div class="method_details ">
|
1016
1022
|
<h3 class="signature " id="v2-instance_method">
|
1017
1023
|
|
1018
|
-
#<strong>v2</strong>(period) ⇒ <tt><span class='object_link'><a href="Client/Proxy.html" title="EdFi::Client::Proxy (class)">EdFi::Client::Proxy</a></span></tt>
|
1024
|
+
#<strong>v2</strong>(period = nil) ⇒ <tt><span class='object_link'><a href="Client/Proxy.html" title="EdFi::Client::Proxy (class)">EdFi::Client::Proxy</a></span></tt>
|
1019
1025
|
|
1020
1026
|
|
1021
1027
|
|
@@ -1024,8 +1030,8 @@ optional.</p>
|
|
1024
1030
|
</h3><div class="docstring">
|
1025
1031
|
<div class="discussion">
|
1026
1032
|
|
1027
|
-
<p>Convenience proxy generator for v2.0 API access,
|
1028
|
-
year you'd like to access.</p>
|
1033
|
+
<p>Convenience proxy generator for v2.0 API access, also addomg the school
|
1034
|
+
year you'd like to access, if given.</p>
|
1029
1035
|
|
1030
1036
|
<p><code>v2(2017)</code>.)</p>
|
1031
1037
|
|
@@ -1044,6 +1050,8 @@ year you'd like to access.</p>
|
|
1044
1050
|
<span class='type'>(<tt>Integer</tt>)</span>
|
1045
1051
|
|
1046
1052
|
|
1053
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
1054
|
+
|
1047
1055
|
|
1048
1056
|
—
|
1049
1057
|
<div class='inline'>
|
@@ -1075,15 +1083,29 @@ year you'd like to access.</p>
|
|
1075
1083
|
<pre class="lines">
|
1076
1084
|
|
1077
1085
|
|
1078
|
-
|
1079
|
-
|
1080
|
-
|
1086
|
+
181
|
1087
|
+
182
|
1088
|
+
183
|
1089
|
+
184
|
1090
|
+
185
|
1091
|
+
186
|
1092
|
+
187
|
1093
|
+
188
|
1094
|
+
189
|
1095
|
+
190</pre>
|
1081
1096
|
</td>
|
1082
1097
|
<td>
|
1083
|
-
<pre class="code"><span class="info file"># File 'lib/ed_fi/client.rb', line
|
1098
|
+
<pre class="code"><span class="info file"># File 'lib/ed_fi/client.rb', line 181</span>
|
1099
|
+
|
1100
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_v2'>v2</span><span class='lparen'>(</span><span class='id identifier rubyid_period'>period</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
1101
|
+
<span class='id identifier rubyid_period'>period</span> <span class='op'>=</span> <span class='id identifier rubyid_period'>period</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span>
|
1084
1102
|
|
1085
|
-
<span class='
|
1086
|
-
<span class='ivar'>@v2</span
|
1103
|
+
<span class='ivar'>@v2</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span> <span class='kw'>if</span> <span class='ivar'>@v2</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
1104
|
+
<span class='ivar'>@v2</span><span class='lbracket'>[</span><span class='id identifier rubyid_period'>period</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>begin</span>
|
1105
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/api/v2.0</span><span class='tstring_end'>'</span></span>
|
1106
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>+=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_period'>period</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_period'>period</span><span class='period'>.</span><span class='id identifier rubyid_nonzero?'>nonzero?</span>
|
1107
|
+
<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="" title="EdFi::Client (class)">Client</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Client/Proxy.html" title="EdFi::Client::Proxy (class)">Proxy</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="EdFi::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>add:</span> <span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>to:</span> <span class='kw'>self</span><span class='rparen'>)</span>
|
1108
|
+
<span class='kw'>end</span>
|
1087
1109
|
<span class='kw'>end</span></pre>
|
1088
1110
|
</td>
|
1089
1111
|
</tr>
|
@@ -1168,15 +1190,15 @@ optional.</p>
|
|
1168
1190
|
<pre class="lines">
|
1169
1191
|
|
1170
1192
|
|
1171
|
-
106
|
1172
|
-
107
|
1173
1193
|
108
|
1174
1194
|
109
|
1175
1195
|
110
|
1176
|
-
111
|
1196
|
+
111
|
1197
|
+
112
|
1198
|
+
113</pre>
|
1177
1199
|
</td>
|
1178
1200
|
<td>
|
1179
|
-
<pre class="code"><span class="info file"># File 'lib/ed_fi/client.rb', line
|
1201
|
+
<pre class="code"><span class="info file"># File 'lib/ed_fi/client.rb', line 108</span>
|
1180
1202
|
|
1181
1203
|
<span class='kw'>def</span> <span class='id identifier rubyid_write'>write</span><span class='lparen'>(</span><span class='id identifier rubyid_resource'>resource</span><span class='comma'>,</span> <span class='label'>as:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
1182
1204
|
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_profile'>profile</span> <span class='op'>=</span> <span class='id identifier rubyid_as'>as</span> <span class='kw'>if</span> <span class='id identifier rubyid_as'>as</span><span class='period'>.</span><span class='id identifier rubyid_present?'>present?</span>
|
@@ -1194,9 +1216,9 @@ optional.</p>
|
|
1194
1216
|
</div>
|
1195
1217
|
|
1196
1218
|
<div id="footer">
|
1197
|
-
Generated on Thu
|
1219
|
+
Generated on Thu Jun 21 17:02:42 2018 by
|
1198
1220
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
1199
|
-
0.9.
|
1221
|
+
0.9.14 (ruby-2.5.1).
|
1200
1222
|
</div>
|
1201
1223
|
|
1202
1224
|
</div>
|
@@ -6,7 +6,7 @@
|
|
6
6
|
<title>
|
7
7
|
Class: EdFi::Client::AccessToken
|
8
8
|
|
9
|
-
— Documentation by YARD 0.9.
|
9
|
+
— Documentation by YARD 0.9.14
|
10
10
|
|
11
11
|
</title>
|
12
12
|
|
@@ -330,15 +330,15 @@ unset, defaults to <code>Time.current</code>.</p>
|
|
330
330
|
<pre class="lines">
|
331
331
|
|
332
332
|
|
333
|
-
26
|
334
333
|
27
|
335
334
|
28
|
336
335
|
29
|
337
336
|
30
|
338
|
-
31
|
337
|
+
31
|
338
|
+
32</pre>
|
339
339
|
</td>
|
340
340
|
<td>
|
341
|
-
<pre class="code"><span class="info file"># File 'lib/ed_fi/client/access_token.rb', line
|
341
|
+
<pre class="code"><span class="info file"># File 'lib/ed_fi/client/access_token.rb', line 27</span>
|
342
342
|
|
343
343
|
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>access_token:</span><span class='comma'>,</span> <span class='label'>token_type:</span><span class='comma'>,</span> <span class='label'>issued_at:</span> <span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_current'>current</span><span class='comma'>,</span> <span class='label'>expires_in:</span><span class='rparen'>)</span>
|
344
344
|
<span class='ivar'>@access_token</span> <span class='op'>=</span> <span class='id identifier rubyid_access_token'>access_token</span><span class='period'>.</span><span class='id identifier rubyid_dup'>dup</span>
|
@@ -397,13 +397,13 @@ unset, defaults to <code>Time.current</code>.</p>
|
|
397
397
|
<pre class="lines">
|
398
398
|
|
399
399
|
|
400
|
-
47
|
401
400
|
48
|
402
401
|
49
|
403
|
-
50
|
402
|
+
50
|
403
|
+
51</pre>
|
404
404
|
</td>
|
405
405
|
<td>
|
406
|
-
<pre class="code"><span class="info file"># File 'lib/ed_fi/client/access_token.rb', line
|
406
|
+
<pre class="code"><span class="info file"># File 'lib/ed_fi/client/access_token.rb', line 48</span>
|
407
407
|
|
408
408
|
<span class='kw'>def</span> <span class='id identifier rubyid_expires_at'>expires_at</span>
|
409
409
|
<span class='kw'>return</span> <span class='int'>1</span><span class='period'>.</span><span class='id identifier rubyid_second'>second</span><span class='period'>.</span><span class='id identifier rubyid_ago'>ago</span> <span class='kw'>if</span> <span class='ivar'>@access_token</span><span class='period'>.</span><span class='id identifier rubyid_blank?'>blank?</span>
|
@@ -453,12 +453,12 @@ unset, defaults to <code>Time.current</code>.</p>
|
|
453
453
|
<pre class="lines">
|
454
454
|
|
455
455
|
|
456
|
-
38
|
457
456
|
39
|
458
|
-
40
|
457
|
+
40
|
458
|
+
41</pre>
|
459
459
|
</td>
|
460
460
|
<td>
|
461
|
-
<pre class="code"><span class="info file"># File 'lib/ed_fi/client/access_token.rb', line
|
461
|
+
<pre class="code"><span class="info file"># File 'lib/ed_fi/client/access_token.rb', line 39</span>
|
462
462
|
|
463
463
|
<span class='kw'>def</span> <span class='id identifier rubyid_token'>token</span>
|
464
464
|
<span class='ivar'>@access_token</span><span class='period'>.</span><span class='id identifier rubyid_dup'>dup</span>
|
@@ -509,13 +509,13 @@ the token to complete.</p>
|
|
509
509
|
<pre class="lines">
|
510
510
|
|
511
511
|
|
512
|
-
58
|
513
512
|
59
|
514
513
|
60
|
515
|
-
61
|
514
|
+
61
|
515
|
+
62</pre>
|
516
516
|
</td>
|
517
517
|
<td>
|
518
|
-
<pre class="code"><span class="info file"># File 'lib/ed_fi/client/access_token.rb', line
|
518
|
+
<pre class="code"><span class="info file"># File 'lib/ed_fi/client/access_token.rb', line 59</span>
|
519
519
|
|
520
520
|
<span class='kw'>def</span> <span class='id identifier rubyid_valid?'>valid?</span>
|
521
521
|
<span class='id identifier rubyid_safety_window'>safety_window</span> <span class='op'>=</span> <span class='int'>5</span><span class='period'>.</span><span class='id identifier rubyid_seconds'>seconds</span>
|
@@ -531,9 +531,9 @@ the token to complete.</p>
|
|
531
531
|
</div>
|
532
532
|
|
533
533
|
<div id="footer">
|
534
|
-
Generated on Thu
|
534
|
+
Generated on Thu Jun 21 17:02:43 2018 by
|
535
535
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
536
|
-
0.9.
|
536
|
+
0.9.14 (ruby-2.5.1).
|
537
537
|
</div>
|
538
538
|
|
539
539
|
</div>
|