htcp 0.0.2

data/.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+doc
+pkg
+.yardoc
+.idea

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2008-2010 Alexey Kovyrin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,55 @@
+= Ruby Implementation of the HTCP Protocol Client
+
+This simple library implements HTCP protocol (http://www.htcp.org/) and could be used in any 
+Ruby project to manage any HTCP-compliant caching server (authors use it for Squid 2.7 servers 
+management).
+
+
+== What commands are supported?
+
+At this moment the only supported HTCP command is CLR that could be used to remove a cached 
+page from any HTCP-compliant server.
+
+
+== How to install?
+
+There are two options when approaching htcp-ruby installation:
+
+* using the gem (recommended and could be used in non-Rails projects)
+* install as a Rails plugin
+
+To install as a gem in a Rails project, add this to your environment.rb:
+
+    config.gem 'htcp'
+
+And then run the command:
+
+    sudo rake gems:install
+
+To install loops as a Rails plugin you need to do the following:
+
+    ./script/plugin install git://github.com/kovyrin/htcp-ruby.git
+
+This will install the whole package in your vendor/plugins directory.
+For merb applications, just check out the code and place it to the vendor/plugins directory.
+
+
+== How to use?
+
+Here is a simple code that could be used to purge a page from a caching server:
+
+    # Instantiate HTCP client
+    # It is possible to pass an array of servers to the constructor, 
+    # in that case any request sent to the client will be sent out 
+    # to all specified servers
+    htcp = Htcp::Client.new('cache01.local')
+
+    # Send CLR request and purge a page from the cache
+    htcp.clr("http://www.yoursite.com/some/page/url")
+
+
+== Who are the authors?
+
+This plugin has been created in Scribd.com for our internal use and then the sources were opened for other 
+people to use. All the code in this package has been developed by Alexey Kovyrin for Scribd.com and is 
+released under the MIT license. For more details, see LICENSE file.

data/Rakefile

@@ -0,0 +1,16 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name        = 'htcp'
+    gemspec.summary     = 'HTCP Protocol Client implemented in Ruby'
+    gemspec.description = 'This simple library implements HTCP protocol (www.htcp.org/) and could be used in any Ruby project to manage any HTCP-compliant caching server (authors use it for Squid 2.7 servers management).'
+    gemspec.email       = 'alexey@kovyrin.net'
+    gemspec.homepage    = 'http://github.com/kovyrin/htcp-ruby'
+    gemspec.rubyforge_project = 'htcp'
+    gemspec.authors     = ['Alexey Kovyrin']
+    gemspec.files.include ['lib/**/*']
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts 'Jeweler not available. Install it with: sudo gem install jeweler'
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/bin/htcp-client

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+puts "TBD"

data/htcp.gemspec

@@ -0,0 +1,64 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{htcp}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Alexey Kovyrin"]
+  s.date = %q{2010-05-29}
+  s.default_executable = %q{htcp-client}
+  s.description = %q{This simple library implements HTCP protocol (www.htcp.org/) and could be used in any Ruby project to manage any HTCP-compliant caching server (authors use it for Squid 2.7 servers management).}
+  s.email = %q{alexey@kovyrin.net}
+  s.executables = ["htcp-client"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "bin/htcp-client",
+     "htcp.gemspec",
+     "init.rb",
+     "lib/htcp.rb",
+     "lib/htcp/autoload.rb",
+     "lib/htcp/client.rb",
+     "lib/htcp/message/auth.rb",
+     "lib/htcp/message/base.rb",
+     "lib/htcp/message/constructor.rb",
+     "lib/htcp/message/data.rb",
+     "lib/htcp/message/header.rb",
+     "lib/htcp/message/op_data/clr.rb",
+     "lib/htcp/message/specifier.rb",
+     "spec/htcp/client_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/kovyrin/htcp-ruby}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{htcp}
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{HTCP Protocol Client implemented in Ruby}
+  s.test_files = [
+    "spec/htcp/client_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), 'lib/htcp')

data/lib/htcp.rb

@@ -0,0 +1,7 @@
+module Htcp
+  # @return [String]
+  #   a full path to the loops "lib" directory.
+  LIB_ROOT = File.expand_path(File.dirname(__FILE__)) unless const_defined?('LIB_ROOT')
+end
+
+require File.join(Htcp::LIB_ROOT, 'htcp/autoload')

data/lib/htcp/autoload.rb

@@ -0,0 +1,28 @@
+module Htcp
+  module Autoload
+    # @private
+    def __p(*path) File.join(Htcp::LIB_ROOT, 'htcp', *path) end
+  end
+  extend Autoload
+  
+  # Define autoloaded modules/classes
+  autoload :Client,         __p('client')
+  
+  module Message
+    extend Autoload
+
+    autoload :Base,         __p('message/base')
+    autoload :Constructor,  __p('message/constructor')
+
+    autoload :Auth,         __p('message/auth')
+    autoload :Data,         __p('message/data')
+    autoload :Header,       __p('message/header')
+    autoload :Specifier,    __p('message/specifier')
+    
+    module OpData
+      extend Autoload
+      
+      autoload :Clr,        __p('message/op_data/clr')
+    end
+  end
+end

data/lib/htcp/client.rb

@@ -0,0 +1,40 @@
+require 'socket'
+
+module Htcp
+  class Client
+    DEFAULT_PORT = 4827
+
+    def initialize(*servers_list)
+      @servers = servers_list.flatten
+    end
+  
+    def clr(url, headers = '')
+      message = Htcp::Message::Constructor.new(
+        :opcode => Htcp::Message::OpData::Clr::OP_CODE,
+        :rd => 0,
+        :trans_id => Time.now.to_i,
+        :op_data => Htcp::Message::OpData::Clr.new(:uri => url, :headers => headers)
+      )
+      send_messages(message)
+    end
+  
+  private
+  
+    def send_messages(message)
+      message = message.to_s
+      @servers.each { |s| send_message(s, message) }
+    end
+    
+    def send_message(server, message)
+      host, port = parse_server(server)
+      UDPSocket.new.send(message, 0, host, port)
+    end
+    
+    def parse_server(server)
+      host, port = server.split(':')
+      port = port.to_i
+      port = DEFAULT_PORT if port.zero?
+      return host, port
+    end
+  end
+end

data/lib/htcp/message/auth.rb

@@ -0,0 +1,13 @@
+module Htcp
+  module Message
+    class Auth < Htcp::Message::Base
+      def initialize(params)
+        # Not implemented
+      end
+  
+      def to_s
+        encode_int16(2)
+      end
+    end
+  end
+end

data/lib/htcp/message/base.rb

@@ -0,0 +1,33 @@
+module Htcp
+  module Message
+    class Base
+      # Put 16-bit int(s) to request.
+      def encode_int8(*ints)
+        request = ''
+        ints.each { |i| request << [i].pack('C') }
+        return request
+      end
+
+      # Put 16-bit int(s) to request.
+      def encode_int16(*ints)
+        request = ''
+        ints.each { |i| request << [i].pack('n') }
+        return request
+      end
+
+      # Put 32-bit int(s) to request.
+      def encode_int32(*ints)
+        request = ''
+        ints.each { |i| request << [i].pack('N') }
+        return request
+      end
+
+      # Put string(s) to request (first length, then the string itself).
+      def encode_string(*strings)
+        request = ''
+        strings.each { |s| request << encode_int16(s.length) + s }
+        return request
+      end
+    end
+  end
+end

data/lib/htcp/message/constructor.rb

@@ -0,0 +1,17 @@
+module Htcp
+  module Message
+    class Constructor
+      def initialize(params)
+        @header = Htcp::Message::Header.new(params[:head] || {})
+        @data = Htcp::Message::Data.new(params[:data] || params)
+        @auth = Htcp::Message::Auth.new(params[:auth] || {})
+      end
+    
+      def to_s
+        payload = @data.to_s + @auth.to_s
+        @header.payload_len = payload.length
+        @header.to_s + payload
+      end
+    end
+  end
+end

data/lib/htcp/message/data.rb

@@ -0,0 +1,27 @@
+module Htcp
+  module Message
+    class Data < Htcp::Message::Base
+      def initialize(params)
+        @params = params
+      end
+  
+      def to_s
+        # Process data fields
+        rr = @params[:response] ? 1 : 0
+        response_code = @params[:response] || 0
+        f1 = (rr.zero?) ? @params[:rd] : @params[:mo]
+
+        # Compose request
+        request = ''
+
+        request << encode_int8(response_code << 4 | @params[:opcode])
+        request << encode_int8((f1 << 1) | rr)
+        request << encode_int32(@params[:trans_id])
+        request << @params[:op_data].to_s
+
+        # Encode request with string
+        encode_int16(request.length + 2) + request
+      end
+    end
+  end
+end

data/lib/htcp/message/header.rb

@@ -0,0 +1,20 @@
+module Htcp
+  module Message
+    class Header < Htcp::Message::Base
+      attr_accessor :payload_len
+  
+      def initialize(params)
+        @params = {
+          :major => 0,
+          :minor => 0
+        }.merge(params)
+
+        @payload_len = 0
+      end
+  
+      def to_s
+        encode_int16(@payload_len + 4) + encode_int8(@params[:major], @params[:minor])
+      end
+    end
+  end
+end

data/lib/htcp/message/op_data/clr.rb

@@ -0,0 +1,17 @@
+module Htcp
+  module Message
+    module OpData
+      class Clr < Htcp::Message::Base
+        OP_CODE = 4
+
+        def initialize(params)
+          @specifier = Htcp::Message::Specifier.new(params)
+        end
+
+        def to_s
+          encode_int16(0) + @specifier.to_s
+        end
+      end
+    end
+  end
+end

data/lib/htcp/message/specifier.rb

@@ -0,0 +1,20 @@
+module Htcp
+  module Message
+    class Specifier < Htcp::Message::Base
+      def initialize(params)
+        @params = params
+      end
+
+      def to_s
+        request = ''
+    
+        request << encode_string(@params[:method] || 'GET')
+        request << encode_string(@params[:uri])
+        request << encode_string(@params[:version] || 'HTTP/1.1')
+        request << encode_string(@params[:headers] || '')
+    
+        return request
+      end
+    end
+  end
+end

data/spec/htcp/client_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe Htcp::Client do
+  context "in constructor" do
+    it "should accept one server" do
+      Htcp::Client.new('foo')
+    end
+
+    it "should accept a list of servers" do
+      Htcp::Client.new('foo', 'bar')
+    end
+
+    it "should accept an array of servers" do
+      Htcp::Client.new(['foo', 'bar'])
+    end
+
+    it "should accept alist of arrays of servers" do
+      Htcp::Client.new(['foo', 'bar'], 'baz', ['blah'])
+    end
+  end
+  
+  context "in parse_server method" do
+    before do
+      @htcp = Htcp::Client.new('foo')
+    end
+
+    it "should accept a 'host:port' server format" do
+      @htcp.send(:parse_server, 'foo:123').should == [ 'foo', 123 ]
+    end
+
+    it "should accept a 'host' server format" do
+      @htcp.send(:parse_server, 'foo').should == [ 'foo', Htcp::Client::DEFAULT_PORT ]
+    end
+
+    it "should accept a 'host:invalid_port' server format" do
+      @htcp.send(:parse_server, 'foo:blah').should == [ 'foo', Htcp::Client::DEFAULT_PORT ]
+    end
+  end
+  
+  context "in clr method" do
+    before do
+      @htcp = Htcp::Client.new('127.0.0.1')
+    end
+    
+    context "when called without additional headers" do
+      it "should compose a CLR request and try to send it out" do
+        @htcp.should_receive(:send_messages)
+        @htcp.clr('http://www.blah.com/foo/bar?baz=blah')
+      end
+    end
+    
+    context "when called with additional headers" do
+      it "should compose a CLR request and try to send it out" do
+        @htcp.should_receive(:send_messages)
+        @htcp.clr('http://www.blah.com/foo/bar?baz=blah', 'Foo: bar')
+      end
+    end
+  end
+  
+  context "in send_message method" do
+    it "should send the message out to one server when only one server specified" do
+      htcp = Htcp::Client.new('127.0.0.1')
+      htcp.should_receive(:send_message).once
+      htcp.clr('http://www.blah.com/foo/bar?baz=blah')
+    end
+
+    it "should send the message out to all servers when many servers specified" do
+      htcp = Htcp::Client.new('127.0.0.1', '127.0.0.2')
+      htcp.should_receive(:send_message).twice
+      htcp.clr('http://www.blah.com/foo/bar?baz=blah')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(File.dirname(__FILE__)), 'lib', 'htcp')

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: htcp
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Alexey Kovyrin
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-29 00:00:00 -04:00
+default_executable: htcp-client
+dependencies: []
+
+description: This simple library implements HTCP protocol (www.htcp.org/) and could be used in any Ruby project to manage any HTCP-compliant caching server (authors use it for Squid 2.7 servers management).
+email: alexey@kovyrin.net
+executables: 
+- htcp-client
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/htcp-client
+- htcp.gemspec
+- init.rb
+- lib/htcp.rb
+- lib/htcp/autoload.rb
+- lib/htcp/client.rb
+- lib/htcp/message/auth.rb
+- lib/htcp/message/base.rb
+- lib/htcp/message/constructor.rb
+- lib/htcp/message/data.rb
+- lib/htcp/message/header.rb
+- lib/htcp/message/op_data/clr.rb
+- lib/htcp/message/specifier.rb
+- spec/htcp/client_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/kovyrin/htcp-ruby
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: htcp
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: HTCP Protocol Client implemented in Ruby
+test_files: 
+- spec/htcp/client_spec.rb
+- spec/spec_helper.rb