familysearch 0.2.0 → 0.3.0

data/spec/url_template_spec.rb

@@ -0,0 +1,117 @@
+require 'spec_helper'
+require 'familysearch/client'
+
+describe FamilySearch::URLTemplate do
+  
+  describe "initializing" do
+    def template_hash
+      {
+        "template" => "https://sandbox.familysearch.org/platform/tree/persons/{pid}/change-summary{?access_token}",
+        "type" => "application/atom+xml,application/json,application/x-gedcomx-atom+json,application/xml,text/html",
+        "accept" => "*/*",
+        "allow" => "GET",
+        "title" => "Person Change Summary"
+      }
+    end
+    
+    def client
+      FamilySearch::Client.new
+    end
+    
+    it "should accept the client object and a hash" do
+      template = FamilySearch::URLTemplate.new(client,template_hash)
+    end
+    
+    it "should set instance attributes for the objects in the hash" do
+      template = FamilySearch::URLTemplate.new(client,template_hash)
+      template.template.should == "https://sandbox.familysearch.org/platform/tree/persons/{pid}/change-summary{?access_token}"
+      template.type.should == "application/atom+xml,application/json,application/x-gedcomx-atom+json,application/xml,text/html"
+      template.accept.should == '*/*'
+      template.allow.should == ['get']
+      template.title.should == 'Person Change Summary'
+    end
+  end
+  
+  describe "get" do
+    def template_hash
+      {
+        "template" => "https://sandbox.familysearch.org/platform/tree/persons-with-relationships{?access_token,person}",
+        "type" => "application/json,application/x-fs-v1+json,application/x-fs-v1+xml,application/xml,text/html",
+        "accept" => "*/*",
+        "allow" => "GET",
+        "title" => "Person With Relationships" 
+      }
+    end
+    
+    def person_template_hash
+      {
+        "template" => "https://sandbox.familysearch.org/platform/tree/persons/{pid}{?access_token}",
+        "type" => "application/json,application/x-fs-v1+json,application/x-fs-v1+xml,application/x-gedcomx-v1+json,application/x-gedcomx-v1+xml,application/xml,text/html",
+        "accept" => "application/x-fs-v1+json,application/x-fs-v1+xml,application/x-gedcomx-v1+json,application/x-gedcomx-v1+xml",
+        "allow" => "HEAD,GET,POST,DELETE,GET,POST",
+        "title" => "Person"
+      }
+    end
+    
+    def client()
+      unless @client
+        @client = FamilySearch::Client.new(:key => 'WCQY-7J1Q-GKVV-7DNM-SQ5M-9Q5H-JX3H-CMJK' )
+        @client.discover!
+        @client.basic_auth! 'api-user-1241', '1782'
+      end
+      @client
+    end
+    
+    def template
+      @template ||= FamilySearch::URLTemplate.new client, template_hash
+    end
+    
+    def person_template
+      @person_template ||= FamilySearch::URLTemplate.new client, person_template_hash
+    end
+    
+    it "should accept a hash of options" do
+      VCR.use_cassette('person_with_relationship') do
+        template.get 'person' => 'KWQX-52J'
+      end
+    end
+    
+    it "should raise an error if the get isn't in the allowed list" do
+      VCR.use_cassette('person_with_relationship') do
+        template.stub!(:allow).and_return([])
+        expect {template.get 'person' => 'KWQX-52J'}.to raise_error(FamilySearch::Error::MethodNotAllowed)
+      end
+    end
+    
+    it "should raise an error if a template value isn't found in the template" do
+      VCR.use_cassette('person_with_relationship') do
+        expect {template.get 'person_id' => 'KWQX-52J'}.to raise_error(FamilySearch::Error::TemplateValueNotFound)
+      end
+    end
+    
+    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
+        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',{})
+        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
+        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',{})
+        person_template.get :pid => 'KWQX-52J'
+      end
+    end
+  end
+end

data/workspace/notes/APIDesign.txt

@@ -45,7 +45,7 @@ person.save
 client.get("https://familysearch.org/platform/tree/persons/KWQS-BBQ")
 
 # The client may support URL templates too
-client.get(:person,'KWQS-BBQ')
+client.template('person').get :pid => 'KWQS-BBQ'
 
 # Perhaps we could allow lazy-loaded relationship traversal?
 person.relationships.parents.father.get

data/workspace/notes/errors.txt

@@ -0,0 +1,5 @@
+Errors:
+
+FamilySearch::Error::BadCredentials
+FamilySearch::Error::NotAuthorized
+FamilySearch::Error::NotFound

data/workspace/notes/gem_design.txt

@@ -0,0 +1,7 @@
+Gems:
+familysearch - contain the client for making http calls, discovery, and URL templates (parses JSON by default)
+familysearch-gedcomx - object model for parsing and serializing GedcomX (XML or JSON?)
+familysearch-oauth2 - an client for doing oauth authentication (non-omniauth option)
+
+Future:
+familysearch-client - Break this out to contain the client for making http calls, discovery, and URL templates

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: familysearch
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-19 00:00:00.000000000 Z
+date: 2013-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -59,38 +59,6 @@ dependencies:
     - - ~>
       - !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: 1.2.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.2.0
-- !ruby/object:Gem::Dependency
-  name: rash
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.3.2
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.3.2
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -128,7 +96,7 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.2.3
   type: :development
@@ -136,25 +104,9 @@ dependencies:
   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
@@ -188,35 +140,46 @@ dependencies:
       - !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
+  Platform can be found at https://familysearch.org/developers/.
+email:
+- jimmy.zimmerman@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- LICENSE.txt
-- README.md
+extra_rdoc_files: []
 files:
 - .document
+- .gitignore
 - .rvmrc
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- VERSION
 - familysearch.gemspec
 - lib/familysearch.rb
 - lib/familysearch/client.rb
+- lib/familysearch/error.rb
+- lib/familysearch/middleware.rb
+- lib/familysearch/middleware/response/familysearch_errors.rb
+- lib/familysearch/middleware/response/multi_json.rb
+- lib/familysearch/url_template.rb
+- lib/familysearch/version.rb
 - spec/client_spec.rb
 - spec/familysearch_spec.rb
+- spec/fixtures/vcr_cassettes/current_user_person_read.yml
 - spec/fixtures/vcr_cassettes/discovery.yml
 - spec/fixtures/vcr_cassettes/discovery_auth.yml
+- spec/fixtures/vcr_cassettes/discovery_auth_wrong_creds.yml
+- spec/fixtures/vcr_cassettes/person_by_id.yml
+- spec/fixtures/vcr_cassettes/person_with_relationship.yml
 - spec/spec_helper.rb
+- spec/url_template_spec.rb
 - workspace/notes/APIDesign.txt
 - workspace/notes/discovery_links.txt
+- workspace/notes/errors.txt
+- workspace/notes/gem_design.txt
 - workspace/notes/goals.txt
-homepage: http://github.com/jimmyz/familysearch-rb
-licenses:
-- MIT
+homepage: https://github.com/jimmyz/familysearch-rb
+licenses: []
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -227,9 +190,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 177874433212010284
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -238,8 +198,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: A gem for the FamilySearch Platform.
-test_files: []
+test_files:
+- spec/client_spec.rb
+- spec/familysearch_spec.rb
+- spec/fixtures/vcr_cassettes/current_user_person_read.yml
+- spec/fixtures/vcr_cassettes/discovery.yml
+- spec/fixtures/vcr_cassettes/discovery_auth.yml
+- spec/fixtures/vcr_cassettes/discovery_auth_wrong_creds.yml
+- spec/fixtures/vcr_cassettes/person_by_id.yml
+- spec/fixtures/vcr_cassettes/person_with_relationship.yml
+- spec/spec_helper.rb
+- spec/url_template_spec.rb

data/VERSION

@@ -1 +0,0 @@
-0.2.0