obix 0.0.1

data/lib/obix/network.rb

@@ -0,0 +1,76 @@
+require "net/http"
+
+module OBIX
+  module Network
+    include Net
+
+    extend self
+
+    # Make a get request.
+    #
+    # url    - A String describing where the request should be sent.
+    # object - A Objects::Object or derivative thereof describing the OBIX element to send.
+    def get url
+      url     = URI url
+      request = HTTP::Get.new url.path
+
+      dispatch request, to: url
+    end
+
+    # Make a post request.
+    #
+    # url    - A String describing where the request should be sent.
+    # object - A Objects::Object or derivative thereof describing the OBIX element to send.
+    def post url, object = nil
+      url     = URI url
+      request = HTTP::Post.new url.path
+
+      if object
+        request.body = object.to_xml
+      end
+
+      dispatch request, to: url
+    end
+
+    private
+
+    # Dispatch the given request.
+    #
+    # request - A derivative of Net::HTTPGenericRequest describing the request.
+    # options - A Hash with query options:
+    #           :to - An URI instance describing where the request should be sent.
+    #
+    # Returns a Net::HTTPResponse instance.
+    def dispatch request, options
+      url = options.fetch :to
+
+      if url.relative?
+        url = URI.join "#{OBIX.configuration.scheme}://#{OBIX.configuration.host}", url
+      end
+
+      options = {
+        use_ssl: true,
+        verify_mode: OpenSSL::SSL::VERIFY_NONE,
+        open_timeout: 10,
+        read_timeout: OBIX.configuration.timeout
+      }
+
+      response = HTTP.start url.host, url.port, options do |http|
+        request.basic_auth OBIX.configuration.username, OBIX.configuration.password
+        http.request request
+      end
+
+      unless response.code == "200"
+        raise Error, "The server responded with an unexpected status code #{response.code} for #{url}."
+      end
+
+      response.body
+    rescue ::Timeout::Error
+      raise Timeout, "The remote server did not respond in a timely fashion"
+    end
+
+    class Error < ::OBIX::Error; end
+
+    class Timeout < Error; end
+  end
+end

data/lib/obix/objects.rb

@@ -0,0 +1,46 @@
+module OBIX
+  module Objects
+    autoload :Base, "obix/objects/base"
+    autoload :Object, "obix/objects/object"
+    autoload :Float, "obix/objects/float"
+    autoload :Integer, "obix/objects/integer"
+    autoload :Boolean, "obix/objects/boolean"
+    autoload :String, "obix/objects/string"
+    autoload :Enumerable, "obix/objects/enumerable"
+    autoload :Time, "obix/objects/time"
+    autoload :Date, "obix/objects/date"
+    autoload :List, "obix/objects/list"
+    autoload :Operation, "obix/objects/operation"
+    autoload :Duration, "obix/objects/duration"
+    autoload :URI, "obix/objects/uri"
+    autoload :Reference, "obix/objects/reference"
+    autoload :Error, "obix/objects/error"
+    autoload :Feed, "obix/objects/feed"
+
+    @objects = [
+      Object, Float, Integer, Boolean, String, Enumerable, Time,
+      Date, List, Operation, Duration, URI, Reference, Error, Feed
+    ]
+
+    # List objects.
+    #
+    # Returns an array of OBIX::Objects::Object instances or derivatives thereof.
+    def self.list
+      @objects
+    end
+
+    # Find an object by the given tag.
+    #
+    # tag - A String or Symbol describing a tag.
+    #
+    # Returns a derivative of OBIX::Objects::Base.
+    def self.find tag
+      object = @objects.find do |object|
+        object.new.tag.to_s == tag.to_s
+      end or raise OBIX::Objects::UnknownObjectError, "Unknown element '#{tag}'"
+    end
+
+    class UnknownObjectError < StandardError; end
+  end
+end
+

data/lib/obix/objects/base.rb

@@ -0,0 +1,97 @@
+module OBIX
+  module Objects
+
+    class Base
+      extend Tag
+
+      attr_accessor :objects, :parent
+
+      def initialize &block
+        @attributes = {}
+        @objects    = []
+
+        if block_given?
+          builder = OBIX::Builder.new self, &block
+
+          @objects = builder.objects
+        end
+      end
+
+      # Find the object by the given name.
+      #
+      # name - A String or Symbol describing the "name" attribute of an object.
+      def find name
+        object = objects.find { |o| o.name == name.to_s }
+      end
+
+      # Serialize the object as a Nokogiri::XML::Node.
+      def to_node
+        Nokogiri::XML::Builder.new do |xml|
+          build xml
+        end.doc.root
+      end
+
+      # Serialize the object as an XML String.
+      def to_xml
+        to_node.document.to_xml
+      end
+
+      # Serialize the object as a human-readable String.
+      def to_s
+        attributes = @attributes.map do |key, value|
+          "#{key}: \"#{value}\""
+        end.join " "
+
+        "#<#{self.class} #{attributes}>"
+      end
+
+      class << self
+
+        # Parse an XML element as OBIX.
+        #
+        # element - A Nokogiri::XML::Node describing an element.
+        # parent  - An Objects::Object instance or derivative thereof describing
+        #           the object's parent.
+        #
+        # Returns an Object instance or derivative thereof.
+        def parse element, parent = nil
+          klass = Objects.find element.name
+
+          object = klass.new
+
+          element.attributes.each do |name, attribute|
+            object.send "#{name.underscore}=", attribute.value unless attribute.namespace
+          end
+
+          element.children.each do |child|
+            object.objects.push parse(child, object) unless child.is_a? Nokogiri::XML::Text
+          end
+
+          object.parent = parent
+
+          if object.is_a? Error
+            object.raise
+          end
+
+          object
+        end
+
+      end
+
+      protected
+
+      # Build the object as an element in a tree.
+      #
+      # xml - A Nokogiri::XML::Builder instance.
+      def build builder
+        builder.send tag, @attributes do |builder|
+          objects.each do |object|
+            object.build builder
+          end
+        end
+      end
+
+    end
+
+  end
+end

data/lib/obix/objects/boolean.rb

@@ -0,0 +1,13 @@
+module OBIX
+  module Objects
+
+    # Booleans represent a boolean condition of either true or false.
+    class Boolean < Object
+      tag :bool
+
+      attribute :val, type: Types::Boolean, default: false
+      attribute :range, type: Types::URI
+    end
+
+  end
+end

data/lib/obix/objects/date.rb

@@ -0,0 +1,15 @@
+module OBIX
+  module Objects
+
+    # Dates represent a day in time.
+    class Date < Object
+      tag :date
+
+      attribute :val, type: Types::Date, default: nil
+      attribute :min, type: Types::Date
+      attribute :max, type: Types::Date
+      attribute :tz, type: Types::String
+    end
+
+  end
+end

data/lib/obix/objects/duration.rb

@@ -0,0 +1,14 @@
+module OBIX
+  module Objects
+
+    # Durations represent a relative duration of time.
+    class Duration < Object
+      tag :reltime
+
+      attribute :val, type: Types::Duration, default: 0
+      attribute :min, type: Types::Duration
+      attribute :max, type: Types::Duration
+    end
+
+  end
+end

data/lib/obix/objects/enumerable.rb

@@ -0,0 +1,13 @@
+module OBIX
+  module Objects
+
+    # Enumerables represent a value which must match a finite set of values.
+    class Enumerable < Object
+      tag :enum
+
+      attribute :val, type: Types::String, default: nil
+      attribute :range, type: Types::String
+    end
+
+  end
+end

data/lib/obix/objects/error.rb

@@ -0,0 +1,26 @@
+module OBIX
+  module Objects
+
+    # Errors represent errors.
+    class Error < Object
+      tag :err
+
+      # Raise an exception with this error.
+      def raise
+        klass = case is
+        when "obix:BadUriErr"
+          OBIX::BadURIError
+        when "obix:UnsupportedErr"
+          OBIX::UnsupportedError
+        when "obix:PermissionErr"
+          OBIX::PermissionError
+        else
+          OBIX::Error
+        end
+
+        super klass, self.to_xml
+      end
+    end
+
+  end
+end

data/lib/obix/objects/feed.rb

@@ -0,0 +1,14 @@
+module OBIX
+  module Objects
+
+    # Lists represent a collection of other objects.
+    class Feed < Object
+      tag :feed
+
+      attribute :in, type: Types::String
+      attribute :of, type: Types::String
+    end
+
+  end
+end
+

data/lib/obix/objects/float.rb

@@ -0,0 +1,16 @@
+module OBIX
+  module Objects
+
+    # Floats represent floating point numbers.
+    class Float < Object
+      tag :real
+
+      attribute :val, type: Types::Float, default: 0.0
+      attribute :min, type: Types::Float
+      attribute :max, type: Types::Float
+      attribute :unit, type: Types::String
+      attribute :precision, type: Types::Integer
+    end
+
+  end
+end

data/lib/obix/objects/integer.rb

@@ -0,0 +1,15 @@
+module OBIX
+  module Objects
+
+    # Integers represent an integer number.
+    class Integer < Object
+      tag :int
+
+      attribute :val, type: Types::Integer, default: 0
+      attribute :min, type: Types::Integer
+      attribute :max, type: Types::Integer
+      attribute :unit, type: Types::String
+    end
+
+  end
+end

data/lib/obix/objects/list.rb

@@ -0,0 +1,14 @@
+module OBIX
+  module Objects
+
+    # Lists represent a collection of other objects.
+    class List < Object
+      tag :list
+
+      attribute :of, type: Types::String
+      attribute :min, type: Types::Integer
+      attribute :max, type: Types::Integer
+    end
+
+  end
+end

data/lib/obix/objects/object.rb

@@ -0,0 +1,20 @@
+module OBIX
+  module Objects
+
+    # Objects are the root abstraction in oBIX.
+    class Object < Base
+      tag :obj
+
+      attribute :name, type: Types::String
+      attribute :href, type: Types::URI, default: ""
+      attribute :is, type: Types::String
+      attribute :null, type: Types::Boolean
+      attribute :icon, type: Types::String
+      attribute :display_name, type: Types::String
+      attribute :display, type: Types::String
+      attribute :writable, type: Types::Boolean
+      attribute :status, type: Types::String
+    end
+
+  end
+end

data/lib/obix/objects/operation.rb

@@ -0,0 +1,28 @@
+require "net/http"
+
+module OBIX
+  module Objects
+
+    # Operations represent operations.
+    class Operation < Object
+      tag :op
+
+      attribute :in, type: Types::String
+      attribute :out, type: Types::String
+
+      # Invoke the operation.
+      #
+      # object - An OBIX::Objects::Object or derivative thereof. Defaults to an object
+      #          that implements the "obix:Nil" contract.
+      #
+      # Returns an OBIX::Objects::Object or derivative thereof describing
+      # the result of the operation.
+      def invoke object = OBIX::Objects::Object.new
+        string = Network.post href, object
+
+        OBIX.parse string: string
+      end
+    end
+
+  end
+end

data/lib/obix/objects/reference.rb

@@ -0,0 +1,10 @@
+module OBIX
+  module Objects
+
+    # References represent references to another oBIX document.
+    class Reference < Object
+      tag :ref
+    end
+
+  end
+end

data/lib/obix/objects/string.rb

@@ -0,0 +1,14 @@
+module OBIX
+  module Objects
+
+    # Strings represent strings of characters.
+    class String < Object
+      tag :str
+
+      attribute :val, type: Types::String, default: ""
+      attribute :min, type: Types::Integer
+      attribute :max, type: Types::Integer
+    end
+
+  end
+end