fakery 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e8e4c5473cf03a8d6eb710c2d1ef96b6a8e7d9bd
-  data.tar.gz: 0051eeef94e885f4749b8e35870deb19594216ae
+  metadata.gz: f630e9880038c8ff0252674f3e1e5d267ad6a451
+  data.tar.gz: 3eab8b25954c9f99ea05fadada60ecfb05f90739
 SHA512:
-  metadata.gz: e9be7034c965974049b538554c2d9fed42b1844f24f77ee9c5a9fd7f3cf3c8efac1ce604e0460bf8d37b6bb8a1ea071569a96f0a92a36f191b1a9fb0a63ebbd3
-  data.tar.gz: 9f92a50048ca5ae55cb15697e3f2b52fe553163291301135ff2be1108f3c7dc9f860e7c2f01d6c57351c477db29fb337433ef749d117113ba49b432e5fd1d87e
+  metadata.gz: 457ae54f67b5f7f3733806826e85a100a08316c7e5625161be618b9ca0d2fc7d28c10a7e3c677c18d4a592019713577e6af8822cc0de81f5dba2f14f52d18703
+  data.tar.gz: 62f2cc100df0abda68408c5e667059f45ce2aad92a4325781b91bbc266c27ffc109b6b46c52b15e28730efb3bf8ae765e2cf8f0b13b43e78f5c9df090c30659a

data/README.md

@@ -1,12 +1,46 @@
-fakery
-======
+# fakery
+
+## Descripton
 
-Descripton
-----------
 Faking Ruby objects from JSON API responses
 
-Badges
-------
+## Usage
+
+### Registering fakes
+
+Automatically register all fakes stored in JSON files under their respective
+filenames:
+
+    require 'fakery'
+    Fakery.register_files Dir[Rails.root + 'spec/support/fakes/*.json']
+
+### Building fakes
+
+`Fakery.build(:foo)` now builds a fake object for the file named `foo.json` in
+the the `spec/support/fakes` directory. `Fakery.build(:foo, with: { bar:
+"something" })` builds the fake with its `bar` attribute set to the string
+`"something"`.
+
+For integration testing of services you can stub an API response with
+`Fakery.build(:the_response).to_json` for your specs.
+
+### Instantiate objects with fake data
+
+`Fakery.instance(:foo, as: TheModel)` instantiates the model TheModel with the
+fake's data by passing it as a hash to the model's constructor.
+`Fakery.instance(:foo, as: TheModel, with: { bar: "something" })` does the same
+with the instances `bar` attribute set to the string `"something"`.
+
+### Seeding fake data from API endpoints
+
+`Fakery.seed('http://api.example.com/foo/bar.json')` returns a fake initialized
+from the URL's JSON content.
+`Fakery.seed('http://api.example.com/foo/bar.json', register: :foo_bar)` also
+registers the fake with the name `foo_bar`.
+`Fakery.reseed(:foo_bar)` then reseeds the fake named `foo_bar` from the same
+URL.
+
+## Badges
 
 [![Build Status](https://travis-ci.org/betterplace/fakery.svg?branch=master)](https://travis-ci.org/betterplace/fakery)
 [![Code Climate](https://codeclimate.com/github/betterplace/fakery.png)](https://codeclimate.com/github/betterplace/fakery)

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.4.0

data/fakery.gemspec

@@ -1,18 +1,18 @@
 # -*- encoding: utf-8 -*-
-# stub: fakery 0.3.1 ruby lib
+# stub: fakery 0.4.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "fakery"
-  s.version = "0.3.1"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["betterplace Developers"]
-  s.date = "2016-06-01"
+  s.date = "2016-06-06"
   s.description = "This library fakes ruby objects from JSON API responses for testing purposes."
   s.email = "developers@betterplace.org"
-  s.extra_rdoc_files = ["README.md", "lib/fakery.rb", "lib/fakery/api.rb", "lib/fakery/api_error.rb", "lib/fakery/change.rb", "lib/fakery/fake.rb", "lib/fakery/fakery_error.rb", "lib/fakery/registry.rb", "lib/fakery/seeding.rb", "lib/fakery/version.rb", "lib/fakery/wrapping.rb"]
-  s.files = [".gitignore", ".rspec", ".travis.yml", "Gemfile", "LICENSE", "README.md", "Rakefile", "TODO.md", "VERSION", "fakery.gemspec", "lib/fakery.rb", "lib/fakery/api.rb", "lib/fakery/api_error.rb", "lib/fakery/change.rb", "lib/fakery/fake.rb", "lib/fakery/fakery_error.rb", "lib/fakery/registry.rb", "lib/fakery/seeding.rb", "lib/fakery/version.rb", "lib/fakery/wrapping.rb", "spec/api_spec.rb", "spec/change_spec.rb", "spec/fake_spec.rb", "spec/registry_spec.rb", "spec/seeding_spec.rb", "spec/spec_helper.rb", "spec/wrapping_spec.rb"]
+  s.extra_rdoc_files = ["README.md", "lib/fakery.rb", "lib/fakery/api.rb", "lib/fakery/api_error.rb", "lib/fakery/change.rb", "lib/fakery/fake.rb", "lib/fakery/fakery_error.rb", "lib/fakery/registry.rb", "lib/fakery/seeding.rb", "lib/fakery/state_error.rb", "lib/fakery/version.rb", "lib/fakery/wrapping.rb"]
+  s.files = [".gitignore", ".rspec", ".travis.yml", "Gemfile", "LICENSE", "README.md", "Rakefile", "TODO.md", "VERSION", "fakery.gemspec", "lib/fakery.rb", "lib/fakery/api.rb", "lib/fakery/api_error.rb", "lib/fakery/change.rb", "lib/fakery/fake.rb", "lib/fakery/fakery_error.rb", "lib/fakery/registry.rb", "lib/fakery/seeding.rb", "lib/fakery/state_error.rb", "lib/fakery/version.rb", "lib/fakery/wrapping.rb", "spec/api_spec.rb", "spec/change_spec.rb", "spec/fake_spec.rb", "spec/registry_spec.rb", "spec/seeding_spec.rb", "spec/spec_helper.rb", "spec/wrapping_spec.rb"]
   s.homepage = "http://github.com/betterplace/fakery"
   s.licenses = ["Apache-2.0"]
   s.rdoc_options = ["--title", "Fakery -- ", "--main", "README.md"]

data/lib/fakery.rb

@@ -9,6 +9,7 @@ module Fakery
   require 'fakery/version'
   require 'fakery/fakery_error'
   require 'fakery/api_error'
+  require 'fakery/state_error'
   require 'fakery/api'
   require 'fakery/change'
   require 'fakery/fake'
@@ -19,8 +20,7 @@ module Fakery
   class << self
     extend Forwardable
 
-    def_delegators :'Fakery::Registry', :register, :registered?, :build,
-      :source, :register_files
+    def_delegators :'Fakery::Registry', :register, :registered?, :build, :register_files
 
     def_delegators :'Fakery::Seeding', :seed, :reseed
 

data/lib/fakery/api.rb

@@ -3,7 +3,7 @@ module Fakery::Api
 
   # Get a http response from +url+ with parameters +params+.
   def get_response(url, params: {})
-    Typhoeus.get(url, params: params)
+    Typhoeus.get(url, params: params, followlocation: true)
   end
 
   # Get the +url+ and parse the response body into a Fakery::Fake object. If

data/lib/fakery/fake.rb

@@ -58,6 +58,8 @@ class Fakery::Fake < JSON::GenericObject
   end
 
   def reseed
+    __api_seed_url__.nil? and raise Fakery::StateError,
+      'reseeding not possible, this fake was not originally seeded'
     myself = self
     self.class.from_hash(Fakery::Api.get(__api_seed_url__)).instance_eval do
       self.__api_seed_url__ = myself.__api_seed_url__
@@ -68,15 +70,6 @@ class Fakery::Fake < JSON::GenericObject
     myself
   end
 
-  def register_as_ruby(register_name)
-    register_name = register_name.to_sym
-    <<EOT
-Fakery.register(#{register_name.inspect}, %{
-#{JSON.pretty_generate(self).gsub(/^/, '  ')}
-})
-EOT
-  end
-
   def initialize_copy(other)
     other.instance_variable_set :@changes, @changes.dup
     super

data/lib/fakery/registry.rb

@@ -6,6 +6,10 @@ module Fakery::Registry
   end
   private :registered_fakes
 
+  def list
+    registered_fakes.keys
+  end
+
   # Clear all registered fakes.
   def clear
     registered_fakes.clear
@@ -28,6 +32,7 @@ module Fakery::Registry
     registered_fakes[register_name] = Fakery::Fake.cast(fake)
   end
 
+  # Register all +files+ as fakes with their filename as their name.
   def register_files(*files)
     files = files.flatten
     puts "Registering fakes…"
@@ -52,10 +57,4 @@ module Fakery::Registry
   rescue KeyError
     raise ArgumentError, "no fake registered under the name #{register_name.inspect}"
   end
-
-  # Returns the ruby source to register +fake+ under the +name+.
-  def source(name, fake)
-    fake = Fakery::Fake.cast(fake)
-    fake.__send__(:register_as_ruby, name)
-  end
 end

data/lib/fakery/seeding.rb

@@ -1,14 +1,30 @@
 module Fakery::Seeding
   module_function
 
-  # TODO
-  def seed(api_seed_url)
-    Fakery::Fake.seed_from_url(api_seed_url)
+  # Seed a fake from the JSON returned by +api_seed_url+. If a name was passed
+  # via +register+ option the fake is registered under that name.
+  def seed(api_seed_url, register: nil)
+    fake = Fakery::Fake.seed_from_url(api_seed_url)
+    register and Fakery::Registry.register register, fake
+    fake
   end
 
-  # TODO
-  def reseed(fake, url = nil)
+  # Reseed the fake (also the name of a registered fake) given as  +fake+ from
+  # its original +api_seed_url+ or from the URL passed as +url+ option. If the
+  # +register+ option is true and the fake was registered the newly seeded fake
+  # will be registered under its original name again. If +register+ was a name
+  # this name will be used instead.
+  def reseed(fake, url: nil, register: true)
+    if register == true
+      if Fakery::Registry.registered?(fake)
+        register = fake
+      else
+        register = nil
+      end
+    end
+    fake = Fakery::Fake.cast(fake)
     url and fake.__api_seed_url__ = url
+    register and Fakery::Registry.register register, fake
     fake.__send__(:reseed)
   end
 end

data/lib/fakery/state_error.rb

@@ -0,0 +1,2 @@
+class Fakery::StateError < Fakery::FakeryError
+end

data/lib/fakery/version.rb

@@ -1,6 +1,6 @@
 module Fakery
   # Fakery version
-  VERSION         = '0.3.1'
+  VERSION         = '0.4.0'
   VERSION_ARRAY   = VERSION.split('.').map(&:to_i) # :nodoc:
   VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
   VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:

data/spec/fake_spec.rb

@@ -49,15 +49,6 @@ describe Fakery::Fake do
     expect(fake.name).to eq 'foo'
   end
 
-  it 'can output ruby code for registration in the Fake::Registry' do
-    string = Fakery.source(:my_name, fake)
-    expect(string).to be_a String
-    expect(Fakery).to_not be_registered :my_name
-    eval(string)
-    expect(Fakery).to be_registered :my_name
-    expect(Fakery.build(:my_name).name).to eq 'foo'
-  end
-
   context 'casting' do
     it 'casts to itself' do
       casted = Fakery::Fake.cast(fake)
@@ -66,7 +57,6 @@ describe Fakery::Fake do
     end
 
     it 'casts from a name to a registered fake' do
-      Fakery.register(:foo, fake)
       casted = Fakery::Fake.cast(:foo)
       expect(casted).to be_a Fakery::Fake
       expect(casted.name).to eq 'foo'

data/spec/registry_spec.rb

@@ -14,7 +14,7 @@ describe Fakery::Registry do
   end
 
   it 'warns iff a fake was registered a second time' do
-    expect(Fakery::Registry).to receive(:warn).with(any_args).and_call_original
+    expect(Fakery::Registry).to receive(:warn).with(any_args)
     Fakery.register 'foo', fake
     Fakery.register 'foo', fake
   end
@@ -46,5 +46,9 @@ describe Fakery::Registry do
       Fakery.register(:bar, foo)
       expect(Fakery.build(:bar).bar).to eq true
     end
+
+    it 'can be listed' do
+      expect(Fakery::Registry.list).to eq %i[ foo ]
+    end
   end
 end

data/spec/seeding_spec.rb

@@ -5,24 +5,59 @@ describe Fakery::Seeding do
     Fakery::Fake.from_hash(name: 'foo')
   end
 
+  let :another_fake do
+    f = fake.dup
+    f.name = 'bar'
+    f
+  end
+
+  before do
+    expect(Fakery::Api).to receive(:get).and_return(another_fake)
+  end
+
   it 'can be seeded from an URL' do
     url = 'http://api.some.where/foo.json'
-    another_fake = fake.dup
-    another_fake.name = 'bar'
-    expect(Fakery::Api).to receive(:get).and_return(another_fake)
     fake = Fakery.seed url
     expect(fake.name).to eq another_fake.name
     expect(fake.__api_seed_url__).to eq url
   end
 
-  it 'can be reseeded from an URL' do
+  it 'can be seeded from an URL and registered' do
+    url = 'http://api.some.where/foo.json'
+    fake = Fakery.seed url, register: :foo
+    expect(Fakery.build(:foo).name).to eq another_fake.name
+    expect(Fakery.build(:foo).__api_seed_url__).to eq url
+  end
+
+  it 'can be reseeded from its original URL' do
     url = 'http://api.some.where/foo.json'
-    another_fake = fake.dup
-    another_fake.name = 'bar'
     fake.__api_seed_url__ = url
-    expect(Fakery::Api).to receive(:get).and_return(another_fake)
     Fakery.reseed(fake)
     expect(fake.name).to eq another_fake.name
     expect(fake.__api_seed_url__).to eq url
   end
+
+  it 'can be reseeded from an URL' do
+    url = 'http://api.some.where/foo.json'
+    Fakery.reseed(fake, url: url)
+    expect(fake.name).to eq another_fake.name
+    expect(fake.__api_seed_url__).to eq url
+  end
+
+  it 'can be reseeded from an URL and registered' do
+    url = 'http://api.some.where/foo.json'
+    fake.__api_seed_url__ = url
+    Fakery.reseed(fake, register: :foo)
+    expect(Fakery.build(:foo).name).to eq another_fake.name
+    expect(Fakery.build(:foo).__api_seed_url__).to eq url
+  end
+
+  it 'can be reseeded from an URL and registered under its previous name' do
+    url = 'http://api.some.where/foo.json'
+    Fakery.register :foo, fake
+    expect(Fakery.build(:foo).name).to eq fake.name
+    expect(Fakery::Registry).to receive(:warn).with(any_args)
+    Fakery.reseed(:foo, url: url, register: true)
+    expect(Fakery.build(:foo).name).to eq another_fake.name
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fakery
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - betterplace Developers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-01 00:00:00.000000000 Z
+date: 2016-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_hadar
@@ -150,6 +150,7 @@ extra_rdoc_files:
 - lib/fakery/fakery_error.rb
 - lib/fakery/registry.rb
 - lib/fakery/seeding.rb
+- lib/fakery/state_error.rb
 - lib/fakery/version.rb
 - lib/fakery/wrapping.rb
 files:
@@ -171,6 +172,7 @@ files:
 - lib/fakery/fakery_error.rb
 - lib/fakery/registry.rb
 - lib/fakery/seeding.rb
+- lib/fakery/state_error.rb
 - lib/fakery/version.rb
 - lib/fakery/wrapping.rb
 - spec/api_spec.rb