xenon-http 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b0b08a0d571aa3a84a8d8e265ac6367faa2a77a2
-  data.tar.gz: a4cb57cf66389dcc581c1af178afaf093ce4e4e7
+  metadata.gz: 8f749f567c0d040df9e40e2956abe02d628652ab
+  data.tar.gz: cf94e0a40a8480f6a05d9af9847f7e30073cc6aa
 SHA512:
-  metadata.gz: b6051d24573e349c0cb707086a1317bd85fe70cab9a1c6b56f96f4f7492bdd3f9dce61d199a9425a4f72ea108c3f0c1bbef6d36f139cf1d869ddc096f65f80db
-  data.tar.gz: 3978873c62fa30babe95b6ff9a75eb56bcdeec03f0bd083bed81244622647ebfeaa27f470e5bce57caf1a9a4b8505b7179f60712345223568cd14ea4ec511cd8
+  metadata.gz: ebb97d34011c1ed89471d45d4cca9f6911758092458c8207b0810e5f0947ce13dce825a9e3b5c472fae01445093b19d97edab3e0a7984afb586025de4596cf13
+  data.tar.gz: 2ddd75cc5b4a291df18a9406a28ed3da9847bd1131708d474c1af8bb6247d6fa1eb2f799653e906bb42d22b1b7ffa7451251d79e6783c063b4b7b090b9df4520

data/lib/xenon/etag.rb

@@ -0,0 +1,85 @@
+require 'xenon/parsers/etag'
+
+module Xenon
+  # An Etag, see {http://tools.ietf.org/html/rfc7232#section-2.3 RFC 7232 § 2.3}.
+  class ETag
+    attr_reader :tag
+
+    # Initializes a new ETag instance.
+    # @param tag [String] The opaque tag.
+    # @param weak [true, false] Whether the tag is weak.
+    def initialize(tag, weak: false)
+      @tag = tag
+      @weak = weak
+      freeze
+    end
+
+    # Prevents further modifications to the ETag.
+    # @return [ETag] This method returns self.
+    def freeze
+      @tag.freeze
+      super
+    end
+
+    # Parses an ETag string.
+    # @param s [String] The ETag string.
+    # @return [ETag] An `ETag` object.
+    def self.parse(s)
+      tree = Parsers::ETag.new.etag.parse(s)
+      Parsers::ETagHeaderTransform.new.apply(tree)
+    rescue Parslet::ParseFailed
+      raise Xenon::ParseError.new("Invalid ETag (#{s}).")
+    end
+
+    # Whether the ETag is weak.
+    # @return [true, false] `true` if the ETag is weak; otherwise `false`.
+    def weak?
+      @weak
+    end
+
+    # Whether the ETag is strong.
+    # @return [true, false] `true` if the ETag is strong; otherwise `false`.
+    def strong?
+      !weak?
+    end
+
+    # The strong equality function, see {http://tools.ietf.org/html/rfc7232#section-2.3.2 RFC 7232 § 2.3.2}.
+    # @return [true, false] `true` if the ETags are both strong and have the same tag; otherwise `false`.
+    def strong_eq?(other)
+      strong? && other.strong? && @tag == other.tag
+    end
+
+    # The weak equality function, see {http://tools.ietf.org/html/rfc7232#section-2.3.2 RFC 7232 § 2.3.2}.
+    # @return [true, false] `true` if the ETags have the same tag; otherwise `false`.
+    def weak_eq?(other)
+      @tag == other.tag
+    end
+
+    # An equality function that checks the ETags have the same strength and tag.
+    # @return [true, false] `true` if the ETags have the same strength and tag; otherwise `false`.
+    def ==(other)
+      strong? == other.strong? && @tag == other.tag
+    end
+    alias_method :eql?, :==
+
+    # A case equality function that uses {strong_eq?} or {weak_eq?} depending on whether the receiving
+    # tag is strong or weak, respectively.
+    # @return [true, false] `true` if the other ETag matches; otherwise `false`.
+    def ===(other)
+      strong? ? strong_eq?(other) : weak_eq?(other)
+    end
+    alias_method :=~, :===
+
+    # Returns a hash code based on the ETag state.
+    # @return [Fixnum] The ETag hash.
+    def hash
+      to_s.hash
+    end
+
+    # Returns a string representation of the ETag.
+    # @return [String] The ETag string.
+    def to_s
+      strong? ? %("#{@tag}") : %(W/"#{@tag}")
+    end
+  end
+end

data/{xenon-http/lib → lib}/xenon/headers.rb

@@ -41,7 +41,13 @@ module Xenon
       self
     end
 
-    %i(set add).each do |name|
+    def remove!(header)
+      header = header.name if header.respond_to?(:name)
+      @hash.delete(header)
+      self
+    end
+
+    %i(set add remove).each do |name|
       define_method name do |header|
         dup.send("#{name}!", header)
       end

data/{xenon-http/lib → lib}/xenon/headers/accept.rb

@@ -7,7 +7,7 @@ module Xenon
     # http://tools.ietf.org/html/rfc7231#section-5.3.2
     class Accept < ListHeader 'Accept'
       def initialize(*media_ranges)
-        super(media_ranges.sort_by.with_index { |mr, i| [mr, -i] }.reverse!)
+        super(media_ranges.sort_by.with_index { |mr, i| [mr, -i] }.reverse)
       end
 
       alias_method :media_ranges, :values

data/{xenon-http/lib → lib}/xenon/headers/accept_charset.rb

@@ -27,7 +27,7 @@ module Xenon
     # http://tools.ietf.org/html/rfc7231#section-5.3.3
     class AcceptCharset < ListHeader 'Accept-Charset'
       def initialize(*charset_ranges)
-        super(charset_ranges.sort_by.with_index { |mr, i| [mr, -i] }.reverse!)
+        super(charset_ranges.sort_by.with_index { |mr, i| [mr, -i] }.reverse)
       end
 
       alias_method :charset_ranges, :values

data/{xenon-http/lib → lib}/xenon/headers/accept_encoding.rb

@@ -27,7 +27,7 @@ module Xenon
     # http://tools.ietf.org/html/rfc7231#section-5.3.4
     class AcceptEncoding < ListHeader 'Accept-Encoding'
       def initialize(*coding_ranges)
-        super(coding_ranges.sort_by.with_index { |mr, i| [mr, -i] }.reverse!)
+        super(coding_ranges.sort_by.with_index { |mr, i| [mr, -i] }.reverse)
       end
 
       alias_method :coding_ranges, :values

data/{xenon-http/lib → lib}/xenon/headers/accept_language.rb

@@ -27,7 +27,7 @@ module Xenon
     # http://tools.ietf.org/html/rfc7231#section-5.3.5
     class AcceptLanguage < ListHeader 'Accept-Language'
       def initialize(*language_ranges)
-        super(language_ranges.sort_by.with_index { |mr, i| [mr, -i] }.reverse!)
+        super(language_ranges.sort_by.with_index { |mr, i| [mr, -i] }.reverse)
       end
 
       alias_method :language_ranges, :values

data/lib/xenon/headers/content_length.rb

@@ -0,0 +1,23 @@
+require 'xenon/headers'
+require 'xenon/media_type'
+
+module Xenon
+  class Headers
+    # https://tools.ietf.org/html/rfc7230#section-3.3.2
+    class ContentLength < Header 'Content-Length'
+      attr_reader :content_length
+
+      def initialize(content_length)
+        @content_length = content_length
+      end
+
+      def self.parse(s)
+        Integer(s)
+      end
+
+      def to_s
+        @content_length.to_s
+      end
+    end
+  end
+end

data/{xenon-http/lib → lib}/xenon/media_type.rb

@@ -56,6 +56,10 @@ module Xenon
       end
     end
 
+    def ==(other)
+      @type == other.type && @subtype == other.subtype && @params == other.params
+    end
+
     # Creates a {MediaRange} using this media type with a quality factor.
     #
     # @param q [Numeric] A value between 1.0 (most desirable) and 0.0 (not acceptable).

data/lib/xenon/parsers/etag.rb

@@ -0,0 +1,9 @@
+require 'xenon/parsers/header_rules'
+
+module Xenon
+  module Parsers
+    class ETag < Parslet::Parser
+      include ETagHeaderRules
+    end
+  end
+end

data/{xenon-http/lib → lib}/xenon/quoted_string.rb

@@ -7,13 +7,13 @@ module Xenon
       end
 
       def unquote
-      	qs = start_with?('"') && end_with?('"') ? self[1..-2] : self
-      	qs.gsub(/\\(.)/, '\1')
+        qs = start_with?('"') && end_with?('"') ? self[1..-2] : self
+        qs.gsub(/\\(.)/, '\1')
       end
 
       def uncomment
-      	qs = start_with?('(') && end_with?(')') ? self[1..-2] : self
-      	qs.gsub(/\\(.)/, '\1')
+        qs = start_with?('(') && end_with?(')') ? self[1..-2] : self
+        qs.gsub(/\\(.)/, '\1')
       end
     end
   end

data/spec/xenon/etag_spec.rb

@@ -0,0 +1,105 @@
+require 'xenon/etag'
+require 'xenon/errors'
+
+describe Xenon::ETag do
+  let(:strong1) { described_class.new('1') }
+  let(:weak1) { described_class.new('1', weak: true) }
+  let(:weak2) { described_class.new('2', weak: true) }
+
+  describe '::parse' do
+    it 'should parse a strong etag' do
+      etag = described_class.parse('"xyzzy"')
+      expect(etag.tag).to eq 'xyzzy'
+      expect(etag).to be_strong
+    end
+    it 'should parse a weak etag' do
+      etag = described_class.parse('W/"xyzzy"')
+      expect(etag.tag).to eq 'xyzzy'
+      expect(etag).to be_weak
+    end
+    it 'should raise a ParseError when the string is not a valid etag' do
+      expect { described_class.parse('xyzzy') }.to raise_error Xenon::ParseError
+      expect { described_class.parse('W/xyzzy') }.to raise_error Xenon::ParseError
+      expect { described_class.parse('w/"xyzzy"') }.to raise_error Xenon::ParseError
+    end
+  end
+
+  describe '#initialize' do
+    it 'should freeze the instance' do
+      expect(strong1).to be_frozen
+    end
+  end
+
+  describe '#freeze' do
+    it 'should freeze the tag' do
+      expect { strong1.tag << 'x' }.to raise_error RuntimeError
+    end
+  end
+
+  describe '#strong_eq?' do
+    it 'should return false for the same weak tags' do
+      expect(weak1).to_not be_strong_eq weak1
+    end
+    it 'should return false for the different weak tags' do
+      expect(weak1).to_not be_strong_eq weak2
+    end
+    it 'should return false for tags that are same but one is weak and one is strong' do
+      expect(weak1).to_not be_strong_eq strong1
+      expect(strong1).to_not be_strong_eq weak1
+    end
+    it 'should return true for the same strong tags' do
+      expect(strong1).to be_strong_eq strong1
+    end
+  end
+
+  describe '#weak_eq?' do
+    it 'should return true for the same weak tags' do
+      expect(weak1).to be_weak_eq weak1
+    end
+    it 'should return false for the different weak tags' do
+      expect(weak1).to_not be_weak_eq weak2
+    end
+    it 'should return true for tags that are same but one is weak and one is strong' do
+      expect(weak1).to be_weak_eq strong1
+      expect(strong1).to be_weak_eq weak1
+    end
+    it 'should return true for the same strong tags' do
+      expect(strong1).to be_weak_eq strong1
+    end
+  end
+
+  describe '#==' do
+    it 'should return true for the same weak tags' do
+      expect(weak1).to be == weak1
+    end
+    it 'should return false for the different weak tags' do
+      expect(weak1).to_not be == weak2
+    end
+    it 'should return false for tags that are same but one is weak and one is strong' do
+      expect(weak1).to_not be == strong1
+      expect(strong1).to_not be == weak1
+    end
+    it 'should return true for the same strong tags' do
+      expect(strong1).to be == strong1
+    end
+  end
+
+  describe '#===' do
+    it 'should return true for the same weak tags' do
+      expect(weak1).to be === weak1
+    end
+    it 'should return false for the different weak tags' do
+      expect(weak1).to_not be === weak2
+    end
+    it 'should return true for the same tags when the receiver is weak and the other is strong' do
+      expect(weak1).to be === strong1
+    end
+    it 'should return false for the same tags when the receiver is strong and the other is weak' do
+      expect(strong1).to_not be === weak1
+    end
+    it 'should return true for the same strong tags' do
+      expect(strong1).to be === strong1
+    end
+  end
+
+end

data/{xenon-http/spec → spec}/xenon/headers/if_range_spec.rb

@@ -21,7 +21,7 @@ describe Xenon::Headers::IfRange do
     it 'can parse a strong etag' do
       header = Xenon::Headers::IfRange.parse('"xyzzy"')
       expect(header.etag).to_not be_nil
-      expect(header.etag.opaque_tag).to eq 'xyzzy'
+      expect(header.etag.tag).to eq 'xyzzy'
       expect(header.etag).to be_strong
     end
 

data/{xenon-http/spec → spec}/xenon/media_type_spec.rb

@@ -94,7 +94,7 @@ describe Xenon::MediaType do
       expect(mt.to_s).to eq('text/plain; format=flowed; paged')
     end
   end
-  
+
 end
 
 describe Xenon::MediaRange do

data/{xenon-http/xenon-http.gemspec → xenon-http.gemspec}

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Xenon::HTTP_VERSION
   spec.authors       = ['Greg Beech']
   spec.email         = ['greg@gregbeech.com']
-  spec.summary       = %q{An HTTP framework for building RESTful APIs.}
-  spec.description   = %q{Provides a model for the HTTP protocol and a tree-based routing syntax.}
+  spec.summary       = %q{A model and parsers for the HTTP protocol.}
+  spec.description   = %q{Provides a model for the HTTP protocol with high quality parsers.}
   spec.homepage      = 'https://github.com/gregbeech/xenon'
   spec.license       = 'MIT'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xenon-http
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Greg Beech
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-17 00:00:00.000000000 Z
+date: 2016-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -38,84 +38,57 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
-description: Provides a model for the HTTP protocol and a tree-based routing syntax.
+description: Provides a model for the HTTP protocol with high quality parsers.
 email:
 - greg@gregbeech.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".codeclimate.yml"
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- Gemfile
-- Guardfile
-- LICENSE
-- README.md
-- Rakefile
-- VERSION
-- examples/hello_world/config.ru
-- examples/hello_world/hello_world.rb
-- xenon-http/lib/xenon/auth.rb
-- xenon-http/lib/xenon/errors.rb
-- xenon-http/lib/xenon/etag.rb
-- xenon-http/lib/xenon/headers.rb
-- xenon-http/lib/xenon/headers/accept.rb
-- xenon-http/lib/xenon/headers/accept_charset.rb
-- xenon-http/lib/xenon/headers/accept_encoding.rb
-- xenon-http/lib/xenon/headers/accept_language.rb
-- xenon-http/lib/xenon/headers/authorization.rb
-- xenon-http/lib/xenon/headers/cache_control.rb
-- xenon-http/lib/xenon/headers/content_type.rb
-- xenon-http/lib/xenon/headers/if_match.rb
-- xenon-http/lib/xenon/headers/if_modified_since.rb
-- xenon-http/lib/xenon/headers/if_none_match.rb
-- xenon-http/lib/xenon/headers/if_range.rb
-- xenon-http/lib/xenon/headers/if_unmodified_since.rb
-- xenon-http/lib/xenon/headers/user_agent.rb
-- xenon-http/lib/xenon/headers/www_authenticate.rb
-- xenon-http/lib/xenon/http.rb
-- xenon-http/lib/xenon/http_version.rb
-- xenon-http/lib/xenon/media_type.rb
-- xenon-http/lib/xenon/parsers/basic_rules.rb
-- xenon-http/lib/xenon/parsers/header_rules.rb
-- xenon-http/lib/xenon/parsers/media_type.rb
-- xenon-http/lib/xenon/quoted_string.rb
-- xenon-http/spec/spec_helper.rb
-- xenon-http/spec/xenon/etag_spec.rb
-- xenon-http/spec/xenon/headers/accept_charset_spec.rb
-- xenon-http/spec/xenon/headers/accept_encoding_spec.rb
-- xenon-http/spec/xenon/headers/accept_language_spec.rb
-- xenon-http/spec/xenon/headers/accept_spec.rb
-- xenon-http/spec/xenon/headers/authorization_spec.rb
-- xenon-http/spec/xenon/headers/cache_control_spec.rb
-- xenon-http/spec/xenon/headers/if_match_spec.rb
-- xenon-http/spec/xenon/headers/if_modified_since_spec.rb
-- xenon-http/spec/xenon/headers/if_none_match_spec.rb
-- xenon-http/spec/xenon/headers/if_range_spec.rb
-- xenon-http/spec/xenon/headers/if_unmodified_since_spec.rb
-- xenon-http/spec/xenon/headers/user_agent_spec.rb
-- xenon-http/spec/xenon/headers/www_authenticate_spec.rb
-- xenon-http/spec/xenon/media_type_spec.rb
-- xenon-http/xenon-http.gemspec
-- xenon-routing/lib/xenon/api.rb
-- xenon-routing/lib/xenon/marshallers.rb
-- xenon-routing/lib/xenon/request.rb
-- xenon-routing/lib/xenon/response.rb
-- xenon-routing/lib/xenon/routing.rb
-- xenon-routing/lib/xenon/routing/context.rb
-- xenon-routing/lib/xenon/routing/directives.rb
-- xenon-routing/lib/xenon/routing/header_directives.rb
-- xenon-routing/lib/xenon/routing/method_directives.rb
-- xenon-routing/lib/xenon/routing/param_directives.rb
-- xenon-routing/lib/xenon/routing/path_directives.rb
-- xenon-routing/lib/xenon/routing/route_directives.rb
-- xenon-routing/lib/xenon/routing/security_directives.rb
-- xenon-routing/lib/xenon/routing_version.rb
-- xenon-routing/spec/spec_helper.rb
-- xenon-routing/xenon-routing.gemspec
-- xenon.gemspec
+- lib/xenon/auth.rb
+- lib/xenon/errors.rb
+- lib/xenon/etag.rb
+- lib/xenon/headers.rb
+- lib/xenon/headers/accept.rb
+- lib/xenon/headers/accept_charset.rb
+- lib/xenon/headers/accept_encoding.rb
+- lib/xenon/headers/accept_language.rb
+- lib/xenon/headers/authorization.rb
+- lib/xenon/headers/cache_control.rb
+- lib/xenon/headers/content_length.rb
+- lib/xenon/headers/content_type.rb
+- lib/xenon/headers/if_match.rb
+- lib/xenon/headers/if_modified_since.rb
+- lib/xenon/headers/if_none_match.rb
+- lib/xenon/headers/if_range.rb
+- lib/xenon/headers/if_unmodified_since.rb
+- lib/xenon/headers/user_agent.rb
+- lib/xenon/headers/www_authenticate.rb
+- lib/xenon/http.rb
+- lib/xenon/http_version.rb
+- lib/xenon/media_type.rb
+- lib/xenon/parsers/basic_rules.rb
+- lib/xenon/parsers/etag.rb
+- lib/xenon/parsers/header_rules.rb
+- lib/xenon/parsers/media_type.rb
+- lib/xenon/quoted_string.rb
+- spec/spec_helper.rb
+- spec/xenon/etag_spec.rb
+- spec/xenon/headers/accept_charset_spec.rb
+- spec/xenon/headers/accept_encoding_spec.rb
+- spec/xenon/headers/accept_language_spec.rb
+- spec/xenon/headers/accept_spec.rb
+- spec/xenon/headers/authorization_spec.rb
+- spec/xenon/headers/cache_control_spec.rb
+- spec/xenon/headers/if_match_spec.rb
+- spec/xenon/headers/if_modified_since_spec.rb
+- spec/xenon/headers/if_none_match_spec.rb
+- spec/xenon/headers/if_range_spec.rb
+- spec/xenon/headers/if_unmodified_since_spec.rb
+- spec/xenon/headers/user_agent_spec.rb
+- spec/xenon/headers/www_authenticate_spec.rb
+- spec/xenon/media_type_spec.rb
+- xenon-http.gemspec
 homepage: https://github.com/gregbeech/xenon
 licenses:
 - MIT
@@ -136,25 +109,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: An HTTP framework for building RESTful APIs.
-test_files:
-- xenon-http/spec/spec_helper.rb
-- xenon-http/spec/xenon/etag_spec.rb
-- xenon-http/spec/xenon/headers/accept_charset_spec.rb
-- xenon-http/spec/xenon/headers/accept_encoding_spec.rb
-- xenon-http/spec/xenon/headers/accept_language_spec.rb
-- xenon-http/spec/xenon/headers/accept_spec.rb
-- xenon-http/spec/xenon/headers/authorization_spec.rb
-- xenon-http/spec/xenon/headers/cache_control_spec.rb
-- xenon-http/spec/xenon/headers/if_match_spec.rb
-- xenon-http/spec/xenon/headers/if_modified_since_spec.rb
-- xenon-http/spec/xenon/headers/if_none_match_spec.rb
-- xenon-http/spec/xenon/headers/if_range_spec.rb
-- xenon-http/spec/xenon/headers/if_unmodified_since_spec.rb
-- xenon-http/spec/xenon/headers/user_agent_spec.rb
-- xenon-http/spec/xenon/headers/www_authenticate_spec.rb
-- xenon-http/spec/xenon/media_type_spec.rb
+summary: A model and parsers for the HTTP protocol.
+test_files: []
 has_rdoc: