frenetic 0.0.12 → 0.0.20.alpha.0

data/lib/frenetic/resource_collection.rb

@@ -0,0 +1,46 @@
+require 'frenetic/concerns/hal_linked'
+require 'frenetic/concerns/collection_rest_methods'
+
+class Frenetic
+  class ResourceCollection < Delegator
+    include HalLinked
+    include CollectionRestMethods
+
+    def initialize( resource, params = {} )
+      @resource_class = resource
+      @resources      = []
+      @params         = params
+
+      extract_resources!
+    end
+
+    def resource_type
+      @resource_type ||= @resource_class.to_s.demodulize.underscore
+    end
+
+    def collection_key
+      @collection_key ||= resource_type.pluralize
+    end
+
+    def __getobj__
+      @resources
+    end
+
+    def __setobj__
+      @resources
+    end
+
+    def api
+      @resources.first.api
+    end
+
+  private
+
+    def extract_resources!
+      @resources = @params['_embedded'][collection_key].collect do |resource|
+        @resource_class.new resource
+      end
+    end
+
+  end
+end

data/lib/frenetic/version.rb

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

data/spec/concerns/configurable_spec.rb

@@ -0,0 +1,50 @@
+describe Frenetic::Configurable do
+  let(:test_cfg) do
+    {
+      url:'http://example.org'
+    }
+  end
+
+  subject(:instance) { Frenetic.new( test_cfg ) }
+
+  describe '#config' do
+    subject { instance.config }
+
+    it { should_not be_empty }
+  end
+
+  describe '#configure' do
+    subject do
+      cfg = nil
+      instance.configure { |c| cfg = c }
+      cfg
+    end
+
+    it 'should yield the configuration' do
+      subject.should be_a Hash
+    end
+  end
+
+  describe '.configure' do
+    subject { Frenetic.configure{|c|} }
+
+    it 'should not exist' do
+      expect{ subject }.to raise_error NoMethodError
+    end
+  end
+
+  describe '#initialize' do
+    let(:callback) do
+      Proc.new { |b| }
+    end
+
+    subject do
+      Frenetic.new( &callback ).instance_variable_get( "@builder_config" )
+    end
+
+    it 'retain block arguments' do
+      subject.should eq callback
+    end
+  end
+
+end

data/spec/concerns/hal_linked_spec.rb

@@ -0,0 +1,116 @@
+require 'spec_helper'
+
+describe Frenetic::HalLinked do
+  let(:test_cfg) { { url:'http://example.com/api' } }
+
+  let(:my_temp_resource) do
+    cfg = test_cfg
+
+    Class.new(Frenetic::Resource) do
+      api_client { Frenetic.new(cfg) }
+    end
+  end
+
+  before do
+    stub_const 'MyTempResource', my_temp_resource
+
+    MyTempResource.send :include, described_class
+  end
+
+  describe '#links' do
+    before { @stubs.api_description }
+
+    let(:_links) do
+      {
+        '_links' => { 'self' => { 'href' => '/api/self' }}
+      }
+    end
+
+    subject { MyTempResource.new(_links).links }
+
+    it 'should return the instances links' do
+      subject.should include 'self'
+    end
+  end
+
+  describe '#member_url' do
+    before { @stubs.api_description }
+
+    subject { MyTempResource.new(_links).member_url }
+
+      let(:_links) do
+        {
+          '_links' => {
+            'self' => { 'href' => '/api/self' },
+            'my_temp_resource' => {
+              'href' => '/api/my_temp_resource/{id}', 'templated' => true
+            }
+          }
+        }
+      end
+
+    context 'with a link that matches the resource name' do
+      it 'should return the named link' do
+        subject.should == '/api/my_temp_resource/'
+      end
+    end
+
+    context 'with an implied self link' do
+      let(:_links) do
+        {
+          '_links' => { 'self' => { 'href' => '/api/self' }}
+        }
+      end
+
+      it 'should return the :self link' do
+        subject.should == '/api/self'
+      end
+    end
+  end
+
+  describe '.member_url' do
+    let(:args) {}
+
+    subject { MyTempResource.member_url args }
+
+    before { @stubs.api_description }
+
+    context 'for an unknown resource' do
+      before do
+        MyTempResource.stub(:namespace).and_return Time.now.to_i.to_s
+      end
+
+      it 'should raise an error' do
+        expect{ subject }.to raise_error Frenetic::HypermediaError
+      end
+    end
+
+    context 'with a non-templated URL' do
+      before do
+        MyTempResource.stub(:namespace).and_return 'abstract_resource'
+      end
+
+      it 'simply return the URL' do
+        subject.should == '/api/abstract_resource'
+      end
+    end
+
+    context 'with a templated URL' do
+      context 'and a non-Hash argument' do
+        let(:args) { 1 }
+
+        it 'should expand the URL template' do
+          subject.should == '/api/my_temp_resources/1'
+        end
+      end
+
+      context 'with a Hash argument' do
+        let(:args) { { id:1 } }
+
+        it 'should interpolate the URL' do
+          subject.should == '/api/my_temp_resources/1'
+        end
+      end
+    end
+  end
+end

data/spec/concerns/member_rest_methods_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe Frenetic::MemberRestMethods do
+  let(:test_cfg) { { url:'http://example.com/api' } }
+
+  let(:my_temp_resource) do
+    cfg = test_cfg
+
+    Class.new(Frenetic::Resource) do
+      api_client { Frenetic.new(cfg) }
+    end
+  end
+
+  before do
+    stub_const 'MyTempResource', my_temp_resource
+
+    MyTempResource.send :include, described_class
+  end
+
+  describe '.find' do
+    before { @stubs.api_description }
+
+    subject { MyTempResource.find 1 }
+
+    context 'for a known instance' do
+      before { @stubs.known_resource }
+
+      it 'should return the instance' do
+        expect(subject).to be_a MyTempResource
+      end
+    end
+
+    context 'for an unknown instance' do
+      before { @stubs.unknown_resource }
+
+      it 'should raise an error' do
+        expect{ subject }.to raise_error Frenetic::ClientError
+      end
+    end
+  end
+end

data/spec/concerns/structured_spec.rb

@@ -0,0 +1,214 @@
+require 'spec_helper'
+
+describe Frenetic::Structured do
+  let(:my_temp_resource) do
+    Class.new do
+      def initialize( attrs = {} )
+        @attrs = attrs
+      end
+    end
+  end
+
+  before do
+    stub_const 'MyTempResource', my_temp_resource
+
+    MyTempResource.send :include, described_class
+  end
+
+  after do
+    instance.rspec_reset
+
+    instance.destroy_structure!
+  end
+
+  subject(:instance) { MyTempResource.new( foo:'foo', bar:'bar' ) }
+
+  describe '#struct_key' do
+    subject { instance.struct_key }
+
+    it 'should return a valid, unique Ruby constant name' do
+      subject.should == 'MyTempResourceFreneticResourceStruct'
+    end
+  end
+
+  describe '#signature' do
+    subject { instance.signature }
+
+    it 'should return a unique and predictable key' do
+      subject.should == 'barfoo'
+    end
+  end
+
+  describe '#structure' do
+    subject { instance.structure }
+
+    context 'with no previously defined signature' do
+      before do
+        instance.stub( :structure_expired? ).and_return true
+      end
+
+      it 'should rebuild the structure' do
+        instance.should_receive :rebuild_structure!
+
+        subject
+      end
+    end
+
+    context 'with a fresh signature' do
+      before do
+        instance.structure
+
+        instance.stub( :structure_expired? ).and_return false
+      end
+
+      it 'should not rebuild the structure' do
+        instance.should_receive( :rebuild_structure! ).never
+
+        subject
+      end
+    end
+
+    context 'with an expired signature' do
+      before do
+        instance.structure
+
+        instance.stub( :structure_expired? ).and_return true
+      end
+
+      it 'should rebuild the structure' do
+        instance.should_receive :rebuild_structure!
+
+        subject
+      end
+    end
+  end
+
+  describe '#fetch_structure' do
+    before { instance.structure }
+
+    subject { instance.fetch_structure }
+
+    it "should return the resource's Struct class" do
+      subject.should == Struct::MyTempResourceFreneticResourceStruct
+    end
+  end
+
+  describe '#rebuild_structure!' do
+    before{ instance.structure }
+
+    subject { instance.rebuild_structure! }
+
+    it 'should destroy the previous Struct' do
+      instance.should_receive(:destroy_structure!).and_call_original
+
+      subject
+    end
+
+    it "should add cache the resource's signature" do
+      sigs = described_class.class_variable_get('@@signatures')
+
+      sigs.should include
+    end
+
+    it "should build the resource's Struct" do
+      subject
+
+      instance.fetch_structure.members.should == [:foo, :bar]
+    end
+  end
+
+  describe '#structure_expired?' do
+    subject { instance.structure_expired? }
+
+    before do
+      instance.stub( :signature ).and_return new_sig
+      described_class.class_variable_set '@@signatures', {
+        'MyTempResourceFreneticResourceStruct' => old_sig
+      }
+    end
+
+    context 'with a fresh signature' do
+      let(:old_sig) { 'fresh' }
+      let(:new_sig) { 'fresh' }
+
+      it { should be_false }
+    end
+
+    context 'with no predefined signature' do
+      let(:old_sig) { nil }
+      let(:new_sig) { 'new' }
+
+      it { should be_true }
+    end
+
+    context 'with an expired signature' do
+      let(:old_sig) { 'old' }
+      let(:new_sig) { 'new' }
+
+      it { should be_true }
+    end
+  end
+
+  describe '#structure_defined?' do
+    subject { instance.structure_defined? }
+
+    let(:consts) { Struct.constants || [] }
+
+    before do
+      Struct.stub(:constants).and_return consts
+    end
+
+    after { Struct.rspec_reset }
+
+    it 'should check if the structure is defined' do
+      instance.stub(:struct_key).and_return 'Foo'
+
+      consts.should_receive( :include? ).with :Foo
+
+      subject
+    end
+  end
+
+  describe '#destroy_structure!' do
+    before { instance.structure }
+
+    subject { instance.destroy_structure! }
+
+    context 'with an undefined structure' do
+      before { instance.destroy_structure! }
+
+      it "should not attempt to remove the structure's constant" do
+        Struct.should_receive( :remove_const ).never
+
+        subject
+      end
+
+      it 'should not remove the signature from the cache' do
+        described_class.class_variable_get('@@signatures').should_receive( :delete ).never
+
+        subject
+      end
+    end
+
+    context 'with an predefined structure' do
+      it 'should remove the constant' do
+        Struct.constants.should include instance.struct_key.to_sym
+
+        subject
+
+        Struct.constants.should_not include instance.struct_key.to_sym
+      end
+
+      it 'should remove the signature from the cache' do
+        signature = { 'MyTempResourceFreneticResourceStruct' => 'barfoo' }
+
+        described_class.class_variable_get('@@signatures').should include signature
+
+        subject
+
+        described_class.class_variable_get('@@signatures').should_not include signature
+      end
+    end
+  end
+
+end