obix 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c01e1acd9c0991b24c9c60188e66a864760e6497
+  data.tar.gz: 6ab23c6b03f95b153b17bd1546a4e1c4838f753d
+SHA512:
+  metadata.gz: 17c06e109456a511132d9add1fedb40fe580b7a72f689b9fad8d76a3d336d79e38d4cfac234956b58ca4bacc565258bf576078ce3900db5a9ac1baf2e8095403
+  data.tar.gz: 675c562b85336c9f3c53681cee97cd1da87d10322838777cf4036d85ceb015b69d447edc61b93cc78974d18c8daca76d58c5eeb97de8f4ed14f18ba655978223

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 obix.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'minitest' do
+  watch(%r|^test/(.*)\/?(.*)_test\.rb|)
+  watch(%r|^lib/(.*)([^/]+)\.rb|)     { |m| "test/#{m[1]}#{m[2]}_test.rb" }
+  watch(%r|^test/test_helper\.rb|)    { "test" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Johannes Gorset
+
+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,128 @@
+# OBIX
+
+[![Code Climate](https://codeclimate.com/github/hyperoslo/obix.png)](https://codeclimate.com/github/hyperoslo/obix)
+
+Ruby OBIX parser.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'obix'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install obix
+
+## Usage
+
+### Parse an object
+
+```xml
+<!-- thermostat.xml -->
+<obj href="http://domain/thermostat">
+  <real name="spaceTemp" unit="obix:units/fahrenheit" val="67.2"/>
+  <real name="setpoint" unit="obix:units/fahrenheit" val="72.0"/>
+  <bool name="furnaceOn" val="true"/>
+</obj>
+```
+
+```ruby
+# thermostat.rb
+thermostat = OBIX.parse file: "thermostat.xml"
+
+thermostat.href # => "http://domain/thermostat/"
+
+temperature = thermostat.objects.find { |obj| obj.name == "spaceTemp" }
+temperature.val # => 67.2
+```
+
+### Build an object
+
+```ruby
+# thermostat.rb
+object = OBIX::Builder.new
+  obj href: "http://domain/thermostat" do
+    real name: "spaceTemp", unit: "obix:units/fahrenheit" val: 67.2
+    real name: "setpoint", unit: "obix:units/fahrenheit" val: 72.0
+    bool name: "furnaceOn", val: true
+  end
+end
+```
+
+### Invoke an operation
+
+```xml
+<!-- furnace.xml -->
+<obj href="http://domain/furnace">
+  <bool name="active" val="false"/>
+  <op name="activate" href="http://domain/furnace/activate" in="obix:Nil" out="obix:Nil"/>
+  <op name="deactivate" href="http://domain/furnace/deactivate" in="obix:Nil" out="obix:Nil"/>
+</obj>
+```
+
+```ruby
+# furnace.rb
+furnace = OBIX.parse file: "furnace.xml"
+
+activate = furnace.objects.find { |obj| obj.name == "activate" }
+activate.invoke
+```
+
+### Create a watch
+
+```ruby
+# Create a new watch...
+watch = OBIX::Watch.make url: "http://domain/watchservice"
+
+# ... or connect to an existing watch
+watch = OBIX::Watch.connect url: "http://domain/watchservice/watch1"
+
+# Add objects to the watch
+watch.add ["/thermostat", "/furnace"]
+
+# Remove objects from the watch
+watch.remove ["/furnace"]
+
+# Poll everything
+watch.all
+
+# Poll changes
+watch.changes
+
+# Delete the watch
+watch.delete
+```
+
+### Query an object's history
+
+```ruby
+history = OBIX::History.new url: "http://domain/history"
+
+history.query start: 2.year.ago, end: 1.year.ago
+```
+
+### Query alarms
+
+```ruby
+alarms = OBIX::Alarms.new url: "http://domain/alarmservice"
+
+alarms.query start: 2.years.ago, end: 1.year.ago
+```
+
+## 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
+
+## Credits
+
+Hyper made this. We're a digital communications agency with a passion for good code,
+and if you're using this library we probably want to hire you.

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/*_test.rb']
+end

data/lib/obix.rb

@@ -0,0 +1,55 @@
+require "obix/version"
+require "nokogiri"
+require "net/http"
+require "obix/errors"
+
+module OBIX
+  autoload :Objects, "obix/objects"
+  autoload :Types, "obix/types"
+  autoload :Watch, "obix/watch"
+  autoload :Alarms, "obix/alarms"
+  autoload :History, "obix/history"
+  autoload :Tag, "obix/tag"
+  autoload :Builder, "obix/builder"
+  autoload :Configuration, "obix/configuration"
+  autoload :Network, "obix/network"
+
+  # Parse the given source as OBIX.
+  #
+  # source  - A Hash describing the source.
+  #           :string - A String describing oBIX data.
+  #           :file   - A String describing a file that contains oBIX data.
+  #           :url    - A String describing a URL that the oBIX data may be loaded from.
+  #
+  # Returns an OBIX::Object instance.
+  def self.parse source
+    string = source[:string]
+    url    = source[:url]
+    file   = source[:file]
+
+    if url
+      string = Network.get url
+    end
+
+    if file
+      string = File.read file
+    end
+
+    document = Nokogiri::XML.parse string do |config|
+      config.noblanks
+      config.strict
+    end
+
+    object = OBIX::Objects::Object.parse document.root
+
+    object
+  end
+
+  def self.configuration
+    Configuration
+  end
+
+  def self.configure &block
+    Configuration.configure &block
+  end
+end

data/lib/obix/alarms.rb

@@ -0,0 +1,48 @@
+module OBIX
+
+  class Alarms
+
+    # Initialize an alarm service.
+    #
+    # source - A Hash of options (see OBIX#parse for details).
+    def initialize source
+      @alarms = OBIX.parse source
+    end
+
+    # The number of alarms.
+    # 
+    # Returns an Integer.
+    def count
+      @alarms.objects.find { |o| o.name == "count" }.val
+    end
+
+    # Query alarms.
+    #
+    # options - A Hash of options:
+    #           :start - A DateTime instance describing the earliest time to query history for.
+    #           :end   - A DateTime instance describing the latest time to query history for.
+    def query options
+      from = options.fetch :start
+      to   = options.fetch :end
+
+      query = @alarms.objects.find { |o| o.name == "query" }
+
+      filter = OBIX::Builder.new do
+        obj do
+          abstime name: "start", val: from.iso8601
+          abstime name: "end", val: to.iso8601
+        end
+      end.object
+
+      alarms = query.invoke filter
+
+      alarms.objects.find { |o| o.name == "data" }
+    end
+
+    def to_s
+      @alarms.to_s
+    end
+
+  end
+
+end

data/lib/obix/builder.rb

@@ -0,0 +1,45 @@
+module OBIX
+
+  class Builder
+    attr_reader :objects
+
+    # Initialize a new builder.
+    #
+    # parent - An Objects::Object instance or derivative thereof describing the parent
+    #          of the object that will be built.
+    def initialize parent = nil, &block
+      @parent  = parent
+      @objects = []
+
+      instance_eval &block
+    end
+
+    def object
+      objects.first
+    end
+
+    # Respond to methods matching OBIX tags.
+    def method_missing method, attributes = {}, &block
+      klass = Objects.find method
+
+      object = klass.new &block
+
+      attributes.each do |key, value|
+        object.send "#{key}=", value
+      end
+
+      object.parent = @parent
+
+      if @parent
+        @objects.push object
+      else
+        if @objects.empty?
+          @objects.push object
+        else
+          raise ArgumentError, "Object already has a root"
+        end
+      end
+    end
+  end
+
+end

data/lib/obix/configuration.rb

@@ -0,0 +1,79 @@
+module OBIX
+
+  module Configuration
+
+    def self.configure &block
+      instance_eval &block
+    end
+
+    def self.definitions
+      @definitions ||= {}
+    end
+
+    def self.definitions= hash
+      @definitions = hash
+    end
+
+    # The username to use when communicating with the server.
+    #
+    # username - A String describing the username.
+    def self.username= username
+      definitions[:username] = username
+    end
+
+    # The username to use when communicating with the server.
+    def self.username
+      definitions[:username]
+    end
+
+    # The password to use when communicating with the server.
+    #
+    # password - A String describing the password.
+    def self.password= password
+      definitions[:password] = password
+    end
+
+    # The password to use when communicating with the server.
+    def self.password
+      definitions[:password]
+    end
+
+    # The scheme of the server.
+    #
+    # host - A String describing the host.
+    def self.scheme= scheme
+      definitions[:scheme] = scheme
+    end
+
+    # The scheme of the server.
+    def self.scheme
+      definitions[:scheme] || "http"
+    end
+
+    # The host of the server.
+    #
+    # host - A String describing the host.
+    def self.host= host
+      definitions[:host] = host
+    end
+
+    # The host of the server.
+    def self.host
+      definitions[:host]
+    end
+
+    # Timeout.
+    #
+    # seconds - An Integer describing timeout in seconds.
+    def self.timeout= seconds
+      definitions[:timeout] = seconds
+    end
+
+    # Timeout.
+    def self.timeout
+      definitions[:timeout] || 30
+    end
+
+  end
+
+end

data/lib/obix/errors.rb

@@ -0,0 +1,6 @@
+module OBIX
+  class Error < StandardError; end
+  class BadURIError < Error; end
+  class UnsupportedError < Error; end
+  class PermissionError < Error; end
+end

data/lib/obix/history.rb

@@ -0,0 +1,65 @@
+module OBIX
+
+  class History
+
+    # Initialize a history.
+    #
+    # source - A Hash of options (see OBIX#parse for details).
+    def initialize source
+      @history = OBIX.parse source
+    end
+
+    # The number of history records contained by the history.
+    # 
+    # Returns an Integer.
+    def count
+      @history.objects.find { |o| o.name == "count" }.val
+    end
+
+    # The timestamp of the oldest record contained by the history.
+    #
+    # Returns a DateTime instance.
+    def start
+      @history.objects.find { |o| o.name == "start" }.val
+    end
+
+    # The timestamp of the newest record contained by the history.
+    def end
+      @history.objects.find { |o| o.name == "end" }.val
+    end
+
+    # The timezone of the history data.
+    def timezone
+      @history.objects.find { |o| o.name == "tz" }.val
+    end
+
+    # Query the history records contained by the history.
+    #
+    # options - A Hash of options:
+    #           :start - A DateTime instance describing the earliest time to query history for.
+    #           :end   - A DateTime instance describing the latest time to query history for.
+    def query options
+      from = options.fetch :start
+      to   = options.fetch :end
+
+      query = @history.objects.find { |o| o.name == "query" }
+
+      filter = OBIX::Builder.new do
+        obj do
+          abstime name: "start", val: from.iso8601
+          abstime name: "end", val: to.iso8601
+        end
+      end.object
+
+      history = query.invoke filter
+
+      history.objects.find { |o| o.name == "data" }
+    end
+
+    def to_s
+      @history.to_s
+    end
+
+  end
+
+end