pachuber 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2009 kitplummer@gmail.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,11 @@
+h1. First whack at a Ruby API for interacting with "Pachube":http://www.pachube.com
+
+h2. Work in progress at this point
+
+Requires version 0.2.0 or greater of the eeml-simple EEML wrapper library.  Thanks to James Smith for including my changes upstream.
+
+Take a peek at the test cases for examples of how to consume/contribute to Pachube in either EEML XML or EEML objects.
+
+h2. Wants
+
+To support the whole API, I don't need it all yet.  So...if you're interested fork away or let me know how I can help.

data/Rakefile

@@ -0,0 +1,70 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+
+$:.unshift(File.dirname(__FILE__) + "/lib")
+require 'pachuber'
+
+PKG_NAME      = 'pachuber'
+PKG_VERSION   = Pachube::VERSION
+PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc "Clean generated files"
+task :clean do
+  #rm FileList['test/']
+  rm_rf 'pkg'
+  rm_rf 'rdoc'
+end
+
+desc 'Test the pachuber gem.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the pachuber gem.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'pachuber'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.textile')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+# Create compressed packages
+spec = Gem::Specification.new do |s|
+  s.platform = Gem::Platform::RUBY
+  s.name = PKG_NAME
+  s.summary = "Interact with the Pachube API via HTTParty."
+  s.description = %q{Just a simple Ruby library to provides Ruby-style abstraction around the HTTP API at Pachube.}
+  s.version = PKG_VERSION
+
+  s.author = "Kit Plummer"
+  s.email = "kitplummer@gmail.com"
+  s.rubyforge_project = PKG_NAME
+  s.homepage = "http://github.com/kitplummer/pachuber"
+
+  s.has_rdoc = true
+  s.requirements << 'none'
+  s.require_path = 'lib'
+  #s.autorequire = 'pachuber'
+  s.add_dependency("httparty", ">= 0.4.5")
+  s.add_dependency("eeml-simple", ">= 0.2.0")
+  s.files = [ "Rakefile", "README.textile", "MIT-LICENSE" ]
+  s.files = s.files + Dir.glob( "lib/**/*" ).delete_if { |item| item.include?( "\.svn" ) }
+  s.files = s.files + Dir.glob( "resources/**/*" ).delete_if { |item| item.include?( "\.svn" ) }
+  s.files = s.files + Dir.glob( "test/**/*" ).delete_if { |item| item.include?( "\.svn" ) || item.include?("\.png") }
+end
+  
+Rake::GemPackageTask.new(spec) do |p|
+  p.gem_spec = spec
+  p.need_tar = false
+  p.need_zip = true
+end

data/lib/pachuber.rb

@@ -0,0 +1,32 @@
+require 'rubygems'
+require 'httparty'
+require 'eeml'
+
+class Pachube
+  VERSION = '0.1.0'
+  class PachubeError < RuntimeError; end
+  
+  include HTTParty
+  base_uri 'http://www.pachube.com/api'
+  
+  def initialize(key)
+    @key = key
+  end
+  
+  def get_xml(feed_url)
+    options = { :format => "xml", :headers => {"X-PachubeApiKey" => @key} }
+    self.class.get(feed_url, options)
+  end
+  
+  def get_eeml(feed_url)
+    xml = self.get_xml(feed_url)
+    eeml = EEML::Environment.from_eeml(xml)
+  end
+  
+  def update(feed_url, eeml)
+    options = { :headers => {"X-PachubeApiKey" => @key},
+                :body => eeml 
+              }
+    self.class.put(feed_url, options)
+  end
+end

data/resources/005.xsd

@@ -0,0 +1,134 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<xsd:schema xmlns="http://www.eeml.org/xsd/005" elementFormDefault="qualified" targetNamespace="http://www.eeml.org/xsd/005" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+  <xsd:element name="eeml">
+    <xsd:complexType>
+      <xsd:choice>
+        <xsd:element maxOccurs="unbounded" name="environment">
+          <xsd:complexType>         
+            <xsd:sequence>
+              <xsd:element minOccurs="0" name="title" type="xsd:string" />
+              <xsd:element minOccurs="0" name="feed" type="xsd:anyURI" />
+              <xsd:element minOccurs="0" name="status">
+                <xsd:simpleType>
+                  <xsd:restriction base="xsd:string">
+                    <xsd:enumeration value="frozen" />
+                    <xsd:enumeration value="live" />
+                  </xsd:restriction>
+                </xsd:simpleType>
+              </xsd:element>
+              <xsd:element minOccurs="0" name="description" type="xsd:string" />
+              <xsd:element minOccurs="0" name="icon" type="xsd:anyURI" />
+              <xsd:element minOccurs="0" name="website" type="xsd:anyURI" />
+              <xsd:element minOccurs="0" name="email" type="xsd:string" />
+              <xsd:element minOccurs="0" name="location">
+                <xsd:complexType>
+                  <xsd:sequence>
+                    <xsd:element minOccurs="0" name="name" type="xsd:string" />
+                    <xsd:element name="lat">
+                      <xsd:simpleType>
+                        <xsd:restriction base="xsd:double">
+                          <xsd:minInclusive value="-90" />
+                          <xsd:maxInclusive value="90" />
+                        </xsd:restriction>
+                      </xsd:simpleType>
+                    </xsd:element>
+                    <xsd:element name="lon">
+                      <xsd:simpleType>
+                        <xsd:restriction base="xsd:double">
+                          <xsd:minInclusive value="-180" />
+                          <xsd:maxInclusive value="180" />
+                        </xsd:restriction>
+                      </xsd:simpleType>
+                    </xsd:element>
+                    <xsd:element minOccurs="0" maxOccurs="1" name="ele" type="xsd:double" />
+                  </xsd:sequence>
+                  <xsd:attribute name="exposure" use="optional">
+                    <xsd:simpleType>
+                      <xsd:restriction base="xsd:string">
+                        <xsd:enumeration value="indoor" />
+                        <xsd:enumeration value="outdoor" />
+                      </xsd:restriction>
+                    </xsd:simpleType>
+                  </xsd:attribute>
+                  <xsd:attribute name="domain" use="required">
+                    <xsd:simpleType>
+                      <xsd:restriction base="xsd:string">
+                        <xsd:enumeration value="physical" />
+                        <xsd:enumeration value="virtual" />
+                      </xsd:restriction>
+                    </xsd:simpleType>
+                  </xsd:attribute>
+                  <xsd:attribute name="disposition" use="optional">
+                    <xsd:simpleType>
+                      <xsd:restriction base="xsd:string">
+                        <xsd:enumeration value="fixed" />
+                        <xsd:enumeration value="mobile" />
+                      </xsd:restriction>
+                    </xsd:simpleType>
+                  </xsd:attribute>
+                </xsd:complexType>
+              </xsd:element>            
+              <xsd:element minOccurs="1" maxOccurs="unbounded" name="data">
+                <xsd:complexType>
+                  <xsd:sequence>
+                    <xsd:element minOccurs="0" maxOccurs="unbounded" name="tag" type="xsd:string" />
+                    <xsd:element name="value">
+                      <xsd:complexType>
+                        <xsd:simpleContent>
+                          <xsd:extension base="xsd:string">
+                            <xsd:attribute name="minValue" type="xsd:string" use="optional" />
+                            <xsd:attribute name="maxValue" type="xsd:string" use="optional" />
+                          </xsd:extension>
+                        </xsd:simpleContent>
+                      </xsd:complexType>
+                    </xsd:element>
+                    <xsd:element minOccurs="0" maxOccurs="1" name="unit">
+                      <xsd:complexType>
+                        <xsd:simpleContent>
+                          <xsd:extension base="xsd:string">
+                            <xsd:attribute name="symbol" type="xsd:string" use="optional">
+                            </xsd:attribute>
+                            <xsd:attribute name="type" use="optional">
+                              <xsd:simpleType>
+                                <xsd:restriction base="xsd:string">
+                                  <xsd:enumeration value="basicSI" />
+                                  <xsd:enumeration value="derivedSI" />
+                                  <xsd:enumeration value="conversionBasedUnits" />
+                                  <xsd:enumeration value="derivedUnits" />
+                                  <xsd:enumeration value="contextDependentUnits" />
+                                </xsd:restriction>
+                              </xsd:simpleType>
+                            </xsd:attribute>
+                          </xsd:extension>
+                        </xsd:simpleContent>
+                      </xsd:complexType>
+                    </xsd:element>
+                  </xsd:sequence>
+                  <xsd:attribute name="id" type="xsd:nonNegativeInteger" use="required" />
+                </xsd:complexType>
+              </xsd:element>
+             </xsd:sequence>            
+            <xsd:attribute name="updated" use="optional">
+              <xsd:simpleType>
+                <xsd:restriction base="xsd:dateTime" />
+              </xsd:simpleType>
+            </xsd:attribute>
+            <xsd:attribute fixed="http://www.haque.co.uk" name="creator" use="optional">
+              <xsd:simpleType>
+                <xsd:restriction base="xsd:string" />
+              </xsd:simpleType>
+            </xsd:attribute>
+            <xsd:attribute name="id" type="xsd:nonNegativeInteger" use="optional" />
+          </xsd:complexType>
+        </xsd:element>
+      </xsd:choice>
+      <xsd:attribute name="version" use="optional">
+        <xsd:simpleType>
+          <xsd:restriction base="xsd:positiveInteger">            
+            <xsd:enumeration value="5" />
+          </xsd:restriction>
+        </xsd:simpleType>
+      </xsd:attribute>
+    </xsd:complexType>
+  </xsd:element>
+</xsd:schema>

data/resources/key.rb

@@ -0,0 +1,3 @@
+def pachube_api_key
+  'c2c52190262b5a066ed86fc4e8f57071248a2f66d73c98b87d109469b07144eb'
+end

data/test/pachuber_test.rb

@@ -0,0 +1,35 @@
+require 'rubygems'
+require 'test/unit'
+require 'nokogiri'
+
+require File.join(File.dirname(__FILE__), '../lib/pachuber.rb')
+# The pachube_api_key needs to be your Pachube API key.
+# I happen to store mine in a key.rb file in resources/.
+require File.join(File.dirname(__FILE__), '../resources/key.rb')
+class PachubeTest < Test::Unit::TestCase
+
+  def test_pachube_get_xml
+    pach = Pachube.new(pachube_api_key)
+    xml = pach.get_xml("/504.xml")
+    assert xml
+    assert_equal "Pachube Office environment",
+    Nokogiri::XML.parse(xml).css('title').text.to_s
+  end
+
+  def test_pachube_get_eeml
+    pach = Pachube.new(pachube_api_key)
+    eeml = pach.get_eeml("/504.xml")  
+    assert eeml
+    assert_equal "EEML::Environment", eeml.class.name
+    assert_equal "office", eeml.location.name
+  end
+
+  def test_pachube_update_post
+    env = EEML::Environment.new
+    env << EEML::Data.new(42, :id => "ABC123")
+    pach = Pachube.new(pachube_api_key)
+    resp = pach.update("/4078.xml", env.to_eeml)
+    assert_equal 200, resp.code
+  end
+  
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: pachuber
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Kit Plummer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-10 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.4.5
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: eeml-simple
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.0
+    version: 
+description: Just a simple Ruby library to provides Ruby-style abstraction around the HTTP API at Pachube.
+email: kitplummer@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- README.textile
+- MIT-LICENSE
+- lib/pachuber.rb
+- resources/005.xsd
+- resources/key.rb
+- test/pachuber_test.rb
+has_rdoc: true
+homepage: http://github.com/kitplummer/pachuber
+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: 
+- none
+rubyforge_project: pachuber
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Interact with the Pachube API via HTTParty.
+test_files: []
+