jimmyz-fs-familytree-v1 0.1.0 → 0.2.1

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:minor: 1
-:patch: 0
+:minor: 2
+:patch: 1
 :major: 0

data/lib/communicator.rb

@@ -0,0 +1,33 @@
+require 'fs_communicator'
+
+module FsFamilytreeV1
+  
+  # This method gets mixed into the FsCommunicator so that
+  # you can make calls on the fs_familytree_v1 module
+  def fs_familytree_v1
+    @com ||= Communicator.new self # self at this point refers to the FsCommunicator instance
+  end
+  
+  class Communicator
+    Base = '/familytree/v1/'
+    
+    # ==params
+    # fs_communicator: FsCommunicator instance
+    def initialize(fs_communicator)
+      @fs_communicator = fs_communicator
+    end
+    
+    def person(id, options = {})
+      url = Base + 'person/' + id
+      response = @fs_communicator.get(url)
+      familytree = Familytree.parse response.body
+      person = familytree.persons.person.find{|p| p.requestedId == id }
+    end
+  end
+  
+end
+
+# Mix in the module so that the fs_familytree_v1 can be called
+class FsCommunicator
+  include FsFamilytreeV1
+end

data/lib/fs_familytree_v1.rb

@@ -1,12 +1,19 @@
+dir = File.dirname(__FILE__)
+$:.unshift(dir) unless $:.include?(dir) || $:.include?(File.expand_path(dir))
+
 require 'rubygems'
 gem 'jimmyz-happymapper'
 require 'happymapper'
 
-module FsFamilytreeV1
+require 'communicator'
 
+module FsFamilytreeV1
+  NS = 'http://api.familysearch.org/familytree/v1'
+  
   class AlternateIds
     include HappyMapper
     
+    namespace_url NS
     tag :alternateIds
     has_many :id, String
   end
@@ -14,6 +21,7 @@ module FsFamilytreeV1
   class PersonInformation
     include HappyMapper
     
+    namespace_url NS
     tag :information
     element :gender, String
     element :living, Boolean
@@ -23,6 +31,7 @@ module FsFamilytreeV1
   class NamePiece
     include HappyMapper
     
+    namespace_url NS
     tag :piece
     attribute :type, String
     element :value, String
@@ -31,12 +40,14 @@ module FsFamilytreeV1
   class Pieces
     include HappyMapper
     
+    namespace_url NS
     has_many :piece, NamePiece
   end
   
   class NameForm
     include HappyMapper
     
+    namespace_url NS
     tag :form
     element :fullText, String
     has_one :pieces, Pieces
@@ -46,6 +57,7 @@ module FsFamilytreeV1
   class Forms
     include HappyMapper
     
+    namespace_url NS
     has_many :form, NameForm
   end
   
@@ -53,6 +65,7 @@ module FsFamilytreeV1
     def self.init(options = {})
       include HappyMapper
       
+      namespace_url NS
       attribute :id, String
       attribute :version, String
       attribute :submitter, String
@@ -80,6 +93,7 @@ module FsFamilytreeV1
   class DateAstro
     include HappyMapper
     
+    namespace_url NS
     tag :astro
     element :earliest, Integer
     element :latest, Integer
@@ -88,6 +102,7 @@ module FsFamilytreeV1
   class Date
     include HappyMapper
     
+    namespace_url NS
     element :original, String
     element :normalized, String
     element :astro, DateAstro
@@ -96,6 +111,7 @@ module FsFamilytreeV1
   class Place
     include HappyMapper
     
+    namespace_url NS
     element :original, String
     element :normalized, String, :attributes => {:placeId => String}
   end
@@ -104,6 +120,7 @@ module FsFamilytreeV1
     def self.init
       include HappyMapper
       
+      namespace_url NS
       attribute :role, String
       attribute :ref, String
       attribute :tempId, String
@@ -158,6 +175,7 @@ module FsFamilytreeV1
   class Assertions
     include HappyMapper
     
+    namespace_url NS
     has_many :name, Name
     has_many :gender, Gender
     has_many :event, Event
@@ -168,6 +186,7 @@ module FsFamilytreeV1
   class Person
     include HappyMapper
     
+    namespace_url NS
     attribute :id, String
     attribute :requestedId, String
     attribute :version, String
@@ -179,12 +198,14 @@ module FsFamilytreeV1
   class Persons
     include HappyMapper
     
+    namespace_url NS
     has_many :person, Person
   end
   
   class Familytree
     include HappyMapper
     
+    namespace_url NS
     attribute :version, String
     attribute :statusMessage, String
     attribute :statusCode, Integer

data/spec/communicator_spec.rb

@@ -0,0 +1,52 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe FsFamilytreeV1::Communicator do
+  
+  describe "fs_familytree_v1 call on the FsCommunicator" do
+    before(:each) do
+      @com = FsCommunicator.new
+      @ft_com_mock = mock("FsFamilytreeV1::Communicator")
+    end
+    
+    it "should add an fs_familytree_v1 method to the communicator" do
+      @com.should respond_to(:fs_familytree_v1)
+    end
+
+    it "should return a Communicator object when called" do
+      FsFamilytreeV1::Communicator.should_receive(:new).with(@com).and_return(@ft_com_mock)
+      famtree_com = @com.fs_familytree_v1
+      famtree_com.should == @ft_com_mock
+    end
+  end
+  
+  describe "person read" do
+    before(:each) do
+      @fs_com_mock = mock("FsCommunicator")
+      @res = mock("HTTP::Response")
+      @xml = fixture_file('person/KJ86-3VD.xml')
+      @res.stub!(:body).and_return(@xml)
+      @fs_com_mock.stub!(:get).and_return(@res)
+      
+      @ft_v1_com = FsFamilytreeV1::Communicator.new @fs_com_mock
+    end
+    
+    it "should call get on the FsCommunicator" do
+      @fs_com_mock.should_receive(:get).with('/familytree/v1/person/KJ86-3VD').and_return(@res)
+      @ft_v1_com.person('KJ86-3VD')
+    end
+    
+    it "should parse the result body from the call" do
+      ft = FsFamilytreeV1::Familytree.parse(@xml)
+      FsFamilytreeV1::Familytree.should_receive(:parse).with(@xml).and_return(ft)
+      @ft_v1_com.person('KJ86-3VD')
+    end
+    
+    it "should return a person of the id requested" do
+      id = 'KJ86-3VD'
+      person = @ft_v1_com.person(id)
+      person.id.should == id
+    end
+    
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jimmyz-fs-familytree-v1
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - Jimmy Zimmerman
@@ -42,7 +42,9 @@ extra_rdoc_files: []
 
 files: 
 - VERSION.yml
+- lib/communicator.rb
 - lib/fs_familytree_v1.rb
+- spec/communicator_spec.rb
 - spec/fixtures
 - spec/fixtures/person
 - spec/fixtures/person/KJ86-3VD.xml