activeresource-persistent 0.0.1 → 0.1.0

data/Gemfile

@@ -1,3 +1,16 @@
 source 'https://rubygems.org'
 
 gemspec
+
+gem 'activeresource', '3.2.3'
+gem 'net-http-persistent', '2.6'
+
+group :test do
+  gem 'rspec', '2.8.0'
+  gem 'sinatra', '1.3.2'
+  gem 'posix-spawn', '0.3.6'
+end
+
+group :bundle do
+  gem 'passenger', '3.0.12'
+end

data/README.md

@@ -6,7 +6,7 @@ HTTP persistent connection support for ActiveResource.
 
 Add this line to your application's Gemfile:
 
-    gem 'active_resource-persistent', :require => 'active_resource/persistent'
+    gem 'activeresource-persistent', :require => 'active_resource/persistent'
 
 And then execute:
 
@@ -14,7 +14,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install active_resource-persistent
+    $ gem install activeresource-persistent
 
 ## Usage
 

data/activeresource-persistent.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = "activeresource-persistent"
   gem.require_paths = ["lib"]
-  gem.version       = "0.0.1"
+  gem.version       = "0.1.0"
 
   gem.add_runtime_dependency 'net-http-persistent', '>=2.5'
   gem.add_runtime_dependency 'activeresource', '>=2.3.0'

data/config.ru

@@ -0,0 +1,2 @@
+Dir["spec/support/**/*.rb"].each { |f| load f }
+run TestApplication.new

data/lib/active_resource/persistent/connection.rb

@@ -5,8 +5,11 @@ module ActiveResource
 
     protected
 
-    def new_http
+    def new_http_with_persistent
       ActiveResource::Persistent::HTTP.new(site, proxy)
     end
+
+    alias_method :new_http_without_persistent, :new_http
+    alias_method :new_http, :new_http_with_persistent
   end
 end

data/lib/active_resource/persistent/http.rb

@@ -8,6 +8,8 @@ module ActiveResource
         @site = site
       end
 
+      attr_reader :site
+
       def get(path, headers)
         req = Net::HTTP::Get.new(path, headers)
         request(@site, req)

data/spec/active_resource/connection_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+describe ActiveResource::Connection do
+  let(:site) { TestServer.uri }
+
+  let(:instance) { described_class.new(site) }
+  
+  describe "#http" do
+    subject { instance.send(:http) }
+    it "should be persistent" do
+      subject.should be_instance_of(ActiveResource::Persistent::HTTP)
+      subject.site.should == site
+    end
+  end
+
+  describe "#new_http" do
+    specify { instance.send(:new_http).should be_instance_of(ActiveResource::Persistent::HTTP) }
+  end
+
+  describe "#new_http_with_persistent" do
+    specify { instance.send(:new_http_with_persistent).should be_instance_of(ActiveResource::Persistent::HTTP) }
+  end
+
+  describe "#new_http_without_persistent" do
+    specify { instance.send(:new_http_without_persistent).should be_instance_of(Net::HTTP) }
+  end
+
+  context "request methods" do
+    let(:path) { '/inspect' }
+    let(:body) { 'HELLO WORLD' }
+    let(:headers) { { 'X_Header' => 'x_value' } }
+    let(:http_mock) { mock('HTTP MOCK') }
+    let(:response_mock) { mock('RESPONSE MOCK', :code => '200') }
+
+    describe "#head" do
+      it "should use ActiveResource::Persistent::HTTP#head" do
+        expected_headers = headers.update('Accept' => 'application/json')
+        instance.should_receive(:http).and_return(http_mock)
+        http_mock.should_receive(:head).with(path, expected_headers).and_return(response_mock)
+
+        instance.head(path, headers)
+      end
+    end
+
+    describe "#get" do
+      it "should use ActiveResource::Persistent::HTTP#get" do
+        expected_headers = headers.update('Accept' => 'application/json')
+        instance.should_receive(:http).and_return(http_mock)
+        http_mock.should_receive(:get).with(path, expected_headers).and_return(response_mock)
+
+        instance.get(path, headers)
+      end
+    end
+
+    describe "#delete" do
+      it "should use ActiveResource::Persistent::HTTP#delete" do
+        expected_headers = headers.update('Accept' => 'application/json')
+        instance.should_receive(:http).and_return(http_mock)
+        http_mock.should_receive(:delete).with(path, expected_headers).and_return(response_mock)
+
+        instance.delete(path, headers)
+      end
+    end
+
+    describe "#post" do
+      it "should use ActiveResource::Persistent::HTTP#post" do
+        expected_headers = headers.update('Content-Type' => 'application/json')
+        instance.should_receive(:http).and_return(http_mock)
+        http_mock.should_receive(:post).with(path, body, expected_headers).and_return(response_mock)
+
+        instance.post(path, body, headers)
+      end
+    end
+
+    describe "#put" do
+      it "should use ActiveResource::Persistent::HTTP#put" do
+        expected_headers = headers.update('Content-Type' => 'application/json')
+        instance.should_receive(:http).and_return(http_mock)
+        http_mock.should_receive(:put).with(path, body, expected_headers).and_return(response_mock)
+
+        instance.put(path, body, headers)
+      end
+    end
+  end
+
+end

data/spec/active_resource/integration_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe %q(
+  As Developer
+  I order to speed up my active resources usage
+  I want to use HTTP 1.1 keepalive feature
+) do
+  
+  it "Retrieving one resource multiple times" do
+    ids = %w(101 202 303)
+    users = ids.map { |id| TestUser.find(id) }
+
+    users[0].id.should == ids[0]
+    users[1].id.should == ids[1]
+    users[2].id.should == ids[2]
+
+    TestHelper.logged_requests.size.should == 3
+    TestHelper.persistent_requests_logged?.should be_true
+  end
+
+  it "Retrieving two resources from the same site" do
+    user = TestUser.find("101")
+    post = TestPost.find("202")
+
+    user.id.should == "101"
+    post.id.should == "202"
+
+    TestHelper.logged_requests.size.should == 2
+    TestHelper.persistent_requests_logged?.should be_true
+  end
+
+  it "Delete different resources from the same site" do
+    TestUser.find("101").destroy
+    TestPost.find("202").destroy
+   
+    TestHelper.logged_requests.size.should == 4
+    TestHelper.persistent_requests_logged?.should be_true
+  end
+
+  it "Updating different resources from the same site" do
+    user = TestUser.find("101").update_attribute(:username, "jack")
+    post = TestPost.find("202").update_attribute(:title, "hi")
+   
+    TestHelper.logged_requests.size.should == 4
+    TestHelper.persistent_requests_logged?.should be_true
+  end
+
+
+  it "Creating different resources on the same site" do
+    user = TestUser.create(:username => "Bob")
+    post = TestPost.create(:title => "Hello Bob")
+
+    user.id.should_not be_blank
+    post.id.should_not be_blank
+
+    user.username.should == "Bob"
+    post.title.should == "Hello Bob"
+
+    TestHelper.logged_requests.size.should == 2
+    TestHelper.persistent_requests_logged?.should be_true
+  end
+end

data/spec/active_resource/persistent/http_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+
+describe ActiveResource::Persistent::HTTP do
+  describe "class" do
+    subject { described_class }
+    its(:superclass) { should == Net::HTTP::Persistent }
+  end
+
+  describe "instance" do
+    let(:site)  { URI.parse('http://site.example.com:3000') }
+    let(:proxy)  { URI.parse('http://proxy.example.com:8080') }
+
+    subject { described_class.new(site, proxy) }
+
+    it "should have site" do
+      subject.site.should == site
+    end
+
+    it "should have proxy_uri" do
+      subject.proxy_uri.should == proxy
+    end
+  end
+
+  context "request methods" do
+    let(:site) { TestServer.uri }
+    let(:instance) { described_class.new(site, nil) }
+
+    let(:path) { '/inspect/all?key=value' }
+    let(:body) { 'HELLO WORLD' }
+    let(:headers) { { 'X-AUTHORIZATION' => 'qwerty' } }
+
+    it "should HEAD data" do
+      @response = instance.head(path, headers)
+
+      @response.should be_instance_of(Net::HTTPOK)
+      @response.body.should be_nil
+    end
+
+    it "should GET data" do
+      @response = instance.get(path, headers)
+
+      expect_response('GET', nil)
+    end
+
+    it "should DELETE data" do
+      @response = instance.delete(path, headers)
+
+      expect_response('DELETE', nil)
+    end
+
+    it "should POST data" do
+      @response = instance.post(path, body, headers)
+
+      expect_response('POST', body)
+    end
+
+    it "should PUT data" do
+      @response = instance.put(path, body, headers)
+
+      expect_response('PUT', body)
+    end
+
+    protected
+
+    def expect_response(request_method, payload)
+      @response.should be_instance_of(Net::HTTPOK)
+
+      body = YAML.load(@response.body)
+     
+      body['REQUEST_METHOD'].should == request_method
+      body['REQUEST_URI'].should == path
+      body['HTTP_X_AUTHORIZATION'].should == 'qwerty'
+      body['rack.input'].should == payload
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+Bundler.setup
+
+require 'active_resource/persistent'
+
+Dir["spec/support/**/*.rb"].each { |f| load f }
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    TestServer.start
+
+    TestUser.site = TestServer.uri
+    TestPost.site = TestServer.uri
+  end 
+
+  config.before(:each) do
+    TestIPC.clear
+  end 
+
+  config.after(:suite) do
+    TestServer.stop
+  end
+end

data/spec/support/test_application.rb

@@ -0,0 +1,127 @@
+require 'sinatra'
+require 'multi_json'
+
+class TestApplication < Sinatra::Base
+  before do
+    TestHelper.log_request(env)
+  end
+
+  #
+  # User resources
+  #
+
+  get '/users/:id.json' do
+    id = params[:id]
+    data_halt({
+      'id'       => id,
+      'username' => "jack_#{id}",
+      'remote_port' => env['REMOTE_PORT']
+    })
+  end
+
+  get '/users.json' do
+    data_halt([
+      {
+        'id'       => 1,
+        'username' => "alice",
+        'remote_port' => env['REMOTE_PORT']
+      },
+      {
+        'id'       => 2,
+        'username' => "bob",
+        'remote_port' => env['REMOTE_PORT']
+      }
+    ])
+  end
+
+  post '/users.json' do
+    user = MultiJson.load(request.body)
+
+    id = Time.now.to_i
+
+    halt 202, { 'Location' => "/users/#{id}" }, ''
+  end
+
+  put '/users/:id.json' do
+    id = params[:id]
+    user = MultiJson.load(request.body)
+    data_halt(user)
+  end
+
+  delete '/users/:id.json' do
+    id = params[:id]
+    halt 200
+  end
+
+  #
+  # Post resources
+  # 
+
+  get '/posts/:id.json' do
+    id = params[:id]
+
+    data_halt({
+      'id'    => id,
+      'title' => "hello_world_#{id}",
+      'remote_port' => env['REMOTE_PORT']
+    })
+  end
+
+  put '/posts/:id.json' do
+    id = params[:id]
+    post = MultiJson.load(request.body)
+    data_halt(post)
+  end
+
+  post '/posts.json' do
+    post = MultiJson.load(request.body)
+
+    id = Time.now.to_i
+
+    halt 202, { 'Location' => "/posts/#{id}" }, ''
+  end
+
+  delete '/posts/:id.json' do
+    id = params[:id]
+    halt 200
+  end
+
+  #
+  # Inspect other requests
+  #
+  head   '/*' do nil end
+  get    '/*' do env_halt end
+  delete '/*' do env_halt end
+  post   '/*' do env_halt end
+  put    '/*' do env_halt end
+
+  protected
+
+  def data_halt(data, status = 200)
+    content_type :json
+    body MultiJson.dump(data)
+    halt status
+  end
+
+  def env_halt
+    payload = {}
+
+    env.sort.each do |key, value|
+      case key
+      when 'rack.input'
+        while line = value.gets
+          data ||= ""
+          data << line
+        end
+        payload[key] = data
+      when /^rack\./
+      else
+        payload[key] = value
+      end
+    end
+
+    content_type :text
+    body payload.to_yaml
+    halt 200
+  end
+end

data/spec/support/test_helper.rb

@@ -0,0 +1,22 @@
+module TestHelper
+  extend self
+
+  def log_request(env)
+    data = [
+      env['REMOTE_PORT'],
+      env['REQUEST_METHOD'],
+      env['REQUEST_URI']
+    ].join('|') 
+
+    TestIPC.push(data)
+  end
+
+  def logged_requests
+    TestIPC.pull.map { |line| line.split('|') }
+  end
+
+  def persistent_requests_logged?
+    logged_requests.map { |line| line[0] }.uniq.size == 1
+  end
+
+end

data/spec/support/test_ipc.rb

@@ -0,0 +1,19 @@
+module TestIPC
+  extend self
+
+  def filename
+    @filename = File.expand_path('../../../tmp/test_ipc.text', __FILE__)
+  end
+
+  def clear
+    File.delete(filename) if File.exists?(filename)
+  end
+
+  def push(data)
+    File.open(filename, "a+") { |f| f.puts(data) }
+  end
+
+  def pull
+    File.exists?(filename) ? File.read(filename).split("\n") : []
+  end
+end

data/spec/support/test_resources.rb

@@ -0,0 +1,9 @@
+require 'active_resource'
+
+class TestUser < ActiveResource::Base
+  self.element_name = 'user'
+end
+
+class TestPost < ActiveResource::Base
+  self.element_name = 'post'
+end

data/spec/support/test_server.rb

@@ -0,0 +1,40 @@
+require 'socket'
+require 'posix/spawn'
+
+module TestServer
+  extend self
+
+  def host
+    'localhost'
+  end
+
+  def port
+    9292
+  end
+
+  def uri
+    URI.parse("http://#{host}:#{port}")
+  end
+
+  def pid
+    @pid
+  end
+
+  def start
+    @pid = POSIX::Spawn.spawn("passenger start --port #{port}", :out => 'test_server.output')
+    sleep(1)
+  end
+
+  def stop
+    Process.kill("TERM", pid) if pid
+  end
+
+  protected
+
+  def find_available_port
+    server = TCPServer.new('127.0.0.1', '9292')
+    server.addr[1]
+  ensure
+    server.close if server
+  end
+end

metadata

@@ -1,106 +1,97 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: activeresource-persistent
-version: !ruby/object:Gem::Version 
-  hash: 29
+version: !ruby/object:Gem::Version
+  version: 0.1.0
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 1
-  version: 0.0.1
 platform: ruby
-authors: 
+authors:
 - Andriy Yanko
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-04-19 00:00:00 +03:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-04-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: net-http-persistent
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &16473480 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 9
-        segments: 
-        - 2
-        - 5
-        version: "2.5"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.5'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: activeresource
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *16473480
+- !ruby/object:Gem::Dependency
+  name: activeresource
+  requirement: &16472560 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 2
-        - 3
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 2.3.0
   type: :runtime
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: *16472560
 description: HTTP persistent connection support for ActiveResource
-email: 
+email:
 - andriy.yanko@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - activeresource-persistent.gemspec
+- config.ru
 - lib/active_resource/persistent.rb
 - lib/active_resource/persistent/connection.rb
 - lib/active_resource/persistent/http.rb
-has_rdoc: true
+- public/.gitkeep
+- spec/active_resource/connection_spec.rb
+- spec/active_resource/integration_spec.rb
+- spec/active_resource/persistent/http_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_application.rb
+- spec/support/test_helper.rb
+- spec/support/test_ipc.rb
+- spec/support/test_resources.rb
+- spec/support/test_server.rb
 homepage: https://github.com/railsware/activeresource-persistent
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.5.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: HTTP persistent connection support for ActiveResource
-test_files: []
-
+test_files:
+- spec/active_resource/connection_spec.rb
+- spec/active_resource/integration_spec.rb
+- spec/active_resource/persistent/http_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_application.rb
+- spec/support/test_helper.rb
+- spec/support/test_ipc.rb
+- spec/support/test_resources.rb
+- spec/support/test_server.rb
+has_rdoc: