flukso4r 0.1.0

Sign up to get free protection for your applications and to get access to all the features.

Potentially problematic release.


This version of flukso4r might be problematic. Click here for more details.

data/LICENSE ADDED
@@ -0,0 +1,279 @@
1
+ GNU GENERAL PUBLIC LICENSE
2
+ Version 2, June 1991
3
+
4
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
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
+
data/README.rdoc ADDED
@@ -0,0 +1,27 @@
1
+ = flukso4r
2
+
3
+ This is the Flukso4R library, available from
4
+
5
+ http://gonium.net/md/flukso4r
6
+
7
+ You can use it to query the Flukso
8
+ webservice. Have a look at the bin/flukso_query script.
9
+
10
+ The code in lib is a cheap knockoff of the twitter ruby gem - many
11
+ thanks to John Nunemaker! You can find the twitter ruby gem here:
12
+
13
+ http://twitter.rubyforge.org/
14
+
15
+ == Note on Patches/Pull Requests
16
+
17
+ * Fork the project.
18
+ * Make your feature addition or bug fix.
19
+ * Add tests for it. This is important so I don't break it in a
20
+ future version unintentionally.
21
+ * Commit, do not mess with rakefile, version, or history.
22
+ (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
23
+ * Send me a pull request. Bonus points for topic branches.
24
+
25
+ == Copyright
26
+
27
+ Copyright (c) 2010 Mathias Dalheimer. See LICENSE for details.
data/Rakefile ADDED
@@ -0,0 +1,59 @@
1
+ require 'rubygems'
2
+ require 'rake'
3
+
4
+ begin
5
+ require 'jeweler'
6
+ Jeweler::Tasks.new do |gem|
7
+ gem.name = "flukso4r"
8
+ gem.summary = %Q{A Ruby Library for the Flukso Webservice}
9
+ gem.description = %Q{This gem provides a library for the Flukso API. See http://flukso.net for more information.}
10
+ gem.email = "md@gonium.net"
11
+ gem.homepage = "http://gonium.net/md/flukso4r"
12
+ gem.authors = ["Mathias Dalheimer"]
13
+ gem.bindir = 'bin'
14
+ gem.executables = ['flukso_query']
15
+ gem.default_executable = 'flukso_query'
16
+ gem.files = FileList["[A-Z]*", "{bin,lib,test}/**/*"]
17
+
18
+ gem.add_dependency('oauth', '~> 0.3.6')
19
+ gem.add_dependency('httparty', '~> 0.4.3')
20
+ gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
21
+ # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
22
+ end
23
+ Jeweler::GemcutterTasks.new
24
+ rescue LoadError
25
+ puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
26
+ end
27
+
28
+ require 'rake/testtask'
29
+ Rake::TestTask.new(:test) do |test|
30
+ test.libs << 'lib' << 'test'
31
+ test.pattern = 'test/**/test_*.rb'
32
+ test.verbose = true
33
+ end
34
+
35
+ begin
36
+ require 'rcov/rcovtask'
37
+ Rcov::RcovTask.new do |test|
38
+ test.libs << 'test'
39
+ test.pattern = 'test/**/test_*.rb'
40
+ test.verbose = true
41
+ end
42
+ rescue LoadError
43
+ task :rcov do
44
+ abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
45
+ end
46
+ end
47
+
48
+ task :test => :check_dependencies
49
+ task :default => :test
50
+
51
+ require 'rake/rdoctask'
52
+ Rake::RDocTask.new do |rdoc|
53
+ version = File.exist?('VERSION') ? File.read('VERSION') : ""
54
+
55
+ rdoc.rdoc_dir = 'rdoc'
56
+ rdoc.title = "flukso4r #{version}"
57
+ rdoc.rdoc_files.include('README*')
58
+ rdoc.rdoc_files.include('lib/**/*.rb')
59
+ end
data/VERSION ADDED
@@ -0,0 +1 @@
1
+ 0.1.0
data/bin/flukso_query ADDED
@@ -0,0 +1,129 @@
1
+ #!/usr/bin/env ruby
2
+ ###
3
+ ##
4
+ # flukso4r: A Ruby library for Flukso
5
+ # Copyright (C) 2010 Mathias Dalheimer (md@gonium.net)
6
+ #
7
+ # This program is free software; you can redistribute it and/or modify
8
+ # it under the terms of the GNU General Public License as published by
9
+ # the Free Software Foundation; either version 2 of the License, or
10
+ # any later version.
11
+ #
12
+ # This program is distributed in the hope that it will be useful,
13
+ # but WITHOUT ANY WARRANTY; without even the implied warranty of
14
+ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15
+ # GNU General Public License for more details.
16
+ #
17
+ # You should have received a copy of the GNU General Public License along
18
+ # with this program; if not, write to the Free Software Foundation, Inc.,
19
+ # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20
+ ##
21
+ ###
22
+
23
+ # Read the flukso4r location
24
+ libpath=File.join(File.dirname(__FILE__), '..', 'lib')
25
+ $:.unshift << libpath
26
+ #puts "Using libraty path #{$:.join(":")}"
27
+
28
+ require 'flukso'
29
+ require 'optparse'
30
+ require 'ostruct'
31
+
32
+ ###
33
+ ## Commandline parser
34
+ #
35
+ class Optparser
36
+ CODES = %w[iso-2022-jp shift_jis euc-jp utf8 binary]
37
+ CODE_ALIASES = { "jis" => "iso-2022-jp", "sjis" => "shift_jis" }
38
+ #
39
+ # Return a structure describing the options.
40
+ #
41
+ def self.parse(args)
42
+ # The options specified on the command line will be collected in *options*.
43
+ # We set default values here.
44
+ options = OpenStruct.new
45
+ options.inplace = false
46
+ options.encoding = "utf8"
47
+ options.verbose = false
48
+ opts = OptionParser.new do |opts|
49
+ opts.banner = "Usage: #{$0} [options]"
50
+ opts.separator ""
51
+ opts.separator "Specific options:"
52
+ opts.on("-t", "--timerange VALUE", "The time range you want to query. Valid queries are: {hour, day, month, year}") do |timerange|
53
+ options.timerange = timerange
54
+ end
55
+ opts.on("-u", "--unit VALUE", "The unit you want to query. Valid queries are: {watt, kwh, eur, aud}") do |unit|
56
+ options.unit = unit
57
+ end
58
+ opts.on("-u", "--unit VALUE", "The unit you want to query. Valid queries are: {watt, kwh, eur, aud}") do |unit|
59
+ options.unit = unit
60
+ end
61
+ opts.on("-a", "--alias VALUE", "The device alias you want to query.") do |alias_id|
62
+ options.alias_id = alias_id
63
+ end
64
+ # Boolean switch.
65
+ opts.on("-v", "--verbose", "Run verbosely") do |v|
66
+ options.verbose = v
67
+ end
68
+ opts.on_tail("-h", "--help", "Show this message") do
69
+ puts opts
70
+ exit
71
+ end
72
+ end
73
+ opts.parse!(args)
74
+ options
75
+ end
76
+ end
77
+
78
+ ###
79
+ ## Script startup
80
+ #
81
+ options = Optparser.parse(ARGV)
82
+ $verbose = options.verbose
83
+ case options.timerange
84
+ when /^hour$/i
85
+ range=:hour
86
+ when /^day$/i
87
+ range=:day
88
+ when /^month$/i
89
+ range=:month
90
+ when /^year$/i
91
+ range=:year
92
+ else begin
93
+ puts "Invalid timerange: #{options.timerange} - see -h for more information."
94
+ exit(-1);
95
+ end
96
+ end
97
+ case options.unit
98
+ when /^watt$/i
99
+ unit=:watt
100
+ when /^kwh$/i
101
+ unit=:kwh
102
+ when /^eur$/i
103
+ unit=:eur
104
+ when /^aud$/i
105
+ unit=:aud
106
+ else begin
107
+ puts "Invalid unit: #{options.unit} - see -h for more information."
108
+ exit(-2);
109
+ end
110
+ end
111
+ alias_id=options.alias_id
112
+
113
+ # No authentication by now.
114
+ auth=Flukso::HTTPAuth.new("", "");
115
+ api=Flukso::API.new(auth);
116
+ query=Flukso::QueryReadings.new(alias_id, range, unit)
117
+ begin
118
+ readings=query.execute(api);
119
+ rescue Exception => e
120
+ puts "Query failed: #{e}"
121
+ exit(-10);
122
+ end
123
+
124
+ puts "Got Response:"
125
+ readings.each{|reading|
126
+ puts reading
127
+ }
128
+
129
+
data/lib/flukso/api.rb ADDED
@@ -0,0 +1,98 @@
1
+ ###
2
+ ##
3
+ # flukso4r: A Ruby library for Flukso
4
+ # Copyright (C) 2010 Mathias Dalheimer (md@gonium.net)
5
+ #
6
+ # This program is free software; you can redistribute it and/or modify
7
+ # it under the terms of the GNU General Public License as published by
8
+ # the Free Software Foundation; either version 2 of the License, or
9
+ # any later version.
10
+ #
11
+ # This program is distributed in the hope that it will be useful,
12
+ # but WITHOUT ANY WARRANTY; without even the implied warranty of
13
+ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14
+ # GNU General Public License for more details.
15
+ #
16
+ # You should have received a copy of the GNU General Public License along
17
+ # with this program; if not, write to the Free Software Foundation, Inc.,
18
+ # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
19
+ ##
20
+ ###
21
+
22
+
23
+ module Flukso
24
+ class QueryReadings
25
+ def initialize(alias_id, timerange=:hour, unit=:watt)
26
+ @alias_id=alias_id;
27
+ # sanity checks.
28
+ valid_timeranges=[:hour, :day, :month, :year];
29
+ valid_units=[:watt, :kwh, :eur, :aud];
30
+ raise Flukso::General, "Invalid timerange #{timerange}" unless valid_timeranges.include?(timerange);
31
+ raise Flukso::General, "Invalid unit #{unit}" unless valid_units.include?(unit);
32
+ @timerange=timerange;
33
+ @unit=unit;
34
+ end
35
+ def execute(api)
36
+ if api.class != Flukso::API
37
+ raise Flukso::General, "Cannot execute query: API object invalid"
38
+ end
39
+ query_url="#{Flukso::BASE_SENSOR_URL}/#{@alias_id}/#{@timerange}/#{@unit}";
40
+ puts "Using query url #{query_url}" if $verbose
41
+ response = api.perform_get(query_url)
42
+ return wrap_response(response);
43
+ end
44
+ def wrap_response(response)
45
+ # The response is an array of arrays. Convert it to UTCReadings.
46
+ retval=Array.new();
47
+ response.each{|reading|
48
+ current=UTCReading.new(reading[0].to_i, reading[1].to_i);
49
+ retval << current;
50
+ }
51
+ return retval
52
+ end
53
+ end
54
+
55
+ class UTCReading
56
+ attr_accessor :utc_timestamp, :value
57
+ def initialize(utc_timestamp, value)
58
+ # sanity checks.
59
+ raise Flukso::General, "Invalid reading timestamp: #{utc_timestamp}" if utc_timestamp.class != Bignum || utc_timestamp < 0;
60
+ # TODO: Think about behavior when NaN is reported by the
61
+ # webservice.
62
+ #raise Flukso::General, "Invalid reading value: #{value}" if value.class != Fixnum || value < 0;
63
+ @utc_timestamp = utc_timestamp;
64
+ @value = value
65
+ end
66
+ def to_s
67
+ return "#{@utc_timestamp} -> #{@value}"
68
+ end
69
+ end
70
+
71
+ class API
72
+ extend Forwardable
73
+
74
+ def_delegators :client, :get, :post, :put, :delete
75
+
76
+ attr_reader :client
77
+
78
+ def initialize(client)
79
+ @client = client
80
+ end
81
+
82
+ def perform_get(path, options={})
83
+ Flukso::Request.get(self, path, options)
84
+ end
85
+
86
+ def perform_post(path, options={})
87
+ Flukso::Request.post(self, path, options)
88
+ end
89
+
90
+ def perform_put(path, options={})
91
+ Flukso::Request.put(self, path, options)
92
+ end
93
+
94
+ def perform_delete(path, options={})
95
+ Flukso::Request.delete(self, path, options)
96
+ end
97
+ end
98
+ end
@@ -0,0 +1,57 @@
1
+ ###
2
+ ##
3
+ # flukso4r: A Ruby library for Flukso
4
+ # Copyright (C) 2010 Mathias Dalheimer (md@gonium.net)
5
+ #
6
+ # This program is free software; you can redistribute it and/or modify
7
+ # it under the terms of the GNU General Public License as published by
8
+ # the Free Software Foundation; either version 2 of the License, or
9
+ # any later version.
10
+ #
11
+ # This program is distributed in the hope that it will be useful,
12
+ # but WITHOUT ANY WARRANTY; without even the implied warranty of
13
+ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14
+ # GNU General Public License for more details.
15
+ #
16
+ # You should have received a copy of the GNU General Public License along
17
+ # with this program; if not, write to the Free Software Foundation, Inc.,
18
+ # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
19
+ ##
20
+ ###
21
+
22
+
23
+ module Flukso
24
+ class HTTPAuth
25
+ include HTTParty
26
+ format :plain
27
+
28
+ attr_reader :username, :password, :options
29
+
30
+ def initialize(username, password, options={})
31
+ @username, @password = username, password
32
+ @options = {:ssl => false}.merge(options)
33
+ self.class.base_uri "http#{'s' if options[:ssl]}://api.flukso.net"
34
+ end
35
+
36
+ def get(uri, headers={})
37
+ self.class.get(uri, :headers => headers, :basic_auth => basic_auth)
38
+ end
39
+
40
+ def post(uri, body={}, headers={})
41
+ self.class.post(uri, :body => body, :headers => headers, :basic_auth => basic_auth)
42
+ end
43
+
44
+ def put(uri, body={}, headers={})
45
+ self.class.put(uri, :body => body, :headers => headers, :basic_auth => basic_auth)
46
+ end
47
+
48
+ def delete(uri, body={}, headers={})
49
+ self.class.delete(uri, :body => body, :headers => headers, :basic_auth => basic_auth)
50
+ end
51
+
52
+ private
53
+ def basic_auth
54
+ @basic_auth ||= {:username => @username, :password => @password}
55
+ end
56
+ end
57
+ end
@@ -0,0 +1,115 @@
1
+ ###
2
+ ##
3
+ # flukso4r: A Ruby library for Flukso
4
+ # Copyright (C) 2010 Mathias Dalheimer (md@gonium.net)
5
+ #
6
+ # This program is free software; you can redistribute it and/or modify
7
+ # it under the terms of the GNU General Public License as published by
8
+ # the Free Software Foundation; either version 2 of the License, or
9
+ # any later version.
10
+ #
11
+ # This program is distributed in the hope that it will be useful,
12
+ # but WITHOUT ANY WARRANTY; without even the implied warranty of
13
+ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14
+ # GNU General Public License for more details.
15
+ #
16
+ # You should have received a copy of the GNU General Public License along
17
+ # with this program; if not, write to the Free Software Foundation, Inc.,
18
+ # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
19
+ ##
20
+ ###
21
+
22
+ module Flukso
23
+ class Request
24
+ include HTTParty
25
+ extend Forwardable
26
+
27
+ def self.get(client, path, options={})
28
+ new(client, :get, path, options).perform
29
+ end
30
+
31
+ def self.post(client, path, options={})
32
+ new(client, :post, path, options).perform
33
+ end
34
+
35
+ def self.put(client, path, options={})
36
+ new(client, :put, path, options).perform
37
+ end
38
+
39
+ def self.delete(client, path, options={})
40
+ new(client, :delete, path, options).perform
41
+ end
42
+
43
+ attr_reader :client, :method, :path, :options
44
+
45
+ def_delegators :client, :get, :post, :put, :delete
46
+
47
+ def initialize(client, method, path, options={})
48
+ @client, @method, @path, @options = client, method, path, {:mash => true}.merge(options)
49
+ end
50
+
51
+ def uri
52
+ @uri ||= begin
53
+ uri = URI.parse(path)
54
+
55
+ if options[:query] && options[:query] != {}
56
+ uri.query = to_query(options[:query])
57
+ end
58
+
59
+ uri.to_s
60
+ end
61
+ end
62
+
63
+ def perform
64
+ make_friendly(send("perform_#{method}"))
65
+ end
66
+
67
+ private
68
+ def perform_get
69
+ send(:get, uri, options[:headers])
70
+ end
71
+
72
+ def perform_post
73
+ send(:post, uri, options[:body], options[:headers])
74
+ end
75
+
76
+ def perform_put
77
+ send(:put, uri, options[:body], options[:headers])
78
+ end
79
+
80
+ def perform_delete
81
+ send(:delete, uri, options[:headers])
82
+ end
83
+
84
+ def make_friendly(response)
85
+ puts "Raw Response from Flukso Server: #{response}" if $verbose
86
+ raise_errors(response)
87
+ data = parse(response)
88
+ return data
89
+ end
90
+
91
+ def raise_errors(response)
92
+ case response.code.to_i
93
+ when 400
94
+ data = parse(response)
95
+ raise RateLimitExceeded.new(data), "(#{response.code}): #{response.message} - #{data['error'] if data}"
96
+ when 401
97
+ data = parse(response)
98
+ raise Unauthorized.new(data), "(#{response.code}): #{response.message} - #{data['error'] if data}"
99
+ when 403
100
+ data = parse(response)
101
+ raise General.new(data), "(#{response.code}): #{response.message} - #{data['error'] if data}"
102
+ when 404
103
+ raise NotFound, "(#{response.code}): #{response.message}"
104
+ when 500
105
+ raise InformFlukso, "Flukso had an internal error. Please let them know in the group. (#{response.code}): #{response.message}"
106
+ when 502..503
107
+ raise Unavailable, "(#{response.code}): #{response.message}"
108
+ end
109
+ end
110
+
111
+ def parse(response)
112
+ Crack::JSON.parse(response.body)
113
+ end
114
+ end
115
+ end
data/lib/flukso.rb ADDED
@@ -0,0 +1,54 @@
1
+ ###
2
+ ##
3
+ # flukso4r: A Ruby library for Flukso
4
+ # Copyright (C) 2010 Mathias Dalheimer (md@gonium.net)
5
+ #
6
+ # This program is free software; you can redistribute it and/or modify
7
+ # it under the terms of the GNU General Public License as published by
8
+ # the Free Software Foundation; either version 2 of the License, or
9
+ # any later version.
10
+ #
11
+ # This program is distributed in the hope that it will be useful,
12
+ # but WITHOUT ANY WARRANTY; without even the implied warranty of
13
+ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14
+ # GNU General Public License for more details.
15
+ #
16
+ # You should have received a copy of the GNU General Public License along
17
+ # with this program; if not, write to the Free Software Foundation, Inc.,
18
+ # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
19
+ ##
20
+ ###
21
+
22
+
23
+ require 'forwardable'
24
+ require 'rubygems'
25
+
26
+ gem 'httparty', '~> 0.4.3'
27
+ require 'httparty'
28
+
29
+ module Flukso
30
+ class FluksoError < StandardError
31
+ attr_reader :data
32
+
33
+ def initialize(data)
34
+ @data = data
35
+ super
36
+ end
37
+ end
38
+
39
+ class RateLimitExceeded < FluksoError; end
40
+ class Unauthorized < FluksoError; end
41
+ class General < FluksoError; end
42
+
43
+ class Unavailable < StandardError; end
44
+ class InformFlukso < StandardError; end
45
+ class NotFound < StandardError; end
46
+
47
+ BASE_SENSOR_URL = "http://api.flukso.net/sensor"
48
+ end
49
+
50
+ directory = File.expand_path(File.dirname(__FILE__))
51
+
52
+ require File.join(directory, 'flukso', 'http_auth')
53
+ require File.join(directory, 'flukso', 'request')
54
+ require File.join(directory, 'flukso', 'api')
data/test/helper.rb ADDED
@@ -0,0 +1,10 @@
1
+ require 'rubygems'
2
+ require 'test/unit'
3
+ require 'shoulda'
4
+
5
+ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
6
+ $LOAD_PATH.unshift(File.dirname(__FILE__))
7
+ require 'flukso4r'
8
+
9
+ class Test::Unit::TestCase
10
+ end
@@ -0,0 +1,7 @@
1
+ require 'helper'
2
+
3
+ class TestFlukso4r < Test::Unit::TestCase
4
+ should "probably rename this file and start testing for real" do
5
+ flunk "hey buddy, you should probably rename this file and start testing for real"
6
+ end
7
+ end
metadata ADDED
@@ -0,0 +1,96 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: flukso4r
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Mathias Dalheimer
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+
12
+ date: 2010-01-06 00:00:00 +01:00
13
+ default_executable: flukso_query
14
+ dependencies:
15
+ - !ruby/object:Gem::Dependency
16
+ name: oauth
17
+ type: :runtime
18
+ version_requirement:
19
+ version_requirements: !ruby/object:Gem::Requirement
20
+ requirements:
21
+ - - ~>
22
+ - !ruby/object:Gem::Version
23
+ version: 0.3.6
24
+ version:
25
+ - !ruby/object:Gem::Dependency
26
+ name: httparty
27
+ type: :runtime
28
+ version_requirement:
29
+ version_requirements: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ~>
32
+ - !ruby/object:Gem::Version
33
+ version: 0.4.3
34
+ version:
35
+ - !ruby/object:Gem::Dependency
36
+ name: thoughtbot-shoulda
37
+ type: :development
38
+ version_requirement:
39
+ version_requirements: !ruby/object:Gem::Requirement
40
+ requirements:
41
+ - - ">="
42
+ - !ruby/object:Gem::Version
43
+ version: "0"
44
+ version:
45
+ description: This gem provides a library for the Flukso API. See http://flukso.net for more information.
46
+ email: md@gonium.net
47
+ executables:
48
+ - flukso_query
49
+ extensions: []
50
+
51
+ extra_rdoc_files:
52
+ - LICENSE
53
+ - README.rdoc
54
+ files:
55
+ - LICENSE
56
+ - README.rdoc
57
+ - Rakefile
58
+ - VERSION
59
+ - bin/flukso_query
60
+ - lib/flukso.rb
61
+ - lib/flukso/api.rb
62
+ - lib/flukso/http_auth.rb
63
+ - lib/flukso/request.rb
64
+ - test/helper.rb
65
+ - test/test_flukso4r.rb
66
+ has_rdoc: true
67
+ homepage: http://gonium.net/md/flukso4r
68
+ licenses: []
69
+
70
+ post_install_message:
71
+ rdoc_options:
72
+ - --charset=UTF-8
73
+ require_paths:
74
+ - lib
75
+ required_ruby_version: !ruby/object:Gem::Requirement
76
+ requirements:
77
+ - - ">="
78
+ - !ruby/object:Gem::Version
79
+ version: "0"
80
+ version:
81
+ required_rubygems_version: !ruby/object:Gem::Requirement
82
+ requirements:
83
+ - - ">="
84
+ - !ruby/object:Gem::Version
85
+ version: "0"
86
+ version:
87
+ requirements: []
88
+
89
+ rubyforge_project:
90
+ rubygems_version: 1.3.5
91
+ signing_key:
92
+ specification_version: 3
93
+ summary: A Ruby Library for the Flukso Webservice
94
+ test_files:
95
+ - test/test_flukso4r.rb
96
+ - test/helper.rb