logical_model 0.5.4 → 0.5.5

data/VERSION

@@ -1 +1 @@
-0.5.4
+0.5.5

data/lib/logical_model.rb

@@ -4,6 +4,8 @@ require 'typhoeus'
 require 'active_support/all' # todo migrate to yajl
 require 'kaminari'
 
+require 'logical_model/hydra'
+require 'logical_model/responses_configuration'
 require 'logical_model/rest_actions'
 require 'logical_model/url_helper'
 require 'logical_model/safe_log'
@@ -50,6 +52,8 @@ require 'logical_model/attributes'
 #  RemoteResource#destroy
 class LogicalModel
 
+  include LogicalModel::Hydra
+  include LogicalModel::ResponsesConfiguration
   include LogicalModel::Attributes
   include LogicalModel::RESTActions
   include LogicalModel::UrlHelper
@@ -87,18 +91,6 @@ class LogicalModel
     def retries; @retries ||= DEFAULT_RETRIES; end
     def delete_multiple_enabled?; @enable_delete_multiple ||= false; end
 
-    def use_hydra(hydra)
-      self.hydra=(hydra)
-    end
-
-    def hydra
-      @@hydra
-    end
-
-    def hydra=(hydra)
-      @@hydra = hydra
-    end
-
     def validates_associated(*associations)
       associations.each do |association|
         validates_each association do |record, attr, value|

data/lib/logical_model/hydra.rb

@@ -0,0 +1,25 @@
+class LogicalModel
+  module Hydra
+
+    def self.included(base)
+      base.send(:extend, ClassMethods)
+    end
+
+    module ClassMethods
+
+      # Set which Hydra this class should use for calls.
+      # @param hydra [Typhoues::Hydra]
+      def use_hydra(hydra)
+        self.hydra=(hydra)
+      end
+
+      def hydra
+        @@hydra
+      end
+
+      def hydra=(hydra)
+        @@hydra = hydra
+      end
+    end
+  end
+end

data/lib/logical_model/responses_configuration.rb

@@ -0,0 +1,35 @@
+class LogicalModel
+  module ResponsesConfiguration
+
+    def self.included(base)
+      base.send(:extend, ClassMethods)
+    end
+
+    module ClassMethods
+      # By default paginate and all will expect a response in the format:
+      # { collection: [....], total: X }
+      # Where collection contains an array of hashes that initialize the Object and
+      # total contains the total number of elements in result (used for pagination)
+      #
+      # configure_index_response allows to change this defaults.
+      # @example
+      #    configure_index_response {collection: 'items', total: 'count'}
+      #    This will expect response to have format: {items: [...], count: X}
+      #
+      # If collection is nil then array is expected at root and total will be ignored.
+      # If total is nil it will be ignored
+      def configure_index_response(hash_response)
+        @collection_key = hash_response[:collection]
+        @total_key      = hash_response[:total]
+      end
+
+      def collection_key
+        @collection_key ||= 'collection'
+      end
+
+      def total_key
+        @total_key ||= 'total'
+      end
+    end
+  end
+end

data/lib/logical_model/rest_actions.rb

@@ -175,11 +175,48 @@ class LogicalModel
       #  Following methods are API specific.
       #  They assume we are using a RESTfull API.
       #  for get, put, delete :id is expected
-      #  for post, put attributes are excepted under class_name directly. eg. put( {:id => 1, :class_name => {:attr => "new value for attr"}} )
+      #  for post, put attributes are excepted under class_name directly.
+      #    eg. put( {:id => 1, :class_name => {:attr => "new value for attr"}} )
       #
-      #  On error (400) a "errors" is expected.
+      #  On error (400) a "errors" key is expected in response
       #  ============================================================================================================
 
+      # @param options [Hash] will be forwarded to API
+      def async_all(options={})
+        options = self.merge_key(options)
+        request = Typhoeus::Request.new(resource_uri, :params => options)
+        request.on_complete do |response|
+          if response.code >= 200 && response.code < 400
+            log_ok(response)
+
+            result_set = self.from_json(response.body)
+            collection = result_set[:collection]
+
+            yield collection
+          else
+            log_failed(response)
+          end
+        end
+        self.hydra.queue(request)
+      end
+
+      def all(options={})
+        result = nil
+        self.retries.times do
+          begin
+            async_all(options){|i| result = i}
+            Timeout::timeout(self.timeout/1000) do
+              self.hydra.run
+            end
+            break unless result.nil?
+          rescue Timeout::Error
+            self.logger.warn("timeout")
+            result = nil
+          end
+        end
+        result
+      end
+
       # Asynchronic Pagination
       #  This pagination won't block excecution waiting for result, pagination will be enqueued in Objectr#hydra.
       #
@@ -397,14 +434,20 @@ class LogicalModel
   end
 
   ##
-  # Will parse JSON string and initialize classes for all hashes in json_string[collection].
+  # Will parse JSON string and initialize classes for all hashes in json_string[collection_key].
   #
   # @param json_string [JSON String] This JSON should have format: {collection: [...], total: X}
   #
   def self.from_json(json_string)
-    parsed = ActiveSupport::JSON.decode(json_string)
-    collection = parsed["collection"].map{|i|self.new(i)}
-    return { :collection => collection, :total => parsed["total"].to_i }
+    parsed_response = ActiveSupport::JSON.decode(json_string)
+    parsed_collection = collection_key.nil?? parsed_response : parsed_response[collection_key]
+    collection = parsed_collection.map{|i| self.new(i)}
+
+    if total_key
+      {collection: collection, total: parsed_response[total_key].to_i}
+    else
+      { collection: collection }
+    end
   end
 
 end

data/logical_model.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "logical_model"
-  s.version = "0.5.4"
+  s.version = "0.5.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Dwayne Macgowan"]
@@ -36,6 +36,8 @@ Gem::Specification.new do |s|
     "lib/logical_model/attributes.rb",
     "lib/logical_model/belongs_to.rb",
     "lib/logical_model/has_many_keys.rb",
+    "lib/logical_model/hydra.rb",
+    "lib/logical_model/responses_configuration.rb",
     "lib/logical_model/rest_actions.rb",
     "lib/logical_model/safe_log.rb",
     "lib/logical_model/url_helper.rb",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logical_model
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.5.5
   prerelease: 
 platform: ruby
 authors:
@@ -327,6 +327,8 @@ files:
 - lib/logical_model/attributes.rb
 - lib/logical_model/belongs_to.rb
 - lib/logical_model/has_many_keys.rb
+- lib/logical_model/hydra.rb
+- lib/logical_model/responses_configuration.rb
 - lib/logical_model/rest_actions.rb
 - lib/logical_model/safe_log.rb
 - lib/logical_model/url_helper.rb
@@ -352,7 +354,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1027467821
+      hash: 551778145
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: