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

data/spec/resource_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe Frenetic::Resource do
   let(:test_cfg) { { url:'http://example.com/api' } }
 
-  let(:my_temp_resource) do
+  let(:abstract_resource) do
     cfg = test_cfg
 
     Class.new(described_class) do
@@ -12,7 +12,7 @@ describe Frenetic::Resource do
   end
 
   before do
-    stub_const 'MyNamespace::MyTempResource', my_temp_resource
+    stub_const 'MyNamespace::MyTempResource', abstract_resource
   end
 
   describe '.api_client' do
@@ -34,26 +34,22 @@ describe Frenetic::Resource do
       end
 
       context 'a block argument' do
-        before do
-          configure_with_block!
-        end
+        before { configure_with_block! }
 
         subject { MyNamespace::MyTempResource.instance_variable_get '@api_client' }
 
-        it 'should save a reference to the argument' do
-          subject.should be_a Proc
+        it 'saves a reference to the argument' do
+          expect(subject).to be_a Proc
         end
       end
 
       context 'a Frenetic instance' do
-        before do
-          configure_with_instance!
-        end
+        before { configure_with_instance! }
 
         subject { MyNamespace::MyTempResource.instance_variable_get '@api_client' }
 
-        it 'should save a reference to the argument' do
-          subject.should be_an_instance_of Frenetic
+        it 'saves a reference to the argument' do
+          expect(subject).to be_an_instance_of Frenetic
         end
       end
 
@@ -62,25 +58,24 @@ describe Frenetic::Resource do
 
         context 'and a previously stored @api_client' do
           context 'Proc' do
-            before do
-              configure_with_block!
-            end
+            before { configure_with_block! }
 
-            it 'should call the Proc' do
+            let(:api_client) do
               MyNamespace::MyTempResource.instance_variable_get('@api_client')
-                .should_receive 'call'
+            end
 
+            it 'calls the Proc' do
+              allow(api_client).to receive(:call)
               subject
+              expect(api_client).to have_received(:call)
             end
           end
 
           context 'Frenetic instance' do
-            before do
-              configure_with_instance!
-            end
+            before { configure_with_instance! }
 
-            it 'should return the instance' do
-              subject.should be_an_instance_of Frenetic
+            it 'returns the instance' do
+              expect(subject).to be_an_instance_of Frenetic
             end
           end
         end
@@ -90,11 +85,15 @@ describe Frenetic::Resource do
 
   describe '.namespace' do
     before do
-      stub_const 'MyNamespace::MyTempResource', my_temp_resource
+      stub_const 'MyNamespace::MyTempResource', abstract_resource
     end
 
     subject { MyNamespace::MyTempResource.namespace }
 
+    let(:namespace) do
+      MyNamespace::MyTempResource.instance_variable_get('@namespace')
+    end
+
     context 'with an argument' do
       before do
         MyNamespace::MyTempResource.class_eval do
@@ -102,30 +101,24 @@ describe Frenetic::Resource do
         end
       end
 
-      it 'should return that value' do
-        subject.should == 'test_spec'
+      it 'returns that value' do
+        expect(subject).to eq 'test_spec'
       end
 
-      it 'should internally save the value' do
+      it 'internally saves the value' do
         subject
-
-        ns = MyNamespace::MyTempResource.instance_variable_get '@namespace'
-
-        ns.should == 'test_spec'
+        expect(namespace).to eq 'test_spec'
       end
     end
 
     context 'with no argument' do
-      it 'should infer the value' do
-        subject.should == 'my_temp_resource'
+      it 'infers the value' do
+        expect(subject).to eq 'my_temp_resource'
       end
 
-      it 'should cache the inferrence' do
+      it 'caches the inferrence' do
         subject
-
-        ns = MyNamespace::MyTempResource.instance_variable_get '@namespace'
-
-        ns.should == 'my_temp_resource'
+        expect(namespace).to eq 'my_temp_resource'
       end
     end
   end
@@ -136,18 +129,43 @@ describe Frenetic::Resource do
     subject { MyNamespace::MyTempResource.properties }
 
     context 'for a known resource' do
-      it 'should return a list of properties defined by the API' do
-        subject.should_not be_empty
+      it 'returns a list of properties defined by the API' do
+        expect(subject).to_not be_empty
       end
     end
 
     context 'for an unknown resource' do
       before do
-        MyNamespace::MyTempResource.stub(:namespace).and_return Time.now.to_i.to_s
+        allow(MyNamespace::MyTempResource)
+          .to receive(:namespace)
+          .and_return(Time.now.to_i.to_s)
+      end
+
+      it 'raises an error' do
+        expect{subject}.to raise_error Frenetic::HypermediaError
+      end
+    end
+
+    context 'in test mode' do
+      let(:mock_abstract_resource) do
+        Class.new(MyNamespace::MyTempResource) do
+          include Frenetic::ResourceMockery
+
+          def self.default_attributes
+            { foo:123 }
+          end
+        end
+      end
+
+      before do
+        stub_const 'MyNamespace::MockMyTempResource', mock_abstract_resource
+        allow(MyNamespace::MyTempResource)
+          .to receive(:test_mode?)
+          .and_return(true)
       end
 
-      it 'should raise an error' do
-        expect{ subject }.to raise_error Frenetic::HypermediaError
+      it 'returns the default attributes of the mock' do
+        expect(subject).to eq(foo:123)
       end
     end
   end
@@ -157,11 +175,10 @@ describe Frenetic::Resource do
 
     before do
       stub_const 'MyNamespace::MyMockResource', Class.new(MyNamespace::MyTempResource)
-
       MyNamespace::MyMockResource.send :include, Frenetic::ResourceMockery
     end
 
-    it 'should initialize the mock with the provided values' do
+    it 'initializes the mock with the provided values' do
       expect(subject.id).to eq 99
     end
   end
@@ -170,19 +187,18 @@ describe Frenetic::Resource do
     subject { MyNamespace::MyTempResource.mock_class }
 
     context 'without a defined Mock-class' do
-      it 'should raise an error' do
-        expect{subject}.to raise_error Frenetic::ClientError
+      it 'raises an error' do
+        expect{subject}.to raise_error Frenetic::UndefinedResourceMock
       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
+      it 'returns a mock instance of the resource' do
         expect(subject).to eq MyNamespace::MyMockResource
       end
     end
@@ -196,30 +212,58 @@ describe Frenetic::Resource do
     context 'with no arguments' do
       let(:args) {}
 
-      it 'should have default attributes' do
-        subject.name.should be_nil
+      it 'has default attributes' do
+        expect(subject.name).to be_nil
       end
     end
 
     context 'with known attributes' do
       let(:args) { { name:'foo' } }
 
-      it 'should set the appropriate values' do
-        subject.name.should == 'foo'
+      it 'sets the appropriate values' do
+        expect(subject.name).to eq 'foo'
+      end
+
+      context 'and an embedded resource' do
+        let(:args) do
+          super().merge({
+            '_embedded' => {
+              'abstract_resource' => {
+                'id' => 99,
+                'genus' => 'canine'
+              }
+            }
+          })
+        end
+
+        context 'this is of a known type' do
+          before do
+            stub_const 'MyNamespace::AbstractResource', abstract_resource
+          end
+
+          it 'instantiates the embedded resource' do
+            expect(subject.abstract_resource).to be_an_instance_of MyNamespace::AbstractResource
+          end
+        end
+
+        context 'this is of a known type' do
+          it 'instantiates a shim of the embedded resource' do
+            expect(subject.abstract_resource).to be_an_instance_of OpenStruct
+          end
+        end
       end
     end
 
     context 'with unknown attributes' do
       let(:args) { { gender:'male' } }
 
-      it 'should not create accessors' do
+      it 'does not create accessors' do
         expect{ subject.gender }.to raise_error NoMethodError
       end
 
-      it 'should be accessible in @params' do
-        params = subject.instance_variable_get( '@params' )
-
-        params.should include 'gender' => 'male'
+      it 'is accessible in @params' do
+        params = subject.instance_variable_get('@params')
+        expect(params).to include 'gender' => 'male'
       end
     end
 
@@ -227,11 +271,13 @@ describe Frenetic::Resource do
       let(:args) {}
 
       before do
-        MyNamespace::MyTempResource.stub(:namespace).and_return Time.now.to_i.to_s
+        allow(MyNamespace::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
   end
@@ -239,9 +285,10 @@ describe Frenetic::Resource do
   describe '#attributes' do
     before { @stubs.api_description }
 
-    subject { MyNamespace::MyTempResource.new(name:'me').attributes }
+    subject { MyNamespace::MyTempResource.new(id:54, name:'me').attributes }
 
-    it { should == { 'name' => 'me' } }
+    it 'returns attributes of the resource' do
+      expect(subject).to eq({'id' => 54, 'name' => 'me'})
+    end
   end
-
 end

data/spec/support/rspec.rb

@@ -1,5 +1,4 @@
 RSpec.configure do |config|
   config.filter_run focus:true
   config.run_all_when_everything_filtered = true
-  config.treat_symbols_as_metadata_keys_with_true_values = true
 end

metadata

@@ -1,160 +1,169 @@
 --- !ruby/object:Gem::Specification
 name: frenetic
 version: !ruby/object:Gem::Version
-  version: 0.0.20.alpha.6
-  prerelease: 7
+  version: 1.0.0.alpha.1
 platform: ruby
 authors:
 - Derek Lindahl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-17 00:00:00.000000000 Z
+date: 2014-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.7
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.7
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.3.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.3.4
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.13.0
+        version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.13.0
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: rack-cache
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: faraday-http-cache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.2
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.11.0
+        version: 1.18.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.11.0
+        version: 1.18.0
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.1
+        version: 1.0.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.1
+        version: 1.0.2
 description: An opinionated Ruby-based Hypermedia API client.
 email:
 - dlindahl@customink.com
@@ -162,40 +171,47 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .irbrc
-- .ruby-version
-- .travis.yml
+- ".gitignore"
+- ".irbrc"
+- ".ruby-version"
+- ".travis.yml"
+- Appraisals
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - frenetic.gemspec
+- gemfiles/faraday_08.gemfile
+- gemfiles/faraday_08.gemfile.lock
+- gemfiles/faraday_09.gemfile
+- gemfiles/faraday_09.gemfile.lock
 - lib/frenetic.rb
-- lib/frenetic/concerns/briefly_memoizable.rb
+- lib/frenetic/briefly_memoizable.rb
 - lib/frenetic/concerns/collection_rest_methods.rb
-- 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/connection.rb
+- lib/frenetic/errors.rb
+- lib/frenetic/hypermedia_link.rb
+- lib/frenetic/hypermedia_link_set.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/briefly_memoizable_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/connection_spec.rb
 - spec/fixtures/test_api_requests.rb
 - spec/frenetic_spec.rb
+- spec/hypermedia_link_set_spec.rb
+- spec/hypermedia_link_spec.rb
 - spec/middleware/hal_json_spec.rb
 - spec/resource_collection_spec.rb
+- spec/resource_mockery_spec.rb
 - spec/resource_spec.rb
 - spec/spec_helper.rb
 - spec/support/rspec.rb
@@ -203,44 +219,41 @@ files:
 - spec/support/webmock.rb
 homepage: http://dlindahl.github.com/frenetic/
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
-      segments:
-      - 0
-      hash: -828936829114139905
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>'
+  - - ">"
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Here lies a Ruby-based Hypermedia API client that expects HAL+JSON and makes
   a lot of assumptions about your API.
 test_files:
-- spec/concerns/breifly_memoizable_spec.rb
-- spec/concerns/configurable_spec.rb
+- spec/briefly_memoizable_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/connection_spec.rb
 - spec/fixtures/test_api_requests.rb
 - spec/frenetic_spec.rb
+- spec/hypermedia_link_set_spec.rb
+- spec/hypermedia_link_spec.rb
 - spec/middleware/hal_json_spec.rb
 - spec/resource_collection_spec.rb
+- spec/resource_mockery_spec.rb
 - spec/resource_spec.rb
 - spec/spec_helper.rb
 - spec/support/rspec.rb