dkim-query 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2d9f9098c1e030f0a2a1c2fba560c7401e141f59
-  data.tar.gz: 59f563536960ccf6971cd19c185bad31826edfef
+  metadata.gz: 1044c31de0b41b92f7bef616f018efd5214ba8e1
+  data.tar.gz: 6ed8cc2e233929018e7a464457436674f25a1f33
 SHA512:
-  metadata.gz: 089538eaa322ce4398a6d7bf93bd8ace4835031f1ce33cee74b70f62b3384961053d7fbb63f18a06e01f91875647771230c8d8260cdf3ecbb3a95710caeab4ae
-  data.tar.gz: 3b32e90b1df9e12058207bb28ede74a056f029522b072a44806c7ff13f7c20218aa34cae5a2bad30c62c1a9d2e91adc4f64a1955ada1ee682aeee876517f07e6
+  metadata.gz: 7d0bf4acd647b16c40291120e8f172dfe529cec4dd9e0cd65f607871548684a4b8d737134981e15d001b158d885d8ee795bf9d81dfa4f078e35995309dc5a910
+  data.tar.gz: b3422596b4b3dc22ba95561eb22368bdd7de929db4b9a086679c14f6ea16d38d8a155c556799bc965e3774d454f3d3dce94b45f132f8c6be61530873db6bae96

data/ChangeLog.md

@@ -1,3 +1,9 @@
+### 0.2.3 / 2015-07-22
+
+* Fixed a typo in the `dkim-query` util.
+* Convert all text into Strings.
+* Convert `t=y` or `t=s` values to Symbols.
+
 ### 0.2.2 / 2015-07-04
 
 * Fixed {DKIM::Query::MalformedKey#to_s}.

data/README.md

@@ -29,10 +29,10 @@ Parse a DKIM record:
     # => :rsa
 
     key.n
-    # => "A 1024 bit key"@230
+    # => "A 1024 bit key"
 
     key.p
-    # => "MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDrEee0Ri4Juz+QfiWYui/E9UGSXau/2P8LjnTD8V4Unn+2FAZVGE3kL23bzeoULYv4PeleB3gfmJiDJOKU3Ns5L4KJAUUHjFwDebt0NP+sBK0VKeTATL2Yr/S3bT/xhy+1xtj4RkdV7fVxTn56Lb4udUnwuxK4V5b5PdOKj/+XcwIDAQAB"@10
+    # => "MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDrEee0Ri4Juz+QfiWYui/E9UGSXau/2P8LjnTD8V4Unn+2FAZVGE3kL23bzeoULYv4PeleB3gfmJiDJOKU3Ns5L4KJAUUHjFwDebt0NP+sBK0VKeTATL2Yr/S3bT/xhy+1xtj4RkdV7fVxTn56Lb4udUnwuxK4V5b5PdOKj/+XcwIDAQAB"
 
     key.s
     # => nil
@@ -42,8 +42,15 @@ Parse a DKIM record:
 
 Query all keys for a domain:
 
-    DKIM::Query::Domain.query('yahoo.com')
-    # => #<DKIM::Query::Domain:0x0000000315c950 @name="yahoo.com", @keys={"s1024"=>#<DKIM::Query::Key:0x0000000315c9f0 @v=nil, @g=nil, @h=nil, @k=:rsa, @n="A 1024 bit key;"@230, @p="MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDrEee0Ri4Juz+QfiWYui/E9UGSXau/2P8LjnTD8V4Unn+2FAZVGE3kL23bzeoULYv4PeleB3gfmJiDJOKU3Ns5L4KJAUUHjFwDebt0NP+sBK0VKeTATL2Yr/S3bT/xhy+1xtj4RkdV7fVxTn56Lb4udUnwuxK4V5b5PdOKj/+XcwIDAQAB"@10, @s=nil, @t=nil>}>
+    domain = DKIM::Query::Domain.query('yahoo.com')
+    # => #<DKIM::Query::Domain:0x0000000315c950 @name="yahoo.com", @keys={"s1024"=>#<DKIM::Query::Key:0x0000000315c9f0 @v=nil, @g=nil, @h=nil, @k=:rsa, @n="A 1024 bit key;", @p="MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDrEee0Ri4Juz+QfiWYui/E9UGSXau/2P8LjnTD8V4Unn+2FAZVGE3kL23bzeoULYv4PeleB3gfmJiDJOKU3Ns5L4KJAUUHjFwDebt0NP+sBK0VKeTATL2Yr/S3bT/xhy+1xtj4RkdV7fVxTn56Lb4udUnwuxK4V5b5PdOKj/+XcwIDAQAB", @s=nil, @t=nil>}>
+
+    domain['s1024']
+    # => #<DKIM::Query::Key:0x0000000315c9f0 @v=nil, @g=nil, @h=nil, @k=:rsa, @n="A 1024 bit key;", @p="MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDrEee0Ri4Juz+QfiWYui/E9UGSXau/2P8LjnTD8V4Unn+2FAZVGE3kL23bzeoULYv4PeleB3gfmJiDJOKU3Ns5L4KJAUUHjFwDebt0NP+sBK0VKeTATL2Yr/S3bT/xhy+1xtj4RkdV7fVxTn56Lb4udUnwuxK4V5b5PdOKj/+XcwIDAQAB", @s=nil, @t=nil>
+
+    domain.each do |key|
+      # ...
+    end
 
 ## Synopsis
 
@@ -87,7 +94,7 @@ Query multiple domains:
 
 ## Install
 
-    rake install
+    $ gem install dkim-query
 
 ## License
 

data/bin/dkim-query

@@ -3,7 +3,7 @@
 lib_dir = File.expand_path('../../lib',__FILE__)
 $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
 
-require 'dkim-query'
+require 'dkim/query'
 
 unless ARGV[0]
   warn "Please supply at least one host name"

data/lib/dkim/query/domain.rb

@@ -5,6 +5,9 @@ require 'resolv'
 
 module DKIM
   module Query
+    #
+    # Represents the DKIM keys of a domain.
+    #
     class Domain
 
       include Enumerable

data/lib/dkim/query/key.rb

@@ -4,29 +4,56 @@ require 'dkim/query/malformed_key'
 
 module DKIM
   module Query
+    #
+    # Represents an individual DKIM signing key.
+    #
     class Key
 
+      # DKIM version.
+      #
+      # @return [:DKIM1]
       attr_reader :v
       alias version v
 
+      # `g=` tag.
+      # 
+      # @return [String, nil]
       attr_reader :g
       alias granularity g
 
+      # `h=` tag.
+      #
+      # @return [:sha1, :sha256, Array<:sha1, :sha256, String>, nil]
       attr_reader :h
       alias hash h
 
+      # `k=` tag.
+      #
+      # @return [:rsa, String]
       attr_reader :k
       alias key k
 
+      # `n=` tag.
+      #
+      # @return [String, nil]
       attr_reader :n
       alias notes n
 
+      # `p=` tag.
+      #
+      # @return [String, nil]
       attr_reader :p
       alias public_key p
 
+      # `s=` tag.
+      #
+      # @return [:email, :*, String, Array<:email, :*, String>, nil]
       attr_reader :s
       alias service_type s
 
+      # `t=` tag.
+      #
+      # @return [:y, :s, String, nil]
       attr_reader :t
       alias flags t
 

data/lib/dkim/query/malformed_key.rb

@@ -1,5 +1,8 @@
 module DKIM
   module Query
+    #
+    # Represents a unparsable DKIM key.
+    #
     class MalformedKey
 
       # Raw value of the DKIM key.

data/lib/dkim/query/parser.rb

@@ -31,6 +31,8 @@ module DKIM
         ).as(:tag)
       end
 
+      private
+
       def self.key_tag_rule(name,&block)
         rule(:"key_#{name}_tag") do
           str(name).as(:name) >>
@@ -43,37 +45,43 @@ module DKIM
         str(name).as(:symbol)
       end
 
+      public
+
       key_tag_rule('v') { symbol('DKIM1') }
       key_tag_rule('g') { key_g_tag_lpart }
       rule(:key_g_tag_lpart) do
-        dot_atom_text.maybe >> (str('*') >> dot_atom_text.maybe).maybe
+        (
+          dot_atom_text.maybe >>
+          (str('*') >> dot_atom_text.maybe).maybe
+        ).as(:string)
+      end
+      rule(:dot_atom_text) do
+        atext.repeat(1) >> (str('.') >> atext.repeat(1)).repeat(0)
       end
-      rule(:dot_atom_text) { atext.repeat(1) >> (str('.') >> atext.repeat(1)).repeat(0) }
 
       key_tag_rule('h') do
-        key_h_tag_alg >>
-        (fws? >> str(':') >> fws? >> key_h_tag_alg).repeat(0)
+        key_h_tag_alg >> (fws? >> str(':') >> fws? >> key_h_tag_alg).repeat(0)
       end
       rule(:key_h_tag_alg) { symbol('sha1') | symbol('sha256') | x_key_h_tag_alg }
-      rule(:x_key_h_tag_alg) { hyphenated_word }
+      rule(:x_key_h_tag_alg) { hyphenated_word.as(:string) }
 
       key_tag_rule('k') { key_k_tag_type }
       rule(:key_k_tag_type) { symbol('rsa') | x_key_k_tag_type }
-      rule(:x_key_k_tag_type) { hyphenated_word }
+      rule(:x_key_k_tag_type) { hyphenated_word.as(:string) }
 
-      key_tag_rule('n') { qp_section }
+      key_tag_rule('n') { qp_section.as(:string) }
       key_tag_rule('p') { base64string.as(:asn1).maybe }
       key_tag_rule('s') do
         key_s_tag_type >> (fws? >> str(':') >> fws? >> key_s_tag_type).repeat(0)
       end
       rule(:key_s_tag_type) { symbol('email') | symbol('*') | x_key_s_tag_type }
-      rule(:x_key_s_tag_type) { hyphenated_word }
+      rule(:x_key_s_tag_type) { hyphenated_word.as(:string) }
 
       key_tag_rule('t') do
         key_t_tag_flag >> (fws? >> str(':') >> fws? >> key_t_tag_flag).repeat(0)
       end
-      rule(:key_t_tag_flag) { match['ys'] | x_key_t_tag_flag }
-      rule(:x_key_t_tag_flag) { hyphenated_word }
+      rule(:key_t_tag_flag) { match['ys'].as(:symbol) | x_key_t_tag_flag }
+      rule(:x_key_t_tag_flag) { hyphenated_word.as(:string) }
 
       #
       # Section 2.6: DKIM-Quoted-Printable
@@ -130,6 +138,7 @@ module DKIM
       class Transform < Parslet::Transform
 
         rule(:symbol => simple(:name)) { name.to_sym }
+        rule(:string => simple(:text)) { text.to_s }
         # XXX: temporarily disable ASN1 decoding, due to an OpenSSL bug.
         # rule(:asn1 => simple(:blob)) { OpenSSL::ASN1.decode(blob) }
         rule(:asn1 => simple(:blob)) { blob }

data/lib/dkim/query/query.rb

@@ -42,6 +42,12 @@ module DKIM
     # Default known selectors
     SELECTORS = %w[default dkim s1024 c1211]
 
+    #
+    # DKIM query selectors for the host.
+    #
+    # @param [String] host
+    #
+    # @return [Array<String>]
     #
     # @api private
     #
@@ -49,6 +55,12 @@ module DKIM
       SELECTORS + [host_without_tld(host)]
     end
 
+    #
+    # Removes the TLD from the hostname.
+    #
+    # @param [String] host
+    #
+    # @return [String]
     #
     # @api private
     #

data/lib/dkim/query/version.rb

@@ -1,5 +1,6 @@
 module DKIM
   module Query
-    VERSION = '0.2.2'
+    # dkim-query version
+    VERSION = '0.2.3'
   end
 end

data/spec/key_spec.rb

@@ -4,12 +4,14 @@ require 'dkim/query/key'
 describe Key do
   let(:k) { :rsa }
   let(:p) { "MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDrEee0Ri4Juz+QfiWYui/E9UGSXau/2P8LjnTD8V4Unn+2FAZVGE3kL23bzeoULYv4PeleB3gfmJiDJOKU3Ns5L4KJAUUHjFwDebt0NP+sBK0VKeTATL2Yr/S3bT/xhy+1xtj4RkdV7fVxTn56Lb4udUnwuxK4V5b5PdOKj/+XcwIDAQAB" }
+  let(:t) { :s }
   let(:n) { "A 1024 bit key;" }
 
   subject do
     described_class.new(
       k: k,
       p: p,
+      t: t,
       n: n
     )
   end
@@ -23,12 +25,16 @@ describe Key do
       expect(subject.p).to be p
     end
 
+    it "should set @t" do
+      expect(subject.t).to be t
+    end
+
     it "should set @n" do
       expect(subject.n).to be n
     end
   end
 
-  let(:record) { %{k=#{k};  p=#{p}; n=#{n}} }
+  let(:record) { %{k=#{k};  p=#{p}; t=#{t}; n=#{n}} }
   let(:invalid_record) { "v=spf1" }
 
   describe ".parse!" do
@@ -38,6 +44,22 @@ describe Key do
       it "should return a Key" do
         expect(subject).to be_kind_of(described_class)
       end
+
+      it "should parse k" do
+        expect(subject.k).to be k
+      end
+
+      it "should parse p" do
+        expect(subject.p).to be == p
+      end
+
+      it "should parse t" do
+        expect(subject.t).to be t
+      end
+
+      it "should parse n" do
+        expect(subject.n).to be == n
+      end
     end
 
     context "when parsing an invalid DKIM Key record" do
@@ -78,6 +100,10 @@ describe Key do
       expect(subject[:p]).to be == p
     end
 
+
+    it "should include :t" do
+      expect(subject[:t]).to be == t
+    end
     it "should include :n" do
       expect(subject[:n]).to be == n
     end
@@ -85,7 +111,7 @@ describe Key do
 
   describe "#to_s" do
     it "should return a semicolon deliminited string" do
-      expect(subject.to_s).to be == "k=#{k}; p=#{p}; n=#{n}"
+      expect(subject.to_s).to be == "k=#{k}; p=#{p}; t=#{t}; n=#{n}"
     end
   end
 end

data/spec/parser_spec.rb

@@ -81,7 +81,7 @@ describe Parser do
       it "should parse n=..." do
         expect(subject.parse("n=#{notes}")).to be == {
           name: 'n',
-          value: notes
+          value: {string: notes}
         }
       end
     end
@@ -130,14 +130,14 @@ describe Parser do
       it "should parse t=y" do
         expect(subject.parse('t=y')).to be == {
           name: 't',
-          value: 'y'
+          value: {symbol: 'y'}
         }
       end
 
       it "should parse t=s" do
         expect(subject.parse('t=s')).to be == {
           name: 't',
-          value: 's'
+          value: {symbol: 's'}
         }
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dkim-query
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - nicktitle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-04 00:00:00.000000000 Z
+date: 2015-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parslet