carddav 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f2c463be27a433b0595a26114f0e1955b1bdcb6f
+  data.tar.gz: f2f0f2e518319bf2b0f5be2b1c70624c48b3659f
+SHA512:
+  metadata.gz: e9a8e9814dc1aeacab75bcfb8612afb35a37b82d1a501be47d654c9b769bcb99ae955f3ea64fa24b9758e1ca68c0911f68677d9be882a7959305f9197393eb02
+  data.tar.gz: 26bab95b8342b671f76df28c8762d46845aa764eb6d512780fd80cd0bd5365034139aba3e6b8269b598d57289f5d5d1f21c9e7d2df74543fc3fd18137485d6d2

data/.byebug_history

@@ -0,0 +1,97 @@
+continue
+t.first.parsed
+t.first.name
+t.size
+t = res.xpath('//address-data/text()').map { |node| Carddav::Card.new node }
+res.xpath('//address-data/text()')
+res.css('address-data/text()')
+res.xpath('address-data/text()')
+res
+cont
+req.status
+req
+cont
+url.new el.first.text
+el.first.text
+cont
+continue
+res.xpath('//response/href[following-sibling::propstat/prop/resourcetype/addressbook]')
+res.xpath('//response/href[following-sibling::propstat/prop/resourcetype/addressbook]').size
+res.xpath('//response/href[following-sibling::propstat/prop/resourcetype]').size
+res.xpath('//response/href[following-sibling::propstat]').size
+res.xpath('//response/href[following-sibling::addressbook]').size
+res.xpath('//response/href[following-sibling:://addressbook]').size
+res.xpath('//response/href[following-sibling::addressbook]').size
+res.xpath('//response/href').size
+res.xpath('//response//href').size
+res.xpath('//response//resourcetype//addressbook').size
+res.xpath('//response[boolean(//resourcetype//addressbook)]//href').size
+res.xpath('//response[boolean(//resourcetype//addressbook]//href)').size
+res.xpath('//response[//resourcetype//addressbook]//href').size
+res.xpath('//response[//resourcetype//addressbook]//href')
+res.xpath('//response[//resourcetype//addressbook]//href').first
+el.first.text
+el
+cont
+continue
+res.xpath('//response[//resourcetype//addressbook]//href').first
+res.xpath('//response[//resourcetype//addressbook]//href').class
+res.xpath('//response[//resourcetype//addressbook]//href/text()').size
+res.xpath('//response[//resourcetype//addressbook]//href//text()').size
+res.xpath('//response[//resourcetype//addressbook]//href').size
+res.xpath('//response[//resourcetype//addressbook]//href').
+res.xpath '//response[//resourcetype//addressbook]//href'
+puts res.to_xml
+el.xpath('text()').text
+el.xpath('text()')
+el.xpath(text())
+el
+el.text
+url
+uel
+cont
+continue
+url.new el.text
+el.text
+url
+el
+cont
+el.text
+continue
+url.to_s
+url
+cont
+continue
+puts res
+url
+cont
+continue
+res.remove_namespaces!.css('addressbook-home-set').text
+res.remove_namespaces!.css('addressbook-home-set href').text
+res.remove_namespaces!.css 'addressbook-home-set href'
+res.remove_namespaces!.css 'addressbook-home-set'
+res
+res.xpath 'addressbook-home-set'
+res.css 'addressbook-home-set'
+puts res
+res
+cont
+continue
+url
+puts res
+res.css('addressbook-home-set')
+res.css('addressbook-home-set').first.to_xml
+res.css('addressbook-home-set').first.text
+res.css('addressbook-home-set').first
+res.css('addressbook-home-set').size
+res.css('addressbook-home-set').text
+res.css('addressbook-home-set').children
+res.css('addressbook-home-set').child
+res.css 'addressbook-home-set'
+res.css 'addressbook-home-set > href'
+res.css 'addressbook-home-set href'
+res.css 'addressbook-home-set'
+res
+node_name
+cont
+node_name

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+cache: bundler
+sudo: false
+rvm:
+  - 2.2.4
+before_install: gem install bundler -v 1.11.2
+notifications:
+  email: false

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'pry'
+gem 'guard-rspec'
+gem 'byebug'

data/Guardfile

@@ -0,0 +1,14 @@
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Tim Maslyuchenko
+
+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,83 @@
+# Carddav
+
+[![Build Status](https://travis-ci.org/timsly/carddav.svg?branch=master)](https://travis-ci.org/timsly/carddav)
+
+Ruby implementation for CardDAV protocol.
+
+It supports only getting cards right now.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'carddav'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install carddav
+
+## Usage
+
+Gem was tested with two providers: iCloud and gmx.
+To get contacts from them you need to do following:
+
+```ruby
+service = Carddav.service :gmx, 'email@gmx.net', 'password'
+service.cards
+```
+
+or
+
+```ruby
+service = Carddav.service :apple, 'email@icloud.com', 'password'
+service.cards
+```
+
+Under the hood it uses `Carddav::Client`. It uses standart approach of getting data
+from CardDAV servers.
+
+```ruby
+client = Carddav.client.new 'http://my-carddav-server.org', 'email@mail.net', 'password'
+client.cards
+```
+
+## Discovery process
+
+`Carddav::Client` discovers urls steps by step and than finally tried to get data from `addressbook_url`
+and than parse vcards from response.
+
+Here are all steps:
+
+* getting current_user_principal url
+* getting addressbook_home_set url
+* getting addressbook url
+* getting cards
+
+Sometimes some of the url are static so it can be passed to the client.
+This was we bypass some steps in the discovery process
+
+```ruby
+client = Carddav.client.new 'http://my-carddav-server.org', 'email@mail.net', 'password'
+client.addressbook_url = '/addressbook-url'
+client.cards # will use http://my-carddav-server.org/addressbook-url and get cards from there.
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/timsly/carddav.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new :test
+
+task default: :test

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'carddav'
+
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/carddav.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'carddav/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'carddav'
+  spec.version       = Carddav::VERSION
+  spec.authors       = ['Tim Maslyuchenko']
+  spec.email         = ['insside@gmail.com']
+
+  spec.summary       = 'CardDAV ruby implementation'
+  spec.description   = 'CardDAV ruby implementation'
+  spec.homepage      = 'https://github.com/timsly/carddav'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'curb'
+  spec.add_dependency 'nokogiri'
+  spec.add_dependency 'vcardigan'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_development_dependency 'webmock'
+end

data/lib/carddav.rb

@@ -0,0 +1,39 @@
+require 'curb'
+require 'nokogiri'
+require 'vcardigan'
+
+require 'carddav/version'
+require 'carddav/client'
+require 'carddav/url'
+require 'carddav/card'
+
+module Carddav
+  SERVICES = {
+    apple: 'https://contacts.icloud.com',
+    gmx: { host: 'https://carddav.gmx.net', urls: {
+      current_user_principal: '/CardDavProxy/carddav/user-principal-uri'
+    }}
+  }
+
+  class InvalidResponse < Exception
+    attr_reader :response
+
+    def initialize(msg = nil, response = nil)
+      super msg
+      @response = response
+    end
+  end
+
+  class UnknownService < Exception
+  end
+
+  def self.service(name, username, password)
+    service = SERVICES[name.to_sym] || raise(UnknownService)
+    service = { host: service } unless service.is_a? Hash
+    client = Client.new service[:host], username, password
+    Array(service[:urls]).each do |key, value|
+      client.public_send "#{key}_url=", value
+    end
+    client
+  end
+end

data/lib/carddav/card.rb

@@ -0,0 +1,31 @@
+class Carddav::Card
+  attr_reader :raw, :parsed
+
+  def self.normalize(data)
+    data.to_s.gsub '&#13', ''
+  end
+
+  def initialize(data)
+    @raw = data.to_s
+    @parsed = VCardigan.parse self.class.normalize(data)
+  end
+
+  def name
+    vcard_field :fn
+  end
+
+  def email
+    vcard_field :email
+  end
+
+  def image
+    vcard_field :photo
+  end
+
+  private
+
+  def vcard_field(name)
+    field = parsed.send name.to_s
+    field && field.first && field.first.values.join
+  end
+end

data/lib/carddav/client.rb

@@ -0,0 +1,84 @@
+class Carddav::Client
+  NAMESPACES = { 'xmlns:D' => 'DAV:', 'xmlns:C' => 'urn:ietf:params:xml:ns:carddav' }
+
+  attr_reader :host, :username, :password, :current_user_principal_url,
+    :addressbook_home_set_url, :addressbook_url
+
+  def initialize(host, username, password)
+    @host = Carddav::Url.new host
+    @username = username
+    @password = password
+  end
+
+  def current_user_principal_url=(url)
+    @current_user_principal_url = host.new url
+  end
+
+  def addressbook_home_set_url=(url)
+    @addressbook_home_set_url = host.new url
+  end
+
+  def addressbook_url=(url)
+    @addressbook_url = host.new url
+  end
+
+  def current_user_principal_url
+    @current_user_principal_url ||= find_href host, 'D:current-user-principal'
+  end
+
+  def addressbook_home_set_url
+    @addressbook_home_set_url ||= find_href current_user_principal_url, 'C:addressbook-home-set'
+  end
+
+  def addressbook_url
+    @addressbook_url ||= find_href addressbook_home_set_url, 'D:resourcetype', 1 do |xml|
+      xml.xpath '//response/href[following-sibling::propstat/prop/resourcetype/addressbook]'
+    end
+  end
+
+  def cards
+    res = request addressbook_url, method: 'REPORT', depth: 1 do
+      Nokogiri::XML::Builder.new do |xml|
+        xml['C'].send 'addressbook-query', NAMESPACES do
+          xml['D'].prop do
+            xml['D'].getetag
+            xml['C'].send 'address-data'
+          end
+        end
+      end.to_xml
+    end
+    res.xpath('//address-data/text()').map { |node| Carddav::Card.new node }
+  end
+
+  private
+
+  def request(url, method: 'PROPFIND', depth: 0)
+    req = Curl::Easy.perform url.to_s do |c|
+      c.headers['Content-Type'] = 'application/xml'
+      c.headers['Depth'] = depth
+      c.userpwd = "#{username}:#{password}"
+      c.set :customrequest, method
+      c.set :postfields, yield if block_given?
+    end
+    if (status = /^(\d+)/.match(req.status)[0].to_i) && (status < 200 || status >= 300)
+      raise Carddav::InvalidResponse, "Invalid response from #{url}", req.body_str
+    end
+    Nokogiri::XML(req.body_str).remove_namespaces!
+  end
+
+  def find_href(url, node, depth = 0)
+    namespece, node_name = node.split ':'
+    res = request url, depth: depth do
+      Nokogiri::XML::Builder.new do |xml|
+        xml['D'].propfind NAMESPACES do
+          xml['D'].prop do
+            xml[namespece].send node_name
+          end
+        end
+      end.to_xml
+    end
+    el = block_given? ? yield(res) : res.css("#{node_name} href")
+    raise Carddav::InvalidResponse, "Cannot find #{node_name} node", res.to_xml if el.empty?
+    url.new el.first.text
+  end
+end

data/lib/carddav/url.rb

@@ -0,0 +1,16 @@
+class Carddav::Url
+  def initialize(uri)
+    @uri = URI uri
+  end
+
+  def new(path)
+    return self.class.new path if /^https?:\/\// =~ path
+    uri = @uri.dup
+    uri.path = path.start_with?('/') ? path : "/#{path}"
+    self.class.new uri
+  end
+
+  def to_s
+    @uri.to_s
+  end
+end

data/lib/carddav/version.rb

@@ -0,0 +1,3 @@
+module Carddav
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: carddav
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tim Maslyuchenko
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: curb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcardigan
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: CardDAV ruby implementation
+email:
+- insside@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".byebug_history"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- carddav.gemspec
+- lib/carddav.rb
+- lib/carddav/card.rb
+- lib/carddav/client.rb
+- lib/carddav/url.rb
+- lib/carddav/version.rb
+homepage: https://github.com/timsly/carddav
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: CardDAV ruby implementation
+test_files: []