As the name suggests, this gem wraps parts of the www.pvoutput.org public api so that you can easily call it from within your Ruby program. Results are available in raw and formatted form.
Add this line to your application's Gemfile:
gem 'pv_output_wrapper'And then execute:
$ bundle
Or install it yourself as:
$ gem install pv_output_wrapper
Methods names and parameters are the same as those defined by pvoutput.org. Documentation for this gem is effectively the same as that which is found at pvoutput.org. You will probably need to register at pvoutput.org to get an api_key and system_id. At present, only a subset of the api is supported by this gem, though it is easy to extend its functionality (see below).
request = PvOutputWrapper::Request.new('pvoutput_api_key', 'pvoutput_system_id')
params = { :df => '20150101' }
# Returns a PvOutputWrapper::Response instance.
response = request.get_statistic(params)
# Returns the body.
body = response.body
# Returns a hash or array of hashes.
parsed_statistics = response.parseAfter checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.
You can add support for more api calls by whitelisting the method name and its parameters in lib/pv_output_wrapper.rb. If you want to parse the response, you can write a parsing method in lib/pv_output_wrapper/response.rb. Please name the method the same as pv_output.org, but using snake_case.
Bug reports and pull requests are welcome on GitHub at https://github.com/studiospring/pv_output_wrapper.
The gem is available as open source under the terms of the MIT License.