fakery 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 53c31aa787a8c9a059340fa40fbf412a5d863f70
+  data.tar.gz: f2adf0d385e2b3e090a66f1066edd0845d3813c7
+SHA512:
+  metadata.gz: 4871051c30bc49d99887e3360567d62c00c5d5356e254b8d89c3a9c5584b5b330bf47fcbbfc8cfc5f4bd7d4a905d8abad7b0a961844c9d9fcbe61c0688bb96dc
+  data.tar.gz: 36e6ad3ff98d671b51976521786e7a147440d3f656fb55ea8417a5a13c2deb5063872d7690d2d220ee354c9197e855fb88008ec705440999caabee59c3a0f239

data/.gitignore

@@ -0,0 +1,11 @@
+.*.sw[pon]
+.AppleDouble
+.DS_Store
+.ruby-version
+.rvmrc
+.utilsrc
+Gemfile.lock
+coverage
+doc
+pkg
+tags

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--backtrace

data/.travis.yml

@@ -0,0 +1,7 @@
+rvm:
+  - 2.1.5
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+env:
+  - START_SIMPLECOV=1 CODECLIMATE_REPO_TOKEN=af3a05003c763bcee8abfdd7d7c46cc122c02ea09e5a71c3e16cf0a26685a851

data/Gemfile

@@ -0,0 +1,7 @@
+# vim: set filetype=ruby et sw=2 ts=2:
+
+source 'https://rubygems.org'
+
+gemspec
+
+gem "codeclimate-test-reporter", group: :test, require: false

data/LICENSE

@@ -0,0 +1,201 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,12 @@
+fakery
+======
+
+Descripton
+----------
+Faking Ruby objects from JSON API responses
+
+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/Rakefile

@@ -0,0 +1,28 @@
+# vim: set filetype=ruby et sw=2 ts=2:
+
+require 'gem_hadar'
+
+GemHadar do
+  name        'fakery'
+  author      'betterplace Developers'
+  email       'developers@betterplace.org'
+  homepage    "http://github.com/betterplace/#{name}"
+  summary     'Fake Ruby objects from JSON API responses'
+  description "This library fakes ruby objects from JSON API responses for testing purposes."
+  test_dir    'spec'
+  ignore      '.*.sw[pon]', 'pkg', 'Gemfile.lock', 'coverage', '.rvmrc',
+    '.ruby-version', '.AppleDouble', 'tags', '.DS_Store', '.utilsrc', 'doc'
+  readme      'README.md'
+  title       "#{name.camelize} -- "
+
+  dependency 'tins',           '~>1.0'
+  dependency 'term-ansicolor', '~>1.3'
+  dependency 'typhoeus',       '~>1.0'
+  dependency 'json',           '~>1.0'
+  development_dependency 'simplecov'
+  development_dependency 'rspec',     '~>3.0'
+  development_dependency 'rspec-nc'
+  development_dependency 'byebug'
+end
+
+task :default => :spec

data/TODO.md

@@ -0,0 +1,4 @@
+TODO
+====
+
+- Method to build instances of classes based on fakes.

data/VERSION

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

data/fakery.gemspec

@@ -0,0 +1,57 @@
+# -*- encoding: utf-8 -*-
+# stub: fakery 0.1.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "fakery"
+  s.version = "0.1.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-01-28"
+  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.homepage = "http://github.com/betterplace/fakery"
+  s.rdoc_options = ["--title", "Fakery -- ", "--main", "README.md"]
+  s.rubygems_version = "2.5.1"
+  s.summary = "Fake Ruby objects from JSON API responses"
+  s.test_files = ["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"]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<gem_hadar>, ["~> 1.3.1"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 3.0"])
+      s.add_development_dependency(%q<rspec-nc>, [">= 0"])
+      s.add_development_dependency(%q<byebug>, [">= 0"])
+      s.add_runtime_dependency(%q<tins>, ["~> 1.0"])
+      s.add_runtime_dependency(%q<term-ansicolor>, ["~> 1.3"])
+      s.add_runtime_dependency(%q<typhoeus>, ["~> 1.0"])
+      s.add_runtime_dependency(%q<json>, ["~> 1.0"])
+    else
+      s.add_dependency(%q<gem_hadar>, ["~> 1.3.1"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 3.0"])
+      s.add_dependency(%q<rspec-nc>, [">= 0"])
+      s.add_dependency(%q<byebug>, [">= 0"])
+      s.add_dependency(%q<tins>, ["~> 1.0"])
+      s.add_dependency(%q<term-ansicolor>, ["~> 1.3"])
+      s.add_dependency(%q<typhoeus>, ["~> 1.0"])
+      s.add_dependency(%q<json>, ["~> 1.0"])
+    end
+  else
+    s.add_dependency(%q<gem_hadar>, ["~> 1.3.1"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 3.0"])
+    s.add_dependency(%q<rspec-nc>, [">= 0"])
+    s.add_dependency(%q<byebug>, [">= 0"])
+    s.add_dependency(%q<tins>, ["~> 1.0"])
+    s.add_dependency(%q<term-ansicolor>, ["~> 1.3"])
+    s.add_dependency(%q<typhoeus>, ["~> 1.0"])
+    s.add_dependency(%q<json>, ["~> 1.0"])
+  end
+end

data/lib/fakery.rb

@@ -0,0 +1,29 @@
+require 'set'
+require 'tins'
+require 'tins/xt/ask_and_send'
+require 'json'
+require 'typhoeus'
+require 'forwardable'
+
+module Fakery
+  require 'fakery/version'
+  require 'fakery/fakery_error'
+  require 'fakery/api_error'
+  require 'fakery/api'
+  require 'fakery/change'
+  require 'fakery/fake'
+  require 'fakery/registry'
+  require 'fakery/seeding'
+  require 'fakery/wrapping'
+
+  class << self
+    extend Forwardable
+
+    def_delegators :'Fakery::Registry', :register, :registered?, :build,
+      :source
+
+    def_delegators :'Fakery::Seeding', :seed, :reseed
+
+    def_delegators :'Fakery::Wrapping', :http_response, :instance
+  end
+end

data/lib/fakery/api.rb

@@ -0,0 +1,29 @@
+module Fakery::Api
+  module_function
+
+  # Get a http response from +url+ with parameters +params+.
+  def get_response(url, params: {})
+    Typhoeus.get(url, params: params)
+  end
+
+  # Get the +url+ and parse the response body into a Fakery::Fake object. If
+  # this is unsuccessful or an invalid JSON text is returned, this method will
+  # throw a Fakery::ApiError exception.
+  def get(url, params: {})
+    response = get_response(url, params: params)
+    if response.success?
+      JSON.parse response.body, object_class: Fakery::Fake
+    else
+      raise Fakery::ApiError.new(
+        "api responded with http_status=#{response.code} "\
+        "message=#{response.return_message.inspect}",
+        response: response
+      )
+    end
+  rescue JSON::ParserError => e
+    raise Fakery::ApiError.new(
+      "#{e.class}: #{e.message}",
+      response: response
+    )
+  end
+end

data/lib/fakery/api_error.rb

@@ -0,0 +1,8 @@
+class Fakery::ApiError < Fakery::FakeryError
+  def initialize(*args, **opts)
+    super(*args)
+    @response = opts[:response]
+  end
+
+  attr_reader :response
+end

data/lib/fakery/change.rb

@@ -0,0 +1,69 @@
+class Fakery::Change
+  # +name+ is the name of the changed field. +from+ is the original value from
+  # which the field was changed. +to+ is the new value to which the field was
+  # changed. If +added+ is false (default) this is a change from previously set
+  # value, if it's true then this change is a new addition of a field.
+  def initialize(name: nil, from: nil, to: nil, added: false) # TODO remove nil in Ruby 2.1
+    name or raise ArgumentError, 'name keyword argument is required'
+    @name, @from, @to, @added = name, from, to, added
+  end
+
+  attr_reader :name # Name of the changed field.
+
+  attr_reader :from # Original value from which the field was changed.
+
+  attr_reader :to   # New value to which the field was changed.
+
+  # Returns true if the field was newly added with this change.
+  def added?
+    !!@added
+  end
+
+  # Returns a string representation of this change. A change from=nil* is an
+  # addition change as opposed to a regular change from some previous value.
+  def to_s
+    "<#{self.class} name=#{@name.inspect} from=#{@from.inspect}#{?* if @added} to=#{@to.inspect}>"
+  end
+
+  alias inspect to_s
+
+  module Support
+    extend Tins::Concern
+
+    included do
+      singleton_class.class_eval do
+        extend Tins::ThreadLocal
+        thread_local :ignore_changesp
+      end
+    end
+
+    # Record the change to +new_value+ for the field +name+.
+    def record_change(name, new_value)
+      old_value = self[name]
+      if old_value != new_value
+        @changes << Fakery::Change.new(
+          name:  name,
+          from:  old_value,
+          to:    new_value,
+          added: !table.key?(name)
+        )
+      end
+      self
+    end
+
+    module ClassMethods
+      # Return true iff in ignoring changes mode.
+      def ignore_changes?
+        ignore_changesp
+      end
+
+      # Ignore the changes during execution of the yielded block.
+      def ignore_changes
+        old, self.ignore_changesp = ignore_changesp, true
+        yield
+      ensure
+        self.ignore_changesp = old
+      end
+    end
+  end
+end

data/lib/fakery/fake.rb

@@ -0,0 +1,106 @@
+class Fakery::Fake < JSON::GenericObject
+  include Fakery::Change::Support
+
+  class << self
+    def cast(fake)
+      case
+      when self === fake
+        fake
+      when Fakery.registered?(fake)
+        Fakery.build(fake)
+      when fake.respond_to?(:to_hash)
+        from_hash(fake.to_hash)
+      when fake.respond_to?(:read)
+        cast(fake.read)
+      when fake.respond_to?(:to_str)
+        from_json(fake.to_str)
+      when fake.respond_to?(:as_json)
+        from_hash(fake.as_json)
+      else
+        raise ArgumentError, "cannot cast #{fake.inspect}"
+      end
+    end
+
+    def from_hash(*a, &b)
+      ignore_changes { super }
+    end
+
+    def from_json(json)
+       JSON.parse(json, object_class: self)
+    end
+
+    def seed_from_url(api_seed_url)
+      ignore_changes do
+        new.tap do |obj|
+          obj.__api_seed_url__ = api_seed_url
+        end.__send__(:reseed)
+      end
+    end
+  end
+
+  def initialize(*)
+    super
+    @changes = Set[]
+  end
+
+  def as_json(*)
+    to_hash
+  end
+
+  private
+
+  attr_reader :changes
+
+  def http_response(type: :typhoeus, http_status: 200)
+    ::Typhoeus::Response.new(code: http_status, body: JSON(self)).tap do |r|
+      r.ask_and_send(:mock=, true)
+    end
+  end
+
+  def reseed
+    myself = self
+    self.class.from_hash(Fakery::Api.get(__api_seed_url__)).instance_eval do
+      self.__api_seed_url__ = myself.__api_seed_url__
+      for (name, value) in table
+        myself[name] = value
+      end
+    end
+    myself
+  end
+
+  def register_as_ruby(register_name)
+    register_name = register_name.to_sym
+    result = <<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
+  end
+
+  def new_ostruct_member(name)
+    name = name.to_sym
+    # Let's not define any singleton methods for write accessors
+    if name !~ /=\z/
+      define_singleton_method(name) { @table[name] }
+    end
+    name
+  end
+
+  def method_missing(id, *args, &block)
+    if id =~ /=\z/
+      args.size > 1 and
+        raise ArgumentError, "wrong number of arguments (#{len} for 1)", caller(1)
+      name  = $`.to_sym
+      value = args.first
+      self.class.ignore_changes? or record_change(name, value)
+      modifiable[name] = value
+    else
+      super
+    end
+  end
+end

data/lib/fakery/fakery_error.rb

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

data/lib/fakery/registry.rb

@@ -0,0 +1,50 @@
+module Fakery::Registry
+  module_function
+
+  def registered_fakes
+    @registered_fakes ||= {}
+  end
+  private :registered_fakes
+
+  # Clear all registered fakes.
+  def clear
+    registered_fakes.clear
+  end
+
+  # Returns true, if there is a fake registered under name +name+.
+  def registered?(name)
+    name.respond_to?(:to_sym) && registered_fakes.key?(name.to_sym)
+  end
+
+  # Registers +fake+ under name +register_name. (A fake is either a
+  # Fakery::Fake instance or a string containing a JSON representation to be
+  # faked. If a fake was already registered under this name a warning will be
+  # displayed.
+  def register(register_name, fake)
+    register_name = register_name.to_sym
+    if registered?(register_name)
+      warn "WARNING: Overwriting a fake for an already registered name #{register_name.inspect}."
+    end
+    registered_fakes[register_name] = Fakery::Fake.cast(fake)
+  end
+
+  # Builds a the fake registered under the name +register_name+. All its fields
+  # can be changed according to the names and values in the +with+ keyword
+  # argument or later by using setters on the object.
+  def build(register_name, with: {})
+    register_name = register_name.to_sym
+    fake = registered_fakes.fetch(register_name).dup
+    for (name, value) in with
+      fake[name] = value
+    end
+    fake
+  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

@@ -0,0 +1,14 @@
+module Fakery::Seeding
+  module_function
+
+  # TODO
+  def seed(api_seed_url)
+    Fakery::Fake.seed_from_url(api_seed_url)
+  end
+
+  # TODO
+  def reseed(fake, url = nil)
+    url and fake.__api_seed_url__ = url
+    fake.__send__(:reseed)
+  end
+end

data/lib/fakery/version.rb

@@ -0,0 +1,8 @@
+module Fakery
+  # Fakery version
+  VERSION         = '0.1.0'
+  VERSION_ARRAY   = VERSION.split('.').map(&:to_i) # :nodoc:
+  VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
+  VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:
+  VERSION_BUILD   = VERSION_ARRAY[2] # :nodoc:
+end

data/lib/fakery/wrapping.rb

@@ -0,0 +1,18 @@
+module Fakery::Wrapping
+  module_function
+
+  # Return a mocked HTTP response that contains the JSON representation of
+  # +fake+ in its body. This response has the status code +http_status+.
+  def http_response(fake, type: :typhoeus, http_status: 200)
+    fake = Fakery::Fake.cast(fake)
+    fake.__send__(:http_response, type: :typhoeus, http_status: http_status)
+  end
+
+  # Return an instance of class +as+ initialized with the hash representation
+  # of +fake+ (via its constructor).
+  def instance(fake, as: nil) # TODO remove nil in Ruby 2.1
+    as or raise ArgumentError, 'as keyword argument is required'
+    fake = Fakery::Fake.cast(fake)
+    as.new(fake.to_hash)
+  end
+end

data/spec/api_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe Fakery::Api do
+  context JSON::ParserError do
+    before do
+      Typhoeus.stub(/.*/).and_return Typhoeus::Response.new(
+        code: 200, body: '<nix>json</nix>'
+      )
+    end
+
+    it 'wraps it into a Fakery::ApiError' do
+      expect { Fakery::Api.get('http://foo.bar') }.to raise_error Fakery::ApiError
+    end
+
+    it 'has a sensible message' do
+      e = Fakery::Api.get('http://foo.bar') rescue $!
+      expect(e.message).to match "JSON::ParserError"
+      expect(e.message).to match "unexpected token at '<nix>json</nix>'"
+    end
+  end
+
+  context 'unsuccessful response' do
+    before do
+      response = Typhoeus::Response.new(
+        code: 404, body: '{ "dont": "matter" }'
+      )
+      allow(response).to receive(:return_message).and_return('curl describes the problem a bit more')
+      Typhoeus.stub(/.*/).and_return response
+    end
+
+
+    it 'should raise a Fakery::ApiError' do
+      expect { Fakery::Api.get('http://foo.bar') }.to raise_error Fakery::ApiError
+    end
+
+    it 'has a sensible message' do
+      e = Fakery::Api.get('http://foo.bar') rescue $!
+      expect(e.message).to match "api responded with http_status=404 "
+      expect(e.message).to match 'curl describes the problem a bit more'
+    end
+  end
+end
+

data/spec/change_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe Fakery::Change do
+  it 'raises ArgumentError if arguments are missing' do
+    expect { Fakery::Change.new }.to raise_error ArgumentError
+  end
+
+  context 'regular change' do
+    let :change do
+      Fakery::Change.new(name: 'foo', from: nil, to: 23)
+    end
+
+    it 'has nice string representations' do
+      expect(change.to_s).to eq change.inspect
+    end
+
+    it 'supports changes of fields' do
+      expect(change.from).to be_nil
+      expect(change.to).to eq 23
+      expect(change).to_not be_added
+    end
+  end
+
+
+  context 'addition change' do
+    let :change do
+      Fakery::Change.new(name: 'foo', from: nil, to: 23, added: true)
+    end
+
+    it 'has nice string representations' do
+      expect(change.to_s).to eq change.inspect
+    end
+
+    it 'supports changes of fields' do
+      expect(change.from).to be_nil
+      expect(change.to).to eq 23
+      expect(change).to be_added
+    end
+  end
+end

data/spec/fake_spec.rb

@@ -0,0 +1,98 @@
+require 'spec_helper'
+require 'stringio'
+
+describe Fakery::Fake do
+  let! :fake do
+    fake = Fakery::Fake.from_hash(name: 'foo')
+    Fakery.register(:foo, fake)
+    fake
+  end
+
+  context Fakery::Change do
+    it 'records regular changes' do
+      obj = Fakery.build(:foo)
+      expect(obj.__send__(:changes)).to be_empty
+      obj.name = 'bar'
+      expect(obj.__send__(:changes).size).to eq 1
+      change = obj.__send__(:changes).first
+      expect(change.name).to eq :name
+      expect(change.from).to eq 'foo'
+      expect(change.to).to eq 'bar'
+      expect(change).to_not be_added
+    end
+
+    it 'records addition changes' do
+      obj = Fakery.build(:foo)
+      expect(obj.__send__(:changes)).to be_empty
+      obj.change = true
+      expect(obj.__send__(:changes).size).to eq 1
+      change = obj.__send__(:changes).first
+      expect(change.name).to eq :change
+      expect(change.from).to be_nil
+      expect(change.to).to eq true
+      expect(change).to be_added
+    end
+
+    it 'can ignore changes' do
+      obj = Fakery.build(:foo)
+      expect(obj.__send__(:changes)).to be_empty
+      Fakery::Fake.ignore_changes do
+        obj.change = true
+      end
+      expect(obj.__send__(:changes)).to be_empty
+    end
+  end
+
+  it 'can be generated from a JSON text' do
+    fake = Fakery::Fake.from_json '{ "name": "foo" }'
+    expect(fake).to be_a Fakery::Fake
+    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)
+      expect(casted).to be_a Fakery::Fake
+      expect(casted.name).to eq 'foo'
+    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'
+    end
+
+    it 'casts from a hash to a fake' do
+      casted = Fakery::Fake.cast(name: 'foo')
+      expect(casted).to be_a Fakery::Fake
+      expect(casted.name).to eq 'foo'
+    end
+
+    it 'casts from a json text to a fake' do
+      casted = Fakery::Fake.cast('{ "name": "foo" }')
+      expect(casted).to be_a Fakery::Fake
+      expect(casted.name).to eq 'foo'
+    end
+
+    it 'casts from a file containing json text to a fake' do
+      io = StringIO.new << '{ "name": "foo" }'
+      fake = Fakery::Fake.cast(io.tap(&:rewind))
+      expect(fake).to be_a Fakery::Fake
+      expect(fake.name).to eq 'foo'
+    end
+
+    it 'raises an ArgumentError if it cannot cast' do
+      expect { Fakery::Fake.cast(Object.new) }.to raise_error ArgumentError
+    end
+  end
+end

data/spec/registry_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe Fakery::Registry do
+  let :fake do
+    Fakery::Fake.from_hash(name: 'foo')
+  end
+
+  it 'registers fakes under a name' do
+    expect(Fakery).to_not be_registered 'foo'
+    expect(Fakery).to_not be_registered :foo
+    Fakery.register 'foo', fake
+    expect(Fakery).to be_registered 'foo'
+    expect(Fakery).to be_registered :foo
+  end
+
+  it 'warns iff a fake was registered a second time' do
+    expect(Fakery::Registry).to receive(:warn).with(any_args).and_call_original
+    Fakery.register 'foo', fake
+    Fakery.register 'foo', fake
+  end
+
+  context 'registered fake' do
+    before :each do
+      Fakery.register :foo, fake
+    end
+
+    it 'cannot be built if not registered' do
+      expect { Fakery.build(:bar) }.to raise_error ArgumentError
+    end
+
+    it 'can be built' do
+      foo = Fakery.build(:foo)
+      expect(foo.name).to eq 'foo'
+      expect(foo.bar).to be_nil
+    end
+
+    it 'can be changed and registered again' do
+      foo = Fakery.build(:foo, with: { bar: true })
+      expect(foo.bar).to eq true
+      Fakery.register(:bar, foo)
+      expect(Fakery.build(:bar).bar).to eq true
+    end
+  end
+end

data/spec/seeding_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe Fakery::Seeding do
+  let :fake do
+    Fakery::Fake.from_hash(name: 'foo')
+  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
+    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
+end

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+require 'simplecov'
+require "codeclimate-test-reporter"
+if ENV['START_SIMPLECOV'].to_i == 1
+  SimpleCov.start do
+    add_filter "#{File.basename(File.dirname(__FILE__))}/"
+  end
+end
+if ENV['CODECLIMATE_REPO_TOKEN']
+  if ENV['START_SIMPLECOV']
+    SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+      SimpleCov::Formatter::HTMLFormatter,
+      CodeClimate::TestReporter::Formatter
+    ]
+  end
+  CodeClimate::TestReporter.start
+end
+require 'rspec'
+require 'byebug'
+require 'fakery'
+
+RSpec.configure do |config|
+  config.before(:each) do
+    Typhoeus::Config.block_connection = true
+  end
+
+  config.after(:each) do
+    Typhoeus::Expectation.clear
+    Fakery::Registry.clear
+  end
+end

data/spec/wrapping_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe Fakery::Wrapping do
+  let :fake do
+    Fakery::Fake.from_hash(name: 'foo')
+  end
+
+  describe 'http_response' do
+    context Typhoeus do
+      it 'returns a successful http response object' do
+        response = Fakery.http_response(fake)
+        expect(response).to be_success
+        expect(JSON(response.body)['name']).to eq fake.name
+      end
+
+      it 'returns an unsuccessful http response object' do
+        response = Fakery.http_response(fake, http_status: 500)
+        expect(response).to_not be_success
+        expect(JSON(response.body)['name']).to eq fake.name
+      end
+
+      context 'registered' do
+        before :each do
+          Fakery.register :foo, fake
+        end
+
+        it 'returns a http response object' do
+          response = Fakery.http_response(:foo)
+          expect(JSON(response.body)['name']).to eq fake.name
+        end
+      end
+    end
+  end
+
+  describe 'instance' do
+    let :klass do
+      Class.new do
+        def initialize(attrs)
+          @attrs = attrs
+        end
+
+        attr_reader :attrs
+      end
+    end
+
+    it 'returns an instance' do
+      obj = Fakery.instance(fake, as: klass)
+      expect(obj.attrs[:name]).to eq fake.name
+    end
+
+    context 'registered' do
+      before :each do
+        Fakery.register :foo, fake
+      end
+
+      it 'returns an instance' do
+        obj = Fakery.instance(:foo, as: klass)
+        expect(obj.attrs[:name]).to eq fake.name
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,217 @@
+--- !ruby/object:Gem::Specification
+name: fakery
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- betterplace Developers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gem_hadar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-nc
+  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: byebug
+  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: tins
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: term-ansicolor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: This library fakes ruby objects from JSON API responses for testing purposes.
+email: developers@betterplace.org
+executables: []
+extensions: []
+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
+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
+homepage: http://github.com/betterplace/fakery
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--title"
+- 'Fakery -- '
+- "--main"
+- README.md
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Fake Ruby objects from JSON API responses
+test_files:
+- 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