http_objects 0.0.1

data/lib/http_objects/parameters/basic_rules.rb

@@ -0,0 +1,62 @@
+module HttpObjects::Parameters
+
+  # 2.2 Basic Rules
+  # This module implement some basic parsing constructs, from RFC 2616.
+  module BasicRules
+
+    # Public: Base interface for HTTP Header.
+    # HTTP Header should have:
+    #
+    #    # parse method that returns self instance.
+    #    Base.parse("value") # => <# Base instance >
+    #
+    #    # constructor with raw and value.
+    #    header = Base.new("raw", "value")
+    class Base
+      attr_reader :raw, :value
+
+      def self.parse(value)
+        raise "Not implemented. You should override this method and return an instance of yourself. See HttpObjects::Parameters::BasicRules source for examples."
+      end
+
+      def initialize(raw, value)
+        @raw, @value = raw, value
+      end
+    end
+
+    # Public: Mapped to String.
+    #    token = 1*<any CHAR except CTLs or separators>
+    class Token < Base
+      def self.parse(value)
+        self.new(value, value)
+      end
+    end
+
+    # Public: Mapped to Integer.
+    #    DIGIT = <any US-ASCII digit "0".."9">
+    class Digit < Base
+      def self.parse(value)
+        self.new(value, value.to_i)
+      end
+    end
+
+    # Public: Mapped to String#upcase.
+    #    UPALPHA = <any US-ASCII uppercase letter "A".."Z">
+    class UpAlpha < Base
+      def self.parse(value)
+        self.new(value, value.to_s.upcase)
+      end
+    end
+
+    # Public: Mapped to String#downcase.
+    #    LOALPHA = <any US-ASCII lowercase letter "a".."z">
+    class LoAlpha < Base
+      def self.parse(value)
+        self.new(value, value.to_s.downcase)
+      end
+    end
+
+  end
+
+end
+

data/lib/http_objects/parameters/date_time.rb

@@ -0,0 +1,19 @@
+require "time"
+
+module HttpObjects::Parameters
+
+  # 3.3. Date/Time Formats
+  # Examples
+  #    Sun, 06 Nov 1994 08:49:37 GMT  ; RFC 822, updated by RFC 1123
+  #    Sunday, 06-Nov-94 08:49:37 GMT ; RFC 850, obsoleted by RFC 1036
+  class DateTime < HttpObjects::Parameters::BasicRules::Base
+
+    def self.parse(value)
+      raw = value
+      value = Time.parse(value, true) rescue nil
+      self.new(raw, value)
+    end
+
+  end
+
+end

data/lib/http_objects/parameters/entity_tags.rb

@@ -0,0 +1,27 @@
+module HttpObjects::Parameters
+
+  # 3.11 Entity Tags
+  #
+  # Examples
+  #    "123456789"    -- A strong ETag validator
+  #    W/"123456789"  -- A weak ETag validator
+  class EntityTags < HttpObjects::Parameters::BasicRules::Base
+
+    def self.parse(value)
+      raw = value
+      if (match = value.match(/("\w*")/))
+        value = match[1]
+      else
+        value = ""
+      end
+      self.new(raw, value.to_s)
+    end
+
+    # Returns true if raw start with 'W/'
+    def weak?
+      @raw.start_with?("W/")
+    end
+
+  end
+
+end

data/lib/http_objects/parameters/language_tags.rb

@@ -0,0 +1,16 @@
+module HttpObjects::Parameters
+
+  # 3.10 Language Tags
+  # Examples
+  #    en, en-US, en-cockney, i-cherokee, x-pig-latin
+  class LanguageTags < HttpObjects::Parameters::BasicRules::Base
+
+    def self.parse(value)
+      raw = value
+      value = value.to_s.gsub(/(\s+)/, "").split(",")
+      self.new(raw, value)
+    end
+
+  end
+
+end

data/lib/http_objects/parameters/media_type.rb

@@ -0,0 +1,29 @@
+module HttpObjects::Parameters
+
+  # 3.7. Media Types
+  # Examples
+  #   text/html; charset=ISO-8859-4
+  class MediaType
+
+    attr_reader :raw, :value, :parameters
+
+    def self.parse(value)
+      raw = value
+      value, params = value.split(";", 2)
+
+      parameters = {}
+      params.split(/\s*;\s*/).each do |param|
+        name, param_value = param.split(/=/)
+        name = name.gsub(/\s*/, "")
+        parameters[name.downcase] = param_value
+      end
+      self.new(raw, value, parameters)
+    end
+
+    def initialize(raw, value, parameters)
+      @raw, @value, @parameters = raw, value, parameters
+    end
+
+  end
+
+end

data/lib/http_objects/parameters/uri.rb

@@ -0,0 +1,21 @@
+require "uri"
+
+module HttpObjects::Parameters
+
+  # 3.2 Uniform Resource Identifiers
+  # Examples
+  #    http://abc.com:80/~smith/home.html
+  #    /~smith/home.html
+  class Uri < HttpObjects::Parameters::BasicRules::Base
+
+    def self.parse(value)
+      raw = value
+      if !(value.nil? || value == "")
+        value = URI.parse(value.to_s)
+      end
+      self.new(raw, value)
+    end
+
+  end
+
+end

data/lib/http_objects/parameters.rb

@@ -0,0 +1,15 @@
+require "http_objects/parameters/basic_rules"
+require "http_objects/parameters/uri"
+require "http_objects/parameters/date_time"
+require "http_objects/parameters/media_type"
+require "http_objects/parameters/language_tags"
+require "http_objects/parameters/entity_tags"
+
+module HttpObjects
+
+  # 3 Protocol Parameters
+  # This module have implementatios for Protocol Parameters from RFC 2616.
+  module Parameters
+  end
+
+end

data/lib/http_objects/version.rb

@@ -0,0 +1,3 @@
+module HttpObjects
+  VERSION = "0.0.1"
+end

data/lib/http_objects.rb

@@ -0,0 +1,5 @@
+require "http_objects/version"
+
+require "http_objects/parameters"
+require "http_objects/headers"
+require "http_objects/headers_hash"

data/test/http_objects/hash_test.rb

@@ -0,0 +1,74 @@
+require "test_helper"
+
+describe HttpObjects::Hash do
+
+  MyObject = Class.new do
+    attr_reader :value, :raw
+    def self.header_name
+      "MyObject"
+    end
+    def self.parse(value)
+      self.new(value)
+    end
+    def initialize(value)
+      @raw, @value = value
+    end
+  end
+
+  class TestHash < HttpObjects::Hash
+    add_attribute(MyObject)
+  end
+
+  subject { TestHash.new }
+
+  describe "#initialize" do
+    subject { TestHash }
+    it "without value" do
+      subject.new.must_be_kind_of(HttpObjects::Hash)
+    end
+    it "with values" do
+      hash = subject.new("MyObject" => "value")
+      hash["MyObject"].must_be_instance_of(MyObject)
+    end
+    it "should reuse same object" do
+      hash_headers = subject.new("MyObject" => "value")
+      hash = subject.new(hash_headers)
+      hash.must_be_same_as(hash_headers)
+    end
+  end
+
+  describe "#[]=" do
+    it "simple value" do
+      subject["chave"] = "valor"
+      subject["chave"].must_equal("valor")
+    end
+    it "HTTP Header value" do
+      subject["MyObject"] = "value"
+      subject["MyObject"].must_be_instance_of(MyObject)
+    end
+    it "without value" do
+      subject["MyObject"].must_be_nil
+    end
+  end
+
+  describe "#store as alias of []=" do
+    it "simple value" do
+      subject.store("chave", "valor")
+      subject["chave"].must_equal("valor")
+    end
+    it "HTTP Header value" do
+      subject.store("MyObject", "value")
+      subject["MyObject"].must_be_instance_of(MyObject)
+    end
+  end
+
+  it "header as instance method" do
+    subject.store("MyObject", "value")
+    subject["MyObject"].must_be_instance_of(MyObject)
+
+    subject.myobject.must_be_instance_of(MyObject)
+    subject.myobject?.must_equal(true)
+    subject.myobject!.must_equal("value")
+  end
+
+end

data/test/http_objects/headers/attributes_test.rb

@@ -0,0 +1,26 @@
+require "test_helper"
+
+class TestSubject
+  extend HttpObjects::Headers::Attributes
+end
+
+describe HttpObjects::Headers::Attributes do
+
+  MyAttribute = Class.new
+
+  it "#register_attribute - register header on .attributes" do
+    TestSubject.register_attribute("MyAttribute", MyAttribute)
+    TestSubject.attributes.must_equal({"MyAttribute" => MyAttribute})
+  end
+
+  it "#register_attribute - should yield block if given" do
+    flag = "out block"
+    TestSubject.register_attribute("MyAttribute", MyAttribute) do |name, h|
+      name.must_equal("MyAttribute")
+      h.must_be_same_as(MyAttribute)
+      flag = "inner block"
+    end
+    flag.must_equal("inner block")
+  end
+
+end

data/test/http_objects/headers/directives/cache_test.rb

@@ -0,0 +1,72 @@
+require "test_helper"
+
+include HttpObjects::Headers::Directives
+
+describe Cache do
+
+  describe "should accept empty declarations" do
+    subject { Cache.parse("") }
+    it "#raw" do
+      subject.raw.must_be_empty
+    end
+    it "#value" do
+      subject.value.must_be_empty
+    end
+    it "directives be false or zero" do
+      subject.no_cache?.must_equal(false)
+      subject.no_store?.must_equal(false)
+      subject.max_age?.must_equal(false)
+      subject.max_stale?.must_equal(false)
+      subject.min_fresh?.must_equal(false)
+      subject.no_transform?.must_equal(false)
+      subject.only_if_cached?.must_equal(false)
+      subject.public?.must_equal(false)
+      subject.private?.must_equal(false)
+      subject.must_revalidate?.must_equal(false)
+      subject.proxy_revalidate?.must_equal(false)
+      subject.s_maxage?.must_equal(false)
+    end
+  end
+
+  describe "should accept one-directive declaration" do
+    subject { Cache.parse("no-cache") }
+    it "#no_cache? be true" do
+      subject.no_cache?.must_equal(true)
+    end
+  end
+
+  describe "should accept standalone directives" do
+    subject { Cache.parse("no-cache, public") }
+
+    it "#public?" do
+      subject.public?.must_equal(true)
+    end
+  end
+
+  describe "should accept multi-directive declaration" do
+    subject { Cache.parse("no-cache, max-age=600, private = \"Accept\"") }
+
+    it "#no_cache? be true" do
+      subject.no_cache?.must_equal(true)
+    end
+    it "#max_age be 600" do
+      subject.max_age?.must_equal(true)
+      subject.max_age.value.must_equal(600)
+    end
+    it "#private be Accept" do
+      subject.private!.must_equal("Accept")
+    end
+  end
+
+  describe "should accept extension directives" do
+    subject { Cache.parse("private, community=\"UCI\", stand-alone-extension") }
+
+    it "should access extension directive with value" do
+      subject["community"].must_equal("UCI")
+    end
+    it "should access extension directive without value" do
+      subject.key?("stand-alone-extension").must_equal(true)
+    end
+  end
+
+end

data/test/http_objects/headers/entity/allow_test.rb

@@ -0,0 +1,13 @@
+require "test_helper"
+
+include HttpObjects::Headers::Entity
+
+describe Allow do
+
+  subject { Allow.parse("GET, HEAD, PUT") }
+
+  it "should be BasicRules::UpAlpha object" do
+    subject.must_be_kind_of(HttpObjects::Parameters::BasicRules::UpAlpha)
+  end
+
+end

data/test/http_objects/headers/entity/content_encoding_test.rb

@@ -0,0 +1,13 @@
+require "test_helper"
+
+include HttpObjects::Headers::Entity
+
+describe ContentEncoding do
+
+  subject { ContentEncoding.parse("Gzip") }
+
+  it "should be BasicRules::LoAlpha object" do
+    subject.must_be_kind_of(HttpObjects::Parameters::BasicRules::LoAlpha)
+  end
+
+end

data/test/http_objects/headers/entity/content_language_test.rb

@@ -0,0 +1,13 @@
+require "test_helper"
+
+include HttpObjects::Headers::Entity
+
+describe ContentLanguage do
+
+  subject { ContentLanguage.parse("text/html; charset=ISO-8859-4") }
+
+  it "should be Language Tags object" do
+    subject.must_be_kind_of(HttpObjects::Parameters::LanguageTags)
+  end
+
+end

data/test/http_objects/headers/entity/content_lenght_test.rb

@@ -0,0 +1,13 @@
+require "test_helper"
+
+include HttpObjects::Headers::Entity
+
+describe ContentLength do
+
+  subject { ContentLength.parse("3495") }
+
+  it "should be BasicRules::Digit object" do
+    subject.must_be_kind_of(HttpObjects::Parameters::BasicRules::Digit)
+  end
+
+end

data/test/http_objects/headers/entity/content_location_test.rb

@@ -0,0 +1,13 @@
+require "test_helper"
+
+include HttpObjects::Headers::Entity
+
+describe ContentLocation do
+
+  subject { ContentLocation.parse("/relative_path") }
+
+  it "should be Uri object" do
+    subject.must_be_kind_of(HttpObjects::Parameters::Uri)
+  end
+
+end

data/test/http_objects/headers/entity/content_md5_test.rb

@@ -0,0 +1,13 @@
+require "test_helper"
+
+include HttpObjects::Headers::Entity
+
+describe ContentMD5 do
+
+  subject { ContentMD5.parse("aad883420fe64e865ba1725e5617222c") }
+
+  it "should be Token object" do
+    subject.must_be_kind_of(HttpObjects::Parameters::BasicRules::Token)
+  end
+
+end

data/test/http_objects/headers/entity/content_type_test.rb

@@ -0,0 +1,12 @@
+require "test_helper"
+
+describe HttpObjects::Headers::Entity::ContentType do
+
+  let(:subject_class) { HttpObjects::Headers::Entity::ContentType }
+  subject { subject_class.parse("text/html; charset=ISO-8859-4") }
+
+  it "should be Media Type object" do
+    subject.must_be_kind_of(HttpObjects::Parameters::MediaType)
+  end
+
+end

data/test/http_objects/headers/entity/expires_test.rb

@@ -0,0 +1,12 @@
+require "test_helper"
+
+describe HttpObjects::Headers::Entity::Expires do
+
+  let(:subject_class) { HttpObjects::Headers::Entity::Expires }
+  subject { subject_class.parse("Sun, 06 Nov 1994 08:49:37 GMT") }
+
+  it "should be Date Time object" do
+    subject.must_be_kind_of(HttpObjects::Parameters::DateTime)
+  end
+
+end

data/test/http_objects/headers/entity/last_modified_test.rb

@@ -0,0 +1,12 @@
+require "test_helper"
+
+describe HttpObjects::Headers::Entity::LastModified do
+
+  let(:subject_class) { HttpObjects::Headers::Entity::LastModified }
+  subject { subject_class.parse("Sun, 06 Nov 1994 08:49:37 GMT") }
+
+  it "should be Date Time object" do
+    subject.must_be_kind_of(HttpObjects::Parameters::DateTime)
+  end
+
+end

data/test/http_objects/headers/general_test.rb

@@ -0,0 +1,59 @@
+require "test_helper"
+
+include HttpObjects::Headers::General
+
+describe CacheControl do
+  subject { CacheControl.parse("no-cache, public") }
+  it "should be Cache directive object" do
+    subject.must_be_kind_of(HttpObjects::Headers::Directives::Cache)
+  end
+end
+
+describe Connection do
+  subject { Connection.parse("close") }
+  it "should be Token object" do
+    subject.must_be_kind_of(HttpObjects::Parameters::BasicRules::Token)
+  end
+end
+
+describe HttpObjects::Headers::General::Date do
+  subject { HttpObjects::Headers::General::Date.parse("Tue, 15 Nov 1994 08:12:31 GMT") }
+  it "should be DateTime object" do
+    subject.must_be_kind_of(HttpObjects::Parameters::DateTime)
+  end
+end
+
+describe Pragma do
+  subject { Pragma.parse("") }
+  it "should be Token object" do
+    subject.must_be_kind_of(HttpObjects::Parameters::BasicRules::Token)
+  end
+end
+
+describe Trailer do
+  subject { Trailer.parse("") }
+  it "should be Token object" do
+    subject.must_be_kind_of(HttpObjects::Parameters::BasicRules::Token)
+  end
+end
+
+describe Upgrade do
+  subject { Upgrade.parse("HTTP/2.0, SHTTP/1.3, IRC/6.9, RTA/x11") }
+  it "should be Token object" do
+    subject.must_be_kind_of(HttpObjects::Parameters::BasicRules::Token)
+  end
+end
+
+describe Via do
+  subject { Via.parse("1.0 fred, 1.1 nowhere.com (Apache/1.1)") }
+  it "should be Token object" do
+    subject.must_be_kind_of(HttpObjects::Parameters::BasicRules::Token)
+  end
+end
+
+describe Warning do
+  subject { Warning.parse("") }
+  it "should be Token object" do
+    subject.must_be_kind_of(HttpObjects::Parameters::BasicRules::Token)
+  end
+end

data/test/http_objects/headers/request/host_test.rb

@@ -0,0 +1,13 @@
+require "test_helper"
+
+include HttpObjects::Headers::Request
+
+describe Host do
+
+  subject { Host.parse("www.w3.org") }
+
+  it "should be Uri object" do
+    subject.must_be_kind_of(HttpObjects::Parameters::Uri)
+  end
+
+end

data/test/http_objects/headers/request/if_match_test.rb

@@ -0,0 +1,21 @@
+require "test_helper"
+
+include HttpObjects::Headers::Request
+
+describe IfMatch do
+
+  describe "*" do
+    subject { IfMatch.parse("*") }
+    it "should be Token object" do
+      subject.must_be_kind_of(HttpObjects::Parameters::BasicRules::Token)
+    end
+  end
+
+  describe '"xyzzy"' do
+    subject { IfMatch.parse('"xyzzy"') }
+    it "should be EntityTags object" do
+      subject.must_be_kind_of(HttpObjects::Parameters::EntityTags)
+    end
+  end
+
+end

data/test/http_objects/headers/request/if_modified_since_test.rb

@@ -0,0 +1,13 @@
+require "test_helper"
+
+include HttpObjects::Headers::Request
+
+describe IfModifiedSince do
+
+  subject { IfModifiedSince.parse("Sat, 29 Oct 1994 19:43:31 GMT") }
+
+  it "should be Date Time object" do
+    subject.must_be_kind_of(HttpObjects::Parameters::DateTime)
+  end
+
+end

data/test/http_objects/headers/request/if_none_match_test.rb

@@ -0,0 +1,21 @@
+require "test_helper"
+
+include HttpObjects::Headers::Request
+
+describe IfNoneMatch do
+
+  describe "*" do
+    subject { IfNoneMatch.parse("*") }
+    it "should be Token object" do
+      subject.must_be_kind_of(HttpObjects::Parameters::BasicRules::Token)
+    end
+  end
+
+  describe '"xyzzy"' do
+    subject { IfNoneMatch.parse('"xyzzy"') }
+    it "should be EntityTags object" do
+      subject.must_be_kind_of(HttpObjects::Parameters::EntityTags)
+    end
+  end
+
+end

data/test/http_objects/headers/request/if_range_test.rb

@@ -0,0 +1,21 @@
+require "test_helper"
+
+include HttpObjects::Headers::Request
+
+describe IfRange do
+
+  describe "entity-tag" do
+    subject { IfRange.parse('W/"xyzzy"') }
+    it "should be EntityTags object" do
+      subject.must_be_kind_of(HttpObjects::Parameters::EntityTags)
+    end
+  end
+
+  describe "HTTP-date" do
+    subject { IfRange.parse("Sat, 29 Oct 1994 19:43:31 GMT") }
+    it "should be Date Time object" do
+      subject.must_be_kind_of(HttpObjects::Parameters::DateTime)
+    end
+  end
+
+end

data/test/http_objects/headers/request/if_unmodified_since_test.rb

@@ -0,0 +1,13 @@
+require "test_helper"
+
+include HttpObjects::Headers::Request
+
+describe IfUnmodifiedSince do
+
+  subject { IfUnmodifiedSince.parse("Sat, 29 Oct 1994 19:43:31 GMT") }
+
+  it "should be Date Time object" do
+    subject.must_be_kind_of(HttpObjects::Parameters::DateTime)
+  end
+
+end