simplemapper 0.0.6 → 0.1.2

data/Rakefile

@@ -6,7 +6,7 @@ require 'rake/gempackagetask'
 require 'rake/contrib/rubyforgepublisher'
 
 PKG_NAME = 'simplemapper'
-PKG_VERSION = "0.0.6"
+PKG_VERSION = "0.1.2"
 
 PKG_FILES = FileList[
     "lib/**/*", "rspec/**/*", "[A-Z]*", "Rakefile", "doc/**/*"
@@ -57,6 +57,8 @@ spec = Gem::Specification.new do |s|
   s.email = "gems@behindlogic.com"
   s.homepage = "http://simplemapper.rubyforge.org"
   s.rubyforge_project = 'simplemapper'
+  s.add_dependency 'hash_magic'
+  s.add_dependency 'formattedstring'
 end
 
 Rake::GemPackageTask.new(spec) do |pkg|

data/lib/simple_mapper/adapters/http_adapter.rb

@@ -35,30 +35,41 @@ module SimpleMapper
       raise TypeError, "options must be a hash!" unless options.is_a?(Hash)
       @finder_options = options
     end
+    alias :set_finder_options :finder_options=
+    def display_options
+      @display_options ||= {}
+    end
+    def display_options=(options)
+      raise TypeError, "options must be a hash!" unless options.is_a?(Hash)
+      @display_options = options
+    end
+    alias :set_display_options :display_options=
 
-    def get(find_options={})
-      options = finder_options.merge(find_options)
-      query = options.empty? ? '' : ('?' + options.to_query)
+    def get(options={})
+      raw_get(base_uri.path + query_string_from_options(finder_options.merge(display_options.merge(options))))
+    end
+
+    def raw_get(url)
       begin
-        http.request(request('get', base_uri.path + query)).body
+        http.request(request('get', url)).body
       rescue => e
         raise e if !!raise_http_errors
         nil
       end
     end
 
-    def put(identifier,data)
+    def put(identifier,data,options={})
       begin
-        http.request(request('put', URI.parse(identifier).path, data)).body
+        http.request(request('put', URI.parse(identifier).path + query_string_from_options(display_options.merge(options)), data)).body
       rescue => e
         raise e if !!raise_http_errors
         nil
       end
     end
 
-    def post(data)
+    def post(data,options={})
       begin
-        http.request(request('post', base_uri.path, data)).body
+        http.request(request('post', base_uri.path + query_string_from_options(display_options.merge(options)), data)).body
       rescue => e
         raise e if !!raise_http_errors
         nil
@@ -66,9 +77,9 @@ module SimpleMapper
     end
 
     # In the http adapter, the identifier is a url.
-    def delete(identifier)
+    def delete(identifier,options={})
       begin
-        http.request(request('delete', URI.parse(identifier).path)).body
+        http.request(request('delete', URI.parse(identifier).path + query_string_from_options(options))).body
       rescue => e
         raise e if !!raise_http_errors
         nil
@@ -76,6 +87,10 @@ module SimpleMapper
     end
 
     private
+      def query_string_from_options(options={})
+        options.empty? ? '' : ('?' + options.to_query)
+      end
+
       def http(refresh=false)
         @http = Net::HTTP.new(base_uri.host, base_uri.port) if @http.nil? || refresh
         @http

data/lib/simple_mapper/default_plugins/callbacks.rb

@@ -8,7 +8,7 @@ module SimpleMapper
     end
     def run_callback(name, *args)
       args = args.first if args.length == 1
-      callbacks[name].inject(args) {|args,cb| cb.call(*args)}
+      callbacks[name].inject(args) {|args,cb| cb.call(*args) || args}
     end
   end
   class HttpAdapter

data/lib/simple_mapper/default_plugins/oauth.rb

@@ -1,4 +1,4 @@
-gem 'oauth'
+require 'rubygems'
 require 'oauth'
 require 'oauth/consumer'
 require 'oauth/client/net_http'
@@ -106,9 +106,8 @@ class OAuthController
 
   def initialize(controller, model, consumer_key, consumer_secret, options={})
     @controller = controller
-    @model = model
     @options = DEFAULT_OPTIONS.merge(options)
-    @model = @options.delete(:model)
+    @model = @options.delete(:model) || model
     @consumer = OAuth::Consumer.new(consumer_key, consumer_secret, options)
   end
 
@@ -130,6 +129,8 @@ class OAuthController
     elsif request_token
       return @controller.begin_pathway(@options[:authorization_method].in_context(controller).call(@model)) if @options[:authorization_method].is_a?(Proc)
       return true if access_token # For scriptables
+    else
+      raise RuntimeError, "It seems there is a problem between your OAuth client and the OAuth provider you are contacting. Inspect the naming of the token and token secret parameters being sent by the website."
     end
   end
 

data/lib/simple_mapper/default_plugins/options_to_query.rb

@@ -1,3 +1,4 @@
+require 'cgi'
 # This simply defines some extensions to various objects to enable smartly converting values to a
 # standard query string understandable by Rails and Merb.
 # First the structural base:

data/lib/simple_mapper/formats/json_format.rb

@@ -19,6 +19,10 @@ module SimpleMapper
       json
     end
 
+    def meta
+      @meta
+    end
+
     module ClassMethods
       # This assumes a standard json format:
       #   {'person':{'attribute':'','another_att':'value'}}
@@ -27,20 +31,32 @@ module SimpleMapper
       def from_json(json)
         doc = Serialize.hash_from_json(json)
         # doc could include a single 'model' element, or a 'models' wrapper around several.
-        puts "Top-level JSON key(s): #{doc.keys.inspect}" if @debug
         if doc.is_a?(Hash)
-          key = doc.keys.first
-          if doc[key] && doc[key].keys.uniq == [key.singularize] && doc[key][key.singularize].is_a?(Array)
-            puts "Several objects returned under key '#{key}'/'#{key.singularize}':" if @debug
-            doc[key][key.singularize].collect do |e|
-              puts "Obj: #{e.inspect}" if @debug
-              Object.module_eval("::#{key.singularize.camelize}", __FILE__, __LINE__).load(e)
+          # In contrast to XML, JSON is not restricted to one top-level key. We will assume the objects are in a hash/array
+          # referenced by either singular or plural of the klass.
+# puts "Received #{doc.length} bytes of json. Top keys: #{doc.keys.join(', ')}. Looking for '#{self.entity_name.underscore}' or '#{self.entity_name.pluralize.underscore}'"
+          meta = doc.dup
+          key = if doc[self.entity_name.underscore]
+            self.entity_name.underscore
+          elsif doc[self.entity_name.pluralize.underscore]
+            self.entity_name.pluralize.underscore
+          end
+          return nil if key.nil?
+# puts "JSON has #{key}"
+          meta.delete(key) # removing the data leaves us only the meta information
+          meta.freeze
+          ret = if doc[key].is_a?(Array)
+            doc[key].collect do |e|
+              obj = self.load(e)
+              obj.instance_variable_set(:@meta, meta)
+              obj
             end
-          elsif doc[key] # top-level must be single object
-            Object.module_eval("::#{key.singularize.camelize}", __FILE__, __LINE__).load(doc[self.name.underscore])
           else
-            nil
+            obj = self.load(doc[key])
+            obj.instance_variable_set(:@meta, meta)
+            obj
           end
+# puts "Collected: #{(ret.is_a?(Array) ? ret : [ret]).length} objects"; ret
         else # doc isn't a hash, probably nil
           doc
         end

data/lib/simple_mapper/formats/xml_format.rb

@@ -38,6 +38,7 @@ module SimpleMapper
         # doc could include a single 'model' element, or a 'models' wrapper around several.
         puts "Top-level XML key(s): #{doc.keys.inspect}" if @debug
         if doc.is_a?(Hash)
+          # By specification the doc should have only ONE top-level element (key)
           key = doc.keys.first
           if doc[key] && doc[key].keys.uniq == [key.singularize] && doc[key][key.singularize].is_a?(Array)
             puts "Several objects returned under key '#{key}'/'#{key.singularize}':" if @debug
@@ -46,7 +47,7 @@ module SimpleMapper
               Object.module_eval("::#{key.singularize.camelize}", __FILE__, __LINE__).load(e)
             end
           elsif doc[key] # top-level must be single object
-            Object.module_eval("::#{key.singularize.camelize}", __FILE__, __LINE__).load(doc[self.name.underscore])
+            Object.module_eval("::#{key.singularize.camelize}", __FILE__, __LINE__).load(doc[key])
           else
             nil
           end

data/lib/simple_mapper/persistence.rb

@@ -53,6 +53,12 @@ module SimpleMapper
       alias :set_format :format=
       attr_reader :format_name
 
+      def entity_name
+        @entity_name ||= name
+      end
+      attr_writer :entity_name
+      alias :set_entity_name :entity_name=
+
       def connections
         @connections ||= {}
       end
@@ -70,10 +76,42 @@ module SimpleMapper
       end
 
       # get
+      # Works with pagination, provided the last object in the returned array responds to .meta and that meta information
+      # includes a total and a url for the next page of results.
       def get(*args)
         adapter = adapter_from_args(*args)
         objs = extract_from(connection(adapter || :default).get(*args))
-        objs.is_a?(Array) ? objs.each {|e| e.instance_variable_set(:@adapter, adapter)} : objs.instance_variable_set(:@adapter, adapter) if adapter
+        # puts "#{objs ? objs.length : 0} objects."
+        # puts "Like #{objs[0].inspect}" if objs
+        if objs.is_a?(Array)
+          safe = 1
+          while(objs[-1].respond_to?(:meta) && objs[-1].meta['total'] > objs.length && objs[-1].meta['next'])
+            safe += 1
+            objs.concat(extract_from(connection(adapter || :default).raw_get(objs[-1].meta['next'])))
+            break if safe >= 50 # Safeguard: if we do 50 requests we're probably on a runaway. Paginating at 50/page would be 2500 records...
+          end
+          objs.each {|e| e.instance_variable_set(:@adapter, adapter)} if adapter
+        else
+          objs.instance_variable_set(:@adapter, adapter) if adapter
+        end
+        # puts "TOTAL #{objs ? objs.length : 0} objects in all."
+        # puts "Like #{objs[-1].inspect}" if objs
+        objs
+      end
+
+      def get_from_url(url, adapter=:default)
+        objs = extract_from(connection(adapter).raw_get(url))
+        if objs.is_a?(Array)
+          safe = 1
+          while(objs[-1].respond_to?(:meta) && objs[-1].meta['total'] > objs.length && objs[-1].meta['next'])
+            safe += 1
+            objs.concat(extract_from(connection(adapter || :default).raw_get(objs[-1].meta['next'])))
+            break if safe >= 50 # Safeguard: if we do 50 requests we're probably on a runaway. Paginating at 50/page would be 2500 records...
+          end
+          objs.each {|e| e.instance_variable_set(:@adapter, adapter)} if adapter
+        else
+          objs.instance_variable_set(:@adapter, adapter) if adapter
+        end
         objs
       end
 
@@ -144,13 +182,17 @@ module SimpleMapper
 
     # sends a put request with self.data
     def put(*args)
-      self.data = self.class.extract_one(self.class.connection(@adapter || :default).put(identifier, formatted_data), identifier).to_hash
+      new_rec = self.class.extract_one(self.class.connection(@adapter || :default).put(identifier, formatted_data, *args), identifier)
+      raise "Request did not return an object" if new_rec.nil?
+      self.data = new_rec.to_hash
       self
     end
 
     # sends a post request with self.data
     def post(*args)
-      self.data = self.class.extract_one(self.class.connection(@adapter || :default).post(formatted_data)).to_hash
+      new_rec = self.class.extract_one(self.class.connection(@adapter || :default).post(formatted_data, *args))
+      raise "Request did not return an object" if new_rec.nil?
+      self.data = new_rec.to_hash
       @persisted = true
       self
     end

data/lib/simple_mapper/support/bliss_serializer.rb

@@ -15,9 +15,6 @@ module Serialize
     :default_root => 'xml',
   }
   def self.object_to_xml(obj, options={})
-    # Automatically set the key_name for DataMapper objects
-    options.merge!(:key_name => obj.class.table.key.name) if obj.class.respond_to?(:table) && obj.class.respond_to?(:persistent?) && obj.class.persistent?
-    # Should do the above also for ActiveRecord...
     options = options.reverse_merge!(obj.class.xml_options) if obj.class.respond_to?(:xml_options)
     options = options.reverse_merge!(obj.xml_options) if obj.respond_to?(:xml_options)
     to_xml(obj.to_hash(options), {:root => Inflector.underscore(obj.class.name)}.merge(options))
@@ -25,7 +22,6 @@ module Serialize
   def self.to_xml(attributes={}, options={})
     options = XML_OPTIONS.merge(options)
     root = options[:root]
-    options[:exclude] = [options[:exclude]].flatten.compact.collect {|e| e.to_s}
     attributes.reject! {|k,v| options[:exclude].include?(k)}
 
     doc = REXML::Document.new
@@ -68,21 +64,16 @@ module Serialize
     :class_columns => :visible_properties,
   }
   def self.object_to_json(obj, options={})
-    # Automatically set the key_name for DataMapper objects
-    options.merge!(:key_name => obj.class.table.key.name) if obj.class.respond_to?(:table) && obj.class.respond_to?(:persistent?) && obj.class.persistent?
-    # Should do the above also for ActiveRecord...
     options = options.reverse_merge!(obj.class.json_options) if obj.class.respond_to?(:json_options)
     options = options.reverse_merge!(obj.json_options) if obj.respond_to?(:json_options)
-    to_json(obj.to_hash(options), {:root => Inflector.underscore(obj.class.name)}.merge(options))
+    to_json(obj.to_hash(options), options)
   end
   def self.to_json(attributes={}, options={})
-# max-results=25 || limit=25
-# start-index=26 || offset=26
-    raise NotImplemented
+    attributes = attributes.to_hash if attributes.respond_to?(:to_hash)
     options = JSON_OPTIONS.merge(options)
-    root = options[:root]
     options[:exclude] = [options[:exclude]].flatten.compact.collect {|e| e.to_s}
     attributes.reject! {|k,v| options[:exclude].include?(k)}
+    options[:root] ? JSON.unparse({options[:root] => attributes}) : JSON.unparse(attributes)
   end
   def self.hash_from_json(json,options={})
     json.to_s.formatted(:json).to_hash
@@ -91,9 +82,8 @@ end
 
 class Hash
   def to_xml(options={})
-    options[:root] = keys[0] if keys.length == 1 && (!options.has_key?(:root) || options[:root].to_s == '')
-    options[:root] = 'xml' if options[:root].to_s == ''
-    Serialize.to_xml(self.slashed, options)
+    options[:root] = keys.length == 1 ? keys[0] : nil if !options.has_key?(:root)
+    Serialize.to_xml(self.slashed, options.merge(:root => (options.has_key?(:root) ? options[:root] : 'xml')))
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: simplemapper
 version: !ruby/object:Gem::Version 
-  version: 0.0.6
+  version: 0.1.2
 platform: ruby
 authors: 
 - Daniel Parker
@@ -9,10 +9,29 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-05-09 00:00:00 -04:00
+date: 2009-06-01 00:00:00 -04:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hash_magic
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: formattedstring
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 description: The lightest of ORMs excluding magic such as properties, primary keys, associations, validations.
 email: gems@behindlogic.com
 executables: []
@@ -70,7 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: simplemapper
-rubygems_version: 1.0.1
+rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
 summary: The lightest of ORMs excluding magic such as properties, primary keys, associations, validations.