ruby-fs-stack 0.3.0 → 0.3.2

data/README.rdoc

@@ -98,6 +98,19 @@ or for the pure Ruby implementation
   new_person.id #=> 'KWQS-ZZZ'
   new_person.version #=> '687799'
 
+=== Selecting the Summary View
+  
+  # assuming you know the value IDs that you want to set as summary
+  # grab a person with the ID and version set
+  person = communicator.familytree_v2.person 'KWQS-BBQ', :names => 'none', :events => 'none', :genders => 'none'
+  person.select_name_summary "100078"
+  person.select_birth_summary "1089498"
+  person.select_death_summary "7834987"
+  # you must set both the mother and the father summary unless you want a single parent as the summary parents.
+  person.select_mother_summary "KWQS-MOM"
+  person.select_father_summary "KWQS-DAD"
+  communicator.save_person person
+
 == RDoc
 
 RDoc is hosted at rdoc.info:

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.3.2

data/lib/ruby-fs-stack/familytree.rb

@@ -52,7 +52,7 @@ module FamilytreeV2
           url = Base + 'person/' + id
         end
       end
-      url += "?"+FsUtils.querystring_from_hash(options) unless options.empty?
+      url += add_querystring(options)
       response = @fs_communicator.get(url)
       familytree = Org::Familysearch::Ws::Familytree::V2::Schema::FamilyTree.from_json JSON.parse(response.body)
       if multiple_ids
@@ -82,7 +82,7 @@ module FamilytreeV2
     # <tt>search_params</tt> - A hash of search parameters matching API doc
     def search(search_params)
       url = Base + 'search'
-      url += "?" + FsUtils.querystring_from_hash(search_params) unless search_params.empty?
+      url += add_querystring(search_params)
       response = @fs_communicator.get(url)
       familytree = Org::Familysearch::Ws::Familytree::V2::Schema::FamilyTree.from_json JSON.parse(response.body)
       # require 'pp'
@@ -106,7 +106,7 @@ module FamilytreeV2
       else
         raise ArgumentError, "first parameter must be a kind of String or Hash"
       end
-      url += "?" + FsUtils.querystring_from_hash(params_hash) unless params_hash.empty?
+      url += add_querystring(params_hash) #"?" + FsUtils.querystring_from_hash(params_hash) unless params_hash.empty?
       response = @fs_communicator.get(url)
       familytree = Org::Familysearch::Ws::Familytree::V2::Schema::FamilyTree.from_json JSON.parse(response.body)
       # require 'pp'
@@ -152,7 +152,7 @@ module FamilytreeV2
       url = "#{Base}person/#{base_id}/#{relationship_type}/#{with_id}"
 
       # Get the existing person/relationship or create a new person
-      unless person = relationship(base_id,options)
+      unless person = relationship(base_id,options.merge({:events => 'none'}))
         person = Org::Familysearch::Ws::Familytree::V2::Schema::Person.new
         person.id = base_id
       end
@@ -177,7 +177,9 @@ module FamilytreeV2
     
     # ====Params
     # * <tt>base_id</tt> - The root person for creating the relationship
-    # * <tt>options</tt> - Should include either :parent, :spouse, or :child. :lineage and :event is optional
+    # * <tt>options</tt> - Should include either :parent, :spouse, or :child. :lineage and :event is optional.
+    #   Other Relationship Read parameters may be included in options such as :events => 'all', 
+    #   :characteristics => 'all', etc.
     #
     # If the :lineage is set, the parent-child relationships will be written via a characteristic.
     # Otherwise, an exists assertion will be created to just establish the relationship.
@@ -190,6 +192,7 @@ module FamilytreeV2
         r_type = get_relationship_type(options)
         with_id = options[r_type.to_sym]
         url = "#{Base}person/#{base_id}/#{r_type}/#{with_id}"
+        url += add_querystring(options)
         res = @fs_communicator.get(url)
         familytree = Org::Familysearch::Ws::Familytree::V2::Schema::FamilyTree.from_json JSON.parse(res.body)
         person = familytree.persons.find{|p|p.id == base_id}
@@ -222,6 +225,11 @@ module FamilytreeV2
       key = keys.find{|k| ['parent','child','spouse'].include? k} 
       key
     end
+    
+    def add_querystring(options)
+      params = options.reject{|k,v| ['parent','child','spouse','lineage','event'].include? k.to_s }
+      (params.empty?) ? '' : "?" + FsUtils.querystring_from_hash(params)
+    end
   end
   
 end
@@ -292,6 +300,12 @@ module Org::Familysearch::Ws::Familytree::V2::Schema
       self.value = NameValue.new
       self.value.add_form(value)
     end
+    
+    def select(value_id)
+      self.action = 'Select'
+      self.value = AssertionValue.new
+      self.value.id = value_id
+    end
   end
   
   class EventValue
@@ -321,6 +335,13 @@ module Org::Familysearch::Ws::Familytree::V2::Schema
       self.value.add_place(options[:place]) if options[:place]
     end
     
+    def select(type,value_id)
+      self.value = EventValue.new
+      self.value.id = value_id
+      self.value.type = type
+      self.action = 'Select'
+    end
+    
     # To make porting code from v1 to v2 easier, date will reference
     # value.date
     def date
@@ -416,6 +437,13 @@ module Org::Familysearch::Ws::Familytree::V2::Schema
       n.add_value(value)
       self.names << n
     end
+    
+    def select_name(value_id)
+      self.names ||= []
+      n = NameAssertion.new
+      n.select(value_id)
+      self.names << n
+    end
         
     def add_event(options)
       self.events ||= []
@@ -424,12 +452,20 @@ module Org::Familysearch::Ws::Familytree::V2::Schema
       self.events << e
     end
     
+    def select_event_summary(type,value_id)
+      self.events ||= []
+      e = EventAssertion.new
+      e.select(type,value_id)
+      self.events << e
+    end
+    
     def add_ordinance(options)
       self.ordinances ||= []
       o = OrdinanceAssertion.new
       o.add_value(options)
       self.ordinances << o
     end
+    
   end
   
   class CharacteristicAssertion
@@ -529,6 +565,22 @@ module Org::Familysearch::Ws::Familytree::V2::Schema
     end
   end
   
+  class ParentsReference
+    def select_parent(parent_id, gender)
+      add_parents!
+      self.action = 'Select'
+      parent = PersonReference.new
+      parent.gender = gender
+      parent.id = parent_id
+      self.parents << parent
+    end
+    
+    private
+    def add_parents!
+      self.parents ||= []
+    end
+  end
+  
   class PersonRelationships
     def initialize
       @parents = []
@@ -665,6 +717,23 @@ module Org::Familysearch::Ws::Familytree::V2::Schema
       assertions.add_name(value)
     end
     
+    # Select the name for the summary view. This should be called on a Person record that
+    # contains a person id and version.
+    # 
+    # ====Params
+    # <tt>value_id</tt> - the value id of a name assertion that you would like to set as the summary
+    # 
+    # ===Example
+    #   person = com.familytree_v2.person 'KWQS-BBR', :names => 'none', :genders => 'none', :events => 'none'
+    #   person.select_name_summary('1000134')
+    #   com.familytree_v2.save_person person
+    # 
+    # This is the recommended approach, to start with a "Version" person (no names, genders, or events)
+    def select_name_summary(value_id)
+      add_assertions!
+      assertions.select_name(value_id)
+    end
+    
     def births
       select_events('Birth')
     end
@@ -702,6 +771,23 @@ module Org::Familysearch::Ws::Familytree::V2::Schema
       options[:type] = 'Birth'
       assertions.add_event(options)
     end
+    
+    # Select the birth for the summary view. This should be called on a Person record that
+    # contains a person id and version.
+    # 
+    # ====Params
+    # <tt>value_id</tt> - the value id of a birth assertion that you would like to set as the summary
+    # 
+    # ===Example
+    #   person = com.familytree_v2.person 'KWQS-BBR', :names => 'none', :genders => 'none', :events => 'none'
+    #   person.select_birth_summary('1000134')
+    #   com.familytree_v2.save_person person
+    # 
+    # This is the recommended approach, to start with a "Version" person (no names, genders, or events)
+    def select_birth_summary(value_id)
+      add_assertions!
+      assertions.select_event_summary('Birth',value_id)
+    end
         
     # Add an event with type of Birth
     #
@@ -717,6 +803,69 @@ module Org::Familysearch::Ws::Familytree::V2::Schema
       assertions.add_event(options)
     end
     
+    # Select the death for the summary view. This should be called on a Person record that
+    # contains a person id and version.
+    # 
+    # ====Params
+    # <tt>value_id</tt> - the value id of a death assertion that you would like to set as the summary
+    # 
+    # ===Example
+    #   person = com.familytree_v2.person 'KWQS-BBR', :names => 'none', :genders => 'none', :events => 'none'
+    #   person.select_death_summary('1000134')
+    #   com.familytree_v2.save_person person
+    # 
+    # This is the recommended approach, to start with a "Version" person (no names, genders, or events)
+    def select_death_summary(value_id)
+      add_assertions!
+      assertions.select_event_summary('Death',value_id)
+    end
+    
+    # Select the mother for the summary view. This should be called on a Person record that
+    # contains a person id and version. 
+    # 
+    # Make sure you set both the mother and father before saving the person. Otherwise you will 
+    # set a single parent as the summary.
+    # 
+    # ====Params
+    # <tt>person_id</tt> - the person id of the mother that you would like to set as the summary
+    # 
+    # ===Example
+    #   person = com.familytree_v2.person 'KWQS-BBR', :names => 'none', :genders => 'none', :events => 'none'
+    #   person.select_mother_summary('KWQS-BBQ')
+    #   person.select_father_summary('KWQS-BBT')
+    #   com.familytree_v2.save_person person
+    # 
+    # This is the recommended approach, to start with a "Version" person (no names, genders, or events)
+    def select_mother_summary(person_id)
+      add_parents!
+      couple = parents[0] || ParentsReference.new
+      couple.select_parent(person_id,'Female')
+      parents << couple 
+    end
+    
+    # Select the father for the summary view. This should be called on a Person record that
+    # contains a person id and version. 
+    # 
+    # Make sure you set both the mother and father before saving the person. Otherwise you will 
+    # set a single parent as the summary.
+    # 
+    # ====Params
+    # <tt>person_id</tt> - the person id of the father that you would like to set as the summary
+    # 
+    # ===Example
+    #   person = com.familytree_v2.person 'KWQS-BBR', :names => 'none', :genders => 'none', :events => 'none'
+    #   person.select_father_summary('KWQS-BBQ')
+    #   person.select_mother_summary('KWQS-BBT')
+    #   com.familytree_v2.save_person person
+    # 
+    # This is the recommended approach, to start with a "Version" person (no names, genders, or events)
+    def select_father_summary(person_id)
+      add_parents!
+      couple = parents[0] || ParentsReference.new
+      couple.select_parent(person_id,'Male')
+      parents << couple 
+    end
+    
     def baptisms
       select_ordinances('Baptism')
     end
@@ -844,6 +993,10 @@ module Org::Familysearch::Ws::Familytree::V2::Schema
   
     private
     
+    def add_parents!
+      self.parents ||= []
+    end
+    
     def add_relationships!
       self.relationships ||= PersonRelationships.new
     end

data/lib/ruby-fs-stack/fs_utils.rb

@@ -7,12 +7,12 @@ class FsUtils
         v.collect do |k2,v2|
           k2 = k2.to_s
           v2 = v2.to_s
-          url_encode(v2)
+          v2 = url_encode(v2)
           "#{k}.#{k2}=#{v2}"
         end.join('&')
       else
         v = v.to_s
-        self.url_encode(v)
+        v = self.url_encode(v)
         k + '=' + v
       end
     end
@@ -22,6 +22,6 @@ class FsUtils
   private
   def self.url_encode(string)
     # Taken from http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/156044
-    string.gsub!( /[^a-zA-Z0-9\-_\.!~*'()]/n ) {|x| sprintf('%%%02x', x[0]) }
+    string.gsub( /[^a-zA-Z0-9\-_\.!~*'()]/n ) {|x| sprintf('%%%02x', x[0]) }
   end
 end

data/ruby-fs-stack.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ruby-fs-stack}
-  s.version = "0.3.0"
+  s.version = "0.3.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jimmy Zimmerman"]
-  s.date = %q{2009-12-18}
+  s.date = %q{2010-01-07}
   s.description = %q{A library that enables you to read and update information with the new.familysearch.org API.}
   s.email = %q{jimmy.zimmerman@gmail.com}
   s.extra_rdoc_files = [

data/spec/familytree_v2/familytree_communicator_spec.rb

@@ -274,7 +274,7 @@ describe FamilytreeV2::Communicator do
       end
       
       it "should first try to read the relationship" do
-        @fs_com_mock.should_receive(:get).with('/familytree/v2/person/KWQS-BBQ/parent/KWQS-BBR').and_return(@res)
+        @fs_com_mock.should_receive(:get).with('/familytree/v2/person/KWQS-BBQ/parent/KWQS-BBR?events=none').and_return(@res)
         @ft_v2_com.write_relationship 'KWQS-BBQ', :parent => 'KWQS-BBR', :lineage => 'Biological'
       end
       
@@ -339,7 +339,7 @@ describe FamilytreeV2::Communicator do
       end
       
       it "should first try to read the relationship" do
-        @fs_com_mock.should_receive(:get).with('/familytree/v2/person/KWQS-BBQ/parent/KWQS-BBR').and_return(@res)
+        @fs_com_mock.should_receive(:get).with('/familytree/v2/person/KWQS-BBQ/parent/KWQS-BBR?events=none').and_return(@res)
         @ft_v2_com.write_relationship 'KWQS-BBQ', :parent => 'KWQS-BBR', :lineage => 'Biological'
       end
       

data/spec/familytree_v2/person_spec.rb

@@ -274,6 +274,104 @@ describe Org::Familysearch::Ws::Familytree::V2::Schema::Person do
       end
     end
     
+    describe "selecting summaries" do
+      before(:each) do
+        @person = parse_person('KJ86-3VD_version.js')
+      end
+      
+      describe "select_name_summary" do
+        
+        it "should accept a value ID" do
+          @person.select_name_summary('10001')
+        end
+        
+        it "should add a name assertion with action, value, and id" do
+          @person.select_name_summary('10001')
+          @person.assertions.names[0].value.id.should == '10001'
+          @person.assertions.names[0].action.should == 'Select'
+        end
+        
+      end
+      
+      describe "select_birth_summary" do
+        
+        it "should accept a value ID" do
+          @person.select_birth_summary('10001')
+        end
+        
+        it "should add a name assertion with action, value, and id" do
+          @person.select_birth_summary('10001')
+          @person.births[0].value.id.should == '10001'
+          @person.births[0].action.should == 'Select'
+        end
+        
+      end
+      
+      describe "select_death_summary" do
+        
+        it "should accept a value ID" do
+          @person.select_death_summary('10001')
+        end
+        
+        it "should add a name assertion with action, value, and id" do
+          @person.select_death_summary('10002')
+          @person.deaths[0].value.id.should == '10002'
+          @person.deaths[0].action.should == 'Select'
+        end
+        
+      end
+      
+      describe "select_mother_summary" do
+        
+        it "should accept a parent ID" do
+          @person.select_mother_summary('KWQS-BBR')
+        end
+        
+        it "should set the parents with given mother as a selected parent" do
+          @person.select_mother_summary('KWQS-BBR')
+          @person.parents[0].parents[0].id.should == 'KWQS-BBR'
+          @person.parents[0].parents[0].gender.should == 'Female'
+          @person.parents[0].action.should == 'Select'
+        end
+        
+      end
+      
+      describe "select_father_summary" do
+        
+        it "should accept a parent ID" do
+          @person.select_father_summary('KWQS-BBQ')
+        end
+        
+        it "should set the parents with given mother as a selected parent" do
+          @person.select_father_summary('KWQS-BBQ')
+          @person.parents[0].parents[0].id.should == 'KWQS-BBQ'
+          @person.parents[0].parents[0].gender.should == 'Male'
+          @person.parents[0].action.should == 'Select'
+        end
+        
+      end
+      
+      describe "select_father_summary and select_mother_summary" do
+        
+        it "should accept a parent ID" do
+          @person.select_mother_summary('KWQS-BBR')
+          @person.select_father_summary('KWQS-BBQ')
+        end
+        
+        it "should set the parents with given mother as a selected parent" do
+          @person.select_mother_summary('KWQS-BBR')
+          @person.select_father_summary('KWQS-BBQ')
+          @person.parents[0].parents[0].id.should == 'KWQS-BBR'
+          @person.parents[0].parents[1].id.should == 'KWQS-BBQ'
+          @person.parents[0].parents[0].gender.should == 'Female'
+          @person.parents[0].parents[1].gender.should == 'Male'
+          @person.parents[0].action.should == 'Select'
+        end
+        
+      end
+      
+    end
+    
     describe "baptisms" do
       describe "for persons with at least one baptism" do
         before(:each) do

data/spec/fs_utils_spec.rb

@@ -19,8 +19,10 @@ describe FsUtils do
     end
     
     it "should url_encode all of the hash values" do
-      qstring = FsUtils.querystring_from_hash :name => "Parker Felch"
+      hash = {:name => "Parker Felch"}
+      qstring = FsUtils.querystring_from_hash hash
       qstring.should == 'name=Parker%20Felch'
+      hash[:name].should_not == 'Parker%20Felch'
     end
     
     it "should convert sub-hashes into key.subkey=value" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-fs-stack
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.3.2
 platform: ruby
 authors: 
 - Jimmy Zimmerman
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-18 00:00:00 -07:00
+date: 2010-01-07 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency