acfs 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9983fabc6b3c91e17cf08ac15da6e51aecf584b5
-  data.tar.gz: 53f6525a13c507bd7cac8132d2618a2b92e551ca
+  metadata.gz: 69903ec6f49f6fb0d192c60aa302ddc9ba16f940
+  data.tar.gz: bb15a106632b4d5f3681d829bee1b4e547d61039
 SHA512:
-  metadata.gz: 7869d4338121f188461dd2e2b4383f1175ebec3255e868a36cd53c63df31cbf6bb746135c8aaddebefb3f3ec5185e565606330a23ebcd75f3f4f838a94ec3591
-  data.tar.gz: d9c7a0575f86fd9e2b71fc98336166aef3e770e82fe6c7f5365b7751eeee78a987fa8eb433b326e228ceccc62c2daba610268664594b5992127911676f5aa735
+  metadata.gz: 4acac2d53426422d60c59502fde95f17893fabced18c70d9236c3473c1250be5ac492f8ff6271db2073340af96725dee05748a6a5de43d9f92fa330fb3ef060d
+  data.tar.gz: d4aefee793caaad3a20afcc1c703b07882492805ad80ce70efb9fafda71700f425ed2246e8964e03c839cfd1f9ebe6da255872316afceabe15bea413161ad518

data/README.md

@@ -13,7 +13,7 @@ level and automatic request queuing and parallel processing. See Usage for more.
 
 Add this line to your application's Gemfile:
 
-    gem 'acfs', '~> 0.10.0'
+    gem 'acfs', '~> 0.11.0'
 
 **Note:** Acfs is under development. I'll try to avoid changes to the public
 API but internal APIs may change quite often.

data/lib/acfs.rb

@@ -17,6 +17,7 @@ module Acfs
 
     autoload :Base
     autoload :Print
+    autoload :Logger
     autoload :JsonDecoder
     autoload :MessagePackDecoder, 'acfs/middleware/msgpack_decoder'
     autoload :JsonEncoder

data/lib/acfs/adapter/typhoeus.rb

@@ -21,6 +21,12 @@ module Acfs
         hydra.queue convert_request(req)
       end
 
+      # Remove all requests from queue.
+      #
+      def clear
+        hydra.abort
+      end
+
     protected
       def hydra
         @hydra ||= ::Typhoeus::Hydra.new
@@ -41,7 +47,10 @@ module Acfs
       end
 
       def convert_response(request, response)
-        Acfs::Response.new(request, response.code, response.headers, response.body)
+        Acfs::Response.new request,
+                           status: response.code,
+                           headers: response.headers,
+                           body: response.body
       end
     end
   end

data/lib/acfs/errors.rb

@@ -2,6 +2,22 @@ module Acfs
 
   # Acfs base error.
   #
-  class Error < StandardError; end
+  class Error < StandardError
+  end
+
+  # Response error containing the responsible response object.
+  #
+  class ErroneousResponse < Error
+    attr_accessor :response
+
+    def initialize(response)
+      self.response = response
+    end
+  end
+
+  # Resource not found error raised on a 404 response
+  #
+  class ResourceNotFound < ErroneousResponse
+  end
 
 end

data/lib/acfs/middleware/logger.rb

@@ -0,0 +1,25 @@
+require 'logger'
+
+module Acfs
+  module Middleware
+
+    # Log requests and responses.
+    #
+    class Logger < Base
+
+      def initialize(app, options = {})
+        super
+        @logger = options[:logger] if options[:logger]
+      end
+
+      def response(res, nxt)
+        logger.info "[ACFS] #{res.request.method.to_s.upcase} #{res.request.url} -> #{res.status}"
+        nxt.call res
+      end
+
+      def logger
+        @logger ||= ::Logger.new STDOUT
+      end
+    end
+  end
+end

data/lib/acfs/model/attributes.rb

@@ -73,7 +73,7 @@ module Acfs::Model
     #
     def write_attribute(name, value, opts = {})
       if (type = self.class.attribute_types[name.to_sym]).nil?
-        raise "Unknown attribute #{name}."
+        raise "Unknown attribute `#{name}`."
       end
 
       write_raw_attribute name, value.nil? ? nil : type.cast(value), opts

data/lib/acfs/model/query_methods.rb

@@ -58,9 +58,13 @@ module Acfs::Model
         model = self.new
 
         request = Acfs::Request.new url(id.to_s) do |response|
-          model.attributes = response.data
-          model.loaded!
-          block.call model unless block.nil?
+          if response.success?
+            model.attributes = response.data
+            model.loaded!
+            block.call model unless block.nil?
+          else
+            raise_error_for response
+          end
         end
         service.queue request
 
@@ -81,6 +85,15 @@ module Acfs::Model
           end
         end
       end
+      
+      def raise_error_for(response)
+        case response.code
+          when 404
+            raise ::Acfs::ResourceNotFound.new response
+          else
+            raise ::Acfs::ErroneousResponse.new response
+        end
+      end
     end
   end
 end

data/lib/acfs/response.rb

@@ -1,4 +1,6 @@
 require 'acfs/response/formats'
+require 'acfs/response/status'
+require 'active_support/core_ext/module/delegation'
 
 module Acfs
 
@@ -7,15 +9,20 @@ module Acfs
   #
   class Response
     attr_accessor :data
-    attr_reader :request, :status, :headers, :body
+    attr_reader :headers, :body
 
     include Response::Formats
+    include Response::Status
 
-    def initialize(request, status = 200, headers = {}, body = nil)
-      @request = request
-      @status  = status
-      @headers = headers
-      @body    = body
+    #delegate :status, :status_message, :success?, :modified?, :timed_out?,
+    #         :response_body, :response_headers, :response_code, :headers,
+    #         to: :response
+
+    def initialize(request, data = {})
+      @request  = request
+      @status   = data[:status]
+      @headers  = data[:headers]
+      @body     = data[:body]
     end
   end
 end

data/lib/acfs/response/status.rb

@@ -0,0 +1,33 @@
+module Acfs
+  class Response
+
+    # Method to fetch information about response status.
+    #
+    module Status
+
+      # Return response status code. Will return zero if
+      # request was not executed or failed on client side.
+      #
+      def status_code
+        return @status.to_i if defined? :@status
+        #return response.response_code unless response.nil?
+        #0
+      end
+      alias :code :status_code
+
+      # Return true if response was successful indicated by
+      # response status code.
+      #
+      def success?
+        code >= 200 && code < 300
+      end
+
+      # Return true unless response status code indicates that
+      # resource was not modified according to send precondition headers.
+      #
+      def modified?
+        code != 304
+      end
+    end
+  end
+end

data/lib/acfs/version.rb

@@ -1,7 +1,7 @@
 module Acfs
   module VERSION
     MAJOR = 0
-    MINOR = 10
+    MINOR = 11
     PATCH = 0
     STAGE = nil
 

data/spec/acfs/middleware/json_decoder_spec.rb

@@ -5,7 +5,7 @@ describe Acfs::Middleware::JsonDecoder do
   let(:body)     { data.to_param }
   let(:headers)  { {} }
   let(:request)  { Acfs::Request.new "fubar" }
-  let(:response) { Acfs::Response.new request, 200, headers, body }
+  let(:response) { Acfs::Response.new request, status: 200, headers: headers, body: body }
   let(:decoder)  { Acfs::Middleware::JsonDecoder.new lambda { |req| req } }
 
   before do

data/spec/acfs/middleware/msgpack_decoder_spec.rb

@@ -5,7 +5,7 @@ describe Acfs::Middleware::MessagePackDecoder do
   let(:body)     { data.to_param }
   let(:headers)  { {} }
   let(:request)  { Acfs::Request.new "fubar" }
-  let(:response) { Acfs::Response.new request, 200, headers, body }
+  let(:response) { Acfs::Response.new request, status: 200, headers: headers, body: body }
   let(:decoder)  { Acfs::Middleware::MessagePackDecoder.new lambda { |req| req } }
 
   before do

data/spec/acfs/model/query_methods_spec.rb

@@ -5,28 +5,63 @@ describe Acfs::Model::QueryMethods do
 
   describe '.find' do
     context 'with single id' do
-      before do
-        stub_request(:get, 'http://users.example.org/users/1').to_return(
-            body: MessagePack.dump({ id: 1, name: 'Anon', age: 12 }),
-            headers: {'Content-Type' => 'application/x-msgpack'})
+      context 'with successful response' do
+        before do
+          stub_request(:get, 'http://users.example.org/users/1').to_return(
+              body: MessagePack.dump({ id: 1, name: 'Anon', age: 12 }),
+              headers: {'Content-Type' => 'application/x-msgpack'})
+        end
+
+        it 'should load a single remote resource' do
+          user = model.find 1
+          Acfs.run
+
+          expect(user.attributes).to be == { id: 1, name: 'Anon', age: 12 }.stringify_keys
+        end
+
+        it 'should invoke callback after model is loaded' do
+          proc = Proc.new { }
+          proc.should_receive(:call) do |user|
+            expect(user).to be === @user
+            expect(user).to be_loaded
+          end
+
+          @user = model.find 1, &proc
+          Acfs.run
+        end
       end
 
-      it 'should load a single remote resource' do
-        user = model.find 1
-        Acfs.run
+      context 'with 404 response' do
+        before do
+          stub_request(:get, 'http://users.example.org/users/1').to_return(
+              status: 404,
+              body: MessagePack.dump({ error: 'not found' }),
+              headers: {'Content-Type' => 'application/x-msgpack'})
+        end
+
+        it 'should raise a NotFound error' do
+          @user = model.find 1
 
-        expect(user.attributes).to be == { id: 1, name: 'Anon', age: 12 }.stringify_keys
+          expect { Acfs.run }.to raise_error(Acfs::ResourceNotFound)
+
+          expect(@user).to_not be_loaded
+        end
       end
 
-      it 'should invoke callback after model is loaded' do
-        proc = Proc.new { }
-        proc.should_receive(:call) do |user|
-          expect(user).to be === @user
-          expect(user).to be_loaded
+      context 'with 500 response' do
+        before do
+          stub_request(:get, 'http://users.example.org/users/1').to_return(
+              status: 500,
+              headers: {'Content-Type' => 'text/plain'})
         end
 
-        @user = model.find 1, &proc
-        Acfs.run
+        it 'should raise a response error' do
+          @user = model.find 1
+
+          expect { Acfs.run }.to raise_error(Acfs::ErroneousResponse)
+
+          expect(@user).to_not be_loaded
+        end
       end
     end
 
@@ -40,25 +75,42 @@ describe Acfs::Model::QueryMethods do
             headers: {'Content-Type' => 'application/x-msgpack'})
       end
 
-      it 'should load a multiple remote resources' do
-        users = model.find 1, 2
-        Acfs.run
+      context 'with successful response' do
+        it 'should load a multiple remote resources' do
+          users = model.find 1, 2
+          Acfs.run
 
-        expect(users.size).to be == 2
-        expect(users[0].attributes).to be == { id: 1, name: 'Anon', age: 12 }.stringify_keys
-        expect(users[1].attributes).to be == { id: 2, name: 'Johnny', age: 42 }.stringify_keys
+          expect(users.size).to be == 2
+          expect(users[0].attributes).to be == { id: 1, name: 'Anon', age: 12 }.stringify_keys
+          expect(users[1].attributes).to be == { id: 2, name: 'Johnny', age: 42 }.stringify_keys
+        end
+
+        it 'should invoke callback after all models are loaded' do
+          proc = Proc.new { }
+          proc.should_receive(:call) do |users|
+            expect(users).to be === @users
+            expect(users.size).to be == 2
+            expect(users).to be_loaded
+          end
+
+          @users = model.find 1, 2, &proc
+          Acfs.run
+        end
       end
 
-      it 'should invoke callback after all models are loaded' do
-        proc = Proc.new { }
-        proc.should_receive(:call) do |users|
-          expect(users).to be === @users
-          expect(users.size).to be == 2
-          expect(users).to be_loaded
+      context 'with one 404 response' do
+        before do
+          stub_request(:get, 'http://users.example.org/users/1').to_return(
+              status: 404,
+              body: MessagePack.dump({ error: 'not found' }),
+              headers: {'Content-Type' => 'application/x-msgpack'})
         end
 
-        @users = model.find 1, 2, &proc
-        Acfs.run
+        it 'should raise resource not found error' do
+          model.find 1, 2
+
+          expect { Acfs.run }.to raise_error(Acfs::ResourceNotFound)
+        end
       end
     end
   end

data/spec/acfs/response/formats_spec.rb

@@ -6,7 +6,7 @@ describe Acfs::Response::Formats do
   let(:headers)   { { 'Content-Type' => mime_type } }
   let(:request)   { Acfs::Request.new 'fubar' }
   let(:body)      { nil }
-  let(:response)  { Acfs::Response.new request, status, headers, body }
+  let(:response)  { Acfs::Response.new request, status: status, headers: headers, body: body }
 
   context 'without Content-Type header' do
     let(:headers)   { {} }

data/spec/acfs/response/status_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe Acfs::Response::Status do
+  let(:status)    { 200 }
+  let(:mime_type) { 'application/unknown' }
+  let(:headers)   { { 'Content-Type' => mime_type } }
+  let(:request)   { Acfs::Request.new 'fubar' }
+  let(:body)      { nil }
+  let(:response)  { Acfs::Response.new request, status: status, headers: headers, body: body }
+
+  describe '#status_code alias #code' do
+    context 'when given' do
+      let(:status) { 200 }
+
+      it 'should return status code' do
+        expect(response.code).to be == 200
+        expect(response.status_code).to be == 200
+      end
+    end
+
+    context 'when nil' do
+      let(:status) { nil }
+
+      it 'should return zero' do
+        expect(response.code).to be == 0
+        expect(response.status_code).to be == 0
+      end
+    end
+  end
+
+  describe '#success?' do
+    context 'with success status code' do
+      let(:status) { 200 }
+      it { expect(response).to be_success }
+    end
+
+    context 'with error status code' do
+      let(:status) { 500 }
+      it { expect(response).to_not be_success }
+    end
+
+    context 'with zero status code' do
+      let(:status) { nil }
+      it { expect(response).to_not be_success }
+    end
+  end
+
+  describe '#modified?' do
+    context 'with success status code' do
+      let(:status) { 200 }
+      it { expect(response).to be_modified }
+    end
+
+    context 'with not modified status code' do
+      let(:status) { 304 }
+      it { expect(response).to_not be_modified }
+    end
+
+    context 'with error status code' do
+      let(:status) { 500 }
+      it { expect(response).to be_modified }
+    end
+
+    context 'with zero status code' do
+      let(:status) { nil }
+      it { expect(response).to be_modified }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -27,4 +27,8 @@ RSpec.configure do |config|
     # Only allow expect syntax
     c.syntax = :expect
   end
+
+  config.before :each do
+    Acfs.adapter.clear
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acfs
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Jan Graichen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-24 00:00:00.000000000 Z
+date: 2013-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -204,6 +204,7 @@ files:
 - lib/acfs/middleware/base.rb
 - lib/acfs/middleware/json_decoder.rb
 - lib/acfs/middleware/json_encoder.rb
+- lib/acfs/middleware/logger.rb
 - lib/acfs/middleware/msgpack_decoder.rb
 - lib/acfs/middleware/msgpack_encoder.rb
 - lib/acfs/middleware/print.rb
@@ -224,6 +225,7 @@ files:
 - lib/acfs/request/callbacks.rb
 - lib/acfs/response.rb
 - lib/acfs/response/formats.rb
+- lib/acfs/response/status.rb
 - lib/acfs/service.rb
 - lib/acfs/service/middleware.rb
 - lib/acfs/service/request_handler.rb
@@ -240,6 +242,7 @@ files:
 - spec/acfs/request/callbacks_spec.rb
 - spec/acfs/request_spec.rb
 - spec/acfs/response/formats_spec.rb
+- spec/acfs/response/status_spec.rb
 - spec/acfs/service_spec.rb
 - spec/acfs_spec.rb
 - spec/spec_helper.rb
@@ -281,6 +284,7 @@ test_files:
 - spec/acfs/request/callbacks_spec.rb
 - spec/acfs/request_spec.rb
 - spec/acfs/response/formats_spec.rb
+- spec/acfs/response/status_spec.rb
 - spec/acfs/service_spec.rb
 - spec/acfs_spec.rb
 - spec/spec_helper.rb