acfs 1.3.2 → 1.3.3

data/lib/acfs/resource/query_methods.rb

@@ -1,264 +0,0 @@
-class Acfs::Resource
-  # Methods providing the query interface for finding resouces.
-  #
-  # @example
-  #   class MyUser < Acfs::Resource
-  #   end
-  #
-  #   MyUser.find(5)               # Find single resource
-  #   MyUser.all                   # Full or partial collection of
-  #                                # resources
-  #   Comment.where(user: user.id) # Collection with additional parameter
-  #                                # to filter resources
-  #
-  module QueryMethods
-    extend ActiveSupport::Concern
-
-    #
-    module ClassMethods
-      # @api public
-      #
-      # @overload find(id, opts = {})
-      #   Find a single resource by given ID.
-      #
-      #   @example
-      #     user = User.find(5) # Will query `http://base.url/users/5`
-      #
-      #   @param id [Fixnum] Resource IDs to fetch from remote service.
-      #   @param params [Hash] Additional options.
-      #   @option opts [Hash] :params Additional parameters added to
-      #     request. `:id` will be overridden with given ID.
-      #
-      #   @yield [resource] Callback block to be executed after resource
-      #     was fetched successfully.
-      #   @yieldparam resource [self] Fetched resources.
-      #
-      #   @return [self] Resource object if only one ID was given.
-      #
-      # @overload find(ids, opts = {})
-      #   Load collection of specified resources by given IDs.
-      #
-      #   @example
-      #     User.find([1, 2, 5]) # Will return collection and will request
-      #                          # `http://base.url/users/1`,
-      #                          # `http://base.url/users/2`
-      #                          # and `http://base.url/users/5` parallel
-      #
-      #   @param ids [Array<Integer>] List of resource IDs.
-      #   @param opts [Hash] Additional options.
-      #   @option opts [Hash] :params Additional parameters added to
-      #     request. `:id` will be overridden with individual resource ID.
-      #
-      #   @yield [collection] Callback block to be executed after collection
-      #     was fetched successfully.
-      #   @yieldparam resource [Collection] Collection with fetched resources.
-      #
-      #   @return [Collection] Collection of requested resources.
-      #
-      def find(id_or_ids, opts = {}, &block)
-        if id_or_ids.respond_to? :each
-          find_multiple id_or_ids, opts, &block
-        else
-          find_single id_or_ids, opts, &block
-        end
-      end
-
-      # @api public
-      #
-      # Try to load all resources.
-      #
-      # @param params [Hash] Request parameters that will be send to
-      #   remote service.
-      #
-      # @yield [collection] Callback block to be executed when resource
-      #   collection was loaded successfully.
-      # @yieldparam collection [Collection] Collection of fetched resources.
-      #
-      # @return [Collection] Collection of requested resources.
-      #
-      def all(params = {}, opts = {}, &block)
-        collection = ::Acfs::Collection.new self
-        collection.__callbacks__ << block if block
-
-        operation :list, opts.merge(params: params) do |data, response|
-          data.each {|obj| collection << create_resource(obj) }
-          collection.process_response response
-          collection.loaded!
-          collection.__invoke__
-        end
-
-        collection
-      end
-      alias_method :where, :all
-
-      # @api public
-      #
-      # Try to load first resource. Return nil if no object can be loaded.
-      #
-      # @param params [Hash] Request parameters that will be send
-      #   to remote service.
-      #
-      # @yield [resource] Callback block to be executed after
-      #   resource was fetched (even if nil).
-      # @yieldparam resource [self] Fetched resource, nil
-      #   if empty list is returned
-      #
-      # @return [self] Resource object, nil if empty list is returned
-      #
-      def find_by(params, &block)
-        Acfs::Util::ResourceDelegator.new(new).tap do |m|
-          m.__callbacks__ << block unless block.nil?
-          operation :list, params: params do |data|
-            if data.empty?
-              m.__setobj__ nil
-            else
-              m.__setobj__ create_resource(data.first, origin: m.__getobj__)
-            end
-            m.__invoke__
-          end
-        end
-      end
-
-      # @api public
-      #
-      # Try to load first resource. Raise Acfs::ResourceNotFound
-      # exception if no object can be loaded.
-      #
-      # @param params [Hash] Request parameters that will be send
-      #   to remote service.
-      #
-      # @yield [resource] Callback block to be executed after
-      #   resource was fetched successfully.
-      # @yieldparam resource [self] Fetched resource, nil
-      #   if empty list is returned
-      #
-      # @return [self] Resource object, nil if empty list is returned
-      #
-      def find_by!(params, &block)
-        find_by params do |m|
-          if m.nil?
-            raise Acfs::ResourceNotFound.new message: 'Received erroneous ' \
-              "response: no `#{name}` with params #{params} found"
-          end
-          block.call m unless block.nil?
-        end
-      end
-
-      # @api public
-      #
-      # Iterates over all pages returned by index action.
-      #
-      # Server must return a paginated resource.
-      #
-      # @example
-      #   User.each_page do |page|
-      #     p page.size
-      #   end
-      #   Acfs.run
-      #   # => 50
-      #   # => 50
-      #   # => 42
-      #
-      # @param opts [Hash] Options passed to {#where}.
-      #
-      # @yield [collection] Callback that will be invoked for each page.
-      # @yieldparam collection [Collection] Paginated collection.
-      #
-      # @return [Collection] First page.
-      #
-      def each_page(opts = {})
-        cb = proc do |collection|
-          yield collection
-          collection.next_page(&cb)
-        end
-        where opts, &cb
-      end
-
-      # @api public
-      #
-      # Iterates over all items of all pages returned by index action.
-      #
-      # Server must return a paginated resource.
-      #
-      # @example
-      #   index = 0
-      #   User.each_item do |page|
-      #     index += 1
-      #   end
-      #   Acfs.run
-      #   print index
-      #   # => 142
-      #
-      # @param opts [Hash] Options passed to {#each_page}.
-      #
-      # @yield [item] Callback that will be invoked for each item.
-      # @yieldparam item [self] Resource.
-      # @yieldparam collection [Acfs::Collection] Collection.
-      #
-      def each_item(opts = {})
-        each_page(opts) do |collection|
-          collection.each do |item|
-            yield item, collection
-          end
-        end
-      end
-
-      private
-
-      def find_single(id, opts, &block)
-        model = Acfs::Util::ResourceDelegator.new new
-
-        opts[:params] ||= {}
-        opts[:params].merge! id: id unless id.nil?
-
-        model.__callbacks__ << block unless block.nil?
-
-        operation :read, opts do |data|
-          model.__setobj__ create_resource data, origin: model.__getobj__
-          model.__invoke__
-        end
-
-        model
-      end
-
-      def find_multiple(ids, opts, &block)
-        ::Acfs::Collection.new(self).tap do |collection|
-          collection.__callbacks__ << block unless block.nil?
-
-          counter = 0
-          ids.each_with_index do |id, index|
-            find_single id, opts do |resource|
-              collection[index] = resource
-              if (counter += 1) == ids.size
-                collection.loaded!
-                collection.__invoke__
-              end
-            end
-          end
-        end
-      end
-
-      def create_resource(data, opts = {})
-        type = data.delete 'type'
-        klass = resource_class_lookup(type)
-        (opts[:origin].is_a?(klass) ? opts[:origin] : klass.new).tap do |m|
-          m.write_attributes data, opts
-          m.loaded!
-        end
-      end
-
-      def resource_class_lookup(type)
-        return self if type.nil?
-        klass = type.camelize.constantize
-
-        unless klass <= self
-          raise Acfs::ResourceTypeError.new type_name: type, base_class: self
-        end
-
-        klass
-      rescue NameError, NoMethodError
-        raise Acfs::ResourceTypeError.new type_name: type, base_class: self
-      end
-    end
-  end
-end

data/lib/acfs/resource/service.rb

@@ -1,42 +0,0 @@
-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.
-      #
-      # @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.
-      #
-      #   @example
-      #     class AccountService < Acfs::Client
-      #       self.base_url = 'http://acc.serv.org'
-      #     end
-      #
-      #     class MyUser < Acfs::Resource
-      #       service AccountService
-      #     end
-      #     MyUser.find 5 # Will fetch `http://acc.serv.org/users/5`
-      #
-      #   @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
-        @service || superclass.service
-      end
-    end
-  end
-end

data/lib/acfs/resource/validation.rb

@@ -1,37 +0,0 @@
-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)
-      if errors.respond_to?(:each_pair)
-        errors.each_pair do |field, errs|
-          Array(errs).each do |err|
-            self.errors.add field.to_sym, err
-            remote_errors.add field.to_sym, err
-          end
-        end
-      else
-        Array(errors).each do |err|
-          self.errors.add :base, err
-          remote_errors.add :base, err
-        end
-      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

@@ -1,28 +0,0 @@
-require 'acfs/response/formats'
-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.
-  #
-  class Response
-    attr_accessor :data
-    attr_reader :headers, :body, :request, :status
-
-    include Response::Formats
-    include Response::Status
-
-    # 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]  || 0
-      @headers  = data[:headers] || {}
-      @body     = data[:body]    || ''
-      @data     = data[:data]    || nil
-    end
-  end
-end

data/lib/acfs/response/formats.rb

@@ -1,25 +0,0 @@
-require 'action_dispatch'
-
-module Acfs
-  class Response
-    # Quick accessors for format handling.
-    module Formats
-      def content_type
-        @content_type ||= read_content_type
-      end
-
-      def json?
-        content_type == Mime[:json]
-      end
-
-      private
-
-      def read_content_type
-        return 'text/plain' unless headers && headers['Content-Type']
-
-        content_type = headers['Content-Type'].split(/;\s*\w+="?\w+"?/).first
-        Mime::Type.parse(content_type).first
-      end
-    end
-  end
-end

data/lib/acfs/response/status.rb

@@ -1,31 +0,0 @@
-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_method :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/rspec.rb

@@ -1,11 +0,0 @@
-require 'acfs'
-
-RSpec.configure do |config|
-  config.before(:each) do
-    Acfs::Stub.enable
-  end
-
-  config.after(:each) do
-    Acfs.reset
-  end
-end

data/lib/acfs/runner.rb

@@ -1,97 +0,0 @@
-require 'acfs/service/middleware'
-
-module Acfs
-  # @api private
-  #
-  class Runner
-    include Service::Middleware
-    attr_reader :adapter
-
-    def initialize(adapter)
-      @adapter = adapter
-      @running = false
-    end
-
-    # Process an operation. Synchronous operations will be run
-    # and parallel operations will be queued.
-    #
-    def process(op)
-      ::ActiveSupport::Notifications.instrument 'acfs.operation.before_process', operation: op
-      op.synchronous? ? run(op) : enqueue(op)
-    end
-
-    # Run operation right now skipping queue.
-    #
-    def run(op)
-      ::ActiveSupport::Notifications.instrument 'acfs.runner.sync_run', operation: op do
-        op_request(op) {|req| adapter.run req }
-      end
-    end
-
-    # List of current queued operations.
-    #
-    def queue
-      @queue ||= []
-    end
-
-    # Enqueue operation to be run later.
-    #
-    def enqueue(op)
-      ::ActiveSupport::Notifications.instrument 'acfs.runner.enqueue', operation: op do
-        if running?
-          op_request(op) {|req| adapter.queue req }
-        else
-          queue << op
-        end
-      end
-    end
-
-    # Return true if queued operations are currently processed.
-    #
-    def running?
-      @running
-    end
-
-    # Start processing queued operations.
-    #
-    def start
-      return if running?
-
-      enqueue_operations
-      start_all
-    rescue
-      queue.clear
-      raise
-    end
-
-    def clear
-      queue.clear
-      adapter.abort
-      @running = false
-    end
-
-    private
-
-    def start_all
-      @running = true
-      adapter.start
-    ensure
-      @running = false
-    end
-
-    def enqueue_operations
-      while (op = queue.shift)
-        op_request(op) {|req| adapter.queue req }
-      end
-    end
-
-    def op_request(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
-      return unless req.is_a? Acfs::Request
-      yield req
-    end
-  end
-end