acfs 1.3.2 → 1.3.3

data/lib/acfs/resource/attributes/list.rb

@@ -1,34 +0,0 @@
-module Acfs::Resource::Attributes
-  # @api public
-  #
-  # List attribute type. Use it in your model as an attribute type:
-  #
-  # @example
-  #   class User < Acfs::Resource
-  #     attribute :name, :list
-  #   end
-  #
-  class List < Base
-    # @api public
-    #
-    # Cast given object to a list.
-    #
-    # @param [Object] value Object to cast.
-    # @return [Fixnum] Casted object as list.
-    # @raise [TypeError] If object cannot be casted to a list.
-    #
-    def cast_value(value)
-      return [] if value.blank?
-
-      if value.is_a?(::Array)
-        value
-      elsif value.respond_to?(:to_ary)
-        value.to_ary
-      elsif value.respond_to?(:to_a)
-        value.to_a
-      else
-        Array(value)
-      end
-    end
-  end
-end

data/lib/acfs/resource/attributes/string.rb

@@ -1,24 +0,0 @@
-module Acfs::Resource::Attributes
-  # @api public
-  #
-  # String attribute type. Use it in your model as
-  # an attribute type:
-  #
-  # @example
-  #   class User < Acfs::Resource
-  #     attribute :name, :string
-  #   end
-  #
-  class String < Base
-    # @api public
-    #
-    # Cast given object to string.
-    #
-    # @param [Object] value Object to cast.
-    # @return [String] Casted string.
-    #
-    def cast_value(value)
-      value.to_s
-    end
-  end
-end

data/lib/acfs/resource/attributes/uuid.rb

@@ -1,47 +0,0 @@
-module Acfs::Resource::Attributes
-  # @api public
-  #
-  # UUID attribute type. Use it in your model as an attribute type:
-  #
-  # @example
-  #   class User < Acfs::Resource
-  #     attribute :id, :uuid
-  #   end
-  #
-  class UUID < Base
-    #
-    UUID_REGEXP = /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/i
-
-    # @api public
-    #
-    # Check if given object looks like a UUID, eg:
-    #   `450b7a40-94ad-11e3-baa8-0800200c9a66`
-    # Valid UUIDs are 16 byte numbers represented as
-    #  a hexadecimal string in five sub-groups seperated
-    #  by a dash. Each group has to consist of a fixed
-    #  number of hexadecimal digits:
-    #   | Group | Digits |
-    #   | -----:|:------ |
-    #   |     1 | 8      |
-    #   |     2 | 4      |
-    #   |     3 | 4      |
-    #   |     4 | 4      |
-    #   |     5 | 12     |
-    #
-    # @param [Object] value Object to cast.
-    # @return [String] Casted object as UUID.
-    #
-    def cast_value(value)
-      if value.blank?
-        nil
-      elsif value.to_s =~ UUID_REGEXP
-        value
-      else
-        raise TypeError.new "Invalid UUID: `#{value.to_s}'"
-      end
-    end
-  end
-
-  # Lower-case alias for automatic type lookup
-  Uuid = UUID
-end

data/lib/acfs/resource/dirty.rb

@@ -1,35 +0,0 @@
-class Acfs::Resource
-  #
-  # Thin wrapper around ActiveModel::Dirty
-  #
-  module Dirty
-    extend ActiveSupport::Concern
-    include ActiveModel::Dirty
-
-    # @api private
-    #
-    def reset_changes
-      clear_changes_information
-    end
-
-    # @api private
-    #
-    def save!(*)
-      super.tap {|_| changes_applied }
-    end
-
-    # @api private
-    #
-    def loaded!
-      reset_changes
-      super
-    end
-
-    # @api private
-    #
-    def write_raw_attribute(name, value, opts = {})
-      attribute_will_change!(name) if opts[:change].nil? || opts[:change]
-      super
-    end
-  end
-end

data/lib/acfs/resource/initialization.rb

@@ -1,29 +0,0 @@
-class Acfs::Resource
-  #
-  # Initialization drop-in for pre-4.0 ActiveModel.
-  #
-  module Initialization
-    #
-    # @api public
-    #
-    # Initializes a new model with the given `params`. fff
-    #
-    # @example
-    #   class User < Acfs::Resource
-    #     attribute :name
-    #     attribute :email, default: ->{ "#{name}@dom.tld" }
-    #     attribute :age, :integer, default: 18
-    #   end
-    #
-    #   user = User.new(name: 'bob')
-    #   user.name  # => "bob"
-    #   user.email # => "bob@dom.tld"
-    #   user.age   # => 18
-    #
-    # @param params [Hash{Symbol => Object}] Attributes to set on resource.
-    #
-    def initialize(params = {})
-      write_attributes params if params
-    end
-  end
-end

data/lib/acfs/resource/loadable.rb

@@ -1,33 +0,0 @@
-class Acfs::Resource
-  # Provides method to check for loading state of resources.
-  # A resource that is created but not yet fetched will be loaded
-  # after running {Acfs::Global#run Acfs.run}.
-  #
-  # @example
-  #   user = User.find 5
-  #   user.loaded? # => false
-  #   Acfs.run
-  #   user.loaded? # => true
-  #
-  module Loadable
-    extend ActiveSupport::Concern
-
-    # @api public
-    #
-    # Check if model is loaded or if request is still queued.
-    #
-    # @return [Boolean] True if resource is loaded, false otherwise.
-    #
-    def loaded?
-      @loaded.nil? ? false : @loaded
-    end
-
-    # @api private
-    #
-    # Mark model as loaded.
-    #
-    def loaded!
-      @loaded = true
-    end
-  end
-end

data/lib/acfs/resource/locatable.rb

@@ -1,128 +0,0 @@
-class Acfs::Resource
-  # Provide methods for generation URLs for resources.
-  #
-  # @example
-  #   class User
-  #     service AccountService # With base URL `http://acc.svr`
-  #   end
-  #   User.url    # => "http://acc.svr/users"
-  #   User.url(5) # => "http://acc.svr/users/5"
-  #
-  module Locatable
-    extend ActiveSupport::Concern
-
-    #
-    module ClassMethods
-      # @overload url(suffix)
-      #   @deprecated
-      #   Return URL for this class of resource. Given suffix
-      #   will be appended.
-      #
-      #   @example
-      #     User.url    # => "http://users.srv.org/users"
-      #     User.url(5) # => "http://users.srv.org/users/5"
-      #
-      #   @param suffix [String] Suffix to append to URL.
-      #   @return [String] Generated URL.
-      #
-      # @overload url(opts = {})
-      #   Return URL for this class of resources. Given options
-      #   will be used to replace URL path arguments and to
-      #   determine the operation action.
-      #
-      #   @example
-      #     User.url(id: 5, action: :read) # => "http://users.srv.org/users/5"
-      #     User.url(action: :list) # => "http://users.srv.org/users"
-      #
-      #   @param opts [Hash] Options.
-      #   @option opts [Symbol] :action Operation action,
-      #     usually `:list`, `:create`, `:read`, `:update` or`:delete`.
-      #   @return [String] Generated URL.
-      #
-      def url(suffix = nil, opts = {})
-        opts, suffix = suffix, nil if suffix.is_a? Hash
-
-        opts[:action] = :list if suffix
-
-        url  = location(opts).build(opts).str
-        url += "/#{suffix}" if suffix.to_s.present?
-        url
-      end
-
-      # Return a location object able to build the URL for this
-      # resource and given action.
-      #
-      # @example
-      #   class Identity < ::Acfs::Resource
-      #     service MyService, path: 'users/:user_id/identities'
-      #   end
-      #
-      #   location = Identity.location(action: :read)
-      #   location.arguments
-      #   => [:user_id, :id]
-      #
-      #   location.raw_url
-      #   => 'http://service/users/:user_id/identities/:id'
-      #
-      #   location = Identity.location(action: :list)
-      #   location.arguments
-      #   => [:user_id]
-      #
-      #   location.build(user_id: 42)
-      #   => 'http://service/users/42/identities'
-      #
-      # @param opts [Hash] Options.
-      # @option opts [Symbol] :action Operation action,
-      #   usually `:list`, `:create`, `:read`, `:update` or`:delete`.
-      #
-      # @return [Location] Location object.
-      #
-      def location(opts = {})
-        service.location(self, opts)
-      end
-
-      # @api private
-      def location_default_path(action, path)
-        case action
-          when :list, :create
-            return path
-          when :read, :update, :delete
-            return "#{path}/:id"
-        end
-      end
-    end
-
-    # Return URL for this resource. Resource if will be appended
-    # as suffix if present.
-    #
-    # @example
-    #   user.new.url # => "http://users.srv.org/users"
-    #
-    #   user = User.find 5
-    #   Acfs.run
-    #   user.url # => "http://users.srv.org/users/5"
-    #
-    # @return [ String ] Generated URL.
-    # @see ClassMethods#url
-    #
-    def url(opts = {})
-      return nil if need_primary_key? && !primary_key?
-
-      self.class.service
-        .location(self.class, opts.reverse_merge(action: :read))
-        .build(attributes).str
-    end
-
-    # @api private
-    # Return true if resource needs a primary key (id) for singular actions.
-    def need_primary_key?
-      true
-    end
-
-    # @api private
-    # Return true if resource has a primary key (id) set.
-    def primary_key?
-      respond_to?(:id) && !id.nil?
-    end
-  end
-end

data/lib/acfs/resource/operational.rb

@@ -1,22 +0,0 @@
-class Acfs::Resource
-  # @api private
-  #
-  # Provide methods for creating and processing CRUD operations and
-  # handling responses. That includes error handling as well as
-  # handling stubbed resources.
-  #
-  # Should only be used internal.
-  #
-  module Operational
-    extend ActiveSupport::Concern
-    delegate :operation, to: :'self.class'
-
-    #
-    module ClassMethods
-      # Invoke CRUD operation.
-      def operation(action, opts = {}, &block)
-        Acfs.runner.process ::Acfs::Operation.new self, action, opts, &block
-      end
-    end
-  end
-end

data/lib/acfs/resource/persistence.rb

@@ -1,257 +0,0 @@
-class Acfs::Resource
-  #
-  # Allow to track the persistence state of a model.
-  #
-  module Persistence
-    extend ActiveSupport::Concern
-
-    # @api public
-    #
-    # Check if the model is persisted. A model is persisted if
-    # it is saved after being created
-    #
-    # @example Newly created resource:
-    #   user = User.new name: "John"
-    #   user.persisted? # => false
-    #   user.save
-    #   user.persisted? # => true
-    #
-    # @example Modified resource:
-    #   user2 = User.find 5
-    #   user2.persisted? # => true
-    #   user2.name = 'Amy'
-    #   user2.persisted? # => true
-    #   user2.save
-    #   user2.persisted? # => true
-    #
-    # @return [Boolean] True if resource has been saved
-    #
-    def persisted?
-      !new?
-    end
-
-    # @api public
-    #
-    # Return true if model is a new record and was not saved yet.
-    #
-    # @return [Boolean] True if resource is newly created,
-    #   false otherwise.
-    #
-    def new?
-      !loaded?
-    end
-    alias_method :new_record?, :new?
-
-    # @api public
-    #
-    # Saves the resource.
-    #
-    # It will PUT to the service to update the resource or send
-    # a POST to create a new one if the resource is new.
-    #
-    # Saving a resource is a synchronous operation.
-    #
-    # @return [Boolean] True if save operation was successful,
-    #   false otherwise.
-    # @see #save! See {#save!} for available options.
-    #
-    def save(*args)
-      save!(*args)
-      true
-    rescue Acfs::Error
-      false
-    end
-
-    # @api public
-    #
-    # Saves the resource. Raises an error if something happens.
-    #
-    # Saving a resource is a synchronous operation.
-    #
-    # @param opts [Hash] Hash with additional options.
-    # @option opts [Hash] :data Data to send to remote service.
-    #   Default will be resource attributes.
-    #
-    # @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
-    #
-    def save!(opts = {})
-      opts[:data] = attributes unless opts[:data]
-
-      operation((new? ? :create : :update), opts) do |data|
-        update_with data
-      end
-    rescue ::Acfs::InvalidResource => err
-      self.remote_errors = err.errors
-      raise err
-    end
-
-    # @api public
-    #
-    # Update attributes with given data and save resource.
-    #
-    # Saving a resource is a synchronous operation.
-    #
-    # @param attrs [Hash] Hash with attributes to write.
-    # @param opts [Hash] 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 [Boolean]
-    # @see #delete!
-    #
-    def delete(opts = {})
-      delete! opts
-      true
-    rescue Acfs::Error
-      false
-    end
-
-    # @api public
-    #
-    # Destroy resource by sending a DELETE request.
-    # Will raise an error in case something goes wrong.
-    #
-    # Deleting a resource is a synchronous operation.
-
-    # @raise [Acfs::ErroneousResponse]
-    #   If remote service respond with not successful response.
-    #
-    # @return [undefined]
-    # @see #delete
-    #
-    def delete!(opts = {})
-      opts[:params] ||= {}
-      opts[:params] = attributes_for_url(:delete).merge opts[:params]
-
-      operation :delete, opts do |data|
-        update_with data
-        freeze
-      end
-    end
-
-    private
-
-    def attributes_for_url(action)
-      arguments_for_url = self.class.location(action: action).arguments
-      attributes.slice(*arguments_for_url)
-    end
-
-    module ClassMethods
-      # @api public
-      #
-      # Create a new resource sending given data. If resource cannot be
-      # created an error will be thrown.
-      #
-      # Saving a resource is a synchronous operation.
-      #
-      # @param data [Hash{Symbol, String => Object}]
-      #   Data to send in create request.
-      #
-      # @return [self] Newly resource object.
-      #
-      # @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 Acfs::Model::Persistence#save! Available options. `:data`
-      #   will be overridden with provided data hash.
-      # @see #create
-      #
-      def create!(data, _opts = {})
-        new(data).tap(&:save!)
-      end
-
-      # @api public
-      #
-      # Create a new resource sending given data. If resource cannot be
-      # create model will be returned and error hash contains response
-      # errors if available.
-      #
-      # Saving a resource is a synchronous operation.
-      #
-      # @param data [Hash{Symbol, String => Object}]
-      #   Data to send in create request.
-      #
-      # @return [self] Newly resource object.
-      #
-      # @raise [Acfs::ErroneousResponse]
-      #   If remote service respond with not successful response.
-      #
-      # @see Acfs::Model::Persistence#save! Available options. `:data`
-      #   will be overridden with provided data hash.
-      # @see #create!
-      #
-      def create(data, _opts = {})
-        model = new data
-        model.save
-        model
-      end
-    end
-
-    private
-
-    def update_with(data)
-      self.attributes = data
-      loaded!
-    end
-
-    def check_loaded!(opts = {})
-      return if loaded? || opts[:force]
-      raise ::Acfs::ResourceNotLoaded.new resource: self
-    end
-  end
-end