ruby-fs-stack 0.4.0 → 0.4.2

data/README.rdoc

@@ -110,7 +110,22 @@ or for the pure Ruby implementation
   # 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
+  communicator.familytree_v2.save_person person
+
+=== Adding notes to an assertion
+
+  # assuming you know the assertion value ID that you want to create a note on
+  note = communicator.familytree_v2.write_note :personId => 'KWQS-BBQ', :assertionId => '60000021', :text => "This is my note text."
+  note.id #=> 'ZnMtZnQucC5LVzNCLU5NRzpwLjE0MDAwMDAwNDIyOjQwMDAwM29nMlpWOTgxOVpCWWs4RjAwMA=='
+  
+  # As soon as this bug is fixed, https://issues.devnet.familysearch.org/issues/show/149, it you can write
+  # notes on relationship assertions
+  marriage_note = communicator.familytree_v2.write_note :spouseIds => ['KWQS-BBQ','KWQS-BBR'], :assertionId => '700000001', :text => "This is my note."
+  
+  lineage_note = communicator.familytree_v2.write_note :parentIds => ['KWQS-BBQ'], :childId => 'KWQS-BBZ', :assertionId => '700000001', :text => "This is my note."
+  
+  # To add a "Person Note" as seen in the new FamilySearch web application, attach the note to an exists assertion
+  # You find these by doing a person read with the :exists => 'all' option.
 
 == RDoc
 

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.4.2

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

@@ -192,16 +192,42 @@ module FamilytreeV2
         r_type = get_relationship_type(options)
         with_id = options[r_type.to_sym]
         url = "#{Base}person/#{base_id}/#{r_type}/#{with_id}"
+        options.reject!{|k,v| k.to_s == 'spouse'}
         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}
+        person = familytree.persons.find{|p|p.requestedId == base_id}
         return person
       rescue RubyFsStack::NotFound
         return nil
       end
     end
     
+    # Writes a note attached to the value ID of the specific person or relationship.
+    # 
+    # ====Params
+    # * <tt>options</tt> - Options for the note including the following:
+    #   * <tt>:personId</tt> - the person ID if attaching to a person assertion.
+    #   * <tt>:spouseIds</tt> - an Array of spouse IDs if creating a note attached to a spouse 
+    #     relationship assertion.
+    #   * <tt>:parentIds</tt> - an Array of parent IDs if creating a note attached to a parent 
+    #     relationship assertion. If creating a note for a child-parent or parent-child 
+    #     relationship, you will need only one parent ID in the array along with a :childId option.
+    #   * <tt>:childId</tt> - a child ID.
+    #   * <tt>:text</tt> - the text of the note (required).
+    #   * <tt>:assertionId</tt> - the valueId of the assertion you are attaching this note to.
+    # 
+    def write_note(options)
+      url = "#{Base}note"
+      note = Org::Familysearch::Ws::Familytree::V2::Schema::Note.new
+      note.build(options)
+      familytree = Org::Familysearch::Ws::Familytree::V2::Schema::FamilyTree.new
+      familytree.notes = [note]
+      res = @fs_communicator.post(url,familytree.to_json)
+      familytree = Org::Familysearch::Ws::Familytree::V2::Schema::FamilyTree.from_json JSON.parse(res.body)
+      return familytree.notes.first
+    end
+    
     # Combines person into a new person
     #  
     # ====Params
@@ -227,7 +253,7 @@ module FamilytreeV2
     end
     
     def add_querystring(options)
-      params = options.reject{|k,v| ['parent','child','spouse','lineage','event'].include? k.to_s }
+      params = options.reject{|k,v| ['parent','child','lineage','event'].include? k.to_s }
       (params.empty?) ? '' : "?" + FsUtils.querystring_from_hash(params)
     end
   end
@@ -773,6 +799,11 @@ module Org::Familysearch::Ws::Familytree::V2::Schema
       death
     end
     
+    # This should only be called on a person containing relationships
+    def marriages(for_person)
+      select_spouse_events('Marriage',for_person)
+    end
+    
     # Add an event with type of Birth
     #
     # ====Params
@@ -855,7 +886,7 @@ module Org::Familysearch::Ws::Familytree::V2::Schema
       add_parents!
       couple = parents[0] || ParentsReference.new
       couple.select_parent(person_id,'Female')
-      parents << couple 
+      parents[0] = couple 
     end
     
     # Select the father for the summary view. This should be called on a Person record that
@@ -878,7 +909,7 @@ module Org::Familysearch::Ws::Familytree::V2::Schema
       add_parents!
       couple = parents[0] || ParentsReference.new
       couple.select_parent(person_id,'Male')
-      parents << couple 
+      parents[0] = couple 
     end
     
     # Select the spouse for the summary view. This should be called on a Person record that
@@ -1053,6 +1084,15 @@ module Org::Familysearch::Ws::Familytree::V2::Schema
       end
     end
     
+    def select_spouse_events(type,for_person)
+      spouse = relationships.spouses.find{|s|s.requestedId=for_person}
+      if spouse.assertions && spouse.assertions.events
+        spouse.assertions.events.select{|e| e.value.type == type}
+      else
+        []
+      end
+    end
+    
     def select_ordinances(type)
       if assertions && assertions.ordinances
         assertions.ordinances.select{|e| e.value.type == type}
@@ -1100,4 +1140,51 @@ module Org::Familysearch::Ws::Familytree::V2::Schema
       parents.find{|p|p.gender == 'Female'}
     end
   end
+  
+  class Note
+    
+    #Builds out the elements needed for the note.
+    # ====Params
+    # * <tt>options</tt> - Options for the note including the following:
+    #   * <tt>:personId</tt> - the person ID if attaching to a person assertion.
+    #   * <tt>:spouseIds</tt> - an Array of spouse IDs if creating a note attached to a spouse 
+    #     relationship assertion.
+    #   * <tt>:parentIds</tt> - an Array of parent IDs if creating a note attached to a parent 
+    #     relationship assertion. If creating a note for a child-parent or parent-child 
+    #     relationship, you will need only one parent ID in the array along with a :childId option.
+    #   * <tt>:childId</tt> - a child ID.
+    #   * <tt>:text</tt> - the text of the note (required).
+    #   * <tt>:assertionId</tt> - the valueId of the assertion you are attaching this note to.
+    def build(options)
+      if spouseIds = options[:spouseIds]
+        self.spouses = spouseIds.collect do |id|
+          s = Org::Familysearch::Ws::Familytree::V2::Schema::EntityReference.new
+          s.id = id
+          s
+        end
+      end
+      if parentIds = options[:parentIds]
+        self.parents = parentIds.collect do |id|
+          p = Org::Familysearch::Ws::Familytree::V2::Schema::EntityReference.new
+          p.id = id
+          p
+        end
+      end
+      if personId = options[:personId]
+        self.person = Org::Familysearch::Ws::Familytree::V2::Schema::EntityReference.new
+        self.person.id = personId
+      end
+      if childId = options[:childId]
+        self.child = Org::Familysearch::Ws::Familytree::V2::Schema::EntityReference.new
+        self.child.id = childId
+      end
+      if assertionId = options[:assertionId]
+        self.assertion = Org::Familysearch::Ws::Familytree::V2::Schema::EntityReference.new
+        self.assertion.id = assertionId
+      end
+      if text = options[:text]
+        self.text = text
+      end
+    end
+  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.4.0"
+  s.version = "0.4.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jimmy Zimmerman"]
-  s.date = %q{2010-01-12}
+  s.date = %q{2010-01-18}
   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 = [
@@ -43,6 +43,7 @@ Gem::Specification.new do |s|
      "spec/familytree_v2/json/combine_request.js",
      "spec/familytree_v2/json/combine_response.js",
      "spec/familytree_v2/json/match_KW3B-NNM.js",
+     "spec/familytree_v2/json/note_create_response.js",
      "spec/familytree_v2/json/person/KJ86-3VD_all.js",
      "spec/familytree_v2/json/person/KJ86-3VD_version.js",
      "spec/familytree_v2/json/person/multiple_version_read.js",
@@ -50,8 +51,10 @@ Gem::Specification.new do |s|
      "spec/familytree_v2/json/person/relationship_not_found.js",
      "spec/familytree_v2/json/person/relationship_read.js",
      "spec/familytree_v2/json/person/relationship_update.js",
+     "spec/familytree_v2/json/person/spouse_read.js",
      "spec/familytree_v2/json/search.js",
      "spec/familytree_v2/match_results_spec.rb",
+     "spec/familytree_v2/note_spec.rb",
      "spec/familytree_v2/person_spec.rb",
      "spec/familytree_v2/search_results_spec.rb",
      "spec/fixtures/fakeweb_response.txt",
@@ -71,6 +74,7 @@ Gem::Specification.new do |s|
     "spec/communicator_spec.rb",
      "spec/familytree_v2/familytree_communicator_spec.rb",
      "spec/familytree_v2/match_results_spec.rb",
+     "spec/familytree_v2/note_spec.rb",
      "spec/familytree_v2/person_spec.rb",
      "spec/familytree_v2/search_results_spec.rb",
      "spec/fs_utils_spec.rb",

data/spec/familytree_v2/familytree_communicator_spec.rb

@@ -368,6 +368,95 @@ describe FamilytreeV2::Communicator do
     end
   end
   
+  describe "writing new notes" do
+    before(:each) do
+      @fs_com_mock = mock("FsCommunicator")
+      @res = mock("HTTP::Response")
+      @ft_v2_com = FamilytreeV2::Communicator.new @fs_com_mock
+      
+      @response_json = read_file("../note_create_response.js")
+      @res.stub!(:body).and_return(@response_json)
+      
+      @fs_com_mock.stub!(:post).and_return(@res)
+      
+      @note = Org::Familysearch::Ws::Familytree::V2::Schema::Note.new
+    end
+    
+    describe "write_note for person assertions" do
+      before(:each) do
+        @options = {:personId => 'KWQS-BBQ',:assertionId => '10002', :text => 'MYNOTE.'}
+      end
+      
+      it "should take a person ID, assertion ID, and text" do
+        @ft_v2_com.write_note(@options)
+      end
+      
+      it "should create a new Note" do
+        note = Org::Familysearch::Ws::Familytree::V2::Schema::Note.new
+        Org::Familysearch::Ws::Familytree::V2::Schema::Note.should_receive(:new).at_least(:once).and_return(note)
+        @ft_v2_com.write_note(@options)
+      end
+      
+      it "should build the note with the passed options" do
+        Org::Familysearch::Ws::Familytree::V2::Schema::Note.stub!(:new).and_return(@note)
+        @note.should_receive(:build).with(@options)
+        @ft_v2_com.write_note(@options)
+      end
+      
+      it "should POST the note to /familytree/v2/note" do
+        @note.build @options
+        familytree = Org::Familysearch::Ws::Familytree::V2::Schema::FamilyTree.new
+        familytree.notes = [@note]
+        @fs_com_mock.should_receive(:post).with('/familytree/v2/note',familytree.to_json).and_return(@res)
+        @ft_v2_com.write_note(@options)
+      end
+      
+      it "should return the created note (containing the ID)" do
+        result = @ft_v2_com.write_note(@options)
+        result.id.should == 'ZnMtZnQucC5LVzNCLU5NRzpwLjE0MDAwMDAwNDIyOjQwMDAwM29nMlpWOTgxOVpCWWs4RjAwMA=='
+      end
+      
+    end
+    
+    describe "write_note for relationships" do
+      
+      before(:each) do
+        @options = {:spouseIds => ['KWQS-BBQ','KWQS-BBR'],:assertionId => '10002', :text => 'MYNOTE.'}
+      end
+      
+      it "should take hash of options including the assertion ID, and text" do
+        @ft_v2_com.write_note(@options)
+      end
+      
+      it "should create a new Note" do
+        note = Org::Familysearch::Ws::Familytree::V2::Schema::Note.new
+        Org::Familysearch::Ws::Familytree::V2::Schema::Note.should_receive(:new).at_least(:once).and_return(note)
+        @ft_v2_com.write_note(@options)
+      end
+      
+      it "should build the note with the passed options" do
+        Org::Familysearch::Ws::Familytree::V2::Schema::Note.stub!(:new).and_return(@note)
+        @note.should_receive(:build).with(@options)
+        @ft_v2_com.write_note(@options)
+      end
+      
+      it "should POST the note to /familytree/v2/note" do
+        @note.build @options.clone
+        familytree = Org::Familysearch::Ws::Familytree::V2::Schema::FamilyTree.new
+        familytree.notes = [@note]
+        @fs_com_mock.should_receive(:post).with('/familytree/v2/note',familytree.to_json).and_return(@res)
+        @ft_v2_com.write_note(@options)
+      end
+      
+      it "should return the created note (containing the ID)" do
+        result = @ft_v2_com.write_note(@options)
+        result.id.should == 'ZnMtZnQucC5LVzNCLU5NRzpwLjE0MDAwMDAwNDIyOjQwMDAwM29nMlpWOTgxOVpCWWs4RjAwMA=='
+      end
+      
+    end
+    
+  end
+  
   describe "combining persons" do
     def new_person(id,version)
       p = FamilyTreeV2::Person.new

data/spec/familytree_v2/json/note_create_response.js

@@ -0,0 +1 @@
+{"notes":[{"id":"ZnMtZnQucC5LVzNCLU5NRzpwLjE0MDAwMDAwNDIyOjQwMDAwM29nMlpWOTgxOVpCWWs4RjAwMA=="}],"version":"2.0.20091221.5312","statusCode":200,"statusMessage":"OK"}

data/spec/familytree_v2/json/person/relationship_read.js

@@ -1 +1 @@
-{"users":null,"notes":null,"citations":null,"persons":[{"properties":null,"id":"KWQS-BBQ","version":null,"identifiers":null,"personId":null,"relationships":{"children":null,"spouses":null,"parents":[{"properties":null,"id":"KWQS-BBR","version":"1","personId":null,"assertions":null,"requestedId":"KWQQ-6DL","personas":null,"tempId":null}]},"assertions":null,"parents":null,"changes":null,"families":null,"requestedId":"KWQQ-6DV","personas":null,"tempId":null}],"contributors":null,"personas":null,"searches":null,"matches":null,"pedigrees":null,"properties":null,"status":null,"version":"2.0.20090729.4570","statusCode":200,"statusMessage":"OK","deprecated":null}
+{"users":null,"notes":null,"citations":null,"persons":[{"properties":null,"id":"KWQS-BBQ","version":null,"identifiers":null,"personId":null,"relationships":{"children":null,"spouses":null,"parents":[{"properties":null,"id":"KWQS-BBR","version":"1","personId":null,"assertions":null,"requestedId":"KWQQ-6DL","personas":null,"tempId":null}]},"assertions":null,"parents":null,"changes":null,"families":null,"requestedId":"KWQS-BBQ","personas":null,"tempId":null}],"contributors":null,"personas":null,"searches":null,"matches":null,"pedigrees":null,"properties":null,"status":null,"version":"2.0.20090729.4570","statusCode":200,"statusMessage":"OK","deprecated":null}

data/spec/familytree_v2/json/person/spouse_read.js

@@ -0,0 +1 @@
+{"persons":[{"id":"KW3B-VVT","relationships":{"spouses":[{"id":"KW3B-VVY","version":"5","assertions":{"events":[{"value":{"type":"Marriage","date":{"selected":false,"normalized":"1853","original":" 1853","astro":{"earliest":"2397855","latest":"2398219"}},"place":{"selected":false,"normalized":{"value":"Alabama, United States","id":"33","version":"3.5.0"},"original":"Alabama, United States"}}},{"value":{"type":"Marriage","date":{"selected":false,"normalized":"Aug 1853","original":"Aug 1853","astro":{"earliest":"2397855","latest":"2398219"}},"place":{"selected":false,"normalized":{"value":"Alabama, United States","id":"33","version":"3.5.0"},"original":"Alabama, United States"}}}]},"requestedId":"KW3B-VVY"}],"spouse":[{"id":"KW3B-VVY","version":"5","assertions":{"events":[{"value":{"type":"Marriage","date":{"selected":false,"normalized":"1853","original":" 1853","astro":{"earliest":"2397855","latest":"2398219"}},"place":{"selected":false,"normalized":{"value":"Alabama, United States","id":"33","version":"3.5.0"},"original":"Alabama, United States"}}}]},"requestedId":"KW3B-VVY"}]},"requestedId":"KW3B-VVT"}],"version":"2.0.20091221.5312","statusCode":200,"statusMessage":"OK"}

data/spec/familytree_v2/note_spec.rb

@@ -0,0 +1,55 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require 'ruby-fs-stack/familytree'
+
+describe Org::Familysearch::Ws::Familytree::V2::Schema::Note do
+  
+  describe "build" do
+    
+    before(:each) do
+      @note = Org::Familysearch::Ws::Familytree::V2::Schema::Note.new
+    end
+    
+    it "should receive a hash of options" do
+      @note.build :personId => 'KWQS-BBQ', :assertionId => '10002', :text => "This is my note."
+    end
+    
+    it "should build out the note according to the options" do
+      @note.build :personId => 'KWQS-BBQ', :assertionId => '10002', :text => "This is my note."
+      @note.person.id.should == 'KWQS-BBQ'
+      @note.assertion.id.should == '10002'
+      @note.text.should == "This is my note."
+    end
+    
+    describe "building a spouses note" do
+      
+      before(:each) do
+        @options = {:spouseIds => ['KWQS-BBQ','KWQS-BBR'],:assertionId => '10002', :text => 'MYNOTE.'}
+      end
+      
+      it "should build the note with spouse references, assertion ID and text" do
+        @note.build @options
+        @note.spouses.size.should == 2
+        @note.spouses[0].id.should == 'KWQS-BBQ'
+        @note.spouses[1].id.should == 'KWQS-BBR'
+        @note.assertion.id.should == '10002'
+        @note.text = 'MYNOTE.'
+      end
+    end
+    
+    describe "building a parent-child note" do
+      before(:each) do
+        @options = {:parentIds => ['KWQS-BBQ'], :childId => 'KWQS-BBZ', :assertionId => '10002', :text => 'MYNOTE.'}
+      end
+      
+      it "should build the note with spouse references, assertion ID and text" do
+        @note.build @options
+        @note.parents.size.should == 1
+        @note.parents[0].id.should == 'KWQS-BBQ'
+        @note.child.id.should == 'KWQS-BBZ'
+        @note.assertion.id.should == '10002'
+        @note.text = 'MYNOTE.'
+      end
+    end
+  end
+  
+end

data/spec/familytree_v2/person_spec.rb

@@ -272,6 +272,44 @@ describe Org::Familysearch::Ws::Familytree::V2::Schema::Person do
       end
     end
     
+    describe "marriages" do
+      before(:each) do
+        @person = parse_person('spouse_read.js')
+      end
+      
+      it "should accept a spouse id." do
+        @person.marriages('KW3B-VVY')
+      end
+      
+      it "should return an array of marriage elements" do
+        marriages = @person.marriages('KW3B-VVY')
+        marriages.should be_instance_of(Array)
+      end
+      
+      it "should return all marriages" do
+        marriages = @person.marriages('KW3B-VVY')
+        marriages[0].date.normalized.should == '1853'
+        marriages[1].date.normalized.should == 'Aug 1853'
+      end
+      
+      describe "checking for cases where there are no assertsions, events, or marriages" do
+        before(:each) do
+          @spouse = @person.relationships.spouses.find{|s|s.requestedId=='KW3B-VVY'}
+        end
+        
+        it "should return [] if no assertions" do
+          @spouse.assertions = nil
+          @person.marriages('KW3B-VVY').should == []
+        end
+        
+        it "should return [] if no events" do
+          @spouse.assertions.events = nil
+          @person.marriages('KW3B-VVY').should == []
+        end
+        
+      end
+    end
+    
     describe "selecting summaries" do
       before(:each) do
         @person = parse_person('KJ86-3VD_version.js')
@@ -364,6 +402,7 @@ describe Org::Familysearch::Ws::Familytree::V2::Schema::Person do
           @person.parents[0].parents[0].gender.should == 'Female'
           @person.parents[0].parents[1].gender.should == 'Male'
           @person.parents[0].action.should == 'Select'
+          @person.parents.size.should == 1
         end
         
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-fs-stack
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
+  version: 0.4.2
 platform: ruby
 authors: 
 - Jimmy Zimmerman
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-12 00:00:00 -07:00
+date: 2010-01-18 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -68,6 +68,7 @@ files:
 - spec/familytree_v2/json/combine_request.js
 - spec/familytree_v2/json/combine_response.js
 - spec/familytree_v2/json/match_KW3B-NNM.js
+- spec/familytree_v2/json/note_create_response.js
 - spec/familytree_v2/json/person/KJ86-3VD_all.js
 - spec/familytree_v2/json/person/KJ86-3VD_version.js
 - spec/familytree_v2/json/person/multiple_version_read.js
@@ -75,8 +76,10 @@ files:
 - spec/familytree_v2/json/person/relationship_not_found.js
 - spec/familytree_v2/json/person/relationship_read.js
 - spec/familytree_v2/json/person/relationship_update.js
+- spec/familytree_v2/json/person/spouse_read.js
 - spec/familytree_v2/json/search.js
 - spec/familytree_v2/match_results_spec.rb
+- spec/familytree_v2/note_spec.rb
 - spec/familytree_v2/person_spec.rb
 - spec/familytree_v2/search_results_spec.rb
 - spec/fixtures/fakeweb_response.txt
@@ -117,6 +120,7 @@ test_files:
 - spec/communicator_spec.rb
 - spec/familytree_v2/familytree_communicator_spec.rb
 - spec/familytree_v2/match_results_spec.rb
+- spec/familytree_v2/note_spec.rb
 - spec/familytree_v2/person_spec.rb
 - spec/familytree_v2/search_results_spec.rb
 - spec/fs_utils_spec.rb