logical_model 0.2.10 → 0.2.11

data/README.rdoc

@@ -62,7 +62,7 @@ the database. We could change this by deleting all users in the test setup.
 
 To run spec:
 
-    bundle exec rspec spec/client_spec.rb
+    bundle exec rspec spec/client_spec.rb --color
 
 
 == Contributing to logical_model

data/VERSION

@@ -1 +1 @@
-0.2.10
+0.2.11

data/lib/logical_model.rb

@@ -62,12 +62,15 @@ class LogicalModel
   DEFAULT_TIMEOUT = 10000
 
   class << self
-    attr_accessor :host, :hydra, :resource_path, :api_key, :api_key_name, :timeout, :use_ssl, :log_path, :use_api_key, :json_root
+    attr_accessor :host, :hydra, :resource_path, :api_key, :api_key_name, :timeout,
+                  :use_ssl, :use_api_key, :enable_delete_multiple,
+                  :json_root, :log_path
 
     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
+    def delete_multiple_enabled?; @enable_delete_multiple ||= false; end
 
     def validates_associated(*associations)
       associations.each do |association|
@@ -249,8 +252,8 @@ class LogicalModel
   # Usage:
   #   Person.async_paginate(:page => params[:page]){|i| result = i}
   def self.async_paginate(options={})
-    page = options[:page] || 1
-    per_page = options[:per_page] || 20
+    options[:page] ||= 1
+    options[:per_page] ||= 20
 
     options = self.merge_key(options)
 
@@ -266,8 +269,8 @@ class LogicalModel
                                              result_set[:collection],
                                              {
                                                :total_count=>result_set[:total],
-                                               :limit => per_page,
-                                               :offset => per_page * ([page, 1].max - 1)
+                                               :limit => options[:per_page],
+                                               :offset => options[:per_page] * ([options[:page], 1].max - 1)
                                              }
                                             )
 
@@ -292,6 +295,52 @@ class LogicalModel
     return nil
   end
 
+  # Asynchronic Count
+  #  This count won't block excecution waiting for result, count will be enqueued in Objectr#hydra.
+  #
+  # Parameters:
+  #   @param options [Hash].
+  #   Valid options are:
+  #   @option options [Integer] :page - indicated what page to return. Defaults to 1.
+  #   @option options [Integer] :per_page - indicates how many records to be returned per page. Defauls to 20
+  #   @option options [Hash] all other options will be forwarded in :params to WebService
+  #
+  # @example 'Count bobs'
+  #   Person.async_count(:when => {:name => 'bob'}}){|i| result = i}
+  def self.async_count(options={})
+    options[:page] = 1
+    options[:per_page] = 1
+
+    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)
+
+        yield result_set[:total]
+      else
+        log_failed(response)
+      end
+    end
+    self.hydra.queue(request)
+  end
+
+  # synchronic count
+  def self.count(options={})
+    result = nil
+    async_count(options){|i| result = i}
+    Timeout::timeout(self.timeout/1000) do
+      self.hydra.run
+    end
+    result
+  rescue Timeout::Error
+    self.logger.warn("timeout")
+    return nil
+  end
+
   # Asynchronic Find
   #  This find won't block excecution waiting for result, excecution will be enqueued in Objectr#hydra.
   #
@@ -471,7 +520,7 @@ class LogicalModel
                                          :timeout => self.timeout
                                        )
     end
-    if response == 200
+    if response.code == 200
       log_ok(response)
       return self
     else
@@ -491,10 +540,47 @@ class LogicalModel
     self.class.delete(self.id,params)
   end
 
+  # Deletes all Objects matching given ids
+  #
+  # This method will make a DELETE request to resource_uri/destroy_multiple
+  #
+  # Returns nil if delete failed
+  #
+  # @param [Array] ids - ids of contacts to be deleted
+  # @param [Hash] params - other params to be sent to WS on request
+  #
+  # Usage:
+  #   Person.delete_multiple([1,2,4,5,6])
+  def self.delete_multiple(ids, params={})
+    raise "not-enabled" unless self.delete_multiple_enabled?
+
+    params = self.merge_key(params)
+    params = params.merge({:ids => ids})
+
+    response = nil
+    Timeout::timeout(self.timeout/1000) do
+      response = Typhoeus::Request.delete( self.resource_uri+"/destroy_multiple",
+                                           :params => params,
+                                           :timeout => self.timeout
+      )
+    end
+    if response.code == 200
+      log_ok(response)
+      return self
+    else
+      log_failed(response)
+      return nil
+    end
+  rescue Timeout::Error
+    self.logger.warn "timeout"
+    return nil
+  end
+
   def persisted?
     false
   end
 
+
   # Returns true if a record has not been persisted yet.
   #
   # Usage:

data/logical_model.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "logical_model"
-  s.version = "0.2.10"
+  s.version = "0.2.11"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Dwayne Macgowan"]
-  s.date = "2012-01-09"
+  s.date = "2012-01-17"
   s.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"
   s.email = "dwaynemac@gmail.com"
   s.extra_rdoc_files = [

data/spec/client_spec.rb

@@ -1,5 +1,8 @@
 require File.dirname(__FILE__) + '/../client'
 
+require File.dirname(__FILE__) + '/../test/typhoeus_mocks.rb'
+include TyphoeusMocks
+
 # NOTE: to run these specs you must have the service running locally. Do like this:
 # ruby service.rb -p 3000 -e test
 
@@ -10,6 +13,7 @@ describe "LogicalModel User client" do
   describe "#create" do
     context "with valid attributes" do
       before(:each) do
+        # TODO mock service
         @user = User.new({:name => "paul", 
                           :email => "paul@pauldix.net", 
                           :password => "strongpass", 
@@ -31,21 +35,12 @@ describe "LogicalModel User client" do
 
   describe "#paginate" do
     before do
-      # --> Mock service
-      req = Typhoeus::Request.any_instance
-      response = mock(
-        code: 200,
-        body: {
-          collection: [{name:'a',email:'a@m'},
-                       {name:'b',email:'b@m'},
-                       {name:'c',email:'c@m'}],
-          total: 6
-        }.to_json,
-        request: mock(url:"mockedurl"),
-        time: 1234
+      mock_index(
+        collection: [{name:'a',email:'a@m'},
+                     {name:'b',email:'b@m'},
+                     {name:'c',email:'c@m'}],
+        total: 6
       )
-      req.stub(:on_complete).and_yield(response)
-      # <-- service mocked
 
       @users = User.paginate(page:1, per_page:1)
     end
@@ -56,7 +51,44 @@ describe "LogicalModel User client" do
       @users.total_count.should == 6
     end
   end
-  
+
+  describe "#count" do
+    before do
+      mock_index(
+        total: 6
+      )
+    end
+    let(:count){User.count}
+    it "should return a Integer" do
+      count.should be_a(Integer)
+    end
+    it "should return total amount of users" do
+      count.should == 6
+    end
+  end
+
+  describe "#find" do
+    context "if found" do
+      before do
+        mock_show(
+          attributes: {
+            id: 1,
+            name: 'mocked-username',
+            email: 'mocked@mail',
+            password: '1234',
+            bio: 'asdfasdf'
+          }
+        )
+
+        @user = User.find(1)
+      end
+      it "should set attributes" do
+        @user.id.should == 1
+        @user.email.should == "mocked@mail"
+      end
+    end
+  end
+
   describe "#https" do
     context "when use_ssl is tue" do
       before(:each) do
@@ -76,4 +108,50 @@ describe "LogicalModel User client" do
       end
     end
   end
+
+  describe "delete_multiple" do
+    before do
+      Typhoeus::Request.stub!(:delete).and_return(mock_response(body: 'ok'))
+    end
+    context "when disabled" do
+      it "should raise exception" do
+        class User < LogicalModel; self.enable_delete_multiple = false; end
+        expect{User.delete_multiple([1,2,4,5])}.to raise_error
+      end
+    end
+    context "when enabled" do
+      it "should raise exception" do
+        class User < LogicalModel; self.enable_delete_multiple = true; end
+        expect{User.delete_multiple([1,2,4,5])}.not_to raise_error
+      end
+    end
+  end
+
+  describe "#delete_multiple_enabled?" do
+    context "with config: 'enable_multiple_delete = true'" do
+      before do
+        class User < LogicalModel
+          self.enable_delete_multiple = true
+        end
+      end
+      it "should return true" do
+        User.delete_multiple_enabled?.should be_true
+      end
+    end
+    context "with config: 'enable_delete_multiple = false'" do
+        it "should return false" do
+        class User < LogicalModel
+          self.enable_delete_multiple = false
+        end
+        User.delete_multiple_enabled?.should be_false
+      end
+    end
+    context "without config" do
+      it "should default to false" do
+        class AnotherClass < LogicalModel
+        end
+        AnotherClass.delete_multiple_enabled?.should be_false
+      end
+    end
+  end
 end

data/test/typhoeus_mocks.rb

@@ -1,5 +1,43 @@
 module TyphoeusMocks
 
+  # This stubs response of GET /resource
+  #
+  # @param [Hash] options
+  # @option options [Array<Hash>] :collection
+  # @option options [Integer] :total
+  # @option options [String] :url
+  # @option options [Integer] :status - HTTP status
+  def mock_index(options={})
+    req = Typhoeus::Request.any_instance
+    response = mock(
+      code: options[:status] || 200,
+      body: {
+        collection: options[:collection] || [],
+        total: options[:total] || 0
+      }.to_json,
+      request: mock(url: options[:url] || "mockedurl"),
+      time: 1234
+    )
+    req.stub(:on_complete).and_yield(response)
+  end
+
+  # This stubs response of GET /resource/:id
+  #
+  # @param [Hash] options
+  # @option options [Array<Hash>] :attributes
+  # @option options [String] :url
+  # @option options [Integer] :status - HTTP status
+  def mock_show(options={})
+    req = Typhoeus::Request.any_instance
+    response = mock(
+      code: options[:status] || 200,
+      body: options[:attributes].to_json,
+      request: mock(url: options[:url] || "mockedurl"),
+      time: 1234
+    )
+    req.stub(:on_complete).and_yield(response)
+  end
+
   # Mocks a Typhoeus::Response
   # @param [Hash] options
   # @option [Integer] code - http response code. default: 200

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logical_model
 version: !ruby/object:Gem::Version
-  version: 0.2.10
+  version: 0.2.11
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-09 00:00:00.000000000Z
+date: 2012-01-17 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &78627270 !ruby/object:Gem::Requirement
+  requirement: &79777970 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *78627270
+  version_requirements: *79777970
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &78626410 !ruby/object:Gem::Requirement
+  requirement: &79777350 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *78626410
+  version_requirements: *79777350
 - !ruby/object:Gem::Dependency
   name: typhoeus
-  requirement: &78624510 !ruby/object:Gem::Requirement
+  requirement: &79776880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 0.2.4
   type: :runtime
   prerelease: false
-  version_requirements: *78624510
+  version_requirements: *79776880
 - !ruby/object:Gem::Dependency
   name: kaminari
-  requirement: &78623980 !ruby/object:Gem::Requirement
+  requirement: &79776350 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 0.13.0
   type: :runtime
   prerelease: false
-  version_requirements: *78623980
+  version_requirements: *79776350
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &78623670 !ruby/object:Gem::Requirement
+  requirement: &79775710 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *78623670
+  version_requirements: *79775710
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &78623310 !ruby/object:Gem::Requirement
+  requirement: &79774980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *78623310
+  version_requirements: *79774980
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &78622890 !ruby/object:Gem::Requirement
+  requirement: &79774320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: 1.0.10
   type: :development
   prerelease: false
-  version_requirements: *78622890
+  version_requirements: *79774320
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &78622410 !ruby/object:Gem::Requirement
+  requirement: &79773570 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,10 +98,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *78622410
+  version_requirements: *79773570
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &78621770 !ruby/object:Gem::Requirement
+  requirement: &79772870 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *78621770
+  version_requirements: *79772870
 - !ruby/object:Gem::Dependency
   name: sqlite3-ruby
-  requirement: &78621440 !ruby/object:Gem::Requirement
+  requirement: &79743610 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +120,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *78621440
+  version_requirements: *79743610
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &78621020 !ruby/object:Gem::Requirement
+  requirement: &79742900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -131,10 +131,10 @@ dependencies:
         version: 1.2.6
   type: :development
   prerelease: false
-  version_requirements: *78621020
+  version_requirements: *79742900
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &78599190 !ruby/object:Gem::Requirement
+  requirement: &79741620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -142,10 +142,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *78599190
+  version_requirements: *79741620
 - !ruby/object:Gem::Dependency
   name: rspec-rails
-  requirement: &78598610 !ruby/object:Gem::Requirement
+  requirement: &79740370 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -153,10 +153,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *78598610
+  version_requirements: *79740370
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &78598040 !ruby/object:Gem::Requirement
+  requirement: &79739390 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -164,10 +164,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *78598040
+  version_requirements: *79739390
 - !ruby/object:Gem::Dependency
   name: rb-inotify
-  requirement: &78597410 !ruby/object:Gem::Requirement
+  requirement: &79738470 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -175,10 +175,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *78597410
+  version_requirements: *79738470
 - !ruby/object:Gem::Dependency
   name: libnotify
-  requirement: &78596950 !ruby/object:Gem::Requirement
+  requirement: &79737780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -186,7 +186,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *78596950
+  version_requirements: *79737780
 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
@@ -234,7 +234,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -162919699
+      hash: 788754387
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: