ruby-fs-stack 0.2.1 → 0.2.2

data/Rakefile

@@ -11,6 +11,7 @@ begin
     gem.homepage = "http://github.com/jimmyz/ruby-fs-stack"
     gem.authors = ["Jimmy Zimmerman"]
     gem.add_development_dependency "rspec"
+    gem.add_development_dependency "fakeweb"
     gem.requirements << "This gem requires a json gem (json, json_pure, or json-jruby)."
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.2.2

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

@@ -80,6 +80,30 @@ module FamilytreeV2
       familytree.searches[0]
     end
     
+    # ====Params
+    # <tt>id_or_hash</tt> - Either an ID or a hash of match parameters matching API doc
+    # <tt>hash</tt> - if the first parameter is an ID, then this will contain the hash
+    # of match parameters.
+    def match(id_or_hash, hash={})
+      url = Base + 'match'
+      if id_or_hash.kind_of? String
+        id = id_or_hash
+        url += "/#{id}"
+        params_hash = hash
+      elsif id_or_hash.kind_of? Hash
+        id = nil
+        params_hash = id_or_hash
+      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?
+      response = @fs_communicator.get(url)
+      familytree = Org::Familysearch::Ws::Familytree::V2::Schema::FamilyTree.from_json JSON.parse(response.body)
+      # require 'pp'
+      # pp familytree
+      familytree.matches[0]
+    end
+    
     # ====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
@@ -807,6 +831,7 @@ module Org::Familysearch::Ws::Familytree::V2::Schema
   
   class SearchPerson
     alias :name :full_name
+    alias :ref :id
     def events
       (assertions && assertions.events) ? assertions.events : []
     end

data/ruby-fs-stack.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ruby-fs-stack}
-  s.version = "0.2.1"
+  s.version = "0.2.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-09}
+  s.date = %q{2009-12-10}
   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 = [
@@ -47,6 +47,7 @@ Gem::Specification.new do |s|
      "spec/familytree_v2/json/person/relationship_read.js",
      "spec/familytree_v2/json/person/relationship_update.js",
      "spec/familytree_v2/json/search.js",
+     "spec/familytree_v2/match_results_spec.rb",
      "spec/familytree_v2/person_spec.rb",
      "spec/familytree_v2/search_results_spec.rb",
      "spec/fs_utils_spec.rb",
@@ -64,6 +65,7 @@ Gem::Specification.new do |s|
   s.test_files = [
     "spec/communicator_spec.rb",
      "spec/familytree_v2/familytree_communicator_spec.rb",
+     "spec/familytree_v2/match_results_spec.rb",
      "spec/familytree_v2/person_spec.rb",
      "spec/familytree_v2/search_results_spec.rb",
      "spec/fs_utils_spec.rb",
@@ -80,10 +82,13 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<fakeweb>, [">= 0"])
     else
       s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<fakeweb>, [">= 0"])
     end
   else
     s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<fakeweb>, [">= 0"])
   end
 end

data/spec/familytree_v2/familytree_communicator_spec.rb

@@ -156,6 +156,47 @@ describe FamilytreeV2::Communicator do
       
     end
     
+    describe "match" do
+      
+      before(:each) do
+        @fs_com_mock = mock("FsCommunicator")
+        @res = mock("HTTP::Response")
+        @ft_v2_com = FamilytreeV2::Communicator.new @fs_com_mock
+        
+        @json = read_file('../match_KW3B-NNM.js') 
+        @res.stub!(:body).and_return(@json)
+        @res.stub!(:code).and_return('200')
+        @fs_com_mock.stub!(:get).and_return(@res)
+      end
+      
+      it "should call the match endpoint" do
+        @fs_com_mock.should_receive(:get).with("/familytree/v2/match?name=John")
+        @ft_v2_com.match :name => "John"
+      end
+      
+      it "should return the MatchResults element" do
+        search_results = @ft_v2_com.match :name => "John"
+        search_results.class.should == Org::Familysearch::Ws::Familytree::V2::Schema::MatchResults
+        search_results.count.should == 4
+      end
+      
+      it "should serialize embedded parent parameters" do
+        @fs_com_mock.should_receive(:get).with("/familytree/v2/match?father.name=John")
+        @ft_v2_com.match :father => {:name => "John"}
+      end
+      
+      it "should accept an id as the first parameter" do
+        @fs_com_mock.should_receive(:get).with("/familytree/v2/match/KWQS-BBQ")
+        @ft_v2_com.match 'KWQS-BBQ'
+      end
+      
+      it "should accept an id AND hash if passed" do
+        @fs_com_mock.should_receive(:get).with("/familytree/v2/match/KWQS-BBQ?maxResults=5")
+        @ft_v2_com.match 'KWQS-BBQ', :maxResults => 5
+      end
+      
+    end
+    
     describe "reading relationships" do
       
       describe "for relationships that already exist" do

data/spec/familytree_v2/match_results_spec.rb

@@ -0,0 +1,117 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require 'ruby-fs-stack/familytree'
+
+describe Org::Familysearch::Ws::Familytree::V2::Schema::MatchResults, "parsing match results" do
+  FamilyTreeV2 = Org::Familysearch::Ws::Familytree::V2::Schema
+  
+  def read_file(filename)
+    fname = File.join(File.dirname(__FILE__),'json',filename)
+    File.read(fname)
+  end
+  
+  before(:all) do
+    json = read_file('match_KW3B-NNM.js')
+    familytree = FamilyTreeV2::FamilyTree.from_json JSON.parse(json)
+    @match = familytree.matches[0]
+    @results = @match.results
+  end
+  
+  it "should have a count of 4" do
+    @match.count.should == 4
+  end
+  
+  it "should parse an xml string and return a MatchResult object" do
+    @results.first.should be_instance_of(FamilyTreeV2::MatchResult)
+  end
+  
+  it "should have 4 result" do
+    @results.should have(4).thing
+  end
+  
+  it "should have first result with ref of KW3B-VC8" do
+    @results.first.ref.should eql('KW3B-VC8')
+  end
+  
+  it "should have first result with a confidence of High" do
+    @results.first.confidence.should eql('High')
+  end
+  
+  describe "first match person" do
+    before(:all) do
+      match = @results.first
+      @person = match.person
+    end
+    
+    it "should keep an alias for ref for v1 migration" do
+      @person.ref.should == 'KW3B-VC8'
+    end
+    
+    it "should have name of John Flack" do
+      @person.name.should eql('John Flack')
+    end
+    
+    it "should be male" do
+      @person.gender.should eql('Male')
+    end
+    
+    it "should have 4 events" do
+      @person.events.should have(4).things
+    end
+    
+    it "should have birth date of 5 June 1880" do
+      @person.birth.date.original.should eql('5 June 1880')
+    end
+        
+    it "should have death date of 5 Aug 1953" do
+      @person.death.date.original.should eql('5 Aug 1953')
+    end
+        
+  end
+  
+  describe "first result person's father" do
+    before(:all) do
+      match = @results.first
+      @person = match.father
+    end
+    
+    it "should have name of Alfred Flack" do
+      @person.name.should eql('Alfred Flack')
+    end
+    
+    it "should be male" do
+      @person.gender.should eql('Male')
+    end
+    
+    it "should have 0 events" do
+      @person.events.should have(0).things
+    end
+    
+    it "should have nil birth" do
+      @person.birth.should be_nil
+    end    
+  end
+
+  describe "first result person's mother" do
+    before(:all) do
+      match = @results.first
+      @person = match.mother
+    end
+    
+    it "should have name of Sarah Lunt" do
+      @person.name.should eql('Sarah Lunt')
+    end
+    
+    it "should be female" do
+      @person.gender.should eql('Female')
+    end
+    
+    it "should have 0 events" do
+      @person.events.should have(0).things
+    end    
+  end
+  
+  describe "first result first spouse" do
+    # Inherits from SearchResult so this doesn't need to be tested.
+  end
+end
+

data/spec/spec_helper.rb

@@ -3,6 +3,7 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'ruby-fs-stack'
 require 'spec'
 require 'spec/autorun'
+require 'fakeweb'
 
 Spec::Runner.configure do |config|
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-fs-stack
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors: 
 - Jimmy Zimmerman
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-09 00:00:00 -07:00
+date: 2009-12-10 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,6 +22,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 description: A library that enables you to read and update information with the new.familysearch.org API.
 email: jimmy.zimmerman@gmail.com
 executables: []
@@ -62,6 +72,7 @@ files:
 - spec/familytree_v2/json/person/relationship_read.js
 - spec/familytree_v2/json/person/relationship_update.js
 - spec/familytree_v2/json/search.js
+- spec/familytree_v2/match_results_spec.rb
 - spec/familytree_v2/person_spec.rb
 - spec/familytree_v2/search_results_spec.rb
 - spec/fs_utils_spec.rb
@@ -100,6 +111,7 @@ summary: Ruby wrapper for all FamilySearch APIs.
 test_files: 
 - spec/communicator_spec.rb
 - spec/familytree_v2/familytree_communicator_spec.rb
+- spec/familytree_v2/match_results_spec.rb
 - spec/familytree_v2/person_spec.rb
 - spec/familytree_v2/search_results_spec.rb
 - spec/fs_utils_spec.rb