purple_air_api 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 (38) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +0 -1
  3. data/Gemfile.lock +1 -1
  4. data/README.md +143 -11
  5. data/Rakefile +5 -0
  6. data/docs/PurpleAirApi.html +488 -0
  7. data/docs/PurpleAirApi/V1.html +128 -0
  8. data/docs/PurpleAirApi/V1/ApiError.html +159 -0
  9. data/docs/PurpleAirApi/V1/ApiKeyError.html +159 -0
  10. data/docs/PurpleAirApi/V1/BaseError.html +431 -0
  11. data/docs/PurpleAirApi/V1/Client.html +801 -0
  12. data/docs/PurpleAirApi/V1/GetSensor.html +1033 -0
  13. data/docs/PurpleAirApi/V1/GetSensors.html +979 -0
  14. data/docs/PurpleAirApi/V1/MissingJsonPayloadError.html +159 -0
  15. data/docs/PurpleAirApi/V1/NotFoundError.html +159 -0
  16. data/docs/PurpleAirApi/V1/OptionsError.html +135 -0
  17. data/docs/PurpleAirApi/V1/RaiseHttpException.html +318 -0
  18. data/docs/PurpleAirApi/V1/ServerError.html +159 -0
  19. data/docs/_index.html +274 -0
  20. data/docs/class_list.html +51 -0
  21. data/docs/css/common.css +1 -0
  22. data/docs/css/full_list.css +58 -0
  23. data/docs/css/style.css +497 -0
  24. data/docs/file.README.html +247 -0
  25. data/docs/file_list.html +56 -0
  26. data/docs/frames.html +17 -0
  27. data/docs/index.html +247 -0
  28. data/docs/js/app.js +314 -0
  29. data/docs/js/full_list.js +216 -0
  30. data/docs/js/jquery.js +4 -0
  31. data/docs/method_list.html +315 -0
  32. data/docs/top-level-namespace.html +110 -0
  33. data/lib/purple_air_api/V1/client.rb +11 -1
  34. data/lib/purple_air_api/V1/sensors/get_sensor.rb +5 -4
  35. data/lib/purple_air_api/V1/sensors/get_sensors.rb +11 -9
  36. data/lib/purple_air_api/version.rb +1 -1
  37. data/purple_air_api.gemspec +8 -5
  38. metadata +37 -8
data/docs/PurpleAirApi/V1/MissingJsonPayloadError.html ADDED
@@ -0,0 +1,159 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Exception: PurpleAirApi::V1::MissingJsonPayloadError
8
+
9
+ &mdash; Documentation by YARD 0.9.26
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../../css/style.css" type="text/css" />
14
+
15
+ <link rel="stylesheet" href="../../css/common.css" type="text/css" />
16
+
17
+ <script type="text/javascript">
18
+ pathId = "PurpleAirApi::V1::MissingJsonPayloadError";
19
+ relpath = '../../';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="../../class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="../../_index.html">Index (M)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../../PurpleAirApi.html" title="PurpleAirApi (module)">PurpleAirApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../V1.html" title="PurpleAirApi::V1 (module)">V1</a></span></span>
41
+ &raquo;
42
+ <span class="title">MissingJsonPayloadError</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="../../class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Exception: PurpleAirApi::V1::MissingJsonPayloadError
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+ <dl>
70
+ <dt>Inherits:</dt>
71
+ <dd>
72
+ <span class="inheritName"><span class='object_link'><a href="BaseError.html" title="PurpleAirApi::V1::BaseError (class)">BaseError</a></span></span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next">StandardError</li>
78
+
79
+ <li class="next"><span class='object_link'><a href="BaseError.html" title="PurpleAirApi::V1::BaseError (class)">BaseError</a></span></li>
80
+
81
+ <li class="next">PurpleAirApi::V1::MissingJsonPayloadError</li>
82
+
83
+ </ul>
84
+ <a href="#" class="inheritanceTree">show all</a>
85
+
86
+ </dd>
87
+ </dl>
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+
98
+
99
+ <dl>
100
+ <dt>Defined in:</dt>
101
+ <dd>lib/purple_air_api/V1/errors.rb</dd>
102
+ </dl>
103
+
104
+ </div>
105
+
106
+ <h2>Overview</h2><div class="docstring">
107
+ <div class="discussion">
108
+
109
+ <p>Raised when the PurpleAir API returns the HTTP status code 415</p>
110
+
111
+
112
+ </div>
113
+ </div>
114
+ <div class="tags">
115
+
116
+
117
+ </div>
118
+
119
+
120
+
121
+
122
+
123
+ <h2>Instance Attribute Summary</h2>
124
+
125
+ <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="BaseError.html" title="PurpleAirApi::V1::BaseError (class)">BaseError</a></span></h3>
126
+ <p class="inherited"><span class='object_link'><a href="BaseError.html#error_type-instance_method" title="PurpleAirApi::V1::BaseError#error_type (method)">#error_type</a></span>, <span class='object_link'><a href="BaseError.html#response_object-instance_method" title="PurpleAirApi::V1::BaseError#response_object (method)">#response_object</a></span></p>
127
+
128
+
129
+
130
+
131
+
132
+
133
+
134
+
135
+
136
+ <h2>Method Summary</h2>
137
+
138
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="BaseError.html" title="PurpleAirApi::V1::BaseError (class)">BaseError</a></span></h3>
139
+ <p class="inherited"><span class='object_link'><a href="BaseError.html#initialize-instance_method" title="PurpleAirApi::V1::BaseError#initialize (method)">#initialize</a></span></p>
140
+
141
+ <div id="constructor_details" class="method_details_list">
142
+ <h2>Constructor Details</h2>
143
+
144
+ <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BaseError.html#initialize-instance_method" title="PurpleAirApi::V1::BaseError#initialize (method)">PurpleAirApi::V1::BaseError</a></span></p>
145
+
146
+ </div>
147
+
148
+
149
+ </div>
150
+
151
+ <div id="footer">
152
+ Generated on Fri Mar 12 10:06:11 2021 by
153
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
154
+ 0.9.26 (ruby-3.0.0).
155
+ </div>
156
+
157
+ </div>
158
+ </body>
159
+ </html>
data/docs/PurpleAirApi/V1/NotFoundError.html ADDED
@@ -0,0 +1,159 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Exception: PurpleAirApi::V1::NotFoundError
8
+
9
+ &mdash; Documentation by YARD 0.9.26
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../../css/style.css" type="text/css" />
14
+
15
+ <link rel="stylesheet" href="../../css/common.css" type="text/css" />
16
+
17
+ <script type="text/javascript">
18
+ pathId = "PurpleAirApi::V1::NotFoundError";
19
+ relpath = '../../';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="../../class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="../../_index.html">Index (N)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../../PurpleAirApi.html" title="PurpleAirApi (module)">PurpleAirApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../V1.html" title="PurpleAirApi::V1 (module)">V1</a></span></span>
41
+ &raquo;
42
+ <span class="title">NotFoundError</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="../../class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Exception: PurpleAirApi::V1::NotFoundError
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+ <dl>
70
+ <dt>Inherits:</dt>
71
+ <dd>
72
+ <span class="inheritName"><span class='object_link'><a href="BaseError.html" title="PurpleAirApi::V1::BaseError (class)">BaseError</a></span></span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next">StandardError</li>
78
+
79
+ <li class="next"><span class='object_link'><a href="BaseError.html" title="PurpleAirApi::V1::BaseError (class)">BaseError</a></span></li>
80
+
81
+ <li class="next">PurpleAirApi::V1::NotFoundError</li>
82
+
83
+ </ul>
84
+ <a href="#" class="inheritanceTree">show all</a>
85
+
86
+ </dd>
87
+ </dl>
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+
98
+
99
+ <dl>
100
+ <dt>Defined in:</dt>
101
+ <dd>lib/purple_air_api/V1/errors.rb</dd>
102
+ </dl>
103
+
104
+ </div>
105
+
106
+ <h2>Overview</h2><div class="docstring">
107
+ <div class="discussion">
108
+
109
+ <p>Raised when the PurpleAir API returns the HTTP status code 404</p>
110
+
111
+
112
+ </div>
113
+ </div>
114
+ <div class="tags">
115
+
116
+
117
+ </div>
118
+
119
+
120
+
121
+
122
+
123
+ <h2>Instance Attribute Summary</h2>
124
+
125
+ <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="BaseError.html" title="PurpleAirApi::V1::BaseError (class)">BaseError</a></span></h3>
126
+ <p class="inherited"><span class='object_link'><a href="BaseError.html#error_type-instance_method" title="PurpleAirApi::V1::BaseError#error_type (method)">#error_type</a></span>, <span class='object_link'><a href="BaseError.html#response_object-instance_method" title="PurpleAirApi::V1::BaseError#response_object (method)">#response_object</a></span></p>
127
+
128
+
129
+
130
+
131
+
132
+
133
+
134
+
135
+
136
+ <h2>Method Summary</h2>
137
+
138
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="BaseError.html" title="PurpleAirApi::V1::BaseError (class)">BaseError</a></span></h3>
139
+ <p class="inherited"><span class='object_link'><a href="BaseError.html#initialize-instance_method" title="PurpleAirApi::V1::BaseError#initialize (method)">#initialize</a></span></p>
140
+
141
+ <div id="constructor_details" class="method_details_list">
142
+ <h2>Constructor Details</h2>
143
+
144
+ <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BaseError.html#initialize-instance_method" title="PurpleAirApi::V1::BaseError#initialize (method)">PurpleAirApi::V1::BaseError</a></span></p>
145
+
146
+ </div>
147
+
148
+
149
+ </div>
150
+
151
+ <div id="footer">
152
+ Generated on Fri Mar 12 10:06:11 2021 by
153
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
154
+ 0.9.26 (ruby-3.0.0).
155
+ </div>
156
+
157
+ </div>
158
+ </body>
159
+ </html>
data/docs/PurpleAirApi/V1/OptionsError.html ADDED
@@ -0,0 +1,135 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Exception: PurpleAirApi::V1::OptionsError
8
+
9
+ &mdash; Documentation by YARD 0.9.26
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../../css/style.css" type="text/css" />
14
+
15
+ <link rel="stylesheet" href="../../css/common.css" type="text/css" />
16
+
17
+ <script type="text/javascript">
18
+ pathId = "PurpleAirApi::V1::OptionsError";
19
+ relpath = '../../';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="../../class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="../../_index.html">Index (O)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../../PurpleAirApi.html" title="PurpleAirApi (module)">PurpleAirApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../V1.html" title="PurpleAirApi::V1 (module)">V1</a></span></span>
41
+ &raquo;
42
+ <span class="title">OptionsError</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="../../class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Exception: PurpleAirApi::V1::OptionsError
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+ <dl>
70
+ <dt>Inherits:</dt>
71
+ <dd>
72
+ <span class="inheritName">StandardError</span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next">StandardError</li>
78
+
79
+ <li class="next">PurpleAirApi::V1::OptionsError</li>
80
+
81
+ </ul>
82
+ <a href="#" class="inheritanceTree">show all</a>
83
+
84
+ </dd>
85
+ </dl>
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+ <dl>
98
+ <dt>Defined in:</dt>
99
+ <dd>lib/purple_air_api/V1/sensors/errors.rb</dd>
100
+ </dl>
101
+
102
+ </div>
103
+
104
+ <h2>Overview</h2><div class="docstring">
105
+ <div class="discussion">
106
+
107
+ <p>Raised when the options given are invalid</p>
108
+
109
+
110
+ </div>
111
+ </div>
112
+ <div class="tags">
113
+
114
+
115
+ </div>
116
+
117
+
118
+
119
+
120
+
121
+
122
+
123
+
124
+
125
+ </div>
126
+
127
+ <div id="footer">
128
+ Generated on Fri Mar 12 10:06:11 2021 by
129
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
130
+ 0.9.26 (ruby-3.0.0).
131
+ </div>
132
+
133
+ </div>
134
+ </body>
135
+ </html>