familysearch 0.3.0 → 0.4.0

data/README.md

@@ -8,7 +8,7 @@ You can install it from the commandline.
 
 Or add it to a Gemfile for use with Bundler
 
-    gem "familysearch", "~> 0.3.0 "
+    gem "familysearch", "~> 0.4.0 "
 
 
 ## Basic Usage
@@ -29,8 +29,17 @@ Here's how to use it
     response = client.get(client.discovery['links']['current-user-person']['href'])
     response.status #=> 200
 	
-	# The response contains a Hash object on the body attribute.
+	  # The response body contains a FamilySearch::Gedcomx::FamilySearch object.
+    # This is technically a Hash, so you could do the following
     response.body['persons'][0]['display']['name']
+    
+    # The FamilySearch::Gedcomx::FamilySearch object also provides convenience methods
+    # and the hash elements have method accessors
+    person = response.body.persons[0]
+    person.full_name #=> "Marshall P Felch"
+    person.surname #=> "Felch"
+    person.birth # => a FamilySearch::Gedcomx::Fact object
+
 
 ## Discovery Resource
 
@@ -60,6 +69,12 @@ The above code is equivalent to the following:
 
 	response = client.get 'https://sandbox.familysearch.org/platform/tree/persons/KWQX-52J'
 
+## FamilySearch::Gedcomx
+
+A separate `familysearch-gedcomx` gem is pulled in as a dependency for the `familysearch` gem. This provides a Ruby object structure that matches the [application/x-fs-v1+json](https://familysearch.org/developers/docs/api/fs_json) hypermedia type. It also provides convenience methods and graph (pedigree) traversal functionality.
+
+For more information visit the [familysearch-gedcomx](https://github.com/jimmyz/familysearch-gedcomx-rb) homepage.
+
 ## Faraday
 
 This gem depends upon the wonderful `faraday` gem for handling HTTP calls. One of the advantages of this is that you could possibly swap out underlying http libraries. Currently, it utilizes the Net::HTTP library, but in the future it could potentially support other libraries such as EventMachine's asynchronous http library.
@@ -73,12 +88,14 @@ This gem makes use of the awesome `multi_json` gem. This allows you to utilize f
 Next on the roadmap:
 
 * Support post, put, delete, head, etc. from the FamilySearch::URLTemplate objec. (currently only supports get)
-* Better object deserialization. Currently, everything is just a dumb Hash. I'd like to be able to allow an option to pass in another middleware for smarter objects (pershaps Hashie::Mash or Rash, or some sort of GedcomX model).
+* Better Faraday configuration options for the client.
+* Testing of more endpoints (search, match, etc.)
+* JSON serialization for put, post, etc.
 * More documentation examples.
 
 ## Bugs and Feature Requests
 
-Please file bug reports and 
+Please file bug reports and enhancement requests on [the issue tracker](https://github.com/jimmyz/familysearch-rb/issues).
 
 ## Copyright
 

data/familysearch.gemspec

@@ -20,6 +20,8 @@ Gem::Specification.new do |s|
   s.add_dependency("faraday", ["~> 0.8.4"])
   s.add_dependency("faraday_middleware", ["~> 0.9.0"])
   s.add_dependency("multi_json", ["~> 1.5.0"])
+  s.add_dependency("addressable", ["~> 2.3.3"])
+  s.add_dependency("familysearch-gedcomx", ["~> 1.0.0"])
   s.add_development_dependency("rspec", ["~> 2.13.0"])
   s.add_development_dependency("shoulda", ["~> 3.3.2"])
   s.add_development_dependency("bundler", [">= 1.2.3"])

data/lib/familysearch/client.rb

@@ -79,6 +79,7 @@ module FamilySearch
       @agent = Faraday.new(@base_url) do |faraday|
         faraday.response :familysearch_errors
         faraday.response :logger, options[:logger] if options[:logger]
+        faraday.response :gedcomx_parser
         faraday.response :multi_json
         faraday.response :follow_redirects, :limit => 3, :standards_compliant => true
         faraday.headers['Accept'] = 'application/x-fs-v1+json'

data/lib/familysearch/middleware/response/familysearch_gedcomx.rb

@@ -0,0 +1,15 @@
+require 'familysearch/gedcomx'
+
+module FamilySearch
+  module Middleware
+    # Parse
+    class GedcomxParser < Faraday::Response::Middleware      
+      # The method that has MultiJson parse the json string.
+      def parse(body)
+        FamilySearch::Gedcomx::FamilySearch.new body
+      end
+    end
+  end
+end
+
+Faraday.register_middleware :response, :gedcomx_parser => FamilySearch::Middleware::GedcomxParser

data/lib/familysearch/middleware.rb

@@ -1,2 +1,3 @@
 require 'familysearch/middleware/response/familysearch_errors'
-require 'familysearch/middleware/response/multi_json'
+require 'familysearch/middleware/response/multi_json'
+require 'familysearch/middleware/response/familysearch_gedcomx'

data/lib/familysearch/url_template.rb

@@ -1,3 +1,4 @@
+require 'addressable/template'
 module FamilySearch
   # Used to make calls on templates that are exposed through the Discovery Resource.
   # 
@@ -82,9 +83,9 @@ module FamilySearch
     def get(template_values)
       raise FamilySearch::Error::MethodNotAllowed unless allow.include?('get')
       template_values = validate_values(template_values)
-      url = make_url(template_values)
-      params = make_params(template_values)
-      @client.get url, params
+      t = Addressable::Template.new(@template)
+      url = t.expand(template_values).to_s
+      @client.get url
     end
     
     private
@@ -107,26 +108,5 @@ module FamilySearch
       end
       stringified_hash
     end
-    
-    def make_url(template_values)
-      url = @template.gsub(/\{\?[^}]*\}/,'')
-      template_values.each do |k,v|
-        to_replace = "{#{k}}"
-        url.gsub!(to_replace,v)
-      end
-      url
-    end
-    
-    def make_params(template_values)
-      to_remove = url_values
-      to_remove.each do |v|
-        template_values.delete(v)
-      end
-      template_values
-    end
-    
-    def url_values
-      @template.scan(/\{(\w*)\}/).flatten
-    end
   end
 end

data/lib/familysearch/version.rb

@@ -1,4 +1,4 @@
 module FamilySearch
   # The version of the familysearch gem. Can be accessed from code FamilySearch::VERSION
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/familysearch.rb

@@ -1,2 +1,3 @@
 require 'familysearch/version'
-require 'familysearch/client'
+require 'familysearch/gedcomx' # located in dependent familysearch-gedcomx gem
+require 'familysearch/client'

data/spec/client_spec.rb

@@ -1,5 +1,5 @@
 require 'spec_helper'
-require 'familysearch/client'
+require 'familysearch'
 
 describe FamilySearch::Client do
   
@@ -226,7 +226,7 @@ describe FamilySearch::Client do
     it "should allow you to make a call to a template and get a result" do
       VCR.use_cassette('person_by_id') do
         result = client.template('person').get 'pid' => 'KWQX-52J'
-        result.body.should be_kind_of(Hash)
+        result.body.should be_instance_of(FamilySearch::Gedcomx::FamilySearch)
       end
     end
   end

data/spec/url_template_spec.rb

@@ -91,25 +91,25 @@ describe FamilySearch::URLTemplate do
     
     it "should call get on the client with the url and values on the querystring" do
       VCR.use_cassette('person_with_relationship') do
-        client.should_receive(:get).with('https://sandbox.familysearch.org/platform/tree/persons-with-relationships',{'person' => 'KWQX-52J'}).and_call_original
+        client.should_receive(:get).with('https://sandbox.familysearch.org/platform/tree/persons-with-relationships?person=KWQX-52J').and_call_original
         template.get 'person' => 'KWQX-52J'
       end
     end
     
     it "should call get on the client with the url and no querystring if nothing needs to be called" do
       VCR.use_cassette('person_by_id') do
-        client.should_receive(:get).with('https://sandbox.familysearch.org/platform/tree/persons/KWQX-52J',{})
+        client.should_receive(:get).with('https://sandbox.familysearch.org/platform/tree/persons/KWQX-52J')
         person_template.get 'pid' => 'KWQX-52J'
       end
     end
     
     it "should accept symbols in the values hash" do
       VCR.use_cassette('person_with_relationship') do
-        client.should_receive(:get).with('https://sandbox.familysearch.org/platform/tree/persons-with-relationships',{'person' => 'KWQX-52J'}).and_call_original
+        client.should_receive(:get).with('https://sandbox.familysearch.org/platform/tree/persons-with-relationships?person=KWQX-52J').and_call_original
         template.get :person => 'KWQX-52J'
       end
       VCR.use_cassette('person_by_id') do
-        client.should_receive(:get).with('https://sandbox.familysearch.org/platform/tree/persons/KWQX-52J',{})
+        client.should_receive(:get).with('https://sandbox.familysearch.org/platform/tree/persons/KWQX-52J')
         person_template.get :pid => 'KWQX-52J'
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: familysearch
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-28 00:00:00.000000000 Z
+date: 2013-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -59,6 +59,38 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.5.0
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.3
+- !ruby/object:Gem::Dependency
+  name: familysearch-gedcomx
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -160,6 +192,7 @@ files:
 - lib/familysearch/error.rb
 - lib/familysearch/middleware.rb
 - lib/familysearch/middleware/response/familysearch_errors.rb
+- lib/familysearch/middleware/response/familysearch_gedcomx.rb
 - lib/familysearch/middleware/response/multi_json.rb
 - lib/familysearch/url_template.rb
 - lib/familysearch/version.rb