acfs 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f5bd82876ac05bd67b6a8d95a8d9e0779eb7d1c1
-  data.tar.gz: 5234ed3bfb459596c3cc0533bec51a67013f0b69
+  metadata.gz: 0f5f03951ec6374b76946211e390bfc2c0ff6f1f
+  data.tar.gz: af8cf339ce2bc9e4a5542a55bb1b8d1e8b63793b
 SHA512:
-  metadata.gz: e10f336df5c116c5155ab4c51dbbe8a746ce3235b87180c69a5a1651ed285c75abeccd219b95fc0dda1a5e65bd9ccd3bfa74a42f672ae9de60d8ec1f9f99f14a
-  data.tar.gz: 8631fdb5b179084f4f54ca953aa750f6b70242c5ebcd6aa6c52f97836663dd88e3d98c6dc30239c9144a63718913d3bac4041530a3aaccebedf8567f4404ef4e
+  metadata.gz: 66728dbe0550a7d8585d1d47b615c60534417d176125ddca78b572e11e13f6611b4ec16877db10096c4752f9d24f1323ea01da8bfc5f0b97fd9bcd83e530a85f
+  data.tar.gz: 55f211e28b344c2c5245161d76c12826cd6c89d36132a7838fdfa1402ac5e1dde1618851e3a1e9d6c1c40b5b17ff6bbdef5c6101b464d1cd7196a46d66418a3c

data/.travis.yml

@@ -3,6 +3,7 @@ rvm:
   - 2.0.0
   - 1.9.3
   - jruby
+  - rbx-19mode
 
 gemfile:
   - gemfiles/Gemfile.rails-3-2

data/CHANGELOG.md

@@ -0,0 +1,78 @@
+# Changelog
+
+## 0.16.0
+
+* Add YAML configuration
+* Add external configuration for services
+* Add Rubinius support
+
+## 0.15.0
+
+* Add stubbing capabilities for resources
+
+## 0.14.0 & 0.13.0
+
+* Fix response attributes
+
+## 0.12.0
+
+* Add JRuby support
+* Improve handling of error respones (422)
+
+## 0.11.0
+
+* Add Logger Middleware
+* Add handling of error responses
+
+## 0.10.0
+
+* Return hash with indifferent access for resource attributes
+
+## 0.9.0
+
+* Add create operation
+
+## 0.8.0
+
+* Add save operation (PUT and POST)
+* Add JSON and MessagePack encoder middlewares for encoding request data
+* ActiveModel::Dirty
+* Add persistant state methods
+
+## 0.7.0
+
+* Per-service middleware stack
+
+## 0.6.0
+
+* Add support for multiple ids for .find
+* Add MessagePack support
+
+## 0.5.1
+
+* Fix mime type parsing for mime types with aditional parameters (ActionPack < 4.0)
+
+## 0.5.0
+
+* Add mime type support for respones
+
+## 0.4.0
+
+* Improve JSON response detection
+* Add bool attribute type
+
+## 0.3.0
+
+* Add tracking for loading state (if resource is loaded or queued)
+* Add JSON middleware to decode respones
+* Add middleware support
+* Add method to fetch single resources or list of resources
+* Use typhoeus as http library for parallel request processing
+
+## 0.2.0
+
+* Allow to define resources and attributes
+
+## 0.1.0
+
+* Project start

data/README.md

@@ -10,7 +10,7 @@ Acfs covers model and service abstraction, convenient query and filter methods,
 
 Add this line to your application's Gemfile:
 
-    gem 'acfs', '~> 0.14.0'
+    gem 'acfs', '~> 0.16.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

@@ -1,6 +1,7 @@
 require 'active_support'
-require 'active_support/core_ext/class'
 require 'active_support/core_ext/hash'
+require 'active_support/core_ext/class'
+require 'active_support/core_ext/string'
 require 'active_support/core_ext/module'
 
 require 'acfs/version'
@@ -19,6 +20,7 @@ module Acfs
   autoload :Stub
   autoload :Operation
   autoload :Runner
+  autoload :Configuration
 
   module Middleware
     extend ActiveSupport::Autoload

data/lib/acfs/configuration.rb

@@ -0,0 +1,63 @@
+require 'uri'
+require 'yaml'
+
+module Acfs
+
+  #
+  #
+  class Configuration
+    attr_reader :locations
+
+    def initialize
+      @locations = {}
+    end
+
+    def configure(&block)
+      if block.arity > 0
+        block.call self
+      else
+        instance_eval &block
+      end
+    end
+
+    def locate(service, uri = nil)
+      service = service.to_s.underscore.to_sym
+      if uri.nil?
+        locations[service]
+      else
+        locations[service] = URI.parse uri
+      end
+    end
+
+    def load(filename)
+      config = YAML::load File.read filename
+      env    = ENV['RACK_ENV'] || ENV['RAILS_ENV'] || 'development'
+
+      config = config[env] if config.has_key? env
+      config.each do |key, value|
+        case key
+          when 'services' then load_services value
+        end
+      end
+    end
+
+    def load_services(services)
+      services.each do |service, data|
+        if (val = data).is_a?(String) || (val = data['locate'])
+          locate service.to_sym, val
+        end
+      end
+    end
+
+    class << self
+
+      def current
+        @configuration ||= new
+      end
+
+      def set(configuration)
+        @configuration = configuration if configuration.is_a? Configuration
+      end
+    end
+  end
+end

data/lib/acfs/errors.rb

@@ -29,5 +29,5 @@ module Acfs
     end
   end
 
-  class RealRequestNotAllowedError < StandardError; end
+  class RealRequestsNotAllowedError < StandardError; end
 end

data/lib/acfs/global.rb

@@ -13,5 +13,9 @@ module Acfs
     def run
       runner.start
     end
+
+    def configure(&block)
+      Configuration.current.configure &block
+    end
   end
 end

data/lib/acfs/service.rb

@@ -6,7 +6,6 @@ module Acfs
   #
   class Service
     attr_accessor :options
-    class_attribute :base_url
 
     include Service::Middleware
 
@@ -26,5 +25,21 @@ module Acfs
       url += "/#{options[:suffix].to_s}" if options[:suffix]
       url
     end
+
+    class << self
+
+      def identity(identity = nil)
+        @identity = identity.to_s.to_sym unless identity.nil?
+        @identity ||= name.to_sym
+      end
+
+      def base_url
+        unless (base = Acfs::Configuration.current.locate identity)
+          raise ArgumentError, "#{identity} not configured. Add `locate '#{identity.to_s.underscore}', 'http://service.url/'` to your configuration."
+        end
+
+        base.to_s
+      end
+    end
   end
 end

data/lib/acfs/stub.rb

@@ -60,7 +60,7 @@ module Acfs
         stub = stub_for op
         unless stub
           return false if allow_requests?
-          raise RealRequestNotAllowedError, "No stub found for `#{op.resource.name}` with params `#{op.params}`"
+          raise RealRequestsNotAllowedError, "No stub found for `#{op.resource.name}` with params `#{op.params}`"
         end
 
         if (data = stub[:return])

data/lib/acfs/version.rb

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

data/spec/acfs/configuration_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe Acfs::Configuration do
+
+  let(:cfg) { Acfs::Configuration.new }
+  before { @configuration = Acfs::Configuration.current.dup }
+  after { Acfs::Configuration.set @configuration }
+
+  describe 'Acfs.configure' do
+
+    it 'should invoke configure on current configuration' do
+      Acfs::Configuration.current.should_receive(:configure).once.and_call_original
+
+      Acfs.configure do |c|
+        expect(c).to be_a Acfs::Configuration
+      end
+    end
+  end
+
+  describe '.load' do
+    it 'should be able to load YAML' do
+      cfg.configure do
+        load 'spec/fixtures/config.yml'
+      end
+
+      expect(cfg.locate(UserService).to_s).to be == 'http://localhost:3001/'
+      expect(cfg.locate(CommentService).to_s).to be == 'http://localhost:3002/'
+    end
+
+    context 'with RACK_ENV' do
+      before { @env = ENV['RACK_ENV']; ENV['RACK_ENV'] = 'production' }
+      after  { ENV['RACK_ENV'] = @env }
+
+      it 'should load ENV block' do
+        cfg.configure do
+          load 'spec/fixtures/config.yml'
+        end
+
+        expect(cfg.locate(UserService).to_s).to be == 'http://user.example.org/'
+        expect(cfg.locate(CommentService).to_s).to be == 'http://comment.example.org/'
+      end
+    end
+  end
+end

data/spec/acfs/service_spec.rb

@@ -1,14 +1,18 @@
 require 'spec_helper'
 
 describe Acfs::Service do
-  let(:srv_class) { Class.new(Acfs::Service) }
+  let(:srv_class) { Class.new(Acfs::Service) { identity :test } }
   let(:options) { {} }
   let(:service) { srv_class.new options }
 
+  before do
+    Acfs::Configuration.current.locate :test, ''
+  end
+
   describe '#initialize' do
     let(:options) { { path: 'abc', key: 'value' } }
 
-    it "should set options" do
+    it 'should set options' do
       expect(service.options).to eq(options)
     end
   end
@@ -28,8 +32,12 @@ describe Acfs::Service do
   end
 
   describe '.base_url' do
-    it "should have a static base_url configuration option" do
-      srv_class.base_url = 'http://abc.de/api/v1'
+
+    before do
+      Acfs::Configuration.current.locate :test, 'http://abc.de/api/v1'
+    end
+
+    it 'should return configured URI for service' do
 
       expect(srv_class.base_url).to eq('http://abc.de/api/v1')
     end

data/spec/acfs/stub_spec.rb

@@ -89,7 +89,7 @@ describe Acfs::Stub do
 
       it 'should allow real requests' do
         @user = MyUser.find 2
-        expect { Acfs.run }.to raise_error(Acfs::RealRequestNotAllowedError)
+        expect { Acfs.run }.to raise_error(Acfs::RealRequestsNotAllowedError)
       end
     end
   end

data/spec/fixtures/config.yml

@@ -0,0 +1,14 @@
+development: &dev
+  services:
+    user_service: http://localhost:3001/
+    comment_service:
+      locate: http://localhost:3002/
+
+production:
+  services:
+    user_service:
+      locate: http://user.example.org/
+    comment_service: http://comment.example.org/
+
+test:
+  <<: *dev

data/spec/support/service.rb

@@ -1,13 +1,16 @@
 
+Acfs.configure do
+  locate :user_service, 'http://users.example.org'
+  locate :comment_service, 'http://comments.example.org'
+end
+
 class UserService < Acfs::Service
-  self.base_url = 'http://users.example.org'
   use Acfs::Middleware::MessagePackDecoder
   use Acfs::Middleware::JsonDecoder
   use Acfs::Middleware::JsonEncoder
 end
 
 class CommentService < Acfs::Service
-  self.base_url = 'http://comments.example.org'
   use Acfs::Middleware::JsonDecoder
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acfs
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Jan Graichen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-09 00:00:00.000000000 Z
+date: 2013-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -118,6 +118,7 @@ files:
 - .gitignore
 - .rspec
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - Guardfile
 - LICENSE
@@ -130,6 +131,7 @@ files:
 - lib/acfs/adapter/base.rb
 - lib/acfs/adapter/typhoeus.rb
 - lib/acfs/collection.rb
+- lib/acfs/configuration.rb
 - lib/acfs/errors.rb
 - lib/acfs/global.rb
 - lib/acfs/middleware/base.rb
@@ -164,6 +166,7 @@ files:
 - lib/acfs/service/middleware.rb
 - lib/acfs/stub.rb
 - lib/acfs/version.rb
+- spec/acfs/configuration_spec.rb
 - spec/acfs/middleware/json_decoder_spec.rb
 - spec/acfs/middleware/msgpack_decoder_spec.rb
 - spec/acfs/model/attributes_spec.rb
@@ -181,6 +184,7 @@ files:
 - spec/acfs/service_spec.rb
 - spec/acfs/stub_spec.rb
 - spec/acfs_spec.rb
+- spec/fixtures/config.yml
 - spec/spec_helper.rb
 - spec/support/response.rb
 - spec/support/service.rb
@@ -209,6 +213,7 @@ signing_key:
 specification_version: 4
 summary: An abstract API base client for service oriented application.
 test_files:
+- spec/acfs/configuration_spec.rb
 - spec/acfs/middleware/json_decoder_spec.rb
 - spec/acfs/middleware/msgpack_decoder_spec.rb
 - spec/acfs/model/attributes_spec.rb
@@ -226,6 +231,7 @@ test_files:
 - spec/acfs/service_spec.rb
 - spec/acfs/stub_spec.rb
 - spec/acfs_spec.rb
+- spec/fixtures/config.yml
 - spec/spec_helper.rb
 - spec/support/response.rb
 - spec/support/service.rb