motion-addressbook 1.4.0 → 1.5.0

data/.travis.yml

@@ -1,5 +1,4 @@
 language: objective-c
-before_install: rvm use 1.9.3
 notifications:
   email:
     recipients:

data/README.md

@@ -2,9 +2,8 @@
 
 A RubyMotion wrapper around the iOS Address Book framework for RubyMotion apps.
 
-Apple's [Address Book Programming Guide for iOS](http://developer.apple.com/library/ios/#DOCUMENTATION/ContactData/Conceptual/AddressBookProgrammingGuideforiPhone/Introduction.html)
-
-[![Gem Version](https://badge.fury.io/rb/motion-addressbook.png)](http://badge.fury.io/rb/motion-addressbook)
+Apple's Address Book Programming Guide for [iOS](http://developer.apple.com/library/ios/#DOCUMENTATION/ContactData/Conceptual/AddressBookProgrammingGuideforiPhone/Introduction.html)
+or for [OSX](https://developer.apple.com/library/mac/#documentation/userexperience/Conceptual/AddressBook/AddressBook.html#//apple_ref/doc/uid/10000117i)
 
 ## Installation
 

data/Rakefile

@@ -1,13 +1,25 @@
-#!/usr/bin/env rake
-$:.unshift("/Library/RubyMotion/lib")
-require 'motion/project/template/ios'
 require "bundler/gem_tasks"
+$:.unshift("/Library/RubyMotion/lib")
+if ENV['osx']
+  require 'motion/project/template/osx'
+else
+  require 'motion/project/template/ios'
+end
 Bundler.setup
 Bundler.require
 
-require 'bubble-wrap/test'
+unless ENV['osx']
+  # iOS needs an AppDelegate for REPL to launch; steal one from BW
+  require 'bubble-wrap/test'
+end
 
 Motion::Project::App.setup do |app|
   # Use `rake config' to see complete project settings.
   app.name = 'AddressBook'
+
+  if Motion::Project::App.osx?
+    app.specs_dir = "./spec/osx"
+  else
+    app.specs_dir = "./spec/ios"
+  end
 end

data/lib/motion-addressbook/version.rb

@@ -1,5 +1,5 @@
 module Motion
   module Addressbook
-    VERSION = "1.4.0"
+    VERSION = "1.5.0"
   end
 end

data/lib/motion-addressbook.rb

@@ -3,17 +3,29 @@ require "motion-addressbook/version"
 BubbleWrap.require 'motion/address_book.rb' do
   file('motion/address_book.rb').uses_framework('AddressBook')
 end
-BW.require 'motion/address_book/multi_value.rb'
-BW.require 'motion/address_book/addr_book.rb'
-BW.require 'motion/address_book/person.rb'
-BW.require 'motion/address_book/group.rb'
-BW.require 'motion/address_book/multi_valued.rb'
-BW.require 'motion/address_book/source.rb'
 
-BW.require 'motion/address_book/picker.rb' do
-  file('motion/address_book/picker.rb').uses_framework('AddressBookUI')
+BubbleWrap.require_ios do
+  # BW.require 'motion/address_book/multi_value.rb'
+  BW.require 'motion/address_book/ios/addr_book.rb'
+  BW.require 'motion/address_book/ios/person.rb'
+  BW.require 'motion/address_book/ios/group.rb'
+  BW.require 'motion/address_book/ios/multi_valued.rb'
+  BW.require 'motion/address_book/ios/source.rb'
+
+  # This is an iOS-specific RubyMotion bug workaround.
+  Motion::Project::App.setup do |app|
+    app.vendor_project(File.expand_path(File.join(File.dirname(__FILE__), '../abhack')), :static)
+  end
+
+  BW.require 'motion/address_book/ios/picker.rb' do
+    file('motion/address_book/ios/picker.rb').uses_framework('AddressBookUI')
+  end
 end
 
-Motion::Project::App.setup do |app|
-  app.vendor_project(File.expand_path(File.join(File.dirname(__FILE__), '../abhack')), :static)
+BubbleWrap.require_osx do
+  BW.require 'motion/address_book/osx/addr_book.rb'
+  BW.require 'motion/address_book/osx/person.rb'
+  BW.require 'motion/address_book/osx/group.rb'
+  BW.require 'motion/address_book/osx/multi_valued.rb'
+  BW.require 'motion/address_book/osx/source.rb'
 end

data/motion/address_book/{person.rb → ios/person.rb}

@@ -77,6 +77,7 @@ module AddressBook
         :first_name   => KABPersonFirstNameProperty,
         :middle_name  => KABPersonMiddleNameProperty,
         :last_name    => KABPersonLastNameProperty,
+        :prefix       => KABPersonPrefixProperty,
         :suffix       => KABPersonSuffixProperty,
         :nickname     => KABPersonNicknameProperty,
         :job_title    => KABPersonJobTitleProperty,
@@ -86,6 +87,7 @@ module AddressBook
         :note         => KABPersonNoteProperty
       }
     end
+
     def attribute_map
       self.class.attribute_map
     end
@@ -344,6 +346,11 @@ module AddressBook
       ABPersonCreateVCardRepresentationWithPeople(ab_persons)
     end
 
+    def to_s
+      "#<#{self.class}:#{uid}: #{attributes}>"
+    end
+    alias :inspect :to_s
+
     private
 
     def self.single_value_property_map
@@ -351,6 +358,7 @@ module AddressBook
         KABPersonFirstNameProperty => :first_name,
         KABPersonLastNameProperty => :last_name,
         KABPersonMiddleNameProperty => :middle_name,
+        KABPersonPrefixProperty => :prefix,
         KABPersonSuffixProperty => :suffix,
         KABPersonNicknameProperty => :nickname,
         KABPersonJobTitleProperty => :job_title,

data/motion/address_book/osx/addr_book.rb

@@ -0,0 +1,67 @@
+module AddressBook
+  class AddrBook
+    attr_reader :ab
+
+    def initialize
+      @ab = ABAddressBook.addressBook
+    end
+    def people(opts = {})
+      if opts[:local]
+        people.select {|p| p.local?}
+      else
+        ab.people.map do |ab_person|
+          AddressBook::Person.new(ab_person, :address_book => ab)
+        end
+      end
+    end
+    def count
+      people.count
+    end
+    def new_person(attributes)
+      Person.new(attributes, :address_book => @ab)
+    end
+    def create_person(attributes)
+      p = Person.new(attributes, :address_book => @ab)
+      p.save
+      p
+    end
+    def person(id)
+      if ab_person = ab.recordForUniqueId(id)
+        Person.new(ab_person, :address_book => ab)
+      end
+    end
+    def changedSince(timestamp)
+      people.select {|p| p.modification_date > timestamp}
+    end
+
+    # get logged-in user's record
+    def me
+      if this_user = ab.me
+        Person.new(this_user, :address_book => ab)
+      end
+    end
+
+    def groups
+      ab.groups.map do |ab_group|
+        AddressBook::Group.new(:ab_group => ab_group, :address_book => @ab)
+      end
+    end
+    def new_group(attributes)
+      AddressBook::Group.new(:attributes => attributes, :address_book => @ab)
+    end
+    def group(id)
+      if ab_group = ab.recordForUniqueId(id)
+        Group.new(:ab_group => ab_group, :address_book => ab)
+      end
+    end
+
+    def notify_changes(callback, context)
+      ABAddressBookRegisterExternalChangeCallback(ab, callback, context)
+    end
+
+    # def sources
+    #   # ABAddressBookCopyArrayOfAllSources(ab).map {|s| ABRecordCopyValue(s, KABSourceTypeProperty)}
+    #   ABAddressBookCopyArrayOfAllSources(ab).map {|s| Source.new(s)}
+    # end
+  end
+end

data/motion/address_book/osx/group.rb

@@ -0,0 +1,122 @@
+# Wrapper for OSX ABGroup
+#
+# * groups are saved to the database immediately upon new()
+# * members are added with <<
+#
+module AddressBook
+  class Group
+    attr_reader :attributes, :error
+
+    def initialize(opts)
+      @address_book = opts[:address_book]
+      if opts[:ab_group]
+        # import existing
+        @ab_group = opts[:ab_group]
+        @attributes = nil
+      else
+        # create new
+        @ab_group = nil
+        @attributes = opts[:attributes]
+      end
+    end
+
+    def address_book
+      @address_book ||= AddressBook.address_book
+    end
+
+    def save
+      address_book.addRecord(ab_group)
+      address_book.save
+      @attributes = nil
+      self
+    end
+
+    def exists?
+      address_book.recordForUniqueId(uid)
+    end
+    def new_record?
+      !exists?
+    end
+    alias :new? :new_record?
+
+    def delete!
+      unless new?
+        address_book.removeRecord(ab_group)
+        address_book.save
+        @ab_group = nil
+        self
+      end
+    end
+
+    def ab_group
+      @ab_group || convert_dict_to_ab
+    end
+    alias :ab_record :ab_group
+
+    def get_field(field)
+      ab_group.valueForProperty(field)
+    end
+
+    def uid
+      get_field(KABUIDProperty)
+    end
+
+    def name
+      get_field(KABGroupNameProperty)
+    end
+
+    def size
+      members.count
+    end
+
+    def members
+      people + subgroups
+    end
+    def people
+      ab_group.members.map do |ab_person|
+        AddressBook::Person.new(ab_person, :address_book => address_book)
+      end
+    end
+    def subgroups
+      ab_group.subgroups.map do |subgroup|
+        AddressBook::Group.new(:ab_group => subgroup, :address_book => address_book)
+      end
+    end
+
+    def <<(person_or_group)
+      raise ArgumentError, "Must save member before adding to group" if person_or_group.new?
+      ABGroupAddMember(ab_group, person_or_group.ab_record, error)
+    end
+
+    def local?
+      !ab_group.isReadOnly
+    end
+
+    def apple_uuid
+      get_field('com.apple.uuid')
+    end
+    # regular groups have a value in the internal "com.apple.uuid" property
+    # groups with nil here appear to include
+    # * all-local-contacts source (group name is "card")
+    # * Facebook source (group name is "addressbook")
+    # I suspect that Exchange and DAV sources will show up here too.
+    def special?
+      apple_uuid.nil?
+    end
+
+    private
+
+    def convert_dict_to_ab
+      @ab_group = ABGroup.alloc.initWithAddressBook(address_book)
+
+      # groups only have a single regular attribute (name)
+      if v = @attributes[:name]
+        ab_group.setValue(v, forProperty:KABGroupNameProperty)
+      end
+
+      save
+
+      @ab_group
+    end
+  end
+end

data/motion/address_book/osx/multi_valued.rb

@@ -0,0 +1,166 @@
+module AddressBook
+  class MultiValued
+    attr_reader :mv_type
+
+    def initialize(opts)
+      unless opts.one?
+        raise ArgumentError, "MultiValued requires :attributes *or* :ab_multi_value argument"
+      end
+
+      if opts[:ab_multi_value]
+        @ab_multi_value = opts[:ab_multi_value] #ABMultiValueCreateMutableCopy(opts[:ab_multi_value])
+      else
+        @attributes = opts[:attributes]
+        raise ArgumentError, "Empty multi-value objects are not allowed" if @attributes.empty?
+      end
+    end
+
+    def count
+      ab_multi_value.count
+    end
+    alias :size :count
+
+    def attributes
+      @attributes ||= convert_multi_value_into_dictionary
+    end
+
+    def convert_multi_value_into_dictionary
+      count.times.map do |i|
+        data = ab_record_to_dict(i)
+        label = @ab_multi_value.labelAtIndex(i)
+        if label != ''
+          label_val = ABPerson.ABCopyLocalizedPropertyOrLabel(label)
+          data[:label] = label_val
+        end
+        data
+      end
+    end
+
+    def ab_multi_value
+      @ab_multi_value ||= convert_dictionary_into_multi_value
+    end
+
+    # Attempt to convert the provided label to the OSX-standard global constant.
+    # If there's no match, then use the string as provided.
+    # nil values are not allowed on OSX, "" seems to be the stand-in for undefined.
+    def localized_label(str)
+      LabelMap[str] || str || ''
+    end
+
+    def convert_dictionary_into_multi_value
+      @mv_type = multi_value_property_type
+      mv = ABMutableMultiValue.new
+
+      case mv_type
+      when KABMultiStringProperty
+        @attributes.each do |rec|
+          mv.addValue(rec[:value], withLabel: localized_label(rec[:label]))
+        end
+      when KABMultiDateProperty
+        @attributes.each do |rec|
+          mv.addValue(rec[:date], withLabel: localized_label(rec[:label]))
+        end
+      else # KABMultiDictionaryProperty
+        @attributes.each do |rec|
+          if value = dict_to_ab_record(rec)
+            mv.addValue(value, withLabel: localized_label(rec[:label]))
+          end
+        end
+      end
+
+      mv
+    end
+
+    def multi_value_property_type
+      if @ab_multi_value
+        @ab_multi_value.propertyType
+      else
+        if attributes.find {|rec| rec[:value]}
+          KABMultiStringProperty
+        elsif attributes.find {|rec| rec[:date]}
+          KABMultiDateProperty
+        else
+          KABMultiDictionaryProperty
+        end
+      end
+    end
+
+    # these are for mapping fields in a kABMultiDictionaryPropertyType record
+    # to keys in a standard hash (NSDictionary)
+    PropertyMap = {
+      KABAddressStreetKey => :street,
+      KABAddressCityKey => :city,
+      KABAddressStateKey => :state,
+      KABAddressZIPKey => :postalcode,
+      KABAddressCountryKey => :country,
+      KABAddressCountryCodeKey => :country_code,
+
+      KABSocialProfileURLKey => :url,
+      KABSocialProfileServiceKey => :service,
+      KABSocialProfileUsernameKey => :username,
+      KABSocialProfileUserIdentifierKey => :userid,
+
+      # these keys are identical to the SocialProfile keys above
+      KABInstantMessageServiceKey => :service,
+      KABInstantMessageUsernameKey => :username
+    }
+
+    LabelMap = {
+      "mobile"   => KABPhoneMobileLabel ,
+      "iphone"   => KABPhoneiPhoneLabel ,
+      "main"     => KABPhoneMainLabel   ,
+      "home_fax" => KABPhoneHomeFAXLabel,
+      "work_fax" => KABPhoneWorkFAXLabel,
+      "pager"    => KABPhonePagerLabel  ,
+      "work"     => KABWorkLabel        ,
+      "home"     => KABHomeLabel        ,
+      "other"    => KABOtherLabel       ,
+      "home page"=> KABHomePageLabel,
+      "anniversary"=> KABAnniversaryLabel
+    }
+
+    def dict_to_ab_record(h)
+      h = PropertyMap.each_with_object({}) do |(ab_key, attr_key), ab_record|
+        ab_record[ab_key] = h[attr_key] if h[attr_key]
+      end
+      h.any? ? h : nil
+    end
+
+    def ab_record_to_dict(i)
+      case multi_value_property_type
+      when KABMultiStringProperty
+        {:value => @ab_multi_value.valueAtIndex(i)}
+      when KABMultiDateProperty
+        {:date => @ab_multi_value.valueAtIndex(i)}
+      when KABMultiDictionaryProperty
+        ab_record = @ab_multi_value.valueAtIndex(i)
+        PropertyMap.each_with_object({}) do |(ab_key, attr_key), dict|
+          dict[attr_key] = ab_record[ab_key] if ab_record[ab_key]
+        end
+      else
+        raise TypeError, "Unknown MultiValue property type #{multi_value_property_type}"
+      end
+    end
+
+    def <<(rec)
+      case multi_value_property_type
+      when KABMultiStringProperty
+        ABMultiValueAddValueAndLabel(ab_multi_value, rec[:value], localized_label(rec[:label]), nil)
+      when KABMultiDateTimeProperty
+        ABMultiValueAddValueAndLabel(ab_multi_value, rec[:date], localized_label(rec[:label]), nil)
+      when KABMultiDictionaryProperty
+        ABMultiValueAddValueAndLabel(ab_multi_value, dict_to_ab_record(rec), localized_label(rec[:label]), nil)
+      else
+        raise TypeError, "Unknown MultiValue property type #{multi_value_property_type}"
+      end
+
+      @attributes = convert_multi_value_into_dictionary
+    end
+
+    def first_for(label)
+      if rec = attributes.find {|r| r[:label] == label.to_s}
+        rec[:value] ? rec[:value] : rec
+      end
+    end
+  end
+end