smooth_operator 0.4.4 → 1.2.0

data/spec/smooth_operator/remote_call_spec.rb

@@ -0,0 +1,320 @@
+require "spec_helper"
+
+describe SmoothOperator::RemoteCall do
+  subject { UserWithAddressAndPosts::Son.new(attributes_for(:user_with_address_and_posts)) }
+
+  context "when the server response has a http code in the 200 range" do
+    before { subject.save(nil, { status: 200 }) }
+
+    it "#ok? should return true" do
+      expect(subject.last_remote_call.ok?).to be true
+    end
+
+    it "#not_processed? should return false" do
+      expect(subject.last_remote_call.not_processed?).to be false
+    end
+
+    it "#client_error? should return false" do
+      expect(subject.last_remote_call.client_error?).to be false
+    end
+
+    it "#server_error? should return false" do
+      expect(subject.last_remote_call.server_error?).to be false
+    end
+
+    it "#error? should return false" do
+      expect(subject.last_remote_call.error?).to be false
+    end
+
+    it "#not_found? should return false" do
+      expect(subject.last_remote_call.not_found?).to be false
+    end
+
+    it "#timeout? should return false" do
+      expect(subject.last_remote_call.timeout?).to be false
+    end
+
+    it "#connection_failed? should return false" do
+      expect(subject.last_remote_call.connection_failed?).to be false
+    end
+
+    it "#status should return true" do
+      expect(subject.last_remote_call.status).to be true
+    end
+  end
+
+  context "when the server response has a http code in the 400 range (not 422, 404)" do
+    before { subject.save(nil, { status: 400 }) }
+
+    it "#ok? should return false" do
+      expect(subject.last_remote_call.ok?).to be false
+    end
+
+    it "#not_processed? should return false" do
+      expect(subject.last_remote_call.not_processed?).to be false
+    end
+
+    it "#client_error? should return true" do
+      expect(subject.last_remote_call.client_error?).to be true
+    end
+
+    it "#server_error? should return false" do
+      expect(subject.last_remote_call.server_error?).to be false
+    end
+
+    it "#error? should return true" do
+      expect(subject.last_remote_call.error?).to be true
+    end
+
+    it "#not_found? should return false" do
+      expect(subject.last_remote_call.not_found?).to be false
+    end
+
+    it "#timeout? should return false" do
+      expect(subject.last_remote_call.timeout?).to be false
+    end
+
+    it "#connection_failed? should return false" do
+      expect(subject.last_remote_call.connection_failed?).to be false
+    end
+
+    it "#status should return nil" do
+      expect(subject.last_remote_call.status).to be nil
+    end
+  end
+
+  context "when the server response has a http is 404" do
+    before { subject.save(nil, { status: 404 }) }
+
+    it "#ok? should return false" do
+      expect(subject.last_remote_call.ok?).to be false
+    end
+
+    it "#not_processed? should return false" do
+      expect(subject.last_remote_call.not_processed?).to be false
+    end
+
+    it "#client_error? should return true" do
+      expect(subject.last_remote_call.client_error?).to be true
+    end
+
+    it "#server_error? should return false" do
+      expect(subject.last_remote_call.server_error?).to be false
+    end
+
+    it "#error? should return true" do
+      expect(subject.last_remote_call.error?).to be true
+    end
+
+    it "#not_found? should return true" do
+      expect(subject.last_remote_call.not_found?).to be true
+    end
+
+    it "#timeout? should return false" do
+      expect(subject.last_remote_call.timeout?).to be false
+    end
+
+    it "#connection_failed? should return false" do
+      expect(subject.last_remote_call.connection_failed?).to be false
+    end
+
+    it "#status should return nil" do
+      expect(subject.last_remote_call.status).to be nil
+    end
+  end
+
+  context "when the server response has a http is 422" do
+    before { subject.save(nil, { status: 422 }) }
+
+    it "#ok? should return false" do
+      expect(subject.last_remote_call.ok?).to be false
+    end
+
+    it "#not_processed? should return true" do
+      expect(subject.last_remote_call.not_processed?).to be true
+    end
+
+    it "#client_error? should return true" do
+      expect(subject.last_remote_call.client_error?).to be true
+    end
+
+    it "#server_error? should return false" do
+      expect(subject.last_remote_call.server_error?).to be false
+    end
+
+    it "#error? should return false" do
+      expect(subject.last_remote_call.error?).to be false
+    end
+
+    it "#not_found? should return false" do
+      expect(subject.last_remote_call.not_found?).to be false
+    end
+
+    it "#timeout? should return false" do
+      expect(subject.last_remote_call.timeout?).to be false
+    end
+
+    it "#connection_failed? should return false" do
+      expect(subject.last_remote_call.connection_failed?).to be false
+    end
+
+    it "#status should return false" do
+      expect(subject.last_remote_call.status).to be false
+    end
+  end
+
+  context "when the server response has a http code in the 500 range" do
+    before { subject.save(nil, { status: 500 }) }
+
+    it "#ok? should return false" do
+      expect(subject.last_remote_call.ok?).to be false
+    end
+
+    it "#not_processed? should return false" do
+      expect(subject.last_remote_call.not_processed?).to be false
+    end
+
+    it "#client_error? should return false" do
+      expect(subject.last_remote_call.client_error?).to be false
+    end
+
+    it "#server_error? should return true" do
+      expect(subject.last_remote_call.server_error?).to be true
+    end
+
+    it "#error? should return true" do
+      expect(subject.last_remote_call.error?).to be true
+    end
+
+    it "#not_found? should return false" do
+      expect(subject.last_remote_call.not_found?).to be false
+    end
+
+    it "#timeout? should return false" do
+      expect(subject.last_remote_call.timeout?).to be false
+    end
+
+    it "#connection_failed? should return false" do
+      expect(subject.last_remote_call.connection_failed?).to be false
+    end
+
+    it "#status should return nil" do
+      expect(subject.last_remote_call.status).to be nil
+    end
+  end
+
+  context "when the connection is broken" do
+    subject { User::BrokenConnection.new }
+
+    before { subject.save }
+
+    it "#ok? should return false" do
+      expect(subject.last_remote_call.ok?).to be false
+    end
+
+    it "#not_processed? should return false" do
+      expect(subject.last_remote_call.not_processed?).to be false
+    end
+
+    it "#client_error? should return false" do
+      expect(subject.last_remote_call.client_error?).to be false
+    end
+
+    it "#server_error? should return true" do
+      expect(subject.last_remote_call.server_error?).to be true
+    end
+
+    it "#error? should return true" do
+      expect(subject.last_remote_call.error?).to be true
+    end
+
+    it "#not_found? should return false" do
+      expect(subject.last_remote_call.not_found?).to be false
+    end
+
+    it "#timeout? should return false" do
+      expect(subject.last_remote_call.timeout?).to be false
+    end
+
+    it "#connection_failed? should return true" do
+      expect(subject.last_remote_call.connection_failed?).to be true
+    end
+
+    it "#status should return nil" do
+      expect(subject.last_remote_call.status).to be nil
+    end
+  end
+
+  context "when the connection exceeds the timeout" do
+    subject { User::TimeoutConnection.new }
+    
+    before { subject.save('/timeout') }
+
+    it "#ok? should return false" do
+      expect(subject.last_remote_call.ok?).to be false
+    end
+
+    it "#not_processed? should return false" do
+      expect(subject.last_remote_call.not_processed?).to be false
+    end
+
+    it "#client_error? should return false" do
+      expect(subject.last_remote_call.client_error?).to be false
+    end
+
+    it "#server_error? should return true" do
+      expect(subject.last_remote_call.server_error?).to be true
+    end
+
+    it "#error? should return true" do
+      expect(subject.last_remote_call.error?).to be true
+    end
+
+    it "#not_found? should return false" do
+      expect(subject.last_remote_call.not_found?).to be false
+    end
+
+    it "#timeout? should return true" do
+      expect(subject.last_remote_call.timeout?).to be true
+    end
+
+    it "#connection_failed? should return false" do
+      expect(subject.last_remote_call.connection_failed?).to be false
+    end
+
+    it "#status should return nil" do
+      expect(subject.last_remote_call.status).to be nil
+    end
+  end
+
+  describe "#parsed_response" do
+    context "when the server response's body does not contains valid json data" do
+      let(:remote_call) { User::Base.find('bad_json') }
+
+      it "should return nil" do
+        expect(remote_call.data).to be nil
+      end
+    end
+  end
+
+  describe "#http_status" do
+    context "when a server connection is established" do
+      before { subject.save(nil, { status: 422 }) }
+
+      it "it should return the server's http response code" do
+        expect(subject.last_remote_call.http_status).to be 422
+      end
+    end
+
+    context "when a server connection fails" do
+      subject { User::TimeoutConnection.new }
+    
+      before { subject.save('/timeout') }
+
+      it "should return 0" do
+        expect(subject.last_remote_call.http_status).to be 0
+      end
+    end
+  end
+
+end

data/spec/smooth_operator/serialization_spec.rb

@@ -0,0 +1,80 @@
+require "spec_helper"
+
+describe SmoothOperator::Serialization do
+
+  describe "#attributes" do
+    subject { UserWithAddressAndPosts::Son.new(attributes_for(:user_with_address_and_posts)) }
+
+    context "when there are changes to nested objects" do
+      before { subject.address.street = 'new street' }
+
+      it "should refect those changes" do
+        new_attributes = attributes_for(:user_with_address_and_posts)
+        new_attributes[:address][:street] = 'new street'
+        
+        expect(subject.attributes).to eq(new_attributes)
+      end
+    end
+  end
+
+  describe "#to_hash" do
+    subject { UserWithAddressAndPosts::Son.new(attributes_for(:user_with_address_and_posts)) }
+
+    it 'it should call #serializable_hash with the same arguments' do
+      options = { option1: 'option1', option2: 'option2' }
+
+      expect(subject).to receive(:serializable_hash).with(options)
+
+      subject.to_hash(options)
+    end
+  end
+
+  describe "#to_json" do
+    subject { UserWithAddressAndPosts::Son.new(attributes_for(:user_with_address_and_posts)) }
+
+    it 'it should call #serializable_hash with the same arguments' do
+      options = { option1: 'option1', option2: 'option2' }
+
+      expect(subject).to receive(:serializable_hash).with(options)
+
+      subject.to_json(options)
+    end
+  end
+
+  describe "#serializable_hash" do
+    subject { UserWithAddressAndPosts::Son.new(attributes_for(:user_with_address_and_posts)) }
+
+    context "when no options are given" do
+      it 'it should return all attributes' do
+        expect(subject.serializable_hash).to eq(SmoothOperator::Helpers.stringify_keys(attributes_for(:user_with_address_and_posts)))
+      end
+    end
+
+    context "when option 'only' is introduced" do
+      let(:options_with_only) { { only: [:id, :first_name] } }
+
+      it 'it should only return the filtered options' do
+        expect(subject.serializable_hash(options_with_only)).to eq(SmoothOperator::Helpers.stringify_keys(attributes_for(:white_list)))
+      end
+    end
+
+    context "when option 'except' is introduced" do
+      let(:options_with_except) { { except: [:last_name, :admin] } }
+
+      it 'it should return all fields except for the filtered options' do
+        expect(subject.serializable_hash(options_with_except)).not_to include(attributes_for(:black_list))
+      end
+    end
+
+    context "when option 'methods' is introduced" do
+      let(:options_with_method) { { methods: :my_method } }
+      subject(:user_with_my_method) { UserWithAddressAndPosts::UserWithMyMethod.new(attributes_for(:user_with_address_and_posts)) }
+
+      it 'it should return all fields including the expected method and its returning value' do
+        expect(user_with_my_method.serializable_hash(options_with_method)).to eq(SmoothOperator::Helpers.stringify_keys(attributes_for(:user_with_my_method)))
+      end
+    end
+
+  end
+
+end

data/spec/smooth_operator/validations_spec.rb

@@ -0,0 +1,42 @@
+require "spec_helper"
+
+describe SmoothOperator::Validations do
+  subject { User::Base.new(attributes_for(:user)) }
+
+  describe "#valid?" do
+    context "when executing a persistence method, and the server response has a hash with the key 'errors'" do
+      before { subject.save('send_error') }
+
+      it "it should return false" do
+        expect(subject.valid?).to be false
+      end
+    end
+
+    context "when executing a persistence method, and the server response does NOT have a hash with the key 'errors'" do
+      before { subject.save }
+
+      it "it should return true" do
+        expect(subject.valid?).to be true
+      end
+    end
+  end
+
+  describe "#invalid?" do
+    context "when executing a persistence method, and the server response has a hash with the key 'errors'" do
+      before { subject.save('send_error') }
+
+      it "it should return true" do
+        expect(subject.invalid?).to be true
+      end
+    end
+
+    context "when executing a persistence method, and the server response does NOT have a hash with the key 'errors'" do
+      before { subject.save }
+
+      it "it should return false" do
+        expect(subject.invalid?).to be false
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+require 'simplecov'
+
+SimpleCov.start do
+  root('lib/')
+  project_name('SmoothOperator')
+  coverage_dir('../tmp/coverage/')
+end
+
+require 'require_helper'
+
+FactoryGirl.find_definitions
+
+RSpec.configure do |config|
+
+  config.include FactoryGirl::Syntax::Methods
+
+  config.include PersistenceHelper, helpers: :persistence
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  LocalhostServer.new(TestServer.new, 4567)
+
+end

data/spec/support/helpers/persistence_helper.rb

@@ -0,0 +1,38 @@
+module PersistenceHelper
+
+  def subject_class
+    UserWithAddressAndPosts::Son
+  end
+
+  def new_user
+    attributes = attributes_for(:user_with_address_and_posts)
+    attributes.delete(:id)
+
+    subject_class.new attributes
+  end
+
+  def existing_user
+    subject_class.new(attributes_for(:user_with_address_and_posts))
+  end
+
+  def existing_user_with_patch
+    UserWithAddressAndPosts::WithPatch.new(attributes_for(:user_with_address_and_posts))
+  end
+
+  def created_subject
+    @created_subject
+  end
+
+  def execute_method
+    if method_to_execute.to_s =~ /create/
+      attributes = attributes_for(:user_with_address_and_posts)
+      
+      attributes.delete(:id) if method_to_execute == :create_without_id
+
+      @created_subject = subject_class.create(attributes, *method_arguments)
+    else
+      subject.send(method_to_execute, *method_arguments)
+    end
+  end
+
+end

data/spec/support/localhost_server.rb

@@ -0,0 +1,97 @@
+# THIS FILE CODE BELONGS TO "typhoeus gem"
+#   https://github.com/typhoeus/typhoeus/blob/master/spec/support/localhost_server.rb
+
+require 'rack'
+require 'rack/handler/webrick'
+require 'net/http'
+
+# The code for this is inspired by Capybara's server:
+#   http://github.com/jnicklas/capybara/blob/0.3.9/lib/capybara/server.rb
+class LocalhostServer
+  READY_MESSAGE = "Server ready"
+
+  class Identify
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      if env["PATH_INFO"] == "/__identify__"
+        [200, {}, [LocalhostServer::READY_MESSAGE]]
+      else
+        @app.call(env)
+      end
+    end
+  end
+
+  attr_reader :port
+
+  def initialize(rack_app, port = nil)
+    @port = port || find_available_port
+    @rack_app = rack_app
+    concurrently { boot }
+    wait_until(10, "Boot failed.") { booted? }
+  end
+
+  private
+
+  def find_available_port
+    server = TCPServer.new('127.0.0.1', 0)
+    server.addr[1]
+  ensure
+    server.close if server
+  end
+
+  def boot
+    # Use WEBrick since it's part of the ruby standard library and is available on all ruby interpreters.
+    options = { :Port => port }
+    options.merge!(:AccessLog => [], :Logger => WEBrick::BasicLog.new(StringIO.new)) unless ENV['VERBOSE_SERVER']
+    Rack::Handler::WEBrick.run(Identify.new(@rack_app), options)
+  end
+
+  def booted?
+    res = ::Net::HTTP.get_response("localhost", '/__identify__', port)
+    if res.is_a?(::Net::HTTPSuccess) or res.is_a?(::Net::HTTPRedirection)
+      return res.body == READY_MESSAGE
+    end
+  rescue Errno::ECONNREFUSED, Errno::EBADF
+    return false
+  end
+
+  def concurrently
+    if should_use_subprocess?
+      pid = Process.fork do
+        trap(:INT) { ::Rack::Handler::WEBrick.shutdown }
+        yield
+        exit # manually exit; otherwise this sub-process will re-run the specs that haven't run yet.
+      end
+
+      at_exit do
+        Process.kill('INT', pid)
+        begin
+          Process.wait(pid)
+        rescue Errno::ECHILD
+          # ignore this error...I think it means the child process has already exited.
+        end
+      end
+    else
+      Thread.new { yield }
+    end
+  end
+
+  def should_use_subprocess?
+    # !ENV['THREADED']
+    false
+  end
+
+  def wait_until(timeout, error_message, &block)
+    start_time = Time.now
+
+    while true
+      return if yield
+      raise TimeoutError.new(error_message) if (Time.now - start_time) > timeout
+      sleep(0.05)
+    end
+  end
+end
+

data/spec/support/models/address.rb

@@ -0,0 +1,14 @@
+class Address < SmoothOperator::Base
+
+  self.dirty_attributes
+
+  self.resource_name = ''
+
+  self.endpoint_user = 'admin'
+  self.endpoint_pass = 'admin'
+
+  self.endpoint = 'http://localhost:4567/'
+
+  self.headers = { "X-APPTOKEN" => "joaquim_app_token", "X-LAYERTOKEN" => "joaquim_layer_token" }
+  
+end

data/spec/support/models/comment.rb

@@ -0,0 +1,3 @@
+class Comment < SmoothOperator::Base
+
+end

data/spec/support/models/post.rb

@@ -0,0 +1,13 @@
+class Post < SmoothOperator::Base
+
+  self.endpoint_user = 'admin'
+
+  self.endpoint_pass = 'admin'
+
+  self.endpoint = 'http://localhost:4567/'
+
+  has_many :comments
+
+  belongs_to :address
+
+end

data/spec/support/models/user.rb

@@ -0,0 +1,41 @@
+module User
+  
+  class Base < SmoothOperator::Base
+
+    self.resource_name = 'user'
+
+    self.endpoint_user = 'admin'
+
+    self.endpoint_pass = 'admin'
+
+    self.endpoint = 'http://localhost:4567/'
+
+    def self.query_string(params)
+      params['query_string_param'] = true
+
+      params
+    end
+
+  end
+
+  module UnknownHashClass
+    
+    class OpenStructBase < User::Base
+      self.unknown_hash_class = SmoothOperator::OpenStruct::Base
+    end
+
+    class None < User::Base
+      self.unknown_hash_class = :none
+    end
+
+  end
+
+  class BrokenConnection < SmoothOperator::Base
+    self.endpoint = 'http://localhost:1234/'
+  end
+
+  class TimeoutConnection < Base
+    self.timeout = 1
+  end
+
+end