carbonculture 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3821fca3c7b630be4de6b2e4d22c4067cbcefbaf
+  data.tar.gz: eff2621b87a3f9257e671abcc7b0037c3d247a7c
+SHA512:
+  metadata.gz: f42abd2b64c7d2266732b9e8bb5d866c55988d15c690337083e702a36e661a5012deab9f0ef3f4a07e9703ffacc10a1b29a4a20bfc8638f286f1684236660f5b
+  data.tar.gz: 5e356620c9f7c27d3a10ffa20cabda4a08a44c88b746e8afdde296d2525634781ac2ac4e8c16ffe25e1ed1924e0008e17ea4de912b811e96e8d3555d7996323b

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in carbonculture.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Sam Knight
+
+MIT License
+
+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.md

@@ -0,0 +1,41 @@
+# Carbonculture
+
+Reads the utility usage of various public buildings including Number 10 Downing Street
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'carbonculture'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install carbonculture
+
+## Usage
+
+You can find building from organisations or call it directly.
+
+    Carbonculture::Organisation('number10').places
+    
+or
+
+    Carbonculture::Place('10-downing-street', 'number10')
+    
+Channels for different types of utility (electric, gas, etc)
+
+    Carbonculture::Place('10-downing-street', 'number10').channels
+    
+More information on methods and results available can be discovered at http://data.carbonculture.net/
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['spec/lib/carbonculture/*_spec.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/carbonculture.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'carbonculture/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "carbonculture"
+  spec.version       = Carbonculture::VERSION
+  spec.authors       = ["Sam Knight"]
+  spec.email         = ["sam@samknight.co.uk"]
+  spec.description   = "Ruby library to gather energy data from CarbonCulture"
+  spec.summary       = "Ruby library to gather energy data from CarbonCulture"
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'httparty'
+
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/carbonculture/base_url.rb

@@ -0,0 +1,3 @@
+module Carbonculture
+  BASE_URL = 'http://data.carbonculture.net'
+end

data/lib/carbonculture/channel.rb

@@ -0,0 +1,56 @@
+module Carbonculture
+  class Channel
+    include HTTParty
+    attr_accessor :name, :place_name, :organisation_name, :data, :body, :results
+
+    def initialize(name, place_name, organisation_name, options = {})
+      self.name = name
+      self.place_name = place_name
+      self.organisation_name = organisation_name
+      self.results = []
+
+      call_api(options)
+
+      begin
+        self.body = JSON.parse(self.data.body)
+      rescue
+        raise ArgumentError
+      end
+
+      build_results
+
+    end
+
+    def place
+      Place.new(place_name, organisation_name)
+    end
+
+    def method_missing(method_name, *args, &block)
+      if body.has_key?(method_name.to_s)
+        body[method_name.to_s]
+      else
+        super
+      end
+    end
+
+    private
+
+    def call_api(options = {})
+      option_params = []
+      options.each_pair { |k, v| option_params << "#{ k }=#{ v }" }
+
+      self.data = self.class.get "#{ BASE_URL }/#{ organisation_name }/#{ place_name }/#{ name }" + '?' + option_params.join('&')
+    end
+
+    def build_results
+      set_start = Time.parse(body['start_time'])
+      set_end = Time.parse(body['end_time'])
+      set_ratio = (set_end - set_start) / body['points'].to_i
+      body['results'].each do |result|
+        self.results << Result.new(set_start, set_start + set_ratio, result.first)
+        set_start = set_start + set_ratio
+      end
+    end
+
+  end
+end

data/lib/carbonculture/organisation.rb

@@ -0,0 +1,26 @@
+module Carbonculture
+  class Organisation
+    include HTTParty
+    attr_accessor :name, :data, :body
+
+    def initialize(name)
+      self.name = name
+      self.data = self.class.get "#{ BASE_URL }/#{ name }"
+
+      raise ArgumentError if data.response.code == '404'
+      self.body = JSON.parse(self.data.body)
+    end
+
+    def places
+      body['places'].map { |p| Place.new(p, name) }
+    end
+
+    def method_missing(method_name, *args, &block)
+      if body.has_key?(method_name.to_s)
+        body[method_name.to_s]
+      else
+        super
+      end
+    end
+  end
+end

data/lib/carbonculture/place.rb

@@ -0,0 +1,32 @@
+module Carbonculture
+  class Place
+    include HTTParty
+    attr_accessor :name, :organisation_name, :data, :body
+
+    def initialize(name, org_name)
+      self.name = name
+      self.organisation_name = org_name
+      self.data = self.class.get "#{ BASE_URL }/#{ org_name }/#{ name }"
+
+      self.body = JSON.parse(self.data.body)
+      raise ArgumentError if status == 'fail'
+
+    end
+
+    def organisation
+      Organisation.new(organisation_name)
+    end
+
+    def channels(options = {})
+      body['channels'].map { |c| Channel.new(c, name, organisation_name, options) }
+    end
+
+    def method_missing(method_name, *args, &block)
+      if body.has_key?(method_name.to_s)
+        body[method_name.to_s]
+      else
+        super
+      end
+    end
+  end
+end

data/lib/carbonculture/result.rb

@@ -0,0 +1,12 @@
+module Carbonculture
+  class Result
+    include HTTParty
+    attr_accessor :start_time, :end_time, :value
+
+    def initialize(start_time, end_time, value)
+      self.start_time = start_time
+      self.end_time = end_time
+      self.value = value
+    end
+  end
+end

data/lib/carbonculture/version.rb

@@ -0,0 +1,3 @@
+module Carbonculture
+  VERSION = "0.0.1"
+end

data/lib/carbonculture.rb

@@ -0,0 +1,7 @@
+module Carbonculture
+  require 'json'
+  require 'httparty'
+  Dir[File.dirname(__FILE__) + '/carbonculture/*.rb'].each do |file|
+    require file
+  end
+end

data/spec/fixtures/carbonculture_cassettes/channel.yml

@@ -0,0 +1,313 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://data.carbonculture.net/number10/10-downing-street/elec
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.2.7
+      Date:
+      - Thu, 27 Jun 2013 10:19:20 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Vary:
+      - Accept-Encoding
+      - Authorization, Host
+      Access-Control-Allow-Headers:
+      - X-Requested-With
+      Access-Control-Allow-Credentials:
+      - 'false'
+      Api-Version:
+      - v1
+      Access-Control-Allow-Origin:
+      - ! '*'
+      Access-Control-Allow-Methods:
+      - POST,GET,OPTIONS
+    body:
+      encoding: US-ASCII
+      string: ! "{\n    \"status\": \"ok\", \n    \"fields\": [\n        \"number10.10-downing-street.elec\"\n
+        \   ], \n    \"start_time\": \"2013-06-26T10:00:00\", \n    \"results\": [\n
+        \       [\n            \"88.12\"\n        ], \n        [\n            \"92.82\"\n
+        \       ], \n        [\n            \"92.34\"\n        ], \n        [\n            \"87.49\"\n
+        \       ], \n        [\n            \"83.78\"\n        ], \n        [\n            \"84.66\"\n
+        \       ], \n        [\n            \"88.29\"\n        ], \n        [\n            \"86.98\"\n
+        \       ], \n        [\n            \"91.87\"\n        ], \n        [\n            \"93.15\"\n
+        \       ], \n        [\n            \"87.61\"\n        ], \n        [\n            \"90.94\"\n
+        \       ], \n        [\n            \"86.61\"\n        ], \n        [\n            \"83.11\"\n
+        \       ], \n        [\n            \"82.54\"\n        ], \n        [\n            \"76.97\"\n
+        \       ], \n        [\n            \"80.58\"\n        ], \n        [\n            \"78.64\"\n
+        \       ], \n        [\n            \"75.54\"\n        ], \n        [\n            \"72.24\"\n
+        \       ], \n        [\n            \"68.61\"\n        ], \n        [\n            \"63.10\"\n
+        \       ], \n        [\n            \"60.13\"\n        ], \n        [\n            \"59.83\"\n
+        \       ], \n        [\n            \"58.22\"\n        ], \n        [\n            \"60.40\"\n
+        \       ], \n        [\n            \"58.20\"\n        ], \n        [\n            \"56.65\"\n
+        \       ], \n        [\n            \"55.67\"\n        ], \n        [\n            \"53.92\"\n
+        \       ], \n        [\n            \"52.61\"\n        ], \n        [\n            \"52.55\"\n
+        \       ], \n        [\n            \"52.83\"\n        ], \n        [\n            \"54.33\"\n
+        \       ], \n        [\n            \"55.32\"\n        ], \n        [\n            \"55.77\"\n
+        \       ], \n        [\n            \"56.88\"\n        ], \n        [\n            \"57.34\"\n
+        \       ], \n        [\n            \"60.89\"\n        ], \n        [\n            \"79.19\"\n
+        \       ], \n        [\n            \"86.37\"\n        ], \n        [\n            \"86.93\"\n
+        \       ], \n        [\n            \"88.98\"\n        ], \n        [\n            \"88.08\"\n
+        \       ], \n        [\n            \"88.81\"\n        ], \n        [\n            \"93.87\"\n
+        \       ], \n        [\n            \"89.94\"\n        ], \n        [\n            \"84.21\"\n
+        \       ]\n    ], \n    \"points\": 48, \n    \"end_time\": \"2013-06-27T10:00:00\"\n}"
+    http_version: 
+  recorded_at: Thu, 27 Jun 2013 10:19:18 GMT
+- request:
+    method: get
+    uri: http://data.carbonculture.net/number10/10-downing-street/fake
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 404
+      message: NOT FOUND
+    headers:
+      Server:
+      - nginx/1.2.7
+      Date:
+      - Thu, 27 Jun 2013 10:19:20 GMT
+      Content-Type:
+      - text/plain
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Vary:
+      - Accept-Encoding
+      - Authorization, Host
+      Access-Control-Allow-Headers:
+      - X-Requested-With
+      Access-Control-Allow-Credentials:
+      - 'false'
+      Api-Version:
+      - v1
+      Access-Control-Allow-Origin:
+      - ! '*'
+      Access-Control-Allow-Methods:
+      - POST,GET,OPTIONS
+    body:
+      encoding: US-ASCII
+      string: ! 'Not Found: Unknown channels: number10.10-downing-street.fake'
+    http_version: 
+  recorded_at: Thu, 27 Jun 2013 10:19:19 GMT
+- request:
+    method: get
+    uri: http://data.carbonculture.net/number10/10-downing-street
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.2.7
+      Date:
+      - Thu, 27 Jun 2013 10:39:37 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Vary:
+      - Accept-Encoding
+      - Authorization, Host
+      Access-Control-Allow-Headers:
+      - X-Requested-With
+      Access-Control-Allow-Credentials:
+      - 'false'
+      Api-Version:
+      - v1
+      Access-Control-Allow-Origin:
+      - ! '*'
+      Access-Control-Allow-Methods:
+      - POST,GET,OPTIONS
+    body:
+      encoding: US-ASCII
+      string: ! "{\n    \"status\": \"ok\", \n    \"operational_rating\": [\n        {\n
+        \           \"end_date\": \"2011-06-27\", \n            \"start_date\": \"2010-06-28\",
+        \n            \"value\": 87\n        }, \n        {\n            \"end_date\":
+        \"2012-06-27\", \n            \"start_date\": \"2011-06-28\", \n            \"value\":
+        83\n        }, \n        {\n            \"end_date\": \"2013-06-27\", \n            \"start_date\":
+        \"2012-06-28\", \n            \"value\": 82\n        }\n    ], \n    \"title\":
+        \"10 Downing Street\", \n    \"link_url\": \"http://www.carbonculture.net/orgs/number10/10-downing-street/\",
+        \n    \"namespace\": \"number10.10-downing-street\", \n    \"channels\": [\n
+        \       \"heat\", \n        \"elec\", \n        \"gas\"\n    ], \n    \"place\":
+        \"10-downing-street\", \n    \"image_url\": \"http://www.carbonculture.net/uploads/places/images/no10external_carbonculture_260.png\",
+        \n    \"building_stats\": {}\n}"
+    http_version: 
+  recorded_at: Thu, 27 Jun 2013 10:39:36 GMT
+- request:
+    method: get
+    uri: http://data.carbonculture.net/number10/10-downing-street/elec?
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.2.7
+      Date:
+      - Tue, 02 Jul 2013 16:56:12 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Vary:
+      - Accept-Encoding
+      - Authorization, Host
+      Access-Control-Allow-Headers:
+      - X-Requested-With
+      Access-Control-Allow-Credentials:
+      - 'false'
+      Api-Version:
+      - v1
+      Access-Control-Allow-Origin:
+      - ! '*'
+      Access-Control-Allow-Methods:
+      - POST,GET,OPTIONS
+    body:
+      encoding: US-ASCII
+      string: ! "{\n    \"status\": \"ok\", \n    \"fields\": [\n        \"number10.10-downing-street.elec\"\n
+        \   ], \n    \"start_time\": \"2013-07-01T16:30:00\", \n    \"results\": [\n
+        \       [\n            \"75.50\"\n        ], \n        [\n            \"72.89\"\n
+        \       ], \n        [\n            \"71.99\"\n        ], \n        [\n            \"72.37\"\n
+        \       ], \n        [\n            \"70.30\"\n        ], \n        [\n            \"66.59\"\n
+        \       ], \n        [\n            \"63.28\"\n        ], \n        [\n            \"62.36\"\n
+        \       ], \n        [\n            \"60.68\"\n        ], \n        [\n            \"59.41\"\n
+        \       ], \n        [\n            \"65.21\"\n        ], \n        [\n            \"60.99\"\n
+        \       ], \n        [\n            \"56.84\"\n        ], \n        [\n            \"56.25\"\n
+        \       ], \n        [\n            \"55.78\"\n        ], \n        [\n            \"55.73\"\n
+        \       ], \n        [\n            \"55.77\"\n        ], \n        [\n            \"54.35\"\n
+        \       ], \n        [\n            \"56.25\"\n        ], \n        [\n            \"54.22\"\n
+        \       ], \n        [\n            \"53.64\"\n        ], \n        [\n            \"54.98\"\n
+        \       ], \n        [\n            \"54.55\"\n        ], \n        [\n            \"53.62\"\n
+        \       ], \n        [\n            \"55.58\"\n        ], \n        [\n            \"60.07\"\n
+        \       ], \n        [\n            \"75.33\"\n        ], \n        [\n            \"79.11\"\n
+        \       ], \n        [\n            \"85.69\"\n        ], \n        [\n            \"91.82\"\n
+        \       ], \n        [\n            \"90.93\"\n        ], \n        [\n            \"91.63\"\n
+        \       ], \n        [\n            \"91.10\"\n        ], \n        [\n            \"91.66\"\n
+        \       ], \n        [\n            \"95.61\"\n        ], \n        [\n            \"91.94\"\n
+        \       ], \n        [\n            \"92.37\"\n        ], \n        [\n            \"89.87\"\n
+        \       ], \n        [\n            \"91.47\"\n        ], \n        [\n            \"89.40\"\n
+        \       ], \n        [\n            \"89.98\"\n        ], \n        [\n            \"88.74\"\n
+        \       ], \n        [\n            \"90.59\"\n        ], \n        [\n            \"95.25\"\n
+        \       ], \n        [\n            \"96.95\"\n        ], \n        [\n            \"93.33\"\n
+        \       ], \n        [\n            \"93.41\"\n        ], \n        [\n            \"89.97\"\n
+        \       ]\n    ], \n    \"points\": 48, \n    \"end_time\": \"2013-07-02T16:30:00\"\n}"
+    http_version: 
+  recorded_at: Tue, 02 Jul 2013 16:56:11 GMT
+- request:
+    method: get
+    uri: http://data.carbonculture.net/number10/10-downing-street/elec?points=12
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.2.7
+      Date:
+      - Tue, 02 Jul 2013 16:56:13 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Vary:
+      - Accept-Encoding
+      - Authorization, Host
+      Access-Control-Allow-Headers:
+      - X-Requested-With
+      Access-Control-Allow-Credentials:
+      - 'false'
+      Api-Version:
+      - v1
+      Access-Control-Allow-Origin:
+      - ! '*'
+      Access-Control-Allow-Methods:
+      - POST,GET,OPTIONS
+    body:
+      encoding: US-ASCII
+      string: ! "{\n    \"status\": \"ok\", \n    \"fields\": [\n        \"number10.10-downing-street.elec\"\n
+        \   ], \n    \"start_time\": \"2013-07-01T16:30:00\", \n    \"results\": [\n
+        \       [\n            \"292.71\"\n        ], \n        [\n            \"262.53\"\n
+        \       ], \n        [\n            \"246.31\"\n        ], \n        [\n            \"224.61\"\n
+        \       ], \n        [\n            \"220.64\"\n        ], \n        [\n            \"216.71\"\n
+        \       ], \n        [\n            \"270.12\"\n        ], \n        [\n            \"360.08\"\n
+        \       ], \n        [\n            \"370.28\"\n        ], \n        [\n            \"363.11\"\n
+        \       ], \n        [\n            \"364.57\"\n        ], \n        [\n            \"373.66\"\n
+        \       ]\n    ], \n    \"points\": 12, \n    \"end_time\": \"2013-07-02T16:30:00\"\n}"
+    http_version: 
+  recorded_at: Tue, 02 Jul 2013 16:56:11 GMT
+- request:
+    method: get
+    uri: http://data.carbonculture.net/number10/10-downing-street/fake?
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 404
+      message: NOT FOUND
+    headers:
+      Server:
+      - nginx/1.2.7
+      Date:
+      - Tue, 02 Jul 2013 16:56:13 GMT
+      Content-Type:
+      - text/plain
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Vary:
+      - Accept-Encoding
+      - Authorization, Host
+      Access-Control-Allow-Headers:
+      - X-Requested-With
+      Access-Control-Allow-Credentials:
+      - 'false'
+      Api-Version:
+      - v1
+      Access-Control-Allow-Origin:
+      - ! '*'
+      Access-Control-Allow-Methods:
+      - POST,GET,OPTIONS
+    body:
+      encoding: US-ASCII
+      string: ! 'Not Found: Unknown channels: number10.10-downing-street.fake'
+    http_version: 
+  recorded_at: Tue, 02 Jul 2013 16:56:11 GMT
+recorded_with: VCR 2.5.0