powershop 0.0.1

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2009 Nik Wakelin <nik@codetocustomer.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.textile

@@ -0,0 +1,79 @@
+h1. Powershop OAuth Client
+
+This is an Ruby OAuth Client library for the Powershop API (more details available at "Powershop":http://powershop.co.nz or on the "Google Group":http://groups.google.com/group/powershop-developers).
+
+It borrows heavily from John Nunemaker's "Twitter Ruby Client":http://github.com/jnunemaker/twitter. Thanks!
+
+h2. Authenticating With OAuth
+
+(Note that there is an executable example in examples/powershop_example.rb. You can get more detail about OAuth itself at the "OAuth Site":http://oauth.net)
+
+First, you'll need a Consumer Key/Secret pair from Powershop. You can obtain one by contacting developers@powershop.co.nz.
+
+Then create a new client like so:
+
+<pre><code>require 'powershop'
+powershop_client = Powershop::Client.new(YOUR_OAUTH_CONSUMER_KEY, YOUR_OAUTH_CONSUMER_SECRET)
+</code></pre>
+
+You can get a Request Token like this:
+
+<pre><code>request_token = powershop_client.request_token(:oauth_callback => "http://mysite.com/oauth/callback")
+</code></pre>
+
+NB: Powershop requires you specify an OAuth Callback URL for your request token. The library will default to "oob" (Out-Of-Band) if you don't specify a URL. Using "oob" means Powershop will provide your user with a verifier that they must manually copy and paste into your application (useful for Desktop applications or similar). Otherwise, the OAuth Callback URL is a URL your users will get redirected to along with an :oauth_verifier param once they've authenticated at Powershop.
+
+Keep your Request Token/Secret pair around (the session is a good place in Rails) - as you'll need it later. 
+
+You'll then need to redirect your user to the authentication URL for the request token. In Rails, this looks something like:
+
+<pre><code>redirect_to request_token.authorize_url
+</code></pre>
+
+Once they've authenticated at Powershop they'll get redirected to your callback with a verifier, and you can then exchange your Request Token for an Access Token like so:
+
+<pre><code>powershop_client.authorize_from_request(request_token.token, request_token.secret, params[:oauth_verifier])
+</code></pre>
+
+(Assuming that params is a hash of GET parameters, similar to Rails)
+
+You can then get an Access Token/Secret pair.
+
+<pre><code>powershop_client.access_token</code></pre>
+
+You should store this in your Database or somewhere similarly persistent - you can use it later to authenticate in a single step:
+
+<pre><code>require 'powershop'
+powershop_client = Powershop::Client.new(YOUR_OAUTH_CONSUMER_KEY, YOUR_OAUTH_CONSUMER_SECRET)
+powershop_client.authorize_from_access(ACCESS_TOKEN, ACCESS_SECRET)
+</code></pre>
+
+h2. Using the Library
+
+Most of the details of the library should be pretty self-explanatory. (If you're stuck, all the calls are tested in test/client_test.rb and Powershop provides a really useful PDF)
+
+<pre><code>  
+  # properties is the result of the "customer_details" API call, it returns an array of Powershop::Property objects
+  powershop_client.properties
+  
+  # you can set the property to use for all subsequent calls (i.e automatically append the icp_number param)
+  powershop_client.set_property(powershop_client.properties.first)
+  
+  # Note that you'll need to set the property for all the following calls
+  
+  # get a list of all products available 
+  powershop_client.products
+  
+  # get some meter readings (the "end_date" parameter defaults to now)
+  powershop_client.meter_readings(:start_date => 2.weeks.ago)
+  
+  # top up power
+  top_up_details = powershop_client.get_top_up
+  
+  # then you should display these details to your user...
+  powershop_client.top_up!(:offer_key => top_up_details.offer_key)
+  
+  # updating meter readings (use a hash of register number => reading pairs)
+  powershop_client.post_meter_readings({ "1000:1" => 40568, "1000:2" => 45638 })
+  
+</code></pre>

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+ 
+desc 'Default: run unit tests.'
+task :default => :test
+ 
+desc 'Test the xero gateway.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end

data/examples/powershop_example.rb

@@ -0,0 +1,27 @@
+require 'rubygems'
+
+require File.dirname(__FILE__) + '/../lib/powershop'
+require 'pp'
+
+# insert your consumer key/secret pair here
+CONSUMER_KEY    = "YOUR_CONSUMER_KEY"
+CONSUMER_SECRET = "YOUR_CONSUMER_SECRET" 
+
+p = Powershop::Client.new(CONSUMER_KEY, CONSUMER_SECRET)
+
+rt = p.request_token
+
+`open #{rt.authorize_url}`
+
+puts "Paste OAuth Verifier:"
+verifier = gets.chomp
+
+access_token, access_secret = p.authorize_from_request(rt.token, rt.secret, verifier)
+
+puts "Your Access Token:  #{access_token}"
+puts "Your Access Secret: #{access_secret}"
+
+puts
+puts "Now let's make an API call..."
+
+pp p.properties

data/init.rb

@@ -0,0 +1 @@
+require 'powershop'

data/lib/powershop/client.rb

@@ -0,0 +1,123 @@
+module Powershop
+  class Client
+
+    attr_accessor :oauth
+    
+    def initialize(oauth_consumer_key, oauth_consumer_secret)
+      @oauth = OAuth.new(oauth_consumer_key, oauth_consumer_secret)
+      
+      @current_property = nil
+    end
+    
+    # so we can oauth straight through the Client
+    %w(request_token authorize_from_request authorize_from_access access_token).each do |method|
+      delegate method, :to => :oauth
+    end
+    
+    # proxy all our requests with an error wrapper
+    %w(get post put delete).each do |http_method|
+      define_method(http_method) do |*args|
+        url, options   = args
+        options      ||= {}
+        
+        options[:icp_number] ||= @current_property.icp_number if @current_property
+        
+        parse(@oauth.send(http_method, "#{url}?#{to_query(options)}"))
+      end
+    end
+    
+    def properties
+      result = self.get(api_url("customer"))
+      
+      result.properties.collect do |p|
+        Property.new(self, p)
+      end
+    end
+    
+    # choose which property (icp_number) to use for all calls requiring an icp_number
+    def set_property(property)
+      @current_property = property
+    end
+    
+    def get_meter_readings(options = {})
+      options[:end_date]   ||= Date.today
+      
+      self.get(api_url("meter_readings"), options)
+    end
+    
+    # 'readings' should be a hash of register_number => reading values
+    #  e.g
+    #     { "10073:1" => 5000, "10073:2" => 2000 }
+    def post_meter_readings(readings, options = {})
+
+      readings.each do |register_number, reading|
+        options["readings[#{register_number}]"] = reading 
+      end
+      
+      response = self.post(api_url("meter_readings"), options)
+      
+      if response.result == "success"
+        true
+      else
+        raise reponse.message
+      end
+    end
+    
+    def products(options = {})
+      self.get(api_url("products"), options)
+    end
+    
+    def get_top_up(options = {})
+      self.get(api_url("top_up"), options)
+    end
+    
+    def top_up!(options = {})
+      raise "You must specify an Offer Key" unless options[:offer_key]
+      
+      self.post(api_url("top_up"), options)
+    end
+    
+    private
+      
+      # NB: For Powershop, the "js" format (usually reserved for executable Javascript)
+      # is used to denote JSON encoding (instead of the more familiar "json")
+      def api_url(endpoint)
+        "#{API_BASE_URL}/external_api/v1/#{endpoint}.js"
+      end
+      
+      def parse(response)
+        check_errors(response)
+        
+        result = ActiveSupport::JSON.decode(response.body)["result"]
+        
+        if result.is_a?(Array)
+          result.map { |r| OpenStruct.new(r) }
+        else
+          OpenStruct.new(result)
+        end
+      end
+      
+      def check_errors(response)
+        case response.code.to_i
+          when 400
+            raise PowershopError.new(response.body)
+          when 401
+            raise PowershopOAuthError.new(response.body)
+          when 503
+            raise RateLimitExceeded.new(response.body)
+        end
+      end
+      
+      def to_query(options)
+        options.inject([]) do |collection, opt|
+          key, value = opt
+          
+          value = value.strftime("%Y-%m-%d") if value.is_a?(Date) || value.is_a?(Time)
+
+          collection << "#{key}=#{value}"
+          collection
+        end * '&'
+      end
+      
+  end
+end

data/lib/powershop/oauth.rb

@@ -0,0 +1,44 @@
+module Powershop
+  
+  # based on OAuth implementation for Twitter Gem, 
+  # http://github.com/jnunemaker/twitter/
+  class OAuth
+    
+    attr_accessor :consumer
+    
+    %w(get post put delete).each do |http_method|
+      delegate http_method,    :to => :access_token      
+    end
+    
+    def initialize(key, secret)
+      @consumer = ::OAuth::Consumer.new(key, secret, 
+                                        :site               => API_BASE_URL, 
+                                        :request_token_path => "/external_api/oauth/request_token", 
+                                        :authorize_path     => "/external_api/oauth/authorize", 
+                                        :access_token_path  => "/external_api/oauth/access_token")
+    end
+    
+    def request_token(options={})
+      # default to Out-Of-Band unless an oauth callback is specified
+      # NB: Powershop requires an OAuth callback, ref: [E908]
+      options[:oauth_callback] ||= "oob"
+    
+      @request_token ||= consumer.get_request_token(options)
+    end
+    
+    def authorize_from_request(rtoken, rsecret, verifier_or_pin)
+      request_token = ::OAuth::RequestToken.new(consumer, rtoken, rsecret)
+      access_token = request_token.get_access_token(:oauth_verifier => verifier_or_pin)
+      @atoken, @asecret = access_token.token, access_token.secret
+    end
+  
+    def access_token
+      @access_token ||= ::OAuth::AccessToken.new(consumer, @atoken, @asecret)
+    end
+    
+    def authorize_from_access(atoken, asecret)
+      @atoken, @asecret = atoken, asecret
+    end
+    
+  end
+end

data/lib/powershop/property.rb

@@ -0,0 +1,26 @@
+module Powershop
+  class Property
+   
+    ATTRIBUTES = %w(icp_number address start_date end_date unit_balance daily_consumption 
+                     last_account_review_at registers)
+   
+    ATTRIBUTES.each { |r| attr_accessor r }
+   
+    def initialize(client, hash)
+      @client = client
+      
+      ATTRIBUTES.each do |r|
+        send("#{r}=", hash[r])
+      end
+    end
+    
+    # Could override this in case a Hash doesn't suit for an address ;)
+    # def address=(address_hash)
+    # end
+    
+    def registers=(register_array)
+      @registers = register_array.map { |r| Register.new(r) }
+    end
+    
+  end
+end

data/lib/powershop/register.rb

@@ -0,0 +1,16 @@
+module Powershop
+  class Register
+   
+    ATTRIBUTES = %w(register_number description dials hidden last_reading_at last_reading_value
+                     last_reading_type estimated_reading_value)
+   
+    ATTRIBUTES.each { |r| attr_accessor r }
+   
+    def initialize(hash)
+      ATTRIBUTES.each do |r|
+        send("#{r}=", hash[r])
+      end
+    end
+    
+  end
+end

data/lib/powershop.rb

@@ -0,0 +1,27 @@
+
+require "active_support"
+require "ostruct"
+require "cgi"
+
+gem "oauth", ">= 0.3.1"
+require "oauth"
+
+directory = File.expand_path(File.dirname(__FILE__))
+
+require File.join(directory, 'powershop', 'client')
+require File.join(directory, 'powershop', 'oauth')
+require File.join(directory, 'powershop', 'property')
+require File.join(directory, 'powershop', 'register')
+
+module Powershop
+
+  class RateLimitExceeded < StandardError; end
+  class PowershopError < StandardError; end
+  class PowershopOAuthError < StandardError; end
+  
+  VERSION   = "0.0.1"
+  
+  # use test url
+  API_BASE_URL = "https://suppliertest.youdo.co.nz"
+  
+end

data/powershop.gemspec

@@ -0,0 +1,33 @@
+Gem::Specification.new do |s|
+  s.name     = "powershop"
+  s.version  = "0.0.1"
+  s.date     = "2009-12-26"
+  s.summary  = "Allows Ruby applications to communicate with the Powershop API"
+  s.email    = "nik@codetocustomer.com"
+  s.homepage = "http://github.com/codetocustomer/powershop"
+  s.description = "Allows Ruby applications to communicate with the Powershop API"
+  s.has_rdoc = false
+  s.authors  = ["Nik Wakelin"]
+  s.add_dependency('oauth', '>= 0.3.1')
+  s.add_dependency('activesupport', '>= 2.3.5')  
+  s.files    = ["init.rb",
+    "LICENSE",
+    "Rakefile",
+    "README.textile",
+    "examples/powershop_example.rb", 
+    "lib/powershop.rb",
+    "lib/powershop/client.rb",
+    "lib/powershop/oauth.rb",
+    "lib/powershop/property.rb",
+    "lib/powershop/register.rb",
+    "script/console",
+    "test/client_test.rb",
+    "test/test_helper.rb",
+    "test/responses/get_top_up.json",
+    "test/responses/icp_number_error.json",
+    "test/responses/meter_readings.json",
+    "test/responses/products.json",
+    "test/responses/properties.json",
+    "test/responses/success.json",
+    "powershop.gemspec"]
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/powershop.rb'}"
+puts "Loading Powershop gem"
+exec "#{irb} #{libs} --simple-prompt"

data/test/client_test.rb

@@ -0,0 +1,140 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class ClientTest < Test::Unit::TestCase
+   
+  STUB_API_CALLS = true
+  
+  # specify a real consumer key/secret pair here to test against the actual API
+  CONSUMER_KEY    = "YOUR_CONSUMER_KEY"
+  CONSUMER_SECRET = "YOUR_CONSUMER_SECRET"
+  
+  # specify an access token/secret pair here to test against the actual API
+  ACCESS_TOKEN  = "YOUR_ACCESS_TOKEN"
+  ACCESS_SECRET = "YOUR_ACCESS_SECRET"
+    
+  def setup
+    @powershop_client = Powershop::Client.new(CONSUMER_KEY, CONSUMER_SECRET)
+    
+    if STUB_API_CALLS
+      Powershop::OAuth.any_instance.expects(:authorize_from_access).with { |x, y| x == ACCESS_TOKEN && y == ACCESS_SECRET }.returns(true)      
+    end
+    
+    @powershop_client.authorize_from_access(ACCESS_TOKEN, ACCESS_SECRET)
+    
+  end
+  
+  def test_properties
+    if STUB_API_CALLS
+      Powershop::OAuth.any_instance.expects(:get).with { |url| url =~ /customer/ }.returns(stub(:code => 200, :body => test_response("properties")))
+    end
+    
+    assert properties = @powershop_client.properties
+    
+    properties.each do |p|
+      assert p.is_a? Powershop::Property
+      assert p.registers.first.is_a? Powershop::Register
+    end
+
+    if STUB_API_CALLS
+      p = properties.first
+      
+      assert_equal "0001427254UNF48", p.icp_number
+      assert_equal 120.1,             p.daily_consumption
+      assert_equal -8261,             p.unit_balance
+      
+      r = p.registers.first
+      
+      assert_equal "109479:1",        r.register_number
+      assert_equal 5,                 r.dials
+    end
+  end
+  
+  def test_get_meter_readings
+    if STUB_API_CALLS
+      Powershop::OAuth.any_instance.expects(:get).with { |url| url =~ /customer/ }.returns(stub(:code => 200, :body => test_response("properties")))
+      Powershop::OAuth.any_instance.expects(:get).with { |url| url =~ /meter_readings/ }.returns(stub(:code => 200, :body => test_response("meter_readings")))      
+    end
+    
+    @powershop_client.set_property(@powershop_client.properties.first)
+    
+    assert readings = @powershop_client.get_meter_readings(:start_date => 2.weeks.ago)
+    
+    if STUB_API_CALLS
+      assert_equal "customer", readings.first.reading_type
+      assert_equal "63918",      readings.first.reading_value
+    end
+  end
+  
+  def test_powershop_errors
+    if STUB_API_CALLS
+      Powershop::OAuth.any_instance.expects(:get).with { |url| url =~ /meter_readings/ }.returns(stub(:code => 400, :body => test_response("icp_number_error")))      
+    end
+    
+    assert_raises Powershop::PowershopError do
+      @powershop_client.get_meter_readings(:start_date => 2.weeks.ago)
+    end
+  end
+  
+  def test_products
+    if STUB_API_CALLS
+      Powershop::OAuth.any_instance.expects(:get).with { |url| url =~ /customer/ }.returns(stub(:code => 200, :body => test_response("properties")))
+      Powershop::OAuth.any_instance.expects(:get).with { |url| url =~ /products/ }.returns(stub(:code => 200, :body => test_response("products")))      
+    end
+    
+    @powershop_client.set_property(@powershop_client.properties.first)
+    
+    assert products = @powershop_client.products
+    
+    if STUB_API_CALLS
+      flower_power_catchup = products.detect { |p| p.name == "$84.90 catch up pack" }
+      
+      assert_equal "0.1772",      flower_power_catchup.price_per_unit
+      assert_match /PowerKiwi/, flower_power_catchup.description
+    end
+  end
+
+  def test_post_meter_readings
+    if STUB_API_CALLS
+      Powershop::OAuth.any_instance.expects(:get).with { |url| url =~ /customer/ }.returns(stub(:code => 200, :body => test_response("properties")))
+      Powershop::OAuth.any_instance.expects(:post).with { |url| url =~ /meter_readings/ }.returns(stub(:code => 200, :body => test_response("success")))      
+    end
+    
+    property = @powershop_client.properties.first
+    @powershop_client.set_property(property)
+    
+    new_readings = property.registers.inject({}) do |hash, r|
+      hash[r.register_number] = r.last_reading_value.to_i + 500
+      hash
+    end
+    
+    assert @powershop_client.post_meter_readings(new_readings)
+  end
+
+  def test_topping_up
+    if STUB_API_CALLS
+      Powershop::OAuth.any_instance.expects(:get).with { |url| url =~ /customer/ }.returns(stub(:code => 200, :body => test_response("properties")))
+      Powershop::OAuth.any_instance.expects(:get).with { |url| url =~ /top_up/ }.returns(stub(:code => 200, :body => test_response("get_top_up")))
+      Powershop::OAuth.any_instance.expects(:post).with { |url| url =~ /top_up/ }.returns(stub(:code => 200, :body => test_response("success")))      
+    end
+        
+    @powershop_client.set_property(@powershop_client.properties.first)
+    
+    assert top_up_details = @powershop_client.get_top_up
+    
+    offer_key = top_up_details.offer_key
+    assert_not_nil offer_key
+    
+    assert_raises RuntimeError, "You must specify an Offer Key" do
+      @powershop_client.top_up!
+    end
+    
+    assert @powershop_client.top_up!(:offer_key => offer_key)
+  end
+  
+  private
+  
+    def test_response(name)
+      File.open(File.join(File.dirname(__FILE__), "responses", "#{name}.json"), "rb").read
+    end
+  
+end

data/test/responses/get_top_up.json

@@ -0,0 +1 @@
+{"version":"1.0","result":{"total_price":"1741.8","offer_key":"9c6a264d88d8a7ff3fb37c6da6f48b0457ecdcd01ba8e303c05e81329d89a37b","price_per_unit":"0.1785","product_name":"Flower Power Top Up","unit_balance":-9758}}

data/test/responses/icp_number_error.json

@@ -0,0 +1 @@
+[E000] The icp_number parameter must be specified for this call

data/test/responses/meter_readings.json

@@ -0,0 +1 @@
+{"version":"1.0","result":[{"reading_type":"customer","read_at":"2009-12-25 00:13:04","register_number":"109479:1","reading_value":"63918"},{"reading_type":"customer","read_at":"2009-12-25 00:13:01","register_number":"109479:1","reading_value":"53918"},{"reading_type":"customer","read_at":"2009-12-25 00:12:58","register_number":"109479:1","reading_value":"53915"},{"reading_type":"customer","read_at":"2009-12-25 00:12:22","register_number":"109479:1","reading_value":"53915"}]}

data/test/responses/products.json

@@ -0,0 +1 @@
+{"version":"1.0","result":[{"type":"special","image_url":"https://suppliertest.youdo.co.nz/photos/fb829edd7c63506b05eec11ae6cee215.original","name":"$49.95 Value Pack","price_per_unit":"0.1765","description":"If you\u2019re serious about saving money on electricity, then our weekly Value Pack is what you\u2019re looking for. About a week\u2019s worth of power for the average user at price that\u2019s very hard to beat.\r\n\r\nWith the colder weather you'll be using a bit more power, so we've bumped up the size of the weekly value pack, but kept the same lean unit price.\r\n\r\nThere\u2019s no catch, but you are limited to one pack per customer per week, so if you want to save, you\u2019ll need to top up regularly. Go for it now and save.\r\n\r\nWho is Standard Power?\r\nStandard Power is backed by Powershop. It is the name we use for our budget house brand electricity because it is the same bulk standard electricity, just better deals."},{"type":"nominated","image_url":"https://suppliertest.youdo.co.nz/photos/b0541bfc10d8eddfd3a19b442aabb336.original","name":"Green Power Top Up","price_per_unit":"0.1983","description":"Do you choose your\u00a0electricity\u00a0company based on how they generate their power?\r\n\r\n\u003Cb\u003EUnfortunately the electrical power from the grid that you actually use in your home comes from a mix of sources that you cannot control. Only The Green Power Company buys carbon credits to help offset the greenhouse gas emissions from electricity generated on your behalf. \u003C/b\u003E\r\n\r\nThe sources of electricity on the grid range from the giant Manapouri and other hydro dams, geothermal power at Wairakei, through to gas and coal fired power, including the thermal power station at Huntly. Around one third of electricity in NZ is generated from fossil fueled thermal power stations. \u003Ca href=\"http://www.med.govt.nz/upload/63349/GHG%20Report.pdf\"\u003ESource MED\u003C/a\u003E Even the geothermal fields in Wairakei are not above reproach, as they result in so called fugitive greenhouse gas emissions. Every household in New Zealand that is on the grid relies on all of these power stations, although the mix of electricity source you use depends on where you live and changes through the seasons.\r\n\r\nEach of these power sources has a different contribution to New Zealand\u2019s carbon emissions, with established hydro dams showing essentially zero emissions and coal and gas fired plants the most.  The MED release quarterly updates on the electricity generation emission factor and it is this emission factor  we use in our calculations to determine the amount of carbon we need to offset for each unit of Green Power you purchase (see  \u003Ca href=\"http://www.med.govt.nz/upload/67175/NZEQ_Sepetmber08_EditorsVersion.pdf\"\u003Ehttp://www.med.govt.nz/upload/67175/NZEQ_Sepetmber08_EditorsVersion.pdf\u003C/a\u003E).  Currently, the emissions factor to determine the greenhouse gas equivalent of electricity derived emissions from generation is 0.18 (ktCO2e/GWh).\r\n\r\nThe greenhouse gas emissions per electricity unit are therefore 0.18kg/unit. For every Green Power unit you purchase The Green Power Company will purchase verified \u003Ca href=\"http://www.v-c-s.org/projects.html\"\u003Evoluntary carbon units\u003C/a\u003E to offset 0.18kg of carbon.  As voluntary carbon units offset carbon by the tonne and individual household electricity emissions per month are likely to be in kilograms of carbon, we will aggregate the emissions from all our customers and reconcile them the month following to the nearest tonne. Aggregated emissions that are less than one tonne will be rolled over to the following month.\r\n\r\nThe verified voluntary carbon units purchased by us will be retired in our Voluntary Carbon Standard Registry account. You can check the PowerKiwi Limited (The Green Power Company) Registry account on the \u003Ca href=\"http://www.tz1market.com/registryview.php\"\u003ETZ1 Registry\u003C/a\u003E.\r\n\t \r\n\r\n\u003Cb\u003EAbout The Green Power Company\u003C/b\u003E\r\nThe Green Power Company product is offered through Powershop, which is web based, paper free, safe and far more fun than the traditional power companies. \r\n\r\n\u003Ca href=\"http://www.greenpowercompany.co.nz\"\u003EThe Green Power Company\u003C/a\u003E is a product from \u003Ca href=\"http://www.powerkiwi.co.nz\"\u003EPowerKiwi\u003C/a\u003E, an independent NZ owned company.\r\n\r\nTips:\r\n* Change your default product to Green Power by clicking on the yellow \u201cmake this my default product\u201d checkbox above. That way you\u2019ll always be sure to get the only power that truly accounts for emissions.\r\n* Find out when your meter reader is coming via text \u2013 use My Settings, Alerts\r\n* Save petrol by turning your engine off if you will be at a stop light for longer than 10 seconds. \u003Ca href=\"http://green.yahoo.com/blog/climate411/71/when-to-turn-off-your-engine.html\"\u003Esource Y! Green\u003C/a\u003E"},{"type":"special","image_url":"https://suppliertest.youdo.co.nz/photos/76293000267be60578e318f8bff807b2.original","name":"Crusaders Power Pack","price_per_unit":"0.2008","description":"The excitement and energy of Super 14 Rugby has now been transformed into \u2018Crusaders Power\u2019.  If you are a one-eyed Crusaders supporter and your favourite colours are red and black - this $50.00 Crusaders Power Pack is for you. By purchasing this pack you can support your favourite Super 14 team.  While the Super 14 playing season might have finished, you can still follow your favourite team members as they play for the All Blacks.\r\n\r\nEach Crusaders Power Pack is about a week's worth of electricity for an average user in winter.   Don't drop the ball. Grab this red and black deal now."},{"type":"special","image_url":"https://suppliertest.youdo.co.nz/photos/8de0c3088ea9c8d03cec83b86d50197d.original","name":"Meridian 300","price_per_unit":"0.1789","description":"Choose the Meridian 300 special, and you can purchase up to 300 units of electricity at the great price shown (cents/unit). You\u2019re limited to one Meridian 300 purchase per week, so be in quick while the offer lasts.\r\n\r\nWind and water are nature\u2019s carbon free fuels, and Meridian uses them to generate electricity. We\u2019re committed to sustainability, and encourage you to be too.\r\n\r\n\u201cMeridian 300\u201d is carboNZero\u003Csup\u003EcertTM\u003C/sup\u003E certified electricity. All units of this product used, will be accounted for by Meridian under the rules of the Landcare Research carboNZero\u003Csup\u003EcertTM\u003C/sup\u003E programme. For more information about Meridian, or our carboNZero\u003Csup\u003EcertTM\u003C/sup\u003E certification, visit \u003Ca href=\"http://www.meridianenergy.co.nz\"\u003Ewww.meridianenergy.co.nz\u003C/a\u003E."},{"type":"special","image_url":"https://suppliertest.youdo.co.nz/photos/3e9499a622046211c7a12dfb197a6b39.original","name":"$84.90 catch up pack","price_per_unit":"0.1772","description":"Buy in bulk and save. With Flower Power $84.90 value pack you can quickly catch up on power you have used.\r\nRestricted to one per week and use any time before the \"use by\" date above.  Make sure though that you use all of your bulk purchased electricity - as all bulk purchases are use it or lose it propositions. \r\n  \r\n\r\nFlower Power \r\n\u003Ca href=\"http://www.flowerpowernz.co.nz\"\u003EFlower Power\u003C/a\u003E  is owned by \u003Ca href=\"http://www.powerkiwi.co.nz\"\u003EPowerKiwi\u003C/a\u003E, an independent company.  "},{"type":"nominated","image_url":"https://suppliertest.youdo.co.nz/photos/23badbfebc43c19a90471d15d088d896.original","name":"Top Up","price_per_unit":"0.1793","description":"Top Up is Standard Power's most versatile product - buy some now to use now, or set it as your default product and rest easy knowing you'll be on a good deal.\r\n\r\n\u003Cb\u003EWho is Standard Power?\u003C/b\u003E\r\nStandard Power is backed by Powershop.  It is the name we use for our budget house brand electricity because it is the same \u003Ci\u003Ebulk standard\u003C/i\u003E electricity, just better deals.\r\n"},{"type":"nominated","image_url":"https://suppliertest.youdo.co.nz/photos/c28aa100f1c7ba8ceb8a27fe79235138.original","name":"Meridian","price_per_unit":"0.1819","description":"Wind and water are nature\u2019s carbon free fuels, and Meridian uses them to generate electricity. We\u2019re committed to sustainability, and encourage you to be too.  \r\n\r\n\u201cMeridian\u201d is carboNZero\u003Csup\u003EcertTM\u003C/sup\u003E certified electricity. All units of this product used, will be accounted for by Meridian under the rules of the Landcare Research carboNZero\u003Csup\u003EcertTM\u003C/sup\u003E programme.\r\n\r\nFor more information about Meridian, or our carboNZero\u003Csup\u003EcertTM\u003C/sup\u003E certification, visit \u003Ca href=\"http://www.meridianenergy.co.nz\"\u003Ewww.meridianenergy.co.nz\u003C/a\u003E."},{"type":"nominated","image_url":"https://suppliertest.youdo.co.nz/photos/b0b3034e188ddadb267d2edb62ec5e96.original","name":"Tree Power Top Up","price_per_unit":"0.1983","description":"For each 30 units you buy Treepower will plant a tree through Trees for the Future. \r\n\r\nWe have contracted Trees for the Future to plant a tree for every 30 KWh of TreePower that is used. Trees for the Future has been working with communities in Central America, Asia and Africa since 1989, and we are proud to be able to contribute to their work. They work directly with rural communities in countries and locations that need serious help to restore ecological balance.\r\n\r\nPlanting the trees helps the communities in three ways - restoring degrading lands and farms, minimising erosion, and providing forage for animals. The process also involves training local people to care for their own environment. \r\n\r\nMeanwhile Trees for the Future estimates that each tree will absorb about 50 lb (that's 22 kg) of carbon, though this is not certified, and it will vary depending on the type of tree and the location. If you want to offset the carbon emission impact of your electricity consumption then try our sister product Green Power. \r\n\r\nAbout Tree Power\r\nTree Power is a product from \u003Ca href=\"http://www.powerkiwi.co.nz\"\u003EPowerKiwi\u003C/a\u003E, an independent Kiwi owned company. We have a partnership contract in place with \u003Ca href=\"http://www.treesftf.org/\"\u003ETrees for the Future\u003C/a\u003E.\r\n \r\nWe have just launched Tree Power, but will report back on how many trees are planted as we progress."},{"type":"nominated","image_url":"https://suppliertest.youdo.co.nz/photos/a6406b84e4b2bcc6bd19f70953db7b1e.original","name":"Meridian Crimson","price_per_unit":"0.2044","description":"Choose Meridian Crimson and you play a part in protecting New Zealand's native trees. For every unit of Meridian Crimson electricity you buy, Meridian will donate 2 cents to The Project Crimson Trust - a charitable trust that protects and renews Pohutukawa and Rata trees throughout New Zealand. When you choose Crimson power, you're helping our Kiwi Christmas trees keep blooming brilliant red every summer.\r\n\r\n\u201cMeridian Crimson\u201d is carboNZero\u003Csup\u003EcertTM\u003C/sup\u003E certified electricity. All units of this product used, will be accounted for by Meridian under the rules of the Landcare Research carboNZero programme.\r\n\r\nFor more information about Meridian, or our carboNZero certification, visit \u003Ca href=\"http://www.meridianenergy.co.nz\"\u003Ewww.meridianenergy.co.nz\u003C/a\u003E.\r\n\r\nSee \u003Ca href=\"http://www.projectcrimson.org.nz\"\u003Ewww.projectcrimson.org.nz\u003C/a\u003E for more on the Trust\u2019s work.\r\n \r\n"},{"type":"nominated","image_url":"https://suppliertest.youdo.co.nz/photos/64df17a17766c0b8e85829ee56c1a4aa.original","name":"Flower Power Top Up","price_per_unit":"0.1785","description":"Welcome to \u003Cb\u003EFlower Power\u003C/b\u003E!\r\n\r\nPower companies have been keeping us in the dark. Buying power can actually be \u003Cb\u003Every simple, quick and fun.\u003C/b\u003E\r\n\r\nJoin the Flower Power revolution today and you'll still get electricity from the same source, use the same meter and receive the same professional backup if things go wrong. \r\n\r\n* Take control, and buy electricity on your own terms\r\n* Save money and impress your friends!\r\n* 100% safe, online and paper free\r\n\r\nJoin the Flower Power revolution, and top up with \u003Ca href=\"http://www.flowerpowernz.co.nz/\"\u003EFlower Power\u003C/a\u003E. \r\n\r\n\u003Cb\u003EAbout Flower Power\u003C/b\u003E\r\n\u003Ca href=\"http://www.flowerpowernz.co.nz/\"\u003EFlower Power\u003C/a\u003E is a product from \u003Ca href=\"http://www.powerkiwi.co.nz/\"\u003EPowerKiwi\u003C/a\u003E, an independent NZ owned company."}]}

data/test/responses/properties.json

@@ -0,0 +1 @@
+{"version":"1.0","result":{"properties":[{"last_account_review_at":"2009-10-22 12:00:00","registers":[{"estimated_reading_value":"63922","dials":5,"register_number":"109479:1","last_reading_at":"2009-12-25 00:13:04","description":null,"last_reading_value":"63918","hidden":0,"last_reading_type":"customer"}],"end_date":"","start_date":"2009-02-24","icp_number":"0001427254UNF48","daily_consumption":120.1,"unit_balance":-8261,"address":{"region":null,"street_number":"1","district":"WELLINGTON","street_name":"test_address","flat_number":"12","suburb":"TE ARO"}}]}}

data/test/responses/success.json

@@ -0,0 +1 @@
+{"version":"1.0","result":{"result":"success"}}

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/powershop'
+
+require 'mocha'

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: powershop
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Nik Wakelin
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-26 00:00:00 +13:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: oauth
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.3.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.5
+    version: 
+description: Allows Ruby applications to communicate with the Powershop API
+email: nik@codetocustomer.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- init.rb
+- LICENSE
+- Rakefile
+- README.textile
+- examples/powershop_example.rb
+- lib/powershop.rb
+- lib/powershop/client.rb
+- lib/powershop/oauth.rb
+- lib/powershop/property.rb
+- lib/powershop/register.rb
+- script/console
+- test/client_test.rb
+- test/test_helper.rb
+- test/responses/get_top_up.json
+- test/responses/icp_number_error.json
+- test/responses/meter_readings.json
+- test/responses/products.json
+- test/responses/properties.json
+- test/responses/success.json
+- powershop.gemspec
+has_rdoc: true
+homepage: http://github.com/codetocustomer/powershop
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Allows Ruby applications to communicate with the Powershop API
+test_files: []
+