acfs 1.0.0.dev.1.b305 → 1.0.0

data/lib/acfs/middleware/base.rb

@@ -1,6 +1,5 @@
 module Acfs
   module Middleware
-
     # A base middleware that does not modify request or response.
     # Can be used as super class for custom middleware implementations.
     #
@@ -13,7 +12,7 @@ module Acfs
       end
 
       def call(request)
-        request.on_complete { |res, nxt| response(res, nxt) } if respond_to? :response
+        request.on_complete {|res, nxt| response(res, nxt) } if respond_to? :response
         app.call(request)
       end
     end

data/lib/acfs/middleware/json.rb

@@ -0,0 +1,27 @@
+require 'multi_json'
+
+module Acfs
+  module Middleware
+    # A middleware to encore request data using JSON.
+    #
+    class JSON < Serializer
+      def mime
+        ::Mime::JSON
+      end
+
+      def encode(data)
+        ::MultiJson.dump data
+      end
+
+      def decode(body)
+        ::MultiJson.load body
+      end
+    end
+
+    # @deprecated
+    JsonDecoder = JSON
+
+    # @deprecated
+    JsonEncoder = JSON
+  end
+end

data/lib/acfs/middleware/logger.rb

@@ -2,11 +2,9 @@ require 'logger'
 
 module Acfs
   module Middleware
-
     # Log requests and responses.
     #
     class Logger < Base
-
       def initialize(app, options = {})
         super
         @logger = options[:logger] if options[:logger]

data/lib/acfs/middleware/msgpack.rb

@@ -0,0 +1,30 @@
+require 'msgpack'
+require 'action_dispatch'
+
+module Acfs
+  module Middleware
+    class MessagePack < Serializer
+      unless defined?(::Mime::MSGPACK)
+        ::Mime::Type.register 'application/x-msgpack', :msgpack
+      end
+
+      def mime
+        ::Mime::MSGPACK
+      end
+
+      def encode(data)
+        ::MessagePack.pack data
+      end
+
+      def decode(body)
+        ::MessagePack.unpack body
+      end
+    end
+
+    # @deprecated
+    MessagePackEncoder = MessagePack
+
+    # @deprecated
+    MessagePackDecoder = MessagePack
+  end
+end

data/lib/acfs/middleware/print.rb

@@ -1,10 +1,8 @@
 module Acfs
   module Middleware
-
     # Print resquests and response on terminal
     #
     class Print < Base
-
       def call(req)
         puts '-' * 80
         puts req.inspect

data/lib/acfs/middleware/serializer.rb

@@ -0,0 +1,39 @@
+module Acfs
+  module Middleware
+    # A base middleware that does not modify request or response.
+    # Can be used as super class for custom middleware implementations.
+    #
+    class Serializer < Base
+      def encode(_data)
+        raise NotImplementedError
+      end
+
+      def decode(_data)
+        raise NotImplementedError
+      end
+
+      def mime
+        raise NotImplementedError
+      end
+
+      def call(request)
+        unless request.headers['Content-Type']
+          request.body = encode request.data
+          request.headers['Content-Type'] = mime
+        end
+
+        accept = request.headers['Accept'].to_s.split(',')
+        accept << "#{mime};q=#{options.fetch(:q, 1)}"
+        request.headers['Accept'] = accept.join(',')
+
+        request.on_complete do |response, nxt|
+          response.data = decode response.body if mime == response.content_type
+
+          nxt.call response
+        end
+
+        app.call(request)
+      end
+    end
+  end
+end

data/lib/acfs/operation.rb

@@ -1,5 +1,4 @@
 module Acfs
-
   # @api private
   #
   # Describes a CRUD operation. Handle request creation and response
@@ -51,15 +50,16 @@ module Acfs
     end
 
     def method
-      { read: :get, list: :get, update: :put, create: :post, delete: :delete }[action]
+      {read: :get, list: :get, update: :put, create: :post, delete: :delete}[action]
     end
 
     def request
-      request = ::Acfs::Request.new url, method: method, params: params, data: data
+      request = ::Acfs::Request.new url, method: method, params: params,
+                                         data: data, operation: self
       request.on_complete do |response|
         ::ActiveSupport::Notifications.instrument 'acfs.operation.complete',
-                                                  operation: self,
-                                                  response: response
+          operation: self,
+          response: response
 
         handle_failure response unless response.success?
         callback.call response.data, response

data/lib/acfs/request.rb

@@ -1,25 +1,25 @@
 require 'acfs/request/callbacks'
 
 module Acfs
-
   # Encapsulate all data required to make up a request to the
   # underlaying http library.
   #
   class Request
     attr_accessor :body, :format
-    attr_reader :url, :headers, :params, :data, :method
+    attr_reader :url, :headers, :params, :data, :method, :operation
 
     include Request::Callbacks
 
     def initialize(url, options = {}, &block)
-      @url = URI.parse(url.to_s).tap do |url|
+      @url = URI.parse(url.to_s).tap do |_url|
         @data    = options.delete(:data) || nil
         @format  = options.delete(:format) || :json
         @headers = options.delete(:headers) || {}
         @params  = options.delete(:params) || {}
         @method  = options.delete(:method) || :get
       end.to_s
-      on_complete &block if block_given?
+      @operation = options.delete(:operation) || nil
+      on_complete(&block) if block_given?
     end
 
     def data?

data/lib/acfs/request/callbacks.rb

@@ -1,6 +1,5 @@
 module Acfs
   class Request
-
     # Module containing callback handling for Requests.
     # Current the only callback type is `on_complete`:
     #
@@ -8,7 +7,6 @@ module Acfs
     #   request.on_complete { |response| ... }
     #
     module Callbacks
-
       # Add a new `on_complete` callback for this request.
       #
       # @example Set on_complete.
@@ -43,8 +41,9 @@ module Acfs
       end
 
       private
+
       def call_callback(res, index)
-        callbacks[index].call res, proc { |res| call_callback res, index + 1 } if index < callbacks.size
+        callbacks[index].call res, proc {|bres| call_callback bres, index + 1 } if index < callbacks.size
       end
     end
   end

data/lib/acfs/resource.rb

@@ -17,8 +17,8 @@ class Acfs::Resource
   if ActiveModel::VERSION::MAJOR >= 4
     include ActiveModel::Model
   else
-    extend  ActiveModel::Naming
-    extend  ActiveModel::Translation
+    extend ActiveModel::Naming
+    extend ActiveModel::Translation
     include ActiveModel::Conversion
     include ActiveModel::Validations
   end

data/lib/acfs/resource/attributes.rb

@@ -178,7 +178,6 @@ class Acfs::Resource
 
     #
     module ClassMethods
-
       ATTR_CLASS_BASE = '::Acfs::Resource::Attributes'.freeze
 
       #
@@ -223,56 +222,30 @@ class Acfs::Resource
       #   Attributes with default values.
       #
       def attributes
-        Hash.new.tap do |attrs|
-          defined_attributes.each do |key, attr|
-            attrs[key] = attr.default_value
-          end
+        defined_attributes.each_with_object({}) do |(key, attr), hash|
+          hash[key] = attr.default_value
         end
       end
 
       def defined_attributes
-        @attributes ||= begin
-          attributes = {}
-          if superclass.respond_to?(:defined_attributes)
-            attributes.merge superclass.defined_attributes
-          end
-
-          attributes
+        if superclass.respond_to?(:defined_attributes)
+          superclass.defined_attributes.merge(local_attributes)
+        else
+          local_attributes
         end
       end
 
-      # @api public
-      #
-      # Return hash of attributes and there types.
-      #
-      # @example
-      #   class User < Acfs::Resource
-      #     attribute :name, :string
-      #     attribute :age, :integer, default: 25
-      #   end
-      #   User.attributes # => {"name": Acfs::Model::Attributes::String,
-      #                   #     "age":  Acfs::Model::Attributes::Integer}
-      #
-      # @return [Hash{Symbol => Class}] Attributes and their types.
-      #
-      def attribute_types
-        @attribute_types ||= begin
-          attribute_types = {}
-          if superclass.respond_to?(:attribute_types)
-            attribute_types.merge superclass.attribute_types
-          end
+      private
 
-          attribute_types
-        end
+      def local_attributes
+        @local_attributes ||= {}
       end
 
-      private
-
       def define_attribute(name, type, opts = {})
         name      = name.to_s
         attribute = type.new opts
 
-        defined_attributes[name] = attribute
+        local_attributes[name] = attribute
         define_attribute_method name
 
         send :define_method, name do

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

@@ -1,36 +1,27 @@
 module Acfs::Resource::Attributes
-
   #
   class Base
-    attr_reader :options
-
-    def initialize(opts = {})
-      @options = opts
-      @options.reverse_merge! allow_nil: true
-    end
+    attr_reader :default
 
-    def nil_allowed?
-      options[:allow_nil]
+    def initialize(default: nil)
+      @default = default
     end
 
-    def blank_allowed?
-      options[:allow_blank]
+    def cast(value)
+      cast_value(value) unless value.nil?
     end
 
     def default_value
-      if options[:default].is_a? Proc
-        options[:default]
+      if default.respond_to? :call
+        default
       else
-        cast options[:default]
+        cast default
       end
     end
 
-    def cast(obj)
-      return nil if obj.nil? && nil_allowed? || (obj == '' && blank_allowed?)
-      cast_type obj
-    end
+    private
 
-    def cast_type(obj)
+    def cast_value(_value)
       raise NotImplementedError
     end
   end

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

@@ -1,5 +1,4 @@
 module Acfs::Resource::Attributes
-
   # @api public
   #
   # Boolean attribute type. Use it in your model as an attribute type:
@@ -15,21 +14,24 @@ module Acfs::Resource::Attributes
   #  true, on, yes
   #
   class Boolean < Base
-
-    TRUE_VALUES = %w(true on yes 1)
+    FALSE_VALUES = [false, 0, '0', 'f', 'F', 'false', 'FALSE', 'off', 'OFF', 'no', 'NO'].to_set
 
     # @api public
     #
     # Cast given object to boolean.
     #
-    # @param [Object] obj Object to cast.
+    # @param [Object] value Object to cast.
     # @return [TrueClass, FalseClass] Casted boolean.
     #
-    def cast_type(obj)
-      return true if obj.is_a? TrueClass
-      return false if obj.is_a? FalseClass
+    def cast_value(value)
+      return true if value == true
+      return false if value == false
 
-      TRUE_VALUES.include? obj.to_s
+      if value.blank?
+        nil
+      else
+        !FALSE_VALUES.include?(value)
+      end
     end
   end
 end

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

@@ -1,5 +1,4 @@
 module Acfs::Resource::Attributes
-
   # @api public
   #
   # DateTime attribute type. Use it in your model as
@@ -16,18 +15,16 @@ module Acfs::Resource::Attributes
     #
     # Cast given object to DateTime.
     #
-    # @param [Object] obj Object to cast.
+    # @param [Object] value Object to cast.
     # @return [DateTime] Casted object as DateTime.
     #
-    def cast_type(obj)
-      if nil_allowed? && obj.blank?
+    def cast_value(value)
+      if value.blank?
         nil
-      elsif obj.is_a? ::DateTime
-        obj
-      elsif obj.is_a?(Time) || obj.is_a?(Date)
-        ::DateTime.iso8601 obj.iso8601
+      elsif value.acts_like?(:time) || value.acts_like?(:date)
+        value.to_datetime
       else
-        ::DateTime.iso8601 obj
+        ::DateTime.iso8601 value
       end
     end
   end

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

@@ -0,0 +1,37 @@
+module Acfs::Resource::Attributes
+  # @api public
+  #
+  # Dict attribute type. Use it in your model as an attribute type:
+  #
+  # @example
+  #   class User
+  #     include Acfs::Model
+  #     attribute :opts, :dict
+  #   end
+  #
+  class Dict < Base
+    # @api public
+    #
+    # Cast given object to a dict/hash.
+    #
+    # @param [Object] value Object to cast.
+    # @return [Hash] Casted object as hash.
+    # @raise [TypeError] If object cannot be casted to a hash.
+    #
+    def cast_value(value)
+      return {} if value.blank?
+
+      if value.is_a?(Hash)
+        value
+      elsif value.respond_to?(:serializable_hash)
+        value.serializable_hash
+      elsif value.respond_to?(:to_hash)
+        value.to_hash
+      elsif value.respond_to?(:to_h)
+        value.to_h
+      else
+        Hash(value)
+      end
+    end
+  end
+end