familysearch 0.1.0

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'vcr'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
+  c.hook_into :webmock # or :fakeweb
+end

data/workspace/notes/APIDesign.txt

@@ -0,0 +1,51 @@
+require 'familysearch'
+
+# Ways to instantiate a client
+
+# This would start with an access_token and keep it for all requests.
+client = FamilySearch::Client.new :env => :production, :access_token => '{YOUR_ACCESS_TOKEN}', :logger => Logger.new(STDOUT)
+
+# Will probably support Basic Auth through this gem, so we would need the developer key for that
+client = FamilySearch::Client.new :host => 'https://sandbox.familysearch.org', :key => '{YOUR_DEV_KEY}', :logger => Logger.new(File.new('log/api.log'))
+client = FamilySearch::Client.new :host => 'http://localhost:5000', :key => '{YOUR_DEV_KEY}'
+
+# Requests would automatically include the following headers: 
+# Authorization: Bearer {access_token}
+# Accept: application/x-fs-v1+json
+# 
+# Responses would automatically be parsed into a smart object
+
+discovery = client.get :discovery
+me = client.get discovery['links']['current-user-person']['href']
+
+# Convenience methods like this #display method would allow you to easily access info 
+# buried deep into the object structure.
+me.display :name
+me.display :surname
+me.display :birth_date
+me.display :death_place
+
+# We would want an easy way to create new persons, relationships, etc.
+person = FamilySearch::Person.new
+person.add :name => 'Jimmy /Zimmerman/'
+person.add :birth => {:date => '14 Aug 2010', :place => 'Tuscarawas, Ohio, United States'}
+
+# Perhaps this could also be chained?
+person.add({:name => 'Jimmy /Zimmerman/'}).add({:birth => {:date => '14 Aug 2010', :place => 'Tuscarawas, Ohio, United States'}})
+
+# The client would support all HTTP methods
+client.post person
+
+# Or perhaps we would do something like this, because the person object
+# should know its own URL, so it could theoretically post to itself as long
+# as it had a way of accessing the client
+person.save
+
+# The client could accept full URLs
+client.get("https://familysearch.org/platform/tree/persons/KWQS-BBQ")
+
+# The client may support URL templates too
+client.get(:person,'KWQS-BBQ')
+
+# Perhaps we could allow lazy-loaded relationship traversal?
+person.relationships.parents.father.get

data/workspace/notes/discovery_links.txt

@@ -0,0 +1,72 @@
+authorities
+child_and_parents_relationships
+couple_relationships
+current_user
+current_user_person
+discussions
+folders
+fs_identity_v2_login
+fs_identity_v2_logout
+fs_identity_v2_permission
+fs_identity_v2_session
+http://oauth.net/core/2.0/endpoint/authorize
+http://oauth.net/core/2.0/endpoint/token
+parent_child_relationship_template
+persons
+person_search
+registration
+reservation
+source_descriptions
+
+ancestry_query
+descendancy_query
+person_matches_query
+person_with_relationships_query
+
+agent_template
+change_restore_template
+child_and_parents_relationship_changes_template
+child_and_parents_relationship_conclusion_template
+child_and_parents_relationship_notes_template
+child_and_parents_relationship_note_template
+child_and_parents_relationship_parent_template
+child_and_parents_relationship_restore_template
+child_and_parents_relationship_source_references_template
+child_and_parents_relationship_source_reference_template
+child_and_parents_relationship_template
+child_relationships_template
+couple_relationship_changes_template
+couple_relationship_conclusion_template
+couple_relationship_notes_template
+couple_relationship_note_template
+couple_relationship_restore_template
+couple_relationship_source_references_template
+couple_relationship_source_reference_template
+couple_relationship_template
+discussion_comments_template
+discussion_comment_template
+discussion_template
+fs_child_relationships_template
+fs_parent_relationships_template
+parent_relationships_template
+person_changes_template
+person_change_summary_template
+person_conclusion_template
+person_discussion_references_template
+person_discussion_reference_template
+person_matches_template
+person_merge_template
+person_notes_template
+person_note_template
+person_restore_template
+person_source_references_template
+person_source_reference_template
+person_template
+preferred_parent_relationship_template
+preferred_spouse_relationship_template
+source_description_template
+source_folder_descriptions_template
+source_folder_descriptions_trashbin_template
+source_folder_template
+spouse_relationships_template
+user_source_folders_template

data/workspace/notes/goals.txt

@@ -0,0 +1,17 @@
+* Implementation less complex than ruby-fs-stack so that other Ruby programmers can easily update.
+* Useful RDoc Documentation for objects.
+* Ability to maintain compatibility as GEDCOMX versions increment.
+* Tested with RSpec.
+* Support for Ruby 1.8.7, 1.9.3, JRuby, and Rubinius
+* Flexibility to access and use any aspect of the Platform without the need to write new gem code.
+  * This would be provided by raw get, put, post, delete methods against a URL and providing a hash of ruby code.
+* Follow HATEOAS principles.
+* Provide convenience methods for simplifying consumer code.
+* Logging should be configurable - 
+* Provide functionality for the following
+  * Reading the discovery resource
+  * Authentication (Basic)
+  * Maintaining sessions
+  * Following links from one resource to the next
+  * Reading, stitching, and traversing pedigree resources
+  

metadata

@@ -0,0 +1,245 @@
+--- !ruby/object:Gem::Specification
+name: familysearch
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Jimmy Zimmerman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.4
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: rash
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.3.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.3
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.10.0
+description: A gem for the FamilySearch Platform. Documentation for the FamilySearch
+  Platform can be found at https://
+email: jimmy.zimmerman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- .rvmrc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- familysearch.gemspec
+- lib/familysearch.rb
+- lib/familysearch/client.rb
+- spec/client_spec.rb
+- spec/familysearch_spec.rb
+- spec/fixtures/vcr_cassettes/discovery.yml
+- spec/fixtures/vcr_cassettes/discovery_auth.yml
+- spec/spec_helper.rb
+- workspace/notes/APIDesign.txt
+- workspace/notes/discovery_links.txt
+- workspace/notes/goals.txt
+homepage: http://github.com/jimmyz/familysearch-rb
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 464565350815825193
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A gem for the FamilySearch Platform.
+test_files: []