vcard_parser 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+*.rbc
+.bundle
+Gemfile.lock
+coverage/
+doc/

data/.travis.yml

@@ -0,0 +1,4 @@
+bundler_args: --without development
+rvm:
+  - 1.9.3
+

data/Gemfile

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake'
+
+group(:development) do
+  gem 'simplecov'
+  gem 'guard-bacon',    '~> 1.1.0'
+  gem 'rb-fsevent'
+  gem 'growl'
+end
+
+group(:test) do
+  gem 'schmurfy-bacon', '~> 1.4.2'
+  gem 'mocha',          '~> 0.10.0'
+end

data/Guardfile

@@ -0,0 +1,8 @@
+
+# parameters:
+#  output     => the formatted to use
+#  backtrace  => number of lines, nil =  everything
+guard 'bacon', :output => "BetterOutput", :backtrace => nil do
+  watch(%r{^lib/vcard_parser/(.+)\.rb$})     { |m| "specs/unit/#{m[1]}_spec.rb" }
+  watch(%r{specs/.+\.rb$})
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Julien Ammous
+
+MIT License
+
+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.md

@@ -0,0 +1,36 @@
+
+# What ?
+
+This is a vCard parser/generator released under te MIT license
+
+# Support
+For now only v3.0 is supported and the testing was done mostly with Apple
+Addressbook and iOS contacts.
+
+# Continuous integration ([![Build Status](https://secure.travis-ci.org/schmurfy/vcard_parser.png)](https://secure.travis-ci.org/schmurfy/vcard_parser.png))
+
+This gem is tested against these ruby by travis-ci.org:
+
+- mri 1.9.3
+
+# Usage
+
+```ruby
+require 'vcard_parser'
+
+cards = VCardParser:parse(...)
+
+puts cards[0].fields
+puts cards[0]['N']
+
+# dump back the vcard
+puts cards[0].to_s
+```
+
+# Setting up development environmeent
+
+```bash
+# clone the repository and:
+$ bundle
+$ bundle exec guard
+```

data/Rakefile

@@ -0,0 +1,21 @@
+require 'rubygems'
+require 'bundler/setup'
+require "bundler/gem_tasks"
+
+task :default => :test
+
+task :test do
+  require 'bacon'
+  
+  # do not generate coverage report from travis
+  unless ENV['TRAVIS']
+    ENV['COVERAGE'] = "1"
+  end
+  
+  Dir[File.expand_path('../specs/**/*_spec.rb', __FILE__)].each do |file|
+    puts "File: #{file}:"
+    load(file)
+  end
+  
+end
+

data/lib/vcard_parser.rb

@@ -0,0 +1,4 @@
+require_relative 'vcard_parser/version'
+require_relative 'vcard_parser/vcard'
+
+require_relative 'vcard_parser/3.0/field'

data/lib/vcard_parser/3.0/field.rb

@@ -0,0 +1,83 @@
+require 'time'
+
+module VCardParser
+  module V30
+    
+    class Field
+      attr_reader :name, :group, :value, :params
+      
+      FORMAT = /^
+          (?:(?<group>[a-zA-Z0-9-]+)\.)?
+          (?<name>[a-zA-Z-]+)
+          (?<params> (?:;[A-Za-z]+=[^;]+)+ )?
+          :(?<value>.*)
+        $/x
+      
+      def initialize(name, value, group = nil, params = {})
+        @name = name
+        @group = group
+        @value = convert_value(value)
+        @params = params
+      end
+      
+      def full_name
+        ret = ""
+        ret << "#{@group}." if group
+        ret << @name
+        ret
+      end
+      
+      def self.parse(line)
+        m = FORMAT.match(line.strip)
+        if m
+          params = {}
+          if m[:params]
+            m[:params].split(';').reject{|s| s.empty? }.each do |p|
+              pname, pvalue = p.split('=')
+              params[pname] ||= []
+              params[pname] << pvalue
+            end
+          end
+          
+          new(m[:name], m[:value], m[:group], params)
+        else
+          raise MalformedInput, line
+        end
+      end
+      
+      def to_s
+        ret = full_name
+                
+        @params.each do |name, values|
+          values.each do |v|
+            ret << ";#{name}=#{v}"
+          end
+        end
+        
+        ret << ":#{dump_value(value)}"
+        
+        ret
+      end
+          
+    private
+      def convert_value(value)
+        case name
+        when "REV", "BDAY"  then Time.parse(value)
+        else
+          value
+        end
+      end
+      
+      def dump_value(value)
+        case name
+        when "REV"    then value.iso8601
+        when "BDAY"   then value.strftime("%Y-%m-%d")
+        else
+          value
+        end
+      end
+      
+    end
+    
+  end
+end

data/lib/vcard_parser/vcard.rb

@@ -0,0 +1,93 @@
+module VCardParser
+  ParsingError = Class.new(RuntimeError)
+  
+  UnsupportedVersion = Class.new(ParsingError)
+  MalformedInput = Class.new(ParsingError)
+  
+  class VCard
+    attr_reader :version, :fields
+    
+    VCARD_FORMAT = /
+        BEGIN:VCARD\s+
+        (.+?)
+        END:VCARD\s*
+      /xm
+    
+    def initialize(version, fields = [])
+      @version = version
+      @fields = fields
+    end
+    
+    def self.parse(data)
+      data.scan(VCARD_FORMAT).map do |vcard_data|
+        # fetch the version to choose the correct parser
+        lines = vcard_data[0].each_line.map(&:strip)
+                
+        key, version = lines[0].split(':')
+        if key != "VERSION"
+          raise MalformedInput, "VERSION expected, got #{key}"
+        end
+        
+        # remove begin and version
+        lines.slice!(0, 1)
+        
+        new(version).tap do |card|
+          lines.each do |line|
+            card.add_field_from_string(line)
+          end
+        end
+        
+      end
+    end
+    
+    def add_field_from_string(line)
+      f = field_class.parse(line)
+      @fields << f
+    end
+    
+    def add_field(*args)
+      f = field_class.new(*args)
+      @fields << f
+    end
+    
+    def values(key, group = nil)
+      @fields.select do |f|
+        (f.name == key) &&
+        (!group || (f.group == group))
+      end
+    end
+    
+    def [](key, group = nil)
+      v = values(key, group)
+      v.empty? ? nil : v[0]
+    end
+    
+    def each_field(&block)
+      @fields.each(&block)
+    end
+    
+    def vcard
+      ret = ["BEGIN:VCARD", "VERSION:#{@version}"]
+      
+      @fields.each do |f|
+        ret << f.to_s
+      end
+      
+      ret << "END:VCARD\n"
+      ret.join("\n")
+    end
+    
+    alias :to_s :vcard
+  
+  
+  private
+    def field_class
+      @field_class ||= case version
+        when '3.0'  then V30::Field
+        else
+          raise UnsupportedVersion, version
+      end
+    end
+        
+  end
+end

data/lib/vcard_parser/version.rb

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

data/specs/data/two_vcard3.0.vcf

@@ -0,0 +1,21 @@
+BEGIN:VCARD
+VERSION:3.0
+PRODID:-//Apple Inc.//iOS 5.0.1//EN
+N:Durand;Christophe;;;
+FN:Christophe Durand
+ORG:Op;
+item1.TEL;type=pref:2 56 38 54
+item2.TEL;type=pref:5 66
+TEL;type=CELL;type=VOICE:3 55
+item2.ADR;type=HOME;type=pref:;;3 rue du chat;Dris;;90880;FRANCE
+BDAY;value=date:1900-01-01
+REV:2012-10-31T16:08:22Z
+UID:11
+END:VCARD
+END:VCARD
+BEGIN:VCARD
+VERSION:3.0
+N:Jean;René;;;
+FN:Jean René
+UID:12
+END:VCARD

data/specs/data/vcard2.1.vcf

@@ -0,0 +1,15 @@
+BEGIN:VCARD
+VERSION:2.1
+N:Gump;Forrest
+FN:Forrest Gump
+ORG:Bubba Gump Shrimp Co.
+TITLE:Shrimp Man
+TEL;WORK;VOICE:(111) 555-1212
+TEL;HOME;VOICE:(404) 555-1212
+ADR;WORK:;;100 Waters Edge;Baytown;LA;30314;United States of America
+LABEL;WORK;ENCODING=QUOTED-PRINTABLE:100 Waters Edge=0D=0ABaytown, LA 30314=0D=0AUnited States of America
+ADR;HOME:;;42 Plantation St.;Baytown;LA;30314;United States of America
+LABEL;HOME;ENCODING=QUOTED-PRINTABLE:42 Plantation St.=0D=0ABaytown, LA 30314=0D=0AUnited States of America
+EMAIL;PREF;INTERNET:forrestgump@example.com
+REV:20080424T195243Z
+END:VCARD

data/specs/data/vcard3.0.vcf

@@ -0,0 +1,14 @@
+BEGIN:VCARD
+VERSION:3.0
+PRODID:-//Apple Inc.//iOS 5.0.1//EN
+N:Durand;Christophe;;;
+FN:Christophe Durand
+ORG:Op;
+item1.TEL;type=pref:2 56 38 54
+item2.TEL;type=pref:5 66
+TEL;type=CELL;type=VOICE:3 55
+item2.ADR;type=HOME;type=pref:;;3 rue du chat;Dris;;90880;FRANCE
+BDAY;value=date:1900-01-01
+REV:2012-10-31T16:08:22Z
+UID:11
+END:VCARD

data/specs/spec_helper.rb

@@ -0,0 +1,25 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'bacon'
+
+if ENV['COVERAGE']
+  Bacon.allow_focused_run = false
+  
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter ".*_spec"
+    add_filter "/helpers/"
+  end
+  
+end
+
+$LOAD_PATH.unshift( File.expand_path('../../lib' , __FILE__) )
+require 'vcard_parser'
+
+# require 'bacon/ext/mocha'
+# require 'bacon/ext/em'
+
+# Thread.abort_on_exception = true
+
+Bacon.summary_on_exit()

data/specs/unit/3.0/field_spec.rb

@@ -0,0 +1,76 @@
+require_relative '../../spec_helper'
+
+describe 'Field 3.0' do
+  should 'parse grouped field' do
+    f = VCardParser::V30::Field.parse("item1.TEL;type=pref:1 24 54 36")
+    f.group.should == "item1"
+    f.name.should == "TEL"
+    f.value.should == "1 24 54 36"
+    f.params.should == {'type' => ['pref']}
+    
+    f.full_name.should == "item1.TEL"
+  end
+  
+  should 'parse empty field' do
+    f = VCardParser::V30::Field.parse("FN:")
+    f.group.should == nil
+    f.name.should == "FN"
+    f.value.should == ""
+    f.params.should == {}
+  end
+  
+  should 'parse extension field' do
+    f = VCardParser::V30::Field.parse("X-ABShowAs:COMPANY")
+    f.group.should == nil
+    f.name.should == "X-ABShowAs"
+    f.value.should == "COMPANY"
+    f.params.should == {}
+  end
+  
+  should 'parse simple line' do
+    f = VCardParser::V30::Field.parse("PRODID:-//Apple Inc.//Mac OS X 10.8.2//EN")
+    f.group.should == nil
+    f.name.should == "PRODID"
+    f.value.should == "-//Apple Inc.//Mac OS X 10.8.2//EN"
+    f.params.should == {}
+  end
+  
+  should 'parse dat field' do
+    f = VCardParser::V30::Field.parse("REV:2012-10-29T21:23:09Z")
+    f.group.should == nil
+    f.name.should == "REV"
+    f.value.should == Time.parse("2012-10-29T21:23:09Z")
+    f.params.should == {}
+  end
+  
+  should 'parse line with parameters' do
+    f = VCardParser::V30::Field.parse("TEL;type=WORK;type=VOICE;type=pref:1234")
+    f.group.should == nil
+    f.name.should == "TEL"
+    f.value.should == "1234"
+    f.params.should == {
+      'type' => %w(WORK VOICE pref)
+    }
+  end
+  
+  should 'generate vcf line from data' do
+    line = "TEL;type=WORK;type=VOICE;type=pref:1234"
+    f = VCardParser::V30::Field.parse(line)
+    f.to_s.should == line
+  end
+  
+  should 'generate vcf line from converted data' do
+    line = "REV:2012-10-29T21:23:09Z"
+    f = VCardParser::V30::Field.parse(line)
+    f.to_s.should == line
+  end
+  
+  should 'generate vcf line from data with group' do
+    line = "item1.TEL;type=pref:1 24 54 36"
+    f = VCardParser::V30::Field.parse(line)
+    f.to_s.should == line
+  end
+
+
+  
+end

data/specs/unit/vcard_spec.rb

@@ -0,0 +1,190 @@
+# encoding: utf-8
+require_relative '../spec_helper'
+
+def data_path(path)
+  File.expand_path(File.join(
+      File.expand_path('../../data', __FILE__),
+      path
+    ))
+end
+
+def data_file(path)
+  File.read( data_path(path) )
+end
+
+describe 'VCard' do
+  
+  should 'add a new field without parameters' do
+    v = VCardParser::VCard.new("3.0")
+    v.add_field("N", "Georges")
+    
+    v['N'].value.should == 'Georges'
+  end
+  
+  describe 'vCard 3.0' do
+    should 'parse simple card' do
+      vcards = VCardParser::VCard.parse( data_file('vcard3.0.vcf') )
+      vcards.size.should == 1
+      
+      vcards[0].version.should == "3.0"
+      vcards[0]["PRODID"].value.should == "-//Apple Inc.//iOS 5.0.1//EN"
+      vcards[0]["N"].value.should == "Durand;Christophe;;;"
+      vcards[0]["FN"].value.should == "Christophe Durand"
+      vcards[0]["UID"].value.should == "11"
+    end
+    
+    should 'parse multiple cards' do
+      vcards = VCardParser::VCard.parse( data_file('two_vcard3.0.vcf') )
+      vcards.size.should == 2
+      
+      vcards[0].version.should == "3.0"
+      vcards[0]["PRODID"].value.should == "-//Apple Inc.//iOS 5.0.1//EN"
+      vcards[0]["N"].value.should == "Durand;Christophe;;;"
+      vcards[0]["FN"].value.should == "Christophe Durand"
+      vcards[0]["UID"].value.should == "11"
+      
+      
+      vcards[1].version.should == "3.0"
+      vcards[1]["N"].value.should == "Jean;René;;;"
+      vcards[1]["FN"].value.should == "Jean René"
+      vcards[1]["UID"].value.should == "12"
+    end
+    
+    should 'enumerate attributes' do
+      vcards = VCardParser::VCard.parse( data_file('vcard3.0.vcf') )
+      vcards.size.should == 1
+      
+      attrs = []
+      
+      vcards[0].each_field do |a|
+        attrs << a
+      end
+      
+      attrs.size.should == 11
+    end
+    
+    should 'enumerate attributes' do
+      vcards = VCardParser::VCard.parse( data_file('vcard3.0.vcf') )
+      vcards.size.should == 1
+      
+      attrs = []
+      
+      vcards[0].each_field.sort_by(&:name).each do |a|
+        attrs << a
+      end
+      
+      attrs[0].tap do |a|
+        a.group.should == "item2"
+        a.name.should == "ADR"
+        a.value.should == ";;3 rue du chat;Dris;;90880;FRANCE"
+        a.params.should == {'type' => ['HOME', 'pref']}
+      end
+      
+      attrs[1].tap do |a|
+        a.name.should == "BDAY"
+        a.value.should == Time.parse('1900-01-01')
+        a.params.should == {'value' => ['date']}
+      end
+
+      
+      attrs[2].tap do |a|
+        a.name.should == "FN"
+        a.value.should == "Christophe Durand"
+        a.params.should == {}
+      end
+      
+      attrs[3].tap do |a|
+        a.name.should == "N"
+        a.value.should == "Durand;Christophe;;;"
+        a.params.should == {}
+      end
+      
+      attrs[4].tap do |a|
+        a.name.should == "ORG"
+        a.value.should == "Op;"
+        a.params.should == {}
+      end
+
+      
+      attrs[5].tap do |a|
+        a.name.should == "PRODID"
+        a.value.should == "-//Apple Inc.//iOS 5.0.1//EN"
+        a.params.should == {}
+      end
+
+      attrs[6].tap do |a|
+        a.name.should == "REV"
+        a.value.should == Time.parse("2012-10-31T16:08:22Z")
+        a.params.should == {}
+      end
+      
+      attrs[7].tap do |a|
+        a.group.should == nil
+        a.name.should == "TEL"
+        a.value.should == "3 55"
+        a.params.should == {'type' => %w(CELL VOICE)}
+      end
+      
+      attrs[8].tap do |a|
+        a.group.should == "item1"
+        a.name.should == "TEL"
+        a.value.should == "2 56 38 54"
+        a.params.should == {'type' => %w(pref)}
+      end
+      
+      attrs[9].tap do |a|
+        a.group.should == "item2"
+        a.name.should == "TEL"
+        a.value.should == "5 66"
+        a.params.should == {'type' => %w(pref)}
+      end
+
+
+      attrs[10].tap do |a|
+        a.name.should == "UID"
+        a.value.should == "11"
+        a.params.should == {}
+      end
+      
+    end
+    
+    should "raise an error if version is not supported" do
+      ->{
+        VCardParser::VCard.parse( data_file('vcard2.1.vcf') )
+        }.should.raise(VCardParser::UnsupportedVersion)
+    end
+    
+    
+    should 'parse and rebuild a full vcard' do
+      vcard_data = <<-EOS
+BEGIN:VCARD
+VERSION:3.0
+PRODID:-//Apple Inc.//iOS 5.0.1//EN
+N:Durand;Christophe;;;
+FN:Christophe Durand
+ORG:Op;
+item1.TEL;type=pref:2 56 38 54
+item2.TEL;type=pref:5 66
+TEL;type=CELL;type=VOICE:3 55
+item2.ADR;type=HOME;type=pref:;;3 rue du chat;Dris;;90880;FRANCE
+BDAY;value=date:1900-01-01
+REV:2012-10-31T16:08:22Z
+UID:12
+END:VCARD
+      EOS
+      
+      cards = VCardParser::VCard.parse(vcard_data)
+      cards.size.should == 1
+      cards[0]['TEL', 'item1'].value.should == '2 56 38 54'
+      cards[0].to_s.should == vcard_data
+    end
+
+    should 'generate vcard from data' do
+      data = data_file('vcard3.0.vcf')
+      vcard = VCardParser::VCard.parse(data).first
+      vcard.vcard.should == data
+      vcard.to_s.should == data
+    end
+  end
+  
+end

data/vcard_parser.gemspec

@@ -0,0 +1,16 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/vcard_parser/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Julien Ammous"]
+  gem.email         = ["schmurfy@gmail.com"]
+  gem.description   = %q{A vCard parser}
+  gem.summary       = %q{A simple vCard parser}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.name          = "vcard_parser"
+  gem.require_paths = ["lib"]
+  gem.version       = VcardParser::VERSION
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: vcard_parser
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Julien Ammous
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-02 00:00:00.000000000 Z
+dependencies: []
+description: A vCard parser
+email:
+- schmurfy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/vcard_parser.rb
+- lib/vcard_parser/3.0/field.rb
+- lib/vcard_parser/vcard.rb
+- lib/vcard_parser/version.rb
+- specs/data/two_vcard3.0.vcf
+- specs/data/vcard2.1.vcf
+- specs/data/vcard3.0.vcf
+- specs/spec_helper.rb
+- specs/unit/3.0/field_spec.rb
+- specs/unit/vcard_spec.rb
+- vcard_parser.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4310828650863439750
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4310828650863439750
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A simple vCard parser
+test_files: []