acfs 0.20.0 → 0.21.0.b185

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a4e5e93e4dee6f02a8b6a830f83a710bd98a7134
-  data.tar.gz: 9833f7ea561dfe761689915f61daf25a33e25ca1
+  metadata.gz: 24c2d64318701de68d4bebf2c0454ae17222f41e
+  data.tar.gz: 7b058dbf9ce187553aa1a41420b3792b96f4b8f3
 SHA512:
-  metadata.gz: 20fae6a5edfd9e81f9f893846951d907226f6c77866cb20938c926dbad8f3b21842c051314cfb91268cdee3e98875e836456436a024be9505148562deabe79c1
-  data.tar.gz: 7eb8bf6e3bd84961a550201d77f2f6e2fe85779108045a4fe991b4537d50cdabedf916e35361b80027022f2e43d141e8e116201ebd859d23b780fc004e48cc76
+  metadata.gz: d2b103a60ada7149b1f58c79ffaad1f2419116040742217933819840b940b7f17ffa7a03294835b87ad346a33509c996b33872efd845b59fece94ce72bf265e8
+  data.tar.gz: 425866d67a2dd571cfd1e5dcb9519616720bf7059ec58004dd4ab61f06f94cf508385448dd9f1674937701e95ffb40ec05f4763803eae403ae5170f1611c39d8

data/.travis.yml

@@ -1,15 +1,22 @@
 language: ruby
 bundler_args: --without development
 rvm:
-  - 2.0.0
-  - 1.9.3
-  - jruby
-  - rbx-19mode
-
+- 2.0.0
+- 1.9.3
+- jruby
+- rbx-19mode
 gemfile:
-  - gemfiles/Gemfile.rails-3-1
-  - gemfiles/Gemfile.rails-3-2
-  - gemfiles/Gemfile.rails-4-0
-
+- gemfiles/Gemfile.rails-4-0
+- gemfiles/Gemfile.rails-3-2
+- gemfiles/Gemfile.rails-3-1
 services:
-  - rabbitmq
+- rabbitmq
+deploy:
+  provider: rubygems
+  api_key:
+    secure: gNudZK0JaRRweudmkpdkJjUMydItTSW5cXjpYdYCfahqd/cD0xPjxotr2TCHrJibfVauoT/PytbQWcP3jnOYytp6oS0up5Y+uKpGmbqVYx/rZvShWALszcBs71lUh/IZpDXNHc+yo/01HCn10/uQUFRtrjWgMwHtHxXb09xE4wQ=
+  gem: acfs
+  on:
+    branch: master
+    repo: jgraichen/acfs
+    rvm: 2.0.0

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.21.0
+
+* Add update_attributes
+* Add validation check to `save` method
+* Inherit attributes to subclasses
+
 ## 0.20.0
 
 * Remove messaging

data/README.md

@@ -15,7 +15,7 @@ Acfs covers model and service abstraction, convenient query and filter methods,
 
 Add this line to your application's Gemfile:
 
-    gem 'acfs', '~> 0.16.0'
+    gem 'acfs', '~> 0.21.0'
 
 **Note:** Acfs is under development. I'll try to avoid changes to the public API but internal APIs may change quite often.
 
@@ -212,10 +212,6 @@ Removed in 0.20.0. See [jgraichen/msgr](https://github.com/jgraichen/msgr) for a
         * Rails responders providing REST operations with integrated ETag,
           Modified Headers, conflict detection, ...
     * Pagination? Filtering? (If service API provides such features.)
-    * Messaging Queue support for services and models
-        * Allow triggering messages on resource events (CRUD)
-        * Abstract messages into objects
-        * Middleware stack for messages?
 * Documentation
 
 ## Contributing

data/acfs.gemspec

@@ -26,4 +26,6 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'rack'
 
   spec.add_development_dependency 'bundler', '~> 1.3'
+
+  spec.version = "#{spec.version}.b#{ENV['TRAVIS_BUILD_NUMBER']}" if ENV['TRAVIS_BUILD_NUMBER']
 end

data/lib/acfs.rb

@@ -4,35 +4,30 @@ require 'active_support/core_ext/class'
 require 'active_support/core_ext/string'
 require 'active_support/core_ext/module'
 
-require 'acfs/version'
-require 'acfs/errors'
-require 'acfs/global'
-
 module Acfs
   extend ActiveSupport::Autoload
+  require 'acfs/version'
+  require 'acfs/errors'
+  require 'acfs/global'
+
+  require 'acfs/collection'
+  require 'acfs/configuration'
+  require 'acfs/model'
+  require 'acfs/operation'
+  require 'acfs/request'
+  require 'acfs/resource'
+  require 'acfs/response'
+  require 'acfs/runner'
+  require 'acfs/service'
+
   extend Global
 
-  autoload :Collection
-  autoload :Model
-  autoload :Request
-  autoload :Response
-  autoload :Service
   autoload :Stub
-  autoload :Operation
-  autoload :Runner
-  autoload :Configuration
-
-  module Messaging
-    extend ActiveSupport::Autoload
-
-    autoload :Client
-    autoload :Receiver
-  end
 
   module Middleware
     extend ActiveSupport::Autoload
+    require 'acfs/middleware/base'
 
-    autoload :Base
     autoload :Print
     autoload :Logger
     autoload :JsonDecoder
@@ -42,10 +37,8 @@ module Acfs
   end
 
   module Adapter
-    extend ActiveSupport::Autoload
-
-    autoload :Base
-    autoload :Typhoeus
+    require 'acfs/adapter/base'
+    require 'acfs/adapter/typhoeus'
   end
 end
 

data/lib/acfs/errors.rb

@@ -3,46 +3,52 @@ module Acfs
   # Acfs base error.
   #
   class Error < StandardError
+    def initialize(opts = {}, message = nil)
+      opts.merge! message: message if message
+      super opts[:message]
+    end
   end
 
   # Response error containing the responsible response object.
   #
   class ErroneousResponse < Error
-    attr_accessor :response
+    attr_reader :response
 
-    def initialize(data = {})
-      self.response = data[:response]
-      message = ''
-      message << "Received erroneous response: #{response.code}"
-      if response.data
-        message << "\n  with content:\n    "
-        message << response.data.map{|k,v| "#{k.inspect}: #{v.inspect}"}.join("\n    ")
-      end
-      if response.headers.any?
-        message << "\n  with headers:\n    "
-        message << response.headers.map{|k,v| "#{k}: #{v}"}.join("\n    ")
-      end
-      message << "\nbased on request: #{response.request.method.upcase} #{response.request.url} #{response.request.format}"
-      if response.request.data
-        message << "\n  with content:\n    "
-        message << response.request.data.map{|k,v| "#{k.inspect}: #{v.inspect}"}.join("\n    ")
+    def initialize(opts = {})
+      @response = opts[:response]
+      message = 'Received erroneous response'
+      if response
+        message << ": #{response.code}"
+        if response.data
+          message << "\n  with content:\n    "
+          message << response.data.map{|k,v| "#{k.inspect}: #{v.inspect}"}.join("\n    ")
+        end
+        if response.headers.any?
+          message << "\n  with headers:\n    "
+          message << response.headers.map{|k,v| "#{k}: #{v}"}.join("\n    ")
+        end
+        message << "\nbased on request: #{response.request.method.upcase} #{response.request.url} #{response.request.format}"
+        if response.request.data
+          message << "\n  with content:\n    "
+          message << response.request.data.map{|k,v| "#{k.inspect}: #{v.inspect}"}.join("\n    ")
+        end
+        if response.request.headers.any?
+          message << "\n  with headers:\n    "
+          message << response.request.headers.map{|k,v| "#{k}: #{v}"}.join("\n    ")
+        end
       end
-      if response.request.headers.any?
-        message << "\n  with headers:\n    "
-        message << response.request.headers.map{|k,v| "#{k}: #{v}"}.join("\n    ")
-      end
-      super message
+      super opts, message
     end
   end
 
   class AmbiguousStubError < Error
     attr_reader :stubs, :operation
 
-    def initialize(stubs, operation)
-      @stubs     = stubs
-      @operation = operation
+    def initialize(opts = {})
+      @stubs     = opts.delete :stubs
+      @operation = opts.delete :operation
 
-      super 'Ambiguous stubs.'
+      super opts, 'Ambiguous stubs.'
     end
 
   end
@@ -53,10 +59,27 @@ module Acfs
   end
 
   class InvalidResource < ErroneousResponse
-    attr_accessor :errors
+    attr_reader :errors, :resource
+
+    def initialize(opts = {})
+      @errors   = opts.delete :errors
+      @resource = opts.delete :resource
+      super
+    end
+  end
+
+  # A ResourceNotLoaded error will be thrown when calling some
+  # modifing methods on not loaded resources as it is usally
+  # unwanted to call e.g. `update_attributes` on a not loaded
+  # resource.
+  # Correct solution is to first run `Acfs.run` to fetch the
+  # resource and then update the resource.
+  #
+  class ResourceNotLoaded < Error
+    attr_reader :resource
 
-    def initialize(data)
-      self.errors = data[:errors]
+    def initialize(opts = {})
+      @resource = opts.delete :resource
       super
     end
   end

data/lib/acfs/model.rb

@@ -1,44 +1,43 @@
 require 'active_model'
 
-require 'acfs/model/attributes'
-require 'acfs/model/dirty'
-require 'acfs/model/loadable'
-require 'acfs/model/locatable'
-require 'acfs/model/persistence'
-require 'acfs/model/operational'
-require 'acfs/model/query_methods'
-require 'acfs/model/relations'
-require 'acfs/model/service'
+# @api public
+#
+module Acfs::Model
+  require 'acfs/model/attributes'
+  require 'acfs/model/dirty'
+  require 'acfs/model/loadable'
+  require 'acfs/model/locatable'
+  require 'acfs/model/operational'
+  require 'acfs/model/persistence'
+  require 'acfs/model/query_methods'
+  require 'acfs/model/relations'
+  require 'acfs/model/service'
+  require 'acfs/model/validation'
 
-module Acfs
+  extend ActiveSupport::Concern
 
-  # @api public
-  #
-  module Model
-    extend ActiveSupport::Concern
+  included do
+    if ActiveModel::VERSION::MAJOR >= 4
+      include ActiveModel::Model
+    else
+      extend  ActiveModel::Naming
+      extend  ActiveModel::Translation
+      include ActiveModel::Conversion
+      include ActiveModel::Validations
 
-    included do
-      if ActiveModel::VERSION::MAJOR >= 4
-        include ActiveModel::Model
-      else
-        extend  ActiveModel::Naming
-        extend  ActiveModel::Translation
-        include ActiveModel::Conversion
-        include ActiveModel::Validations
-
-        require 'acfs/model/initialization'
-        include Model::Initialization
-      end
-
-      include Model::Attributes
-      include Model::Loadable
-      include Model::Persistence
-      include Model::Locatable
-      include Model::Operational
-      include Model::QueryMethods
-      include Model::Relations
-      include Model::Service
-      include Model::Dirty
+      require 'acfs/model/initialization'
+      include Initialization
     end
+
+    include Attributes
+    include Loadable
+    include Persistence
+    include Locatable
+    include Operational
+    include QueryMethods
+    include Relations
+    include Service
+    include Dirty
+    include Validation
   end
 end

data/lib/acfs/model/attributes.rb

@@ -187,7 +187,7 @@ module Acfs::Model
       # @return [ Hash{ String => Object, Proc } ] Attributes with default values.
       #
       def attributes
-        @attributes ||= {}
+        @attributes ||= {}.merge superclass.respond_to?(:attributes) ? superclass.attributes : {}
       end
 
       # @api public
@@ -205,7 +205,7 @@ module Acfs::Model
       # @return [ Hash{ Symbol => Class } ] Attributes and their types.
       #
       def attribute_types
-        @attribute_types ||= {}
+        @attribute_types ||= {}.merge superclass.respond_to?(:attribute_types) ? superclass.attribute_types : {}
       end
 
       private

data/lib/acfs/model/persistence.rb

@@ -26,7 +26,7 @@ module Acfs
       #   user2.save
       #   user2.persisted? # => true
       #
-      # @return [TrueClass, FalseClass] True if resource has no changes and is not newly created, false otherwise.
+      # @return [Boolean] True if resource has no changes and is not newly created, false otherwise.
       #
       def persisted?
         !new? && !changed?
@@ -36,7 +36,7 @@ module Acfs
       #
       # Return true if model is a new record and was not saved yet.
       #
-      # @return [TrueClass, FalseClass] True if resource is newly created, false otherwise.
+      # @return [Boolean] True if resource is newly created, false otherwise.
       #
       def new?
         read_attribute(:id).nil?
@@ -52,7 +52,7 @@ module Acfs
       #
       # Saving a resource is a synchronous operation.
       #
-      # @return [TrueClass, FalseClass] True if save operation was successful, false otherwise.
+      # @return [Boolean] True if save operation was successful, false otherwise.
       # @see #save! See #save! for available options.
       #
       def save(*args)
@@ -79,8 +79,6 @@ module Acfs
       # @see #save
       #
       def save!(opts = {})
-        #raise ::Acfs::InvalidResource errors: errors.to_a unless valid?
-
         opts[:data] = attributes unless opts[:data]
 
         operation (new? ? :create : :update), opts do |data|
@@ -88,13 +86,60 @@ module Acfs
         end
       end
 
+      # @api public
+      #
+      # Update attributes with given data and save resource.
+      #
+      # Saving a resource is a synchronous operation.
+      #
+      # @param [Hash] attrs Hash with attributes to write.
+      # @param [Hash] opts Options passed to `save`.
+      #
+      # @return [Boolean] True if save operation was successful, false otherwise.
+      #
+      # @see #save
+      # @see #attributes=
+      # @see #update_attributes!
+      #
+      def update_attributes(attrs, opts = {})
+        check_loaded! opts
+
+        self.attributes = attrs
+        save opts
+      end
+
+      # @api public
+      #
+      # Update attributes with given data and save resource.
+      #
+      # Saving a resource is a synchronous operation.
+      #
+      # @param [Hash] attrs Hash with attributes to write.
+      # @param [Hash] opts Options passed to `save!`.
+      #
+      # @raise [Acfs::InvalidResource]
+      #   If remote services respond with 422 response. Will fill errors with data from response
+      # @raise [Acfs::ErroneousResponse]
+      #   If remote service respond with not successful response.
+      #
+      # @see #save!
+      # @see #attributes=
+      # @see #update_attributes
+      #
+      def update_attributes!(attrs, opts = {})
+        check_loaded! opts
+
+        self.attributes = attrs
+        save! opts
+      end
+
       # @api public
       #
       # Destroy resource by sending a DELETE request.
       #
       # Deleting a resource is a synchronous operation.
       #
-      # @return [TrueClass, FalseClass]
+      # @return [Boolean]
       # @see #delete!
       #
       def delete(opts = {})
@@ -186,6 +231,10 @@ module Acfs
         self.attributes = data
         loaded!
       end
+
+      def check_loaded!(opts = {})
+        raise ResourceNotLoaded, resource: self unless loaded? or opts[:force]
+      end
     end
   end
 end

data/lib/acfs/model/validation.rb

@@ -0,0 +1,13 @@
+module Acfs::Model
+
+  #
+  #
+  module Validation
+
+    def save!(*_)
+      raise ::Acfs::InvalidResource.new resource: self, errors: errors.to_a unless valid? :save
+
+      super
+    end
+  end
+end

data/lib/acfs/stub.rb

@@ -98,7 +98,7 @@ module Acfs
 
         accepted_stubs = stubs.select { |stub| stub.accept? op }
 
-        raise AmbiguousStubError.new accepted_stubs, op if accepted_stubs.size > 1
+        raise AmbiguousStubError.new stubs: accepted_stubs, operation: op if accepted_stubs.size > 1
 
         accepted_stubs.first
       end

data/lib/acfs/version.rb

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

data/spec/acfs/model/attributes_spec.rb

@@ -109,7 +109,7 @@ describe Acfs::Model::Attributes do
 
     it 'should cast values' do
       o = model.new
-      o.age = "28"
+      o.age = '28'
 
       expect(o.age).to be == 28
     end

data/spec/acfs/model/persistance_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe Acfs::Model::Persistence do
   let(:model_class) { MyUser }
   before do
-    @get_stub = stub_request(:get, 'http://users.example.org/users/1').to_return response({ id: 1, name: "Anon", age: 12 })
+    @get_stub = stub_request(:get, 'http://users.example.org/users/1').to_return response({ id: 1, name: 'Anon', age: 12 })
 
     @patch_stub = stub_request(:put, 'http://users.example.org/users/1')
       .with(body: '{"id":1,"name":"Idefix","age":12}')
@@ -71,6 +71,20 @@ describe Acfs::Model::Persistence do
     end
   end
 
+  context 'unloaded model' do
+    let!(:model) { model_class.find 1 }
+
+    describe '#update_attributes' do
+      subject { -> { model.update_attributes name: 'John' } }
+      it { expect{ subject.call }.to raise_error Acfs::ResourceNotLoaded }
+    end
+
+    describe '#update_attributes!' do
+      subject { -> { model.update_attributes! name: 'John' } }
+      it { expect{ subject.call }.to raise_error Acfs::ResourceNotLoaded }
+    end
+  end
+
   context 'loaded model' do
     context 'without changes' do
       let(:model) { model_class.find 1 }
@@ -102,6 +116,46 @@ describe Acfs::Model::Persistence do
         expect(model).to be_frozen
       end
     end
+
+    describe '#update_atributes!' do
+      let(:model) { model_class.find 1 }
+      before { model; Acfs.run }
+
+      it 'should set attributes' do
+        model.update_attributes name: 'Idefix'
+        expect(model.attributes.symbolize_keys).to eq id: 1, name: 'Idefix', age: 12
+      end
+
+      it 'should save resource' do
+        expect(model).to receive(:save).with({})
+        model.update_attributes name: 'Idefix'
+      end
+
+      it 'should pass second hash to save' do
+        expect(model).to receive(:save).with({ bla: 'blub' })
+        model.update_attributes({ name: 'Idefix' }, { bla: 'blub' })
+      end
+    end
+
+    describe '#update_atributes' do
+      let(:model) { model_class.find 1 }
+      before { model; Acfs.run }
+
+      it 'should set attributes' do
+        model.update_attributes! name: 'Idefix'
+        expect(model.attributes.symbolize_keys).to eq id: 1, name: 'Idefix', age: 12
+      end
+
+      it 'should save resource' do
+        expect(model).to receive(:save!).with({})
+        model.update_attributes! name: 'Idefix'
+      end
+
+      it 'should pass second hash to save' do
+        expect(model).to receive(:save!).with({ bla: 'blub' })
+        model.update_attributes!({ name: 'Idefix' }, { bla: 'blub' })
+      end
+    end
   end
 
   describe '.create!' do
@@ -125,7 +179,7 @@ describe Acfs::Model::Persistence do
 
       it 'should raise an error' do
         expect { model_class.create! data }.to raise_error ::Acfs::InvalidResource do |error|
-          expect(error.errors).to be == { name: ['required'] }.stringify_keys
+          expect(error.errors).to be == { name: %w(required) }.stringify_keys
         end
       end
     end
@@ -157,7 +211,7 @@ describe Acfs::Model::Persistence do
 
       it 'should contain error hash' do
         model = model_class.create data
-        expect(model.errors.to_hash).to be == { name: [ "required" ]}.stringify_keys
+        expect(model.errors.to_hash).to be == { name: %w(required) }.stringify_keys
       end
     end
   end

data/spec/acfs/model/validation_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe Acfs::Model::Validation do
+  let(:params) { {} }
+  let(:model) { MyUserWithValidations.new params }
+
+  describe '#valid?' do
+    context 'with valid attributes' do
+      let(:params) { {name: 'john smith', age: 24} }
+      subject { model }
+
+      it { should be_valid }
+    end
+
+    context 'with invalid attributes' do
+      let(:params) { {name: 'invname'} }
+      subject { model }
+
+      it { should_not be_valid }
+    end
+  end
+
+  describe '#errors' do
+    context 'with valid attributes' do
+      let(:params) { {name: 'john smith', age: 24} }
+      before { model.valid? }
+      subject { model.errors }
+
+      it { should be_empty }
+    end
+
+    context 'with invalid attributes' do
+      let(:params) { {name: 'john'} }
+      before { model.valid? }
+      subject { model.errors }
+
+      it { should_not be_empty }
+      it { should have(2).items }
+
+      it 'should contain a list of error messages' do
+        expect(subject.to_hash).to eq age: ["can't be blank"], name: ['is invalid']
+      end
+    end
+  end
+
+  describe '#save!' do
+    context 'with invalid attributes' do
+      let(:params) { {name: 'john'} }
+      subject { -> { model.save! } }
+
+      it { expect { subject.call }.to raise_error Acfs::InvalidResource }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -21,7 +21,7 @@ RSpec.configure do |config|
   # order dependency and want to debug it, you can fix the order by providing
   # the seed, which is printed after each run.
   #     --seed 1234
-  config.order = "random"
+  config.order = 'random'
 
   config.expect_with :rspec do |c|
     # Only allow expect syntax

data/spec/support/service.rb

@@ -16,8 +16,7 @@ class CommentService < Acfs::Service
   use Acfs::Middleware::JsonDecoder
 end
 
-class MyUser
-  include Acfs::Model
+class MyUser < Acfs::Resource
   service UserService, path: 'users'
 
   attribute :id, :integer
@@ -25,16 +24,23 @@ class MyUser
   attribute :age, :integer
 end
 
-class Session
-  include Acfs::Model
+class MyUserInherited < MyUser
+
+end
+
+class MyUserWithValidations < MyUser
+  validates_presence_of :name, :age
+  validates_format_of :name, with: /\A\w+\s+\w+.?\z/
+end
+
+class Session < Acfs::Resource
   service UserService
 
   attribute :id, :string
   attribute :user, :integer
 end
 
-class Comment
-  include Acfs::Model
+class Comment < Acfs::Resource
   service CommentService
 
   attribute :id, :integer

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acfs
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 0.21.0.b185
 platform: ruby
 authors:
 - Jan Graichen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-23 00:00:00.000000000 Z
+date: 2013-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -160,6 +160,7 @@ files:
 - lib/acfs/model/query_methods.rb
 - lib/acfs/model/relations.rb
 - lib/acfs/model/service.rb
+- lib/acfs/model/validation.rb
 - lib/acfs/operation.rb
 - lib/acfs/request.rb
 - lib/acfs/request/callbacks.rb
@@ -187,6 +188,7 @@ files:
 - spec/acfs/model/locatable_spec.rb
 - spec/acfs/model/persistance_spec.rb
 - spec/acfs/model/query_methods_spec.rb
+- spec/acfs/model/validation_spec.rb
 - spec/acfs/request/callbacks_spec.rb
 - spec/acfs/request_spec.rb
 - spec/acfs/response/formats_spec.rb
@@ -214,9 +216,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.0.3
@@ -237,6 +239,7 @@ test_files:
 - spec/acfs/model/locatable_spec.rb
 - spec/acfs/model/persistance_spec.rb
 - spec/acfs/model/query_methods_spec.rb
+- spec/acfs/model/validation_spec.rb
 - spec/acfs/request/callbacks_spec.rb
 - spec/acfs/request_spec.rb
 - spec/acfs/response/formats_spec.rb
@@ -249,4 +252,3 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/response.rb
 - spec/support/service.rb
-has_rdoc: