familysearch-gedcomx 1.0.0 → 1.0.1

data/lib/familysearch/gedcomx/data_model.rb

@@ -653,13 +653,92 @@ module FamilySearch
       property :databaseVersion
       property :platformVersion
     end
+        
+    class Tag < SuperDash
+      property :resource
+    end
     
-    class ResultConfidence < SuperDash
-      # Here to give a number 1-5. Not really a significant piece of the model.
+    class AtomCommonAttributes < SuperDash
+      property :base
+      property :lang
     end
     
-    class Tag < SuperDash
-      property :resource
-    end        
+    class AtomExtensibleElement < AtomCommonAttributes
+      include SuperCoercion
+    end
+    
+    class AtomPerson < AtomExtensibleElement
+      property :name
+      property :uri
+      property :email
+    end
+    
+    class AtomGenerator < SuperDash
+      property :base
+      property :uri
+      property :lang
+      property :version
+      property :value
+    end
+    
+    class AtomCategory < AtomCommonAttributes
+      property :scheme
+      property :term
+      property :label
+    end
+    
+    class AtomContent < SuperDash
+      include SuperCoercion
+      property :type
+      property :gedcomx
+      
+      coerce_key :gedcomx, Gedcomx
+    end
+    
+    class AtomEntry < AtomExtensibleElement
+      property :authors
+      property :categories
+      property :confidence
+      property :content
+      property :contributors
+      property :id
+      property :links
+      property :published
+      property :rights
+      property :score
+      property :title
+      property :updated
+      
+      coerce_key :authors, [AtomPerson]
+      coerce_key :categories, [AtomCategory]
+      coerce_key :content, AtomContent
+      coerce_key :contributors, [AtomPerson]
+      coerce_key :links, {'key' => Link}
+    end
+    
+    class AtomFeed < AtomExtensibleElement
+      property :authors
+      property :contributors
+      property :generator
+      property :icon
+      property :id
+      property :results
+      property :index
+      property :links
+      property :logo
+      property :rights
+      property :subtitle
+      property :title
+      property :updated
+      property :entries
+      property :facets
+      
+      coerce_key :authors, [AtomPerson]
+      coerce_key :contributors, [AtomPerson]
+      coerce_key :generator, AtomGenerator
+      coerce_key :links, {'key' => Link}
+      coerce_key :entries, [AtomEntry]
+      coerce_key :facets, [Facet]
+    end
   end
 end

data/lib/familysearch/gedcomx/version.rb

@@ -1,6 +1,6 @@
 # A structured object model for the application/x-fs-v1+json media type.
 module FamilySearch
   module Gedcomx
-    VERSION = "1.0.0"
+    VERSION = "1.0.1"
   end
 end

data/spec/familysearch/gedcomx/atom_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+require 'json'
+
+describe FamilySearch::Gedcomx::AtomFeed do
+  it 'should have a version number' do
+    FamilySearch::Gedcomx::VERSION.should_not be_nil
+  end
+  
+  context "populating from hashes" do
+    it 'should be able to parse a person file' do
+      person_json = File.read 'spec/familysearch/gedcomx/fixtures/search.json'
+      search_hash = JSON.parse person_json
+      atom = FamilySearch::Gedcomx::AtomFeed.new search_hash
+      atom.links['next'].href.should == 'https://sandbox.familysearch.org/platform/tree/search?context=AQATNTk5NDY4MzUzOTQ4Njk1NzQyMQAAAAZTMWTrAABfbQA%3D&start=4'
+      atom.results.should == 4
+      atom.entries[0].should be_instance_of FamilySearch::Gedcomx::AtomEntry
+      atom.entries[0].content.should be_instance_of FamilySearch::Gedcomx::AtomContent
+      atom.entries[0].content.gedcomx.persons[0].should be_instance_of FamilySearch::Gedcomx::Person
+      atom.entries[0].content.gedcomx.persons[0].full_name.should == 'John Smith'
+      atom.entries[0].confidence.should == 5
+      atom.entries[0].score.should == 512.5161
+    end
+    
+  end
+end

data/spec/familysearch/gedcomx/fixtures/search.json

@@ -0,0 +1,423 @@
+{
+  "results" : 4,
+  "index" : 0,
+  "links" : {
+    "next" : {
+      "href" : "https://sandbox.familysearch.org/platform/tree/search?context=AQATNTk5NDY4MzUzOTQ4Njk1NzQyMQAAAAZTMWTrAABfbQA%3D&start=4",
+      "title" : "Person Search"
+    },
+    "self" : {
+      "href" : "https://sandbox.familysearch.org/platform/tree/search?q=givenName:John+surname:Smith+gender:male",
+      "title" : "Person Search"
+    },
+    "first" : {
+      "href" : "https://sandbox.familysearch.org/platform/tree/search?context=AQATNTk5NDY4MzUzOTQ4Njk1NzQyMQAAAAZTMWTrAABfbQA%3D&start=0",
+      "title" : "Person Search"
+    }
+  },
+  "subtitle" : "Results of searching for persons.",
+  "title" : "Results",
+  "entries" : [ {
+    "content" : {
+      "gedcomx" : {
+        "persons" : [ {
+          "id" : "KW7M-6SD",
+          "links" : {
+            "person" : {
+              "href" : "https://sandbox.familysearch.org/platform/tree/persons/KW7M-6SD",
+              "title" : "Person"
+            }
+          },
+          "living" : false,
+          "gender" : {
+            "type" : "http://gedcomx.org/Male"
+          },
+          "names" : [ {
+            "type" : "http://gedcomx.org/BirthName",
+            "nameForms" : [ {
+              "fullText" : "John Smith"
+            } ]
+          } ],
+          "facts" : [ {
+            "type" : "http://gedcomx.org/Birth",
+            "date" : {
+              "original" : "1 January 1900"
+            },
+            "place" : {
+              "original" : "Jericho, Queensland, Australia"
+            }
+          } ],
+          "display" : {
+            "name" : "John Smith",
+            "gender" : "Male",
+            "birthDate" : "1 January 1900",
+            "birthPlace" : "Jericho, Queensland, Australia"
+          }
+        }, {
+          "id" : "KW7M-6S6",
+          "links" : {
+            "person" : {
+              "href" : "https://sandbox.familysearch.org/platform/tree/persons/KW7M-6S6",
+              "title" : "Person"
+            }
+          },
+          "living" : false,
+          "gender" : {
+            "type" : "http://gedcomx.org/Female"
+          },
+          "names" : [ {
+            "type" : "http://gedcomx.org/BirthName",
+            "nameForms" : [ {
+              "fullText" : "Mary Hawkins"
+            } ]
+          } ],
+          "facts" : [ {
+            "type" : "http://gedcomx.org/Marriage",
+            "date" : {
+              "original" : "2 Feb 1930"
+            },
+            "place" : {
+              "original" : "Melbourne, Victoria, Australia"
+            }
+          } ],
+          "display" : {
+            "name" : "Mary Hawkins",
+            "gender" : "Female"
+          }
+        } ],
+        "relationships" : [ {
+          "type" : "http://gedcomx.org/Couple",
+          "person1" : {
+            "resource" : "https://sandbox.familysearch.org/platform/tree/persons/KW7M-6SD",
+            "resourceId" : "KW7M-6SD"
+          },
+          "person2" : {
+            "resource" : "https://sandbox.familysearch.org/platform/tree/persons/KW7M-6S6",
+            "resourceId" : "KW7M-6S6"
+          }
+        } ]
+      }
+    },
+    "id" : "KW7M-6SD",
+    "score" : 512.5161,
+    "confidence" : 5,
+    "links" : {
+      "person" : {
+        "href" : "https://sandbox.familysearch.org/platform/tree/persons/KW7M-6SD",
+        "title" : "Person"
+      }
+    },
+    "title" : "Person KW7M-6SD (John Smith)"
+  }, {
+    "content" : {
+      "gedcomx" : {
+        "persons" : [ {
+          "id" : "KW73-8G5",
+          "links" : {
+            "person" : {
+              "href" : "https://sandbox.familysearch.org/platform/tree/persons/KW73-8G5",
+              "title" : "Person"
+            }
+          },
+          "living" : false,
+          "gender" : {
+            "type" : "http://gedcomx.org/Male"
+          },
+          "names" : [ {
+            "type" : "http://gedcomx.org/BirthName",
+            "nameForms" : [ {
+              "fullText" : "John SMITH"
+            } ]
+          } ],
+          "facts" : [ {
+            "type" : "http://gedcomx.org/Birth",
+            "date" : {
+              "original" : "28 May 1687"
+            }
+          } ],
+          "display" : {
+            "name" : "John SMITH",
+            "gender" : "Male",
+            "birthDate" : "28 May 1687"
+          }
+        }, {
+          "id" : "KW73-8GR",
+          "links" : {
+            "person" : {
+              "href" : "https://sandbox.familysearch.org/platform/tree/persons/KW73-8GR",
+              "title" : "Person"
+            }
+          },
+          "living" : false,
+          "gender" : {
+            "type" : "http://gedcomx.org/Female"
+          },
+          "names" : [ {
+            "type" : "http://gedcomx.org/BirthName",
+            "nameForms" : [ {
+              "fullText" : "Elizabeth BRYCE"
+            } ]
+          } ],
+          "display" : {
+            "name" : "Elizabeth BRYCE",
+            "gender" : "Female"
+          }
+        }, {
+          "id" : "KW73-8GV",
+          "links" : {
+            "person" : {
+              "href" : "https://sandbox.familysearch.org/platform/tree/persons/KW73-8GV",
+              "title" : "Person"
+            }
+          },
+          "living" : false,
+          "gender" : {
+            "type" : "http://gedcomx.org/Male"
+          },
+          "names" : [ {
+            "type" : "http://gedcomx.org/BirthName",
+            "nameForms" : [ {
+              "fullText" : "Francis SMITH"
+            } ]
+          } ],
+          "display" : {
+            "name" : "Francis SMITH",
+            "gender" : "Male"
+          }
+        } ],
+        "relationships" : [ {
+          "type" : "http://gedcomx.org/Couple",
+          "person1" : {
+            "resource" : "https://sandbox.familysearch.org/platform/tree/persons/KW73-8G5",
+            "resourceId" : "KW73-8G5"
+          },
+          "person2" : {
+            "resource" : "https://sandbox.familysearch.org/platform/tree/persons/KW73-8GR",
+            "resourceId" : "KW73-8GR"
+          }
+        }, {
+          "type" : "http://gedcomx.org/ParentChild",
+          "person1" : {
+            "resource" : "https://sandbox.familysearch.org/platform/tree/persons/KW73-8G5",
+            "resourceId" : "KW73-8G5"
+          },
+          "person2" : {
+            "resource" : "https://sandbox.familysearch.org/platform/tree/persons/KW73-8GV",
+            "resourceId" : "KW73-8GV"
+          }
+        } ]
+      }
+    },
+    "id" : "KW73-8G5",
+    "score" : 512.516,
+    "confidence" : 5,
+    "links" : {
+      "person" : {
+        "href" : "https://sandbox.familysearch.org/platform/tree/persons/KW73-8G5",
+        "title" : "Person"
+      }
+    },
+    "title" : "Person KW73-8G5 (John SMITH)"
+  }, {
+    "content" : {
+      "gedcomx" : {
+        "persons" : [ {
+          "id" : "KWQB-VJS",
+          "links" : {
+            "person" : {
+              "href" : "https://sandbox.familysearch.org/platform/tree/persons/KWQB-VJS",
+              "title" : "Person"
+            }
+          },
+          "living" : false,
+          "gender" : {
+            "type" : "http://gedcomx.org/Male"
+          },
+          "names" : [ {
+            "type" : "http://gedcomx.org/BirthName",
+            "nameForms" : [ {
+              "fullText" : "John Smith"
+            } ]
+          } ],
+          "facts" : [ {
+            "type" : "http://gedcomx.org/Death",
+            "date" : {
+              "original" : "1776"
+            },
+            "place" : {
+              "original" : "United States"
+            }
+          }, {
+            "type" : "http://gedcomx.org/Birth",
+            "date" : {
+              "original" : "1735"
+            },
+            "place" : {
+              "original" : "England"
+            }
+          } ],
+          "display" : {
+            "name" : "John Smith",
+            "gender" : "Male",
+            "birthDate" : "1735",
+            "birthPlace" : "England",
+            "deathDate" : "1776",
+            "deathPlace" : "United States"
+          }
+        } ],
+        "relationships" : [ ]
+      }
+    },
+    "id" : "KWQB-VJS",
+    "score" : 512.51575,
+    "confidence" : 5,
+    "links" : {
+      "person" : {
+        "href" : "https://sandbox.familysearch.org/platform/tree/persons/KWQB-VJS",
+        "title" : "Person"
+      }
+    },
+    "title" : "Person KWQB-VJS (John Smith)"
+  }, {
+    "content" : {
+      "gedcomx" : {
+        "persons" : [ {
+          "id" : "KWQZ-8LK",
+          "links" : {
+            "person" : {
+              "href" : "https://sandbox.familysearch.org/platform/tree/persons/KWQZ-8LK",
+              "title" : "Person"
+            }
+          },
+          "living" : false,
+          "gender" : {
+            "type" : "http://gedcomx.org/Male"
+          },
+          "names" : [ {
+            "type" : "http://gedcomx.org/BirthName",
+            "nameForms" : [ {
+              "fullText" : "* John SMITH"
+            } ]
+          } ],
+          "facts" : [ {
+            "type" : "http://gedcomx.org/Death",
+            "date" : {
+              "original" : "12 Jun 1712"
+            },
+            "place" : {
+              "original" : "Haddam, Middlesesx, Connecticut"
+            }
+          }, {
+            "type" : "http://gedcomx.org/Christening",
+            "date" : {
+              "original" : "21 Mar 1670"
+            },
+            "place" : {
+              "original" : "Beckford, Herefordshire, Engl"
+            }
+          }, {
+            "type" : "http://gedcomx.org/Birth",
+            "date" : {
+              "original" : "ABT 1660"
+            },
+            "place" : {
+              "original" : "Haddam, Middlesex, Connecticut, United States"
+            }
+          } ],
+          "display" : {
+            "name" : "* John SMITH",
+            "gender" : "Male",
+            "birthDate" : "ABT 1660",
+            "birthPlace" : "Haddam, Middlesex, Connecticut, United States",
+            "deathDate" : "12 Jun 1712",
+            "deathPlace" : "Haddam, Middlesesx, Connecticut"
+          }
+        }, {
+          "id" : "KWQZ-8FD",
+          "links" : {
+            "person" : {
+              "href" : "https://sandbox.familysearch.org/platform/tree/persons/KWQZ-8FD",
+              "title" : "Person"
+            }
+          },
+          "living" : false,
+          "gender" : {
+            "type" : "http://gedcomx.org/Female"
+          },
+          "names" : [ {
+            "type" : "http://gedcomx.org/BirthName",
+            "nameForms" : [ {
+              "fullText" : "Sarah White"
+            } ]
+          } ],
+          "facts" : [ {
+            "type" : "http://gedcomx.org/Marriage",
+            "date" : {
+              "original" : "ABT 1682"
+            },
+            "place" : {
+              "original" : "Middletown, Middlesex, Connecticut, United States"
+            }
+          } ],
+          "display" : {
+            "name" : "Sarah White",
+            "gender" : "Female"
+          }
+        }, {
+          "id" : "KWQX-5TJ",
+          "links" : {
+            "person" : {
+              "href" : "https://sandbox.familysearch.org/platform/tree/persons/KWQX-5TJ",
+              "title" : "Person"
+            }
+          },
+          "living" : false,
+          "gender" : {
+            "type" : "http://gedcomx.org/Female"
+          },
+          "names" : [ {
+            "type" : "http://gedcomx.org/BirthName",
+            "nameForms" : [ {
+              "fullText" : "LA Verna Coleman"
+            } ]
+          } ],
+          "display" : {
+            "name" : "LA Verna Coleman",
+            "gender" : "Female"
+          }
+        } ],
+        "relationships" : [ {
+          "type" : "http://gedcomx.org/Couple",
+          "person1" : {
+            "resource" : "https://sandbox.familysearch.org/platform/tree/persons/KWQZ-8LK",
+            "resourceId" : "KWQZ-8LK"
+          },
+          "person2" : {
+            "resource" : "https://sandbox.familysearch.org/platform/tree/persons/KWQZ-8FD",
+            "resourceId" : "KWQZ-8FD"
+          }
+        }, {
+          "type" : "http://gedcomx.org/ParentChild",
+          "person1" : {
+            "resource" : "https://sandbox.familysearch.org/platform/tree/persons/KWQZ-8LK",
+            "resourceId" : "KWQZ-8LK"
+          },
+          "person2" : {
+            "resource" : "https://sandbox.familysearch.org/platform/tree/persons/KWQX-5TJ",
+            "resourceId" : "KWQX-5TJ"
+          }
+        } ]
+      }
+    },
+    "id" : "KWQZ-8LK",
+    "score" : 412.3539,
+    "confidence" : 4,
+    "links" : {
+      "person" : {
+        "href" : "https://sandbox.familysearch.org/platform/tree/persons/KWQZ-8LK",
+        "title" : "Person"
+      }
+    },
+    "title" : "Person KWQZ-8LK (* John SMITH)"
+  } ]
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: familysearch-gedcomx
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-28 00:00:00.000000000 Z
+date: 2013-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -98,6 +98,7 @@ files:
 - lib/familysearch/gedcomx/super_coercion.rb
 - lib/familysearch/gedcomx/super_dash.rb
 - lib/familysearch/gedcomx/version.rb
+- spec/familysearch/gedcomx/atom_spec.rb
 - spec/familysearch/gedcomx/fact_spec.rb
 - spec/familysearch/gedcomx/familysearch_spec.rb
 - spec/familysearch/gedcomx/fixtures/ancestry-query.json
@@ -105,6 +106,7 @@ files:
 - spec/familysearch/gedcomx/fixtures/person-with-relationships-mother.json
 - spec/familysearch/gedcomx/fixtures/person-with-relationships.json
 - spec/familysearch/gedcomx/fixtures/person.json
+- spec/familysearch/gedcomx/fixtures/search.json
 - spec/familysearch/gedcomx/graph_person_spec.rb
 - spec/familysearch/gedcomx/graph_spec.rb
 - spec/familysearch/gedcomx/person_spec.rb
@@ -126,7 +128,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1290558280724314510
+      hash: 1520665764010235973
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -135,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1290558280724314510
+      hash: 1520665764010235973
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -143,6 +145,7 @@ signing_key:
 specification_version: 3
 summary: A structured object model for the application/x-fs-v1+json media type
 test_files:
+- spec/familysearch/gedcomx/atom_spec.rb
 - spec/familysearch/gedcomx/fact_spec.rb
 - spec/familysearch/gedcomx/familysearch_spec.rb
 - spec/familysearch/gedcomx/fixtures/ancestry-query.json
@@ -150,6 +153,7 @@ test_files:
 - spec/familysearch/gedcomx/fixtures/person-with-relationships-mother.json
 - spec/familysearch/gedcomx/fixtures/person-with-relationships.json
 - spec/familysearch/gedcomx/fixtures/person.json
+- spec/familysearch/gedcomx/fixtures/search.json
 - spec/familysearch/gedcomx/graph_person_spec.rb
 - spec/familysearch/gedcomx/graph_spec.rb
 - spec/familysearch/gedcomx/person_spec.rb