medea 0.2.3 → 0.2.4

data/Rakefile

@@ -1,20 +1,21 @@
-require 'rake'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |s|
-    s.name = "medea"
-    s.summary = "Simple wrapper for persisting objects to JasonDB"
-    s.email = "michaelj@jasondb.com"
-    s.homepage = "https://github.com/rob-linton/Medea"
-    s.description = "Simple wrapper for persisting objects to JasonDB"
-    s.authors = ["Michael Jensen"]
-    s.files = FileList["[A-Z]*", "{lib}/medea.rb", "{lib}/medea/*"]
-    s.files.exclude '{lib}/test*'
-    s.add_dependency 'json'
-    s.add_dependency 'rest-client'
-  end
-rescue LoadError
-  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
-end
-
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "medea"
+    s.summary = "Simple wrapper for persisting objects to JasonDB"
+    s.email = "michaelj@jasondb.com"
+    s.homepage = "https://github.com/rob-linton/Medea"
+    s.description = "Simple wrapper for persisting objects to JasonDB"
+    s.authors = ["Michael Jensen"]
+    s.files = FileList["[A-Z]*", "{lib}/medea.rb", "{lib}/medea/*"]
+    s.files.exclude '{lib}/test*'
+    s.add_dependency 'json'
+    s.add_dependency 'rest-client'
+    s.add_dependency 'uuidtools'
+  end
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+

data/VERSION

@@ -1 +1 @@
-0.2.3
+0.2.4

data/lib/medea.rb

@@ -1,8 +1,8 @@
-
-module Medea
-  require 'medea/inheritable_attributes'
-  require 'medea/jasonobject'
-  require 'medea/jasondeferredquery'
-  require 'medea/jasonlistproperty'
-  require 'medea/jasondb'
+
+module Medea
+  require 'medea/inheritable_attributes'
+  require 'medea/jasonobject'
+  require 'medea/jasondeferredquery'
+  require 'medea/jasonlistproperty'
+  require 'medea/jasondb'
 end

data/lib/medea/inheritable_attributes.rb

@@ -1,31 +1,31 @@
-#This module allows for an attribute to be defined on a superclass and carry down into sub-classes with its default.
-#Taken from http://railstips.org/blog/archives/2006/11/18/class-and-instance-variables-in-ruby/
-
-module ClassLevelInheritableAttributes
-  def self.included(base)
-    base.extend(ClassMethods)    
-  end
-  
-  module ClassMethods
-    def inheritable_attributes(*args)
-      #for some reason, in rails, @inheritable_attributes is set to be an empty hash here...
-      #check for this strange case and account for it.
-      @inheritable_attributes = [:inheritable_attributes] if @inheritable_attributes == {} ||
-                                                             @inheritable_attributes == nil
-      @inheritable_attributes += args
-      args.each do |arg|
-        class_eval %(
-          class << self; attr_accessor :#{arg} end
-        )
-      end
-      @inheritable_attributes
-    end
-    
-    def inherited(subclass)
-      @inheritable_attributes.each do |inheritable_attribute|
-        instance_var = "@#{inheritable_attribute}"
-        subclass.instance_variable_set(instance_var, instance_variable_get(instance_var))
-      end
-    end
-  end
+#This module allows for an attribute to be defined on a superclass and carry down into sub-classes with its default.
+#Taken from http://railstips.org/blog/archives/2006/11/18/class-and-instance-variables-in-ruby/
+
+module ClassLevelInheritableAttributes
+  def self.included(base)
+    base.extend(ClassMethods)    
+  end
+  
+  module ClassMethods
+    def inheritable_attributes(*args)
+      #for some reason, in rails, @inheritable_attributes is set to be an empty hash here...
+      #check for this strange case and account for it.
+      @inheritable_attributes = [:inheritable_attributes] if @inheritable_attributes == {} ||
+                                                             @inheritable_attributes == nil
+      @inheritable_attributes += args
+      args.each do |arg|
+        class_eval %(
+          class << self; attr_accessor :#{arg} end
+        )
+      end
+      @inheritable_attributes
+    end
+    
+    def inherited(subclass)
+      @inheritable_attributes.each do |inheritable_attribute|
+        instance_var = "@#{inheritable_attribute}"
+        subclass.instance_variable_set(instance_var, instance_variable_get(instance_var))
+      end
+    end
+  end
 end

data/lib/medea/jasondb.rb

@@ -1,20 +1,20 @@
-module JasonDB
-    #jason_url here doesn't include the http[s]:// part, but does include the domain and a trailing '/'
-    #( so it's "rest.jasondb.com/<domain>/" )
-
-    def JasonDB::db_auth_url mode=:secure
-      config = Rails.configuration.database_configuration[Rails.env]
-      user = config["user"]
-      topic = config["topic"]
-      password = config["password"]
-      if config["jason_host"]
-        host = config["jason_host"]
-      else
-        host = "rest.jasondb.com"
-      end
-      protocol = "http"
-      protocol << "s" if mode == :secure
-      "#{protocol}://#{user}:#{password}@#{host}/#{topic}/"
-    end
-
-end
+module JasonDB
+    #jason_url here doesn't include the http[s]:// part, but does include the domain and a trailing '/'
+    #( so it's "rest.jasondb.com/<domain>/" )
+
+    def JasonDB::db_auth_url mode=:secure
+      config = Rails.configuration.database_configuration[Rails.env]
+      user = config["user"]
+      topic = config["topic"]
+      password = config["password"]
+      if config["jason_host"]
+        host = config["jason_host"]
+      else
+        host = "rest.jasondb.com"
+      end
+      protocol = "http"
+      protocol << "s" if mode == :secure
+      "#{protocol}://#{user}:#{password}@#{host}/#{topic}/"
+    end
+
+end

data/lib/medea/jasondeferredquery.rb

@@ -1,125 +1,125 @@
-module Medea
-  class JasonDeferredQuery
-    require 'rest_client'
-
-    attr_accessor :time_limit, :result_format, :type, :result_format, :time_limit, :state, :contents, :filters
-
-    def initialize a_class, format=:json
-      @type = a_class
-      @filters = {:FILTER => {:HTTP_X_CLASS => a_class.name.to_s}}
-      @result_format = format
-      @time_limit = 0
-      @state = :prefetch
-      @contents = []
-    end
-
-    #Here we're going to put the "query" interface
-
-    #here we will capture:
-    #members_of(object) (where object is an instance of a class that this class can be a member of)
-    #members_of_<classname>(key)
-    #find_by_<property>(value)
-    #Will return a JasonDeferredQuery for this class with the appropriate data filter set
-    def method_missing(name, *args, &block)
-      #if we are postfetch, we throw away all our cached results
-      if self.state == :postfetch
-        self.state = :prefetch
-        self.contents = []
-      end
-
-      if name =~ /^members_of$/
-        #use the type and key of the first arg (being a JasonObject)
-        #args[0] must be a JasonObject (or child)
-        raise ArgumentError, "When looking for members, you must pass a JasonObject" unless args[0].is_a? JasonObject
-
-        self.filters[:DATA_FILTER] ||= {}
-        self.filters[:DATA_FILTER]["__member_of"] ||= []
-        self.filters[:DATA_FILTER]["__member_of"] << args[0].jason_key
-      elsif name =~ /^find_by_(.*)$/
-        #use the property name from the name variable, and the value from the first arg
-        add_data_filter $1, args[0].to_s
-      else
-        #no method!
-        super
-        return
-      end
-      #return self, so that we can chain up query refinements
-      self
-    end
-    #end query interface
-
-    def add_data_filter property, value
-      self.filters[:DATA_FILTER] ||= {}
-      self.filters[:DATA_FILTER][property] = value
-    end
-
-    def to_url
-      url = "#{JasonDB::db_auth_url}@#{self.time_limit}.#{self.result_format}?"
-      filter_array = []
-      self.filters.each do |name, val|
-        if not val
-          filter_array << name.to_s
-          next
-        else
-          #FILTER's value is a hash (to avoid dupes)
-          #DATA_FILTER's value is a hash
-          if val.is_a? Hash
-            #for each k/v in the hash, we want to add an entry to filter_array
-            val.each do |field ,value|
-              if value.is_a? Array
-                value.each do |i|
-                  filter_array << "#{name.to_s}=#{field}:#{i}"
-                end
-              else
-                filter_array << "#{name.to_s}=#{field.to_s}:#{value.to_s}"
-              end
-            end
-          end
-        end
-      end
-
-      url + filter_array.join("&")
-    end
-
-    #array access interface
-    def [](index)
-      execute_query unless self.state == :postfetch
-      self.contents[index]
-    end
-
-    def each(&block)
-      execute_query unless self.state == :postfetch
-      self.contents.each &block
-    end
-
-    def count
-      execute_query unless self.state == :postfetch
-      self.contents.count
-    end
-    #end array interface
-
-    def execute_query
-      #hit the URL
-      #fill self.contents with :ghost versions of JasonObjects
-      begin
-        #puts "   = Executing #{type.name} deferred query! (#{to_url})"
-        result = JSON.parse(RestClient.get to_url)
-
-        #results are in a hash, their keys are just numbers
-        result.keys.each do |k|
-          if k =~ /^[0-9]+$/
-            #this is a result! get the key
-            /\/([^\/]*)\/([^\/]*)$/.match result[k]["POST_TO"]
-            #$1 is the class name, $2 is the key
-            item = type.new($2, :lazy)
-            self.contents << item
-          end
-        end
-      rescue
-        self.contents = []
-      ensure
-        self.state = :postfetch
-      end
-    end
-  end
+module Medea
+  class JasonDeferredQuery
+    require 'rest_client'
+
+    attr_accessor :time_limit, :result_format, :type, :result_format, :time_limit, :state, :contents, :filters
+
+    def initialize a_class, format=:json
+      @type = a_class
+      @filters = {:FILTER => {:HTTP_X_CLASS => a_class.name.to_s}}
+      @result_format = format
+      @time_limit = 0
+      @state = :prefetch
+      @contents = []
+    end
+
+    #Here we're going to put the "query" interface
+
+    #here we will capture:
+    #members_of(object) (where object is an instance of a class that this class can be a member of)
+    #members_of_<classname>(key)
+    #find_by_<property>(value)
+    #Will return a JasonDeferredQuery for this class with the appropriate data filter set
+    def method_missing(name, *args, &block)
+      #if we are postfetch, we throw away all our cached results
+      if self.state == :postfetch
+        self.state = :prefetch
+        self.contents = []
+      end
+
+      if name =~ /^members_of$/
+        #use the type and key of the first arg (being a JasonObject)
+        #args[0] must be a JasonObject (or child)
+        raise ArgumentError, "When looking for members, you must pass a JasonObject" unless args[0].is_a? JasonObject
+
+        self.filters[:DATA_FILTER] ||= {}
+        self.filters[:DATA_FILTER]["__member_of"] ||= []
+        self.filters[:DATA_FILTER]["__member_of"] << args[0].jason_key
+      elsif name =~ /^find_by_(.*)$/
+        #use the property name from the name variable, and the value from the first arg
+        add_data_filter $1, args[0].to_s
+      else
+        #no method!
+        super
+        return
+      end
+      #return self, so that we can chain up query refinements
+      self
+    end
+    #end query interface
+
+    def add_data_filter property, value
+      self.filters[:DATA_FILTER] ||= {}
+      self.filters[:DATA_FILTER][property] = value
+    end
+
+    def to_url
+      url = "#{JasonDB::db_auth_url}@#{self.time_limit}.#{self.result_format}?"
+      filter_array = []
+      self.filters.each do |name, val|
+        if not val
+          filter_array << name.to_s
+          next
+        else
+          #FILTER's value is a hash (to avoid dupes)
+          #DATA_FILTER's value is a hash
+          if val.is_a? Hash
+            #for each k/v in the hash, we want to add an entry to filter_array
+            val.each do |field ,value|
+              if value.is_a? Array
+                value.each do |i|
+                  filter_array << "#{name.to_s}=#{field}:#{i}"
+                end
+              else
+                filter_array << "#{name.to_s}=#{field.to_s}:#{value.to_s}"
+              end
+            end
+          end
+        end
+      end
+
+      url + filter_array.join("&")
+    end
+
+    #array access interface
+    def [](index)
+      execute_query unless self.state == :postfetch
+      self.contents[index]
+    end
+
+    def each(&block)
+      execute_query unless self.state == :postfetch
+      self.contents.each &block
+    end
+
+    def count
+      execute_query unless self.state == :postfetch
+      self.contents.count
+    end
+    #end array interface
+
+    def execute_query
+      #hit the URL
+      #fill self.contents with :ghost versions of JasonObjects
+      begin
+        #puts "   = Executing #{type.name} deferred query! (#{to_url})"
+        result = JSON.parse(RestClient.get to_url)
+
+        #results are in a hash, their keys are just numbers
+        result.keys.each do |k|
+          if k =~ /^[0-9]+$/
+            #this is a result! get the key
+            /\/([^\/]*)\/([^\/]*)$/.match result[k]["POST_TO"]
+            #$1 is the class name, $2 is the key
+            item = type.new($2, :lazy)
+            self.contents << item
+          end
+        end
+      rescue
+        self.contents = []
+      ensure
+        self.state = :postfetch
+      end
+    end
+  end
 end

data/lib/medea/jasonlistproperty.rb

@@ -1,102 +1,102 @@
-module Medea
-  require 'uri'
-  require 'rest_client'
-  class JasonListProperty < JasonDeferredQuery
-
-    attr_accessor :list_name, :parent, :list_type
-
-    def initialize parent, list_name, list_class, list_type
-      @type = list_class
-      @list_name = list_name
-      @list_type = list_type
-      @parent = parent
-      @result_format = :json
-      @time_limit = 0
-      @state = :prefetch
-      @contents = []
-    end
-
-    def method_missing name, *args, &block
-      #is this a list property on the base class?
-      if (@type.class_variable_defined? :@@lists) && (@type.class_variable_get(:@@lists).has_key? name)
-        #if so, we'll just return a new ListProperty with my query as the parent
-        new_list_class, new_list_type = @type.class_variable_get(:@@lists)[name]
-        base_query = self.clone
-        base_query.result_format = :keylist
-        JasonListProperty.new base_query, name.to_sym, new_list_class, new_list_type
-      else
-        #no method, let JasonDeferredQuery handle it
-        super
-      end
-    end
-
-    def add! member, save=true
-      raise RuntimeError, "You can only add an item if you are accessing this list from an object." unless @parent.is_a? JasonObject
-      raise ArgumentError, "You can only add #{@type.name} items to this collection!" unless member.is_a? @type
-      
-      if @list_type == :value
-        member.jason_parent = @parent
-        member.jason_parent_list = @list_name
-      elsif @list_type == :reference
-
-        #post to JasonDB::db_auth_url/a_class.name/
-        url = "#{JasonDB::db_auth_url}#{@type.name}/#{@parent.jason_key}/#{@list_name}/#{member.jason_key}"
-        post_headers = {
-              :content_type => 'application/json',
-              "X-CLASS" => @type.name,
-              "X-KEY" => member.jason_key,
-              "X-PARENT" => @parent.jason_key,
-              "X-LIST" => @list_name.to_s
-        }
-        content = {
-            "_id" => member.jason_key,
-            "_parent" => @parent.jason_key
-        }
-        #puts "   = " + url
-        #puts "   = #{post_headers}"
-        response = RestClient.post url, content.to_json, post_headers
-
-        if response.code == 201
-            #save successful!
-            #store the new eTag for this object
-            #puts response.raw_headers
-            #@__jason_etag = response.headers[:location] + ":" + response.headers[:content_md5]
-        else
-            raise "POST failed! Could not save membership"
-        end
-      else
-        #parent is a JasonObject, but this list is something other than :value or :reference??
-        raise "Invalid list type or trying to add an item to a subquery list!"
-      end
-
-      if member.jason_state == :new
-        #we want to save it? probably...
-        member.save! if save
-      end
-
-      @state = :prefetch
-    end
-
-    def to_url
-      url = "#{JasonDB::db_auth_url}@#{@time_limit}.#{@result_format}?"
-      params = ["VERSION0"]
-
-      params << "FILTER=HTTP_X_CLASS:#{@type.name}"
-
-      if @parent.is_a? JasonObject
-        params << "FILTER=HTTP_X_PARENT:#{@parent.jason_key}"
-      else # @parent.is_a? JasonListProperty ##(or DeferredQuery?)
-        #we can get the insecure url here, because it will be resolved and executed at JasonDB - on a secure subnet.
-
-        #subquery = "<%@LANGUAGE=\"URL\" #{@parent.to_url}%>"
-        #puts "   = Fetching subquery stupidly. (#{@parent.to_url})"
-
-        subquery = (RestClient.get @parent.to_url).strip
-        #puts "   =   Result: #{subquery}"
-        params << URI.escape("FILTER={HTTP_X_PARENT:#{subquery}}", Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
-      end
-
-      url << params.join("&")
-    end
-  end
+module Medea
+  require 'uri'
+  require 'rest_client'
+  class JasonListProperty < JasonDeferredQuery
+
+    attr_accessor :list_name, :parent, :list_type
+
+    def initialize parent, list_name, list_class, list_type
+      @type = list_class
+      @list_name = list_name
+      @list_type = list_type
+      @parent = parent
+      @result_format = :json
+      @time_limit = 0
+      @state = :prefetch
+      @contents = []
+    end
+
+    def method_missing name, *args, &block
+      #is this a list property on the base class?
+      if (@type.class_variable_defined? :@@lists) && (@type.class_variable_get(:@@lists).has_key? name)
+        #if so, we'll just return a new ListProperty with my query as the parent
+        new_list_class, new_list_type = @type.class_variable_get(:@@lists)[name]
+        base_query = self.clone
+        base_query.result_format = :keylist
+        JasonListProperty.new base_query, name.to_sym, new_list_class, new_list_type
+      else
+        #no method, let JasonDeferredQuery handle it
+        super
+      end
+    end
+
+    def add! member, save=true
+      raise RuntimeError, "You can only add an item if you are accessing this list from an object." unless @parent.is_a? JasonObject
+      raise ArgumentError, "You can only add #{@type.name} items to this collection!" unless member.is_a? @type
+      
+      if @list_type == :value
+        member.jason_parent = @parent
+        member.jason_parent_list = @list_name
+      elsif @list_type == :reference
+
+        #post to JasonDB::db_auth_url/a_class.name/
+        url = "#{JasonDB::db_auth_url}#{@type.name}/#{@parent.jason_key}/#{@list_name}/#{member.jason_key}"
+        post_headers = {
+              :content_type => 'application/json',
+              "X-CLASS" => @type.name,
+              "X-KEY" => member.jason_key,
+              "X-PARENT" => @parent.jason_key,
+              "X-LIST" => @list_name.to_s
+        }
+        content = {
+            "_id" => member.jason_key,
+            "_parent" => @parent.jason_key
+        }
+        #puts "   = " + url
+        #puts "   = #{post_headers}"
+        response = RestClient.post url, content.to_json, post_headers
+
+        if response.code == 201
+            #save successful!
+            #store the new eTag for this object
+            #puts response.raw_headers
+            #@__jason_etag = response.headers[:location] + ":" + response.headers[:content_md5]
+        else
+            raise "POST failed! Could not save membership"
+        end
+      else
+        #parent is a JasonObject, but this list is something other than :value or :reference??
+        raise "Invalid list type or trying to add an item to a subquery list!"
+      end
+
+      if member.jason_state == :new
+        #we want to save it? probably...
+        member.save! if save
+      end
+
+      @state = :prefetch
+    end
+
+    def to_url
+      url = "#{JasonDB::db_auth_url}@#{@time_limit}.#{@result_format}?"
+      params = ["VERSION0"]
+
+      params << "FILTER=HTTP_X_CLASS:#{@type.name}"
+
+      if @parent.is_a? JasonObject
+        params << "FILTER=HTTP_X_PARENT:#{@parent.jason_key}"
+      else # @parent.is_a? JasonListProperty ##(or DeferredQuery?)
+        #we can get the insecure url here, because it will be resolved and executed at JasonDB - on a secure subnet.
+
+        #subquery = "<%@LANGUAGE=\"URL\" #{@parent.to_url}%>"
+        #puts "   = Fetching subquery stupidly. (#{@parent.to_url})"
+
+        subquery = (RestClient.get @parent.to_url).strip
+        #puts "   =   Result: #{subquery}"
+        params << URI.escape("FILTER={HTTP_X_PARENT:#{subquery}}", Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+      end
+
+      url << params.join("&")
+    end
+  end
 end