acfs 0.42.0 → 0.43.0

data/lib/acfs/{model → resource}/service.rb

@@ -1,36 +1,37 @@
-module Acfs::Model
-
+class Acfs::Resource
   # Included by Acfs::Model. Allows to configure the service
   # a resource belongs to.
   #
   module Service
     extend ActiveSupport::Concern
 
+    #
     module ClassMethods
-
       # @api public
       #
       # @overload service()
       #   Return service instance.
       #
-      #   @return [ Service ] Service class instance.
+      #   @return [Service] Service class instance.
       #
       # @overload service(klass, options = {})
-      #   Link to service this model belongs to. Connection settings like base URL
-      #   are fetched from service. Return assigned service if no arguments are given.
+      #   Link to service this model belongs to. Connection
+      #   settings like base URL are fetched from service.
+      #   Return assigned service if no arguments are given.
       #
       #   @example
       #     class AccountService < Acfs::Client
       #       self.base_url = 'http://acc.serv.org'
       #     end
       #
-      #     class MyUser
+      #     class MyUser < Acfs::Resource
       #       service AccountService
       #     end
       #     MyUser.find 5 # Will fetch `http://acc.serv.org/users/5`
       #
-      #   @param [ Class ] klass Service class derived from {Acfs::Service}.
-      #   @param [ Object ] options Option delegated to service class initializer.
+      #   @param klass [Class] Service class derived from {Acfs::Service}.
+      #   @param options [Object] Option delegated to
+      #     service class initializer.
       #
       def service(klass = nil, options = {})
         return (@service = klass.new options) if klass

data/lib/acfs/resource/validation.rb

@@ -0,0 +1,28 @@
+class Acfs::Resource
+  #
+  module Validation
+    def valid?(*args)
+      super
+      remote_errors.each {|f, e| errors.add f, e }
+      errors.empty?
+    end
+
+    def remote_errors
+      @remote_errors ||= ActiveModel::Errors.new self
+    end
+
+    def remote_errors=(errors)
+      (errors || []).each do |field, errs|
+        self.errors.set field.to_sym, errs
+        remote_errors.set field.to_sym, errs
+      end
+    end
+
+    def save!(*_)
+      unless valid?(new? ? :create : :save)
+        raise ::Acfs::InvalidResource.new resource: self, errors: errors.to_a
+      end
+      super
+    end
+  end
+end

data/lib/acfs/response.rb

@@ -3,7 +3,6 @@ require 'acfs/response/status'
 require 'active_support/core_ext/module/delegation'
 
 module Acfs
-
   # This represents a response. In addition to an standard HTTP
   # it has a field `data` for storing the encoded body.
   #
@@ -14,7 +13,7 @@ module Acfs
     include Response::Formats
     include Response::Status
 
-    #delegate :status, :status_message, :success?, :modified?, :timed_out?,
+    # delegate :status, :status_message, :success?, :modified?, :timed_out?,
     #         :response_body, :response_headers, :response_code, :headers,
     #         to: :response
 

data/lib/acfs/response/formats.rb

@@ -2,10 +2,8 @@ require 'action_dispatch'
 
 module Acfs
   class Response
-
     # Quick accessors for format handling.
     module Formats
-
       def content_type
         @content_type ||= read_content_type
       end
@@ -15,6 +13,7 @@ module Acfs
       end
 
       private
+
       def read_content_type
         return 'text/plain' unless headers && headers['Content-Type']
 

data/lib/acfs/response/status.rb

@@ -1,19 +1,17 @@
 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
+        # return response.response_code unless response.nil?
+        # 0
       end
-      alias :code :status_code
+      alias_method :code, :status_code
 
       # Return true if response was successful indicated by
       # response status code.

data/lib/acfs/runner.rb

@@ -1,7 +1,6 @@
 require 'acfs/service/middleware'
 
 module Acfs
-
   # @api private
   #
   class Runner
@@ -25,7 +24,7 @@ module Acfs
     #
     def run(op)
       ::ActiveSupport::Notifications.instrument 'acfs.runner.sync_run', operation: op do
-        op_request(op) { |req| adapter.run req }
+        op_request(op) {|req| adapter.run req }
       end
     end
 
@@ -40,7 +39,7 @@ module Acfs
     def enqueue(op)
       ::ActiveSupport::Notifications.instrument 'acfs.runner.enqueue', operation: op do
         if running?
-          op_request(op) { |req| adapter.queue req }
+          op_request(op) {|req| adapter.queue req }
         else
           queue << op
         end
@@ -82,12 +81,12 @@ module Acfs
 
     def enqueue_operations
       while (op = queue.shift)
-        op_request(op) { |req| adapter.queue req }
+        op_request(op) {|req| adapter.queue req }
       end
     end
 
     def op_request(op)
-      return if Acfs::Stub.enabled? and Acfs::Stub.stubbed(op)
+      return if Acfs::Stub.enabled? && Acfs::Stub.stubbed(op)
       req = op.service.prepare op.request
       return unless req.is_a? Acfs::Request
       req = prepare req

data/lib/acfs/service.rb

@@ -1,7 +1,6 @@
 require 'acfs/service/middleware'
 
 module Acfs
-
   # User {Acfs::Service} to define your services. That includes
   # an identity used to identify the service in configuration files
   # and middlewares the service uses.
@@ -35,14 +34,14 @@ module Acfs
     # @return [Location]
     #
     def location(resource_class, opts = {})
-      opts.reverse_merge! self.options
+      opts.reverse_merge! options
 
       action = opts[:action] || :list
 
-      path = if Hash === opts[:path] && opts[:path].has_key?(action)
+      path = if opts[:path].is_a?(Hash) && opts[:path].key?(action)
                opts[:path].fetch(action)
              else
-               path = if Hash === opts[:path]
+               path = if opts[:path].is_a?(Hash)
                         opts[:path][:all].to_s
                       else
                         opts[:path].to_s
@@ -59,7 +58,6 @@ module Acfs
     end
 
     class << self
-
       # @api public
       #
       # @overload identity()
@@ -83,7 +81,7 @@ module Acfs
       #
       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."
+          raise ArgumentError.new "#{identity} not configured. Add `locate '#{identity.to_s.underscore}', 'http://service.url/'` to your configuration."
         end
 
         base.to_s

data/lib/acfs/service/middleware.rb

@@ -1,6 +1,5 @@
 module Acfs
   class Service
-
     # Module providing all function to register middlewares
     # on services and process queued request through the
     # middleware stack.
@@ -16,7 +15,6 @@ module Acfs
       end
 
       module ClassMethods
-
         # @api public
         #
         # Register a new middleware to be used for this service.
@@ -47,7 +45,7 @@ module Acfs
         # @return [#call]
         #
         def middleware
-          @middleware ||= proc { |request| request}
+          @middleware ||= proc {|request| request }
         end
 
         # @api public

data/lib/acfs/singleton_resource.rb

@@ -1,33 +1,18 @@
 module Acfs
-
   # Acfs SingletonResources
   #
   # Usage explanation:
   #   Single.find      => sends GET    request to http://service:port/single
-  #   my_single.save   => sends POST   request to http://service:port/single if my_single is a new object
-  #                    or sends PUT    request to http://service:port/single if my_single has been requested before
+  #   my_single.save   => sends POST   request to http://service:port/single
+  #                                    if my_single is a new object
+  #                    or sends PUT    request to http://service:port/single
+  #                                    if my_single has been requested before
   #   my_single.delete => sends DELETE request to http://service:port/single
   #
   # SingletonResources do not support the Resource method :all, since
   # always only a single instance of the resource is being returned
   #
   class SingletonResource < Acfs::Resource
-
-    # @api public
-    #
-    # Return true if model is a new record and was not saved yet.
-    #
-    # Checks weather object is loaded via delegator or not, since
-    # the id-attribute is not required for singletons this check
-    # cannot check for existence of value in id-attribute
-    #
-    # @return [Boolean] True if resource is newly created, false otherwise.
-    #
-    def new?
-      !loaded?
-    end
-    alias :new_record? :new?
-
     # @api public
     #
     # Destroy resource by sending a DELETE request.
@@ -66,7 +51,8 @@ module Acfs
       #   @param [ Hash ] opts Additional options.
       #   @option opts [ Hash ] :params Additional parameters added to request.
       #
-      #   @yield [ resource ] Callback block to be executed after resource was fetched successfully.
+      #   @yield [ resource ] Callback block to be executed after
+      #     resource was fetched successfully.
       #   @yieldparam resource [ self ] Fetched resources.
       #
       #   @return [ self ] Resource object.
@@ -82,10 +68,11 @@ module Acfs
       # methods :all and :where are not defined.
       # :find_by is not defined on singletons, use :find instead
       #
-      undef_method :all
-      undef_method :where
-      undef_method :find_by
-      undef_method :find_by!
+      def all
+        raise ::Acfs::UnsupportedOperation.new
+      end
+      alias_method :find_by, :all
+      alias_method :find_by!, :all
 
       # @api private
       def location_default_path(_, path)

data/lib/acfs/stub.rb

@@ -1,7 +1,6 @@
 require 'rack/utils'
 
 module Acfs
-
   # Global handler for stubbing resources.
   #
   class Stub
@@ -14,7 +13,7 @@ module Acfs
 
       @opts[:with].stringify_keys! if @opts[:with].is_a? Hash
       @opts[:return].stringify_keys! if @opts[:return].is_a? Hash
-      @opts[:return].map! { |h| h.stringify_keys! if h.is_a? Hash } if @opts[:return].is_a? Array
+      @opts[:return].map! {|h| h.stringify_keys! if h.is_a? Hash } if @opts[:return].is_a? Array
     end
 
     def accept?(op)
@@ -22,15 +21,21 @@ module Acfs
 
       params = op.full_params.stringify_keys
       data   = op.data.stringify_keys
-
-      return true if opts[:with] == params || data == opts[:with]
-      return true if opts[:with].nil? && params.empty? && data.empty?
-
-      opts[:with] ||= {}
-      return true if opts[:with].reject{|_, v| v.nil? } == params.reject {|_, v| v.nil? }
-      return true if opts[:with].reject{|_, v| v.nil? } == data.reject {|_, v| v.nil? }
-
-      false
+      with   = opts[:with]
+
+      return true if with.nil?
+
+      case opts.fetch(:match, :inclusion)
+        when :legacy
+          return true if with.empty? && params.empty? && data.empty?
+          return true if with.reject {|_, v| v.nil? } == params.reject {|_, v| v.nil? }
+          return true if with.reject {|_, v| v.nil? } == data.reject {|_, v| v.nil? }
+          false
+        when :inclusion
+          !with.each_pair.any? do |k, v|
+            (params.key?(k) && params[k] != v) || (data.key?(k) && data[k] != v)
+          end
+      end
     end
 
     def calls
@@ -51,17 +56,20 @@ module Acfs
       if err
         raise_error op, err, opts[:return]
       elsif data
+        data = data.call(op) if data.respond_to?(:call)
+
         response = Acfs::Response.new op.request,
-                                      headers: opts[:headers] || {},
-                                      status:  opts[:status] || 200,
-                                      data:    data || {}
+          headers: opts[:headers] || {},
+          status:  opts[:status] || 200,
+          data:    data || {}
         op.call data, response
       else
-        raise ArgumentError, 'Unsupported stub.'
+        raise ArgumentError.new 'Unsupported stub.'
       end
     end
 
     private
+
     def raise_error(op, name, data)
       raise name if name.is_a? Class
       data.stringify_keys! if data.respond_to? :stringify_keys!
@@ -70,13 +78,12 @@ module Acfs
     end
 
     class << self
-
       # Stub a resource with given handler block. An already created handler
       # for same resource class will be overridden.
       #
-      def resource(klass, action, opts = {}, &block)
+      def resource(klass, action, opts = {}, &_block)
         action = action.to_sym
-        raise ArgumentError, "Unknown action `#{action}`." unless ACTIONS.include? action
+        raise ArgumentError.new "Unknown action `#{action}`." unless ACTIONS.include? action
 
         Stub.new(opts).tap do |stub|
           stubs[klass]         ||= {}
@@ -97,11 +104,11 @@ module Acfs
         @enabled ||= false
       end
 
-      def enable;
+      def enable
         @enabled = true
       end
 
-      def disable;
+      def disable
         @enabled = false
       end
 
@@ -119,7 +126,7 @@ module Acfs
         return false unless (classes = stubs[op.resource])
         return false unless (stubs = classes[op.action])
 
-        accepted_stubs = stubs.select { |stub| stub.accept? op }
+        accepted_stubs = stubs.select {|stub| stub.accept? op }
 
         raise AmbiguousStubError.new stubs: accepted_stubs, operation: op if accepted_stubs.size > 1
 
@@ -143,8 +150,9 @@ module Acfs
       end
 
       private
+
       def pretty_print
-        out = String.new
+        out = ''
         stubs.each do |klass, actions|
           out << '  ' << klass.name << ":\n"
           actions.each do |action, stubs|

data/lib/acfs/util.rb

@@ -7,7 +7,7 @@ module Acfs
       end
 
       def __invoke__
-        __callbacks__.each{|c| c.call self}
+        __callbacks__.each {|c| c.call self }
       end
     end
 

data/lib/acfs/version.rb

@@ -1,12 +1,14 @@
 module Acfs
   module VERSION
     MAJOR = 0
-    MINOR = 42
+    MINOR = 43
     PATCH = 0
     STAGE = nil
 
     STRING = [MAJOR, MINOR, PATCH, STAGE].reject(&:nil?).join('.')
 
-    def self.to_s; STRING end
+    def self.to_s
+      STRING
+    end
   end
 end