virginity 0.3.31

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d5ded8c5c157bd494a6ea4644503ec864cdc4e32
+  data.tar.gz: 3b6e0534423dda14a021437c9ca323ef47dd5814
+SHA512:
+  metadata.gz: f4b0415cde8eac73ea8af7c6b67fbbcec313a034a0b895a00df27e5b5516bdbf2e0b721a89b559461c6100395dc968464e1e4b4bee89bb3b66653dd0b96f226d
+  data.tar.gz: 3fe5472499124c8bd04e6647e91d86ef29d8152e9f47f301c8fa622be9c5f07fae01e87be91e891e67c79dda9d25b84ab75f0fdbf1881c3901d848d5b56314cd

data/lib/virginity.rb

@@ -0,0 +1,6 @@
+# V stands for virginity according to http://www.urbandictionary.com/define.php?term=V%20card
+
+require 'active_support/core_ext/string/multibyte.rb'
+require 'virginity/vcard'
+require 'virginity/fixes'
+require 'virginity/vcard/patching'

data/lib/virginity/api_extensions.rb

@@ -0,0 +1,87 @@
+require 'virginity'
+require 'digest/sha1'
+
+
+# FIXME move this to the API
+module Virginity
+  class ContentLine
+
+    # api_id, a SHA1 hash of the whole line
+    def api_id
+      Digest::SHA1.hexdigest(to_s)
+    end
+  end
+end
+
+
+require 'virginity/api_extensions/fields_to_xml'
+
+
+module Virginity
+  class Param
+    def as_json(options = {})
+      { key => value }
+    end
+  end
+
+  module StructuredTextAsJson
+    def as_json(options = {})
+      hash = {}
+      components.each do |c|
+        hash[c.to_s] = send(c)
+      end
+      field_as_json(hash, options)
+    end
+  end
+
+  module SeparatedTextAsJson
+    def as_json(options = {})
+      field_as_json({ :values => [values] }, options)
+    end
+  end
+
+  module Values
+    module Binary
+      def as_json(options = {})
+        field_as_json({ :binary => binary }, options)
+      end
+    end
+  end
+
+  class BaseField < ContentLine
+    def group_and_params_as_json(options = {})
+      { :group => group, :params => params }
+    end
+
+    def field_as_json(hash, options = {})
+      group_and_params_as_json(options).merge(hash).delete_if { |k,v| v.nil? }
+    end
+  end
+
+
+
+  class Email < BaseField
+    def as_json(options = {})
+      field_as_json({ :address => address }, options)
+    end
+  end
+
+  class Tel < BaseField
+    def as_json(options = {})
+      field_as_json({ :number => number }, options)
+    end
+  end
+
+  class Adr < BaseField
+    include StructuredTextAsJson
+  end
+
+  class Name < BaseField
+    include StructuredTextAsJson
+  end
+
+  class Separated < BaseField
+    include SeparatedTextAsJson
+  end
+
+end

data/lib/virginity/api_extensions/fields_to_json.rb

@@ -0,0 +1,82 @@
+module Virginity
+
+  class Email < BaseField
+    def as_json(options = {})
+      { :email => {
+          :id => api_id,
+          :params => params,
+          :address => address
+      }}
+    end
+  end
+
+
+  class Tel < BaseField
+    def as_json(options = {})
+      { :tel => {
+          :id => api_id,
+          :params => params,
+          :number => number
+      }}
+    end
+  end
+
+
+  class Url < BaseField
+    def as_json(options = {})
+      { :url => {
+          :id => api_id,
+          :text => text
+      }}
+    end
+  end
+
+
+  class Adr < BaseField
+    def as_json(options = {})
+      hash = { :adr => {
+          :id => api_id,
+          :params => params,
+      }}
+      components.each do |component|
+        hash[component] = send(component))
+      end
+      hash
+    end
+  end
+
+
+  class Org < BaseField
+    def as_json(options = {})
+      { :org => {
+          :id => api_id,
+          :name => orgname,
+          :unit1 => unit1,
+          :unit2 => unit2
+      }}
+    end
+  end
+
+
+  class Impp < BaseField
+    def as_json(options = {})
+      { :impp => {
+          :id => api_id,
+          :scheme => scheme,
+          :address => address,
+          :text => text
+      }}
+    end
+  end
+
+
+  class Note < BaseField
+    def as_json(options = {})
+      { :note => {
+          :id => api_id,
+          :text => text
+      }}
+    end
+  end
+
+end

data/lib/virginity/api_extensions/fields_to_xml.rb

@@ -0,0 +1,151 @@
+module Virginity
+
+
+  class BaseField < ContentLine
+    def params_to_xml!(params, builder)
+      builder.params(:type => "array") do
+        params.each do |p|
+          builder.tag!(p.key, p.value, :type => "string")
+        end
+      end
+    end
+
+    def extra_fields_to_xml(fields, builder)
+      fields.each_pair { |k,v| builder.tag!(k, v) } unless fields.nil?
+    end
+  end
+
+
+  class BaseField < ContentLine
+    def params_to_xml
+      s = ""
+      unless params.empty?
+        s << "<params>"
+        params.each do |p|
+          s << xml_element(p.key, p.value)
+        end
+        s << "</params>"
+      end
+      s
+    end
+
+#     def params_to_xml
+#       return "" if params.empty?
+#       "<params>#{params.map {|p| xml_element(p.key, p.value) }.join}</params>"
+#     end
+
+    def value_to_xml
+      xml_element(@value, @value.strip)
+    end
+
+    def to_xml
+      s = "<#{name.downcase}>"
+      s << xml_element("group", group) unless group.nil?
+      s << params_to_xml
+      s << value_to_xml
+      s << "</#{name.downcase}>"
+    end
+  end
+
+
+  class Email < BaseField
+    def to_xml(options = {})
+      xml = options[:builder] || Builder::XmlMarkup.new(options)
+      xml.email(:index => api_id ) do
+        xml.id api_id, :type => "string"
+#           params_to_xml!(params, xml)
+        xml.address address
+        extra_fields_to_xml(options[:include], xml)
+      end
+      xml.target!
+    end
+  end
+
+
+  class Tel < BaseField
+    def to_xml(options = {})
+      xml = options[:builder] || Builder::XmlMarkup.new(options)
+      xml.telephone(:index => api_id ) do
+        xml.id api_id, :type => "string"
+#           params_to_xml!(params, xml)
+        xml.number number
+        extra_fields_to_xml(options[:include], xml)
+      end
+      xml.target!
+    end
+  end
+
+
+  class Url < BaseField
+    def to_xml(options = {})
+      xml = options[:builder] || Builder::XmlMarkup.new(options)
+      xml.url(:index => api_id) do
+        xml.id api_id, :type => "string"
+        xml.text text
+        extra_fields_to_xml(options[:include], xml)
+      end
+      xml.target!
+    end
+  end
+
+
+  class Adr < BaseField
+    def to_xml(options = {})
+      xml = options[:builder] || Builder::XmlMarkup.new(options)
+      xml.address(:index => api_id) do
+        xml.id api_id, :type => "string"
+#           params_to_xml!(params, xml)
+        components.each do |component|
+          xml.tag!(component, send(component))
+        end
+        extra_fields_to_xml(options[:include], xml)
+      end
+      xml.target!
+    end
+  end
+
+
+  class Org < BaseField
+    def to_xml(options = {})
+      xml = options[:builder] || Builder::XmlMarkup.new(options)
+      xml.organisation :index => api_id do
+        xml.id api_id, :type => "string"
+        xml.name orgname
+        xml.unit1 unit1
+        xml.unit2 unit2
+        extra_fields_to_xml(options[:include], xml)
+      end
+      xml.target!
+    end
+  end
+
+
+  class Impp < BaseField
+    def to_xml(options = {})
+      xml = options[:builder] || Builder::XmlMarkup.new(options)
+      xml.impp(:index => api_id ) do
+        xml.id api_id, :type => "string"
+        xml.scheme scheme
+        xml.address address
+        xml.value text
+        extra_fields_to_xml(options[:include], xml)
+      end
+      xml.target!
+    end
+  end
+
+
+  class TextField < BaseField
+    def to_xml(options = {})
+      xml = options[:builder] || Builder::XmlMarkup.new(options)
+      xml.note(:index => api_id) do
+        xml.id api_id, :type => "string"
+        xml.text text
+        extra_fields_to_xml(options[:include], xml)
+      end
+      xml.target!
+    end
+  end
+
+
+end

data/lib/virginity/bnf.rb

@@ -0,0 +1,84 @@
+module Virginity
+
+  module Rfc882
+    # rfc822 has a slightly different definition of quoted string compared to rfc2425... it's better
+    QTEXT = /[^\"\\\n]/ # <any CHAR excepting <"> "\" & CR, and including linear-white-space
+    QUOTED_PAIR = /\\./
+    QUOTED_STRING = /(\"((#{QTEXT}|#{QUOTED_PAIR})*)\")/
+  end
+
+
+  module Rfc2234 #:nodoc: # Augmented BNF for Syntax Specifications: ABNF
+    CRLF = /\r\n/
+    DIGIT = /\d/
+    WSP = /\s/ # whitespace
+  end
+
+  module Rfc2425
+  end
+
+  # Contains regular expression strings for the EBNF of rfc 2425.
+  module Bnf #:nodoc:
+    include Rfc882
+    include Rfc2234
+    include Rfc2425
+    # 1*(ALPHA / DIGIT / "-")
+    # added underscore '_' because it's produced by Notes - X-LOTUS-CHILD_UID
+    # added a slash '/' so that it will match lines like: "X-messaging/xmpp-All:someone@gmail.com"
+    # added a space ' ' so that it will match lines like: "X-GOOGLE TALK;TYPE=WORK:janklaassen"
+    NAME    = '[a-zA-Z0-9][a-zA-Z0-9\-\_\/\ ]*'
+
+    # <"> <Any character except CTLs, DQUOTE> <">
+    # CTL         =  <any ASCII control           ; (  0- 37,  0.- 31.)
+    #                 character and DEL>          ; (    177,     127.)
+    # DQOUTE = '"'
+    # QSTR    = '"([^"]*)"'
+    QSTR = QUOTED_STRING # use the definition from rfc822
+
+    # *<Any character except CTLs, DQUOTE, ";", ":", ",">
+    PTEXT   = '([^";:,]+)'
+
+    # param-value = ptext / quoted-string
+    PVALUE  = "(?:#{QSTR}|#{PTEXT})"
+
+    # param = name "=" param-value *("," param-value)
+    PARAM = ";(#{NAME})=((?:#{PVALUE})?(?:,#{PVALUE})*)"
+
+    # V3.0: contentline  =   [group "."]  name *(";" param) ":" value
+    # V2.1: contentline  = *( group "." ) name *(";" param) ":" value
+    #
+    #LINE = "((?:#{NAME}\\.)*)?(#{NAME})([^:]*)\:(.*)"
+    # tcmalloc (used by ree) having memory issues with that one:
+    #LINE = "^((?:#{NAME}\\.)*)?(#{NAME})((?:#{PARAM})*):(.*)$"
+    #LINE = "^((?:#{NAME}\\.)*)?(#{NAME})((?:#{PARAM})*):"
+    # We do not accept the V2.1 syntax.
+    LINE = "^(#{NAME}\\.)?(#{NAME})((?:#{PARAM})*):"
+
+    # date = date-fullyear ["-"] date-month ["-"] date-mday
+    # date-fullyear = 4 DIGIT
+    # date-month = 2 DIGIT
+    # date-mday = 2 DIGIT
+    DATE = '(\d\d\d\d)-?(\d\d)-?(\d\d)'
+
+    # time = time-hour [":"] time-minute [":"] time-second [time-secfrac] [time-zone]
+    # time-hour = 2 DIGIT
+    # time-minute = 2 DIGIT
+    # time-second = 2 DIGIT
+    # time-secfrac = "," 1*DIGIT
+    # time-zone = "Z" / time-numzone
+    # time-numzome = sign time-hour [":"] time-minute
+    TIME = '(\d\d):?(\d\d):?(\d\d)(\.\d+)?(Z|[-+]\d\d:?\d\d)?'
+
+    # integer = (["+"] / "-") 1*DIGIT
+    INTEGER = '[-+]?\d+'
+
+    # QSAFE-CHAR = WSP / %x21 / %x23-7E / NON-US-ASCII
+    #  ; Any character except CTLs and DQUOTE
+    QSAFECHAR = '[ \t\x21\x23-\x7e\x80-\xff]'
+
+    # SAFE-CHAR  = WSP / %x21 / %x23-2B / %x2D-39 / %x3C-7E / NON-US-ASCII
+    #   ; Any character except CTLs, DQUOTE, ";", ":", ","
+    SAFECHAR = '[ \t\x21\x23-\x2b\x2d-\x39\x3c-\x7e\x80-\xff]'
+  end
+
+end

data/lib/virginity/dir_info.rb

@@ -0,0 +1,93 @@
+require 'virginity/bnf'
+require 'virginity/dir_info/line_folding'
+require 'virginity/dir_info/content_line'
+require 'virginity/dir_info/query'
+
+require 'virginity/vcard21/reader'
+
+$KCODE = 'U' unless defined? Encoding::UTF_8
+
+module Virginity
+
+  # see rfc 2425, MIME Content-Type for Directory Information.
+  #
+  # Basically a DirectoryInformation-object is a collection of lines (see ContentLine)
+  class DirectoryInformation
+    include Query
+    extend Virginity::Vcard21::Reader
+    extend Encodings
+    attr_reader :lines
+
+    # decode directory information text
+    # TODO accept an array of lines as the argument, make a special from_string(string="")
+    def initialize(string = "")
+      raise "expected a string but found #{string.inspect}, a #{string.class}" unless string.is_a? String
+      @lines = LineFolding::unfold_and_split(string).map do |line|
+        ContentLine.parse(line)
+      end
+    end
+
+    # string representation
+    def encode
+      LineFolding::fold(unfolded)
+    end
+    alias_method :to_s, :encode
+
+    # replace _all_ lines
+    def lines=(replace_lines)
+      @lines = replace_lines.to_a.map { |line| ContentLine.parse(line.to_s) }
+    end
+
+    def inspect
+      "#<#{self.class}:#{object_id}>"
+    end
+
+    def delete(*lines_to_delete)
+      lines_to_delete.compact.map { |line| lines.delete(line) }.compact
+    end
+
+    # remove only this exact content line identified by its object-id
+    def delete_content_line(cl)
+      lines.delete_if { |line| line.object_id == cl.object_id }
+    end
+
+    # append a line
+    def <<(line)
+      lines << ContentLine.parse(line.to_s)
+    end
+    alias_method :push, :<<
+
+    # string representation that is not folded (see LineFolding)
+    LF = "\n"
+    def unfolded
+      @lines.join(LF) << LF
+    end
+
+    def pretty_print(q)
+      q.text unfolded
+    end
+
+    # equallity is defined as having the same lines
+    def ==(other)
+      return false if other.class != self.class
+      # checking for lines.size is an optimisation
+      @lines.size == other.lines.size and @lines.sort == other.lines.sort
+    end
+
+    # eql? is defined as being of the same class (not a descendent class like Vcard) and having the same lines
+    def eql?(other)
+      self.class == other.class and self == other
+    end
+
+    # are all @lines also present in other?
+    def subset_of?(other)
+      @lines.all? do |line|
+        other.first_match(line.to_s)
+      end
+    end
+
+    def superset_of?(other)
+      other.subset_of?(self)
+    end
+  end
+end