lazy_resource 0.3.0 → 0.3.2

data/Gemfile

@@ -13,3 +13,4 @@ gem 'rspec'
 gem 'simplecov', :require => false
 gem 'guard-rspec'
 gem 'growl'
+gem 'rb-fsevent'

data/Guardfile

@@ -1,4 +1,4 @@
-guard 'rspec', :version => 2, :cli => "--color --format documentation" do
+guard 'rspec', :cli => "--color --format documentation" do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/lazy_resource/(.+)\.rb$})     { |m| "spec/lazy_resource/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')  { "spec" }

data/lazy_resource.gemspec

@@ -18,5 +18,5 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'activemodel', '>= 3.1.0'
   gem.add_dependency 'activesupport', '>= 3.1.0'
   gem.add_dependency 'json', '>= 1.5.2'
-  gem.add_dependency 'typhoeus', '>= 0.2.4'
+  gem.add_dependency 'typhoeus', '0.4.2'
 end

data/lib/lazy_resource.rb

@@ -21,9 +21,12 @@ require 'active_support/core_ext/uri'
 require 'lazy_resource/version'
 require 'lazy_resource/errors'
 
+require 'lazy_resource/ext/typhoeus'
+
 module LazyResource
   extend ActiveSupport::Autoload
   
+  autoload :ConfigurationDelegate
   autoload :Attributes
   autoload :Mapping
   autoload :Relation
@@ -34,6 +37,22 @@ module LazyResource
   autoload :UrlGeneration
 
   def self.configure(&block)
-    yield Resource
+    yield LazyResource::ConfigurationDelegate.new
+  end
+
+  def self.logger=(logger)
+    @logger = logger
+  end
+
+  def self.logger
+    @logger
+  end
+
+  def self.debug=(debug)
+    @debug = debug
+  end
+
+  def self.debug
+    @debug = @debug.nil? ? false : @debug
   end
 end

data/lib/lazy_resource/configuration_delegate.rb

@@ -0,0 +1,14 @@
+module LazyResource
+  class ConfigurationDelegate
+    def method_missing(method_name, *args, &block)
+      [LazyResource::Resource, LazyResource].each do |klass|
+        if klass.respond_to?(method_name)
+          return klass.send(method_name, *args, &block)
+        end
+      end
+
+      # if we didn't return from the each above, the method wasn't found
+      super
+    end
+  end
+end

data/lib/lazy_resource/ext/typhoeus.rb

@@ -0,0 +1,24 @@
+module Typhoeus
+  class Hydra
+    def run_with_logging
+      log = LazyResource.debug && LazyResource.logger && @multi.active > 0 && @multi.running <= 0
+      if log
+        LazyResource.logger.info "Processing requests:"
+        start_time = Time.now
+      end
+
+      run_without_logging
+
+      if log
+        LazyResource.logger.info "Requests processed in #{((Time.now - start_time) * 1000).ceil}ms"
+      end
+    end
+
+    alias_method :run_without_logging, :run
+    alias_method :run, :run_with_logging
+  end
+
+  class Multi
+    attr_reader :active, :running
+  end
+end

data/lib/lazy_resource/mapping.rb

@@ -2,7 +2,7 @@ module LazyResource
   module Mapping
     extend ActiveSupport::Concern
 
-    attr_accessor :fetched, :persisted
+    attr_accessor :fetched, :persisted, :other_attributes
 
     def fetched?
       @fetched
@@ -26,13 +26,17 @@ module LazyResource
       end
 
       def load(objects)
+        objects.fetched = true and return objects if objects.kind_of?(LazyResource::Mapping)
+
         if objects.is_a?(Array)
-          objects.map do |object|
-            self.new.load(object)
+          Relation.new(self, :fetched => true).tap do |relation|
+            relation.load(objects)
           end
         else
           if self.root_node_name && objects.key?(self.root_node_name.to_s)
-            self.load(objects[self.root_node_name.to_s])
+            self.load(objects.delete(self.root_node_name.to_s)).tap do |obj|
+              obj.other_attributes = objects
+            end
           else
             self.new.load(objects)
           end
@@ -46,8 +50,13 @@ module LazyResource
       self.tap do |resource|
         resource.persisted = persisted
         resource.fetched = false
-        
-        hash = hash[resource.class.root_node_name.to_s] if resource.class.root_node_name && hash.key?(resource.class.root_node_name.to_s)
+
+        if resource.class.root_node_name && hash.key?(resource.class.root_node_name.to_s)
+          other_attributes = hash
+          hash = other_attributes.delete(resource.class.root_node_name.to_s)
+          self.other_attributes = other_attributes
+        end
+
         hash.each do |name, value|
           attribute = self.class.attributes[name.to_sym]
           next if attribute.nil?

data/lib/lazy_resource/relation.rb

@@ -8,7 +8,7 @@ module LazyResource
       end
     end
 
-    attr_accessor :fetched, :klass, :values, :from, :site
+    attr_accessor :fetched, :klass, :values, :from, :site, :other_attributes
 
     def initialize(klass, options = {})
       @klass = klass
@@ -22,7 +22,7 @@ module LazyResource
     end
 
     def from
-      @from || self.klass.collection_name
+      @from || self.klass.from || self.klass.collection_name
     end
 
     def collection_name
@@ -41,7 +41,20 @@ module LazyResource
 
     def load(objects)
       @fetched = true
-      @result = @klass.load(objects)
+
+      if @klass.root_node_name && objects.respond_to?(:key?) && objects.key?(@klass.root_node_name.to_s)
+        other_objects = objects.dup
+        objects = other_objects.delete(@klass.root_node_name.to_s)
+        @other_attributes = other_objects
+      end
+
+      @result = objects.map do |object|
+        @klass.load(object)
+      end
+    end
+
+    def headers
+      @headers ||= @klass.default_headers
     end
 
     def resource_queue

data/lib/lazy_resource/request.rb

@@ -21,12 +21,17 @@ module LazyResource
 
     def on_complete_proc
       Proc.new do |response|
+        log_response(response) if LazyResource.debug && LazyResource.logger
         @response = response
         handle_errors unless SUCCESS_STATUSES.include?(@response.code)
         parse
       end
     end
 
+    def log_response(response)
+      LazyResource.logger.info "\t[#{response.code}](#{((response.time || 0) * 1000).ceil}ms): #{self.url}"
+    end
+
     def parse
       unless self.response.body.nil? || self.response.body == ''
         @resource.load(JSON.parse(self.response.body))

data/lib/lazy_resource/resource.rb

@@ -19,6 +19,14 @@ module LazyResource
       @site
     end
 
+    def self.default_headers=(headers)
+      @default_headers = headers
+    end
+
+    def self.default_headers
+      @default_headers || {}
+    end
+
     def self.root_node_name=(node_name)
       LazyResource::Mapping.root_node_name = node_name
     end
@@ -35,11 +43,23 @@ module LazyResource
       end
 
       # Sets the URI of the REST resources to map for this class to the value in the +site+ argument.
-      # The site variable is required for Active Async's mapping to work.
+      # The site variable is required for LazyResources's mapping to work.
       def site=(site)
         @site = site
       end
 
+      def default_headers
+        if defined?(@default_headers)
+          @default_headers
+        else
+          LazyResource::Resource.default_headers
+        end
+      end
+
+      def default_headers=(headers)
+        @default_headers = headers
+      end
+
       def from
         @from
       end
@@ -56,6 +76,8 @@ module LazyResource
         self.new(self.primary_key_name => id).tap do |resource|
           resource.fetched = false
           resource.persisted = true
+          options[:headers] ||= {}
+          options[:headers].reverse_merge!(default_headers)
           request = Request.new(resource.element_url(params), resource, options)
           request_queue.queue(request)
         end

data/lib/lazy_resource/resource_queue.rb

@@ -25,7 +25,7 @@ module LazyResource
 
     def send_to_request_queue!
       while(relation = @queue.pop)
-        request = Request.new(url_for(relation), relation)
+        request = Request.new(url_for(relation), relation, :headers => relation.headers)
         request_queue.queue(request)
       end
     end

data/lib/lazy_resource/version.rb

@@ -1,3 +1,3 @@
 module LazyResource
-  VERSION = "0.3.0"
+  VERSION = "0.3.2"
 end

data/spec/lazy_resource/configuration_delegate_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe LazyResource::ConfigurationDelegate do
+  subject { LazyResource::ConfigurationDelegate.new }
+  it 'forwards the method invocation to Resource if the method is defined there' do
+    subject.site.should == 'http://example.com'
+  end
+
+  it 'forwards the invocation to LazyResource if the method is defined there' do
+    subject.debug.should == false
+  end
+
+  it 'raises an error if the method is not defined on one of the delegated classes' do
+    lambda { subject.foo }.should raise_error(NoMethodError)
+  end
+end

data/spec/lazy_resource/ext/typhoeus_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+class SimpleLogger
+  def info(msg)
+    msg
+  end
+end
+
+describe Typhoeus::Hydra do
+  describe '#run_with_logging' do
+    before :each do
+      LazyResource.debug = true
+      LazyResource.logger = SimpleLogger.new
+      @hydra = Typhoeus::Hydra.new
+      @hydra.stub!(:run_without_logging)
+      @multi = @hydra.send(:instance_variable_get, :"@multi")
+    end
+
+    it 'logs if logging is enabled, there are items to process, and the queue has not yet started processing' do
+      @multi.send(:instance_variable_set, "@active", 10)
+      @multi.send(:instance_variable_set, "@running", 0)
+      LazyResource.logger.should_receive(:info).twice
+      @hydra.run_with_logging
+    end
+
+    it 'does not log if there are no items to process' do
+      @multi.send(:instance_variable_set, "@active", 0)
+      @multi.send(:instance_variable_set, "@running", 0)
+      LazyResource.logger.should_not_receive(:info)
+      @hydra.run_with_logging
+    end
+
+    it 'does not log if the queue is already being processed' do
+      @multi.send(:instance_variable_set, "@active", 10)
+      @multi.send(:instance_variable_set, "@running", 5)
+      LazyResource.logger.should_not_receive(:info)
+      @hydra.run_with_logging
+    end
+  end
+end

data/spec/lazy_resource/lazy_resource_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+class DumbLogger
+  def info(msg)
+    puts msg
+  end
+end
+
+describe LazyResource do
+  before :each do
+    LazyResource.configure do |config|
+      config.debug = true
+      config.logger = DumbLogger.new
+    end
+  end
+
+  describe '#logger' do
+    it 'returns the logger' do
+      LazyResource.logger.should_not be_nil
+    end
+  end
+
+  describe '#debug' do
+    it 'logs when a request completes' do
+      LazyResource.logger.should_receive(:info)
+      request = LazyResource::Request.new('http://example.com', User.new)
+      request.on_complete_proc.call(Typhoeus::Response.new)
+    end
+  end
+end

data/spec/lazy_resource/mapping_spec.rb

@@ -72,7 +72,7 @@ describe LazyResource::Mapping do
       user.name.should == 'Andrew'
       user.created_at.should == @now
       user.post.should == @post
-      user.comments.should == @comments
+      user.comments.to_a.should == @comments
     end
 
     it 'loads an array of objects' do
@@ -143,6 +143,25 @@ describe LazyResource::Mapping do
       user = Foo.load('data' => { :id => 123 })
       user.id.should == 123
     end
+
+    it 'sets any other attributes in the hash to #other_attributes for a single resource' do
+      Foo.root_node_name = :data
+      user = Foo.load('data' => { :id => 123 }, 'length' => 12)
+      user.other_attributes.should == { 'length' => 12 }
+    end
+
+    it 'sets any other attributes in the hash to #other_attributes for a collection' do
+      Foo.root_node_name = :data
+      users = Foo.load('data' => [{:id => 123}], 'length' => 12)
+      users.other_attributes.should == { 'length' => 12 }
+    end
+
+    it 'sets any other attributes in the hash to #other_attributes for an instantiated object' do
+      Foo.root_node_name = :data
+      user = Foo.new
+      user.load('data' => { :id => 123 }, 'length' => 12)
+      user.other_attributes.should == { 'length' => 12 }
+    end
   end
 
   describe '#load' do

data/spec/lazy_resource/relation_spec.rb

@@ -25,7 +25,15 @@ describe LazyResource::Relation do
       users = [{ :id => '1', :name => 'Andrew' }, { :id => '1', :name => 'James' }]
       users_collection = LazyResource::Relation.new(User)
       users_collection.load(users)
-      users_collection.to_a.should == User.load(users)
+      users_collection.to_a.should == User.load(users).to_a
+    end
+
+    it 'adds any other attributes to #other_attributes' do
+      User.root_node_name = :data
+      users = { 'data' => [{ :id => '1', :name => 'Andrew' }, { :id => '1', :name => 'James' }], 'length' => 12 }
+      users_collection = LazyResource::Relation.new(User)
+      users_collection.load(users)
+      users_collection.other_attributes.should == { 'length' => 12 }
     end
   end
 

data/spec/lazy_resource/resource_spec.rb

@@ -259,6 +259,10 @@ describe LazyResource::Resource do
       end
     end
 
+    after :each do
+      User.default_headers = {}
+    end
+
     it 'generates a new resource and associated request and adds it to the request queue' do
       LazyResource::Request.should_receive(:new)
       User.request_queue.should_receive(:queue)
@@ -276,6 +280,20 @@ describe LazyResource::Resource do
       user = User.find(1)
       user.name.should == 'Andrew'
     end
+
+    it 'uses default headers' do
+      User.default_headers = { :foo => 'bar' }
+      request = LazyResource::Request.new('/path/to/something', User.new)
+      LazyResource::Request.should_receive(:new).with(anything, anything, :headers => { :foo => 'bar' }).and_return(request)
+      User.find(1)
+    end
+
+    it 'allows default headers to be overwritten' do
+      User.default_headers = { :foo => 'bar' }
+      request = LazyResource::Request.new('/path/to/something', User.new)
+      LazyResource::Request.should_receive(:new).with(anything, anything, :headers => { :foo => 'buzz' }).and_return(request)
+      User.find(1, {}, { :headers => { :foo => 'buzz' } })
+    end
   end
 
   describe '.where' do
@@ -379,6 +397,55 @@ describe LazyResource::Resource do
     end
   end
 
+  describe '.default_headers' do
+    after :each do
+      User.default_headers = {}
+    end
+
+    it 'returns the default headers if they are defined' do
+      User.default_headers = { :foo => 'bar' }
+      User.default_headers.should == { :foo => 'bar' }
+    end
+
+    it 'returns LazyResource::Resource.default_headers if default_headers is not defined' do
+      User.send(:remove_instance_variable, "@default_headers")
+      User.default_headers.should == LazyResource::Resource.default_headers
+    end
+  end
+
+  describe '.default_headers=' do
+    after :each do
+      User.default_headers = {}
+    end
+
+    it 'sets the default headers' do
+      User.default_headers = { :foo => 'bar' }
+      User.default_headers.should == { :foo => 'bar' }
+    end
+  end
+
+  describe 'self.default_headers' do
+    after :each do
+      LazyResource::Resource.default_headers = {}
+    end
+
+    it 'returns the global default headers' do
+      LazyResource::Resource.default_headers = { :foo => 'bar' }
+      LazyResource::Resource.default_headers.should == { :foo => 'bar' }
+    end
+  end
+
+  describe 'self.default_headers=' do
+    after :each do
+      LazyResource::Resource.default_headers = {}
+    end
+
+    it 'sets the global default headers' do
+      LazyResource::Resource.default_headers = { :foo => 'bar' }
+      LazyResource::Resource.default_headers.should == { :foo => 'bar' }
+    end
+  end
+
   describe '.from' do
     before :each do
       @from = User.from

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lazy_resource
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-20 00:00:00.000000000 Z
+date: 2012-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -64,17 +64,17 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.4
+        version: 0.4.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.4
+        version: 0.4.2
 description: ActiveResource with it's feet up. The write less, do more consumer of
   delicious APIs.
 email:
@@ -95,7 +95,9 @@ files:
 - lazy_resource.gemspec
 - lib/lazy_resource.rb
 - lib/lazy_resource/attributes.rb
+- lib/lazy_resource/configuration_delegate.rb
 - lib/lazy_resource/errors.rb
+- lib/lazy_resource/ext/typhoeus.rb
 - lib/lazy_resource/http_mock.rb
 - lib/lazy_resource/mapping.rb
 - lib/lazy_resource/relation.rb
@@ -109,7 +111,10 @@ files:
 - spec/fixtures/post.rb
 - spec/fixtures/user.rb
 - spec/lazy_resource/attributes_spec.rb
+- spec/lazy_resource/configuration_delegate_spec.rb
 - spec/lazy_resource/errors_spec.rb
+- spec/lazy_resource/ext/typhoeus_spec.rb
+- spec/lazy_resource/lazy_resource_spec.rb
 - spec/lazy_resource/mapping_spec.rb
 - spec/lazy_resource/relation_spec.rb
 - spec/lazy_resource/request_spec.rb
@@ -132,7 +137,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2886530034829089377
+      hash: 1900980543301721831
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -141,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2886530034829089377
+      hash: 1900980543301721831
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -154,7 +159,10 @@ test_files:
 - spec/fixtures/post.rb
 - spec/fixtures/user.rb
 - spec/lazy_resource/attributes_spec.rb
+- spec/lazy_resource/configuration_delegate_spec.rb
 - spec/lazy_resource/errors_spec.rb
+- spec/lazy_resource/ext/typhoeus_spec.rb
+- spec/lazy_resource/lazy_resource_spec.rb
 - spec/lazy_resource/mapping_spec.rb
 - spec/lazy_resource/relation_spec.rb
 - spec/lazy_resource/request_spec.rb