frenetic 0.0.20.alpha.4 → 0.0.20.alpha.5

data/README.md

@@ -402,6 +402,43 @@ end
 As you can see, this allows you to supply some default values for the attributes
 of your resource to ease object creation in testing.
 
+
+
+### Integration Testing
+
+When it comes time to write integration tests for your API client, you can either
+stub out all of the HTTP requests with something like WebMock or VCR, or you can
+use Frenetic in `test_mode`
+
+```ruby
+Frenetic.new( url:url, test_mode:true )
+# ...or...
+api = Frenetic.new(url:url)
+api.config.test_mode = true
+```
+
+Doing so will allow `Frenetic::Resource.find` to return a mock resource instead
+of querying your API for what is available.
+
+Example:
+
+```ruby
+class MyResource < Frenetic::Resource
+  api_client { Frenetic.new(url) }
+end
+
+class MyMockResource < MyResource
+  include Frenetic::ResourceMockery
+end
+
+> MyResource.api_client.config.test_mode = true
+# true
+> MyResource.find(99)
+# <MyMockResource id=99>
+```
+
+
+
 ## Contributing
 
 1. Fork it

data/lib/frenetic/concerns/member_rest_methods.rb

@@ -5,15 +5,19 @@ class Frenetic
     extend ActiveSupport::Concern
 
     module ClassMethods
-      def find( params = {} )
+      def find( params )
         params = { id:params } unless params.is_a? Hash
 
+        return as_mock(params) if test_mode?
+
         if response = api.get( member_url(params) ) and response.success?
           new response.body
         end
       end
 
       def all
+        return [] if test_mode?
+
         if response = api.get( collection_url ) and response.success?
           Frenetic::ResourceCollection.new self, response.body
         end

data/lib/frenetic/concerns/resource_mockery.rb

@@ -1,7 +1,15 @@
 require 'ostruct'
+require 'active_support/concern'
 
 class Frenetic
   module ResourceMockery
+    extend ActiveSupport::Concern
+
+    included do
+      # I'm sure this violates some sort of CS principle or best practice,
+      # but it solves the problem for now.
+      superclass.send :instance_variable_set, '@mock_class', self
+    end
 
     def attributes
       @params

data/lib/frenetic/configuration.rb

@@ -32,6 +32,7 @@ class Frenetic
         headers:   headers,
         password:  password,
         ssl:       ssl,
+        test_mode: test_mode,
         url:       url,
         username:  username
       }
@@ -71,6 +72,10 @@ class Frenetic
       @_cfg[:ssl] || { verify:true }
     end
 
+    def test_mode
+      @_cfg[:test_mode] || false
+    end
+
     def url
       Addressable::URI.parse @_cfg[:url]
     end

data/lib/frenetic/resource.rb

@@ -46,6 +46,14 @@ class Frenetic
       (api.schema[namespace]||{})['properties'] or raise HypermediaError, %Q{Could not find schema definition for the resource "#{namespace}"}
     end
 
+    def self.as_mock( params = {} )
+      raise Frenetic::ClientError, "Mock resource not defined for #{namespace}." \
+                                    " Subclass #{self} and mixin Frenetic::ResourceMockery" \
+                                    " to define a mock" unless @mock_class
+
+      @mock_class.new params
+    end
+
     def initialize( p = {} )
       build_params p
       @attrs  = {}
@@ -112,5 +120,9 @@ class Frenetic
       self.class.properties
     end
 
+    def self.test_mode?
+      api_client.config.test_mode
+    end
+
   end
 end

data/lib/frenetic/version.rb

@@ -1,3 +1,3 @@
 class Frenetic
-  VERSION = '0.0.20.alpha.4'
+  VERSION = '0.0.20.alpha.5'
 end

data/spec/concerns/member_rest_methods_spec.rb

@@ -45,6 +45,20 @@ describe Frenetic::MemberRestMethods do
         expect{ subject }.to raise_error Frenetic::ClientError
       end
     end
+
+    context 'in test mode' do
+      let(:test_cfg) { { url:'http://example.com/api', test_mode:true } }
+
+      before do
+        stub_const 'MyMockResource', Class.new(MyTempResource)
+
+        MyMockResource.send :include, Frenetic::ResourceMockery
+      end
+
+      it 'should return a mock resource' do
+        expect(subject).to be_an_instance_of MyMockResource
+      end
+    end
   end
 
   describe '.all' do
@@ -63,5 +77,13 @@ describe Frenetic::MemberRestMethods do
         expect(subject.first).to be_an_instance_of MyTempResource
       end
     end
+
+    context 'in test mode' do
+      let(:test_cfg) { { url:'http://example.com/api', test_mode:true } }
+
+      it 'should return an empty collection' do
+        expect(subject).to be_empty
+      end
+    end
   end
 end

data/spec/concerns/resource_mockery_spec.rb

@@ -3,8 +3,12 @@ require 'spec_helper'
 require 'frenetic/resource_mockery'
 
 describe Frenetic::ResourceMockery do
+  let(:my_temp_resource) do
+    Class.new(Frenetic::Resource)
+  end
+
   let(:my_mocked_resource) do
-    Class.new(Frenetic::Resource) do
+    Class.new(my_temp_resource) do
       def default_attributes
         { qux:'qux' }
       end
@@ -21,6 +25,10 @@ describe Frenetic::ResourceMockery do
 
   subject { MyNamespace::MyMockedResource.new params }
 
+  it 'should violate some basic CS principles by telling the parent-class of its existence' do
+    expect(my_temp_resource.instance_variables).to include :@mock_class
+  end
+
   describe '#properties' do
     subject { super().properties }
 

data/spec/configuration_spec.rb

@@ -19,6 +19,7 @@ describe Frenetic::Configuration do
     it { should include :headers }
     it { should include :password }
     it { should include :ssl }
+    it { should include :test_mode }
     it { should include :url }
     it { should include :username }
   end
@@ -101,6 +102,12 @@ describe Frenetic::Configuration do
     it { should include verify:true }
   end
 
+  describe '#test_mode' do
+    subject { instance.test_mode }
+
+    it { should be_false }
+  end
+
   describe '#url' do
     let(:cfg) do
       { url:'http://example.org' }

data/spec/resource_spec.rb

@@ -152,6 +152,32 @@ describe Frenetic::Resource do
     end
   end
 
+  describe '.as_mock' do
+    subject { MyNamespace::MyTempResource.as_mock id:99 }
+
+    context 'without a defined Mock-class' do
+      it 'should raise an error' do
+        expect{subject}.to raise_error Frenetic::ClientError
+      end
+    end
+
+    context 'with a defined Mock-class' do
+      before do
+        stub_const 'MyNamespace::MyMockResource', Class.new(MyNamespace::MyTempResource)
+
+        MyNamespace::MyMockResource.send :include, Frenetic::ResourceMockery
+      end
+
+      it 'should return a mock instance of the resource' do
+        expect(subject).to be_an_instance_of MyNamespace::MyMockResource
+      end
+
+      it 'should initialize the mock with the provided values' do
+        expect(subject.id).to eq 99
+      end
+    end
+  end
+
   describe '#initialize' do
     before { @stubs.api_description }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: frenetic
 version: !ruby/object:Gem::Version
-  version: 0.0.20.alpha.4
+  version: 0.0.20.alpha.5
   prerelease: 7
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-15 00:00:00.000000000 Z
+date: 2013-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -215,7 +215,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3576003086095464905
+      hash: -3382151532624258123
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: