acfs 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 36f33bb4ccf82d17ac10c0c1a142476817229231
-  data.tar.gz: a881457d71f8437c9f81466e928eb4e7cb57df90
+  metadata.gz: 07e4fa8c5a501299db87e1fd63da042f42b4064d
+  data.tar.gz: 267732ea7fae5e6d110038ff8769ceb8ee3fb9dd
 SHA512:
-  metadata.gz: fcb651f2c3c488d05fdebcd2a63ac2c6612a5d19188519456a1d690cccfe6fdc7786aeeddef7ae6dd30170aa9cc11a4b342037d2102ed4eb67d1b983950e8922
-  data.tar.gz: eed4cc6c2c6dd9071c40c22fc5786541e7c5e615e708affe2d772e5d7a6e2c9005cb2d97e664bef9acad7cf222fa16904282797a7da1b27c4255a586c65f1aeb
+  metadata.gz: 1ef40e8272f8396f232e14efd645ded71b393cdeeea7ddd4057b3e671d212ab627d03e39b58e32e62f90e478b26656b1856ad48e9ad8cdf747c707ae284d5001
+  data.tar.gz: d5693941256b767e34fe7934bdfba838156af64f00d1c3d7bd29fc24a1483b4473d3adcfeba616d709183c14bbbe7db8790c8864a3d8918eb2db2b74ec3ea58d

data/README.md

@@ -10,7 +10,7 @@ TODO: Write a gem description
 
 Add this line to your application's Gemfile:
 
-    gem 'acfs', '0.6.0'
+    gem 'acfs', '0.7.0'
 
 **Note:** Acfs is under development. I'll try to avoid changes to the public
 API but internal APIs may change quite often.
@@ -30,6 +30,12 @@ First you need to define your service(s):
 ```ruby
 class UserService < Acfs::Service
   self.base_url = 'http://users.myapp.org'
+
+  # You can configure middlewares you want use for the service here.
+  # Each service has it own middleware stack.
+  #
+  use Acfs::Middleware::JsonDecoder
+  use Acfs::Middleware::MessagePackDecoder
 end
 ```
 
@@ -114,24 +120,25 @@ Acfs.run # This call will fire all request as parallel as possible.
 @user.name       # => "John
 @comments.size   # => 25
 @friends[0].name # => "Miraculix"
+```
 
 ## TODO
 
 * Create/Update operations
 * High level features
-** Pagination? Filtering? (If service API provides such features.)
-** Messaging Queue support for services and models
+    * Pagination? Filtering? (If service API provides such features.)
+    * Messaging Queue support for services and models
 * Documentation
 
 ## Contributing
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
-3a. Add specs for your feature
-3b. Implement your feature
-3c. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+4. Add specs for your feature
+5. Implement your feature
+6. Commit your changes (`git commit -am 'Add some feature'`)
+7. Push to the branch (`git push origin my-new-feature`)
+8. Create new Pull Request
 
 ## License
 

data/lib/acfs.rb

@@ -33,35 +33,9 @@ module Acfs
       adapter.run
     end
 
-    def queue(req, &block)
-      request = Request.new req
-      request.on_complete &block if block_given?
-      middleware.call request
-    end
-
     def adapter
       @adapter ||= Adapter::Typhoeus.new
     end
-
-    def middleware
-      @middleware ||= proc do |request|
-        adapter.queue request
-      end
-    end
-
-    def use(klass, options = {})
-      @middlewares ||= []
-
-      return false if @middlewares.include? klass
-
-      @middlewares << klass
-      @middleware = klass.new(middleware, options)
-    end
-
-    def clear
-      @middleware  = nil
-      @middlewares = nil
-    end
   end
 end
 

data/lib/acfs/model/query_methods.rb

@@ -37,7 +37,7 @@ module Acfs::Model
       def all(params = {}, &block)
         collection = ::Acfs::Collection.new
 
-        service.queue(Acfs::Request.new(url, params: params)) do |response|
+        request = Acfs::Request.new(url, params: params) do |response|
           response.data.each do |obj|
             collection << self.new.tap do |m|
               m.attributes = obj
@@ -47,6 +47,7 @@ module Acfs::Model
           collection.loaded!
           block.call collection unless block.nil?
         end
+        service.queue request
 
         collection
       end
@@ -56,12 +57,12 @@ module Acfs::Model
       def find_single(id, opts, &block)
         model = self.new
 
-        request = Acfs::Request.new url(id.to_s)
-        service.queue(request) do |response|
+        request = Acfs::Request.new url(id.to_s) do |response|
           model.attributes = response.data
           model.loaded!
           block.call model unless block.nil?
         end
+        service.queue request
 
         model
       end

data/lib/acfs/request.rb

@@ -11,7 +11,7 @@ module Acfs
 
     include Request::Callbacks
 
-    def initialize(url, options = {})
+    def initialize(url, options = {}, &block)
       @url = URI.parse(url).tap do |url|
         @data    = options.delete(:data) || nil
         @format  = options.delete(:format) || :json
@@ -20,6 +20,7 @@ module Acfs
 
         url.query = nil # params.any? ? params.to_param : nil
       end.to_s
+      on_complete &block if block_given?
     end
 
     def data?

data/lib/acfs/service.rb

@@ -1,3 +1,6 @@
+require 'acfs/service/middleware'
+require 'acfs/service/queue'
+
 module Acfs
 
   # Service object.
@@ -6,6 +9,9 @@ module Acfs
     attr_accessor :options
     class_attribute :base_url
 
+    include Service::Queue
+    include Service::Middleware
+
     def initialize(options = {})
       @options = options
     end
@@ -22,9 +28,5 @@ module Acfs
       url += "/#{options[:suffix].to_s}" if options[:suffix]
       url
     end
-
-    def queue(request, &block)
-      Acfs.queue request, &block
-    end
   end
 end

data/lib/acfs/service/middleware.rb

@@ -0,0 +1,51 @@
+module Acfs
+  class Service
+
+    # Module providing all function to register middlewares
+    # on services and process queued request through the
+    # middleware stack.
+    #
+    module Middleware
+      extend ActiveSupport::Concern
+
+      # Queue a new request. The request will travel through
+      # all registered middleware.
+      #
+      def queue(req)
+        super self.class.middleware.call req
+      end
+
+      module ClassMethods
+
+        # Register a new middleware to be used for this service.
+        #
+        # class MyService < Acfs::Service
+        #   self.base_url = 'http://my.srv'
+        #   use Acfs::Middleware::JsonDecoder
+        # end
+        #
+        def use(klass, options = {})
+          @middlewares ||= []
+
+          return false if @middlewares.include? klass
+
+          @middlewares << klass
+          @middleware = klass.new(middleware, options)
+        end
+
+        # Return top most middleware.
+        #
+        def middleware
+          @middleware ||= proc { |request| request}
+        end
+
+        # Clear all registered middlewares.
+        #
+        def clear
+          @middleware  = nil
+          @middlewares = nil
+        end
+      end
+    end
+  end
+end

data/lib/acfs/service/queue.rb

@@ -0,0 +1,16 @@
+module Acfs
+  class Service
+
+    # Allows to queue request on this service that will be
+    # delegated to global Acfs adapter queue.
+    #
+    module Queue
+
+      # Queue a new request on global adapter queue.
+      #
+      def queue(request)
+        Acfs.adapter.queue request
+      end
+    end
+  end
+end

data/lib/acfs/version.rb

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

data/spec/acfs_spec.rb

@@ -3,17 +3,25 @@ require 'spec_helper'
 describe "Acfs" do
 
   before do
-    Acfs.clear
-    Acfs.use Acfs::Middleware::JsonDecoder
-    Acfs.use Acfs::Middleware::MessagePackDecoder
-
-    headers = { 'Content-Type' => 'application/json' }
-    stub_request(:get, "http://users.example.org/users").to_return(:body => '[{"id":1,"name":"Anon","age":12},{"id":2,"name":"John","age":26}]', headers: headers)
-    stub_request(:get, "http://users.example.org/users/2").to_return(:body => '{"id":2,"name":"John","age":26}', headers: headers)
-    stub_request(:get, "http://users.example.org/users/3").to_return(:body => '{"id":2,"name":"Miraculix","age":122}', headers: headers)
-    stub_request(:get, "http://users.example.org/users/100").to_return(:body => '{"id":2,"name":"Jimmy","age":45}', headers: headers)
-    stub_request(:get, "http://users.example.org/users/2/friends").to_return(:body => '[{"id":1,"name":"Anon","age":12}]', headers: headers)
-    stub_request(:get, "http://comments.example.org/comments?user=2").to_return(:body => '[{"id":1,"text":"Comment #1"},{"id":2,"text":"Comment #2"}]', headers: headers)
+    headers         = {}
+    stub_request(:get, "http://users.example.org/users").to_return(
+        body: MessagePack.dump([{ id: 1, name: "Anon", age: 12 }, { id: 2, name: "John", age: 26 }]),
+        headers: headers.merge({'Content-Type' => 'application/x-msgpack'}))
+    stub_request(:get, "http://users.example.org/users/2").to_return(
+        body: MessagePack.dump({ id: 2, name: "John", age: 26 }),
+        headers: headers.merge({'Content-Type' => 'application/x-msgpack'}))
+    stub_request(:get, "http://users.example.org/users/3").to_return(
+        body: MessagePack.dump({ id: 2, name: "Miraculix", age: 122 }),
+        headers: headers.merge({'Content-Type' => 'application/x-msgpack'}))
+    stub_request(:get, "http://users.example.org/users/100").to_return(
+        body: '{"id":2,"name":"Jimmy","age":45}',
+        headers: headers.merge({'Content-Type' => 'application/json'}))
+    stub_request(:get, "http://users.example.org/users/2/friends").to_return(
+        body: '[{"id":1,"name":"Anon","age":12}]',
+        headers: headers.merge({'Content-Type' => 'application/json'}))
+    stub_request(:get, "http://comments.example.org/comments?user=2").to_return(
+        body: '[{"id":1,"text":"Comment #1"},{"id":2,"text":"Comment #2"}]',
+        headers: headers.merge({'Content-Type' => 'application/json'}))
   end
 
   it 'should load single resource' do

data/spec/spec_helper.rb

@@ -1,6 +1,8 @@
 require 'acfs'
 require 'coveralls'
-Coveralls.wear!
+Coveralls.wear! do
+  add_filter 'spec'
+end
 
 require 'webmock/rspec'
 

data/spec/support/service.rb

@@ -1,10 +1,13 @@
 
 class UserService < Acfs::Service
   self.base_url = 'http://users.example.org'
+  use Acfs::Middleware::MessagePackDecoder
+  use Acfs::Middleware::JsonDecoder
 end
 
 class CommentService < Acfs::Service
   self.base_url = 'http://comments.example.org'
+  use Acfs::Middleware::JsonDecoder
 end
 
 class MyUser

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acfs
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Jan Graichen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-19 00:00:00.000000000 Z
+date: 2013-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -220,17 +220,19 @@ files:
 - lib/acfs/response.rb
 - lib/acfs/response/formats.rb
 - lib/acfs/service.rb
+- lib/acfs/service/middleware.rb
+- lib/acfs/service/queue.rb
 - lib/acfs/version.rb
 - spec/acfs/middleware/json_decoder_spec.rb
 - spec/acfs/middleware/msgpack_decoder_spec.rb
 - spec/acfs/request/callbacks_spec.rb
 - spec/acfs/request_spec.rb
 - spec/acfs/response/formats_spec.rb
+- spec/acfs/service_spec.rb
 - spec/acfs_spec.rb
 - spec/model/attributes_spec.rb
 - spec/model/initialization_spec.rb
 - spec/model/locatable_spec.rb
-- spec/service_spec.rb
 - spec/spec_helper.rb
 - spec/support/service.rb
 homepage: ''
@@ -263,10 +265,10 @@ test_files:
 - spec/acfs/request/callbacks_spec.rb
 - spec/acfs/request_spec.rb
 - spec/acfs/response/formats_spec.rb
+- spec/acfs/service_spec.rb
 - spec/acfs_spec.rb
 - spec/model/attributes_spec.rb
 - spec/model/initialization_spec.rb
 - spec/model/locatable_spec.rb
-- spec/service_spec.rb
 - spec/spec_helper.rb
 - spec/support/service.rb