auth0-ruby 0.9

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 (73) hide show
  1. checksums.yaml +7 -0
  2. data/.bundle/config +2 -0
  3. data/.gitignore +8 -0
  4. data/.rspec +2 -0
  5. data/Gemfile +4 -0
  6. data/Gemfile.lock +68 -0
  7. data/README.md +27 -0
  8. data/Rakefile +9 -0
  9. data/auth0.gemspec +29 -0
  10. data/doc/Auth0.html +153 -0
  11. data/doc/Auth0/Api.html +128 -0
  12. data/doc/Auth0/Api/AuthenticationEndpoints.html +596 -0
  13. data/doc/Auth0/Api/V1.html +192 -0
  14. data/doc/Auth0/Api/V1/Clients.html +440 -0
  15. data/doc/Auth0/Api/V1/Connections.html +506 -0
  16. data/doc/Auth0/Api/V1/Logs.html +366 -0
  17. data/doc/Auth0/Api/V1/Rules.html +439 -0
  18. data/doc/Auth0/Api/V1/Users.html +1617 -0
  19. data/doc/Auth0/BadRequest.html +142 -0
  20. data/doc/Auth0/Client.html +236 -0
  21. data/doc/Auth0/Exception.html +140 -0
  22. data/doc/Auth0/Mixins.html +225 -0
  23. data/doc/Auth0/Mixins/HTTPartyProxy.html +121 -0
  24. data/doc/Auth0/Mixins/Initializer.html +298 -0
  25. data/doc/Auth0/NotFound.html +143 -0
  26. data/doc/Auth0/ServerError.html +142 -0
  27. data/doc/Auth0/Unauthorized.html +143 -0
  28. data/doc/Auth0/Unsupported.html +142 -0
  29. data/doc/Auth0/UserIdIsBlank.html +143 -0
  30. data/doc/Auth0Client.html +235 -0
  31. data/doc/_index.html +347 -0
  32. data/doc/class_list.html +58 -0
  33. data/doc/css/common.css +1 -0
  34. data/doc/css/full_list.css +57 -0
  35. data/doc/css/style.css +339 -0
  36. data/doc/file.README.html +103 -0
  37. data/doc/file_list.html +60 -0
  38. data/doc/frames.html +26 -0
  39. data/doc/index.html +103 -0
  40. data/doc/js/app.js +219 -0
  41. data/doc/js/full_list.js +181 -0
  42. data/doc/js/jquery.js +4 -0
  43. data/doc/method_list.html +327 -0
  44. data/doc/top-level-namespace.html +114 -0
  45. data/lib/auth0.rb +8 -0
  46. data/lib/auth0/api/authentication_endpoints.rb +71 -0
  47. data/lib/auth0/api/v1.rb +19 -0
  48. data/lib/auth0/api/v1/clients.rb +48 -0
  49. data/lib/auth0/api/v1/connections.rb +51 -0
  50. data/lib/auth0/api/v1/logs.rb +41 -0
  51. data/lib/auth0/api/v1/rules.rb +44 -0
  52. data/lib/auth0/api/v1/users.rb +163 -0
  53. data/lib/auth0/client.rb +7 -0
  54. data/lib/auth0/exception.rb +18 -0
  55. data/lib/auth0/mixins.rb +13 -0
  56. data/lib/auth0/mixins/httparty_proxy.rb +29 -0
  57. data/lib/auth0/mixins/initializer.rb +25 -0
  58. data/lib/auth0/version.rb +4 -0
  59. data/lib/auth0_client.rb +3 -0
  60. data/spec/lib/auth0/api/authentication_endpoints_spec.rb +56 -0
  61. data/spec/lib/auth0/api/v1/clients_spec.rb +62 -0
  62. data/spec/lib/auth0/api/v1/connections_spec.rb +62 -0
  63. data/spec/lib/auth0/api/v1/logs_spec.rb +46 -0
  64. data/spec/lib/auth0/api/v1/rules_spec.rb +40 -0
  65. data/spec/lib/auth0/api/v1/users_spec.rb +215 -0
  66. data/spec/lib/auth0/client_spec.rb +19 -0
  67. data/spec/lib/auth0/mixins/httparty_proxy_spec.rb +60 -0
  68. data/spec/lib/auth0_client_spec.rb +8 -0
  69. data/spec/spec_helper.rb +18 -0
  70. data/spec/support/dummy_class.rb +7 -0
  71. data/spec/support/dummy_class_for_proxy.rb +4 -0
  72. data/spec/support/stub_response.rb +2 -0
  73. metadata +253 -0
data/doc/Auth0/Mixins.html ADDED
@@ -0,0 +1,225 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>
7
+ Module: Auth0::Mixins
8
+
9
+ &mdash; Documentation by YARD 0.8.7.6
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ hasFrames = window.top.frames.main ? true : false;
19
+ relpath = '../';
20
+ framesUrl = "../frames.html#!Auth0/Mixins.html";
21
+ </script>
22
+
23
+
24
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
25
+
26
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
27
+
28
+
29
+ </head>
30
+ <body>
31
+ <div id="header">
32
+ <div id="menu">
33
+
34
+ <a href="../_index.html">Index (M)</a> &raquo;
35
+ <span class='title'><span class='object_link'><a href="../Auth0.html" title="Auth0 (module)">Auth0</a></span></span>
36
+ &raquo;
37
+ <span class="title">Mixins</span>
38
+
39
+
40
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
41
+ </div>
42
+
43
+ <div id="search">
44
+
45
+ <a class="full_list_link" id="class_list_link"
46
+ href="../class_list.html">
47
+ Class List
48
+ </a>
49
+
50
+ <a class="full_list_link" id="method_list_link"
51
+ href="../method_list.html">
52
+ Method List
53
+ </a>
54
+
55
+ <a class="full_list_link" id="file_list_link"
56
+ href="../file_list.html">
57
+ File List
58
+ </a>
59
+
60
+ </div>
61
+ <div class="clear"></div>
62
+ </div>
63
+
64
+ <iframe id="search_frame"></iframe>
65
+
66
+ <div id="content"><h1>Module: Auth0::Mixins
67
+
68
+
69
+
70
+ </h1>
71
+
72
+ <dl class="box">
73
+
74
+
75
+
76
+
77
+
78
+ <dt class="r1">Includes:</dt>
79
+ <dd class="r1"><span class='object_link'><a href="Api/AuthenticationEndpoints.html" title="Auth0::Api::AuthenticationEndpoints (module)">Api::AuthenticationEndpoints</a></span>, <span class='object_link'><a href="Api/V1.html" title="Auth0::Api::V1 (module)">Api::V1</a></span>, <span class='object_link'><a href="Mixins/HTTPartyProxy.html" title="Auth0::Mixins::HTTPartyProxy (module)">HTTPartyProxy</a></span>, <span class='object_link'><a href="Mixins/Initializer.html" title="Auth0::Mixins::Initializer (module)">Initializer</a></span></dd>
80
+
81
+
82
+
83
+
84
+ <dt class="r2">Included in:</dt>
85
+ <dd class="r2"><span class='object_link'><a href="Client.html" title="Auth0::Client (class)">Client</a></span></dd>
86
+
87
+
88
+
89
+ <dt class="r1 last">Defined in:</dt>
90
+ <dd class="r1 last">lib/auth0/mixins.rb<span class="defines">,<br />
91
+ lib/auth0/mixins/initializer.rb,<br /> lib/auth0/mixins/httparty_proxy.rb</span>
92
+ </dd>
93
+
94
+ </dl>
95
+ <div class="clear"></div>
96
+
97
+ <h2>Overview</h2><div class="docstring">
98
+ <div class="discussion">
99
+
100
+ <p>Collecting dependencies here</p>
101
+
102
+
103
+ </div>
104
+ </div>
105
+ <div class="tags">
106
+
107
+
108
+ </div><h2>Defined Under Namespace</h2>
109
+ <p class="children">
110
+
111
+
112
+ <strong class="modules">Modules:</strong> <span class='object_link'><a href="Mixins/HTTPartyProxy.html" title="Auth0::Mixins::HTTPartyProxy (module)">HTTPartyProxy</a></span>, <span class='object_link'><a href="Mixins/Initializer.html" title="Auth0::Mixins::Initializer (module)">Initializer</a></span>
113
+
114
+
115
+
116
+
117
+ </p>
118
+
119
+
120
+
121
+
122
+
123
+
124
+
125
+
126
+
127
+
128
+
129
+
130
+
131
+
132
+
133
+
134
+
135
+
136
+
137
+
138
+ <h2>Method Summary</h2>
139
+
140
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="Api/V1/Logs.html" title="Auth0::Api::V1::Logs (module)">Api::V1::Logs</a></span></h3>
141
+ <p class="inherited"><span class='object_link'><a href="Api/V1/Logs.html#log-instance_method" title="Auth0::Api::V1::Logs#log (method)">#log</a></span>, <span class='object_link'><a href="Api/V1/Logs.html#logs-instance_method" title="Auth0::Api::V1::Logs#logs (method)">#logs</a></span>, <span class='object_link'><a href="Api/V1/Logs.html#user_logs-instance_method" title="Auth0::Api::V1::Logs#user_logs (method)">#user_logs</a></span></p>
142
+
143
+
144
+
145
+
146
+
147
+
148
+
149
+
150
+
151
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="Api/V1/Rules.html" title="Auth0::Api::V1::Rules (module)">Api::V1::Rules</a></span></h3>
152
+ <p class="inherited"><span class='object_link'><a href="Api/V1/Rules.html#create_rule-instance_method" title="Auth0::Api::V1::Rules#create_rule (method)">#create_rule</a></span>, <span class='object_link'><a href="Api/V1/Rules.html#delete_rule-instance_method" title="Auth0::Api::V1::Rules#delete_rule (method)">#delete_rule</a></span>, <span class='object_link'><a href="Api/V1/Rules.html#rules-instance_method" title="Auth0::Api::V1::Rules#rules (method)">#rules</a></span>, <span class='object_link'><a href="Api/V1/Rules.html#update_rule-instance_method" title="Auth0::Api::V1::Rules#update_rule (method)">#update_rule</a></span></p>
153
+
154
+
155
+
156
+
157
+
158
+
159
+
160
+
161
+
162
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="Api/V1/Clients.html" title="Auth0::Api::V1::Clients (module)">Api::V1::Clients</a></span></h3>
163
+ <p class="inherited"><span class='object_link'><a href="Api/V1/Clients.html#clients-instance_method" title="Auth0::Api::V1::Clients#clients (method)">#clients</a></span>, <span class='object_link'><a href="Api/V1/Clients.html#create_client-instance_method" title="Auth0::Api::V1::Clients#create_client (method)">#create_client</a></span>, <span class='object_link'><a href="Api/V1/Clients.html#patch_client-instance_method" title="Auth0::Api::V1::Clients#patch_client (method)">#patch_client</a></span>, <span class='object_link'><a href="Api/V1/Clients.html#update_client-instance_method" title="Auth0::Api::V1::Clients#update_client (method)">#update_client</a></span></p>
164
+
165
+
166
+
167
+
168
+
169
+
170
+
171
+
172
+
173
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="Api/V1/Connections.html" title="Auth0::Api::V1::Connections (module)">Api::V1::Connections</a></span></h3>
174
+ <p class="inherited"><span class='object_link'><a href="Api/V1/Connections.html#connection-instance_method" title="Auth0::Api::V1::Connections#connection (method)">#connection</a></span>, <span class='object_link'><a href="Api/V1/Connections.html#connections-instance_method" title="Auth0::Api::V1::Connections#connections (method)">#connections</a></span>, <span class='object_link'><a href="Api/V1/Connections.html#create_connection-instance_method" title="Auth0::Api::V1::Connections#create_connection (method)">#create_connection</a></span>, <span class='object_link'><a href="Api/V1/Connections.html#delete_connection-instance_method" title="Auth0::Api::V1::Connections#delete_connection (method)">#delete_connection</a></span>, <span class='object_link'><a href="Api/V1/Connections.html#update_connection-instance_method" title="Auth0::Api::V1::Connections#update_connection (method)">#update_connection</a></span></p>
175
+
176
+
177
+
178
+
179
+
180
+
181
+
182
+
183
+
184
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="Api/V1/Users.html" title="Auth0::Api::V1::Users (module)">Api::V1::Users</a></span></h3>
185
+ <p class="inherited"><span class='object_link'><a href="Api/V1/Users.html#change_password_ticket-instance_method" title="Auth0::Api::V1::Users#change_password_ticket (method)">#change_password_ticket</a></span>, <span class='object_link'><a href="Api/V1/Users.html#client_users-instance_method" title="Auth0::Api::V1::Users#client_users (method)">#client_users</a></span>, <span class='object_link'><a href="Api/V1/Users.html#connection_users-instance_method" title="Auth0::Api::V1::Users#connection_users (method)">#connection_users</a></span>, <span class='object_link'><a href="Api/V1/Users.html#create_public_key-instance_method" title="Auth0::Api::V1::Users#create_public_key (method)">#create_public_key</a></span>, <span class='object_link'><a href="Api/V1/Users.html#create_user-instance_method" title="Auth0::Api::V1::Users#create_user (method)">#create_user</a></span>, <span class='object_link'><a href="Api/V1/Users.html#delete_user-instance_method" title="Auth0::Api::V1::Users#delete_user (method)">#delete_user</a></span>, <span class='object_link'><a href="Api/V1/Users.html#delete_users-instance_method" title="Auth0::Api::V1::Users#delete_users (method)">#delete_users</a></span>, <span class='object_link'><a href="Api/V1/Users.html#enterpriseconnections_users-instance_method" title="Auth0::Api::V1::Users#enterpriseconnections_users (method)">#enterpriseconnections_users</a></span>, <span class='object_link'><a href="Api/V1/Users.html#patch_user_metadata-instance_method" title="Auth0::Api::V1::Users#patch_user_metadata (method)">#patch_user_metadata</a></span>, <span class='object_link'><a href="Api/V1/Users.html#revoke_user_device_public_key-instance_method" title="Auth0::Api::V1::Users#revoke_user_device_public_key (method)">#revoke_user_device_public_key</a></span>, <span class='object_link'><a href="Api/V1/Users.html#revoke_user_refresh_token-instance_method" title="Auth0::Api::V1::Users#revoke_user_refresh_token (method)">#revoke_user_refresh_token</a></span>, <span class='object_link'><a href="Api/V1/Users.html#send_verification_email-instance_method" title="Auth0::Api::V1::Users#send_verification_email (method)">#send_verification_email</a></span>, <span class='object_link'><a href="Api/V1/Users.html#socialconnections_users-instance_method" title="Auth0::Api::V1::Users#socialconnections_users (method)">#socialconnections_users</a></span>, <span class='object_link'><a href="Api/V1/Users.html#update_user_email-instance_method" title="Auth0::Api::V1::Users#update_user_email (method)">#update_user_email</a></span>, <span class='object_link'><a href="Api/V1/Users.html#update_user_metadata-instance_method" title="Auth0::Api::V1::Users#update_user_metadata (method)">#update_user_metadata</a></span>, <span class='object_link'><a href="Api/V1/Users.html#update_user_password-instance_method" title="Auth0::Api::V1::Users#update_user_password (method)">#update_user_password</a></span>, <span class='object_link'><a href="Api/V1/Users.html#update_user_password_using_email-instance_method" title="Auth0::Api::V1::Users#update_user_password_using_email (method)">#update_user_password_using_email</a></span>, <span class='object_link'><a href="Api/V1/Users.html#user-instance_method" title="Auth0::Api::V1::Users#user (method)">#user</a></span>, <span class='object_link'><a href="Api/V1/Users.html#user_devices-instance_method" title="Auth0::Api::V1::Users#user_devices (method)">#user_devices</a></span>, <span class='object_link'><a href="Api/V1/Users.html#users-instance_method" title="Auth0::Api::V1::Users#users (method)">#users</a></span>, <span class='object_link'><a href="Api/V1/Users.html#verification_ticket-instance_method" title="Auth0::Api::V1::Users#verification_ticket (method)">#verification_ticket</a></span></p>
186
+
187
+
188
+
189
+
190
+
191
+
192
+
193
+
194
+
195
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="Api/AuthenticationEndpoints.html" title="Auth0::Api::AuthenticationEndpoints (module)">Api::AuthenticationEndpoints</a></span></h3>
196
+ <p class="inherited"><span class='object_link'><a href="Api/AuthenticationEndpoints.html#change_password-instance_method" title="Auth0::Api::AuthenticationEndpoints#change_password (method)">#change_password</a></span>, <span class='object_link'><a href="Api/AuthenticationEndpoints.html#delegation-instance_method" title="Auth0::Api::AuthenticationEndpoints#delegation (method)">#delegation</a></span>, <span class='object_link'><a href="Api/AuthenticationEndpoints.html#login-instance_method" title="Auth0::Api::AuthenticationEndpoints#login (method)">#login</a></span>, <span class='object_link'><a href="Api/AuthenticationEndpoints.html#obtain_access_token-instance_method" title="Auth0::Api::AuthenticationEndpoints#obtain_access_token (method)">#obtain_access_token</a></span>, <span class='object_link'><a href="Api/AuthenticationEndpoints.html#signup-instance_method" title="Auth0::Api::AuthenticationEndpoints#signup (method)">#signup</a></span>, <span class='object_link'><a href="Api/AuthenticationEndpoints.html#token_info-instance_method" title="Auth0::Api::AuthenticationEndpoints#token_info (method)">#token_info</a></span></p>
197
+
198
+
199
+
200
+
201
+
202
+
203
+
204
+
205
+
206
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="Mixins/Initializer.html" title="Auth0::Mixins::Initializer (module)">Initializer</a></span></h3>
207
+ <p class="inherited"><span class='object_link'><a href="Mixins/Initializer.html#included-class_method" title="Auth0::Mixins::Initializer.included (method)">included</a></span>, <span class='object_link'><a href="Mixins/Initializer.html#initialize-instance_method" title="Auth0::Mixins::Initializer#initialize (method)">#initialize</a></span></p>
208
+
209
+
210
+
211
+
212
+
213
+
214
+
215
+
216
+ </div>
217
+
218
+ <div id="footer">
219
+ Generated on Mon Jan 26 03:18:46 2015 by
220
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
221
+ 0.8.7.6 (ruby-2.0.0).
222
+ </div>
223
+
224
+ </body>
225
+ </html>
data/doc/Auth0/Mixins/HTTPartyProxy.html ADDED
@@ -0,0 +1,121 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>
7
+ Module: Auth0::Mixins::HTTPartyProxy
8
+
9
+ &mdash; Documentation by YARD 0.8.7.6
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ hasFrames = window.top.frames.main ? true : false;
19
+ relpath = '../../';
20
+ framesUrl = "../../frames.html#!Auth0/Mixins/HTTPartyProxy.html";
21
+ </script>
22
+
23
+
24
+ <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
25
+
26
+ <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
27
+
28
+
29
+ </head>
30
+ <body>
31
+ <div id="header">
32
+ <div id="menu">
33
+
34
+ <a href="../../_index.html">Index (H)</a> &raquo;
35
+ <span class='title'><span class='object_link'><a href="../../Auth0.html" title="Auth0 (module)">Auth0</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Mixins.html" title="Auth0::Mixins (module)">Mixins</a></span></span>
36
+ &raquo;
37
+ <span class="title">HTTPartyProxy</span>
38
+
39
+
40
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
41
+ </div>
42
+
43
+ <div id="search">
44
+
45
+ <a class="full_list_link" id="class_list_link"
46
+ href="../../class_list.html">
47
+ Class List
48
+ </a>
49
+
50
+ <a class="full_list_link" id="method_list_link"
51
+ href="../../method_list.html">
52
+ Method List
53
+ </a>
54
+
55
+ <a class="full_list_link" id="file_list_link"
56
+ href="../../file_list.html">
57
+ File List
58
+ </a>
59
+
60
+ </div>
61
+ <div class="clear"></div>
62
+ </div>
63
+
64
+ <iframe id="search_frame"></iframe>
65
+
66
+ <div id="content"><h1>Module: Auth0::Mixins::HTTPartyProxy
67
+
68
+
69
+
70
+ </h1>
71
+
72
+ <dl class="box">
73
+
74
+
75
+
76
+
77
+
78
+
79
+
80
+ <dt class="r1">Included in:</dt>
81
+ <dd class="r1"><span class='object_link'><a href="../Mixins.html" title="Auth0::Mixins (module)">Auth0::Mixins</a></span></dd>
82
+
83
+
84
+
85
+ <dt class="r2 last">Defined in:</dt>
86
+ <dd class="r2 last">lib/auth0/mixins/httparty_proxy.rb</dd>
87
+
88
+ </dl>
89
+ <div class="clear"></div>
90
+
91
+ <h2>Overview</h2><div class="docstring">
92
+ <div class="discussion">
93
+
94
+ <p>here&#39;s the proxy for HTTParty, we&#39;re building all request on that
95
+ gem for now, if you want to feel free to use your own http client</p>
96
+
97
+
98
+ </div>
99
+ </div>
100
+ <div class="tags">
101
+
102
+
103
+ </div>
104
+
105
+
106
+
107
+
108
+
109
+
110
+
111
+
112
+ </div>
113
+
114
+ <div id="footer">
115
+ Generated on Mon Jan 26 03:18:46 2015 by
116
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
117
+ 0.8.7.6 (ruby-2.0.0).
118
+ </div>
119
+
120
+ </body>
121
+ </html>
data/doc/Auth0/Mixins/Initializer.html ADDED
@@ -0,0 +1,298 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>
7
+ Module: Auth0::Mixins::Initializer
8
+
9
+ &mdash; Documentation by YARD 0.8.7.6
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ hasFrames = window.top.frames.main ? true : false;
19
+ relpath = '../../';
20
+ framesUrl = "../../frames.html#!Auth0/Mixins/Initializer.html";
21
+ </script>
22
+
23
+
24
+ <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
25
+
26
+ <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
27
+
28
+
29
+ </head>
30
+ <body>
31
+ <div id="header">
32
+ <div id="menu">
33
+
34
+ <a href="../../_index.html">Index (I)</a> &raquo;
35
+ <span class='title'><span class='object_link'><a href="../../Auth0.html" title="Auth0 (module)">Auth0</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Mixins.html" title="Auth0::Mixins (module)">Mixins</a></span></span>
36
+ &raquo;
37
+ <span class="title">Initializer</span>
38
+
39
+
40
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
41
+ </div>
42
+
43
+ <div id="search">
44
+
45
+ <a class="full_list_link" id="class_list_link"
46
+ href="../../class_list.html">
47
+ Class List
48
+ </a>
49
+
50
+ <a class="full_list_link" id="method_list_link"
51
+ href="../../method_list.html">
52
+ Method List
53
+ </a>
54
+
55
+ <a class="full_list_link" id="file_list_link"
56
+ href="../../file_list.html">
57
+ File List
58
+ </a>
59
+
60
+ </div>
61
+ <div class="clear"></div>
62
+ </div>
63
+
64
+ <iframe id="search_frame"></iframe>
65
+
66
+ <div id="content"><h1>Module: Auth0::Mixins::Initializer
67
+
68
+
69
+
70
+ </h1>
71
+
72
+ <dl class="box">
73
+
74
+
75
+
76
+
77
+
78
+
79
+
80
+ <dt class="r1">Included in:</dt>
81
+ <dd class="r1"><span class='object_link'><a href="../Mixins.html" title="Auth0::Mixins (module)">Auth0::Mixins</a></span></dd>
82
+
83
+
84
+
85
+ <dt class="r2 last">Defined in:</dt>
86
+ <dd class="r2 last">lib/auth0/mixins/initializer.rb</dd>
87
+
88
+ </dl>
89
+ <div class="clear"></div>
90
+
91
+ <h2>Overview</h2><div class="docstring">
92
+ <div class="discussion">
93
+
94
+ <p>Help class where Auth0::Client initialization described</p>
95
+
96
+
97
+ </div>
98
+ </div>
99
+ <div class="tags">
100
+
101
+
102
+ </div>
103
+
104
+
105
+
106
+
107
+
108
+
109
+
110
+ <h2>
111
+ Class Method Summary
112
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
113
+ </h2>
114
+
115
+ <ul class="summary">
116
+
117
+ <li class="public ">
118
+ <span class="summary_signature">
119
+
120
+ <a href="#included-class_method" title="included (class method)">+ (Object) <strong>included</strong>(klass) </a>
121
+
122
+
123
+
124
+ </span>
125
+
126
+
127
+
128
+
129
+
130
+
131
+
132
+
133
+
134
+ <span class="summary_desc"><div class='inline'>
135
+ <p>including initializer in top of klass.</p>
136
+ </div></span>
137
+
138
+ </li>
139
+
140
+
141
+ </ul>
142
+
143
+ <h2>
144
+ Instance Method Summary
145
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
146
+ </h2>
147
+
148
+ <ul class="summary">
149
+
150
+ <li class="public ">
151
+ <span class="summary_signature">
152
+
153
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (Object) <strong>initialize</strong>(config) </a>
154
+
155
+
156
+
157
+ </span>
158
+
159
+
160
+
161
+
162
+
163
+
164
+
165
+
166
+
167
+ <span class="summary_desc"><div class='inline'>
168
+ <p>Default initialization mechanism, moved here to keep Auth0::Client clear
169
+ accepts hash as parameter you can get all required fields from here: <a
170
+ href="https://auth0.com/docs/auth-api">auth0.com/docs/auth-api</a>.</p>
171
+ </div></span>
172
+
173
+ </li>
174
+
175
+
176
+ </ul>
177
+
178
+
179
+
180
+
181
+ <div id="class_method_details" class="method_details_list">
182
+ <h2>Class Method Details</h2>
183
+
184
+
185
+ <div class="method_details first">
186
+ <h3 class="signature first" id="included-class_method">
187
+
188
+ + (<tt>Object</tt>) <strong>included</strong>(klass)
189
+
190
+
191
+
192
+
193
+
194
+ </h3><div class="docstring">
195
+ <div class="discussion">
196
+
197
+ <p>including initializer in top of klass</p>
198
+
199
+
200
+ </div>
201
+ </div>
202
+ <div class="tags">
203
+
204
+
205
+ </div><table class="source_code">
206
+ <tr>
207
+ <td>
208
+ <pre class="lines">
209
+
210
+
211
+ 19
212
+ 20
213
+ 21</pre>
214
+ </td>
215
+ <td>
216
+ <pre class="code"><span class="info file"># File 'lib/auth0/mixins/initializer.rb', line 19</span>
217
+
218
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_included'>included</span><span class='lparen'>(</span><span class='id identifier rubyid_klass'>klass</span><span class='rparen'>)</span>
219
+ <span class='id identifier rubyid_klass'>klass</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span> <span class='symbol'>:prepend</span><span class='comma'>,</span> <span class='const'>Initializer</span>
220
+ <span class='kw'>end</span></pre>
221
+ </td>
222
+ </tr>
223
+ </table>
224
+ </div>
225
+
226
+ </div>
227
+
228
+ <div id="instance_method_details" class="method_details_list">
229
+ <h2>Instance Method Details</h2>
230
+
231
+
232
+ <div class="method_details first">
233
+ <h3 class="signature first" id="initialize-instance_method">
234
+
235
+ - (<tt>Object</tt>) <strong>initialize</strong>(config)
236
+
237
+
238
+
239
+
240
+
241
+ </h3><div class="docstring">
242
+ <div class="discussion">
243
+
244
+ <p>Default initialization mechanism, moved here to keep Auth0::Client clear
245
+ accepts hash as parameter you can get all required fields from here: <a
246
+ href="https://auth0.com/docs/auth-api">auth0.com/docs/auth-api</a></p>
247
+
248
+
249
+ </div>
250
+ </div>
251
+ <div class="tags">
252
+
253
+
254
+ </div><table class="source_code">
255
+ <tr>
256
+ <td>
257
+ <pre class="lines">
258
+
259
+
260
+ 8
261
+ 9
262
+ 10
263
+ 11
264
+ 12
265
+ 13
266
+ 14
267
+ 15
268
+ 16</pre>
269
+ </td>
270
+ <td>
271
+ <pre class="code"><span class="info file"># File 'lib/auth0/mixins/initializer.rb', line 8</span>
272
+
273
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_config'>config</span><span class='rparen'>)</span>
274
+ <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='const'>Hash</span><span class='lbracket'>[</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lbrace'>{</span><span class='op'>|</span><span class='lparen'>(</span><span class='id identifier rubyid_k'>k</span><span class='comma'>,</span><span class='id identifier rubyid_v'>v</span><span class='rparen'>)</span><span class='op'>|</span> <span class='lbracket'>[</span><span class='id identifier rubyid_k'>k</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='comma'>,</span><span class='id identifier rubyid_v'>v</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='rbracket'>]</span>
275
+ <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_base_uri'>base_uri</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>https://</span><span class='tstring_end'>&quot;</span></span><span class='op'>+</span><span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:namespace</span><span class='rbracket'>]</span>
276
+ <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_headers'>headers</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Content-Type</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>application/json</span><span class='tstring_end'>&#39;</span></span>
277
+ <span class='ivar'>@client_id</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:client_id</span><span class='rbracket'>]</span>
278
+ <span class='ivar'>@client_secret</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:client_secret</span><span class='rbracket'>]</span>
279
+ <span class='ivar'>@token</span> <span class='op'>=</span> <span class='id identifier rubyid_obtain_access_token'>obtain_access_token</span>
280
+ <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_headers'>headers</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Authorization</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Bearer </span><span class='embexpr_beg'>#{</span><span class='ivar'>@token</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
281
+ <span class='kw'>end</span></pre>
282
+ </td>
283
+ </tr>
284
+ </table>
285
+ </div>
286
+
287
+ </div>
288
+
289
+ </div>
290
+
291
+ <div id="footer">
292
+ Generated on Mon Jan 26 03:18:46 2015 by
293
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
294
+ 0.8.7.6 (ruby-2.0.0).
295
+ </div>
296
+
297
+ </body>
298
+ </html>