frenetic 0.0.20.alpha.2 → 0.0.20.alpha.3

data/README.md

@@ -340,9 +340,54 @@ the schema has changed. If so, it will redefine the the getter methods available
 on your Class. This is what Hypermedia APIs are all about, a loose coupling
 between client and server.
 
+#### Mocking Resources
 
+Sometimes, when you are writing tests for your API client, it is helpful to have
+a mock instance of your API resource to play with.
 
+Frenetic provides a mixin that removes some of the HTTP interactions required
+when interacting with a Hypermedia API. It essentially turns your resource
+into a fancy OpenStruct, allowing you to assign whatever attributes you want.
 
+You can enable this by directly mixing in the behavior into your resource:
+
+```ruby
+require 'frenetic/resource_mockery'
+
+MyResource.send :include, Frenetic::ResourceMockery
+```
+
+Or by creating a special Class specifically for testing (which is recommended)
+
+```ruby
+# models/my_mock_resource.rb
+require 'frenetic/resource_mockery'
+
+class MyMockResource < MyResource
+  include Frenetic::ResourceMockery
+
+  def default_attributes
+    {
+      name: 'Mock Name',
+      city: 'Mock City'
+    }
+  end
+end
+
+# spec/integrations/my_integration_spec.rb
+describe 'My contrived integration test' do
+  it 'returns a Resource' do
+    MyResource.stub(:find).and_return MyMockResource.new city:'Washington, DC'
+
+    do_my_thing
+
+    payee.city.should == 'Washington, DC'
+  end
+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.
 
 ## Contributing
 

data/lib/frenetic/concerns/resource_mockery.rb

@@ -0,0 +1,34 @@
+require 'ostruct'
+
+class Frenetic
+  module ResourceMockery
+
+    def attributes
+      @params
+    end
+
+    def properties
+      @params.each_with_object({}) do |(k,v), props|
+        props[k] = v.class.to_s.underscore
+      end
+    end
+
+    # Provides a place for a Resources that are mocked to declare reasonable
+    # default values for Mock Resources
+    def default_attributes
+      {}
+    end
+
+  private
+
+    def build_params( p )
+      defaults = default_attributes.with_indifferent_access
+      @params  = defaults.merge( (p || {}).with_indifferent_access )
+    end
+
+    def build_structure
+      @structure = OpenStruct.new( @attrs )
+    end
+
+  end
+end

data/lib/frenetic/configuration.rb

@@ -53,7 +53,13 @@ class Frenetic
     end
 
     def headers
-      @@defaults[:headers].merge( @_cfg[:headers] || {} )
+      @@defaults[:headers].merge( @_cfg[:headers] || {} ).tap do |h|
+        if @_cfg[:headers] && @_cfg[:headers][:user_agent]
+          if h[:user_agent] != @@defaults[:headers][:user_agent]
+            h[:user_agent] = "#{h[:user_agent]} (#{@@defaults[:headers][:user_agent]})"
+          end
+        end
+      end
     end
 
     def password

data/lib/frenetic/resource.rb

@@ -47,14 +47,14 @@ class Frenetic
     end
 
     def initialize( p = {} )
-      @params = (p || {}).with_indifferent_access
+      build_params p
       @attrs  = {}
 
       properties.keys.each do |k|
         @attrs[k] = @params[k]
       end
 
-      @structure = structure.new( *@attrs.values )
+      build_structure
     end
 
     def attributes
@@ -74,7 +74,7 @@ class Frenetic
     end
 
     def inspect
-      attrs = @structure.each_pair.collect do |k,v|
+      attrs = attributes.collect do |k,v|
         val = v.is_a?(String) ? "\"#{v}\"" : v || 'nil'
         "#{k}=#{val}"
       end.join(' ')
@@ -94,6 +94,14 @@ class Frenetic
 
   private
 
+    def build_params( p )
+      @params = (p || {}).with_indifferent_access
+    end
+
+    def build_structure
+      @structure = structure.new( *@attrs.values )
+    end
+
     def namespace
       self.class.namespace
     end

data/lib/frenetic/resource_mockery.rb

@@ -0,0 +1 @@
+require 'frenetic/concerns/resource_mockery'

data/lib/frenetic/version.rb

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

data/spec/concerns/resource_mockery_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+require 'frenetic/resource_mockery'
+
+describe Frenetic::ResourceMockery do
+  let(:my_mocked_resource) do
+    Class.new(Frenetic::Resource) do
+      def default_attributes
+        { qux:'qux' }
+      end
+    end
+  end
+
+  before do
+    stub_const 'MyNamespace::MyMockedResource', my_mocked_resource
+
+    MyNamespace::MyMockedResource.send :include, described_class
+  end
+
+  let(:params) { { foo:1, bar:'baz' } }
+
+  subject { MyNamespace::MyMockedResource.new params }
+
+  describe '#properties' do
+    subject { super().properties }
+
+    it 'should return a hash of available properties' do
+      subject.should include 'foo' => 'fixnum'
+      subject.should include 'bar' => 'string'
+    end
+  end
+
+  describe '#attributes' do
+    subject { super().attributes }
+
+    it 'should return a hash of the resources attributes' do
+      subject.should include 'foo' => 1
+      subject.should include 'bar' => 'baz'
+      subject.should include 'qux' => 'qux'
+    end
+  end
+
+  describe '#default_attributes' do
+    it 'should allow implementors to specify sane defaults' do
+      subject.qux.should == 'qux'
+    end
+  end
+end

data/spec/configuration_spec.rb

@@ -70,6 +70,16 @@ describe Frenetic::Configuration do
       subject.should include accept:'MIME'
       subject.should include x_foo:'BAR'
     end
+
+    context 'with a custom User-Agent' do
+      let(:cfg) do
+        { headers:{ user_agent:'Foo v1.1' } }
+      end
+
+      it 'should append the Frenentic User-Agent' do
+        subject[:user_agent].should match %r{\AFoo v1.1 \(Frenetic v.[^;]*; [^)]*\)\Z}
+      end
+    end
   end
 
   describe '#password' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: frenetic
 version: !ruby/object:Gem::Version
-  version: 0.0.20.alpha.2
+  version: 0.0.20.alpha.3
   prerelease: 7
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-12 00:00:00.000000000 Z
+date: 2013-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -177,16 +177,19 @@ files:
 - lib/frenetic/concerns/configurable.rb
 - lib/frenetic/concerns/hal_linked.rb
 - lib/frenetic/concerns/member_rest_methods.rb
+- lib/frenetic/concerns/resource_mockery.rb
 - lib/frenetic/concerns/structured.rb
 - lib/frenetic/configuration.rb
 - lib/frenetic/middleware/hal_json.rb
 - lib/frenetic/resource.rb
 - lib/frenetic/resource_collection.rb
+- lib/frenetic/resource_mockery.rb
 - lib/frenetic/version.rb
 - spec/concerns/breifly_memoizable_spec.rb
 - spec/concerns/configurable_spec.rb
 - spec/concerns/hal_linked_spec.rb
 - spec/concerns/member_rest_methods_spec.rb
+- spec/concerns/resource_mockery_spec.rb
 - spec/concerns/structured_spec.rb
 - spec/configuration_spec.rb
 - spec/fixtures/test_api_requests.rb
@@ -212,7 +215,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -863323542650757064
+      hash: -3162981887620573122
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -231,6 +234,7 @@ test_files:
 - spec/concerns/configurable_spec.rb
 - spec/concerns/hal_linked_spec.rb
 - spec/concerns/member_rest_methods_spec.rb
+- spec/concerns/resource_mockery_spec.rb
 - spec/concerns/structured_spec.rb
 - spec/configuration_spec.rb
 - spec/fixtures/test_api_requests.rb