ruby-fs-stack 0.4.7 → 0.4.8

data/VERSION

@@ -1 +1 @@
-0.4.7
+0.4.8

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

@@ -277,6 +277,48 @@ module FamilytreeV2
       end
     end
     
+    # ===params
+    # <tt>id_or_ids</tt> should be a string of the persons identifier. For the 'me' person, use :me or 'me'. Can also accept an array of ID strings.
+    # <tt>options</tt> accepts a hash of parameters as documented by the API.
+    # For full parameter documentation, see DevNet[https://devnet.familysearch.org/docs/api-manual-reference-system/familytree-v2/r_api_family_tree_person_read_v2.html]
+    #
+    # ===Example
+    #   # communicator is an authenticated FsCommunicator object
+    #   # Request a person with no assertions, only the version.
+    #   p = communicator.familytree_v2.person :me, :names => 'none', :genders => 'none', :events => 'none'
+    #   
+    #   p.version # => '90194378772'
+    #   p.id # => 'KW3B-NNM'
+    def contributor(id_or_ids)
+      if id_or_ids.kind_of? Array
+        multiple_ids = true
+        url = Base + 'contributor/' + id_or_ids.join(',')
+        props = properties()
+        if id_or_ids.size > props['contributor.max.ids'] 
+          contributors = []
+          id_or_ids.each_slice(props['contributor.max.ids']) do |ids_slice|
+            contributors = contributors + contributor(ids_slice)
+          end
+          return contributors
+        end
+      else
+        multiple_ids = false
+        id = id_or_ids.to_s
+        if id == 'me'
+          url = Base + 'contributor'
+        else
+          url = Base + 'contributor/' + id
+        end
+      end
+      response = @fs_communicator.get(url)
+      familytree = parse_response(response)
+      if multiple_ids
+        return familytree.contributors
+      else
+        return familytree.contributors.first
+      end
+    end
+    
     def properties
       if @properties_hash
         return @properties_hash

data/ruby-fs-stack.gemspec

@@ -1,15 +1,15 @@
 # Generated by jeweler
-# DO NOT EDIT THIS FILE
-# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{ruby-fs-stack}
-  s.version = "0.4.7"
+  s.version = "0.4.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jimmy Zimmerman"]
-  s.date = %q{2010-02-26}
+  s.date = %q{2010-03-04}
   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 = [
@@ -42,6 +42,7 @@ Gem::Specification.new do |s|
      "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",
@@ -109,3 +110,4 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<fakeweb>, [">= 0"])
   end
 end
+

data/spec/familytree_v2/familytree_communicator_spec.rb

@@ -594,4 +594,31 @@ describe FamilytreeV2::Communicator do
         
   end
   
+  describe "contributor read" do
+    before(:each) do
+      options = {
+        :domain => 'https://fakeweb.familysearch.org', 
+        :key => '1111-1111', 
+        :user_agent => "FsCommunicator/0.1",
+        :session => 'SESSID',
+      }
+      @com = FsCommunicator.new options
+      response = File.join(File.dirname(__FILE__),'json','fakeweb_contributor.txt')
+      FakeWeb.register_uri(:get, "https://fakeweb.familysearch.org/familytree/v2/contributor?sessionId=SESSID&dataFormat=application/json", 
+                          :response => response)
+    end
+    
+    it "should return a contributor record" do
+      contributor = @com.familytree_v2.contributor :me
+      contributor.class.should == FamilyTreeV2::Contributor
+    end
+    
+    it "should have an ID and contact name" do
+      contributor = @com.familytree_v2.contributor :me
+      contributor.id.should == 'MMDZ-8JD'
+      contributor.contactName.should == 'API User 1241'
+    end
+            
+  end
+  
 end

data/spec/familytree_v2/json/fakeweb_contributor.txt

@@ -0,0 +1,14 @@
+HTTP/1.1 200 OK
+Date: Thu, 04 Mar 2010 21:25:10 GMT
+APP_SVR_ID: 9.31
+Expires: Thu, 01 Jan 1970 00:00:00 GMT
+Cache-Control: no-cache
+Cache-Control: no-store
+X-PROCESSING-TIME: 147
+Content-Type: application/json;charset=utf-8
+Content-Language: en-US
+Content-Length: 134
+Set-Cookie: ftSessionId=USYS47776926A788A2044E0BEE0AC339E945.ptap009-035; Path=/
+Connection: close
+
+{"contributors":[{"id":"MMDZ-8JD","contactName":"API User 1241"}],"version":"2.1.20100119.5407","statusCode":200,"statusMessage":"OK"}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-fs-stack
 version: !ruby/object:Gem::Version 
-  version: 0.4.7
+  version: 0.4.8
 platform: ruby
 authors: 
 - Jimmy Zimmerman
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-26 00:00:00 -07:00
+date: 2010-03-04 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -67,6 +67,7 @@ files:
 - 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