api_resource 0.2.11 → 0.3.0

data/lib/api_resource/connection.rb

@@ -51,7 +51,13 @@ module ApiResource
     end
     
     def get(path, headers = {})
-      format.decode(request(:get, path, build_request_headers(headers, :get, self.site.merge(path))))
+      # our site and headers for this request
+      site = self.site.merge(path)
+      headers = build_request_headers(headers, :get, site)
+
+      self.with_caching(path, headers) do
+        format.decode(request(:get, path, headers))
+      end
     end
     
     def delete(path, headers = {})
@@ -81,6 +87,23 @@ module ApiResource
       end
     end
 
+    protected
+
+    def cache_key(path, headers)
+      key = Digest::MD5.hexdigest([path, headers].to_s)
+      return "a-#{key}-#{ApiResource::Base.ttl}"
+    end
+
+    def with_caching(path, data = {}, &block)
+      if ApiResource::Base.ttl.to_f > 0.0
+        key = self.cache_key(path, data)
+        ApiResource.cache.fetch(key, :expires_in => ApiResource::Base.ttl) do
+          yield
+        end
+      else
+        yield
+      end
+    end
 
     private
       # Makes a request to the remote service.

data/lib/api_resource/custom_methods.rb

@@ -83,37 +83,35 @@ module ApiResource
       end
     end
 
-    module InstanceMethods
-      def get(method_name, options = {})
-        connection.get(custom_method_element_url(method_name, options), self.class.headers)
-      end
+    def get(method_name, options = {})
+      connection.get(custom_method_element_url(method_name, options), self.class.headers)
+    end
 
-      def post(method_name, options = {}, body = nil)
-        request_body = body.blank? ? encode : body
-        if new?
-          connection.post(custom_method_new_element_url(method_name, options), request_body, self.class.headers)
-        else
-          connection.post(custom_method_element_url(method_name, options), request_body, self.class.headers)
-        end
+    def post(method_name, options = {}, body = nil)
+      request_body = body.blank? ? encode : body
+      if new?
+        connection.post(custom_method_new_element_url(method_name, options), request_body, self.class.headers)
+      else
+        connection.post(custom_method_element_url(method_name, options), request_body, self.class.headers)
       end
+    end
 
-      def put(method_name, options = {}, body = '')
-        connection.put(custom_method_element_url(method_name, options), body, self.class.headers)
-      end
+    def put(method_name, options = {}, body = '')
+      connection.put(custom_method_element_url(method_name, options), body, self.class.headers)
+    end
 
-      def delete(method_name, options = {})
-        connection.delete(custom_method_element_url(method_name, options), self.class.headers)
-      end
+    def delete(method_name, options = {})
+      connection.delete(custom_method_element_url(method_name, options), self.class.headers)
+    end
 
 
-      private
-        def custom_method_element_url(method_name, options = {})
-          "#{self.class.prefix(prefix_options)}#{self.class.collection_name}/#{id}/#{method_name}.#{self.class.format.extension}#{self.class.__send__(:query_string, options)}"
-        end
+    private
+      def custom_method_element_url(method_name, options = {})
+        "#{self.class.prefix(prefix_options)}#{self.class.collection_name}/#{id}/#{method_name}.#{self.class.format.extension}#{self.class.__send__(:query_string, options)}"
+      end
 
-        def custom_method_new_element_url(method_name, options = {})
-          "#{self.class.prefix(prefix_options)}#{self.class.collection_name}/new/#{method_name}.#{self.class.format.extension}#{self.class.__send__(:query_string, options)}"
-        end
-    end
+      def custom_method_new_element_url(method_name, options = {})
+        "#{self.class.prefix(prefix_options)}#{self.class.collection_name}/new/#{method_name}.#{self.class.format.extension}#{self.class.__send__(:query_string, options)}"
+      end
   end
 end

data/lib/api_resource/formats.rb

@@ -8,7 +8,15 @@ module ApiResource
     #   ActiveResource::Formats[:xml]  # => ActiveResource::Formats::XmlFormat
     #   ActiveResource::Formats[:json] # => ActiveResource::Formats::JsonFormat
     def self.[](mime_type_reference)
-      ApiResource::Formats.const_get(ActiveSupport::Inflector.camelize(mime_type_reference.to_s) + "Format")
+      format_name = ActiveSupport::Inflector.camelize(mime_type_reference.to_s) + "Format"
+      begin
+        ApiResource::Formats.const_get(format_name)
+      rescue NameError => e
+        raise BadFormat.new("#{mime_type_reference} is not a valid format")
+      end
+    end
+
+    class BadFormat < StandardError
     end
   end
 end

data/lib/api_resource/model_errors.rb

@@ -35,50 +35,46 @@ module ApiResource
       alias_method_chain :save, :validations
     end
     
-    module InstanceMethods
+    def save_with_validations(*args)
+      # we want to leave the original intact
+      options = args.clone.extract_options!
       
-      def save_with_validations(*args)
-        # we want to leave the original intact
-        options = args.clone.extract_options!
-        
-        perform_validation = options.blank? ? true : options[:validate]
-        
-        @remote_errors = nil
-        if perform_validation && valid? || !perform_validation
-          save_without_validations(*args)
-          true
-        else
-          false
-        end
-      rescue ApiResource::UnprocessableEntity => error
-        @remote_errors = error
-        load_remote_errors(@remote_errors, true)
-        false
-      end
-      
-      def load_remote_errors(remote_errors, save_cache = false)
-        error_data = self.class.format.decode(remote_errors.response.body)['errors'] || {}
-        if error_data.is_a?(Hash)
-          self.errors.from_hash(error_data)
-        elsif error_data.is_a?(Array)
-          self.errors.from_array(error_data)
-        else
-          raise Exception.new
-        end
-      rescue Exception
-        raise "Invalid response for invalid object: expected an array or hash got #{remote_errors}"
-      end
+      perform_validation = options.blank? ? true : options[:validate]
       
-      # This method runs any local validations but not remote ones
-      def valid?
-        super
-        errors.empty?
+      @remote_errors = nil
+      if perform_validation && valid? || !perform_validation
+        save_without_validations(*args)
+        true
+      else
+        false
       end
-      
-      def errors
-        @errors ||= ApiResource::Errors.new(self)
+    rescue ApiResource::UnprocessableEntity => error
+      @remote_errors = error
+      load_remote_errors(@remote_errors, true)
+      false
+    end
+    
+    def load_remote_errors(remote_errors, save_cache = false)
+      error_data = self.class.format.decode(remote_errors.response.body)['errors'] || {}
+      if error_data.is_a?(Hash)
+        self.errors.from_hash(error_data)
+      elsif error_data.is_a?(Array)
+        self.errors.from_array(error_data)
+      else
+        raise Exception.new
       end
-      
+    rescue Exception
+      raise "Invalid response for invalid object: expected an array or hash got #{remote_errors}"
+    end
+    
+    # This method runs any local validations but not remote ones
+    def valid?
+      super
+      errors.empty?
+    end
+    
+    def errors
+      @errors ||= ApiResource::Errors.new(self)
     end
     
   end

data/lib/api_resource/observing.rb

@@ -11,18 +11,16 @@ module ApiResource
         alias_method_chain method, :observers
     end
     
-    module InstanceMethods
-      %w( create save update destroy ).each do |method|
-        module_eval <<-EOE, __FILE__, __LINE__ + 1
-          def #{method}_with_observers(*args)
-            notify_observers(:before_#method)
-            if result = #{method}_without_observers(*args)
-              notify_observers(:after_#{method})
-            end
-            return result
+    %w( create save update destroy ).each do |method|
+      module_eval <<-EOE, __FILE__, __LINE__ + 1
+        def #{method}_with_observers(*args)
+          notify_observers(:before_#method)
+          if result = #{method}_without_observers(*args)
+            notify_observers(:after_#{method})
           end
-        EOE
-      end
+          return result
+        end
+      EOE
     end
     
   end

data/lib/api_resource/scopes.rb

@@ -28,18 +28,18 @@ module ApiResource
         self.related_objects[:scope][name.to_sym]
       end
     end
-    module InstanceMethods
-      def scopes
-        return self.class.scopes
-      end
-      
-      def scope?(name)
-        return self.class.scope?(name)
-      end
-      
-      def scope_attributes(name)
-        return self.class.scope_attributes(name)
-      end
+    
+    def scopes
+      return self.class.scopes
+    end
+    
+    def scope?(name)
+      return self.class.scope?(name)
     end
+    
+    def scope_attributes(name)
+      return self.class.scope_attributes(name)
+    end
+    
   end
 end

data/spec/lib/api_resource_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe ApiResource do
+
+  context ".cache" do
+
+    around(:each) do |example|
+      begin
+        old_rails = Object.send(:remove_const, :Rails)
+        example.run
+      ensure
+        Rails = old_rails
+        ApiResource
+      end
+    end
+
+    it "should be a Rails cache if it's initialized" do
+      cache_stub = stub()
+      Rails = mock(:cache => cache_stub)
+      ApiResource.cache(true).should be cache_stub
+    end
+
+    it "should default to an instance of memory cache" do
+      defined?(Rails).should be_blank
+      ApiResource.cache(true).should be_a(
+        ActiveSupport::Cache::MemoryStore
+      )
+    end
+  end
+
+  context ".with_ttl" do
+
+    it "should temporarily set ttl for a block" do
+      old_ttl = ApiResource.ttl
+      ApiResource.with_ttl(10) do
+        ApiResource.ttl.should eql(10)
+      end
+      ApiResource.ttl.should eql(old_ttl)
+    end
+
+  end
+
+end

data/spec/lib/associations_spec.rb

@@ -52,7 +52,7 @@ describe "Associations" do
     
     it "should only define relationships for the given class - they should not cascade" do
       TestResource.belongs_to :belongs_to_object
-      AnotherTestResource.association?(:belongs_to_object).should_not be true
+      AnotherTestResource.association?(:belongs_to_object).should_not be_true
     end
     
     it "should have its relationship cascade when sub-classed" do
@@ -295,7 +295,6 @@ describe "Associations" do
       
       
       it "should be able to query scopes on the current model" do
-        
         ScopeResource.one.to_query.should eql "one=true"
         ScopeResource.two("test").to_query.should eql "two=test"
         ScopeResource.three(1,2,3).to_query.should eql "three[]=1&three[]=2&three[]=3"
@@ -518,6 +517,7 @@ describe "Associations" do
         end
         
         it "should assign associations to the correct type on initialization" do
+          #binding.pry
           tr = TestResource.new(:has_one_object => {:name => "Dan"}, :belongs_to_object => {:name => "Dan"})
           
           tr.has_one_object.internal_object.should be_instance_of HasOneObject
@@ -563,7 +563,8 @@ describe "Associations" do
       context "ActiveModel" do
         before(:all) do
           require 'active_record'
-          ActiveRecord::Base.establish_connection({"adapter" => "sqlite3", "database" => "/tmp/api_resource_test_db.sqlite"})
+          db_path = File.expand_path(File.dirname(__FILE__) + "/../tmp/api_resource_test_db.sqlite")
+          ActiveRecord::Base.establish_connection({"adapter" => "sqlite3", "database" => db_path})
           ActiveRecord::Base.connection.create_table(:test_ars, :force => true) do |t|
             t.integer(:test_resource_id)
           end

data/spec/lib/base_spec.rb

@@ -162,6 +162,10 @@ describe "Base" do
       TestResource.format.extension.to_sym.should eql(:xml)
       TestResource.format = :json
     end
+
+    it "should only allow proper formats to be set" do
+      expect {TestResource.format = :blah}.should raise_error(::ApiResource::Formats::BadFormat)
+    end 
     
     it "should be able to set an http timeout" do
       TestResource.timeout = 5
@@ -579,5 +583,29 @@ describe "Base" do
     end
     
   end
+
+  context ".get" do
+
+    context "with ttl" do
+      around(:each) do |example|
+
+        begin
+          initial = ApiResource::Base.ttl
+          ApiResource::Base.ttl = 1
+          example.run
+        ensure 
+          ApiResource::Base.ttl = initial
+        end
+
+      end
+
+      it "should implement caching using the ttl setting" do
+        cache = mock(:fetch => {:id => 123, :name => "Dan"})
+        ApiResource.stubs(:cache => cache)
+        TestResource.find(123)
+      end
+    end
+
+  end
   
 end

data/spec/spec_helper.rb

@@ -1,6 +1,5 @@
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
-
 require 'bundler'
 require 'api_resource'
 require 'simplecov'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api_resource
 version: !ruby/object:Gem::Version
-  version: 0.2.11
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,22 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-21 00:00:00.000000000 Z
+date: 2012-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70339494520880 !ruby/object:Gem::Requirement
+  requirement: &2157448720 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - =
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 3.0.9
+        version: '3'
   type: :runtime
   prerelease: false
-  version_requirements: *70339494520880
+  version_requirements: *2157448720
 - !ruby/object:Gem::Dependency
   name: hash_dealer
-  requirement: &70339494519400 !ruby/object:Gem::Requirement
+  requirement: &2157445640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70339494519400
+  version_requirements: *2157445640
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &70339494517340 !ruby/object:Gem::Requirement
+  requirement: &2157443060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70339494517340
+  version_requirements: *2157443060
 - !ruby/object:Gem::Dependency
   name: log4r
-  requirement: &70339494515320 !ruby/object:Gem::Requirement
+  requirement: &2157441760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70339494515320
+  version_requirements: *2157441760
 - !ruby/object:Gem::Dependency
   name: differ
-  requirement: &70339494514460 !ruby/object:Gem::Requirement
+  requirement: &2157438700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70339494514460
+  version_requirements: *2157438700
 - !ruby/object:Gem::Dependency
   name: colorize
-  requirement: &70339494513160 !ruby/object:Gem::Requirement
+  requirement: &2157427000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70339494513160
+  version_requirements: *2157427000
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70339494498860 !ruby/object:Gem::Requirement
+  requirement: &2157425020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,43 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70339494498860
+  version_requirements: *2157425020
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: &2157421560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2157421560
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: &2157417420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2157417420
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: &2157416240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2157416240
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70339494498060 !ruby/object:Gem::Requirement
+  requirement: &2157415120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +131,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70339494498060
+  version_requirements: *2157415120
 - !ruby/object:Gem::Dependency
   name: ruby-debug19
-  requirement: &70339494485980 !ruby/object:Gem::Requirement
+  requirement: &2157408240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +142,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70339494485980
+  version_requirements: *2157408240
 - !ruby/object:Gem::Dependency
   name: growl
-  requirement: &70339494484300 !ruby/object:Gem::Requirement
+  requirement: &2157406740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +153,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70339494484300
+  version_requirements: *2157406740
 - !ruby/object:Gem::Dependency
   name: rspec-rails
-  requirement: &70339494482660 !ruby/object:Gem::Requirement
+  requirement: &2157405020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,10 +164,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70339494482660
+  version_requirements: *2157405020
 - !ruby/object:Gem::Dependency
   name: factory_girl
-  requirement: &70339494480240 !ruby/object:Gem::Requirement
+  requirement: &2157402240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -142,10 +175,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70339494480240
+  version_requirements: *2157402240
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70339494479280 !ruby/object:Gem::Requirement
+  requirement: &2157394860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -153,10 +186,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70339494479280
+  version_requirements: *2157394860
 - !ruby/object:Gem::Dependency
   name: faker
-  requirement: &70339494477780 !ruby/object:Gem::Requirement
+  requirement: &2157392560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -164,10 +197,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70339494477780
+  version_requirements: *2157392560
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &70339494476400 !ruby/object:Gem::Requirement
+  requirement: &2157391740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -175,10 +208,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70339494476400
+  version_requirements: *2157391740
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70339494475220 !ruby/object:Gem::Requirement
+  requirement: &2157390760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -186,10 +219,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70339494475220
+  version_requirements: *2157390760
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70339494473700 !ruby/object:Gem::Requirement
+  requirement: &2157389540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -197,10 +230,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70339494473700
+  version_requirements: *2157389540
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70339494472760 !ruby/object:Gem::Requirement
+  requirement: &2157384400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -208,10 +241,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70339494472760
+  version_requirements: *2157384400
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70339494471640 !ruby/object:Gem::Requirement
+  requirement: &2157381720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -219,21 +252,21 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *70339494471640
+  version_requirements: *2157381720
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70339494455840 !ruby/object:Gem::Requirement
+  requirement: &2157379880 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - =
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 3.0.9
+        version: '3'
   type: :development
   prerelease: false
-  version_requirements: *70339494455840
+  version_requirements: *2157379880
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70339494453680 !ruby/object:Gem::Requirement
+  requirement: &2157378660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -241,7 +274,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70339494453680
+  version_requirements: *2157378660
 description: A replacement for ActiveResource for RESTful APIs that handles associated
   object and multiple data sources
 email: ejl6266@gmail.com
@@ -294,6 +327,7 @@ files:
 - lib/api_resource/railtie.rb
 - lib/api_resource/scopes.rb
 - nohup.out
+- spec/lib/api_resource_spec.rb
 - spec/lib/associations_spec.rb
 - spec/lib/attributes_spec.rb
 - spec/lib/base_spec.rb
@@ -325,7 +359,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2077166226351536959
+      hash: 391851535398052430
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -334,7 +368,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.17
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: A replacement for ActiveResource for RESTful APIs that handles associated