directed-edge 0.1.1 → 0.1.2

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/directed-edge.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{directed-edge}
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Directed Edge"]
-  s.date = %q{2010-03-29}
+  s.date = %q{2010-04-06}
   s.description = %q{Bindings for the Directed Edge webservices API}
   s.email = %q{info@directededge.com}
   s.extra_rdoc_files = [

data/lib/directed_edge.rb

@@ -26,40 +26,6 @@ require 'rest_client'
 require 'rexml/document'
 require 'cgi'
 
-class Hash
-
-  # An extension to normalize tokens and strings of the form foo_bar to strings
-  # of fooBar as expected by the REST API.
-
-  def normalize!
-    each do |key, value|
-      if !key.is_a?(String)
-        delete(key)
-        key = key.to_s
-        store(key, value.to_s)
-      end
-      if key.match(/_\w/)
-        delete(key)
-        store(key.gsub(/_\w/) { |s| s[1, 1].upcase }, value.to_s)
-      elsif !value.is_a?(String)
-        store(key, value.to_s)
-      end
-    end
-    self
-  end
-
-  def []=(key, value)
-    store(key, value)
-    @insert_order = [] if @insert_order.nil?
-    @insert_order.delete(key) if @insert_order.include?(key)
-    @insert_order.push(key)
-  end
-
-  def insert_order_each
-    @insert_order.each { |key| yield key, fetch(key) } unless @insert_order.nil?
-  end
-end
-
 # The DirectedEdge module contains three classes:
 #
 # - Database - encapsulation of connection a database hosted by Directed Edge.
@@ -68,11 +34,34 @@ end
 
 module DirectedEdge
 
+  # A hash subclass that tracks the insert order, which is useful when returning
+  # a set of results that include full properties.
+
+  class InsertOrderHash < Hash
+
+    # Overridden assignment to track insert order
+
+    def []=(key, value)
+      store(key, value)
+      @insert_order = [] if @insert_order.nil?
+      @insert_order.delete(key) if @insert_order.include?(key)
+      @insert_order.push(key)
+    end
+
+    # Provides an iterator that uses the hash's insert order
+
+    def insert_order_each
+      @insert_order.each { |key| yield key, fetch(key) } unless @insert_order.nil?
+    end
+  end
+
   # Base class used for Database and Item that has some basic resource
   # grabbing functionality.
 
   class Resource
 
+    private
+
     # Reads an item from the database and puts it into an XML document.
 
     def read_document(method='', params={})
@@ -95,7 +84,7 @@ module DirectedEdge
     # 'item1' => { 'foo' => 'bar' }
 
     def property_hash_from_document(document, element)
-      values = {}
+      values = InsertOrderHash.new
       document.elements.each("//#{element}") do |e|
         values[e.text] = {}
         e.attributes.each_attribute { |a| values[e.text][a.name] = a.value }
@@ -122,6 +111,27 @@ module DirectedEdge
       end
       values
     end
+
+    # Normalizes the parameters in an argument hash to a standard form
+    # so that they can be passed off to the web services API -- e.g.
+    # :foo_bar to 'fooBar'
+
+    def normalize_params(hash)
+      hash.each do |key, value|
+        if !key.is_a?(String)
+          hash.delete(key)
+          key = key.to_s
+          hash.store(key, value.to_s)
+        end
+        if key.match(/_\w/)
+          hash.delete(key)
+          hash.store(key.gsub(/_\w/) { |s| s[1, 1].upcase }, value.to_s)
+        elsif !value.is_a?(String)
+          hash.store(key, value.to_s)
+        end
+      end
+      hash
+    end
   end
 
   # A Database is an encapsulation of a database being accessed via the Directed
@@ -175,12 +185,12 @@ module DirectedEdge
 
     def group_related(items=Set.new, tags=Set.new, params={})
       if !items.is_a?(Array) || items.size < 1
-        return (params['includeProperties'] == 'true') ? {} : []
+        return (params['includeProperties'] == 'true') ? InsertOrderHash.new : []
       end
       params['items'] = items.to_a.join(',')
       params['tags'] = tags.to_a.join(',')
       params['union'] = true
-      params.normalize!
+      params = normalize_params(params)
       if params['includeProperties'] == 'true'
         property_hash_from_document(read_document('related', params), 'related')
       else
@@ -538,7 +548,7 @@ module DirectedEdge
     # This will not reflect any unsaved changes to items.
 
     def related(tags=Set.new, params={})
-      params.normalize!
+      params = normalize_params(params)
       params['tags'] = tags.to_a.join(',')
       if params['includeProperties'] == 'true'
         property_hash_from_document(read_document('related', params), 'related')
@@ -559,7 +569,7 @@ module DirectedEdge
     # This will not reflect any unsaved changes to items.
 
     def recommended(tags=Set.new, params={})
-      params.normalize!
+      params = normalize_params(params)
       params['tags'] = tags.to_a.join(',')
       params.key?('excludeLinked') || params['excludeLinked'] = 'true'
       if params['includeProperties'] == 'true'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: directed-edge
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Directed Edge
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-29 00:00:00 +02:00
+date: 2010-04-06 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency