caren-api 0.1.0

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.8.7@api

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+
+gem "i18n"
+gem "active_support"
+gem "builder"
+gem "rest-client"
+
+group :development do
+  gem "bundler"
+  gem "rcov"
+  gem "capybara"
+  gem "rspec"
+  gem "fakeweb", :git => "git://github.com/nedap/fakeweb.git", :branch => "master"
+  gem "jeweler"
+end

data/Gemfile.lock

@@ -0,0 +1,72 @@
+GIT
+  remote: git://github.com/nedap/fakeweb.git
+  revision: c91964160483fa2aeed89945461b50d75b9016b5
+  branch: master
+  specs:
+    fakeweb (1.2.2.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    active_support (3.0.0)
+      activesupport (= 3.0.0)
+    activesupport (3.0.0)
+    builder (3.0.0)
+    capybara (1.1.1)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      selenium-webdriver (~> 2.0)
+      xpath (~> 0.1.4)
+    childprocess (0.2.2)
+      ffi (~> 1.0.6)
+    diff-lcs (1.1.3)
+    ffi (1.0.9)
+    git (1.2.5)
+    i18n (0.6.0)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    json_pure (1.6.1)
+    mime-types (1.16)
+    nokogiri (1.5.0)
+    rack (1.3.5)
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rake (0.8.7)
+    rcov (0.9.11)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.7.0)
+      rspec-core (~> 2.7.0)
+      rspec-expectations (~> 2.7.0)
+      rspec-mocks (~> 2.7.0)
+    rspec-core (2.7.0)
+    rspec-expectations (2.7.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.7.0)
+    rubyzip (0.9.4)
+    selenium-webdriver (2.8.0)
+      childprocess (>= 0.2.1)
+      ffi (>= 1.0.7)
+      json_pure
+      rubyzip
+    xpath (0.1.4)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_support
+  builder
+  bundler
+  capybara
+  fakeweb!
+  i18n
+  jeweler
+  rcov
+  rest-client
+  rspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Andre Foeken
+
+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.rdoc

@@ -0,0 +1,21 @@
+= Caren API reference implementation
+
+This is the reference implementation for the Caren CareProvider API (http://caren-cares.com). 
+To get started you will need a care provider API shared key. Set `Caren::Api.shared_key` to that key.
+Next you will need to set your care provider url `Caren::Api.url` to your specific URL like https://example.caren-cares.com
+
+== Contributing to caren-api
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Andre Foeken. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "caren-api"
+  gem.homepage = "http://github.com/foeken/caren-api"
+  gem.license = "MIT"
+  gem.summary = %Q{Reference implementation of Caren CareProvider API}
+  gem.description = %Q{You can use this gem as inspiration of the base of your connections with Caren.}
+  gem.email = "andre.foeken@nedap.com"
+  gem.authors = ["Andre Foeken"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "caren-api #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/caren-api.gemspec

@@ -0,0 +1,101 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{caren-api}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Andre Foeken"]
+  s.date = %q{2011-10-20}
+  s.description = %q{You can use this gem as inspiration of the base of your connections with Caren.}
+  s.email = %q{andre.foeken@nedap.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".rvmrc",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "caren-api.gemspec",
+    "init.rb",
+    "lib/caren-api.rb",
+    "lib/caren/base.rb",
+    "lib/caren/care_provider.rb",
+    "lib/caren/caren.rb",
+    "lib/caren/error.rb",
+    "lib/caren/event.rb",
+    "lib/caren/external_message.rb",
+    "lib/caren/link.rb",
+    "lib/caren/person.rb",
+    "spec/.DS_Store",
+    "spec/care_provider_spec.rb",
+    "spec/caren_spec.rb",
+    "spec/event_spec.rb",
+    "spec/external_message_spec.rb",
+    "spec/fixtures/bacon.jpg",
+    "spec/fixtures/caren_care_provider_validation.xml",
+    "spec/fixtures/caren_care_providers.xml",
+    "spec/fixtures/caren_care_providers_search.xml",
+    "spec/fixtures/caren_links.xml",
+    "spec/fixtures/caren_links_search.xml",
+    "spec/fixtures/caren_unauthorized.xml",
+    "spec/link_spec.rb",
+    "spec/person_spec.rb",
+    "spec/spec.opts",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/foeken/caren-api}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Reference implementation of Caren CareProvider API}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<i18n>, [">= 0"])
+      s.add_runtime_dependency(%q<active_support>, [">= 0"])
+      s.add_runtime_dependency(%q<builder>, [">= 0"])
+      s.add_runtime_dependency(%q<rest-client>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<capybara>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<fakeweb>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+    else
+      s.add_dependency(%q<i18n>, [">= 0"])
+      s.add_dependency(%q<active_support>, [">= 0"])
+      s.add_dependency(%q<builder>, [">= 0"])
+      s.add_dependency(%q<rest-client>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<capybara>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<fakeweb>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<i18n>, [">= 0"])
+    s.add_dependency(%q<active_support>, [">= 0"])
+    s.add_dependency(%q<builder>, [">= 0"])
+    s.add_dependency(%q<rest-client>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<capybara>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<fakeweb>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+  end
+end
+

data/init.rb

@@ -0,0 +1,4 @@
+require "lib/caren.rb"
+
+Caren::Api.url = "https://www.carenzorgt.nl"
+Caren::Api.shared_key = ""

data/lib/caren/base.rb

@@ -0,0 +1,86 @@
+# The base class for all API objects that can be converted to XML.
+# The class provides basic functionality to convert objects to and from xml based
+# on the default Caren API format.
+class Caren::Base
+  
+  attr_accessor :attributes
+  
+  # Basic initializer, handles quick setting of passed attributes.
+  def initialize args={}
+    self.attributes = {}
+    self.class.keys.each do |key|
+      self.attributes[key] = args[key] || args[key.to_s] || nil
+    end
+  end
+  
+  # List of available attributes for this object
+  def self.keys
+    []
+  end
+  
+  # Root name of the XML array of objects
+  def self.array_root
+    :objects
+  end
+  
+  # Name of each XML if converted to XML
+  def self.node_root
+    :object
+  end
+  
+  # The relative location of this resource.
+  def self.resource_location
+    raise "No resource location found"
+  end
+  
+  # Convert an array of these objects to XML
+  def self.to_xml array
+    array.to_xml( :root => self.array_root )
+  end
+  
+  # Convert a XML string to a single object or an array of objects
+  def self.from_xml xml
+    hash = xml.is_a?(Hash) ? xml : Hash.from_xml(xml)
+    if hash.has_key?(self.array_root.to_s)
+      return hash[self.array_root.to_s].map{ |h| self.from_xml(h) }
+    elsif hash.has_key?(self.node_root)
+      return self.new( hash[self.node_root.to_s] )
+    else
+      return self.new( hash )
+    end
+  end
+  
+  # Convert this object to XML
+  def to_xml options={}
+    self.as_xml.to_xml(options.merge( :root => self.class.node_root ))
+  end
+  
+  # Overridable hash of attributes that is used for converting to XML.
+  def as_xml
+    attributes
+  end
+  
+  # The absolute (constructed url) to the resource.
+  def self.resource_url id=nil
+    "#{Caren::Api.url}#{self.resource_location}#{id}"
+  end
+  
+  def self.search_url key, value
+    "#{self.resource_url}?key=#{key.to_s.dasherize}&value=#{value}"
+  end
+  
+  # The absolute (constructed url) to the resource.
+  def resource_url id=nil
+    self.class.resource_url(id)
+  end
+  
+  private
+  
+  # Method missing calls to enable getters/setters
+  def method_missing args, value=nil
+    return self.attributes[args] if self.class.keys.include?(args)
+    return self.attributes[args] = value if self.class.keys.include?(args.to_s.gsub('=','').to_sym)
+    super
+  end
+  
+end

data/lib/caren/care_provider.rb

@@ -0,0 +1,86 @@
+# The CareProvider class enables the following features:
+# * Update care provider settings
+# * Get a list of care providers
+# * Search for a specific care provider based on key/value
+class Caren::CareProvider < Caren::Base
+      
+  def self.keys
+    [ :caren_id,                    # String (The id of this CP inside Caren)
+      :name,                        # String
+      :telephone,                   # String
+      :website,                     # String
+      :email,                       # String
+      :address_line,                # String (Kerkstraat 1, 7522AH, Enschede)
+      :url_shortcut,                # String
+      :time_zone,                   # String (Amsterdam)
+      :resolution,                  # String (exact,daypart,range)
+      :bandwidth,                   # Integer (60 -> 60 minutes)
+      :show_employee_names,         # Boolean
+      :max_start,                   # String (23:00)
+      :min_start,                   # String (07:00)
+      :show_employee_name_as_title, # Boolean
+      :communication                # Boolean
+    ]
+  end
+    
+  def self.search key, value
+    from_xml Caren::Api.get( self.search_url(key,value) )
+  end
+  
+  def self.all
+    from_xml Caren::Api.get(self.resource_url)
+  end
+  
+  def update
+    Caren::Api.put(self.resource_url(self.caren_id), self.to_xml)
+  end
+  
+  def update_logo logo_hash_or_path
+    Caren::Api.put(self.resource_url(self.caren_id), self.to_logo_xml(logo_hash_or_path))
+  end
+    
+  def as_xml
+    { :name => self.name,
+      :telephone => self.telephone,
+      :website => self.website,
+      :email => self.email,
+      :address_line => self.address_line,
+      :url_shortcut => self.url_shortcut,
+      :time_zone => self.time_zone,
+      :resolution => self.resolution,
+      :bandwidth => self.bandwidth,
+      :min_start => self.min_start,
+      :max_start => self.max_start,
+      :show_employee_name_as_title => self.show_employee_name_as_title,
+      :show_employee_names => self.show_employee_names,
+      :communication => self.communication }
+  end
+  
+  def to_logo_xml logo_hash_or_path
+    builder = Builder::XmlMarkup.new
+    logo = self.class.logo_hash(logo_hash_or_path)
+    xml = builder.care_provider do |care_provider|
+      care_provider.tag!("logo", logo[:content], "name" => logo[:name], "content-type" => logo[:content_type] ) if logo
+    end
+  end
+  
+  def self.logo_hash logo_hash_or_path
+    return logo_hash_or_path if logo_hash_or_path.is_a?(Hash)
+    { :name => File.basename(logo_hash_or_path),
+      :content => Base64.encode64(File.open(logo_hash_or_path).read),
+      :content_type => `file -Ib #{logo_hash_or_path}`.gsub(/\n/,"").split(";")[0] }
+  end
+  
+  def self.resource_location
+    "/api/care_providers/"
+  end
+  
+  def self.array_root
+    :care_providers
+  end
+  
+  def self.node_root
+    :care_provider
+  end
+    
+end

data/lib/caren/caren.rb

@@ -0,0 +1,91 @@
+module Caren
+  
+  module Exceptions
+    
+    class StandardError < ::StandardError ; end
+    
+    class SignatureMismatch < Caren::Exceptions::StandardError ; end
+    
+    class ServerSideError < Caren::Exceptions::StandardError
+      
+      attr_accessor :errors
+      
+      def initialize errors=[]
+        self.errors = errors
+      end
+      
+    end
+    
+  end
+
+  class Api
+    class << self
+      attr_accessor :shared_key
+      attr_accessor :url
+    end
+    
+    def self.put url, xml
+      begin
+        response = RestClient.put url, xml, :content_type => :xml, :accept => :xml, :signature => Caren::Api.sign(xml)
+        return check_signature(response)
+      rescue RestClient::Exception => e
+        handle_error(e.response)
+      end
+    end
+    
+    def self.post url, xml
+      begin
+        response = RestClient.post url, xml, :content_type => :xml, :accept => :xml, :signature => Caren::Api.sign(xml)
+        return check_signature(response)
+      rescue RestClient::Exception => e
+        handle_error(e.response)
+      end
+    end
+    
+    def self.delete url
+      begin
+        response = RestClient.delete url, :content_type => :xml, :accept => :xml, :signature => Caren::Api.sign
+        return check_signature(response)
+      rescue RestClient::Exception => e
+        handle_error(e.response)
+      end
+    end
+    
+    def self.get url
+      begin
+        response = RestClient.get url, :content_type => :xml, :accept => :xml, :signature => Caren::Api.sign
+        return check_signature(response)
+      rescue RestClient::Exception => e
+        handle_error(e.response)
+      end
+    end
+        
+    def self.sign string=""
+      raise "No API key given: Caren::Api.shared_key" unless Caren::Api.shared_key
+      Digest::SHA256.hexdigest(string+Caren::Api.shared_key)
+    end
+    
+    private
+    
+    def self.check_signature response
+      return response if response.headers[:signature] == Caren::Api.sign(response.to_str)
+      raise Caren::Exceptions::SignatureMismatch.new
+    end
+    
+    def self.handle_error response
+      errors = []
+      doc = REXML::Document.new(response)
+      doc.elements.each('errors/error') do |error|
+        if error.attributes["category"] == "validation"
+          attrs  = { :on => error.attributes["on"].to_s.underscore.to_sym }
+          errors << Caren::ValidationError.new( error.attributes["category"], error.text.strip, attrs )
+        else
+          errors << Caren::Error.new( error.attributes["category"], error.text.strip )
+        end
+      end        
+      raise Caren::Exceptions::ServerSideError.new(errors)
+    end
+    
+  end
+
+end

data/lib/caren/error.rb

@@ -0,0 +1,24 @@
+# This class provides a wrapper for caren's server side errors.
+class Caren::Error  
+  
+  attr_accessor :category, :message, :attributes
+  
+  def initialize category, message="", attributes={}
+    self.category = category
+    self.message = message
+    self.attributes = attributes
+  end
+  
+end
+
+class Caren::ValidationError < Caren::Error
+  
+  def field
+    attributes[:on]
+  end
+  
+  def to_s
+    "`#{field}` #{message}"
+  end
+  
+end

data/lib/caren/event.rb

@@ -0,0 +1,28 @@
+# This class is just an intermediate for exporting events to Caren. 
+# It has the correct format for exports. 
+class Caren::Event < Caren::Base
+      
+  def self.keys
+    [ :external_id,       # String Unique identifying string (Your event id)
+      :name,              # String
+      :comment,           # String
+      :start,             # String (14:00)
+      :duration,          # Integer
+      :valid_from,        # Date
+      :valid_to,          # Date
+      :person_first_name, # String
+      :person_last_name,  # String
+      :person_male,       # Boolean
+      :external_person_id # String (Your person id)
+    ]
+  end
+  
+  def self.array_root
+   :events
+  end
+
+  def self.node_root
+   :event
+  end
+    
+end

data/lib/caren/external_message.rb

@@ -0,0 +1,52 @@
+class Caren::ExternalMessage < Caren::Base
+      
+  def self.keys
+    [ :caren_id,            # String (Caren message id) 
+      :person_name,         # String (Andre Foeken)
+      :external_person_id,  # String (Your person id)
+      :body,                # Text
+      :external_id,         # String (Your message id)
+      :in_reply_to_id,      # Integer (Caren message id)
+      :subject_id           # Integer (Caren person id)
+    ]
+  end
+  
+  def create
+    Caren::Api.post self.class.resource_url(self.subject_id), self.to_xml
+  end
+  
+  def delete
+    Caren::Api.delete self.class.resource_url(self.subject_id,self.caren_id)
+  end
+  
+  def self.array_root
+    :external_messages
+  end
+  
+  def self.node_root
+    :external_message
+  end
+  
+  def as_xml
+    { :person_name => self.person_name,
+      :external_person_id => self.external_person_id,
+      :body => self.body,
+      :external_id => self.external_id,
+      :in_reply_to_id => self.in_reply_to_id }
+  end
+  
+  def self.resource_location
+    "/api/people/%i/external_messages/"
+  end
+      
+  private
+
+  def resource_url subject_id, id=nil
+    self.class.resource_url(subject_id,id)
+  end
+  
+  def self.resource_url subject_id, id=nil
+    "#{Caren::Api.url}#{self.resource_location % subject_id}#{id}"
+  end
+    
+end