acfs 0.50.0 → 1.0.0.dev.1.b297

data/lib/acfs/location.rb

@@ -1,4 +1,5 @@
 module Acfs
+
   # @api private
   #
   # Describes a URL with placeholders.
@@ -6,17 +7,17 @@ module Acfs
   class Location
     attr_reader :arguments, :raw, :struct, :args
 
-    REGEXP = /^:([A-z][A-z0-9_]*)$/
+    REGEXP= /^:([A-z][A-z0-9_]*)$/
 
     def initialize(uri, args = {})
       @raw       = URI.parse uri
       @args      = args
-      @struct    = raw.path.split('/').reject(&:empty?).map {|s| s =~ REGEXP ? Regexp.last_match[1].to_sym : s }
-      @arguments = struct.select {|s| s.is_a?(Symbol) }
+      @struct    = raw.path.split('/').reject(&:empty?).map{|s| s =~ REGEXP ? $1.to_sym : s }
+      @arguments = struct.select{|s| Symbol === s }
     end
 
     def build(args = {})
-      unless args.is_a?(Hash)
+      unless Hash === args
         raise ArgumentError.new "URI path arguments must be a hash, `#{args.inspect}' given."
       end
 
@@ -24,8 +25,8 @@ module Acfs
     end
 
     def extract_from(*args)
-      args = {}.tap do |collect|
-        arguments.each {|key| collect[key] = extract_arg key, args }
+      args = Hash.new.tap do |collect|
+        arguments.each{|key| collect[key] = extract_arg key, args }
       end
 
       build args
@@ -33,7 +34,7 @@ module Acfs
 
     def str
       uri = raw.dup
-      uri.path = URI.escape '/' + struct.map {|s| lookup_arg(s, args) }.join('/')
+      uri.path = URI.escape '/' + struct.map{|s| lookup_arg(s, args) }.join('/')
       uri.to_s
     end
 
@@ -43,17 +44,16 @@ module Acfs
     alias_method :to_s, :raw_uri
 
     private
-
     def extract_arg(key, hashes)
       hashes.each_with_index do |hash, index|
-        return (index == 0 ? hash.delete(key) : hash.fetch(key)) if hash.key?(key)
+        return (index == 0 ? hash.delete(key) : hash.fetch(key)) if hash.has_key?(key)
       end
 
       nil
     end
 
     def lookup_arg(arg, args)
-      arg.is_a?(Symbol) ? lookup_replacement(arg, args) : arg
+      Symbol === arg ? lookup_replacement(arg, args) : arg
     end
 
     def lookup_replacement(sym, args)
@@ -67,7 +67,7 @@ module Acfs
       args.fetch(sym.to_s) do
         args.fetch(sym) do
           if args[:raise].nil? || args[:raise]
-            raise ArgumentError.new "URI path argument `#{sym}' missing on `#{self}'. Given: `#{args}.inspect'"
+            raise ArgumentError.new "URI path argument `#{sym}' missing on `#{to_s}'. Given: `#{args}.inspect'"
           else
             ":#{sym}"
           end

data/lib/acfs/middleware/base.rb

@@ -1,5 +1,6 @@
 module Acfs
   module Middleware
+
     # A base middleware that does not modify request or response.
     # Can be used as super class for custom middleware implementations.
     #
@@ -12,7 +13,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_decoder.rb

@@ -0,0 +1,16 @@
+require 'multi_json'
+
+module Acfs
+  module Middleware
+
+    # A middleware to automatically decode JSON responses.
+    #
+    class JsonDecoder < Base
+
+      def response(response, nxt)
+        response.data = ::MultiJson.load(response.body) if response.json?
+        nxt.call response
+      end
+    end
+  end
+end

data/lib/acfs/middleware/json_encoder.rb

@@ -0,0 +1,20 @@
+require 'multi_json'
+
+module Acfs
+  module Middleware
+
+    # A middleware to encore request data using JSON.
+    #
+    class JsonEncoder < Base
+
+      def call(request)
+        unless request.method == :get or request.data.nil?
+          request.body = ::MultiJson.dump(request.data)
+          request.headers['Content-Type'] = 'application/json'
+        end
+
+        app.call request
+      end
+    end
+  end
+end

data/lib/acfs/middleware/logger.rb

@@ -2,9 +2,11 @@ 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_decoder.rb

@@ -0,0 +1,26 @@
+require 'msgpack'
+require 'action_dispatch'
+
+module Acfs
+  module Middleware
+
+    # Register msgpack mime type
+    ::Mime::Type.register 'application/x-msgpack', :msgpack
+
+    # A middleware to decode Message Pack responses.
+    #
+    class MessagePackDecoder < Base
+
+      CONTENT_TYPES = %w(application/x-msgpack)
+
+      def response(response, nxt)
+        response.data = ::MessagePack.unpack(response.body) if message_pack?(response)
+        nxt.call response
+      end
+
+      def message_pack?(response)
+        CONTENT_TYPES.include? response.content_type
+      end
+    end
+  end
+end

data/lib/acfs/middleware/msgpack_encoder.rb

@@ -0,0 +1,19 @@
+require 'msgpack'
+require 'action_dispatch'
+
+module Acfs
+  module Middleware
+
+    # A middleware to encode request data with Message Pack.
+    #
+    class MessagePackEncoder < Base
+
+      def call(request)
+        request.body = ::MessagePack.dump(request.data)
+        request.headers['Content-Type'] = 'application/x-msgpack'
+
+        app.call request
+      end
+    end
+  end
+end

data/lib/acfs/middleware/print.rb

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

data/lib/acfs/operation.rb

@@ -1,4 +1,5 @@
 module Acfs
+
   # @api private
   #
   # Describes a CRUD operation. Handle request creation and response
@@ -50,16 +51,15 @@ 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, operation: self
+      request = ::Acfs::Request.new url, method: method, params: params, data: data
       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, :operation
+    attr_reader :url, :headers, :params, :data, :method
 
     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
-      @operation = options.delete(:operation) || nil
-      on_complete(&block) if block_given?
+      on_complete &block if block_given?
     end
 
     def data?

data/lib/acfs/request/callbacks.rb

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

@@ -47,7 +47,7 @@ class Acfs::Resource
     #   Attributes and their values.
     #
     def attributes
-      @_attrs ||= HashWithIndifferentAccess.new
+      @attributes ||= HashWithIndifferentAccess.new
     end
 
     # @api public
@@ -178,6 +178,7 @@ class Acfs::Resource
 
     #
     module ClassMethods
+
       ATTR_CLASS_BASE = '::Acfs::Resource::Attributes'.freeze
 
       #
@@ -222,30 +223,56 @@ class Acfs::Resource
       #   Attributes with default values.
       #
       def attributes
-        defined_attributes.each_with_object({}) do |(key, attr), hash|
-          hash[key] = attr.default_value
+        Hash.new.tap do |attrs|
+          defined_attributes.each do |key, attr|
+            attrs[key] = attr.default_value
+          end
         end
       end
 
       def defined_attributes
-        if superclass.respond_to?(:defined_attributes)
-          superclass.defined_attributes.merge(local_attributes)
-        else
-          local_attributes
+        @attributes ||= begin
+          attributes = {}
+          if superclass.respond_to?(:defined_attributes)
+            attributes.merge superclass.defined_attributes
+          end
+
+          attributes
         end
       end
 
-      private
+      # @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
 
-      def local_attributes
-        @local_attributes ||= {}
+          attribute_types
+        end
       end
 
+      private
+
       def define_attribute(name, type, opts = {})
         name      = name.to_s
         attribute = type.new opts
 
-        local_attributes[name] = attribute
+        defined_attributes[name] = attribute
         define_attribute_method name
 
         send :define_method, name do

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

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

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

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