active_resource_test_helper 0.1.0

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2010 Flavio Castelli <flavio@castelli.name>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,148 @@
+= active_resource_test_helper
+
+active_resource_test_helper makes it easier to use ActiveResouce::HttpMock[http://api.rubyonrails.org/classes/ActiveResource/HttpMock.html].
+
+Instead of declaring manually all the request-response pairs, it's possible to
+use dynamically generated contents. These contents are defined using
+factory_girl[http://github.com/thoughtbot/factory_girl] and are stored into a
+Redis[http://code.google.com/p/redis/] database using ohm[http://github.com/soveran/ohm].
+
+Usually ActiveResource tests look like that:
+
+  def setup
+    @matz  = { :id => 1, :name => "Matz" }.to_xml(:root => "person")
+    ActiveResource::HttpMock.respond_to do |mock|
+      mock.post   "/people.xml",   {}, @matz, 201, "Location" => "/people/1.xml"
+      mock.get    "/people/1.xml", {}, @matz
+      mock.put    "/people/1.xml", {}, nil, 204
+      mock.delete "/people/1.xml", {}, nil, 200
+    end
+  end
+
+  def test_get_matz
+    person = Person.find(1)
+    assert_equal "Matz", person.name
+  end
+
+While using active_resource_test_helper an common ActiveResource test would be something like that:
+
+  class RemoteUserTest < Test::Unit::TestCase
+    include ActiveResourceTestHelper
+    active_resource_factories :user
+
+    def setup
+      assert_equal 0, User.count
+      @users = []
+      20.times do |i|
+        @users << Factory.create(:basic_user)
+      end
+    end
+
+    def test_find_by_id
+      @users.each do |expected_user|
+        user = UserResource.find(expected_user.id)
+        assert_not_nil user
+        assert_equal expected_user.first_name, user.first_name
+      end
+    end
+  end
+
+== HTTP methods supported
+
+Currently active_resource_test_helper dynamic contents are served only by _get_ requests.
+In the future they will be used also by _post_, _put_, _delete_ and _head_ operations.
+
+=== Get requests
+
+The following operations are currently fully supported:
+
+  Person.find(1)
+  Person.find(:all)
+  Person.find(:first)
+  Person.find(:last)
+  Person.find(:all, :params => { :title => "CEO" })
+  Person.find(:first, :params => { :first_name => "flavio", :last_name => "castelli" })
+
+== Requirements
+
+Install Redis[http://code.google.com/p/redis/]. On most platforms it's as easy as grabbing the sources, running make and then putting the redis-server binary in the PATH.
+
+Once you have it installed, you can execute redis-server and it will run on localhost:6379 by default. Check the redis.conf file that comes with the sources if you want to change some settings.
+
+Then install the active_resource_test_helper gem:
+
+  sudo gem install active_resource_test_helper
+
+== Usage
+
+In order to use active_resource_test_helper inside of your tests you have to:
+
+* require 'active_resource_test_helper'
+* include the ActiveResourceTestHelper module inside of your test
+
+This is a small example:
+
+  require  'active_resource_test_helper'
+
+  class MyTest < Test::Unit::TestCase
+    include ActiveResourceTestHelper
+    active_resource_factories :user, :post, :comment
+  end
+
+Obviously you have also to define the factories used by your test (see below).
+
+You can find more examples under the _test_ directory.
+
+== Defining factories
+
+Factories used by ActiveResource::HttpMock are defined with the _Factory.define_active_resource_factory_ method:
+
+  Factory.define_active_resource_factory(:basic_user, :class => "User") do |u|
+    u.sequence(:first_name) {|n| "first_name#{n}"}
+    u.sequence(:last_name) {|n| "last_name#{n}"}
+    u.admin false
+    u.email {|u| "#{u.first_name}.#{u.last_name}@example.com" }
+    u.age {rand(30) + 18}
+  end
+
+If you are already familiar with factory_girl[http://github.com/thoughtbot/factory_girl] you will probably have already noticed we are using the same syntax.
+
+=== What happens behind the scenes
+
+_active_resource_test_helper_ will automatically generate an ohm[http://github.com/soveran/ohm]
+model for each build class used by the active resource factories.
+
+These models will have one attribute and one index per each attribute declared inside of the factory.
+
+The factory defined into the previous example will generate this model:
+
+  class User < Ohm::Model
+      index :id
+
+      attribute :first_name
+      index :first_name
+
+      attribute :last_name
+      index :last_name
+
+      attribute :admin
+      index :admin
+
+      attribute :email
+      index :email
+
+      attribute :age
+      index :age
+
+      alias :save! :save
+  end
+
+== Transactional factories
+
+Currently redis doesn't have a complete transaction support. active_resource_test_helper removes from the redis database all the instances of the models defined by the ActiveResource factories that are used by the test.
+This operation is executed before and after each test execution.
+
+== Statically defined responses
+
+It's possible to use dynamic contents and static pairs of request-response at the same time.
+However the responses defined in the static way have precedence over those generated in the dynamic way.

data/Rakefile

@@ -0,0 +1,65 @@
+require 'rake'
+require 'rake/rdoctask'
+require 'rake/testtask'
+
+task :default => "test"
+
+namespace :test do
+  desc "Test all classes"
+  Rake::TestTask.new(:all) do |t|
+    t.libs << "test"
+    t.pattern = 'test/*_test.rb'
+    t.verbose = true
+  end 
+end
+
+desc "Run all the unit tests"
+task :test do
+  Rake::Task["test:all"].invoke
+end
+
+desc 'Generate documentation.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'active_resource_test_hekper'
+  rdoc.options << '--line-numbers' << "--main" << "README.rdoc"
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name        = %q{active_resource_test_helper}
+    s.summary     = %q{ActiveResource test helper.}
+    s.description = %q{active_resource_test_helper makes it easier to use ActiveResouce::HttpMock.
+                      Instead of declaring manually all the request-response pairs,
+                      it’s possible to use dynamically generated contents.
+                      These contents are defined using factory_girl and are
+                      stored into a Redis database using ohm.}
+
+    s.files        = FileList['[A-Z]*', 'lib/**/*.rb', 'test/**/*.rb']
+    s.require_path = 'lib'
+    s.test_files   = Dir[*['test/**/*_test.rb']]
+
+    s.has_rdoc         = true
+    s.extra_rdoc_files = ["README.rdoc"]
+    s.rdoc_options = ['--line-numbers', "--main", "README.rdoc"]
+
+    s.authors = ["Flavio Castelli"]
+    s.email   = %q{flavio@castelli.name}
+    s.homepage = "http://github.com/flavio/active_resource_test_helper"
+
+    s.add_dependency "factory_girl", ">= 1.2.3"
+    s.add_dependency "redis", ">= 1.0.4"
+    s.add_dependency "ohm", ">= 0.0.35"
+
+    s.platform = Gem::Platform::RUBY
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+
+desc "Clean files generated by rake tasks"
+task :clobber => [:clobber_rdoc]

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/active_resource_test_helper.rb

@@ -0,0 +1,29 @@
+require 'active_resource_test_helper/ohm/model'
+require 'active_resource_test_helper/active_resource/http_mock'
+require 'active_resource_test_helper/factory'
+
+module ActiveResourceTestHelper  #:nodoc: all
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  def run(*args, &block)
+    ActiveResource::HttpMock.dynamic_models.each do |model|
+      model.destroy_all
+    end
+
+    super(*args, &block)
+
+    ActiveResource::HttpMock.dynamic_models.each do |model|
+      model.destroy_all
+    end
+  end
+
+  module ClassMethods
+    def active_resource_factories *args
+      args.each do |name|
+        ActiveResource::HttpMock.register_factory name
+      end
+    end
+  end
+end

data/lib/active_resource_test_helper/active_resource/http_mock.rb

@@ -0,0 +1,77 @@
+require "active_resource"
+require "active_resource/http_mock"
+require "active_support"
+require 'cgi'
+
+module ActiveResource # :nodoc:
+
+  # Adds new convenience methods to ActiveResource::HttpMock[http://api.rubyonrails.org/classes/ActiveResource/HttpMock.html].
+  class HttpMock
+    # Return a list of all the dynamic models used by HttpMock
+    def self.dynamic_models
+      @@dynamic_models ||= []
+    end
+
+    # Add a new dynamic model by registering a new factory.
+    # Do not use this method directly, Use the active_resource_factories method
+    # provided by the ActiveResourceTestHelper module.
+    def self.register_factory name
+      build_class = Factory.factory_by_name(name).build_class
+      dynamic_models << build_class unless dynamic_models.include? build_class
+    end
+
+    # Unregister all the dynamic models.
+    def reset_dynamic_models!
+      @@dynamic_models.clear
+    end
+
+    alias old_get get
+    
+    def get(path, headers) #:nodoc:
+      begin
+        # lookup into the static mocks
+        old_get path, headers
+      rescue InvalidRequestError
+        # lookup into the dynamic mocks
+        model_class = HttpMock.dynamic_models.find{|m| !(path =~ dynamic_model_regexp(m)).nil?}
+        if model_class.nil?
+          raise
+        else
+          if $1.nil? and $2.nil?
+            # all the items have been requested
+            items = entries_to_valid_array(model_class.all)
+            response = Response.new(items.to_xml(:root => model_class.to_s))
+          elsif !$1.nil?
+            # a specific item has been requested
+            match = model_class.find(:id => $1.delete('/').to_i).entries.first
+
+            if match.nil?
+              response = Response.new(nil, 404)
+            else
+              response = Response.new(match.to_hash.to_xml(:root => model_class.to_s))
+            end
+          else
+            # query contains params
+            params = {}
+            CGI::parse($2[1,$2.size]).each do |key, value|
+              params[key.to_sym] = value.first
+            end
+            items = entries_to_valid_array(model_class.find(params).entries)
+            response = Response.new(items.to_xml(:root => model_class.to_s))
+          end
+          self.class.responses << response
+          response
+        end
+      end
+    end
+
+    private
+    def dynamic_model_regexp model # :nodoc:
+      /\/#{model.to_s.underscore.pluralize}(\/\d+)?\.xml(\?.*)?/
+    end
+
+    def entries_to_valid_array entries# :nodoc:
+      entries.sort{|a,b| a.id.to_i <=> b.id.to_i}.map{|i| i.to_hash}
+    end
+  end
+end

data/lib/active_resource_test_helper/factory.rb

@@ -0,0 +1,37 @@
+require 'ohm'
+
+# Adds a new type of factory to factory_girl[http://github.com/thoughtbot/factory_girl].
+class Factory
+  # Define a new factory to use inside of ActiveRecord tests.
+  # Uses the same syntax of factory_girl[http://github.com/thoughtbot/factory_girl].
+  def self.define_active_resource_factory name, options = {}, &definition
+    raise "no block given" unless block_given?
+
+    Factory.define name, options.dup, &definition
+
+    return if options.include? :parent
+    return if options.include?(:class) and const_defined?(options[:class].to_s.camelcase)
+
+    if options.include?(:class) and !const_defined?(options[:class].to_s.camelcase)
+      model_class_name = options[:class].to_s
+    else
+      model_class_name = name.to_s.capitalize
+    end
+
+    Object.module_eval <<-EOE, __FILE__, __LINE__
+      class #{model_class_name} < Ohm::Model
+        index :id
+        alias :save! :save
+      end
+    EOE
+
+    const_get(model_class_name).class_eval do
+      Factory.factories[name].attributes.each do |attr|
+        attribute attr.name.to_sym
+        index attr.name.to_sym
+      end
+    end
+  end
+end
+
+require 'factory_girl'

data/lib/active_resource_test_helper/ohm/model.rb

@@ -0,0 +1,27 @@
+require 'ohm'
+
+module Ohm # :nodoc:
+  # Adds some convenience methods to Ohm::Model[http://github.com/soveran/ohm].
+  class Model
+    # Convert the model to hash.
+    def to_hash
+      hash = {:id => self.id.to_i}
+      self.attributes.each do |attr|
+        hash[attr] = self.send attr
+      end
+      hash
+    end
+
+    # Destroy all instances of this model
+    def self.destroy_all
+      self.all.each do |i|
+        i.delete
+      end
+    end
+
+    # Return the number of instances of this model saved into redis
+    def self.count
+      self.all.size
+    end
+  end
+end

data/test/active_resource_factories_test.rb

@@ -0,0 +1,71 @@
+require 'test_helper'
+
+Factory.define_active_resource_factory(:book) do |b|
+  b.sequence(:author) {|n| "author foo#{n}"}
+  b.sequence(:title) {|n| "title#{n}"}
+  b.sequence(:genre) {|n| "genre #{n}"}
+  b.pages {rand(500) + 30}
+end
+
+Factory.define_active_resource_factory(:fantasy_book, :parent => :book) do |b|
+  b.genre "fantasy"
+  b.pages {rand(500) + 130}
+end
+
+class ActiveResourceFactoriesTest < Test::Unit::TestCase
+  def setup
+    Book.destroy_all
+  end
+
+  def teardown
+    Book.destroy_all
+  end
+
+  def test_factory_should_be_defined
+    assert_not_nil Factory.factory_by_name(:book)
+    assert_not_nil Factory.factory_by_name(:fantasy_book)
+  end
+
+  def test_model_class_should_be_defined
+    assert_nothing_raised do
+      assert_not_nil Book.new
+    end
+    assert_raise NameError do
+      FantasyBook.new
+    end
+  end
+
+  def test_factory_create_works
+    assert Book.all.empty?
+
+    Factory.create(:book)
+    assert_equal 1, Book.all.size
+
+    fbook = Factory.create(:fantasy_book)
+    assert_equal 2, Book.all.size
+
+    assert_equal "fantasy", fbook.genre
+  end
+
+  def test_model_attributes
+    book = Book.new
+    assert(book.attributes.include?(:author))
+    assert(book.attributes.include?(:title))
+    assert(book.attributes.include?(:pages))
+    assert(book.attributes.include?(:genre))
+  end
+
+  def test_model_indices
+    book = Book.new
+    assert(book.indices.include?(:author))
+    assert( book.indices.include?(:title))
+    assert( book.indices.include?(:pages))
+    assert( book.indices.include?(:genre))
+    assert( book.indices.include?(:id))
+  end
+
+  def test_model_has_save!
+    book = Book.new
+    assert( book.methods.include?("save!"))
+  end
+end

data/test/active_resource_http_mock_test.rb

@@ -0,0 +1,67 @@
+require 'test_helper'
+require 'active_resource'
+
+class UserResource < ActiveResource::Base
+  self.site = "http://example.com/"
+  self.element_name = "user"
+end
+
+
+class RemoteUserTest < Test::Unit::TestCase
+  include ActiveResourceTestHelper
+  active_resource_factories :basic_user
+  
+  def setup
+    assert_equal 0, User.count
+    @users = []
+    20.times do |i|
+      @users << Factory.create(:basic_user)
+    end
+  end
+
+  def test_find_by_id
+    @users.each do |expected_user|
+      user = UserResource.find(expected_user.id)
+      assert_not_nil user
+      assert_equal expected_user.id.to_i, user.id
+      assert_equal expected_user.first_name, user.first_name
+    end
+  end
+
+  def test_should_return_404_if_user_does_not_exist
+    assert_raise ActiveResource::ResourceNotFound do
+      UserResource.find(@users.last.id.to_i + 100)
+    end
+  end
+
+  def test_should_get_all_users
+    current_users = UserResource.find(:all)
+    assert_equal current_users.size, @users.size
+  end
+
+  def test_find_first_should_work
+    user = UserResource.find(:first)
+    assert_equal user.id, @users.first.id.to_i
+  end
+
+  def test_find_last_should_work
+    user = UserResource.find(:last)
+    assert_equal user.id, @users.last.id.to_i
+  end
+
+  def test_find_by_param
+    Factory.create(:basic_user, :age => 18, :first_name => "flavio")
+    Factory.create(:basic_user, :age => 28, :first_name => "flavio")
+
+    users = UserResource.find(:all, :params => {:first_name => "flavio"})
+    assert_equal 2, users.size
+
+    users = UserResource.find(:all, :params => {:first_name => "flavio", :age => 18})
+    assert_equal 1, users.size
+    assert_equal "flavio", users.first.first_name
+    assert_equal "18", users.first.age
+
+    users = UserResource.find(:all, :params => {:first_name => "flavio", :age => 68})
+    assert users.empty?
+  end
+end

data/test/active_resource_test_helper_test.rb

@@ -0,0 +1,29 @@
+require 'test_helper'
+
+User.destroy_all
+
+100.times do
+  Factory.create(:basic_user)
+end
+
+if User.count != 100
+  warn("Error: 100 users should have been created")
+  exit(1)
+end
+
+class ActiveResourceTestHelperTest < Test::Unit::TestCase
+  include ActiveResourceTestHelper
+  active_resource_factories :basic_user
+
+  def setup
+    # make sure the User table is empty at the beginning of the test
+    assert_equal 0, User.count
+  end
+
+  def test_create_some_users
+    100.times do
+      Factory.create(:basic_user)
+    end
+    assert_equal 100, User.count
+  end
+end

data/test/factories/user_factory.rb

@@ -0,0 +1,10 @@
+require 'test_helper'
+
+Factory.define_active_resource_factory(:basic_user, :class => "User") do |u|
+  u.sequence(:first_name) {|n| "first_name#{n}"}
+  u.sequence(:last_name) {|n| "last_name#{n}"}
+  u.admin false
+  u.email {|u| "#{u.first_name}.#{u.last_name}@example.com" }
+  u.age {rand(30) + 18}
+  #u.association :pet, :factory => :pet
+end

data/test/ohm_model_changes_test.rb

@@ -0,0 +1,33 @@
+require 'test_helper'
+
+class Dog < Ohm::Model
+  attribute :name
+  attribute :breed
+end
+
+class OhmModelChangesTest < Test::Unit::TestCase
+  def setup
+    Dog.destroy_all
+  end
+
+  def teardown
+    Dog.destroy_all
+  end
+
+  def test_to_hash
+    my_dog = Dog.new(:name => "Baguette", :breed => "Dachshund").save
+
+    expected = {:breed=>"Dachshund", :name=>"Baguette", :id=>my_dog.id.to_i}
+
+    assert_equal expected, my_dog.to_hash
+  end
+
+  def test_destroy_all
+    101.times do |i|
+      Dog.new(:name => "puppy #{i}", :breed => "Dalmatian").save
+    end
+    assert_equal 101, Dog.count
+    Dog.destroy_all
+    assert_equal 0, Dog.count
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+require 'test/unit'
+
+require  File.expand_path(File.join(File.dirname(__FILE__),
+                          '..', 'lib', 'active_resource_test_helper'))

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification 
+name: active_resource_test_helper
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Flavio Castelli
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-14 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: factory_girl
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: redis
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.4
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: ohm
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.0.35
+    version: 
+description: "active_resource_test_helper makes it easier to use ActiveResouce::HttpMock.\n                      Instead of declaring manually all the request-response pairs,\n                      it\xE2\x80\x99s possible to use dynamically generated contents.\n                      These contents are defined using factory_girl and are\n                      stored into a Redis database using ohm."
+email: flavio@castelli.name
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/active_resource_test_helper.rb
+- lib/active_resource_test_helper/active_resource/http_mock.rb
+- lib/active_resource_test_helper/factory.rb
+- lib/active_resource_test_helper/ohm/model.rb
+- test/active_resource_factories_test.rb
+- test/active_resource_http_mock_test.rb
+- test/active_resource_test_helper_test.rb
+- test/factories/user_factory.rb
+- test/ohm_model_changes_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/flavio/active_resource_test_helper
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: ActiveResource test helper.
+test_files: 
+- test/active_resource_test_helper_test.rb
+- test/ohm_model_changes_test.rb
+- test/active_resource_factories_test.rb
+- test/active_resource_http_mock_test.rb