factory_girl-remote_api 0.3.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Julian Tescher
+
+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.md

@@ -0,0 +1,168 @@
+# FactoryGirl::RemoteApi
+
+Simply creates an HTTP API for your FactoryGirl factories to be used by client tests.
+
+Tested against ruby-head, ruby 2.0.0, ruby 1.9.3,  jruby-19mode, jruby-head, and rbx-19mode
+
+[![Build Status](https://travis-ci.org/jtescher/factory_girl-remote_api.png?branch=master)]
+(https://travis-ci.org/jtescher/factory_girl-remote_api)
+[![Code Climate](https://codeclimate.com/github/jtescher/factory_girl-remote_api.png)]
+(https://codeclimate.com/github/jtescher/factory_girl-remote_api)
+[![Dependency Status](https://gemnasium.com/jtescher/factory_girl-remote_api.png)]
+(https://gemnasium.com/jtescher/factory_girl-remote_api)
+[![Coverage Status](https://coveralls.io/repos/jtescher/factory_girl-remote_api/badge.png)]
+(https://coveralls.io/r/jtescher/factory_girl-remote_api)
+
+
+##Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'factory_girl-remote_api', '~> 0.2.1'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install factory_girl-remote_api
+```
+
+Then mount as an engine in your config/routes.rb file.
+```ruby
+Rails.application.routes.draw do
+  ...
+  mount FactoryGirl::RemoteApi::Engine => '/factories' if Rails.env.test?
+  ...
+end
+```
+
+
+## Usage
+
+First install [FactoryGirl](https://github.com/thoughtbot/factory_girl) and create some
+[factories](https://github.com/thoughtbot/factory_girl/wiki/Usage).
+
+To use with a client application, start rails in the `test` environment
+(or whichever environment has the engine mounted).
+```bash
+$ rails server -e test
+```
+
+Then any FactoryGirl factories you have defined will be available at `/mount_path/:factory_name`
+
+### Example
+
+A user factory in spec/factories/users.rb:
+```ruby
+FactoryGirl.define do
+  factory :user do
+    first_name 'John'
+    last_name  'Doe'
+  end
+end
+```
+
+And FactoryGirl::RemoteApi mounted at /factories:
+```ruby
+Rails.application.routes.draw do
+  mount FactoryGirl::RemoteApi::Engine => '/factories' if Rails.env.test?
+end
+```
+
+Will make the created user available via any client:
+```bash
+$ curl http://localhost:3000/factories/user?user[first_name]=John&user[last_name]=Doe
+{
+  "created_at": "2013-06-07T23:02:32Z",
+  "first_name": "John",
+  "id": 1,
+  "last_name": "Doe",
+  "updated_at": "2013-06-07T23:02:32Z"
+}
+```
+
+And attributes for the user without creating it:
+```bash
+$ curl http://localhost:3000/factories/attributes_for/user?user[first_name]=John
+{
+  "first_name": "John",
+  "last_name": "FactoryDefaultLastName",
+}
+```
+
+## Usage (As Client)
+
+FactoryGirl::RemoteApi can also be used between rails servers by the client rails app.
+First install the gem (You don't have to mount the engine in routes.rb)
+
+Then configure the server URL (if different than localhost:3000/factories) in
+`spec/support/factory_girl-remote_api.rb`
+
+```ruby
+FactoryGirl::RemoteApi.configure do |config|
+  config.server_url = 'http://localhost:3001'  # Default: http://localhost:3000
+  config.server_mount_path = '/remote_models'  # Default: /factories
+end
+```
+
+Then you can create records on the server rails app during tests by includeing the following in your test files:
+
+```ruby
+it 'Does something with a model that is persisted on the server' do
+   user = FactoryGirl::RemoteApi.create(:user)
+   user.id #=> 1
+   user.first_name #=> "Tom"
+   user.last_name #=> "Smith"
+   ...
+end
+```
+
+And you can build records on the client rails app during tests by includeing the following in your test files:
+
+```ruby
+it 'Does something with a model that is persisted on the server' do
+   user = FactoryGirl::RemoteApi.build(:user)
+   user.id #=> nil
+   user.first_name #=> "Tom"
+   user.last_name #=> "Smith"
+   ...
+end
+```
+
+And you can get attributes for models defined in factories on the server as well:
+
+```ruby
+it 'Does something with attributes of a model that are not persisted on the server' do
+   user_attributes = FactoryGirl::RemoteApi.attributes_for(:user, first_name: 'John')
+   user_attributes[:id] #=> nil
+   user_attributes[:first_name] #=> "John"
+   user_attributes[:last_name] #=> "Smith"
+   ...
+end
+```
+
+It is also possible to create or get attributes of a child factory:
+
+ ```ruby
+ it 'Does something with attributes of a child factory' do
+    user_attributes = FactoryGirl::RemoteApi.attributes_for(:expired_user, parent_factory: 'user')
+    user_attributes[:id] #=> nil
+    user_attributes[:first_name] #=> "John"
+    user_attributes[:last_name] #=> "Smith"
+    ...
+ end
+ ```
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,58 @@
+#!/usr/bin/env rake
+
+require 'appraisal'
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'FactoryGirl::RemoteApi'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'rspec/core'
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(spec: %w[app:db:migrate app:db:test:prepare])
+rescue LoadError
+  desc 'spec rake task not available (rspec not installed)'
+  task :spec do
+    abort 'Spec rake task is not available. Be sure to install rspec as gem.'
+  end
+end
+
+# Find the right dummy Rakefile to load. If in appraisal, use that version of dummy Rails, else default to 3.2.
+rails_minor_version = if ENV['BUNDLE_GEMFILE'] =~ /gemfiles/
+                        ENV['BUNDLE_GEMFILE'].split('/').last.scan(/(\d).(\d)/).join
+                      else
+                        '32'
+                      end
+APP_RAKEFILE = File.expand_path("../spec/dummy_#{rails_minor_version}/Rakefile", __FILE__)
+
+# Ensure the dummy app is in the test environment
+ENV['RAILS_ENV'] ||= 'test'
+
+# Stop Rails from resetting the BUNDLE_GEMFILE env variable on load.
+old_bundle_gemfile = ENV['BUNDLE_GEMFILE']
+load 'rails/tasks/engine.rake'
+ENV['BUNDLE_GEMFILE'] = old_bundle_gemfile
+
+# Load all tasks
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
+
+Bundler::GemHelper.install_tasks
+
+task default: :spec

data/app/assets/javascripts/factory_girl-remote_api/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require_tree .

data/app/assets/stylesheets/factory_girl-remote_api/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/controllers/factory_girl/remote_api/application_controller.rb

@@ -0,0 +1,6 @@
+module FactoryGirl
+  module RemoteApi
+    class ApplicationController < ActionController::Base
+    end
+  end
+end

data/app/controllers/factory_girl/remote_api/factories_controller.rb

@@ -0,0 +1,24 @@
+module FactoryGirl
+  module RemoteApi
+    class FactoriesController < FactoryGirl::RemoteApi::ApplicationController
+      respond_to :json
+
+      def create
+        @model = FactoryGirl.create(params[:factory], factory_attributes)
+        respond_with @model
+      end
+
+      def show
+        @model = FactoryGirl.attributes_for(params[:factory], factory_attributes)
+        respond_with @model
+      end
+
+    private
+
+      def factory_attributes
+        params[params[:factory]].try(:except, :parent_factory)
+      end
+
+    end
+  end
+end

data/app/helpers/factory_girl/remote_api/application_helper.rb

@@ -0,0 +1,4 @@
+module FactoryGirl::RemoteApi
+  module ApplicationHelper
+  end
+end

data/app/views/layouts/factory_girl/remote_api/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>FactoryGirl::RemoteApi</title>
+  <%= stylesheet_link_tag    "factory_girl/remote_api/application", :media => "all" %>
+  <%= javascript_include_tag "factory_girl/remote_api/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,4 @@
+FactoryGirl::RemoteApi::Engine.routes.draw do
+  get ':factory_method/:factory' => 'factories#show', defaults: { format: :json }
+  match ':factory' => 'factories#create', via: [:get, :post], defaults: { format: :json }
+end

data/lib/factory_girl/remote_api/configuration.rb

@@ -0,0 +1,21 @@
+module FactoryGirl
+  module RemoteApi
+    class Configuration
+      attr_reader :server_url, :server_mount_path
+
+      def initialize
+        @server_url = 'http://localhost:3000'
+        @server_mount_path = '/factories'
+      end
+
+      def server_url=(server_url)
+        @server_url = server_url.gsub(/\/$/, '')
+      end
+
+      def server_mount_path=(server_mount_path)
+        @server_mount_path = "/#{server_mount_path}".squeeze('/').gsub(/\/+\Z/, '')
+      end
+
+    end
+  end
+end

data/lib/factory_girl/remote_api/engine.rb

@@ -0,0 +1,14 @@
+module FactoryGirl
+  module RemoteApi
+    class Engine < ::Rails::Engine
+      isolate_namespace FactoryGirl::RemoteApi
+
+      config.generators do |g|
+        g.test_framework :rspec, fixture: false
+        g.fixture_replacement :factory_girl, dir: 'spec/factories'
+        g.assets false
+        g.helper false
+      end
+    end
+  end
+end

data/lib/factory_girl/remote_api/remote_factory.rb

@@ -0,0 +1,31 @@
+require 'factory_girl/remote_api/request'
+
+module FactoryGirl
+  module RemoteApi
+    class RemoteFactory
+
+      def self.model_from(factory_method, factory, attributes)
+        final_attributes = FactoryGirl::RemoteApi::Request.new.get_response_for(factory_method, factory, attributes)
+        new.instantiate_model(final_attributes, factory, attributes)
+      end
+
+      def instantiate_model(final_attributes, factory, attributes)
+        model_instance = model_class(factory, attributes).new
+        apply_attributes_to_instance(final_attributes, model_instance)
+        model_instance
+      end
+
+    private
+
+      def model_class(factory, attributes)
+        class_name = attributes[:parent_factory] || factory.to_s
+        class_name.camelize.constantize
+      end
+
+      def apply_attributes_to_instance(attributes, model_instance)
+        attributes.each { |attr_name, attr_value| model_instance.public_send("#{attr_name}=", attr_value) }
+      end
+
+    end
+  end
+end

data/lib/factory_girl/remote_api/request.rb

@@ -0,0 +1,40 @@
+require 'net/http'
+require 'json'
+
+module FactoryGirl
+  module RemoteApi
+    class Request
+
+      def get_response_for(factory_method, factory, attributes)
+        uri = uri_for(factory_method, factory)
+        uri.query = attributes_as_query(factory, attributes)
+        parsed_response(Net::HTTP.get_response(uri).body, attributes[:parent_factory] || factory.to_s)
+      end
+
+    private
+
+      def uri_for(factory_method, factory)
+        factories_path = "#{configuration.server_url}#{configuration.server_mount_path}"
+        factories_path << "/#{factory_method}" if factory_method != :create
+        factories_path << "/#{factory}"
+        URI(factories_path)
+      end
+
+      def configuration
+        FactoryGirl::RemoteApi.configuration
+      end
+
+      def attributes_as_query(factory, attributes)
+        attributes = { factory.to_sym => attributes } if attributes != {}
+        attributes.to_query
+      end
+
+      def parsed_response(response_body, json_root)
+        response_json = JSON.parse(response_body)
+        attributes = response_json.key?(json_root) ? response_json[json_root] : response_json
+        attributes.with_indifferent_access
+      end
+
+    end
+  end
+end

data/lib/factory_girl/remote_api/version.rb

@@ -0,0 +1,5 @@
+module FactoryGirl
+  module RemoteApi
+    VERSION = '0.3.0'
+  end
+end

data/lib/factory_girl/remote_api.rb

@@ -0,0 +1,35 @@
+require 'factory_girl'
+require 'factory_girl_rails'
+require 'factory_girl/remote_api/engine'
+require 'factory_girl/remote_api/configuration'
+require 'factory_girl/remote_api/remote_factory'
+
+module FactoryGirl
+  module RemoteApi
+
+    def self.configure
+      yield configuration if block_given?
+    end
+
+    def self.configuration
+      @configuration ||= FactoryGirl::RemoteApi::Configuration.new
+    end
+
+    def self.reset_configuration
+      @configuration = nil
+    end
+
+    def self.create(factory, attributes = {})
+      FactoryGirl::RemoteApi::RemoteFactory.model_from(:create, factory, attributes)
+    end
+
+    def self.build(factory, attributes = {})
+      FactoryGirl::RemoteApi::RemoteFactory.model_from(:build, factory, attributes)
+    end
+
+    def self.attributes_for(factory, attributes = {})
+      FactoryGirl::RemoteApi::Request.new.get_response_for(:attributes_for, factory, attributes)
+    end
+
+  end
+end

data/spec/dummy_31/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/spec/dummy_31/app/assets/javascripts/application.js

@@ -0,0 +1,9 @@
+// This is a manifest file that'll be compiled into including all the files listed below.
+// Add new JavaScript/Coffee code in separate files in this directory and they'll automatically
+// be included in the compiled file accessible from http://example.com/assets/application.js
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/spec/dummy_31/app/assets/stylesheets/application.css

@@ -0,0 +1,7 @@
+/*
+ * This is a manifest file that'll automatically include all the stylesheets available in this directory
+ * and any sub-directories. You're free to add application-wide styles to this file and they'll appear at
+ * the top of the compiled file, but it's generally better to create a new file per style scope.
+ *= require_self
+ *= require_tree . 
+*/

data/spec/dummy_31/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/spec/dummy_31/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy_31/app/models/user.rb

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+  attr_accessible :first_name, :last_name
+end

data/spec/dummy_31/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application" %>
+  <%= javascript_include_tag "application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy_31/config/application.rb

@@ -0,0 +1,45 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require
+require "factory_girl/remote_api"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+
+    # Enable the asset pipeline
+    config.assets.enabled = true
+
+    # Version of your assets, change this if you want to expire all your assets
+    config.assets.version = '1.0'
+  end
+end
+

data/spec/dummy_31/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy_31/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/spec/dummy_31/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!

data/spec/dummy_31/config/environments/development.rb

@@ -0,0 +1,30 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # In the development environment your application's code is reloaded on
+  # every request.  This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger
+  config.active_support.deprecation = :log
+
+  # Only use best-standards-support built into browsers
+  config.action_dispatch.best_standards_support = :builtin
+
+  # Do not compress assets
+  config.assets.compress = false
+
+  # Expands the lines which load the assets
+  config.assets.debug = true
+end