frenetic 0.0.20.alpha.6 → 1.0.0.alpha.1

data/lib/frenetic/resource_collection.rb

@@ -45,6 +45,5 @@ class Frenetic
     def embedded_collection
       @params.fetch('_embedded',{}).fetch(collection_key, [])
     end
-
   end
 end

data/lib/frenetic/resource_mockery.rb

@@ -1 +1,55 @@
-require 'frenetic/concerns/resource_mockery'
+require 'ostruct'
+require 'delegate'
+require 'active_support/concern'
+
+class Frenetic
+  module ResourceMockery
+    extend Forwardable
+    extend ActiveSupport::Concern
+
+    def_delegators :@params, :to_json
+
+    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
+    end
+
+    def properties
+      @params.each_with_object({}) do |(k,v), props|
+        props[k] = v.class.to_s.underscore
+      end
+    end
+
+    def default_attributes
+      self.class.default_attributes
+    end
+
+    module ClassMethods
+      def api_client
+        superclass.api_client
+      end
+
+      # Provides a place for a Resources that are mocked to declare reasonable
+      # default values for Mock Resources
+      def default_attributes
+        {}
+      end
+    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/version.rb

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

data/spec/{concerns/breifly_memoizable_spec.rb → briefly_memoizable_spec.rb}

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe BrieflyMemoizable do
+describe Frenetic::BrieflyMemoizable do
   let(:my_class) { Class.new }
 
   before do
@@ -10,7 +10,6 @@ describe BrieflyMemoizable do
     MyClass.class_eval do
       def fetch
         @fetch_age = Time.now + 3600
-
         external_call
       end
       briefly_memoize :fetch
@@ -27,40 +26,33 @@ describe BrieflyMemoizable do
     context 'for an expensive method' do
       before do
         Timecop.freeze
-
         instance.fetch
+        allow(instance).to receive(:external_call).and_call_original
       end
 
       context 'which is called again outside the memoize window' do
-        before do
-          Timecop.travel Time.now + 5400
-        end
-
-        it 'should be called' do
-          instance.should_receive(:external_call).once.and_call_original
+        before { Timecop.travel Time.now + 5400 }
 
+        it 'is called' do
           instance.fetch
+          expect(instance).to have_received(:external_call).once
         end
       end
 
       context 'which is called again within the memoize window' do
-        before do
-          Timecop.travel Time.now + 1800
-        end
-
-        it 'should not be called' do
-          instance.should_receive(:external_call).never.and_call_original
+        before { Timecop.travel Time.now + 1800 }
 
+        it 'is not called' do
           instance.fetch
+          expect(instance).to_not have_received(:external_call)
         end
 
         context 'after it has been reloaded' do
           before { instance.reload_fetch! }
 
-          it 'should be called' do
-            instance.should_receive(:external_call).once.and_call_original
-
+          it 'is called' do
             instance.fetch
+            expect(instance).to have_received(:external_call).once
           end
         end
       end

data/spec/concerns/hal_linked_spec.rb

@@ -13,7 +13,6 @@ describe Frenetic::HalLinked do
 
   before do
     stub_const 'MyTempResource', my_temp_resource
-
     MyTempResource.send :include, described_class
   end
 
@@ -28,8 +27,8 @@ describe Frenetic::HalLinked do
 
     subject { MyTempResource.new(_links).links }
 
-    it 'should return the instances links' do
-      subject.should include 'self'
+    it 'returns the instances links' do
+      expect(subject).to include 'self'
     end
   end
 
@@ -38,20 +37,28 @@ describe Frenetic::HalLinked do
 
     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
+    context 'with a link that matches the resource name' do
+      let(:_links) do
+        {
+          '_links' => {
+            'self' => { 'href' => '/api/self' },
+            'my_temp_resource' => {
+              'href' => '/api/my_temp_resource'
+            }
           }
         }
-      }
-    end
+      end
 
-    context 'with a link that matches the resource name' do
-      it 'should return the named link' do
-        subject.should == '/api/my_temp_resource/'
+      it 'processes the link' do
+        expect_any_instance_of(Frenetic::HypermediaLinkSet)
+          .to receive(:href).with({}).and_call_original
+        subject
+      end
+
+      it 'finds the appropriate link' do
+        # Admittedly, this isn't the best test in the world, but I wanted to
+        # ensure that the correct link is found out of the set
+        expect(subject).to eq '/api/my_temp_resource'
       end
     end
 
@@ -62,76 +69,56 @@ describe Frenetic::HalLinked do
         }
       end
 
-      it 'should return the :self link' do
-        subject.should == '/api/self'
+      it 'processes the link' do
+        expect_any_instance_of(Frenetic::HypermediaLinkSet)
+          .to receive(:href).with({}).and_call_original
+        subject
+      end
+
+      it 'returns the :self link' do
+        # Admittedly, this isn't the best test in the world, but I wanted to
+        # ensure that the correct link is found out of the set
+        expect(subject).to eq '/api/self'
       end
     end
   end
 
   describe '.member_url' do
-    let(:args) {}
-
-    subject { MyTempResource.member_url args }
+    let(:params) { { id:1 } }
 
     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
+    subject { MyTempResource.member_url params }
 
-      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
+    it 'processes the link' do
+      expect_any_instance_of(Frenetic::HypermediaLinkSet)
+        .to receive(:href).with( params ).and_call_original
+      subject
     end
   end
 
   describe '.collection_url' do
-    subject { MyTempResource.collection_url }
-
     before { @stubs.api_description }
 
+    subject { MyTempResource.collection_url }
+
     context 'for an unknown resource' do
       before do
-        MyTempResource.stub(:namespace).and_return Time.now.to_i.to_s
+        allow(MyTempResource)
+          .to receive(:namespace)
+            .and_return(Time.now.to_i.to_s)
       end
 
-      it 'should raise an error' do
-        expect{ subject }.to raise_error Frenetic::HypermediaError
+      it 'raises an error' do
+        expect{subject}.to raise_error Frenetic::HypermediaError
       end
     end
 
-    context 'with a non-templated URL' do
-      it 'simply return the URL' do
-        subject.should == '/api/my_temp_resources'
+    context 'for a known resource' do
+      it 'processes the link' do
+        expect_any_instance_of(Frenetic::HypermediaLinkSet)
+          .to receive(:href).and_call_original
+        subject
       end
     end
   end

data/spec/concerns/member_rest_methods_spec.rb

@@ -13,7 +13,6 @@ describe Frenetic::MemberRestMethods do
 
   before do
     stub_const 'MyTempResource', my_temp_resource
-
     MyTempResource.send :include, described_class
   end
 
@@ -25,14 +24,14 @@ describe Frenetic::MemberRestMethods do
     context 'for a known instance' do
       before { @stubs.known_instance }
 
-      it 'should return the instance' do
+      it 'returns the instance' do
         expect(subject).to be_a MyTempResource
       end
 
       context 'and a Hash argument' do
         subject { MyTempResource.find id:1 }
 
-        it 'should return the instance' do
+        it 'returns the instance' do
           expect(subject).to be_a MyTempResource
         end
       end
@@ -41,8 +40,8 @@ describe Frenetic::MemberRestMethods do
     context 'for an unknown instance' do
       before { @stubs.unknown_instance }
 
-      it 'should raise an error' do
-        expect{ subject }.to raise_error Frenetic::ClientError
+      it 'raises an error' do
+        expect{subject}.to raise_error Frenetic::ClientError
       end
     end
 
@@ -51,11 +50,10 @@ describe Frenetic::MemberRestMethods do
 
       before do
         stub_const 'MyMockResource', Class.new(MyTempResource)
-
         MyMockResource.send :include, Frenetic::ResourceMockery
       end
 
-      it 'should return a mock resource' do
+      it 'returns a mock resource' do
         expect(subject).to be_an_instance_of MyMockResource
       end
     end
@@ -69,11 +67,11 @@ describe Frenetic::MemberRestMethods do
     context 'for a known resource' do
       before { @stubs.known_resource }
 
-      it 'should return a resource collection' do
+      it 'returns a resource collection' do
         expect(subject).to be_an_instance_of Frenetic::ResourceCollection
       end
 
-      it 'should instantiate all resources in the collection' do
+      it 'instantiates all resources in the collection' do
         expect(subject.first).to be_an_instance_of MyTempResource
       end
     end
@@ -81,7 +79,7 @@ describe Frenetic::MemberRestMethods do
     context 'in test mode' do
       let(:test_cfg) { { url:'http://example.com/api', test_mode:true } }
 
-      it 'should return an empty collection' do
+      it 'returns an empty collection' do
         expect(subject).to be_empty
       end
     end

data/spec/concerns/structured_spec.rb

@@ -9,76 +9,77 @@ describe Frenetic::Structured do
     end
   end
 
+  let(:signatures) do
+    described_class.class_variable_get('@@signatures')
+  end
+
+  let(:signature) do
+    { 'MyTempResourceFreneticResourceStruct' => 'barfoo' }
+  end
+
   before do
     stub_const 'MyTempResource', my_temp_resource
-
     MyTempResource.send :include, described_class
   end
 
-  after do
-    instance.rspec_reset
-
-    instance.destroy_structure!
-  end
+  after { instance.destroy_structure! }
 
   subject(:instance) { MyTempResource.new( foo:'foo', bar:'bar' ) }
 
   describe '#struct_key' do
-    subject { instance.struct_key }
+    subject { super().struct_key }
 
-    it 'should return a valid, unique Ruby constant name' do
-      subject.should == 'MyTempResourceFreneticResourceStruct'
+    it 'returns a valid, unique Ruby constant name' do
+      expect(subject).to eq 'MyTempResourceFreneticResourceStruct'
     end
   end
 
   describe '#signature' do
-    subject { instance.signature }
+    subject { super().signature }
 
-    it 'should return a unique and predictable key' do
-      subject.should == 'barfoo'
+    it 'returns a unique and predictable key' do
+      expect(subject).to eq 'barfoo'
     end
   end
 
   describe '#structure' do
-    subject { instance.structure }
+    subject { super().structure }
 
     context 'with no previously defined signature' do
       before do
-        instance.stub( :structure_expired? ).and_return true
+        allow(instance).to receive(:structure_expired?).and_return(true)
       end
 
-      it 'should rebuild the structure' do
-        instance.should_receive :rebuild_structure!
-
+      it 'rebuilds the structure' do
+        allow(instance).to receive(:rebuild_structure!).and_call_original
         subject
+        expect(instance).to have_received(:rebuild_structure!)
       end
     end
 
     context 'with a fresh signature' do
       before do
         instance.structure
-
-        instance.stub( :structure_expired? ).and_return false
+        allow(instance).to receive(:structure_expired?).and_return(false)
       end
 
-      it 'should not rebuild the structure' do
-        instance.should_receive( :rebuild_structure! ).never
-
+      it 'does not rebuild the structure' do
+        allow(instance).to receive(:rebuild_structure!)
         subject
+        expect(instance).to_not have_received(:rebuild_structure!)
       end
     end
 
     context 'with an expired signature' do
       before do
         instance.structure
-
-        instance.stub( :structure_expired? ).and_return true
+        allow(instance).to receive(:structure_expired?).and_return(true)
       end
 
-      it 'should rebuild the structure' do
-        instance.should_receive :rebuild_structure!
-
+      it 'rebuilds the structure' do
+        allow(instance).to receive(:rebuild_structure!)
         subject
+        expect(instance).to have_received(:rebuild_structure!)
       end
     end
   end
@@ -86,42 +87,40 @@ describe Frenetic::Structured do
   describe '#fetch_structure' do
     before { instance.structure }
 
-    subject { instance.fetch_structure }
+    subject { super().fetch_structure }
 
-    it "should return the resource's Struct class" do
-      subject.should == Struct::MyTempResourceFreneticResourceStruct
+    it 'returns the Struct class of the resource' do
+      expect(subject).to eq 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 { super().rebuild_structure! }
 
+    it 'destroys the previous Struct' do
+      allow(instance).to receive(:destroy_structure!).and_call_original
       subject
+      expect(instance).to have_received(:destroy_structure!)
     end
 
-    it "should add cache the resource's signature" do
-      sigs = described_class.class_variable_get('@@signatures')
-
-      sigs.should include
+    it 'caches the signature of the resource' do
+      subject
+      expect(signatures).to include signature
     end
 
-    it "should build the resource's Struct" do
+    it 'builds the Struct resource' do
       subject
-
-      instance.fetch_structure.members.should == [:foo, :bar]
+      expect(instance.fetch_structure.members).to eq [:foo, :bar]
     end
   end
 
   describe '#structure_expired?' do
-    subject { instance.structure_expired? }
+    subject { super().structure_expired? }
 
     before do
-      instance.stub( :signature ).and_return new_sig
+      allow(instance).to receive(:signature).and_return(new_sig)
       described_class.class_variable_set '@@signatures', {
         'MyTempResourceFreneticResourceStruct' => old_sig
       }
@@ -131,84 +130,80 @@ describe Frenetic::Structured do
       let(:old_sig) { 'fresh' }
       let(:new_sig) { 'fresh' }
 
-      it { should be_false }
+      it 'return FALSE' do
+        expect(subject).to eq false
+      end
     end
 
     context 'with no predefined signature' do
       let(:old_sig) { nil }
       let(:new_sig) { 'new' }
 
-      it { should be_true }
+      it 'returns TRUE' do
+        expect(subject).to eq true
+      end
     end
 
     context 'with an expired signature' do
       let(:old_sig) { 'old' }
       let(:new_sig) { 'new' }
 
-      it { should be_true }
+      it 'returns TRUE' do
+        expect(subject).to eq true
+      end
     end
   end
 
   describe '#structure_defined?' do
-    subject { instance.structure_defined? }
-
     let(:consts) { Struct.constants || [] }
 
     before do
-      Struct.stub(:constants).and_return consts
+      allow(Struct).to receive(: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 { super().structure_defined? }
 
+    it 'checks if the structure is defined' do
+      allow(instance).to receive(:struct_key).and_return('Foo')
+      allow(consts).to receive(:include?)
       subject
+      expect(consts).to have_received(:include?).with(:Foo)
     end
   end
 
   describe '#destroy_structure!' do
     before { instance.structure }
 
-    subject { instance.destroy_structure! }
+    subject { super().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
-
+      it 'does not attempt to remove the constant from the Struct' do
+        allow(Struct).to receive(:remove_const)
         subject
+        expect(Struct).to_not have_received(:remove_const)
       end
 
-      it 'should not remove the signature from the cache' do
-        described_class.class_variable_get('@@signatures').should_receive( :delete ).never
-
+      it 'does not remove the signature from the cache' do
+        allow(signatures).to receive(:delete)
         subject
+        expect(signatures).to_not receive(:delete)
       end
     end
 
     context 'with an predefined structure' do
-      it 'should remove the constant' do
-        Struct.constants.should include instance.struct_key.to_sym
-
+      it 'removes the constant' do
+        expect(Struct.constants).to include instance.struct_key.to_sym
         subject
-
-        Struct.constants.should_not include instance.struct_key.to_sym
+        expect(Struct.constants).to_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
-
+      it 'removes the signature from the cache' do
+        expect(signatures).to include signature
         subject
-
-        described_class.class_variable_get('@@signatures').should_not include signature
+        expect(signatures).to_not include signature
       end
     end
   end
-
 end