motion-addressbook 0.1.1 → 0.1.2

data/.gitignore

@@ -3,8 +3,7 @@ build
 resources/*.nib
 resources/*.momd
 resources/*.storyboardc
-
-resources/photos/[1-9]*/*
+Gemfile.lock
 
 vendor/Pods/Pods.xcodeproj/project.pbxproj
 vendor/Pods/build*

data/README.md

@@ -20,6 +20,62 @@ Or install it yourself as:
 
 ## Usage
 
+### Requesting access
+
+iOS 6 requires asking the user for permission before it allows an app to access the AddressBook.  There are 3 ways to interact with this
+
+1 - Let the gem take care of it for you
+
+```ruby
+people = AddressBook::Person.all
+# A dialog may be presented to the user before "people" was returned
+```
+
+2 - Manually decide when to ask the user for authorization
+
+```ruby
+# asking whether we are already authorized
+if AddressBook.authorized?
+  puts "This app is authorized?"
+else
+  puts "This app is not authorized?"
+end
+
+# ask the user to authorize us
+if AddressBook.authorize
+  # do something now that the user has said "yes"
+else
+  # do something now that the user has said "no"
+end
+```
+
+3 - Manually ask the user but do it asynchronously (this is how Apple's API works)
+
+```ruby
+# ask the user to authorize us
+if AddressBook.authorize do |granted|
+  # this block is invoked sometime later
+  if granted
+    # do something now that the user has said "yes"
+  else
+    # do something now that the user has said "no"
+  end
+end
+# do something here before the user has decided
+```
+
+### Showing the ABPeoplePicker
+
+```ruby
+AddressBook.pick { |person|
+  if person
+    # person is an AddressBook::Person object
+  else
+    # canceled
+  end
+}
+```
+
 ### Instantiating a person object
 
 There are 3 ways to instantiate a person object

data/Rakefile

@@ -5,4 +5,4 @@ require "bundler/gem_tasks"
 Bundler.setup
 Bundler.require
 
-require 'bubble-wrap/test'
+require 'bubble-wrap/test'

data/lib/motion-addressbook/version.rb

@@ -1,5 +1,5 @@
 module Motion
   module Addressbook
-    VERSION = "0.1.1"
+    VERSION = "0.1.2"
   end
 end

data/lib/motion-addressbook.rb

@@ -1,5 +1,10 @@
 require "motion-addressbook/version"
 
-BubbleWrap.require 'motion/address_book.rb'
+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/person.rb'
+BW.require 'motion/address_book/picker.rb' do
+  file('motion/address_book/picker.rb').uses_framework('AddressBookUI')
+end

data/motion/address_book/multi_value.rb

@@ -17,14 +17,14 @@ module AddressBook
     def attribute_map
       self.class.attribute_map
     end
-    
+
     def alex
       ABMultiValueGetIdentifierAtIndex @ab_multi_values, 0
     end
 
     def initialize(attributes={}, existing_ab_multi_values=nil)
       @attributes = {}
-      if existing_ab_multi_values 
+      if existing_ab_multi_values
         @ab_multi_values = ABMultiValueCreateMutableCopy(existing_ab_multi_values)
         load_attributes_from_ab
       else
@@ -49,7 +49,7 @@ module AddressBook
       return false if attribute_name.nil?
       attribute_map.include?(attribute_name.to_sym) || [:email, :phone_number].include?( attribute_name.to_sym)
     end
-    
+
     def getter?(method_name)
       if self.class.is_attribute? method_name
         method_name
@@ -69,7 +69,7 @@ module AddressBook
     def get(attribute_name)
       attributes[attribute_name.to_sym] ||= get_field(attribute_map[attribute_name])
     end
-    
+
     def set(attribute_name, value)
       set_field(attribute_map[attribute_name.to_sym], value)
       attributes[attribute_name.to_sym] = value
@@ -117,4 +117,4 @@ module AddressBook
     end
 
   end
-end
+end

data/motion/address_book/person.rb

@@ -14,10 +14,11 @@ module AddressBook
     end
 
     def self.all
-      address_book = ABAddressBookCreate()
-      ABAddressBookCopyArrayOfAllPeople(address_book).map do |ab_person|
+      people = ABAddressBookCopyArrayOfAllPeople(AddressBook.address_book).map do |ab_person|
         new({}, ab_person)
       end
+      people.sort! { |a,b| "#{a.first_name} #{a.last_name}" <=> "#{b.first_name} #{b.last_name}" }
+      people
     end
 
     def self.create(attributes)
@@ -32,13 +33,13 @@ module AddressBook
       @address_book = nil #force refresh
       @new_record = false
     end
-    
+
     def self.where(conditions)
       all.select do |person|
         person.meets? conditions
       end
     end
-    
+
     def meets?(conditions)
       conditions.keys.all? do |attribute|
         send(attribute) == conditions[attribute]
@@ -77,12 +78,12 @@ module AddressBook
       else
         super
       end
-    end    
+    end
     def self.is_attribute?(attribute_name)
       return false if attribute_name.nil?
       attribute_map.include?(attribute_name.to_sym) || [:email, :phone_number].include?( attribute_name.to_sym)
     end
-    
+
     def getter?(method_name)
       if self.class.is_attribute? method_name
         method_name
@@ -122,16 +123,16 @@ module AddressBook
         nil
       end
     end
-    
+
     def get(attribute_name)
       attributes[attribute_name.to_sym] ||= get_field(attribute_map[attribute_name])
     end
-    
+
     def set(attribute_name, value)
       set_field(attribute_map[attribute_name.to_sym], value)
       attributes[attribute_name.to_sym] = value
     end
-    
+
     def self.find_all_by(attribute_name, criteria)
       where({attribute_name.to_sym => criteria})
     end
@@ -141,7 +142,7 @@ module AddressBook
     def self.find_or_new_by(attribute_name, criteria)
       find_by(attribute_name, criteria) || new({attribute_name.to_sym => criteria})
     end
-      
+
     def photo
       ABPersonCopyImageData(ab_person)
     end
@@ -166,7 +167,7 @@ module AddressBook
     def email_values
       emails.values
     end
-    
+
     # UGH - kinda arbitrary way to deal with multiple values.  DO SOMETHING BETTER.
     def email
       @attributes[:email] ||= email_values.first
@@ -247,8 +248,8 @@ module AddressBook
     end
 
     def address_book
-      @address_book ||= ABAddressBookCreate()
+      @address_book ||= AddressBook.address_book
     end
 
   end
-end
+end

data/motion/address_book/picker.rb

@@ -0,0 +1,60 @@
+module AddressBook
+  class Picker
+    class << self
+      attr_accessor :showing
+    end
+    def self.show(&after)
+      raise "Cannot show two Pickers" if showing?
+      @picker = Picker.new(&after)
+      @picker.show
+      @picker
+    end
+
+    def self.showing?
+      !!showing
+    end
+
+    def initialize(&after)
+      @after = after
+    end
+
+    def show
+      self.class.showing = true
+
+      @people_picker_ctlr = ABPeoplePickerNavigationController.alloc.init
+      @people_picker_ctlr.peoplePickerDelegate = self
+      UIApplication.sharedApplication.keyWindow.rootViewController.presentViewController(@people_picker_ctlr, animated:true, completion:nil)
+    end
+
+    def hide(ab_person=nil)
+      person = ab_person ? AddressBook::Person.new({}, ab_person) : nil
+
+      UIApplication.sharedApplication.keyWindow.rootViewController.dismissViewControllerAnimated(true, completion:lambda{
+        @after.call(person) if @after
+        self.class.showing = false
+      })
+    end
+
+    def peoplePickerNavigationController(people_picker, shouldContinueAfterSelectingPerson:ab_person)
+      hide(ab_person)
+      false
+    end
+
+    def peoplePickerNavigationController(people_picker, shouldContinueAfterSelectingPerson:ab_person, property:property, identifier:id)
+      hide(ab_person)
+      false
+    end
+
+    def peoplePickerNavigationControllerDidCancel(people_picker)
+      hide
+    end
+  end
+end
+
+module AddressBook
+  module_function
+  def pick(&after)
+    AddressBook::Picker.show &after
+  end
+end
+

data/motion/address_book.rb

@@ -0,0 +1,60 @@
+module AddressBook
+  module_function
+
+  def address_book
+    if UIDevice.currentDevice.systemVersion >= '6'
+      ios6_create
+    else
+      ios5_create
+    end
+  end
+
+  def ios6_create
+    error = nil
+    address_book = ABAddressBookCreateWithOptions(nil, error)
+    request_authorization unless authorized?
+    address_book
+  end
+
+  def ios5_create
+    ABAddressBookCreate()
+  end
+
+  def request_authorization(&block)
+    synchronous = !!block
+    access_callback = lambda { |granted, error|
+      # not sure what to do with error ... so we're ignoring it
+      @address_book_access_granted = granted
+      block.call(@address_book_access_granted) unless block.nil?
+    }
+
+    ABAddressBookRequestAccessWithCompletion address_book, access_callback
+    if synchronous
+      # Wait on the asynchronous callback before returning.
+      while @address_book_access_granted.nil? do
+        sleep 0.1
+      end
+    end
+    @address_book_access_granted
+  end
+
+  def authorized?
+    authorization_status == :authorized
+  end
+
+  def authorization_status
+    return :authorized unless UIDevice.currentDevice.systemVersion >= '6'
+
+    status_map = { KABAuthorizationStatusNotDetermined => :not_determined,
+                   KABAuthorizationStatusRestricted    => :restricted,
+                   KABAuthorizationStatusDenied        => :denied,
+                   KABAuthorizationStatusAuthorized    => :authorized
+                 }
+    status_map[ABAddressBookGetAuthorizationStatus()]
+  end
+
+  def create_with_options_available?
+    error = nil
+    ABAddressBookCreateWithOptions(nil, error) rescue false
+  end
+end

data/spec/address_book/multi_value_spec.rb

@@ -2,12 +2,12 @@ describe AddressBook::MultiValue do
   describe 'properties on a new multivalue' do
     describe 'initializing with values' do
       before do
-        @attributes = { :mobile   => '123-456-7890',   :iphone   => '222-333-4444',   :main  => '555-1212', 
+        @attributes = { :mobile   => '123-456-7890',   :iphone   => '222-333-4444',   :main  => '555-1212',
                         :home_fax => '1-617-555-8000', :work_fax => '1-212-555-0000', :pager => '99-9999-9999',
                         :work     => 'alex@work.com',  :home     => 'alex@home.com',  :other => 'alex@other.com'}
         @multi_value = AddressBook::MultiValue.new @attributes
       end
-    
+
       it 'should be able to get each of the single value fields' do
         @multi_value.mobile.should.equal   @attributes[:mobile  ]
         @multi_value.iphone.should.equal   @attributes[:iphone  ]
@@ -19,7 +19,7 @@ describe AddressBook::MultiValue do
         @multi_value.home.should.equal     @attributes[:home    ]
         @multi_value.other.should.equal    @attributes[:other   ]
       end
-      
+
       it 'should give all the values in a list' do
         @multi_value.values.should == ["123-456-7890", "222-333-4444", "555-1212", "1-617-555-8000", "1-212-555-0000", "99-9999-9999", "alex@work.com", "alex@home.com", "alex@other.com"]
       end
@@ -68,13 +68,13 @@ describe AddressBook::MultiValue do
       end
     end
   end
-  
+
   describe 'an existing multivalue' do
     before do
       @first_multi_value = AddressBook::MultiValue.new :mobile => '123-456-7890', :iphone => '99-8888888-7777777-66'
       @multi_value = AddressBook::MultiValue.new({:mobile => '987654321', :home_fax => '777-6666-4444'}, @first_multi_value.ab_multi_values)
     end
-    
+
     it 'should ' do
       @multi_value.mobile.should == '987654321'
       @multi_value.iphone.should == '99-8888888-7777777-66'

data/spec/address_book/person_spec.rb

@@ -1,5 +1,4 @@
 describe AddressBook::Person do
-
   describe 'ways of creating and finding people' do
     describe 'new' do
       before do
@@ -12,7 +11,7 @@ describe AddressBook::Person do
         @alex.email_values.should     == ['alex_testy@example.com']
       end
     end
-    
+
     describe 'existing' do
       before do
         @email = unique_email
@@ -60,7 +59,7 @@ describe AddressBook::Person do
           alexes.should == []
         end
       end
-      
+
       describe '.all' do
         it 'should have the person we created' do
           all_names = AddressBook::Person.all.map do |person|
@@ -68,13 +67,13 @@ describe AddressBook::Person do
           end
           all_names.should.include? [@alex.first_name, @alex.last_name]
         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      
+      end
     end
 
     describe '.find_or_new_by_XXX - new or existing' do
@@ -107,17 +106,17 @@ describe AddressBook::Person do
                      :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   ]
@@ -125,7 +124,7 @@ describe AddressBook::Person do
         @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'
@@ -147,7 +146,7 @@ describe AddressBook::Person 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)
@@ -155,11 +154,11 @@ describe AddressBook::Person do
           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
@@ -173,7 +172,7 @@ describe AddressBook::Person do
         end
       end
     end
-  
+
     describe 'updating an existing person' do
       before do
         AddressBook::Person.new(@attributes).save
@@ -182,14 +181,14 @@ describe AddressBook::Person do
         @attributes[:department  ] = nil
         @ab_person = AddressBook::Person.find_or_new_by_email(@attributes[:email])
       end
-  
+
       it 'should know it is not new' do
         @ab_person.should.not.be.new_record
         @ab_person.should.be.exists
         @ab_person.first_name.should == 'Alex'
         @ab_person.department.should == 'Development'
       end
-  
+
       describe 'updating' do
         it 'should be able to get each of the single value fields' do
           @ab_person.save
@@ -199,11 +198,11 @@ describe AddressBook::Person do
           AddressBook::Person.find_by_email(@ab_person.email).first_name.should == 'New First Name'
         end
       end
-  
+
     end
-  
+
   end
-  
+
   describe 'method missing magic' do
     before do
       @person = AddressBook::Person.new

data/spec/address_book/picker_spec.rb

@@ -0,0 +1,34 @@
+# I don't know how to test a class wrapping a controller like this yet
+#
+# describe AddressBook::Picker do
+#   describe 'IOS UI for finding people' do
+#     before do
+#       @selected_person = nil
+#       @picker = AddressBook.pick do |person|
+#         @selected_person = person
+#       end
+#     end
+
+#     it 'should yield the selected person' do
+#       ab_person = AddressBook::Person.new(first_name: 'Colin').ab_person
+#       @picker.peoplePickerNavigationController(@picker_nav_controller, shouldContinueAfterSelectingPerson: ab_person)
+#       @selected_person.should.not == nil
+#       @selected_person.first_name.should == 'Colin'
+#     end
+
+#     it 'should yield the selected person' do
+#       property = :some_property
+#       id = :some_id
+#       ab_person = AddressBook::Person.new(first_name: 'Colin').ab_person
+#       @picker.peoplePickerNavigationController(@picker_nav_controller, shouldContinueAfterSelectingPerson: ab_person, property:property, identifier:id)
+#       @selected_person.should.not == nil
+#       @selected_person.first_name.should == 'Colin'
+#     end
+
+#     it 'should yield nil when cancelled' do
+#       ab_person = AddressBook::Person.new(first_name: 'Colin').ab_person
+#       @picker.peoplePickerNavigationControllerDidCancel(@picker_nav_controller)
+#       @selected_person.should == nil
+#     end
+#   end
+# end

data/spec/helpers/hacks.rb

@@ -1,3 +1,6 @@
-# The value of these constants is undefined until one of the following functions has been called: ABAddressBookCreate, ABPersonCreate, ABGroupCreate.
-# see https://developer.apple.com/library/ios/#documentation/AddressBook/Reference/ABPersonRef_iPhoneOS/Reference/reference.html and search for "Discussion"
-ABAddressBookCreate()
+# The value of these constants is undefined until one of the following functions has been called:
+# ABAddressBookCreate, ABPersonCreate, ABGroupCreate.
+# see https://developer.apple.com/library/ios/#documentation/AddressBook/Reference/ABPersonRef_iPhoneOS/Reference/reference.html
+#     and search for "Discussion"
+# WTF: Why would an API define a constant this way?!?!
+AddressBook.address_book

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: motion-addressbook
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-08 00:00:00.000000000 Z
+date: 2012-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bubble-wrap
@@ -68,17 +68,19 @@ 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.rb
 - motion/address_book/multi_value.rb
 - motion/address_book/person.rb
+- motion/address_book/picker.rb
 - spec/address_book/multi_value_spec.rb
 - spec/address_book/person_spec.rb
+- spec/address_book/picker_spec.rb
 - spec/helpers/bacon_matchers.rb
 - spec/helpers/hacks.rb
 - spec/helpers/person_helpers.rb
@@ -96,7 +98,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2733254916178873065
+      hash: 4255124381672907442
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -105,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2733254916178873065
+      hash: 4255124381672907442
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -115,6 +117,7 @@ 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
+- spec/address_book/picker_spec.rb
 - spec/helpers/bacon_matchers.rb
 - spec/helpers/hacks.rb
 - spec/helpers/person_helpers.rb

data/Gemfile.lock

@@ -1,29 +0,0 @@
-PATH
-  remote: .
-  specs:
-    motion-addressbook (0.1.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