json_api_client_mock 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 45902ed709aa4974099a06459be994b4a4095a33
+  data.tar.gz: 0af1f842e8d9143335378a39216251d8040f73a0
+SHA512:
+  metadata.gz: 2704c569141fb4a0c85d84b87ee1289d5341977f7f247a10710051bbb02f9343cecbd89f89b0ef65677d71eda38c248f68049e197b98ced00a12cdd10eae64c6
+  data.tar.gz: 3094b0b15152f8c42efae3b69efe49c154807db704e8ad7b693b4baa90b6248cc905652a4c42e1433786a6b9165c6a9e5713b6bb499921e1ee4a3a10a6e49eb4

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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,60 @@
+# JsonApiClientMock [![Build Status](https://travis-ci.org/chingor13/json_api_client_mock.png)](https://travis-ci.org/chingor13/json_api_client_mock)
+
+This gem allows you to easily test [json_api_client](json_api_client) gem.
+
+## Usage
+
+In your `Gemfile`:
+
+```
+group :test do
+  gem 'json_api_client_mock', '~> 0'
+end
+```
+
+To set a global mock for `MyResource`:
+
+```
+MyResource.set_test_results([
+  {foo: 'bar', qwer: 'asdf'},
+  {foo: 'wat', qwer: 'zxcv'}
+])
+
+MyResource.all
+=> [<#MyResource foo:'bar', qwer:'asdf'>, <#MyResource foo:'wat', qwer:'zxcv'>]
+
+MyResource.where(condition1: 'value', condition2: 'value2').all
+=> [<#MyResource foo:'bar', qwer:'asdf'>, <#MyResource foo:'wat', qwer:'zxcv'>]
+```
+
+To set a targeted mock for `MyResource`:
+
+```
+MyResource.set_test_results([
+  {foo: 'asdf', 'qwer': 'bar'}
+], {
+  condition1: 'value1',
+  condition2: 'value2',
+})
+
+MyResource.where(condition1: 'value1', condition2: 'value2').all
+=> [<#MyResource foo:'asdf', qwer:'bar'>]
+
+# condition order should not matter
+MyResource.where(condition2: 'value2', condition1: 'value1').all
+=> [<#MyResource foo:'asdf', qwer:'bar'>]
+```
+
+### Mock Priority
+
+If you set multiple mocks that match the same query, the last matching result set should be returned. If no targetted match is found, we will return the untargeted result set you've specified (if it exists). If no mock is found, we will raise a `JsonApiClientMock::MissingMock` exception.
+
+## Contributing
+
+Please fork and send me a pull request.
+
+## License
+
+This project rocks and uses MIT-LICENSE.
+
+[json_api_client]: http://github.com/chingor13/json_api_client

data/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+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    = 'JsonApiClientMock'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/json_api_client_mock/missing_mock.rb

@@ -0,0 +1,4 @@
+module JsonApiClientMock
+  class MissingMock < StandardError
+  end
+end

data/lib/json_api_client_mock/mock_connection.rb

@@ -0,0 +1,41 @@
+require 'ostruct'
+
+module JsonApiClientMock
+  class MockConnection
+    def self.instance
+      @instance ||= self.new
+    end
+
+    def initialize
+      # ignored
+      @mocks = {}
+    end
+
+    def execute(query)
+      if results = find_test_results(query)
+        OpenStruct.new(:body => {
+          query.klass.table_name => results[:results]
+        })
+      else
+        raise MissingMock, "no test results set for #{query.klass.name} with conditions: #{query.params.inspect}"
+      end      
+    end
+
+    def set_test_results(klass, results, conditions = nil)
+      @mocks[klass.name] ||= []
+      @mocks[klass.name].unshift({results: results, conditions: conditions})
+    end
+
+    def clear_test_results
+      @mocks = {}
+    end
+
+    protected
+
+    def find_test_results(query)
+      class_mocks = @mocks.fetch(query.klass.name, [])
+      class_mocks.detect{|mock| mock[:conditions] == query.params} ||
+        class_mocks.detect{|mock| mock[:conditions].nil?}
+    end
+  end
+end

data/lib/json_api_client_mock/resource_extensions.rb

@@ -0,0 +1,20 @@
+module JsonApiClientMock
+  module ResourceExtensions
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def connection
+        MockConnection.instance
+      end
+
+      def set_test_results(results, conditions = nil)
+        connection.set_test_results(self, results, conditions)
+      end
+
+      def clear_test_results
+        connection.clear_test_results
+      end
+
+    end
+  end
+end

data/lib/json_api_client_mock/version.rb

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

data/lib/json_api_client_mock.rb

@@ -0,0 +1,9 @@
+require 'json_api_client'
+
+module JsonApiClientMock
+  autoload :MissingMock, "json_api_client_mock/missing_mock"
+  autoload :MockConnection, "json_api_client_mock/mock_connection"
+  autoload :ResourceExtensions, "json_api_client_mock/resource_extensions"
+end
+
+JsonApiClient::Resource.send(:include, JsonApiClientMock::ResourceExtensions)

data/lib/tasks/json_api_client_mock_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :json_api_client_mock do
+#   # Task goes here
+# end

data/test/json_api_client_mock_test.rb

@@ -0,0 +1,77 @@
+require 'test_helper'
+
+class JsonApiClientMockTest < MiniTest::Unit::TestCase
+
+  def teardown
+    JsonApiClient::Resource.clear_test_results
+    super
+  end
+
+  def test_conditionless_mocking
+    BarResource.set_test_results([{foo: 'bar', qwer: 'asdf'}])
+    results = BarResource.all
+
+    assert_equal(JsonApiClient::ResultSet, results.class)
+    assert_equal(1, results.length)
+
+    first = results.first
+    assert_equal(BarResource, first.class)
+    assert_equal('bar', first.foo)
+    assert_equal('asdf', first.qwer)
+
+    conditioned_results = BarResource.where(something: 'else').all
+    assert_equal(JsonApiClient::ResultSet, results.class)
+    assert_equal(1, conditioned_results.length)
+
+    first = conditioned_results.first
+    assert_equal(BarResource, first.class)
+    assert_equal('bar', first.foo)
+    assert_equal('asdf', first.qwer)
+  end
+
+  def test_missing_mock
+    assert_raises(JsonApiClientMock::MissingMock) do
+      BarResource.all
+    end
+  end
+
+  def test_conditional_mocking
+    BarResource.set_test_results([{foo: 'bar', qwer: 'asdf'}], {foo: 'bar'})
+    assert_raises(JsonApiClientMock::MissingMock) do
+      BarResource.all
+    end
+
+    results = BarResource.where(foo: 'bar').all
+    assert_equal(1, results.length)
+
+    first = results.first
+    assert_equal(BarResource, first.class)
+    assert_equal('bar', first.foo)
+    assert_equal('asdf', first.qwer)
+  end
+
+  def test_conditional_mocking_param_order
+    BarResource.set_test_results([{foo: 'bar', qwer: 'asdf'}], {foo: 'bar', qwer: 'asdf'})
+
+    results = BarResource.where(foo: 'bar', qwer: 'asdf').all
+    assert_equal(1, results.length)
+
+    results = BarResource.where(qwer: 'asdf', foo: 'bar').all
+    assert_equal(1, results.length)
+  end
+
+  def test_mocks_are_stored_by_class
+    BarResource.set_test_results([{foo: 'bar', qwer: 'asdf'}])
+    assert_raises(JsonApiClientMock::MissingMock) do
+      FooResource.all
+    end
+  end
+
+  def test_inherited_mocking
+    BarResource.set_test_results([{foo: 'bar', qwer: 'asdf'}])
+    assert_raises(JsonApiClientMock::MissingMock) do
+      BarExtendedResource.all
+    end
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,19 @@
+Bundler.require(:default, :test)
+
+require 'minitest/autorun'
+require 'pp'
+
+# test classes
+
+class BaseResource < JsonApiClient::Resource
+  self.site = "http://test.host/api/1"
+end
+
+class BarResource < BaseResource
+end
+
+class FooResource < BaseResource
+end
+
+class BarExtendedResource < BarResource
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: json_api_client_mock
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jeff Ching
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json_api_client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: mocha
+  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: sqlite3
+  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: Adds methods to JsonApiClient allowing you to easily mock test results
+email:
+- ching.jeff@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/json_api_client_mock.rb
+- lib/json_api_client_mock/missing_mock.rb
+- lib/json_api_client_mock/mock_connection.rb
+- lib/json_api_client_mock/resource_extensions.rb
+- lib/json_api_client_mock/version.rb
+- lib/tasks/json_api_client_mock_tasks.rake
+- test/json_api_client_mock_test.rb
+- test/test_helper.rb
+homepage: http://github.com/chingor13/json_api_client_mock
+licenses: []
+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.0
+signing_key: 
+specification_version: 4
+summary: Easily mock JsonApiClient queries
+test_files:
+- test/json_api_client_mock_test.rb
+- test/test_helper.rb