ruby-fs-stack 0.4.12 → 0.5.0

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

@@ -0,0 +1,209 @@
+module Org::Familysearch::Ws::Familytree::V2::Schema
+  
+  class RelationshipAssertions
+    # ====Params
+    # * <tt>options</tt> - :type ('Lineage' or valid CharacteristicType), :lineage => 'Biological', etc.
+    def add_characteristic(options)
+      self.characteristics ||= []
+      characteristic = CharacteristicAssertion.new
+      characteristic.add_value(options)
+      self.characteristics << characteristic
+    end
+    
+    # ====Params
+    # * <tt>options</tt> - Accepts the following options
+    # ** :type - 'Marriage', etc. REQUIRED
+    # ** :date - 'Utah, United States' (optional)
+    # ** :place - '16 Nov 1987' (optional)
+    def add_event(options)
+      self.events ||= []
+      event = EventAssertion.new
+      event.add_value(options)
+      self.events << event
+    end
+    
+    # ====Params
+    # * <tt>options</tt> - Accepts the following options
+    # ** :type - 'Sealing_to_Spouse', etc. REQUIRED
+    # ** :date - 'Utah, United States' (optional)
+    # ** :place - '16 Nov 1987' (optional)
+    # ** :temple - 'SLAKE'
+    def add_ordinance(options)
+      self.ordinances ||= []
+      ordinance = OrdinanceAssertion.new
+      ordinance.add_value(options)
+      self.ordinances << ordinance
+    end
+    
+    def add_exists
+      self.exists ||= []
+      exist = ExistsAssertion.new
+      exist.add_value
+      self.exists << exist
+    end
+  end
+  
+  class Relationship
+    def add_lineage_characteristic(lineage)
+      add_assertions!
+      self.assertions.add_characteristic(:type => 'Lineage', :lineage => lineage)
+    end
+    
+    def add_exists
+      add_assertions!
+      self.assertions.add_exists
+    end
+    
+    # ====Params
+    # * <tt>event_hash</tt> - Accepts the following options
+    # ** :type - 'Marriage', etc. REQUIRED
+    # ** :date - 'Utah, United States' (optional)
+    # ** :place - '16 Nov 1987' (optional)
+    def add_event(event_hash)
+      add_assertions!
+      self.assertions.add_event(event_hash)
+    end
+    
+    # ====Params
+    # * <tt>ordinance_hash</tt> - Accepts the following options
+    # ** :type - 'Sealing_to_Spouse', etc. REQUIRED
+    # ** :date - 'Utah, United States' (optional)
+    # ** :place - '16 Nov 1987' (optional)
+    # ** :temple - 'SLAKE'
+    def add_ordinance(ordinance_hash)
+      add_assertions!
+      self.assertions.add_ordinance(ordinance_hash)
+    end
+    
+    private
+    def add_assertions!
+      self.assertions ||= RelationshipAssertions.new
+    end
+  end
+  
+  class FamilyReference
+    def select_spouse(spouse_id)
+      add_parents!
+      self.action = 'Select'
+      parent = PersonReference.new
+      parent.id = spouse_id
+      self.parents << parent
+    end
+    
+    private
+    def add_parents!
+      self.parents ||= []
+    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 = []
+      @spouses = []
+      @children = []
+    end
+    
+    # ====Params
+    # * <tt>options</tt> - requires the following: 
+    # ** :type - 'parent', 'child', 'spouse'
+    # ** :with - ID of the person with whom you are making the relationship
+    # ** :lineage (optional) - 'Biological', 'Adoptive', etc.
+    # ** :event - a hash with values {:type => 'Marriage', :date => '15 Nov 2007', :place => 'Utah, United States'}
+    # ** :ordinance - a hash with values {:date => '15 Nov 2007', :temple => 'SLAKE', :place => 'Utah, United States', :type => "Sealing_to_Spouse"}
+    def add_relationship(options)
+      relationship = self.get_relationships_of_type(options[:type]).find{|r|r.id == options[:with] || r.requestedId == options[:with]}
+      if relationship.nil?
+        relationship = Relationship.new
+        relationship.id = options[:with]
+      end
+      if options[:lineage]
+        relationship.add_lineage_characteristic(options[:lineage]) if options[:lineage]
+      else
+        relationship.add_exists
+      end
+      if options[:event]
+        relationship.add_event(options[:event])
+      end
+      if options[:ordinance]
+        relationship.add_ordinance(options[:ordinance])
+      end
+      s_command = set_command(options[:type])
+      self.send(s_command.to_sym,[relationship])
+    end
+    
+    # ====Params
+    # * type - should be 'child', 'spouse', or 'parent'
+    def get_relationships_of_type(type)
+      g_command = get_command(type)
+      relationships = self.send(g_command.to_sym)
+    end
+    
+    # Overriding the Enunciate code because of a bug (parents, spouses, and children were not pluralized)
+    # the json hash for this PersonRelationships
+    def to_jaxb_json_hash
+      _h = {}
+      if !parents.nil?
+        _ha = Array.new
+        parents.each { | _item | _ha.push _item.to_jaxb_json_hash }
+        _h['parents'] = _ha
+      end
+      if !spouses.nil?
+        _ha = Array.new
+        spouses.each { | _item | _ha.push _item.to_jaxb_json_hash }
+        _h['spouses'] = _ha
+      end
+      if !children.nil?
+        _ha = Array.new
+        children.each { | _item | _ha.push _item.to_jaxb_json_hash }
+        _h['children'] = _ha
+      end
+      return _h
+    end
+    
+    # Overriding the Enunciate code because of a bug
+    #initializes this PersonRelationships with a json hash
+    def init_jaxb_json_hash(_o)
+      if !_o['parents'].nil?
+        @parents = Array.new
+        _oa = _o['parents']
+        _oa.each { | _item | @parents.push Org::Familysearch::Ws::Familytree::V2::Schema::Relationship.from_json(_item) }
+      end
+      if !_o['spouses'].nil?
+        @spouses = Array.new
+        _oa = _o['spouses']
+        _oa.each { | _item | @spouses.push Org::Familysearch::Ws::Familytree::V2::Schema::Relationship.from_json(_item) }
+      end
+      if !_o['children'].nil?
+        @children = Array.new
+        _oa = _o['children']
+        _oa.each { | _item | @children.push Org::Familysearch::Ws::Familytree::V2::Schema::Relationship.from_json(_item) }
+      end
+    end
+    
+    private
+    def get_command(type)
+      (type.to_s == 'child') ? 'children' : "#{type}s"
+    end
+     
+    def set_command(type)
+      get_command(type)+"="
+    end    
+  end
+  
+end

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

@@ -0,0 +1,27 @@
+module Org::Familysearch::Ws::Familytree::V2::Schema
+    
+  class SearchPerson
+    alias :name :full_name
+    alias :ref :id
+    def events
+      (assertions && assertions.events) ? assertions.events : []
+    end
+    
+    # Always will return nil. Method is here for v1 backwards compatibility
+    def marriage
+      nil
+    end
+  end
+  
+  class SearchResult
+    alias :ref :id
+    
+    def father
+      parents.find{|p|p.gender == 'Male'}
+    end
+    
+    def mother
+      parents.find{|p|p.gender == 'Female'}
+    end
+  end
+end

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

@@ -1,5 +1,5 @@
 require 'rubygems'
-require 'ruby-fs-stack/fs_communicator'
+require 'ruby-fs-stack/identity/communicator'
 # Including more than one enunciate library raises a warning of
 # already initialized constant.
 require 'ruby-fs-stack/warning_suppressor'
@@ -7,39 +7,3 @@ with_warnings_suppressed do
   require 'ruby-fs-stack/enunciate/identity'
 end
 
-module IdentityV1
-  
-  # This method gets mixed into the FsCommunicator so that
-  # you can make calls on the fs_familytree_v1 module
-  def identity_v1
-    @identity_v1_com ||= Communicator.new self # self at this point refers to the FsCommunicator instance
-  end
-  
-  class Communicator
-    Base = '/identity/v1/'
-    
-    # ====params
-    # fs_communicator: FsCommunicator instance
-    def initialize(fs_communicator)
-      @communicator = fs_communicator
-    end
-    
-    # ==== Params
-    # <tt>credentials</tt> - :username, :password
-    def authenticate(credentials = {})
-      url = Base + 'login'
-      response = @communicator.get(url, credentials)
-      login_result = Org::Familysearch::Ws::Identity::V1::Schema::Identity.from_json JSON.parse(response.body)
-      if login_result.statusCode == 200
-        @communicator.session = login_result.session.id
-        return true
-      end
-    end
-  end
-  
-end
-
-# Mix in the module so that the identity_v1 can be called
-class FsCommunicator
-  include IdentityV1
-end

data/lib/ruby-fs-stack/identity/communicator.rb

@@ -0,0 +1,41 @@
+require 'ruby-fs-stack/fs_communicator'
+module IdentityV1
+  
+  # This method gets mixed into the FsCommunicator so that
+  # you can make calls on the fs_familytree_v1 module
+  def identity_v1
+    @identity_v1_com ||= Communicator.new self # self at this point refers to the FsCommunicator instance
+  end
+  
+  class Communicator
+    Base = '/identity/v1/'
+    
+    # ====params
+    # fs_communicator: FsCommunicator instance
+    def initialize(fs_communicator)
+      @communicator = fs_communicator
+    end
+    
+    # ==== Params
+    # <tt>credentials</tt> - :username, :password
+    def authenticate(credentials = {})
+      url = Base + 'login'
+      response = @communicator.get(url, credentials)
+      if response.code == '200'
+        login_result = Org::Familysearch::Ws::Identity::V1::Schema::Identity.from_json JSON.parse(response.body)
+        @communicator.session = login_result.session.id
+        return true
+      else
+        return false
+      end
+    end
+    
+    alias :login :authenticate
+  end
+  
+end
+
+# Mix in the module so that the identity_v1 can be called
+class FsCommunicator
+  include IdentityV1
+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.12"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jimmy Zimmerman"]
-  s.date = %q{2010-05-01}
+  s.date = %q{2010-05-15}
   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 = [
@@ -33,43 +33,58 @@ Gem::Specification.new do |s|
      "lib/ruby-fs-stack/enunciate/identity.rb",
      "lib/ruby-fs-stack/errors.rb",
      "lib/ruby-fs-stack/familytree.rb",
+     "lib/ruby-fs-stack/familytree/characteristic.rb",
+     "lib/ruby-fs-stack/familytree/communicator.rb",
+     "lib/ruby-fs-stack/familytree/event.rb",
+     "lib/ruby-fs-stack/familytree/exist.rb",
+     "lib/ruby-fs-stack/familytree/gender.rb",
+     "lib/ruby-fs-stack/familytree/match.rb",
+     "lib/ruby-fs-stack/familytree/name.rb",
+     "lib/ruby-fs-stack/familytree/note.rb",
+     "lib/ruby-fs-stack/familytree/ordinance.rb",
+     "lib/ruby-fs-stack/familytree/pedigree.rb",
+     "lib/ruby-fs-stack/familytree/person.rb",
+     "lib/ruby-fs-stack/familytree/relationship.rb",
+     "lib/ruby-fs-stack/familytree/search.rb",
      "lib/ruby-fs-stack/fs_communicator.rb",
      "lib/ruby-fs-stack/fs_utils.rb",
      "lib/ruby-fs-stack/identity.rb",
+     "lib/ruby-fs-stack/identity/communicator.rb",
      "lib/ruby-fs-stack/warning_suppressor.rb",
      "ruby-fs-stack.gemspec",
-     "spec/communicator_spec.rb",
-     "spec/familytree_v2/familytree_communicator_spec.rb",
-     "spec/familytree_v2/json/combine_request.js",
-     "spec/familytree_v2/json/combine_response.js",
-     "spec/familytree_v2/json/fakeweb_contributor.txt",
-     "spec/familytree_v2/json/fakeweb_pedigree.txt",
-     "spec/familytree_v2/json/fakeweb_pedigree2.txt",
-     "spec/familytree_v2/json/fakeweb_properties.txt",
-     "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_parents_families.js",
-     "spec/familytree_v2/json/person/KJ86-3VD_version.js",
-     "spec/familytree_v2/json/person/fakeweb_10_batch.txt",
-     "spec/familytree_v2/json/person/fakeweb_6_batch.txt",
-     "spec/familytree_v2/json/person/multiple_version_read.js",
-     "spec/familytree_v2/json/person/post_response.js",
-     "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/pedigree_spec.rb",
-     "spec/familytree_v2/person_spec.rb",
-     "spec/familytree_v2/relationships_spec.rb",
-     "spec/familytree_v2/search_results_spec.rb",
      "spec/fixtures/fakeweb_response.txt",
-     "spec/fs_utils_spec.rb",
-     "spec/identity_v1/identity_spec.rb",
-     "spec/identity_v1/json/login.js",
+     "spec/ruby-fs-stack/familytree/communicator_spec.rb",
+     "spec/ruby-fs-stack/familytree/json/combine_request.js",
+     "spec/ruby-fs-stack/familytree/json/combine_response.js",
+     "spec/ruby-fs-stack/familytree/json/fakeweb_contributor.txt",
+     "spec/ruby-fs-stack/familytree/json/fakeweb_pedigree.txt",
+     "spec/ruby-fs-stack/familytree/json/fakeweb_pedigree2.txt",
+     "spec/ruby-fs-stack/familytree/json/fakeweb_properties.txt",
+     "spec/ruby-fs-stack/familytree/json/match_KW3B-NNM.js",
+     "spec/ruby-fs-stack/familytree/json/note_create_response.js",
+     "spec/ruby-fs-stack/familytree/json/person/KJ86-3VD_all.js",
+     "spec/ruby-fs-stack/familytree/json/person/KJ86-3VD_parents_families.js",
+     "spec/ruby-fs-stack/familytree/json/person/KJ86-3VD_version.js",
+     "spec/ruby-fs-stack/familytree/json/person/fakeweb_10_batch.txt",
+     "spec/ruby-fs-stack/familytree/json/person/fakeweb_6_batch.txt",
+     "spec/ruby-fs-stack/familytree/json/person/multiple_version_read.js",
+     "spec/ruby-fs-stack/familytree/json/person/post_response.js",
+     "spec/ruby-fs-stack/familytree/json/person/relationship_not_found.js",
+     "spec/ruby-fs-stack/familytree/json/person/relationship_read.js",
+     "spec/ruby-fs-stack/familytree/json/person/relationship_update.js",
+     "spec/ruby-fs-stack/familytree/json/person/spouse_read.js",
+     "spec/ruby-fs-stack/familytree/json/search.js",
+     "spec/ruby-fs-stack/familytree/match_spec.rb",
+     "spec/ruby-fs-stack/familytree/note_spec.rb",
+     "spec/ruby-fs-stack/familytree/pedigree_spec.rb",
+     "spec/ruby-fs-stack/familytree/person_spec.rb",
+     "spec/ruby-fs-stack/familytree/relationship_spec.rb",
+     "spec/ruby-fs-stack/familytree/search_spec.rb",
+     "spec/ruby-fs-stack/familytree/spec_helper.rb",
+     "spec/ruby-fs-stack/fs_communicator_spec.rb",
+     "spec/ruby-fs-stack/fs_utils_spec.rb",
+     "spec/ruby-fs-stack/identity/communicator_spec.rb",
+     "spec/ruby-fs-stack/identity/json/login.js",
      "spec/ruby-fs-stack_spec.rb",
      "spec/spec_helper.rb"
   ]
@@ -80,16 +95,17 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.6}
   s.summary = %q{Ruby wrapper for all FamilySearch APIs.}
   s.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/pedigree_spec.rb",
-     "spec/familytree_v2/person_spec.rb",
-     "spec/familytree_v2/relationships_spec.rb",
-     "spec/familytree_v2/search_results_spec.rb",
-     "spec/fs_utils_spec.rb",
-     "spec/identity_v1/identity_spec.rb",
+    "spec/ruby-fs-stack/familytree/communicator_spec.rb",
+     "spec/ruby-fs-stack/familytree/match_spec.rb",
+     "spec/ruby-fs-stack/familytree/note_spec.rb",
+     "spec/ruby-fs-stack/familytree/pedigree_spec.rb",
+     "spec/ruby-fs-stack/familytree/person_spec.rb",
+     "spec/ruby-fs-stack/familytree/relationship_spec.rb",
+     "spec/ruby-fs-stack/familytree/search_spec.rb",
+     "spec/ruby-fs-stack/familytree/spec_helper.rb",
+     "spec/ruby-fs-stack/fs_communicator_spec.rb",
+     "spec/ruby-fs-stack/fs_utils_spec.rb",
+     "spec/ruby-fs-stack/identity/communicator_spec.rb",
      "spec/ruby-fs-stack_spec.rb",
      "spec/spec_helper.rb",
      "examples/familytree_example.rb",