flexirest 1.6.7 → 1.6.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d07c8260f4147a07a88031a028a1062a40f8fecc
-  data.tar.gz: db5f43a0ac0a8a2dc7b7e60dd8742d83ec614ddf
+  metadata.gz: 48c8e263cf0b1c959599454ce360b612b279b900
+  data.tar.gz: eba90a77d94f9d8e29f651ec1a1b7815a10b4aa6
 SHA512:
-  metadata.gz: abd6a9d4e215781f4f2a421cd796bd2c76878e47fb969c5191092d72c6ad6e613cef9bba5cf005a6651fadaa4637ba8475160c3f41eb089b3007994ea326d94b
-  data.tar.gz: 3934022f4a3ee6a28e6f4290a7228fe89a9f6cc116d00ceb6746c1fe29e6b4b4756c25277e200549f8c0b1bfb6577342343841d5104422b4f3041c8f3ae58084
+  metadata.gz: a43bc7600fd621a71e595e55b1aebddc19feda4eae959a376c429eb4498e35d2f55c64c62c5a97f4769a98036d8f31a207da90e72de94133d38a5ad5c680b080
+  data.tar.gz: 895458b577307cf2a2be5681fb827979847d61b13e36f89c236a3c1ddffcf3f98ace941fa9ed639e7cb7287ea5d291f0433f4ed8f360f5e7c305507e02853e4c

data/CHANGELOG.md

@@ -1,4 +1,10 @@
-# Changelog
+# Changelog
+
+## 1.6.8
+
+Feature:
+
+- A refactoring to allow users to chose to use ActiveModel validation instead of the custom ActiveModel-like validation built in to Flexirest. In a future release this will become the default. (thanks to KARASZI István for the pull request)
 
 ## 1.6.7
 
@@ -78,91 +84,91 @@ Feature:
 
 - Changing `_request` to accept options, including `:headers`, rather than headers directly
 
-## 1.5.3
+## 1.5.3
 
 Feature:
 
 - Allow passing custom headers as an option to raw requests.
 
-## 1.5.2
+## 1.5.2
 
 Bugfix:
 
 - Some APIs return an empty response body even on 200s, so any valid status with an empty body should be handled nicely
 
-## 1.5.1
+## 1.5.1
 
 Bugfix:
 
 - PUT/POST/PATCH methods called on an instantiated object should merge the objects attributes with specified params.
 
-## 1.5.0
+## 1.5.0
 
 Bugfix:
 
 - GET requests with the same URL as PUT requests shouldn't use the etag cached version.
 
-## 1.4.8/1.4.9
+## 1.4.8/1.4.9
 
 Bugfix:
 
 - Responses without content (202, 204) will return an empty object.
 
-## 1.4.7
+## 1.4.7
 
 Bugfix:
 
 - Responses without content (202, 204) will still make the headers available in `_headers`.
 
-## 1.4.6
+## 1.4.6
 
 Feature:
 
 - You can define how to handle the body of `delete` requests now with the mapping option `send_delete_body`.
 
-## 1.4.5
+## 1.4.5
 
 Bugfix:
 
 - DELETE requests shouldn't send a request body, the body semantics are undefined.
 
-## 1.4.4
+## 1.4.4
 
 Feature:
 
 - Handling 202s without any content the same as a 204.
 
-## 1.4.3
+## 1.4.3
 
 Feature:
 
 - Added more client exceptions to allow fine grained exception trapping
 
-## 1.4.2
+## 1.4.2
 
 Bugfix:
 
 - Breakage in path parameters where the value isn't specified
 
-## 1.4.1
+## 1.4.1
 
 Bugfix:
 
 - Pluses in URL params are now escaped to %2B (thanks to jan-vitek for the bug report and pull request)
 
-## 1.4.0
+## 1.4.0
 
 Feature:
 
 - New JSON API support - thanks to Mike Voets for all his hard work!
 
-## 1.3.35
+## 1.3.35
 
 Bugfix:
 
 - Slashes in URL params are now escaped to %2F (thanks to davidtolsma for the bug report)
 
-## 1.3.34
+## 1.3.34
 
 Feature:
 
@@ -172,187 +178,187 @@ Bugfix:
 
 - Now can disable caching on subclasses after being enabled on a parent (thanks to yujideveloper for the PR)
 
-## 1.3.33
+## 1.3.33
 
 Feature:
 
 - Allowed specifying custom message for validation failures
 
-## 1.3.32
+## 1.3.32
 
 Bugfix:
 
 - Rolled back 1.3.31 - was an error in client code
 
-## 1.3.31
+## 1.3.31
 
 Bugfix:
 
 - Working with later versions of Faraday where the response seems to have lost response_headers
 
-## 1.3.30
+## 1.3.30
 
 Bugfix:
 
 - Restoring cached Flexirest::ResultIterators created via a Proxy wasn't restoring correctly
 
-## 1.3.29
+## 1.3.29
 
 Bugfix:
 
 - Setting `perform_caching` on `Flexirest::Base` was being ignored
 
-## 1.3.28
+## 1.3.28
 
 Feature:
 
 - Implemented delete_if on ResultIterator
 
-## 1.3.27
+## 1.3.27
 
 Bugfix:
 
 - HTTP GET requests shouldn't send any body, JSON-encoded or otherwise
 
-## 1.3.26
+## 1.3.26
 
 Bugfix:
 
 - Parameters sent within the URL (e.g. /foo/:bar) should be URI escaped or Flexirest raises an error about unparseable URLs
 
-## 1.3.25
+## 1.3.25
 
 Feature:
 
 - Improvements in performance due to date parsing (thanks to guanglunw for the PR)
 
-## 1.3.24
+## 1.3.24
 
 Bugfix:
 
 - Calling class methods on an instance where the instance is cacheable should work (thanks to johnmckinght for the bug report)
 
-## 1.3.23
+## 1.3.23
 
 Bugfix:
 
 - Should not parse multiline strings as `DateTime` when using the automatica parsing (thanks to execjosh for the PR)
 
-## 1.3.22
+## 1.3.22
 
 Bugfix:
 
 - Broke a test in v1.3.21 (according to Travis) which was passing locally, updated all my gems and then it broke locally, so reverted the test.
 
-## 1.3.21
+## 1.3.21
 
 Feature:
 
 - Now any requests returning a 204 with an empty (nil or blank) body return true instead of raising a ParseException
 
-## 1.3.20
+## 1.3.20
 
 Bugfix:
 
 - Fixed `has_one` association raising an error if there is no associated object (it should just return `nil`) (thanks to Azat Galikhanov for the PR)
 
-## 1.3.19
+## 1.3.19
 
 Feature:
 
 - Added Headers in to Flexirest::ResponseParseException to aid debugging of why it doesn't work against custom APIs.
 
-## 1.3.18
+## 1.3.18
 
 Feature:
 
 - Simplistic load balancing of API servers by supplying an array of URLs to `base_url`. It then pulls a random one out for each request.
 
-## 1.3.17
+## 1.3.17
 
 Bugfix:
 
 - Authentication credentials weren't being passed through proxied classes (thanks to Lukasz Modlinski for the contribution).
 
-## 1.3.16
+## 1.3.16
 
 Feature:
 
 - Allows disabling of the automatic date parsing with the `Flexirest::Base.disable_automatic_date_parsing` setting and/or specifying it per mapped method with the `:parse_fields` option (thanks to Michael Mealling for the request).
 
-## 1.3.15
+## 1.3.15
 
 Feature:
 
 - Allows setting of the ApiAuth `:digest` or `:override_http_method` if v2.0 or above of ApiAuth is installed (thanks to Alan Ruth for the request).
 
-## 1.3.14
+## 1.3.14
 
 Feature:
 
 - Plain Requests (both using the `plain: true` option to mapped methods and using `_plain_request`) return a `Flexirest::PlainResponse` which is string-like for all intents and purposes (it's comparable with strings using the body of the response) and also has `_status` and `_headers` methods (thanks to Rui Ribeiro for the request/inspiration).
 
-## 1.3.13
+## 1.3.13
 
 Feature:
 
 - The undocumented `plain: true` option to mapped methods was tested and documented.
 
-## 1.3.12
+## 1.3.12
 
 Bugfix:
 
 - The Travis build was breaking because Guard pulls in Listen, which only runs on Ruby 2.2 and above. So I removed Guard so the gem can be tested to work against older Ruby versions still.
 
-## 1.3.11
+## 1.3.11
 
 Feature:
 
 - Made the `Flexirest::*Exception#message` much nicer to help debugging applications, e.g. `Sending PUT to '/enable' returned a 500 with the body of - {"error":"John doesn't exist", "code":1234}`.
 
-## 1.3.10
+## 1.3.10
 
 Feature:
 
 - Added per-request params encoding so you can choose between `param[]=foo&param[]=bar` or `param=foo&param=bar` (thanks to bkubic for the PR).
 
-## 1.3.9
+## 1.3.9
 
 Feature:
 
 - Proxying now works for PATCH requests, along with the existing GET, POST, PUT and DELETE (thanks to Andrew Schaper for the PR).
 
-## 1.3.8
+## 1.3.8
 
 Bugfix:
 
 - Fixing crash when trying to parse a JSON response body for error codes and no translator present.
 
-## 1.3.7
+## 1.3.7
 
 Bugfix:
 
 - Removed some more warnings about using uninitialized variables (thanks to Joel Low for the heads-up).
 
-## 1.3.6
+## 1.3.6
 
 Bugfix:
 
 - Removed some warnings about using uninitialized variables (thanks to Joel Low for the heads-up).
 
-## 1.3.5
+## 1.3.5
 
 Bugfix:
 
 - Deeply nested has_many relationships weren't working (thanks to Lewis Buckley for the bug report, spec and fix).
 
-## 1.3.4
+## 1.3.4
 
 Features:
 
 - Allows assigning `STDOUT` to `Flexirest::Logger.logfile` which can be useful when debugging Flexirest or applications at the console (either `rails console` from a Rails app or `rake console` from within Flexirest's codebase) along with setting `verbose!` on the class.
 
-## 1.3.3
+## 1.3.3
 
 Features:
 
@@ -504,7 +510,7 @@ Bugfixes
 - Start of XML support
 - URL encoding username and password
 
-## 1.0.9
+## 1.0.9
 
 Bugfixes
 

data/docs/validation.md

@@ -1,6 +1,6 @@
 # *Flexirest:* Validation
 
-You can create validations on your objects just like Rails' built in ActiveModel validations. For example:
+Flexirest comes with its own validation. It is very similar to the Rails' built in ActiveModel validations. For example:
 
 ```ruby
 class Person < Flexirest::Base
@@ -20,6 +20,7 @@ class Person < Flexirest::Base
 end
 ```
 
+
 Note: the block based validation is responsible for adding errors to `object._errors[name]` (and this will automatically be ready for `<<` inserting into).
 
 Validations are run when calling `valid?` or when calling any API on an instance (and then only if it is `valid?` will the API go on to be called).
@@ -83,6 +84,34 @@ The following attributes will pass validation since they explicitly `allow_nil`:
 - `:retirement_age`
 - `:favorite_authors`
 
+## ActiveModel::Validations
+
+This built-in validations have a bit different syntax than the ActiveModel validations and use a different codebase.
+
+You can opt-out from the built-in validations and use the `ActiveModel` validations instead if you inherit from the `Flexirest::BaseWithoutValidation` class instead of the `Flexirest::Base`.
+
+Here is the same example what you could see at the top but with `ActiveModel` validations:
+
+
+```ruby
+class Person < Flexirest::BaseWithoutValidation
+  include ActiveModel::Validations
+
+  validates :first_name, :last_name, presence: true # ensures that the value is present and not blank
+  validates :password, length: { within: 6..12, message: "Invalid password length, must be 6-12 characters" }
+  validates :post_code, length: { minimum: 6, maximum: 8 }
+  validates :salary, numericality: { greater_than_or_equal_to: 20_000, less_than_or_equal_to: 50_000 }
+  validates :age, numericality: { greater_than_or_equal_to: 18, less_than_or_equal_to: 65 }
+  validates :suffix, inclusion: { in: %w{Dr. Mr. Mrs. Ms.} }
+
+  validate do
+    errors.add(:name, "must be over 4 chars long") if first_name.length <= 4
+  end
+
+  get :index, '/'
+end
+```
+
 
 -----
 

data/flexirest.gemspec

@@ -34,6 +34,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'coveralls'
   spec.add_development_dependency "api-auth", ">= 1.3.1"
   spec.add_development_dependency 'typhoeus'
+  spec.add_development_dependency 'activemodel'
 
   spec.add_runtime_dependency "multi_json"
   spec.add_runtime_dependency "crack"

data/lib/flexirest.rb

@@ -20,6 +20,7 @@ require "flexirest/validation"
 require "flexirest/callbacks"
 require "flexirest/proxy_base"
 require "flexirest/recording"
+require "flexirest/base_without_validation"
 require "flexirest/base"
 require "flexirest/monkey_patching"
 require "flexirest/plain_response"
@@ -33,4 +34,8 @@ module Flexirest
   def self.name=(value)
     @@name = value
   end
+
+  class NoAttributeException < StandardError ; end
+  class ValidationFailedException < StandardError ; end
+  class MissingOptionalLibraryError < StandardError ; end
 end

data/lib/flexirest/base.rb

@@ -1,228 +1,14 @@
 module Flexirest
-  class Base
-    include Mapping
-    include Configuration
-    include Callbacks
+  class Base < BaseWithoutValidation
     include Validation
-    include Caching
-    include Recording
-    include AttributeParsing
-    include Associations
-
-    attr_accessor :_status
-    attr_accessor :_etag
-    attr_accessor :_headers
-
-    instance_methods.each do |m|
-      next unless %w{display presence load require hash untrust trust freeze method enable_warnings with_warnings suppress capture silence quietly debugger breakpoint}.map(&:to_sym).include? m
-      undef_method m
-    end
 
     def initialize(attrs={})
-      @attributes = {}
-      @dirty_attributes = Hash.new
-
-      raise Exception.new("Cannot instantiate Base class") if self.class.name == "Flexirest::Base"
-
-      attrs.each do |attribute_name, attribute_value|
-        attribute_name = attribute_name.to_sym
-        @attributes[attribute_name] = parse_date?(attribute_name) ? parse_attribute_value(attribute_value) : attribute_value
-        @dirty_attributes[attribute_name] = [nil, attribute_value]
-      end
-    end
-
-    def _clean!
-      @dirty_attributes = Hash.new
-    end
-
-    def _attributes
-      @attributes
-    end
-
-    def _copy_from(result)
-      @attributes = result._attributes
-      @_status = result._status
-    end
-
-    def dirty?
-      @dirty_attributes.size > 0
-    end
-
-    def changed?
-      dirty?
-    end
-
-    # Returns an array of changed fields
-    def changed
-      @dirty_attributes.keys
-    end
-
-    # Returns hash of old and new vaules for each changed field
-    def changes
-      @dirty_attributes
+      raise Exception.new("Cannot instantiate Base class") if self.class == Flexirest::Base
+      super
     end
 
     def errors
       @attributes[:errors] || (_errors != {} ? _errors : nil)
     end
-
-    def self._request(request, method = :get, params = nil, options = {})
-      prepare_direct_request(request, method, options).call(params)
-    end
-
-    def self._plain_request(request, method = :get, params = nil, options = {})
-      prepare_direct_request(request, method, options.merge(plain:true)).call(params)
-    end
-
-    def self._lazy_request(request, method = :get, params = nil, options = {})
-      Flexirest::LazyLoader.new(prepare_direct_request(request, method, options), params)
-    end
-
-    def self.prepare_direct_request(request, method = :get, options={})
-      unless request.is_a? Flexirest::Request
-        options[:plain] ||= false
-        options[:direct] ||= true
-        request = Flexirest::Request.new({ url: request, method: method, options: options }, self)
-      end
-      request
-    end
-
-    def self._request_for(method_name, *args)
-      if mapped = self._mapped_method(method_name)
-        params = (args.first.is_a?(Hash) ? args.first : nil)
-        request = Request.new(mapped, self, params)
-        request
-      else
-        nil
-      end
-    end
-
-    def [](key)
-      @attributes[key.to_sym]
-    end
-
-    def []=(key, value)
-      _set_attribute(key, value)
-    end
-
-    def each
-      @attributes.each do |key, value|
-        yield key, value
-      end
-    end
-
-    def inspect
-      inspection = if @attributes.any?
-                     @attributes.collect { |key, value|
-                       "#{key}: #{value_for_inspect(value)}"
-                     }.compact.join(", ")
-                   else
-                     "[uninitialized]"
-                   end
-      inspection += "#{"," if @attributes.any?} ETag: #{@_etag}" unless @_etag.nil?
-      inspection += "#{"," if @attributes.any?} Status: #{@_status}" unless @_status.nil?
-      inspection += " (unsaved: #{@dirty_attributes.keys.map(&:to_s).join(", ")})" if @dirty_attributes.any?
-      "#<#{self.class} #{inspection}>"
-    end
-
-    def method_missing(name, *args)
-      if name.to_s[-1,1] == "="
-        name = name.to_s.chop.to_sym
-        _set_attribute(name, args.first)
-      else
-        name_sym = name.to_sym
-        name = name.to_s
-
-        if @attributes.has_key? name_sym
-          @attributes[name_sym]
-        else
-          if name[/^lazy_/] && mapped = self.class._mapped_method(name_sym)
-            if mapped[:method] != :delete
-              raise ValidationFailedException.new unless valid?
-            end
-
-            request = Request.new(mapped, self, args.first)
-            Flexirest::LazyLoader.new(request)
-          elsif mapped = self.class._mapped_method(name_sym)
-            if mapped[:method] != :delete
-              raise ValidationFailedException.new unless valid?
-            end
-
-            request = Request.new(mapped, self, args.first)
-            request.call
-          elsif name[/_was$/] and @attributes.has_key? (name.sub(/_was$/,'').to_sym)
-            k = (name.sub(/_was$/,'').to_sym)
-            @dirty_attributes[k][0]
-          elsif name[/^reset_.*!$/] and @attributes.has_key? (name.sub(/^reset_/,'').sub(/!$/,'').to_sym)
-            k = (name.sub(/^reset_/,'').sub(/!$/,'').to_sym)
-            _reset_attribute(k)
-          elsif self.class.whiny_missing
-            raise NoAttributeException.new("Missing attribute #{name_sym}")
-          else
-            nil
-          end
-        end
-      end
-    end
-
-    def respond_to_missing?(method_name, include_private = false)
-      @attributes.has_key? method_name.to_sym
-    end
-
-    def to_hash
-      output = {}
-      @attributes.each do |key, value|
-        if value.is_a? Flexirest::Base
-          output[key.to_s] = value.to_hash
-        elsif value.is_a? Array
-          output[key.to_s] = value.map(&:to_hash)
-        else
-          output[key.to_s] = value
-        end
-      end
-      output
-    end
-
-    def to_json
-      output = to_hash
-      output.to_json
-    end
-
-    private
-
-    def _set_attribute(key, value)
-      old_value = @dirty_attributes[key.to_sym]
-      old_value = @attributes[key.to_sym] unless old_value
-      old_value = old_value[0] if old_value and old_value.is_a? Array
-      @dirty_attributes[key.to_sym] = [old_value, value]
-      @attributes[key.to_sym] = value
-    end
-
-    def _reset_attribute(key)
-      old_value = @dirty_attributes[key.to_sym]
-      @attributes[key.to_sym] = old_value[0] if old_value and old_value.is_a? Array
-      @dirty_attributes.delete(key.to_sym)
-    end
-
-    def value_for_inspect(value)
-      if value.is_a?(String) && value.length > 50
-        "#{value[0..50]}...".inspect
-      elsif value.is_a?(Date) || value.is_a?(Time)
-        %("#{value.to_s(:db)}")
-      else
-        value.inspect
-      end
-    end
-
-    def parse_date?(name)
-      return true if self.class._date_fields.include?(name)
-      return true if !Flexirest::Base.disable_automatic_date_parsing && self.class._date_fields.empty?
-      false
-    end
-
   end
-
-  class NoAttributeException < StandardError ; end
-  class ValidationFailedException < StandardError ; end
-  class MissingOptionalLibraryError < StandardError ; end
 end