caren-api 0.1.0

data/lib/caren/link.rb

@@ -0,0 +1,43 @@
+class Caren::Link < Caren::Base
+      
+  def self.keys
+    [:person_name,    # String (Caren person name)
+     :person_id,      # String (Caren person id)
+     :person_photo,   # String (url of photo)
+     :patient_number, # String (12345)
+     :external_id,    # String (Your person id)
+     :status          # String (pending,confirmed,cancelled)
+    ]
+  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
+  
+  # Request to create a new link. Example:
+  # Caren::Link.new( :patient_number => 1234 ).create
+  def create
+    Caren::Api.post(self.resource_url, self.to_xml)
+  end
+
+  def as_xml
+    { :patient_number => self.patient_number }
+  end
+  
+  def self.array_root
+    :links
+  end
+  
+  def self.node_root
+    :link
+  end
+  
+  def self.resource_location
+    "/api/links/"
+  end
+        
+end

data/lib/caren/person.rb

@@ -0,0 +1,25 @@
+class Caren::Person < Caren::Base
+    
+  def self.keys
+    [ :external_id,     # String (Your person id)
+      :uid,             # String (Customer unique code)
+      :first_name,      # String
+      :last_name,       # String
+      :male,            # Boolean
+      :date_of_birth,   # Date
+      :address_street,  # String
+      :address_zipcode, # String
+      :address_city,    # String
+      :address_country  # String
+    ]
+  end
+  
+  def self.array_root
+    :people
+  end
+  
+  def self.node_root
+    :person
+  end
+  
+end

data/lib/caren-api.rb

@@ -0,0 +1,25 @@
+require "digest/sha2"
+require "uri"
+require "net/https"
+
+begin
+  require "rubygems"
+rescue LoadError
+end
+
+require "active_support"
+require "active_support/secure_random"
+require "active_support/core_ext"
+require "builder"
+require "rest_client"
+require "rexml/document"
+require "base64"
+
+require "lib/caren/caren.rb"
+require "lib/caren/error.rb"
+require "lib/caren/base.rb"
+require "lib/caren/event.rb"
+require "lib/caren/person.rb"
+require "lib/caren/care_provider.rb"
+require "lib/caren/external_message.rb"
+require "lib/caren/link.rb"

data/spec/care_provider_spec.rb

@@ -0,0 +1,107 @@
+require 'spec_helper'
+
+describe "CareProvider", "converting to xml" do
+    
+  before do
+    @care_provider_a = Caren::CareProvider.new( :name => "Zuwe",
+      :telephone => "112",
+      :website => "http://www.zuwe.nl",
+      :email => "zuwe@example.com",
+      :address_line => "Sesamestreet 1",
+      :url_shortcut => "zuwe",
+      :time_zone => "Amsterdam",
+      :resolution => "exact",
+      :bandwidth => "0",
+      :min_start => "07:00",
+      :max_start => "00:00",
+      :show_employee_name_as_title => true,
+      :show_employee_names => true,
+      :communication => true )
+    
+    @care_provider_b = Caren::CareProvider.new( :name => "Aveant",
+      :telephone => "112",
+      :website => "http://www.aveant.nl",
+      :email => "aveant@example.com",
+      :address_line => "Sesamestreet 1",
+      :url_shortcut => "zuwe",
+      :time_zone => "Amsterdam",
+      :resolution => "exact",
+      :bandwidth => "0",
+      :min_start => "07:00",
+      :max_start => "00:00",
+      :show_employee_name_as_title => true,
+      :show_employee_names => true,
+      :communication => true )    
+  end
+  
+  it "should be able to convert a person to valid xml" do
+    @care_provider_a.should convert_to_valid_caren_xml
+  end
+  
+  it "should be able to convert an array of people to valid xml" do
+    [@care_provider_a,@care_provider_b].should convert_to_valid_caren_array_xml
+  end
+  
+  it "should be able to generate a proper xml file to update the logo" do
+    filename = "spec/fixtures/bacon.jpg"
+    xml = @care_provider_a.to_logo_xml filename
+    doc = REXML::Document.new(xml)
+    doc.elements.each('care_provider/logo') do |cp|
+      cp.attributes["name"].should == "bacon.jpg"
+      cp.attributes["content-type"].should == "image/jpeg"
+      cp.text.should == Base64.encode64(File.open(filename).read)
+    end
+  end
+  
+end
+
+describe "CareProvider" do
+  
+  it "should be able to convert a image file path to a hash suited for xml conversion" do
+    filename = "spec/fixtures/bacon.jpg"
+    logo = Caren::CareProvider.logo_hash( filename )
+    logo[:content_type].should == "image/jpeg"
+    logo[:name].should == "bacon.jpg"
+    logo[:content].should == Base64.encode64(File.open(filename).read)
+  end
+    
+end
+
+describe "CareProvider", "REST methods" do
+  
+  before do
+    care_providers = File.read("spec/fixtures/caren_care_providers.xml")
+    care_providers_search = File.read("spec/fixtures/caren_care_providers_search.xml")
+    FakeWeb.register_uri(:put, Caren::CareProvider.resource_url(1), :signature => Caren::Api.sign )
+    
+    FakeWeb.register_uri(:get, Caren::CareProvider.resource_url, :body => care_providers, 
+                                                                 :signature => Caren::Api.sign(care_providers) )
+                                                             
+    FakeWeb.register_uri(:get, "#{Caren::CareProvider.resource_url}?key=url-shortcut&value=pantein", 
+                                                                 :body => care_providers_search, 
+                                                                 :signature => Caren::Api.sign(care_providers_search) )
+  end
+  
+  it "should be able to update a care provider" do
+    lambda{ Caren::CareProvider.new( :caren_id => 1, :name => "Test" ).update }.should_not raise_error
+  end
+  
+  it "should be able to update the logo for a care provider" do
+    lambda{ Caren::CareProvider.new( :caren_id => 1 ).update_logo( "spec/fixtures/bacon.jpg" ) }.should_not raise_error
+  end
+  
+  it "should be able to search for a specific care provider" do
+    care_providers = Caren::CareProvider.search :url_shortcut, "pantein"
+    care_providers.should have(1).things
+    care_providers.first.name.should == "Pantein"
+    care_providers.first.url_shortcut.should == "pantein"
+  end
+  
+  it "should be able to find all care providers" do
+    care_providers = Caren::CareProvider.all
+    care_providers.should have(2).things
+    care_providers.first.name.should == "Demo"
+    care_providers.first.url_shortcut.should == "demo"
+  end
+    
+end

data/spec/caren_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+describe "Caren", "signature checks" do
+  
+  before do
+    @incorrect_url = "#{Caren::Api.url}/test_with_incorrect_signature"
+    @correct_url   = "#{Caren::Api.url}/test_with_correct_signature"
+    @error_url     = "#{Caren::Api.url}/test_with_errors"
+    
+    FakeWeb.register_uri(:get, @incorrect_url, :body => "TEST", :signature => "[INCORRECT]" )
+    FakeWeb.register_uri(:post, @incorrect_url, :body => "TEST", :signature => "[INCORRECT]" )
+    FakeWeb.register_uri(:put, @incorrect_url, :body => "TEST", :signature => "[INCORRECT]" )
+    FakeWeb.register_uri(:delete, @incorrect_url, :body => "TEST", :signature => "[INCORRECT]" )
+    
+    FakeWeb.register_uri(:get, @correct_url, :body => "TEST", :signature => Caren::Api.sign("TEST") )
+    FakeWeb.register_uri(:post, @correct_url, :body => "TEST", :signature => Caren::Api.sign("TEST") )
+    FakeWeb.register_uri(:put, @correct_url, :body => "TEST", :signature => Caren::Api.sign("TEST") )
+    FakeWeb.register_uri(:delete, @correct_url, :body => "TEST", :signature => Caren::Api.sign("TEST") )
+    
+    errors = File.read "spec/fixtures/caren_care_provider_validation.xml"
+    unauth = File.read "spec/fixtures/caren_unauthorized.xml"  
+    FakeWeb.register_uri(:get, @error_url, :status => 406, :body => errors, :signature => Caren::Api.sign(errors) )
+    FakeWeb.register_uri(:post, @error_url, :status => 406, :body => errors, :signature => Caren::Api.sign(errors) )
+    FakeWeb.register_uri(:put, @error_url, :status => 406, :body => errors, :signature => Caren::Api.sign(errors) )
+    FakeWeb.register_uri(:delete, @error_url, :status => 403, :body => unauth, :signature => Caren::Api.sign(unauth) )
+  end
+    
+  it "should not accept result swith an incorrect signature" do
+    lambda{ Caren::Api.get @incorrect_url }.should raise_error
+    lambda{ Caren::Api.post @incorrect_url, "" }.should raise_error
+    lambda{ Caren::Api.put @incorrect_url, "" }.should raise_error
+    lambda{ Caren::Api.delete @incorrect_url }.should raise_error
+  end
+  
+  it "should accept results with a correct signature" do
+    lambda{ Caren::Api.get @correct_url }.should_not raise_error
+    lambda{ Caren::Api.post @correct_url, "" }.should_not raise_error
+    lambda{ Caren::Api.put @correct_url, "" }.should_not raise_error
+    lambda{ Caren::Api.delete @correct_url }.should_not raise_error
+  end
+  
+  it "should be able to handle server side errors" do
+    
+    lambda{ Caren::Api.get @error_url }.should raise_error(Caren::Exceptions::ServerSideError)
+    lambda{ Caren::Api.put @error_url, "" }.should raise_error(Caren::Exceptions::ServerSideError)
+    lambda{ Caren::Api.post @error_url, "" }.should raise_error(Caren::Exceptions::ServerSideError)
+    lambda{ Caren::Api.delete @error_url }.should raise_error(Caren::Exceptions::ServerSideError)
+      
+  end
+  
+  it "should be able to handle authorization errors" do
+    begin
+      Caren::Api.delete @error_url
+    rescue Caren::Exceptions::ServerSideError => e
+      e.errors.should have(1).things
+      e.errors.first.class.should == Caren::Error
+      e.errors.first.category.should == "unauthorized"
+      e.errors.first.message.should == "You are not allowed to perform this action."
+    end  
+  end
+  
+  it "should be able to handle validation errors" do
+    begin
+      Caren::Api.get @error_url
+    rescue Caren::Exceptions::ServerSideError => e
+      e.errors.should have(1).things
+      e.errors.first.class.should == Caren::ValidationError
+      e.errors.first.message.should == "has already been taken"
+      e.errors.first.field.should == :url_shortcut
+      e.errors.first.to_s.should == "`url_shortcut` has already been taken"
+    end  
+  end
+  
+end

data/spec/event_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe "Event", "converting to xml" do
+    
+  before do
+    @event_a = Caren::Event.new( :external_id => 1, :name => "Washing", :comment => "Real good", :start => "12:00", 
+                                 :duration => 30, :valid_from => Date.today, :valid_to => Date.today+1.day, 
+                                 :person_first_name => "Andre", :person_last_name => "Foeken", :person_male => true, :external_person_id => 100 )
+    
+    @event_b = Caren::Event.new( :external_id => 2, :name => "Clothing", :comment => "Real bad", 
+                                 :start => "13:00", :duration => 30, :valid_from => Date.today, :valid_to => Date.today+1.day, 
+                                 :person_first_name => "Oscar", :person_last_name => "Foeken", :person_male => true, :external_person_id => 101 )
+  end
+  
+  it "should be able to convert an event to valid xml" do
+    @event_a.should convert_to_valid_caren_xml
+  end
+  
+  it "should be able to convert an array of events to valid xml" do
+    [@event_a,@event_b].should convert_to_valid_caren_array_xml
+  end
+  
+end

data/spec/external_message_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe "ExternalMessage", "converting to xml" do
+    
+  before do
+    @external_message_a = Caren::ExternalMessage.new( :person_name => "Andre Foeken",
+                                                      :external_person_id => 1,
+                                                      :body => "Test message",
+                                                      :external_id => 1,
+                                                      :in_reply_to_id => nil )
+    
+    @external_message_b = Caren::ExternalMessage.new( :person_name => "Ria Foeken",
+                                                      :external_person_id => 2,
+                                                      :body => "Test message reply",
+                                                      :external_id => 2,
+                                                      :in_reply_to_id => 99 )
+  end
+  
+  it "should be able to convert a link to valid xml" do
+    @external_message_a.should convert_to_valid_caren_xml
+  end
+  
+  it "should be able to convert an array of links to valid xml" do
+    [@external_message_a,@external_message_b].should convert_to_valid_caren_array_xml
+  end
+  
+end
+
+describe "ExternalMessage", "REST methods" do
+  
+  before do
+    FakeWeb.register_uri(:post, Caren::ExternalMessage.resource_url(1), :status => 201, :signature => Caren::Api.sign )
+    FakeWeb.register_uri(:delete, Caren::ExternalMessage.resource_url(1,1), :signature => Caren::Api.sign )
+  end
+  
+  it "should be able to create an external message" do
+    lambda{ Caren::ExternalMessage.new( :person_name => "Andre Foeken", 
+                                        :external_person_id => 1, 
+                                        :body => "Test message", 
+                                        :external_id => 1, 
+                                        :subject_id => 1 ).create }.should_not raise_error
+  end
+  
+  it "should be able to delete an external message" do
+    lambda{ Caren::ExternalMessage.new( :subject_id => 1, :caren_id => 1 ).delete }.should_not raise_error
+  end
+  
+end

data/spec/fixtures/caren_care_provider_validation.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<errors type="array">
+  <error on="url-shortcut" category="validation">
+    has already been taken
+  </error>
+</errors>

data/spec/fixtures/caren_care_providers.xml

@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<care-providers type="array">
+  <care-provider>
+    <url-shortcut>demo</url-shortcut>
+    <name>Demo</name>
+    <created-at type="datetime">2011-10-10T10:38:13+02:00</created-at>
+    <address-line></address-line>
+    <updated-at type="datetime">2011-10-10T10:38:13+02:00</updated-at>
+    <lng type="float">5.29127</lng>
+    <id type="integer">1</id>
+    <website></website>
+    <telephone></telephone>
+    <time-zone>Europe/Amsterdam</time-zone>
+    <lat type="float">52.1326</lat>
+    <email></email>
+    <logo></logo>
+    <linkable>true</linkable>
+  </care-provider>
+  <care-provider>
+    <url-shortcut>pantein</url-shortcut>
+    <name>Pantein</name>
+    <created-at type="datetime">2011-10-10T14:19:53+02:00</created-at>
+    <address-line></address-line>
+    <updated-at type="datetime">2011-10-11T08:58:48+02:00</updated-at>
+    <lng type="float">5.29127</lng>
+    <id type="integer">2</id>
+    <website></website>
+    <telephone></telephone>
+    <time-zone>Europe/Amsterdam</time-zone>
+    <lat type="float">52.1326</lat>
+    <email></email>
+    <logo></logo>
+    <linkable>true</linkable>
+  </care-provider>
+</care-providers>

data/spec/fixtures/caren_care_providers_search.xml

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<care-providers type="array">
+  <care-provider>
+    <url-shortcut>pantein</url-shortcut>
+    <name>Pantein</name>
+    <created-at type="datetime">2011-10-10T14:19:53+02:00</created-at>
+    <address-line></address-line>
+    <updated-at type="datetime">2011-10-11T08:58:48+02:00</updated-at>
+    <lng type="float">5.29127</lng>
+    <id type="integer">2</id>
+    <website></website>
+    <telephone></telephone>
+    <time-zone>Europe/Amsterdam</time-zone>
+    <lat type="float">52.1326</lat>
+    <email></email>
+    <logo></logo>
+    <linkable>true</linkable>
+  </care-provider>
+</care-providers>

data/spec/fixtures/caren_links.xml

@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<links type="array">
+  <link>
+    <created-at type="datetime">2011-10-10T10:38:49+02:00</created-at>
+    <updated-at type="datetime">2011-10-10T10:40:35+02:00</updated-at>
+    <id type="integer">1</id>
+    <care-provider-id type="integer">1</care-provider-id>
+    <person-id type="integer">3</person-id>
+    <person-name>Andre Foeken</person-name>
+    <person-photo>http://example.com/1.png</person-photo>
+    <external-id>1</external-id>
+    <status>confirmed</status>
+  </link>
+  <link>
+    <created-at type="datetime">2011-10-10T10:42:42+02:00</created-at>
+    <updated-at type="datetime">2011-10-10T10:53:07+02:00</updated-at>
+    <id type="integer">2</id>
+    <care-provider-id type="integer">1</care-provider-id>
+    <person-id type="integer">3</person-id>
+    <person-name>Andre Foeken</person-name>
+    <person-photo>http://example.com/1.png</person-photo>
+    <external-id>2</external-id>
+    <status>confirmed</status>
+  </link>
+  <link>
+    <created-at type="datetime">2011-10-10T11:05:28+02:00</created-at>
+    <updated-at type="datetime">2011-10-10T11:06:44+02:00</updated-at>
+    <id type="integer">3</id>
+    <care-provider-id type="integer">1</care-provider-id>
+    <person-id type="integer">3</person-id>
+    <person-name>Andre Foeken</person-name>
+    <person-photo>http://example.com/1.png</person-photo>
+    <external-id>3</external-id>
+    <status>confirmed</status>
+  </link>
+</links>

data/spec/fixtures/caren_links_search.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<links type="array">
+  <link>
+    <created-at type="datetime">2011-10-10T10:38:49+02:00</created-at>
+    <updated-at type="datetime">2011-10-10T10:40:35+02:00</updated-at>
+    <id type="integer">1</id>
+    <care-provider-id type="integer">1</care-provider-id>
+    <person-id type="integer">3</person-id>
+    <person-name>Andre Foeken</person-name>
+    <person-photo>http://example.com/1.png</person-photo>
+    <external-id>1</external-id>
+    <status>confirmed</status>
+  </link>
+</links>

data/spec/fixtures/caren_unauthorized.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<errors type="array">
+  <error category="unauthorized">
+    You are not allowed to perform this action.
+  </error>
+</errors>

data/spec/link_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe "Link", "converting to xml" do
+    
+  before do
+    @link_a = Caren::Link.new( :patient_number => "12345" )
+    @link_b = Caren::Link.new( :patient_number => "67890" )
+  end
+  
+  it "should be able to convert a link to valid xml" do
+    @link_a.should convert_to_valid_caren_xml
+  end
+  
+  it "should be able to convert an array of links to valid xml" do
+    [@link_a,@link_b].should convert_to_valid_caren_array_xml
+  end
+  
+end
+
+describe "Link", "REST methods" do
+  
+  before do
+    links  = File.read("spec/fixtures/caren_links.xml")
+    search = File.read("spec/fixtures/caren_links_search.xml")
+    FakeWeb.register_uri(:get, Caren::Link.resource_url, :body => links, :signature => Caren::Api.sign(links) )
+    FakeWeb.register_uri(:get, "#{Caren::Link.resource_url}?key=external-id&value=1", :body => search, :signature => Caren::Api.sign(search) )
+    FakeWeb.register_uri(:post, Caren::Link.resource_url, :status => 201, :signature => Caren::Api.sign )
+  end
+  
+  it "should be able to create a new link using the API" do
+    lambda{ Caren::Link.new( :patient_number => "12345" ).create }.should_not raise_error
+  end
+  
+  it "should be find all links using the API" do
+    links = Caren::Link.all
+    links.should have(3).things
+    links.first.status.should == "confirmed"
+    links.first.external_id.should == "1"
+    links.first.person_name.should == "Andre Foeken"
+    links.first.person_id.should == 3
+  end
+  
+  it "should be find a specific link using the API" do
+    links = Caren::Link.search(:external_id, 1)
+    links.should have(1).thing
+  end
+  
+end

data/spec/person_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe "Person", "converting to xml" do
+    
+  before do
+    @person_a = Caren::Person.new( :external_id => 1, 
+                                   :uid => "ABC123", 
+                                   :first_name => "Andre", 
+                                   :last_name => "Foeken", 
+                                   :male => true, 
+                                   :date_of_birth => 80.years.ago.to_date,
+                                   :address_street => "Sesamestreet 1", 
+                                   :address_zipcode => "7500AA", 
+                                   :address_city => "Groenlo", 
+                                   :address_country => "The Netherlands" )
+    
+    @person_b = Caren::Person.new( :external_id => 2, 
+                                   :uid => "ABC456", 
+                                   :first_name => "Oscar", 
+                                   :last_name => "Foeken", 
+                                   :male => true, 
+                                   :date_of_birth => 80.years.ago.to_date,
+                                   :address_street => "Sesamestreet 1", 
+                                   :address_zipcode => "7500AA", 
+                                   :address_city => "Groenlo", 
+                                   :address_country => "The Netherlands" )
+  end
+  
+  it "should be able to convert a person to valid xml" do
+    @person_a.should convert_to_valid_caren_xml
+  end
+  
+  it "should be able to convert an array of people to valid xml" do
+    [@person_a,@person_b].should convert_to_valid_caren_array_xml
+  end
+  
+end

data/spec/spec.opts

@@ -0,0 +1,3 @@
+--colour
+--format specdoc
+--loadby mtime

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
+require 'caren-api'
+require 'rspec'
+require 'fakeweb'
+require 'capybara'
+
+Caren::Api.shared_key = "specs"
+Caren::Api.url = "http://example.com"
+
+FakeWeb.allow_net_connect = false
+
+RSpec::Matchers.define :convert_to_valid_caren_xml do
+  match do |instance|
+    hash = Hash.from_xml(instance.to_xml)
+    keys = instance.as_xml.keys.map(&:to_s)
+    (hash[instance.class.node_root.to_s].keys - keys).should be_empty
+    keys.map{ |key| hash[instance.class.node_root.to_s][key].to_s == instance.send(key.to_sym).to_s }.inject(&:&)
+  end
+end
+
+RSpec::Matchers.define :convert_to_valid_caren_array_xml do
+  match do |array|
+    hash = Hash.from_xml( array.first.class.to_xml(array) )
+    hash.keys.should eql [array.first.class.array_root.to_s]
+    array.each do |obj|
+      obj.should convert_to_valid_caren_xml
+    end
+  end
+end
+
+RSpec.configure do |config|
+  
+end