frenetic 0.0.20.alpha.3 → 0.0.20.alpha.4

data/README.md

@@ -340,6 +340,19 @@ 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.
 
+#### Requesting Resources
+
+Given the above `Order` example, and a supporting API, you can query the API
+like so:
+
+```ruby
+> Order.find(1)
+# <Order id=1 total=54.47>
+
+> Order.all
+# [<Order id=1 total=54.47>,<Order id=2 total=42.00>]
+```
+
 #### Mocking Resources
 
 Sometimes, when you are writing tests for your API client, it is helpful to have

data/lib/frenetic/concerns/briefly_memoizable.rb

@@ -23,6 +23,10 @@ module BrieflyMemoizable
                                                                                  #
           #{memoized_ivar} ||= #{original_method}(*args)                         #   @mime_type ||= _unmemoized_mime_type(*args)
         end                                                                      # end
+
+        def reload_#{symbol}!                                                    # def reload_mime_type!
+          #{memoized_ivar} = nil                                                 #   @mime_type = nil
+        end                                                                      # end
       EOS
     end
   end

data/lib/frenetic/concerns/hal_linked.rb

@@ -28,6 +28,12 @@ class Frenetic
         parse_link link, params
       end
 
+      def collection_url
+        link = links[namespace.pluralize] or raise HypermediaError, %Q{No Hypermedia GET Url found for the resource "#{namespace.pluralize}"}
+
+        link['href']
+      end
+
       def parse_link( link, params = {} )
         if link['templated']
           expand_link link, params

data/lib/frenetic/concerns/member_rest_methods.rb

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

data/lib/frenetic/configuration.rb

@@ -31,6 +31,7 @@ class Frenetic
         default_root_cache_age: default_root_cache_age,
         headers:   headers,
         password:  password,
+        ssl:       ssl,
         url:       url,
         username:  username
       }
@@ -66,6 +67,10 @@ class Frenetic
       @_cfg[:password] || @_cfg[:api_key]
     end
 
+    def ssl
+      @_cfg[:ssl] || { verify:true }
+    end
+
     def url
       Addressable::URI.parse @_cfg[:url]
     end

data/lib/frenetic/middleware/hal_json.rb

@@ -13,7 +13,13 @@ class Frenetic
           raise ClientError, env[:body]['error']
         end
       rescue Faraday::Error::ParsingError => err
-        raise ParsingError, err.message
+        if (500...599).include? env[:status]
+          raise ServerError, "#{env[:status]} Error encountered"
+        elsif (400...499).include? env[:status]
+          raise ClientError, "#{env[:status]} Error encountered"
+        else
+          raise ParsingError, err.message
+        end
       end
 
     end

data/lib/frenetic/resource.rb

@@ -69,8 +69,10 @@ class Frenetic
       @structure
     end
 
-    def __setobj__
-      @structure
+    def __setobj__( obj )
+      @attributes = nil
+
+      @structure = obj
     end
 
     def inspect

data/lib/frenetic/resource_collection.rb

@@ -9,7 +9,7 @@ class Frenetic
     def initialize( resource, params = {} )
       @resource_class = resource
       @resources      = []
-      @params         = params
+      @params         = params || {}
 
       extract_resources!
     end
@@ -37,10 +37,14 @@ class Frenetic
   private
 
     def extract_resources!
-      @resources = @params['_embedded'][collection_key].collect do |resource|
+      @resources = embedded_collection.collect do |resource|
         @resource_class.new resource
       end
     end
 
+    def embedded_collection
+      @params.fetch('_embedded',{}).fetch(collection_key, [])
+    end
+
   end
 end

data/lib/frenetic/version.rb

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

data/spec/concerns/breifly_memoizable_spec.rb

@@ -53,6 +53,16 @@ describe BrieflyMemoizable do
 
           instance.fetch
         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
+
+            instance.fetch
+          end
+        end
       end
     end
   end

data/spec/concerns/hal_linked_spec.rb

@@ -38,16 +38,16 @@ 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
-            }
+    let(:_links) do
+      {
+        '_links' => {
+          'self' => { 'href' => '/api/self' },
+          'my_temp_resource' => {
+            'href' => '/api/my_temp_resource/{id}', 'templated' => true
           }
         }
-      end
+      }
+    end
 
     context 'with a link that matches the resource name' do
       it 'should return the named link' do
@@ -113,4 +113,26 @@ describe Frenetic::HalLinked do
       end
     end
   end
+
+  describe '.collection_url' do
+    subject { MyTempResource.collection_url }
+
+    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
+      it 'simply return the URL' do
+        subject.should == '/api/my_temp_resources'
+      end
+    end
+  end
 end

data/spec/concerns/member_rest_methods_spec.rb

@@ -23,19 +23,45 @@ describe Frenetic::MemberRestMethods do
     subject { MyTempResource.find 1 }
 
     context 'for a known instance' do
-      before { @stubs.known_resource }
+      before { @stubs.known_instance }
 
       it 'should return 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
+          expect(subject).to be_a MyTempResource
+        end
+      end
     end
 
     context 'for an unknown instance' do
-      before { @stubs.unknown_resource }
+      before { @stubs.unknown_instance }
 
       it 'should raise an error' do
         expect{ subject }.to raise_error Frenetic::ClientError
       end
     end
   end
+
+  describe '.all' do
+    before { @stubs.api_description }
+
+    subject { MyTempResource.all }
+
+    context 'for a known resource' do
+      before { @stubs.known_resource }
+
+      it 'should return a resource collection' do
+        expect(subject).to be_an_instance_of Frenetic::ResourceCollection
+      end
+
+      it 'should instantiate all resources in the collection' do
+        expect(subject.first).to be_an_instance_of MyTempResource
+      end
+    end
+  end
 end

data/spec/configuration_spec.rb

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

data/spec/fixtures/test_api_requests.rb

@@ -25,9 +25,18 @@ class HttpStubs
     end
   end
 
-  def api_server_error
+  def api_html_response
     @rspec.stub_request( :any, 'example.com/api' )
-      .to_return response( body:{error:'500 Server Error'}, status:500 )
+      .to_return response( body:'Non-JSON response', status:200 )
+  end
+
+  def api_server_error( type = :json )
+    body = '500 Server Error'
+
+    body = { 'error' => body }.to_json if type == :json
+
+    @rspec.stub_request( :any, 'example.com/api' )
+      .to_return response( body:body, status:500 )
   end
 
   def api_client_error( type = :json )
@@ -44,16 +53,27 @@ class HttpStubs
       .to_return response( body:schema, headers:{ 'Cache-Control' => 'max-age=3600, public' } )
   end
 
-  def unknown_resource
+  def unknown_instance
     @rspec.stub_request( :get, 'example.com/api/my_temp_resources/1' )
       .to_return response( body:{ 'error' => '404 Not Found' }, status:404 )
   end
 
-  def known_resource
+  def known_instance
     @rspec.stub_request( :get, 'example.com/api/my_temp_resources/1' )
       .to_return response( body:{ 'name' => 'Resource Name' } )
   end
 
+  def known_resource
+    @rspec.stub_request( :get, 'example.com/api/my_temp_resources' )
+      .to_return response( body:{
+        '_embedded' => {
+          'my_temp_resources' => [
+            { 'name' => 'Resource Name' }
+          ]
+        }
+      } )
+  end
+
   def schema
     {
       _embedded: {

data/spec/frenetic_spec.rb

@@ -78,10 +78,28 @@ describe Frenetic do
       end
 
       context 'JSON parsing error' do
-        before { @stubs.api_client_error :text }
+        context 'for an otherwise successful response' do
+          before { @stubs.api_html_response }
 
-        it 'should raise an error' do
-          expect{ subject }.to raise_error Frenetic::ParsingError
+          it 'should raise an error' do
+            expect{ subject }.to raise_error Frenetic::ParsingError
+          end
+        end
+
+        context 'for a server error' do
+          before { @stubs.api_server_error :text }
+
+          it 'should raise an error' do
+            expect{ subject }.to raise_error Frenetic::ServerError, '500 Error encountered'
+          end
+        end
+
+        context 'for a client error' do
+          before { @stubs.api_client_error :text }
+
+          it 'should raise an error' do
+            expect{ subject }.to raise_error Frenetic::ClientError, '404 Error encountered'
+          end
         end
       end
     end

data/spec/resource_collection_spec.rb

@@ -67,8 +67,14 @@ describe Frenetic::ResourceCollection do
     subject.links.should_not be_empty
   end
 
+  context 'for a non-embedded resource' do
+    subject { described_class.new(MyTempResource) }
+
+    it { should be_empty }
+  end
+
   describe '#get' do
-    before { @stubs.known_resource }
+    before { @stubs.known_instance }
 
     subject { super().get(1) }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: frenetic
 version: !ruby/object:Gem::Version
-  version: 0.0.20.alpha.3
+  version: 0.0.20.alpha.4
   prerelease: 7
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-14 00:00:00.000000000 Z
+date: 2013-05-15 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: -3162981887620573122
+      hash: -3576003086095464905
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: