factory_girl_remote_strategy 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f47dcf78670bdee4078ffdf889289242a8f702d8
+  data.tar.gz: 21586d574f443b5241782bb89c60a1f8987a868d
+SHA512:
+  metadata.gz: 0989d5b79f3bdd5eb330804cbc486b7932d80c5255c22f403767e7583ef97366527cfef3b932f43bcac5f78efb8e16f0cd4983e8c715485ac7e6b7c12d4da068
+  data.tar.gz: 95a068b0278b69480af3eeab4b9dd7de5fbb457e9c684412a5f98bab630c85c930c80cde726f1d3a57e4981675590268267f39c832c6c49ab8b294b5f6fad12e

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format doc

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in factory_girl_remote_strategy.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Alex Avoyants
+
+MIT License
+
+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,29 @@
+# factory_girl_remote_strategy
+
+FactoryGirl strategy for ActiveResource models.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'factory_girl_remote_strategy'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install factory_girl_remote_strategy
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/shhavel/factory_girl_remote_strategy/fork )
+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,8 @@
+require "bundler/gem_tasks"
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = ["-c", "-f documentation", "-r ./spec/spec_helper.rb"]
+  t.pattern = 'spec/**/*_spec.rb'
+end
+task default: :spec

data/factory_girl_remote_strategy.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "factory_girl_remote_strategy/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "factory_girl_remote_strategy"
+  spec.version       = FactoryGirlRemoteStrategy::VERSION
+  spec.authors       = ["Alex Avoyants"]
+  spec.email         = ["shhavel@gmail.com"]
+  spec.summary       = %q{FactoryGirl strategy for ActiveResource models.}
+  spec.description   = %q{FactoryGirl strategy for ActiveResource models.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", '~> 3.2'
+  spec.add_dependency "activeresource", '~> 3.2'
+  spec.add_dependency "factory_girl"
+  spec.add_dependency "fakeweb"
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/factory_girl_remote_strategy.rb

@@ -0,0 +1,86 @@
+require "active_support/core_ext/module/delegation"
+require "factory_girl"
+require "active_resource"
+##
+# FactoryGirl strategy for remote entities
+#
+# - FactoryGirl.remote(:incident) builds incident and registers get url with FakeWeb;
+# - remote associations are added to response json:
+#     FactoryGirl.remote(:incident, victims: FactoryGirl.remote_list(:victim, 2))
+# - also allows to create has_many association with <assotiation(s)>_ids option:
+#     FactoryGirl.remote(:incident, victim_ids: [2, 3])
+# - belongs_to association id is added to response json:
+#     FactoryGirl.remote(:membership, group: group) # group_id is added to serialized hash
+# - after(:remote) callback in factories.
+#
+module FactoryGirl
+  class RemoteStrategy
+    def initialize
+      @strategy = FactoryGirl.strategy_by_name(:build).new
+    end
+
+    delegate :association, to: :@strategy
+
+    def result(evaluation)
+      @strategy.result(evaluation).tap do |e|
+        FakeWeb.register_uri(:get, self.class.entity_url(e), body: self.class.entity_hash(e).to_json)
+        evaluation.notify(:after_remote, e) # runs after(:remote) callback
+      end
+    end
+
+    class << self
+      def entity_hash(entity)
+        raise ArgumentError, "cann't construct hash for non ActiveResource::Base object" unless entity.is_a?(ActiveResource::Base)
+        attributes = entity.attributes
+        # Set belongs_to <association>_id instead of each <association>.
+        attributes.select { |k, v| v.is_a?(ActiveResource::Base) }.each do |k, v|
+          attributes[:"#{k}_id"] = v.id
+          attributes.delete(k)
+        end
+        # Set has_many <association> instead of each <association(s)>_ids.
+        attributes.map do |k, v|
+          next unless k.to_s =~ /^(\w+)_ids$/ && FactoryGirl.factories.map(&:name).include?(f = $1.singularize.to_sym) && v.is_a?(Array)
+          [k, v, f, $1.pluralize.to_sym]
+        end.compact.each do |k, v, f, r|
+          attributes[r] = v.map { |id| FactoryGirl.remote(f, id: id) }
+          attributes.delete(k)
+        end
+        # Serilaize has_many associations.
+        attributes.each do |k, v|
+          if v.is_a?(Array) && v.first.is_a?(ActiveResource::Base)
+            attributes[k] = v.map { |e| entity_hash(e) }
+          end
+        end
+        { entity.class.element_name => attributes, _metadata: { abilities: %w(update destroy) } }      
+      end
+
+      def entity_url(entity)
+        "#{entity.class.site}#{entity.class.prefix}#{entity.class.collection_name}/#{entity.id}.json"
+      end
+
+      def collection_url(collection)
+        collection.first.class.instance_eval { "#{site}#{prefix}#{collection_name}.json" }
+      end
+    end
+  end
+end
+
+FactoryGirl.register_strategy(:remote, FactoryGirl::RemoteStrategy)
+
+module RemoteStrategySearchHelper
+  ##
+  # Helper method for register search url with provided params and serialized collection as response.
+  #
+  def remote_search(*args)
+    params = args.extract_options!
+    collection = args.flatten
+    FakeWeb.register_uri(:get, "#{FactoryGirl::RemoteStrategy.collection_url(collection)}?#{params.to_query}",
+      body: collection.map { |e| FactoryGirl::RemoteStrategy.entity_hash(e) }.to_json)
+  end
+end
+
+module FactoryGirl::Syntax::Methods
+  include RemoteStrategySearchHelper
+end
+
+FactoryGirl.extend RemoteStrategySearchHelper

data/lib/factory_girl_remote_strategy/version.rb

@@ -0,0 +1,3 @@
+module FactoryGirlRemoteStrategy
+  VERSION = "0.0.1"
+end

data/spec/factories/group.rb

@@ -0,0 +1,5 @@
+FactoryGirl.define do
+  factory :group do
+    sequence(:id)
+  end
+end

data/spec/factories/incident.rb

@@ -0,0 +1,13 @@
+FactoryGirl.define do
+  factory :incident do
+    sequence(:id)
+    victims []
+    reported_by nil
+
+    after(:remote) do |incident, evaluator|
+      if incident.reported_by
+        FactoryGirl.remote(:user, id: incident.reported_by, full_name: 'Reporter Name')
+      end
+    end
+  end
+end

data/spec/factories/membership.rb

@@ -0,0 +1,12 @@
+FactoryGirl.define do
+  factory :membership do
+    sequence(:id)
+    group_id nil
+
+    after(:build) do |membership, evaluator|
+      if !evaluator.group_id && !evaluator.respond_to?(:group)
+        membership.group = FactoryGirl.remote(:group)
+      end
+    end
+  end
+end

data/spec/factories/user.rb

@@ -0,0 +1,5 @@
+FactoryGirl.define do
+  factory :user do
+    sequence(:id)
+  end
+end

data/spec/factories/victim.rb

@@ -0,0 +1,5 @@
+FactoryGirl.define do
+  factory :victim do
+    sequence(:id)
+  end
+end

data/spec/factory_girl_remote_strategy_spec.rb

@@ -0,0 +1,67 @@
+require "spec_helper"
+
+describe FactoryGirl::RemoteStrategy do
+  # - FactoryGirl.remote(:incident) builds incident and registers get url with FakeWeb;
+  # - remote associations are added to response json:
+  #     FactoryGirl.remote(:incident, victims: FactoryGirl.remote_list(:victim, 2))
+  # - also allows to create has_many association with <assotiation(s)>_ids option:
+  #     FactoryGirl.remote(:incident, victim_ids: [2, 3])
+  # - belongs_to association id is added to response json:
+  #     FactoryGirl.remote(:membership, group: group) # group_id is added to serialized hash
+  # - after(:remote) callback in factories.
+  describe "basic usage" do
+    it "builds instance and registers get url with FakeWeb" do
+      FactoryGirl.remote(:incident, id: 1)
+      expect { Incident.find(1) }.not_to raise_error
+      incident = Incident.find(1)
+      incident.should be_kind_of Incident
+    end
+  end
+
+  describe "Associations in JSON response" do
+    let(:victims) { FactoryGirl.remote_list(:victim, 2) }
+    let(:group) { FactoryGirl.remote(:group) }
+
+    it "remote associations are added to response json" do
+      FactoryGirl.remote(:incident, id: 3, victims: victims)
+      incident = Incident.find(3)
+      incident.victims.should be_kind_of Array
+      incident.victims.first.should be_kind_of Victim
+    end
+
+    it "allows to create has_many association with <assotiation(s)>_ids option" do
+      FactoryGirl.remote(:incident, id: 4, victim_ids: [2, 3])
+      incident = Incident.find(4)
+      incident.victims.should be_kind_of Array
+      incident.victims.first.should be_kind_of Victim
+
+      expect { Victim.find(2) }.not_to raise_error
+      victim = Victim.find(2)
+      victim.should eq incident.victims.first
+    end
+
+    it "belongs_to association id is added to response json" do
+      membership = FactoryGirl.remote(:membership, group: group)
+      membership.group_id.should == group.id
+    end
+  end
+
+  describe "after(:remote) callback in factories" do
+    it "invokes after(:remote) callback" do
+      incident = FactoryGirl.remote(:incident, reported_by: 4)
+      expect { User.find(4) }.not_to raise_error
+      user = User.find(4)
+      user.should be_kind_of User
+    end
+  end
+
+  describe "FactoryGirl.remote_search" do
+    it "registers search url with FakeWeb" do
+      remote_search FactoryGirl.remote_list(:membership, 2), search: { premises_id_in: [4] }
+      expect { Membership.find(:all, params: { search: { premises_id_in: [4] } }) }.not_to raise_error
+      memberships = Membership.find(:all, params: { search: { premises_id_in: [4] } })
+      memberships.should be_kind_of Array
+      memberships.first.should be_kind_of Membership
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require "factory_girl_remote_strategy"
+require "fakeweb"
+
+FakeWeb.allow_net_connect = false
+
+FactoryGirl.find_definitions
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].sort.each {|f| require f}
+
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+end

data/spec/support/group.rb

@@ -0,0 +1,9 @@
+require_relative "json_with_metadata_formatter"
+
+class Group < ActiveResource::Base
+  self.element_name = "group"
+  self.collection_name = "groups"
+  self.format = JsonWithMetadataFormatter.new
+  self.site = "http://example.com"
+  self.prefix = "/api/v1/"
+end

data/spec/support/incident.rb

@@ -0,0 +1,9 @@
+require_relative "json_with_metadata_formatter"
+
+class Incident < ActiveResource::Base
+  self.element_name = "incident"
+  self.collection_name = "incidents"
+  self.format = JsonWithMetadataFormatter.new
+  self.site = "http://example.com"
+  self.prefix = "/api/v1/"
+end

data/spec/support/json_with_metadata_formatter.rb

@@ -0,0 +1,42 @@
+class JsonWithMetadataFormatter
+  include ActiveResource::Formats::JsonFormat
+
+  ##
+  # Since usual JSON from Facewatch has multiple root keys, such as object and _metadata
+  #
+  # {
+  #   "incident": {"id": 1, ...},
+  #   "_metadata": {"abilities": ['eat_cookies']}
+  # }
+  #
+  # To be able to get object with its params just after AResObject.find(..), we remove _metadata
+  # root key for now since we do not use it internally in APIs
+  #
+  def decode(json)
+    decoded_json = ActiveSupport::JSON.decode(json)
+    iterate_by_nodes(decoded_json)
+    ActiveResource::Formats.remove_root(decoded_json)
+  end
+
+  def iterate_by_nodes(json)
+    iterate_by_array(json) if json.is_a? Array
+
+    iterate_by_hash(json) if json.is_a? Hash
+  end
+
+  private
+
+  def iterate_by_hash(hash)
+    hash.delete('_metadata')
+
+    hash.each_pair do |k, v|
+      iterate_by_nodes(v)
+    end
+  end
+
+  def iterate_by_array(array)
+    array.each do |item|
+      iterate_by_nodes(item)
+    end
+  end
+end

data/spec/support/membership.rb

@@ -0,0 +1,9 @@
+require_relative "json_with_metadata_formatter"
+
+class Membership < ActiveResource::Base
+  self.element_name = "membership"
+  self.collection_name = "memberships"
+  self.format = JsonWithMetadataFormatter.new
+  self.site = "http://example.com"
+  self.prefix = "/api/v1/"
+end

data/spec/support/user.rb

@@ -0,0 +1,9 @@
+require_relative "json_with_metadata_formatter"
+
+class User < ActiveResource::Base
+  self.element_name = "user"
+  self.collection_name = "users"
+  self.format = JsonWithMetadataFormatter.new
+  self.site = "http://example.com"
+  self.prefix = "/api/v1/"
+end

data/spec/support/victim.rb

@@ -0,0 +1,9 @@
+require_relative "json_with_metadata_formatter"
+
+class Victim < ActiveResource::Base
+  self.element_name = "victim"
+  self.collection_name = "victims"
+  self.format = JsonWithMetadataFormatter.new
+  self.site = "http://example.com"
+  self.prefix = "/api/v1/"
+end

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: factory_girl_remote_strategy
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alex Avoyants
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: activeresource
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: FactoryGirl strategy for ActiveResource models.
+email:
+- shhavel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- factory_girl_remote_strategy.gemspec
+- lib/factory_girl_remote_strategy.rb
+- lib/factory_girl_remote_strategy/version.rb
+- spec/factories/group.rb
+- spec/factories/incident.rb
+- spec/factories/membership.rb
+- spec/factories/user.rb
+- spec/factories/victim.rb
+- spec/factory_girl_remote_strategy_spec.rb
+- spec/spec_helper.rb
+- spec/support/group.rb
+- spec/support/incident.rb
+- spec/support/json_with_metadata_formatter.rb
+- spec/support/membership.rb
+- spec/support/user.rb
+- spec/support/victim.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: FactoryGirl strategy for ActiveResource models.
+test_files:
+- spec/factories/group.rb
+- spec/factories/incident.rb
+- spec/factories/membership.rb
+- spec/factories/user.rb
+- spec/factories/victim.rb
+- spec/factory_girl_remote_strategy_spec.rb
+- spec/spec_helper.rb
+- spec/support/group.rb
+- spec/support/incident.rb
+- spec/support/json_with_metadata_formatter.rb
+- spec/support/membership.rb
+- spec/support/user.rb
+- spec/support/victim.rb