logical_model 0.1.7 → 0.1.9

data/README.rdoc

@@ -4,6 +4,12 @@ LogicalModel allows to use a restfull resources as models.
 
 It was written following this tutorial: http://www.slideshare.net/ihower/serviceoriented-design-and-implement-with-rails3
 
+== Usage
+
+In your Gemfile:
+
+gem "logical_model"
+
 == Contributing to logical_model
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
@@ -13,6 +19,7 @@ It was written following this tutorial: http://www.slideshare.net/ihower/service
 * Commit and push until you are happy with your contribution
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+* PivotalTracker: https://www.pivotaltracker.com/projects/339595
 
 == Copyright
 

data/VERSION

@@ -1 +1 @@
-0.1.7
+0.1.9

data/lib/logical_model.rb

@@ -1,3 +1,4 @@
+require 'timeout'
 require 'active_model'
 require 'typhoeus'
 require 'active_support' # todo migrate to yajl
@@ -56,13 +57,22 @@ class LogicalModel
     @attribute_keys
   end
 
+  DEFAULT_TIMEOUT = 10000
+
   class << self
-    attr_accessor :host, :hydra, :resource_path, :use_ssl, :use_api_key, :api_key, :api_key_name, :log_path
+    attr_accessor :host, :hydra, :resource_path, :api_key, :api_key_name, :timeout, :use_ssl, :log_path, :use_api_key
+
+    def timeout; @timeout ||= DEFAULT_TIMEOUT; end
+    def use_ssl; @use_ssl ||= false; end
+    def log_path; @log_path ||= "log/logical_model.log"; end
+    def use_api_key; @use_api_key ||= false; end
 
     # host eg: "127.0.0.1:3010"
     # resource_path eg: "/api/v1/people"
   end
 
+
+
   def self.resource_uri(id=nil)
     prefix = (use_ssl)? "https://" : "http://"
     sufix  = (id.nil?)? "" : "/#{id}"
@@ -105,8 +115,11 @@ class LogicalModel
   end
 
   def self.log_failed(response)
-    # error_message = ActiveSupport::JSON.decode(response.body)["message"]
-    error_message = "error"
+    begin
+      error_message = ActiveSupport::JSON.decode(response.body)["message"]
+    rescue => e
+      error_message = "error"
+    end
     msg = "LogicalModel Log: #{response.code} #{response.request.url} in #{response.time}s FAILED: #{error_message}"
     self.logger.warn(msg)
     self.logger.debug("LogicalModel Log RESPONSE: #{response.body}")
@@ -120,8 +133,7 @@ class LogicalModel
     if defined?(Rails)
       Rails.logger
     else
-      path = self.log_path.nil?? "log.log" : self.log_path
-      Logger.new(path)
+      Logger.new(self.log_path)
     end
   end
 
@@ -184,8 +196,13 @@ class LogicalModel
   def self.paginate(options={})
     result = nil
     async_paginate(options){|i| result = i}
-    self.hydra.run
+    Timeout::timeout(self.timeout/1000) do
+      self.hydra.run
+    end
     result
+  rescue Timeout::Error
+    self.logger.warn("timeout")
+    return nil
   end
 
   # Asynchronic Find
@@ -216,8 +233,13 @@ class LogicalModel
   def self.find(id)
     result = nil
     async_find(id){|i| result = i}
-    self.hydra.run
+    Timeout::timeout(self.timeout/1000) do
+      self.hydra.run
+    end
     result
+  rescue Timeout::Error
+    self.logger.warn("timeout")
+    return nil
   end
 
   #
@@ -235,9 +257,12 @@ class LogicalModel
     return false unless valid?
 
     params = self.attributes
-    params = self.merge_key(params)
+    params = self.class.merge_key(params)
 
-    response = Typhoeus::Request.post( self.resource_uri, :params => params )
+    response = nil
+    Timeout::timeout(self.class.timeout/1000) do
+      response = Typhoeus::Request.post( self.class.resource_uri, :params => params, :timeout => self.class.timeout )
+    end
     if response.code == 201
       log_ok(response)
       self.id = ActiveSupport::JSON.decode(response.body)["id"]
@@ -245,9 +270,13 @@ class LogicalModel
       log_failed(response)
       return nil
     end
+  rescue Timeout::Error
+    self.class.logger.warn "timeout"
+    return nil
   end
 
-  # Updates Objects attributes.
+  # Updates Objects attributes, this will only send attributes passed as arguments
+  # 
   #
   # Returns false if Object#valid? is false.
   # Returns updated object if successfull.
@@ -256,14 +285,67 @@ class LogicalModel
   # Usage:
   #   @person.update(params[:person])
   def update(attributes)
+    self.attributes = attributes
+
+    return false unless valid?
+
+    sending_params = attributes
+    sending_params.delete(:id)
+
+    params = { self.class.to_s.underscore => sending_params }
+    params = self.class.merge_key(params)
+
+
+    e = Typhoeus::Easy.new
+    e.url = self.class.resource_uri(id)
+    e.method = :put
+    e.params = params
+
+    response = nil
+    Timeout::timeout(self.class.timeout/1000) do
+      # using Typhoeus::Easy avoids PUT hang issue: https://github.com/dbalatero/typhoeus/issues/69
+      e.perform
+    end
 
+    if e.response_code == 200
+      self.class.logger.info("LogicalModel Log: #{e.response_code} #{e.url} in #{e.total_time_taken}s")
+      self.class.logger.debug("LogicalModel Log RESPONSE: #{e.response_body}")
+      return self
+    else
+      msg = "LogicalModel Log: #{e.response_code} #{e.url} in #{e.total_time_taken}s FAILED"
+      self.logger.warn(msg)
+      self.logger.debug("LogicalModel Log RESPONSE: #{e.response_body}")
+      return nil
+    end
+
+  rescue Timeout::Error
+    self.class.logger.warn("request timed out")
+    return nil
+  end
+
+  # Saves Objects attributes
+  # 
+  #
+  # Returns false if Object#valid? is false.
+  # Returns updated object if successfull.
+  # Returns nil if update failed
+  #
+  # Usage:
+  #   @person.save
+  def save
     self.attributes = attributes
 
     return false unless valid?
 
-    params = { self.class.underscore => self.attributes }
-    params = self.merge_key(params)
-    response = Typhoeus::Request.put( self.resource_uri(id), :params => params )
+    sending_params = self.attributes
+    sending_params.delete(:id)
+
+    params = { self.class.to_s.underscore => sending_params }
+    params = self.class.merge_key(params)
+    response = nil
+    Timeout::timeout(self.class.timeout/1000) do
+      response = Typhoeus::Request.put( self.class.resource_uri(id), :params => params, :timeout => self.class.timeout )
+    end
     if response.code == 200
       log_ok(response)
       return self
@@ -271,6 +353,9 @@ class LogicalModel
       log_failed(response)
       return nil
     end
+  rescue Timeout::Error
+    self.class.logger.warn "timeout"
+    return nil
   end
 
   # Deletes Object#id
@@ -283,7 +368,13 @@ class LogicalModel
 
     params = self.merge_key
 
-    response = Typhoeus::Request.delete( self.resource_uri(id), :params => params )
+    response = nil
+    Timeout::timeout(self.timeout/1000) do
+      response = Typhoeus::Request.delete( self.resource_uri(id),
+                                         :params => params,
+                                         :timeout => self.class.timeout
+                                       )
+    end
     if response == 200
       log_ok(response)
       return self
@@ -291,6 +382,9 @@ class LogicalModel
       log_failed(response)
       return nil
     end
+  rescue Timeout::Error
+    self.logger.warn "timeout"
+    return nil
   end
 
   # Destroy object

data/logical_model.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{logical_model}
-  s.version = "0.1.7"
+  s.version = "0.1.9"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{Dwayne Macgowan}]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logical_model
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.9
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-07-28 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &71817330 !ruby/object:Gem::Requirement
+  requirement: &85591940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *71817330
+  version_requirements: *85591940
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &71816850 !ruby/object:Gem::Requirement
+  requirement: &85591550 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *71816850
+  version_requirements: *85591550
 - !ruby/object:Gem::Dependency
   name: typhoeus
-  requirement: &71816230 !ruby/object:Gem::Requirement
+  requirement: &85591170 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 0.2.4
   type: :runtime
   prerelease: false
-  version_requirements: *71816230
+  version_requirements: *85591170
 - !ruby/object:Gem::Dependency
   name: will_paginate
-  requirement: &71815650 !ruby/object:Gem::Requirement
+  requirement: &85590790 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 3.0.pre2
   type: :runtime
   prerelease: false
-  version_requirements: *71815650
+  version_requirements: *85590790
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &71815190 !ruby/object:Gem::Requirement
+  requirement: &85590460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *71815190
+  version_requirements: *85590460
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &71814930 !ruby/object:Gem::Requirement
+  requirement: &85590100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *71814930
+  version_requirements: *85590100
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &71814010 !ruby/object:Gem::Requirement
+  requirement: &85589200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *71814010
+  version_requirements: *85589200
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &71813650 !ruby/object:Gem::Requirement
+  requirement: &85588130 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,7 +98,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *71813650
+  version_requirements: *85588130
 description: LogicalModel allows to use a resource as a model. It is based on web
   presentation http://www.slideshare.net/ihower/serviceoriented-design-and-implement-with-rails3
 email: dwaynemac@gmail.com
@@ -134,7 +134,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 482849903
+      hash: -590611747
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: