ruby-fs-stack 0.1.7 → 0.2.0

data/README.rdoc

@@ -5,22 +5,87 @@ API modules provided by FamilySearch.
 
 == Installation
 
-This project is being configured as a Ruby Gem. Instructions will be posted here
-as soon you can install the gem from RubyForge.
+If you haven't added gemcutter.org to your gem sources, run
+
+  gem sources -a http://gemcutter.org
+
+Install the ruby-fs-stack gem
+
+  sudo gem install ruby-fs-stack
+  
+=== JSON gem
+Ruby-fs-stack needs a json gem, but does not force it as a dependency.
+
+  sudo gem install json
+
+or if you are using JRuby
+
+  sudo gem install json-jruby
+
+or for the pure Ruby implementation
+
+  sudo gem install json_pure
 
 == Example Usage
 
-# Example code will be posted here as soon as it is packaged as a gem.
+=== Authenticating with FamilySearch
+
+  require 'ruby-fs-stack'
+
+  communicator = FsCommunicator.new :domain => 'http://www.dev.usys.org', # or 'https://api.familysearch.org'
+                                    :key => 'DEVELOPER-KEY',
+                                    :user_agent => 'Ruby-Fs-Stack/v.1 (JimmyZimmerman) FsCommunicator/0.1 (Ruby)'
+
+  communicator.identity_v1.authenticate :username => 'USERNAME', :password => 'PASSWORD' #=> true
+  communicator.session #=> "USYSE4EF197..."
 
-See examples/login_example.rb[http://github.com/jimmyz/ruby-fs-stack/tree/master/examples/login_example.rb]
+=== Reading Person Records
 
-See examples/familytree_example.rb[http://github.com/jimmyz/ruby-fs-stack/tree/master/examples/familytree_example.rb]
+  me = communicator.familytree_v2.person :me
+  puts "My name: " + me.full_name
+  puts "My birthdate: " + me.birth.value.date.normalized
+
+  # Read only the version number for a person
+  vperson = communicator.familytree_v2.person 'KW3B-NNM', :names => 'none', :genders => 'none', :events => 'none'
+  puts "Person's version: " + vperson.person
+  
+  # read the person and the parent, family, and child information
+  person = ftcom.person 'KW3B-NNM', :parents => 'summary', :families => 'all', :children => 'all'
+  
+  puts "Gender: " + person.gender
+  puts "First parent ID: " + person.parents[0].parents[0].id
+  puts "First child ID: " + person.families[0].children[0].id
+  puts "First spouse's gender: " + person.families[0].parents[1].gender
+  puts "First spouse's ID: " + person.families[0].parents[1].id
+  
+=== Searching Records
+
+  search = communicator.familytree_v2.search  :givenName => "John", 
+                                              :familyName => "Doe",
+                                              :birthDate => "12 Jun 1812",
+                                              :birthPlace => "Virginia, United States",
+                                              :father => {:givenName => "Robert"},
+                                              :maxResults => 10
+  search.count #=> 10
+  search.close #=> 2
+  search.partial #=> 16
+  search.results.each do |result|
+    puts result.score #=> 4.0
+    puts result.id #=> "KW3B-JXV"
+    puts result.person.full_name #=> "John Doe"
+    puts result.person.birth.date.original #=> "abt 1812"
+    puts result.father.full_name #=> "Robert Doe"
+    puts result.mother.full_name #=> "Ruby Johnson"
+    puts result.spouses.first.full_name #=> "Sarah Franklin"
+  end
 
 == Discussion
 
 A Google Group has been set up for questions and discussion
 around the ruby-fs-stack project.
 
+http://groups.google.com/group/ruby-fs-stack
+
 == Copyright
 
 Copyright (c) 2009 Jimmy Zimmerman. See LICENSE for details.

data/Rakefile

@@ -11,9 +11,7 @@ begin
     gem.homepage = "http://github.com/jimmyz/ruby-fs-stack"
     gem.authors = ["Jimmy Zimmerman"]
     gem.add_development_dependency "rspec"
-    gem.add_dependency('json', '>=1.1.7')
-    gem.files << "lib/ruby-fs-stack/enunciate/identity.rb"
-    gem.files << "lib/ruby-fs-stack/enunciate/familytree.rb"
+    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
 rescue LoadError

data/VERSION

@@ -1 +1 @@
-0.1.7
+0.2.0

data/ruby-fs-stack.gemspec

@@ -0,0 +1,89 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ruby-fs-stack}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jimmy Zimmerman"]
+  s.date = %q{2009-12-05}
+  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 = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "examples/familytree_example.rb",
+     "examples/login_example.rb",
+     "lib/ruby-fs-stack.rb",
+     "lib/ruby-fs-stack/assets/entrust-ca.crt",
+     "lib/ruby-fs-stack/enunciate/LICENSE",
+     "lib/ruby-fs-stack/enunciate/README",
+     "lib/ruby-fs-stack/enunciate/familytree.rb",
+     "lib/ruby-fs-stack/enunciate/identity.rb",
+     "lib/ruby-fs-stack/familytree.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/warning_suppressor.rb",
+     "ruby-fs-stack.gemspec",
+     "spec/communicator_spec.rb",
+     "spec/familytree_v2/familytree_communicator_spec.rb",
+     "spec/familytree_v2/json/match_KW3B-NNM.js",
+     "spec/familytree_v2/json/person/KJ86-3VD_all.js",
+     "spec/familytree_v2/json/person/KJ86-3VD_version.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/search.js",
+     "spec/familytree_v2/person_spec.rb",
+     "spec/familytree_v2/search_results_spec.rb",
+     "spec/fs_utils_spec.rb",
+     "spec/identity_v1/identity_spec.rb",
+     "spec/identity_v1/json/login.js",
+     "spec/ruby-fs-stack_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/jimmyz/ruby-fs-stack}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.requirements = ["This gem requires a json gem (json, json_pure, or json-jruby)."]
+  s.rubygems_version = %q{1.3.5}
+  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/person_spec.rb",
+     "spec/familytree_v2/search_results_spec.rb",
+     "spec/fs_utils_spec.rb",
+     "spec/identity_v1/identity_spec.rb",
+     "spec/ruby-fs-stack_spec.rb",
+     "spec/spec_helper.rb",
+     "examples/familytree_example.rb",
+     "examples/login_example.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 0"])
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-fs-stack
 version: !ruby/object:Gem::Version 
-  version: 0.1.7
+  version: 0.2.0
 platform: ruby
 authors: 
 - Jimmy Zimmerman
@@ -22,16 +22,6 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
-- !ruby/object:Gem::Dependency 
-  name: json
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.1.7
-    version: 
 description: A library that enables you to read and update information with the new.familysearch.org API.
 email: jimmy.zimmerman@gmail.com
 executables: []
@@ -61,6 +51,7 @@ files:
 - lib/ruby-fs-stack/fs_utils.rb
 - lib/ruby-fs-stack/identity.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/match_KW3B-NNM.js
@@ -99,12 +90,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version 
       version: "0"
   version: 
-requirements: []
-
+requirements: 
+- This gem requires a json gem (json, json_pure, or json-jruby).
 rubyforge_project: 
 rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Ruby wrapper for all FamilySearch APIs.
 test_files: 
 - spec/communicator_spec.rb