optimizely 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 56d6a8e2116a5dc47d782947d5e886d328d2a349
4
+ data.tar.gz: 6b3fa8d2e138b8f185e143d32e401268860d57b4
5
+ SHA512:
6
+ metadata.gz: bd5bc338f82f455fb43130946e63bd11cde39bc641a4e6ee605111776d48f64c7ccbc462dda84ada75c27f87632a0efd913eb24189c8a4285ece8c5a2f5ea588
7
+ data.tar.gz: 17ef6944f4da2efdb93465f27879591824457852b70d2fbec2577b0c1839a90513d342828f98616070f1a0ef2df3972d38ce45649475488057fe6c80d62a8094
data/.gitignore ADDED
@@ -0,0 +1 @@
1
+ .DS_Store
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source "http://www.rubygems.org"
2
+ gemspec
3
+ gem "bundler"
4
+ gem "json" # 1.8.1
data/Gemfile.lock ADDED
@@ -0,0 +1,17 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ Optimizely (1.0.0)
5
+
6
+ GEM
7
+ remote: http://www.rubygems.org/
8
+ specs:
9
+ json (1.8.1)
10
+
11
+ PLATFORMS
12
+ ruby
13
+
14
+ DEPENDENCIES
15
+ Optimizely!
16
+ bundler
17
+ json
data/LICENSE ADDED
@@ -0,0 +1,339 @@
1
+ GNU GENERAL PUBLIC LICENSE
2
+ Version 2, June 1991
3
+
4
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc., <http://fsf.org/>
5
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
6
+ Everyone is permitted to copy and distribute verbatim copies
7
+ of this license document, but changing it is not allowed.
8
+
9
+ Preamble
10
+
11
+ The licenses for most software are designed to take away your
12
+ freedom to share and change it. By contrast, the GNU General Public
13
+ License is intended to guarantee your freedom to share and change free
14
+ software--to make sure the software is free for all its users. This
15
+ General Public License applies to most of the Free Software
16
+ Foundation's software and to any other program whose authors commit to
17
+ using it. (Some other Free Software Foundation software is covered by
18
+ the GNU Lesser General Public License instead.) You can apply it to
19
+ your programs, too.
20
+
21
+ When we speak of free software, we are referring to freedom, not
22
+ price. Our General Public Licenses are designed to make sure that you
23
+ have the freedom to distribute copies of free software (and charge for
24
+ this service if you wish), that you receive source code or can get it
25
+ if you want it, that you can change the software or use pieces of it
26
+ in new free programs; and that you know you can do these things.
27
+
28
+ To protect your rights, we need to make restrictions that forbid
29
+ anyone to deny you these rights or to ask you to surrender the rights.
30
+ These restrictions translate to certain responsibilities for you if you
31
+ distribute copies of the software, or if you modify it.
32
+
33
+ For example, if you distribute copies of such a program, whether
34
+ gratis or for a fee, you must give the recipients all the rights that
35
+ you have. You must make sure that they, too, receive or can get the
36
+ source code. And you must show them these terms so they know their
37
+ rights.
38
+
39
+ We protect your rights with two steps: (1) copyright the software, and
40
+ (2) offer you this license which gives you legal permission to copy,
41
+ distribute and/or modify the software.
42
+
43
+ Also, for each author's protection and ours, we want to make certain
44
+ that everyone understands that there is no warranty for this free
45
+ software. If the software is modified by someone else and passed on, we
46
+ want its recipients to know that what they have is not the original, so
47
+ that any problems introduced by others will not reflect on the original
48
+ authors' reputations.
49
+
50
+ Finally, any free program is threatened constantly by software
51
+ patents. We wish to avoid the danger that redistributors of a free
52
+ program will individually obtain patent licenses, in effect making the
53
+ program proprietary. To prevent this, we have made it clear that any
54
+ patent must be licensed for everyone's free use or not licensed at all.
55
+
56
+ The precise terms and conditions for copying, distribution and
57
+ modification follow.
58
+
59
+ GNU GENERAL PUBLIC LICENSE
60
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
61
+
62
+ 0. This License applies to any program or other work which contains
63
+ a notice placed by the copyright holder saying it may be distributed
64
+ under the terms of this General Public License. The "Program", below,
65
+ refers to any such program or work, and a "work based on the Program"
66
+ means either the Program or any derivative work under copyright law:
67
+ that is to say, a work containing the Program or a portion of it,
68
+ either verbatim or with modifications and/or translated into another
69
+ language. (Hereinafter, translation is included without limitation in
70
+ the term "modification".) Each licensee is addressed as "you".
71
+
72
+ Activities other than copying, distribution and modification are not
73
+ covered by this License; they are outside its scope. The act of
74
+ running the Program is not restricted, and the output from the Program
75
+ is covered only if its contents constitute a work based on the
76
+ Program (independent of having been made by running the Program).
77
+ Whether that is true depends on what the Program does.
78
+
79
+ 1. You may copy and distribute verbatim copies of the Program's
80
+ source code as you receive it, in any medium, provided that you
81
+ conspicuously and appropriately publish on each copy an appropriate
82
+ copyright notice and disclaimer of warranty; keep intact all the
83
+ notices that refer to this License and to the absence of any warranty;
84
+ and give any other recipients of the Program a copy of this License
85
+ along with the Program.
86
+
87
+ You may charge a fee for the physical act of transferring a copy, and
88
+ you may at your option offer warranty protection in exchange for a fee.
89
+
90
+ 2. You may modify your copy or copies of the Program or any portion
91
+ of it, thus forming a work based on the Program, and copy and
92
+ distribute such modifications or work under the terms of Section 1
93
+ above, provided that you also meet all of these conditions:
94
+
95
+ a) You must cause the modified files to carry prominent notices
96
+ stating that you changed the files and the date of any change.
97
+
98
+ b) You must cause any work that you distribute or publish, that in
99
+ whole or in part contains or is derived from the Program or any
100
+ part thereof, to be licensed as a whole at no charge to all third
101
+ parties under the terms of this License.
102
+
103
+ c) If the modified program normally reads commands interactively
104
+ when run, you must cause it, when started running for such
105
+ interactive use in the most ordinary way, to print or display an
106
+ announcement including an appropriate copyright notice and a
107
+ notice that there is no warranty (or else, saying that you provide
108
+ a warranty) and that users may redistribute the program under
109
+ these conditions, and telling the user how to view a copy of this
110
+ License. (Exception: if the Program itself is interactive but
111
+ does not normally print such an announcement, your work based on
112
+ the Program is not required to print an announcement.)
113
+
114
+ These requirements apply to the modified work as a whole. If
115
+ identifiable sections of that work are not derived from the Program,
116
+ and can be reasonably considered independent and separate works in
117
+ themselves, then this License, and its terms, do not apply to those
118
+ sections when you distribute them as separate works. But when you
119
+ distribute the same sections as part of a whole which is a work based
120
+ on the Program, the distribution of the whole must be on the terms of
121
+ this License, whose permissions for other licensees extend to the
122
+ entire whole, and thus to each and every part regardless of who wrote it.
123
+
124
+ Thus, it is not the intent of this section to claim rights or contest
125
+ your rights to work written entirely by you; rather, the intent is to
126
+ exercise the right to control the distribution of derivative or
127
+ collective works based on the Program.
128
+
129
+ In addition, mere aggregation of another work not based on the Program
130
+ with the Program (or with a work based on the Program) on a volume of
131
+ a storage or distribution medium does not bring the other work under
132
+ the scope of this License.
133
+
134
+ 3. You may copy and distribute the Program (or a work based on it,
135
+ under Section 2) in object code or executable form under the terms of
136
+ Sections 1 and 2 above provided that you also do one of the following:
137
+
138
+ a) Accompany it with the complete corresponding machine-readable
139
+ source code, which must be distributed under the terms of Sections
140
+ 1 and 2 above on a medium customarily used for software interchange; or,
141
+
142
+ b) Accompany it with a written offer, valid for at least three
143
+ years, to give any third party, for a charge no more than your
144
+ cost of physically performing source distribution, a complete
145
+ machine-readable copy of the corresponding source code, to be
146
+ distributed under the terms of Sections 1 and 2 above on a medium
147
+ customarily used for software interchange; or,
148
+
149
+ c) Accompany it with the information you received as to the offer
150
+ to distribute corresponding source code. (This alternative is
151
+ allowed only for noncommercial distribution and only if you
152
+ received the program in object code or executable form with such
153
+ an offer, in accord with Subsection b above.)
154
+
155
+ The source code for a work means the preferred form of the work for
156
+ making modifications to it. For an executable work, complete source
157
+ code means all the source code for all modules it contains, plus any
158
+ associated interface definition files, plus the scripts used to
159
+ control compilation and installation of the executable. However, as a
160
+ special exception, the source code distributed need not include
161
+ anything that is normally distributed (in either source or binary
162
+ form) with the major components (compiler, kernel, and so on) of the
163
+ operating system on which the executable runs, unless that component
164
+ itself accompanies the executable.
165
+
166
+ If distribution of executable or object code is made by offering
167
+ access to copy from a designated place, then offering equivalent
168
+ access to copy the source code from the same place counts as
169
+ distribution of the source code, even though third parties are not
170
+ compelled to copy the source along with the object code.
171
+
172
+ 4. You may not copy, modify, sublicense, or distribute the Program
173
+ except as expressly provided under this License. Any attempt
174
+ otherwise to copy, modify, sublicense or distribute the Program is
175
+ void, and will automatically terminate your rights under this License.
176
+ However, parties who have received copies, or rights, from you under
177
+ this License will not have their licenses terminated so long as such
178
+ parties remain in full compliance.
179
+
180
+ 5. You are not required to accept this License, since you have not
181
+ signed it. However, nothing else grants you permission to modify or
182
+ distribute the Program or its derivative works. These actions are
183
+ prohibited by law if you do not accept this License. Therefore, by
184
+ modifying or distributing the Program (or any work based on the
185
+ Program), you indicate your acceptance of this License to do so, and
186
+ all its terms and conditions for copying, distributing or modifying
187
+ the Program or works based on it.
188
+
189
+ 6. Each time you redistribute the Program (or any work based on the
190
+ Program), the recipient automatically receives a license from the
191
+ original licensor to copy, distribute or modify the Program subject to
192
+ these terms and conditions. You may not impose any further
193
+ restrictions on the recipients' exercise of the rights granted herein.
194
+ You are not responsible for enforcing compliance by third parties to
195
+ this License.
196
+
197
+ 7. If, as a consequence of a court judgment or allegation of patent
198
+ infringement or for any other reason (not limited to patent issues),
199
+ conditions are imposed on you (whether by court order, agreement or
200
+ otherwise) that contradict the conditions of this License, they do not
201
+ excuse you from the conditions of this License. If you cannot
202
+ distribute so as to satisfy simultaneously your obligations under this
203
+ License and any other pertinent obligations, then as a consequence you
204
+ may not distribute the Program at all. For example, if a patent
205
+ license would not permit royalty-free redistribution of the Program by
206
+ all those who receive copies directly or indirectly through you, then
207
+ the only way you could satisfy both it and this License would be to
208
+ refrain entirely from distribution of the Program.
209
+
210
+ If any portion of this section is held invalid or unenforceable under
211
+ any particular circumstance, the balance of the section is intended to
212
+ apply and the section as a whole is intended to apply in other
213
+ circumstances.
214
+
215
+ It is not the purpose of this section to induce you to infringe any
216
+ patents or other property right claims or to contest validity of any
217
+ such claims; this section has the sole purpose of protecting the
218
+ integrity of the free software distribution system, which is
219
+ implemented by public license practices. Many people have made
220
+ generous contributions to the wide range of software distributed
221
+ through that system in reliance on consistent application of that
222
+ system; it is up to the author/donor to decide if he or she is willing
223
+ to distribute software through any other system and a licensee cannot
224
+ impose that choice.
225
+
226
+ This section is intended to make thoroughly clear what is believed to
227
+ be a consequence of the rest of this License.
228
+
229
+ 8. If the distribution and/or use of the Program is restricted in
230
+ certain countries either by patents or by copyrighted interfaces, the
231
+ original copyright holder who places the Program under this License
232
+ may add an explicit geographical distribution limitation excluding
233
+ those countries, so that distribution is permitted only in or among
234
+ countries not thus excluded. In such case, this License incorporates
235
+ the limitation as if written in the body of this License.
236
+
237
+ 9. The Free Software Foundation may publish revised and/or new versions
238
+ of the General Public License from time to time. Such new versions will
239
+ be similar in spirit to the present version, but may differ in detail to
240
+ address new problems or concerns.
241
+
242
+ Each version is given a distinguishing version number. If the Program
243
+ specifies a version number of this License which applies to it and "any
244
+ later version", you have the option of following the terms and conditions
245
+ either of that version or of any later version published by the Free
246
+ Software Foundation. If the Program does not specify a version number of
247
+ this License, you may choose any version ever published by the Free Software
248
+ Foundation.
249
+
250
+ 10. If you wish to incorporate parts of the Program into other free
251
+ programs whose distribution conditions are different, write to the author
252
+ to ask for permission. For software which is copyrighted by the Free
253
+ Software Foundation, write to the Free Software Foundation; we sometimes
254
+ make exceptions for this. Our decision will be guided by the two goals
255
+ of preserving the free status of all derivatives of our free software and
256
+ of promoting the sharing and reuse of software generally.
257
+
258
+ NO WARRANTY
259
+
260
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
261
+ FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
262
+ OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
263
+ PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
264
+ OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
265
+ MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
266
+ TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
267
+ PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
268
+ REPAIR OR CORRECTION.
269
+
270
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
271
+ WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
272
+ REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
273
+ INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
274
+ OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
275
+ TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
276
+ YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
277
+ PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
278
+ POSSIBILITY OF SUCH DAMAGES.
279
+
280
+ END OF TERMS AND CONDITIONS
281
+
282
+ How to Apply These Terms to Your New Programs
283
+
284
+ If you develop a new program, and you want it to be of the greatest
285
+ possible use to the public, the best way to achieve this is to make it
286
+ free software which everyone can redistribute and change under these terms.
287
+
288
+ To do so, attach the following notices to the program. It is safest
289
+ to attach them to the start of each source file to most effectively
290
+ convey the exclusion of warranty; and each file should have at least
291
+ the "copyright" line and a pointer to where the full notice is found.
292
+
293
+ {description}
294
+ Copyright (C) {year} {fullname}
295
+
296
+ This program is free software; you can redistribute it and/or modify
297
+ it under the terms of the GNU General Public License as published by
298
+ the Free Software Foundation; either version 2 of the License, or
299
+ (at your option) any later version.
300
+
301
+ This program is distributed in the hope that it will be useful,
302
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
303
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
304
+ GNU General Public License for more details.
305
+
306
+ You should have received a copy of the GNU General Public License along
307
+ with this program; if not, write to the Free Software Foundation, Inc.,
308
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
309
+
310
+ Also add information on how to contact you by electronic and paper mail.
311
+
312
+ If the program is interactive, make it output a short notice like this
313
+ when it starts in an interactive mode:
314
+
315
+ Gnomovision version 69, Copyright (C) year name of author
316
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
317
+ This is free software, and you are welcome to redistribute it
318
+ under certain conditions; type `show c' for details.
319
+
320
+ The hypothetical commands `show w' and `show c' should show the appropriate
321
+ parts of the General Public License. Of course, the commands you use may
322
+ be called something other than `show w' and `show c'; they could even be
323
+ mouse-clicks or menu items--whatever suits your program.
324
+
325
+ You should also get your employer (if you work as a programmer) or your
326
+ school, if any, to sign a "copyright disclaimer" for the program, if
327
+ necessary. Here is a sample; alter the names:
328
+
329
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
330
+ `Gnomovision' (which makes passes at compilers) written by James Hacker.
331
+
332
+ {signature of Ty Coon}, 1 April 1989
333
+ Ty Coon, President of Vice
334
+
335
+ This General Public License does not permit incorporating your program into
336
+ proprietary programs. If your program is a subroutine library, you may
337
+ consider it more useful to permit linking proprietary applications with the
338
+ library. If this is what you want to do, use the GNU Lesser General
339
+ Public License instead of this License.
data/README.md ADDED
@@ -0,0 +1,68 @@
1
+ Optimizely
2
+ ===========
3
+
4
+ The unofficial (basic) Ruby gem to communicate with the Optimizely Experiment API (http://developers.optimizely.com/rest/).
5
+ The Experiment API lets you create and manage Optimizely projects and the experiments inside of them.
6
+
7
+ To start using the Optimizely Experiment API you need an API Token, you can request one via: developers@optimizely.com
8
+
9
+ # Quick start
10
+
11
+ ## Installation
12
+
13
+ Add Optimizely to your Gemfile
14
+
15
+ gem 'optimizely'
16
+
17
+ Don't forget to bundle install:
18
+
19
+ $ bundle install
20
+
21
+ # General usage
22
+
23
+ ### Create your Optimizely object
24
+
25
+ optimizely = Optimizely.new({ api_token: 'abcdefghijklmnopqrstuvwxyz:123456' })
26
+
27
+ ## Projects
28
+
29
+ Retrieve all projects:
30
+ projects = optimizely.projects
31
+
32
+ ## Experiments
33
+
34
+ Retrieve all experiments for a project:
35
+ experiments = optimizely.experiments(12345)
36
+
37
+ ## Variations
38
+
39
+ Retrieve all variations for an experiment:
40
+ variations = optimizely.variations(12345)
41
+
42
+ ## Audiences
43
+
44
+ Retrieve all audiences for an project:
45
+ audiences = optimizely.audiences(12345)
46
+
47
+ # Information
48
+
49
+ ### Changelog
50
+
51
+ #### 1.0
52
+ * Add all basic features for the Optimizely Experiment API.
53
+
54
+ ### Bug reports
55
+
56
+ If you discover any bugs, feel free to create an issue on GitHub. Please add as much information as
57
+ possible to help us fixing the possible bug. We also encourage you to help even more by forking and
58
+ sending us a pull request.
59
+
60
+ https://github.com/martijnsch/optimizely-gem/issues
61
+
62
+ ### Contributing
63
+
64
+ 1. Fork it
65
+ 2. Create your feature branch (`git checkout -b my-new-feature`)
66
+ 3. Commit your changes (`git commit -am 'Add some feature'`)
67
+ 4. Push to the branch (`git push origin my-new-feature`)
68
+ 5. Create a new pull request
data/Rakefile ADDED
File without changes
@@ -0,0 +1,5 @@
1
+ module Optimizely
2
+ class Audience
3
+
4
+ end
5
+ end
@@ -0,0 +1,138 @@
1
+ module Optimizely
2
+ class Engine
3
+
4
+ BASE_URL = "https://www.optimizelyapis.com/experiment/v1/"
5
+
6
+ # Initialize Optimizely using an API token.
7
+ #
8
+ # == Options:
9
+ # +:api_token+:: Use an API token you received before.
10
+ # +:timeout+:: Set Net:HTTP timeout in seconds (default is 300).
11
+ #
12
+ def initialize(options={})
13
+ @options = options
14
+ check_init_auth_requirements
15
+ end
16
+
17
+ # Initalize the Token so it can be used in every request we'll do later on.
18
+ # Besides that also set the authentication header.
19
+ def token=(token)
20
+ @token = token
21
+ set_headers
22
+ end
23
+
24
+ # Returns the list of projects available to the authenticated user.
25
+ #
26
+ # == Usage
27
+ # optimizely = Optimizely.new({ api_token: 'oauth2_token' })
28
+ # projects = optimizely.projects # Look up all projects.
29
+ #
30
+ def projects
31
+ @projects = self.get("projects") if @projects.nil?
32
+ @projects
33
+ end
34
+
35
+ # Returns the list of experiments for a specified project.
36
+ #
37
+ # == Usage
38
+ # optimizely = Optimizely.new({ api_token: 'oauth2_token' })
39
+ # experiments = optimizely.experiments(12345) # Look up all experiments for a project.
40
+ #
41
+ def experiments(project_id)
42
+ raise OptimizelyError::NoProjectID, "A Project ID required to retrieve experiments." if project_id.nil?
43
+ @experiments = self.get("projects/#{project_id}/experiments") if @experiments.nil?
44
+ @experiments
45
+ end
46
+
47
+ # Returns the list of variations for a specified experiment.
48
+ #
49
+ # == Usage
50
+ # optimizely = Optimizely.new({ api_token: 'oauth2_token' })
51
+ # variations = optimizely.variations(12345) # Look up all variations for an experiment.
52
+ #
53
+ def variations(experiment_id)
54
+ raise OptimizelyError::NoExperimentID, "An Experiment ID required to retrieve variations." if experiment_id.nil?
55
+ @variations = self.get("projects/#{experiment_id}/variations") if @variations.nil?
56
+ @experiments
57
+ end
58
+
59
+ # Returns the list of audiences for a specified project.
60
+ #
61
+ # == Usage
62
+ # optimizely = Optimizely.new({ api_token: 'oauth2_token' })
63
+ # audiences = optimizely.audiences(12345) # Look up all audiences for a project.
64
+ #
65
+ def audiences(project_id)
66
+ raise OptimizelyError::NoProjectID, "A Project ID required to retrieve audiences." if project_id.nil?
67
+ @audiences = self.get("projects/#{project_id}/audiences") if @audiences.nil?
68
+ @audiences
69
+ end
70
+
71
+ def get(url)
72
+ uri = URI.parse("#{BASE_URL}#{url}/")
73
+ https = Net::HTTP.new(uri.host, uri.port)
74
+ https.read_timeout = @options[:timeout] if @options[:timeout]
75
+ https.verify_mode = OpenSSL::SSL::VERIFY_NONE
76
+ https.use_ssl = true
77
+ request = Net::HTTP::Get.new(uri.request_uri, @headers)
78
+ response = https.request(request)
79
+
80
+ # Response code error checking
81
+ if response.code != '200'
82
+ case response.code
83
+ when '400'
84
+ raise OptimizelyError::BadRequest, response.body + "Your request was not sent in valid JSON. (status code: #{response.code})."
85
+ when '401'
86
+ raise OptimizelyError::Unauthorized, "Your API token was missing or included in the body rather than the header (status code: #{response.code})."
87
+ when '403'
88
+ raise OptimizelyError::Forbidden, response.body + "You provided an API token but it was invalid or revoked, or if you don't have read/ write access to the entity you're trying to view/edit (status code: #{response.code})."
89
+ when '404'
90
+ raise OptimizelyError::NotFound, response.body + "The id used in the request was inaccurate or you didn't have permission to view/edit it (status code: #{response.code})."
91
+ else
92
+ raise OptimizelyError::UnknownError, response.body + "(status code: #{response.code})."
93
+ end
94
+ else
95
+ parse_json(response.body)
96
+ end
97
+ end
98
+
99
+ def post()
100
+
101
+ end
102
+
103
+ def put()
104
+
105
+ end
106
+
107
+ def delete()
108
+
109
+ end
110
+
111
+
112
+ private
113
+
114
+
115
+ # If there is no API token or an empty API token raise an exception.
116
+ def check_init_auth_requirements
117
+ if @options[:api_token].nil? || @options[:api_token].empty?
118
+ raise OptimizelyError::NoAPIToken, "An API token is required to initialize Optimizely."
119
+ else
120
+ self.token = @options[:api_token]
121
+ end
122
+ end
123
+
124
+ # As the authentication for the Optimizely Experiments API is handled via the
125
+ # Token header in every request we set the header + also make clear we expect JSON.
126
+ def set_headers
127
+ @headers = {}
128
+ @headers['Token'] = @token
129
+ @headers['Content-Type'] = "application/json"
130
+ end
131
+
132
+ # Parse the JSON data that's been requested through the get method.
133
+ def parse_json(data)
134
+ json = JSON.parse(data)
135
+ json
136
+ end
137
+ end
138
+ end
@@ -0,0 +1,15 @@
1
+ module OptimizelyError
2
+ # Authentication Error
3
+ class NoAPIToken < StandardError; end;
4
+
5
+ # Request Error
6
+ class BadRequest < StandardError; end;
7
+ class Unauthorized < StandardError; end;
8
+ class Forbidden < StandardError; end;
9
+ class NotFound < StandardError; end;
10
+ class UnknownError < StandardError; end;
11
+
12
+ # Request Error
13
+ class NoProjectID < StandardError; end;
14
+ class NoExperimentID < StandardError; end;
15
+ end
@@ -0,0 +1,5 @@
1
+ module Optimizely
2
+ class Experiment
3
+
4
+ end
5
+ end
@@ -0,0 +1,5 @@
1
+ module Optimizely
2
+ class Project
3
+
4
+ end
5
+ end
@@ -0,0 +1,5 @@
1
+ module Optimizely
2
+ class Variation
3
+
4
+ end
5
+ end
@@ -0,0 +1,3 @@
1
+ module Optimizely
2
+ VERSION = "1.0.0"
3
+ end
data/lib/optimizely.rb ADDED
@@ -0,0 +1,23 @@
1
+ $:.unshift File.dirname(__FILE__) # For testing when no gem is installed
2
+
3
+ require "net/http"
4
+ require "net/https"
5
+ require "uri"
6
+ require "json"
7
+ require "openssl"
8
+
9
+ require "optimizely/audience"
10
+ require "optimizely/engine"
11
+ require "optimizely/exceptions"
12
+ require "optimizely/experiment"
13
+ require "optimizely/project"
14
+ require "optimizely/variation"
15
+ require "optimizely/version"
16
+
17
+ # Optimizely is a Ruby library for talking to the Optimizely Experiments API.
18
+ # Please see the README for usage documentation.
19
+ module Optimizely
20
+ def self.new(*args)
21
+ Engine.new(*args)
22
+ end
23
+ end
@@ -0,0 +1,19 @@
1
+ # -*- encoding: utf-8 -*-
2
+ $:.push File.expand_path("../lib", __FILE__)
3
+ require "optimizely/version"
4
+
5
+ Gem::Specification.new do |s|
6
+ s.name = "optimizely"
7
+ s.version = Optimizely::VERSION
8
+ s.platform = Gem::Platform::RUBY
9
+ s.author = "Martijn Scheijbeler"
10
+ s.email = "martijn@marusem.com"
11
+ s.homepage = "https://github.com/martijnsch/optimizely-gem/"
12
+ s.summary = %q{The Optimizely Experiment API lets you create and manage Optimizely projects and the experiments inside of them.}
13
+ s.description = %q{A Ruby gem to communicate with the Optimizely Experiments API, it lets you create and manage Optimizely projects and the experiments inside of them.}
14
+ s.files = `git ls-files`.split("\n")
15
+ s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
16
+ s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
17
+ s.require_paths = ["lib"]
18
+ s.extra_rdoc_files = ["README.md"]
19
+ end
metadata ADDED
@@ -0,0 +1,60 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: optimizely
3
+ version: !ruby/object:Gem::Version
4
+ version: 1.0.0
5
+ platform: ruby
6
+ authors:
7
+ - Martijn Scheijbeler
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2014-04-30 00:00:00.000000000 Z
12
+ dependencies: []
13
+ description: A Ruby gem to communicate with the Optimizely Experiments API, it lets
14
+ you create and manage Optimizely projects and the experiments inside of them.
15
+ email: martijn@marusem.com
16
+ executables: []
17
+ extensions: []
18
+ extra_rdoc_files:
19
+ - README.md
20
+ files:
21
+ - .gitignore
22
+ - Gemfile
23
+ - Gemfile.lock
24
+ - LICENSE
25
+ - README.md
26
+ - Rakefile
27
+ - lib/optimizely.rb
28
+ - lib/optimizely/audience.rb
29
+ - lib/optimizely/engine.rb
30
+ - lib/optimizely/exceptions.rb
31
+ - lib/optimizely/experiment.rb
32
+ - lib/optimizely/project.rb
33
+ - lib/optimizely/variation.rb
34
+ - lib/optimizely/version.rb
35
+ - optimizely.gemspec
36
+ homepage: https://github.com/martijnsch/optimizely-gem/
37
+ licenses: []
38
+ metadata: {}
39
+ post_install_message:
40
+ rdoc_options: []
41
+ require_paths:
42
+ - lib
43
+ required_ruby_version: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - '>='
46
+ - !ruby/object:Gem::Version
47
+ version: '0'
48
+ required_rubygems_version: !ruby/object:Gem::Requirement
49
+ requirements:
50
+ - - '>='
51
+ - !ruby/object:Gem::Version
52
+ version: '0'
53
+ requirements: []
54
+ rubyforge_project:
55
+ rubygems_version: 2.0.14
56
+ signing_key:
57
+ specification_version: 4
58
+ summary: The Optimizely Experiment API lets you create and manage Optimizely projects
59
+ and the experiments inside of them.
60
+ test_files: []