flukso4r 0.3.3 → 0.3.4

data/README.rdoc

@@ -9,20 +9,27 @@ webservice. Have a look at the bin/flukso_query script. It allows you to
 query the Flukso API and retrieve the latest readings from your Flukso
 meter. A simple call to retrieve the readings of the last day is:
 
-flukso_query -t day -u watt -a <your-sensor-alias>
+$ flukso_query -t day -u watt -c <CONFIG_FILE>
 
-In addition, the library includes two scripts that can be used to
+In addition, the library includes scripts that can be used to
 archive your Flukso readings at the highest resolution. The values are
 stored in an sqlite3 database.
 
-First, copy the flukso4rrc template file to a destination of your
-liking:
+== Installation
 
-$ cp etc/flukso4rrc $HOME/.flukso4rrc
+For most cases installation can be done using gems:
+
+$ gem install flukso4r
+
+After installation you need to copy the flukso4rrc template file to a
+destination of your liking:
+
+$ cp <GEM_LOCATION>/etc/flukso4rrc $HOME/.flukso4rrc
 
 Then, edit the file and specify the database file and your API key.
-Please note that the library uses HTTPS to communicate with the Flukso
-webservice, so your API key is not sent unencrypted over the net.
+Please note that the library uses the value in BASE_URL for
+communicating with the webservice. Please use HTTPS 
+so that your API key is not sent unencrypted over the net.
 
 Then, create an empty database:
 
@@ -33,7 +40,14 @@ After the DB has been created, you can add new data with the command
 $ flukso_archive_watts -c <CONFIG_FILE>
 
 This command will download all values of the last hour and add the new
-ones to the database. It is intended to be run as a cronjob.
+ones to the database. It is intended to be run as a cronjob. You can
+then export the data with 
+
+$ flukso_export_db -c <CONFIG_FILE> 
+
+All commands support additional options which are displayed with the
+parameter "-h". For verbose output, use "-v" in addition to your other
+commandline switches.
 
 The code in lib is a cheap knockoff of the twitter ruby gem - many
 thanks to John Nunemaker! You can find the twitter ruby gem here:

data/VERSION

@@ -1 +1 @@
-0.3.3
+0.3.4

data/bin/flukso_archive_watts

@@ -93,9 +93,9 @@ if not File.exists?(dbfile)
   exit(-2);
 end
 
-
+BASE_URL=$CONFIG['BASE_URL']
 auth=Flukso::TokenAuth.new($CONFIG["ACCESS_TOKEN"]);
-api=Flukso::API.new(auth);
+api=Flukso::API.new(auth, BASE_URL);
 query=Flukso::QueryReadings.new($CONFIG["SENSOR_ID"], :hour, :watt)
 begin
   readings=query.execute(api);

data/bin/flukso_query

@@ -55,11 +55,8 @@ class Optparser
       opts.on("-u", "--unit VALUE", "The unit you want to query. Valid queries are: {watt, kwh, eur, aud}") do |unit|
         options.unit = unit 
       end
-      opts.on("-i", "--sensor-id VALUE", "The sensor ID you want to query.") do |sensor_id|
-        options.sensor_id = sensor_id
-      end
-      opts.on("-a", "--access-token VALUE", "Your access token.") do |access_token|
-        options.access_token = access_token
+      opts.on("-c", "--config FILE", "The file where the configuration lives.") do |file|
+        options.config_file = file
       end
       # Boolean switch.
       opts.on("-v", "--verbose", "Run verbosely") do |v|
@@ -110,16 +107,30 @@ else begin
   exit(-2);
 end
 end
-sensor_id=options.sensor_id
-access_token=options.access_token
+if options.config_file == nil
+  puts "Please provide a configuration file... (-h for details)."
+  exit(-1);
+end
+if not File.exists?(options.config_file) 
+  puts " Configuration file #{options.config_file} not found - exiting."
+  exit(-3);
+else
+  $CONFIG=YAML.load_file(options.config_file);
+  puts "Using this configuration:" if $verbose
+  puts "#{$CONFIG}" if $verbose
+end
 
+sensor_id = $CONFIG['SENSOR_ID']
+access_token = $CONFIG['ACCESS_TOKEN']
+BASE_URL=$CONFIG['BASE_URL']
 auth=Flukso::TokenAuth.new(access_token);
-api=Flukso::API.new(auth);
+api=Flukso::API.new(auth, BASE_URL);
 query=Flukso::QueryReadings.new(sensor_id, range, unit)
 begin
   readings=query.execute(api);
 rescue Exception => e
   puts "Query failed: #{e}"
+  puts "Used #{BASE_URL} as BASE_URL"
   exit(-10);
 end
 

data/lib/flukso.rb

@@ -44,7 +44,7 @@ module Flukso
   class InformFlukso < StandardError; end
   class NotFound < StandardError; end
   # Use only the encrypted endpoint.
-  BASE_SENSOR_URL = "https://api.flukso.net/sensor"
+  #BASE_SENSOR_URL = "https://api.flukso.net/sensor"
   API_VERSION="1.0"
 end
  

data/lib/flukso/api.rb

@@ -36,7 +36,8 @@ module Flukso
       if api.class != Flukso::API
         raise  Flukso::General, "Cannot execute query: API object invalid"
       end
-      query_url="#{Flukso::BASE_SENSOR_URL}/#{@sensor_id}?interval=#{@timerange}&unit=#{@unit}";
+      query_url="/#{@sensor_id}?interval=#{@timerange}&unit=#{@unit}";
+      #query_url="#{Flukso::BASE_SENSOR_URL}/#{@sensor_id}?interval=#{@timerange}&unit=#{@unit}";
       puts "Using query url #{query_url}" if $verbose
       response = api.perform_get(query_url) 
       return wrap_response(response);
@@ -59,24 +60,25 @@ module Flukso
 
     attr_reader :client
 
-    def initialize(client)
+    def initialize(client, base_url)
       @client = client
+      @base_url = base_url
     end
     
     def perform_get(path, options={})
-      Flukso::Request.get(self, path, options )
+      Flukso::Request.get(self, @base_url+path, options )
     end
 
     def perform_post(path, options={})
-      Flukso::Request.post(self, path, add_version_header(options))
+      Flukso::Request.post(self, @base_url+path, add_version_header(options))
     end
 
     def perform_put(path, options={})
-      Flukso::Request.put(self, path, add_version_header(options))
+      Flukso::Request.put(self, @base_url+path, add_version_header(options))
     end
 
     def perform_delete(path, options={})
-      Flukso::Request.delete(self, path, add_version_header(options))
+      Flukso::Request.delete(self, @base_url+path, add_version_header(options))
     end
 
   end

data/lib/flukso/http_auth.rb

@@ -27,10 +27,10 @@ module Flukso
 
     attr_reader :options
 
-    def initialize(access_token)
+    def initialize(access_token)#, base_url)
       @access_token = access_token
       #@options = {:ssl => true}.merge(options)
-      self.class.base_uri "#{Flukso::BASE_SENSOR_URL}"
+      #self.class.base_uri "#{base_url}"
     end
 
     

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: flukso4r
 version: !ruby/object:Gem::Version 
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors: 
 - Mathias Dalheimer
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-28 00:00:00 +01:00
+date: 2010-03-31 00:00:00 +02:00
 default_executable: flukso_query
 dependencies: 
 - !ruby/object:Gem::Dependency