memotoo 1.0.6 → 2.0.0

data/README.rdoc

@@ -2,19 +2,21 @@
 
 <b>This is not an official gem from the provider of memotoo !!!</b>
 
-The memotoo-gem is a soap(savon)-wrapper to (easy) access your {memotoo}[http://www.memotoo.com/index-saleshype.php] contacts.
+The memotoo-gem is a soap(savon)-wrapper to (easy) access your {memotoo}[https://www.memotoo.com/index-saleshype.php] contacts.
 
-Add, get, search, modify and delete your memotoo contacts.
+Add, get, search, modify and delete your memotoo contacts, contact-groups and bookmarks.
 
 == You need
 you need a memotoo-credential (username/passwd) to use this gem 
 
-<b>get a free account here: {www.memotoo.com}[http://www.memotoo.com/index-saleshype.php]</b>
+<b>get a free account here: {www.memotoo.com}[https://www.memotoo.com/index-saleshype.php]</b>
 
 
 ==Install
 
-if you use <b>bundler</b> add gem 'memotoo' to your Gemfile run
+if you use <b>bundler</b> add 
+    gem 'memotoo'
+to your Gemfile run
     bundle install
 else put it in your <b>environment.rb</b> and run
     rake gems:install
@@ -23,6 +25,9 @@ else put it in your <b>environment.rb</b> and run
 
 give a first try in ./script/console
 
+@connect=Memotoo.new("myusername","mypassword")
+
+Changelog: (prev V 2.0 I wrapped it in a Module )
 @connect=Memotoo::Connect.new("myusername","mypassword")
 
 add a contact:
@@ -70,11 +75,44 @@ bookmarks:
     @connect.modifyBookmark({:id=>response[:id], :url=>"www.google.com", :description => "nice"})
     
     @connect.deleteBookmark(12345)
-    
+
+
+Requirements:
+
+ for the objects:
+
+Contact:: :lastname
+ContactGroup:: :name
+Bookmark:: :url
+BookmarkFolder:: :name 
+Note:: :description
+CalendarCategory:: :name
+Event:: :title, :dateBegin, :dateEnd
+Holiday:: :description, :dateBegin, :dateEnd
+Task:: :title
+
+ for the methods:
+
+searchmethod:: {search=>" "}, a hash
+id:: id of record, integer
+get...Sync:: datetime, format YYYY-MM-DD HH:MM:SS - "2010-02-23 10:00:00"
+modify:: id of record, integer
+add and modify:: need always the object requirements 
+
+ hint:
+ 
+Holiday::
+dateBegin::    "2011-01-01", Format: YYYY-MM-DD
+dateEnd::    "2011-01-01", Format: YYYY-MM-DD
+
+Task and Event::
+dateBegin::    "2011-06-18T10:00:00", Format: YYYY-MM-DDTHH:II:SS - ISO8601 time format GMT
+dateEnd::    "2011-06-18T10:00:00", Format: YYYY-MM-DDTHH:II:SS - ISO8601 time format GMT
+ 
 ==Testing
 
 I added tests for all implemented functions. (rcov 100%)
-You can add your own credential to /test/test_memotoo.rb
+You can add your own credential to /test/helper.rb
 
 I also added support for {http://test.rubygems.org}[http://test.rubygems.org]
 
@@ -82,19 +120,35 @@ You can now use the gem rubygems-test for easy testing this gem.
 
     gem test memotoo
 
-See my testresult here: http://test.rubygems.org/gems/memotoo/v/1.0.6/test_results/1655
+See my testresult here: http://test.rubygems.org/gems/memotoo/v/2.0.0/test_results/1663
+
+(To make a fast functional test only contact will be tested - goto test_soapobjects.rb line 8 and uncomment for all soapobject-tests)
 
 ==Documentation
 
 see rdoc
 
-==To-Dos
+and memotoo api-documentation
+
+https://www.memotoo.com/index.php?rub=api#SOAP-server.php
+
+== Changelog V. 2.0.0
+
+I create all methods now dynamically. This reduced the code dramatically.
+I give up using a module to wrap the namespace. Now it's a class.
+
+== Hint
+
+Be careful with following methods due to a problem at memotoo's api:
+
+searchBookmarkFolder:: (possible workaround: search for all -> " " and then go ahead)
 
-1. Exception handling should be done - fetched problems are written to console
-2. I only implemented contacts, contact's group and bookmark - these soap-objects are missing: bookmark's folder, event, holiday, task, note
+getHoliday:: (possible workaround: search and use the result)
+getHolidaySync (no workaround known)
 
-It would be nice if *someone* could help me with the missing parts .
+All three methods seems not to be really important - just fyi
 
+I will remove this hint when the soap-api is repaired. 
 
 == Contributing to memotoo-gem
  

data/Rakefile

@@ -15,7 +15,16 @@ Jeweler::Tasks.new do |gem|
   gem.homepage = "http://github.com/kredmer/memotoo"
   gem.license = "MIT"
   gem.summary = "Unofficial gem for connecting to memotoo.com with their given soap-api"
-  gem.description = "Unofficial gem for connecting to memotoo.com with their soap-api and handle your contact needs. Memotoo lets your synchronize all your contacts, events and tasks with yahoo, gmail, facebook, xing, outlook, your mobile-phone and more. You can also get your e-mails in one place."
+  gem.description = "Unofficial gem for connecting to memotoo.com with their soap-api and handle your contact needs. Memotoo lets your synchronize all your contacts, events and tasks with yahoo, gmail, facebook, xing, outlook, your mobile-phone and more. You can also get your e-mails in one place.Features of memotoo:
+  New mobile? Transfer all your data to your new device!
+  Synchronise your data with your mobile phone (with SyncML)
+  Access all your e-mail in a single page from Google, Yahoo, Hotmail / MSN, ...!
+  View your data on your mobile phone (WAP / XHTML)
+  Access your contacts using a LDAP directory
+  Access your files via a Web Folder
+  Access your files via FTP
+  Add Memotoo widgets to iGoogle, Netvibes, Windows Vista, Apple Dashboard, ...
+  Memotoo plugins for your browser"
   gem.email = "k.redmer@yahoo.de"
   gem.authors = ["Karsten Redmer"]
   gem.add_dependency 'savon'

data/VERSION

@@ -1 +1 @@
-1.0.6
+2.0.0

data/lib/memotoo.rb

@@ -1,8 +1,75 @@
-require "memotoo/connect"
 require 'rubygems'
 require 'active_support/inflector'
+require "savon"
+require "memotoo/main"
+require "memotoo/core-ext/hash"
+require "memotoo/core-ext/kernel"
 
+class Memotoo
 
-module Memotoo
+   # will hold username and password in a hash style (used for all requests)
+    attr_accessor :opts #:nodoc:
+    
+    SEARCHDEFAULTS = { :limit_start => '0', :limit_nb => '100' }
+    
+    # requirement for the objects - for validation
+	NEEDS = { 	 :contact => [:lastname],
+				 :contact_group => [:name],
+				 :bookmark => [:url],
+				 :bookmark_folder => [:name],
+				 :note => [:description],
+				 :calendar_category => [:name],
+				 :event => [:title, :dateBegin, :dateEnd],
+				 :holiday => [:description, :dateBegin, :dateEnd],
+				 :task => [:title]}
+     
+     #[https] default:true for the SOAP service. Use false to use http-connection
+     # example:(use https) 
+     #     @connect=Memotoo::Connect.new("myusername","mypassword")
+     # example:(use http) 
+     #     @connect=Memotoo::Connect.new("myusername","mypassword", false)
+    def initialize(username, password, https=true)
 
+		# we will need it for every request - will be merged in
+		self.opts= { :param => { :login => username, :password => password}}
+		
+		# build dynamically all methods - some magic :-)
+		make_methods
+		
+		# creates client with memotoo settings 
+		client(https)
+	end
 end
+
+# stop savon logging 
+
+module Savon # :nodoc: all
+  module Global
+    def log?
+      false
+    end
+      def raise_errors?
+      @raise_errors = true
+    end
+   
+  end
+end
+
+#Finished in 12.361502 seconds.
+
+#14 tests, 14 assertions, 0 failures, 0 errors
+#+----------------------------------------------------+-------+-------+--------+
+#|                  File                              | Lines |  LOC  |  COV   |
+#+----------------------------------------------------+-------+-------+--------+
+#|lib/memotoo.rb                                      |    59 |    34 | 100.0% |
+#|lib/memotoo/core-ext/hash.rb                        |    41 |    25 | 100.0% |
+#|lib/memotoo/core-ext/kernel.rb                      |    10 |     6 | 100.0% |
+#|lib/memotoo/main.rb                                 |   280 |    77 | 100.0% |
+#+----------------------------------------------------+-------+-------+--------+
+#|Total                                               |   390 |   142 | 100.0% |
+#+----------------------------------------------------+-------+-------+--------+
+#100.0%   4 file(s)   390 Lines   142 LOC
+
+#Generated on Sun Jun 12 07:03:59 +0200 2011 with rcov 0.9.8
+
+

data/lib/memotoo/core-ext/hash.rb

@@ -26,8 +26,8 @@ class Hash # :nodoc: all
   
       # Returns a new Hash with +self+ and +other_hash+ merged recursively.
       # Modifies the receiver in place.
-      # => already in savon gem 
-      # =>  in case a time come and it will be away - just uncomment it
+      # => see this function also in savon gem 
+      # got problems in my test and had to include it here...
       def deep_merge_me!(other_hash)
         other_hash.each_pair do |k,v|
           tv = self[k]

data/lib/memotoo/core-ext/kernel.rb

@@ -1,4 +1,4 @@
-module Kernel
+module Kernel # :nodoc: all
 private
 #  def this_method
 #    caller[0] =~ /`([^']*)'/ and $1

data/lib/memotoo/main.rb

@@ -0,0 +1,280 @@
+class Memotoo
+
+	private	
+	
+   # Creates the <tt>Savon::Client</tt>.
+    def client(https=true)
+		#--
+		# in any case problems switch back to receiving the wsdl file from memotoo
+		# https: wsdl.document = "https://www.memotoo.com/SOAP-server.php?wsdl"
+		# http:  wsdl.document = "http://www.memotoo.com/SOAP-server.php?wsdl"
+		#++
+	
+		@client ||= Savon::Client.new do
+          wsdl.namespace="urn:memotooSoap"
+		  if https
+				wsdl.endpoint="https://www.memotoo.com/SOAP-server.php"
+				http.auth.ssl.verify_mode = :none 
+		  else
+				wsdl.endpoint="http://www.memotoo.com/SOAP-server.php"
+		  end
+		  http.auth.basic self.opts[:param][:login], self.opts[:param][:password]
+		end
+    end
+    
+	def selfclass
+	(class << self; self; end)
+	end
+
+	# builds for every soap-object six methods (add, search, get, get..Sync,modify, delete )
+	# on-the-fly :-)
+	def make_methods
+	
+	# the accessible soap objects
+	soapobjects = %w{Contact ContactGroup Bookmark BookmarkFolder Note CalendarCategory Event Holiday Task}
+	
+		soapobjects.each do |soapobject|
+		symbol=soapobject.underscore.to_sym
+	
+		# add method
+		methodname="add"+soapobject	
+		selfclass.send(:define_method, methodname) { |details| output(detailsApicall({symbol => details}), :id) if fields?(details, NEEDS[symbol]) }
+		
+		# search
+		methodname="search"+soapobject	
+		selfclass.send(:define_method, methodname) { |params| output(searchApiCall(params), :return, symbol) if fields?(params, [:search]) }
+		
+		# get
+		methodname="get"+soapobject	
+		selfclass.send(:define_method, methodname) { |id| output(idApicall(id), :return, symbol) }
+
+		# get...Sync
+		methodname="get"+soapobject+"Sync"	
+		selfclass.send(:define_method, methodname) { |datetime| output(getSyncApiCall(datetime), :return, symbol) }
+
+		# modify
+		methodname="modify"+soapobject	
+		selfclass.send(:define_method, methodname) { |details| output(detailsApicall({symbol => details}), :ok) if fields?(details, [NEEDS[symbol], :id].flatten!) }
+		
+		# delete
+		methodname="delete"+soapobject	
+		selfclass.send(:define_method, methodname) { |id| output(idApicall(id), :ok) }
+
+		end
+	end
+	
+    def searchApiCall(searchparameter)
+		search = SEARCHDEFAULTS.merge!(searchparameter)
+		apicall(calling_method.to_sym, search)
+    end
+    
+    def getSyncApiCall(datetime)
+    	date2time=Time.mktime(*ParseDate.parsedate(datetime))
+    	formated_date=date2time.strftime("%Y-%m-%d %H:%M:%S")
+    	apicall(calling_method.to_sym, { :date => formated_date })
+    end
+    
+    def idApicall(id)
+        apicall(calling_method.to_sym, { :id => id })
+    end
+    
+    def detailsApicall(details)
+		apicall(calling_method.to_sym, details )
+    end
+    
+    # used internally for a request
+    def apicall(action, parameter)
+		response=@client.request :wsdl, action do 
+			soap.body = { :param => parameter }.deep_merge_me!(self.opts)
+		end	
+		response
+		rescue Savon::Error => error
+			raise ArgumentError, "Memotoo::Connect #invalid username/password" if error.message.nil?
+	end
+
+	def output(response, *_keys_)
+		output_key = [(calling_method.underscore+"_response").to_sym] | _keys_
+		response.nil? ? nil : response.to_hash.seek(output_key) 
+    end
+	
+	def go_home(message)
+		raise ArgumentError, "Memotoo::Connect #missing fields: " + message.to_s
+	end
+	
+	def fields?(thehash, args=[])
+		valid=true
+		retarr=[]
+		args.each do |arg_item|
+			unless thehash.has_key?(arg_item)
+				valid = false
+				retarr << arg_item
+			end
+		end
+		valid ? true : go_home(retarr.join(", "))
+	end
+	
+# ---------------------
+# :section: memotoo soap actions
+# === bookmark - ready implemented
+# * searchBookmark(searchparams={})
+# * addBookmark(params={})
+# * getBookmark(id)
+# * getBookmarkSync(datetime)  
+# * modifyBookmark(params={})
+# * deleteBookmark(id)
+# 
+# === bookmarkfolder - ready implemented - API problem with search
+# * searchBookmarkFolder(searchparams={})
+# * addBookmarkFolder(params={})
+# * getBookmarkFolder(id)      
+# * getBookmarkFolderSync(datetime)
+# * modifyBookmarkFolder(params={})
+# * deleteBookmarkFolder(id)
+#
+# === calendar_category  - ready implemented
+# * searchCalendarCategory
+# * addCalendarCategory
+# * getCalendarCategory
+# * getCalendarCategorySync
+# * modifyCalendarCategory
+# * deleteCalendarCategory
+# 
+# === contact - ready implemented
+# * searchContact    
+# * add_contact    
+# * getContact
+# * getContactSync
+# * modifyContact 
+# * deleteContact    
+#
+# === contact-group - ready implemented
+# * searchContactGroup
+# * addContactGroup    
+# * getContactGroup
+# * getContactGroupSync
+# * modifyContactGroup
+# * deleteContactGroup
+#
+# === event - ready implemented
+# * searchEvent
+# * addEvent
+# * getEvent
+# * getEventSync 
+# * modifyEvent    
+# * deleteEvent    
+#
+# === holiday - ready implemented - API problem with get and getSync
+# * searchHoliday
+# * addHoliday
+# * getHoliday 
+# * getHolidaySync
+# * modifyHoliday
+# * deleteHoliday
+# 
+# === note  - ready implemented
+# * searchNote
+# * addNote 
+# * getNote
+# * getNoteSync
+# * modifyNote
+# * deleteNote
+#
+# === task - ready implemented
+# * searchTask
+# * addTask    
+# * getTask 
+# * getTaskSync
+# * modifyTask     
+# * deleteTask 
+#
+# ---------------------
+
+# ---------------------
+# :section: Bookmark fields
+#
+# id:: "2531368"
+# url(*):: "http://www.google.com"
+# description:: "google"
+# rank:: "0"
+# tags:: nil
+# id_bookmark_folder:: "363174"
+# ---------------------
+
+# ---------------------
+# :section: BookmarkFolder fields
+# 
+# id:: "2531368"
+# name(*):: "Download applications"
+# id_bookmark_folder_parent:: "363174"
+# ---------------------
+
+
+
+# ---------------------
+# :section: Contact fields
+# all contacts fields
+#			:id
+#			:title => 'Mr.',
+#			:lastname => 'test',
+#			:firstname => 'user',
+#			:middlename => '',
+#			:nickname => 'bob',
+#			:suffix => '',
+#			:birthday => '1975-02-14', // Format YYYY-MM-DD
+#			:homeaddress => '',
+#			:homecity => 'new york',
+#			:homepostalcode => '',
+#			:homestate => '',
+#			:homecountry => 'usa',
+#			:homeemail => '',
+#			:homephone => '',
+#			:homemobile => '',
+#			:homefax => '',
+#			:homewebpage => '',
+#			:businessaddress => '',
+#			:businesscity => '',
+#			:businesspostalcode => '',
+#			:businessstate => '',
+#			:businesscountry => '',
+#			:businessemail => '',
+#			:businessphone => '',
+#			:businessmobile => '',
+#			:businessfax => '',
+#			:businesswebpage => '',
+#			:company => '',
+#			:department => '',
+#			:jobtitle => '',
+#			:notes => '',
+#			:otheraddress => '',
+#			:othercity => '',
+#			:otherpostalcode => '',
+#			:otherstate => '',
+#			:othercountry => '',
+#			:otheremail => '',
+#			:otherphone => '',
+#			:othermobile => '',
+#			:otherfax => '',
+#			:skypeid => '',
+#			:msnid => '',
+#			:aimid => '',
+#			:pager => '',
+#			:carphone => '',
+#			:managersname => '',
+#			:assistantsname => '',
+#			:assistantsphone => '',
+#			:parent => '',
+#			:spouse => '',
+#			:children => '',
+#			:custom1 => '',
+#			:custom2 => '',
+#			:custom3 => '',
+#			:custom4 => '',
+#			:group => '0',
+#			:photo => '', // Photo encoded with Base64
+# ---------------------
+	
+  end
+
+
+
+