motion-addressbook 0.0.1

data/.gitignore

@@ -0,0 +1,13 @@
+.repl_history
+build
+resources/*.nib
+resources/*.momd
+resources/*.storyboardc
+
+resources/photos/[1-9]*/*
+
+vendor/Pods/Pods.xcodeproj/project.pbxproj
+vendor/Pods/build*
+
+.dat*.00*
+pkg

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# need to do this here as alphabetically "bubble-wrap" comes after "address_book" and require fails otherwise
+gem 'bubble-wrap'
+
+# Specify your gem's dependencies in motion-addressbook.gemspec
+gemspec
+

data/Gemfile.lock

@@ -0,0 +1,29 @@
+PATH
+  remote: .
+  specs:
+    motion-addressbook (0.0.1)
+      bubble-wrap
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    bubble-wrap (1.1.1)
+    diff-lcs (1.1.3)
+    rake (0.9.2.2)
+    rspec (2.10.0)
+      rspec-core (~> 2.10.0)
+      rspec-expectations (~> 2.10.0)
+      rspec-mocks (~> 2.10.0)
+    rspec-core (2.10.1)
+    rspec-expectations (2.10.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.10.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bubble-wrap
+  motion-addressbook!
+  rake
+  rspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Alex Rothenberg
+
+MIT License
+
+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,61 @@
+# Addressbook for RubyMotion
+
+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)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'motion-addressbook'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install motion-addressbook
+
+## Usage
+
+### List all people
+
+```ruby
+    AddressBook::Person.all
+    # => [#<AddressBook::Person:0x6d55e90 @attributes={:first_name=>"Alex", :last_name=>"Rothenberg", :job_title=>nil, :department=>nil, :organization=>nil} @ab_person=#<__NSCFType:0x6df8bf0>>,
+    #     #<AddressBook::Person:0x6d550a0 @attributes={:first_name=>"Laurent", :last_name=>"Sansonetti", :job_title=>nil, :department=>nil, :organization=>"HipByte"} @ab_person=#<__NSCFType:0x6df97d0>>]
+```
+
+
+### Create a new Contact and save in Contacts app
+
+```ruby
+    alex = AddressBook::Person.new(:first_name => 'Alex', :last_name => 'Rothenberg', :email => 'alex@example.com')
+    alex.save
+```
+
+### Get an existing Contact
+
+```ruby
+    alex = AddressBook::Person.new(:first_name => 'Alex', :email => 'alex@example.com')
+    alex.last_name
+    # => 'Rothenberg'
+```
+
+### Update existing contact
+
+```ruby
+    alex = AddressBook::Person.new(:first_name => 'Alex', :email => 'alex@example.com')
+    alex.job_title = 'RubyMotion Developer'
+    alex.save
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+$:.unshift("/Library/RubyMotion/lib")
+require 'motion/project'
+require "bundler/gem_tasks"
+Bundler.setup
+Bundler.require
+
+require 'bubble-wrap/test'

data/lib/motion-addressbook/version.rb

@@ -0,0 +1,5 @@
+module Motion
+  module Addressbook
+    VERSION = "0.0.1"
+  end
+end

data/lib/motion-addressbook.rb

@@ -0,0 +1,5 @@
+require "motion-addressbook/version"
+
+BubbleWrap.require 'motion/address_book.rb'
+BW.require 'motion/address_book/multi_value.rb'
+BW.require 'motion/address_book/person.rb'

data/motion/address_book/multi_value.rb

@@ -0,0 +1,46 @@
+module AddressBook
+  class MultiValue
+    attr_reader :multivalueIdentifier, :ab_multi_values
+    
+    def initialize(ab_multi_values=nil)
+      @ab_multi_values = ab_multi_values ? ABMultiValueCreateMutableCopy(ab_multi_values) : ABMultiValueCreateMutable(KABMultiStringPropertyType)
+      # @ab_multi_values = ABMultiValueCreateMutable(KABMultiStringPropertyType)
+    end
+    
+    def set(ab_label, value)
+      return if values.include? value  #temp because blank? not working
+      if blank?(ab_label)
+        ABMultiValueAddValueAndLabel(@ab_multi_values, value, ab_label, multivalueIdentifier) unless value.nil?
+      else
+        # untested!!!
+        ABMultiValueReplaceValueAtIndex(@ab_multi_values, value, index_for(ab_label))
+      end
+    end
+
+    def set_many(new_values)
+      new_values.each do |ab_label, value|
+        set(ab_label, value)
+      end
+    end
+    
+    def values
+      ABMultiValueCopyArrayOfAllValues(@ab_multi_values) || []
+    end
+    
+    def include? value
+      return false if values.nil?
+      values.include? value
+    end
+    
+    private
+    def blank?(ab_label)
+      index_for(ab_label) == -1
+    end
+      
+    def index_for(ab_label)
+      return -1 # Keep getting this error :(  <ArgumentError: invalid value for Integer: "_$!<Work>!$_">
+      # ABMultiValueGetIndexForIdentifier(@ab_multi_values, ab_label)
+    end
+      
+  end
+end

data/motion/address_book/person.rb

@@ -0,0 +1,153 @@
+module AddressBook
+  class Person
+    attr_reader :attributes, :error, :ab_person
+
+    def initialize(attributes, ab_person = nil)
+      @attributes = attributes
+      load_ab_person(ab_person)
+    end
+
+    def self.all
+      address_book = ABAddressBookCreate()
+      ABAddressBookCopyArrayOfAllPeople(address_book).map do |ab_person|
+        new({}, ab_person)
+      end
+    end
+
+    def self.create(attributes)
+      person = new(attributes)
+      person.save
+      person
+    end
+
+    def save
+      ABAddressBookAddRecord(address_book, ab_person, error)
+      ABAddressBookSave(address_book, error )
+      @address_book = nil #force refresh
+    end
+
+    def attribute_map
+      { :first_name   => KABPersonFirstNameProperty,
+        :last_name    => KABPersonLastNameProperty,
+        :job_title    => KABPersonJobTitleProperty,
+        :department   => KABPersonDepartmentProperty,
+        :organization => KABPersonOrganizationProperty
+      }
+    end
+
+    def method_missing(name, *args)
+      name.to_s =~ /^(\w*)(=?)$/
+      attribute_name = $1.to_sym unless $1.nil?
+      if attribute_map.include? attribute_name
+        if $2 == '='
+          set_field(attribute_map[attribute_name], args.first)
+          attributes[attribute_name] = args.first
+        else
+          attributes[attribute_name] ||= get_field(attribute_map[attribute_name])
+        end
+      else
+        super
+      end
+    end
+
+    def photo
+      ABPersonCopyImageData(ab_person)
+    end
+
+    def photo=(photo_data)
+      ABPersonSetImageData(ab_person, photo_data, error)
+    end
+
+
+    def phone_numbers
+      get_multi_field(KABPersonPhoneProperty)
+    end
+
+    def phone_number_values
+      phone_numbers.values
+    end
+
+    def emails
+      get_multi_field(KABPersonEmailProperty )
+    end
+
+    def email_values
+      emails.values
+    end
+
+    # private
+
+    def load_ab_person(ab_person = nil)
+      @ab_person = ab_person || find_or_new
+      set_field(KABPersonFirstNameProperty,    attributes[:first_name  ]) unless attributes[:first_name  ].nil?
+      set_field(KABPersonLastNameProperty,     attributes[:last_name   ]) unless attributes[:last_name   ].nil?
+      set_field(KABPersonJobTitleProperty,     attributes[:job_title   ]) unless attributes[:job_title   ].nil?
+      set_field(KABPersonDepartmentProperty,   attributes[:department  ]) unless attributes[:department  ].nil?
+      set_field(KABPersonOrganizationProperty, attributes[:organization]) unless attributes[:organization].nil?
+      set_multi_field(KABPersonPhoneProperty,  KABPersonPhoneMobileLabel => attributes[:mobile_phone], KABWorkLabel => attributes[:office_phone])
+      set_multi_field(KABPersonEmailProperty,  KABWorkLabel => attributes[:email])
+    end
+
+    def set_field(field, value)
+      ABRecordSetValue(ab_person, field, value, error)
+    end
+    def get_field(field)
+      ABRecordCopyValue(ab_person, field)
+    end
+
+    def set_multi_field(field, values)
+      multi_field = MultiValue.new(ABRecordCopyValue(ab_person, field))
+      multi_field.set_many(values)
+      ABRecordSetValue(ab_person, field, multi_field.ab_multi_values, error )
+    end
+    def get_multi_field(field)
+      MultiValue.new(ABRecordCopyValue(ab_person, field))
+    end
+
+    def find_or_new
+      if new_record?
+        ab_person = ABPersonCreate()
+        ABAddressBookAddRecord(address_book, ab_person, error )
+        ab_person
+      else
+        existing_record
+      end
+    end
+
+    def existing_records
+      potential_matches = ABAddressBookCopyPeopleWithName(address_book, attributes[:first_name])
+      potential_matches.select do |record|
+        multi_field = MultiValue.new ABRecordCopyValue(record, KABPersonEmailProperty)
+        multi_field.include? attributes[:email]
+      end
+    end
+
+    def exists?
+      !new_record?
+    end
+    def new_record?
+      existing_record.nil?
+    end
+    def existing_record
+      # what if there are more than one match? email should be unique but ...
+      existing_records.first
+    end
+
+    def address_book
+      @address_book ||= ABAddressBookCreate()
+    end
+
+    def inspect
+      # ensure all attributes loaded
+      attribute_map.keys.each do |attribute|
+        self.send(attribute)
+      end
+
+      super
+    end
+
+    # def define_some_constants
+    #   [KABWorkLabel, KABOtherLabel, KABHomeLabel]
+    # end
+  end
+end

data/motion-addressbook.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/motion-addressbook/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Alex Rothenberg"]
+  gem.email         = ["alex@alexrothenberg.com"]
+  gem.description   = %q{A RubyMotion wrapper around the iOS Address Book framework}
+  gem.summary       = %q{A RubyMotion wrapper around the iOS Address Book framework}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "motion-addressbook"
+  gem.require_paths = ["lib"]
+  gem.version       = Motion::Addressbook::VERSION
+  
+  gem.add_dependency 'bubble-wrap'
+  gem.add_development_dependency 'rake'  
+  gem.add_development_dependency 'rspec'
+end

data/spec/address_book/multi_value_spec.rb

@@ -0,0 +1,66 @@
+describe AddressBook::MultiValue do
+  describe 'new field' do
+    before do
+      @multi_value = AddressBook::MultiValue.new
+    end
+
+    describe 'setting one value' do
+      before { @multi_value.set(KABWorkLabel, 'alex@work.com') }
+      it 'gives access to the values' do
+        @multi_value.values.should == ['alex@work.com']
+      end
+      it 'should know if the value exists' do
+        @multi_value.include?('alex@work.com').should.be.true 
+      end
+
+      it 'should know if the value exists' do
+        @multi_value.include?('not@there.com').should.be.false 
+      end
+    end
+    describe 'setting many values' do
+      before { @multi_value.set_many(KABWorkLabel => 'alex@work.com', KABHomeLabel => 'alex@home.com') }
+      it 'gives access to the values' do
+        @multi_value.values.should == ['alex@work.com', 'alex@home.com']
+      end
+      it 'should know both values exist' do
+        @multi_value.include?('alex@work.com').should.be.true 
+        @multi_value.include?('alex@home.com').should.be.true 
+      end
+
+      it 'should know if the value exists' do
+        @multi_value.include?('not@there.com').should.be.false 
+      end
+    end
+  end
+
+  describe 'existing field' do
+    before do
+      old_multi_value = AddressBook::MultiValue.new
+      old_multi_value.set(KABWorkLabel, 'alex@work.com')
+      
+      @multi_value = AddressBook::MultiValue.new old_multi_value.ab_multi_values
+    end
+    
+    it 'should have the value' do
+      @multi_value.values.should == ['alex@work.com']
+    end
+    
+    it 'should be able to update the value' do
+      @multi_value.set(KABWorkLabel, 'alex@new_work.com')
+      puts '******PENDING******  Waiting for RubyMotion ABMultiValueGetIndexForIdentifier fix'
+      @multi_value.values.should == ['alex@work.com', 'alex@new_work.com'] # ['alex@new_work.com']
+    end
+
+    it 'should ignore when updating an existing value to the same value' do
+      @multi_value.set(KABWorkLabel, 'alex@work.com')
+      @multi_value.values.should == ['alex@work.com']
+    end
+
+    it 'should be able to add an additional value' do
+      @multi_value.set(KABHomeLabel, 'alex@home.com')
+      @multi_value.values.should == ['alex@work.com', 'alex@home.com']
+    end
+
+  end
+  
+end

data/spec/address_book/person_spec.rb

@@ -0,0 +1,137 @@
+describe AddressBook::Person do
+  describe '.all' do
+    before do
+      @person = AddressBook::Person.create({:first_name => 'Alex', :last_name=>'Rothenberg'})
+    end
+    it 'should have the person we created' do
+      all_names = AddressBook::Person.all.map do |person|
+        [person.first_name, person.last_name]
+      end
+      all_names.should.include? ['Alex', 'Rothenberg'] 
+    end
+    
+    it 'should get bigger when we create another' do 
+      initial_people_count = AddressBook::Person.all.size
+      @person = AddressBook::Person.create({:first_name => 'Alex2', :last_name=>'Rothenberg2'})
+      AddressBook::Person.all.size.should == (initial_people_count + 1)
+    end
+  end
+
+  describe 'save' do
+    before do
+      unique_email = "alex_#{Time.now.to_i}@example.com"
+      @attributes = {:first_name=>'Alex', :last_name=>'Testy',
+                     :job_title => 'Developer', :department => 'Development', :organization => 'The Company',
+                     :mobile_phone => '123 456 7890', :office_phone => '987 654 3210',
+                     :email => unique_email
+                    }
+    end
+
+    describe 'a new person' do
+      before do
+        @ab_person = AddressBook::Person.new(@attributes)
+      end
+
+      it 'should not be existing' do
+        @ab_person.should.be.new_record
+        @ab_person.should.not.be.exists
+      end
+
+      it 'should be able to get each of the single value fields' do
+        @ab_person.first_name.should.equal   @attributes[:first_name  ]
+        @ab_person.last_name.should.equal    @attributes[:last_name   ]
+        @ab_person.job_title.should.equal    @attributes[:job_title   ]
+        @ab_person.department.should.equal   @attributes[:department  ]
+        @ab_person.organization.should.equal @attributes[:organization]
+      end
+
+      describe 'setting each field' do
+        it 'should be able to set the first name' do
+          @ab_person.first_name = 'new first name'
+          @ab_person.first_name.should.equal 'new first name'
+        end
+        it 'should be able to set the last name' do
+          @ab_person.last_name = 'new last name'
+          @ab_person.last_name.should.equal 'new last name'
+        end
+        it 'should be able to set the job title' do
+          @ab_person.job_title = 'new job title'
+          @ab_person.job_title.should.equal 'new job title'
+        end
+        it 'should be able to set the department' do
+          @ab_person.department = 'new department'
+          @ab_person.department.should.equal 'new department'
+        end
+        it 'should be able to set the organization' do
+          @ab_person.organization = 'new organization'
+          @ab_person.organization.should.equal 'new organization'
+        end
+
+        it 'should be able to set the phot' do
+          image = CIImage.emptyImage
+          data = UIImagePNGRepresentation(UIImage.imageWithCIImage image)
+          @ab_person.photo = data
+          UIImagePNGRepresentation(@ab_person.photo).should.equal data
+        end
+
+      end
+
+      it 'should be able to get the phone numbers' do
+        @ab_person.phone_number_values.should.equal [@attributes[:mobile_phone], @attributes[:office_phone] ]
+      end
+
+      it 'should be able to get the emails' do
+        @ab_person.email_values.should.equal [@attributes[:email] ]
+      end
+      describe 'saving' do
+        before do
+          @ab_person.save
+        end
+        it 'after saving it should not be existing' do
+          @ab_person.should.not.be.new_record
+          @ab_person.should.be.exists
+        end
+      end
+    end
+
+    describe 'updating an existing person' do
+      before do
+        AddressBook::Person.new(@attributes).save
+        @attributes[:job_title   ] = 'i got promoted'
+        @attributes[:office_phone] = '111 222 3333'
+        # @attributes[:department  ] = nil
+        @ab_person = AddressBook::Person.new(@attributes)
+      end
+
+      it 'should know it is not new' do
+        @ab_person.should.not.be.new_record
+        @ab_person.should.be.exists
+        @ab_person.department.should == 'Development'
+      end
+
+      describe 'updating' do
+        before do
+          @ab_person.save
+          @new_ab_person = AddressBook::Person.new :first_name=>@attributes[:first_name], :email => @attributes[:email]
+        end
+        it 'should be able to get each of the single value fields' do
+          @new_ab_person.first_name.should.equal   @attributes[:first_name  ]
+          @new_ab_person.last_name.should.equal    @attributes[:last_name   ]
+          @new_ab_person.job_title.should.equal    @attributes[:job_title   ]
+          @new_ab_person.department.should.equal   @attributes[:department  ]
+          @new_ab_person.organization.should.equal @attributes[:organization]
+        end
+        it 'should be able to get the phone numbers (we never delete and just add - not sure if this is "right")' do
+          @new_ab_person.phone_number_values.should.equal [@attributes[:mobile_phone], '987 654 3210', @attributes[:office_phone]]
+        end
+
+        it 'should be able to get the emails' do
+          @new_ab_person.email_values.should.equal [@attributes[:email] ]
+        end
+      end
+
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: motion-addressbook
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Alex Rothenberg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bubble-wrap
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A RubyMotion wrapper around the iOS Address Book framework
+email:
+- alex@alexrothenberg.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/motion-addressbook.rb
+- lib/motion-addressbook/version.rb
+- motion-addressbook.gemspec
+- motion/address_book/multi_value.rb
+- motion/address_book/person.rb
+- spec/address_book/multi_value_spec.rb
+- spec/address_book/person_spec.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4038011897139577156
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4038011897139577156
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A RubyMotion wrapper around the iOS Address Book framework
+test_files:
+- spec/address_book/multi_value_spec.rb
+- spec/address_book/person_spec.rb