familysearch 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rvmrc

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-p362@familysearch"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.17.7 ()" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | GREP_OPTIONS= \grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | GREP_OPTIONS= \grep -vE '^Using|Your bundle is complete'
+# fi

data/Gemfile

@@ -0,0 +1,20 @@
+source "https://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+gem 'faraday', "~> 0.8.4"
+gem 'faraday_middleware', "~> 0.9.0"
+gem 'multi_json', "~> 1.5.0"
+gem "hashie", "~> 2.0.2"
+gem "rash", "~> 0.4.0"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development, :test do
+  gem "rspec", "~> 2.13.0"
+  gem "shoulda", "~> 3.3.2"
+  gem "bundler", "~> 1.2.3"
+  gem "jeweler", "~> 1.8.4"
+  gem "vcr", "~> 2.4.0"
+  gem "webmock", "~> 1.10.0"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Jimmy Zimmerman
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# familysearch gem
+
+## Installation
+
+You can install it from the commandline.
+
+    gem install familysearch
+
+Or add it to a Gemfile for use with Bundler
+
+    gem "familysearch", "~> 0.1.0 "
+
+
+## Basic Usage
+
+Here's how to use it
+
+    require 'rubygems'
+    require 'familysearch'
+    
+    # Instantiate a Client object
+    client = FamilySearch::Client.new :environment => :sandbox, :key => 'your-dev-key-here'
+    
+    # Load the Discovery resource
+    client.discover!
+    
+    # For testing, you can use basic auth to get a session, 
+    # Don't do this in your production web app. Use OAuth 2.0
+    client.basic_auth! 'api-user-1241', '1782'
+    
+    me = client.get(client.discovery.links.current_user_person.href).body
+
+More documentation coming soon...
+
+## Copyright
+
+Copyright (c) 2013 Jimmy Zimmerman. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,40 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "familysearch"
+  gem.homepage = "http://github.com/jimmyz/familysearch-rb"
+  gem.license = "MIT"
+  gem.summary = %Q{A gem for the FamilySearch Platform.}
+  gem.description = %Q{A gem for the FamilySearch Platform. Documentation for the FamilySearch Platform can be found at https://}
+  gem.email = "jimmy.zimmerman@gmail.com"
+  gem.authors = ["Jimmy Zimmerman"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "familysearch #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/familysearch.gemspec

@@ -0,0 +1,87 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "familysearch"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jimmy Zimmerman"]
+  s.date = "2013-03-18"
+  s.description = "A gem for the FamilySearch Platform. Documentation for the FamilySearch Platform can be found at https://"
+  s.email = "jimmy.zimmerman@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.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"
+  ]
+  s.homepage = "http://github.com/jimmyz/familysearch-rb"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "A gem for the FamilySearch Platform."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<faraday>, ["~> 0.8.4"])
+      s.add_runtime_dependency(%q<faraday_middleware>, ["~> 0.9.0"])
+      s.add_runtime_dependency(%q<multi_json>, ["~> 1.5.0"])
+      s.add_runtime_dependency(%q<hashie>, ["~> 2.0.2"])
+      s.add_runtime_dependency(%q<rash>, ["~> 0.4.0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.13.0"])
+      s.add_development_dependency(%q<shoulda>, ["~> 3.3.2"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.2.3"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_development_dependency(%q<vcr>, ["~> 2.4.0"])
+      s.add_development_dependency(%q<webmock>, ["~> 1.10.0"])
+    else
+      s.add_dependency(%q<faraday>, ["~> 0.8.4"])
+      s.add_dependency(%q<faraday_middleware>, ["~> 0.9.0"])
+      s.add_dependency(%q<multi_json>, ["~> 1.5.0"])
+      s.add_dependency(%q<hashie>, ["~> 2.0.2"])
+      s.add_dependency(%q<rash>, ["~> 0.4.0"])
+      s.add_dependency(%q<rspec>, ["~> 2.13.0"])
+      s.add_dependency(%q<shoulda>, ["~> 3.3.2"])
+      s.add_dependency(%q<bundler>, ["~> 1.2.3"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_dependency(%q<vcr>, ["~> 2.4.0"])
+      s.add_dependency(%q<webmock>, ["~> 1.10.0"])
+    end
+  else
+    s.add_dependency(%q<faraday>, ["~> 0.8.4"])
+    s.add_dependency(%q<faraday_middleware>, ["~> 0.9.0"])
+    s.add_dependency(%q<multi_json>, ["~> 1.5.0"])
+    s.add_dependency(%q<hashie>, ["~> 2.0.2"])
+    s.add_dependency(%q<rash>, ["~> 0.4.0"])
+    s.add_dependency(%q<rspec>, ["~> 2.13.0"])
+    s.add_dependency(%q<shoulda>, ["~> 3.3.2"])
+    s.add_dependency(%q<bundler>, ["~> 1.2.3"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    s.add_dependency(%q<vcr>, ["~> 2.4.0"])
+    s.add_dependency(%q<webmock>, ["~> 1.10.0"])
+  end
+end
+

data/lib/familysearch.rb

@@ -0,0 +1 @@
+require 'familysearch/client'

data/lib/familysearch/client.rb

@@ -0,0 +1,65 @@
+require 'hashie'
+require 'faraday'
+require 'faraday_middleware'
+require 'forwardable'
+
+module FamilySearch
+  class Client
+    ENV_CONF = {
+      :production => {
+        :base_url => 'https://familysearch.org',
+        :discovery_path => '/.well-known/app-meta'
+      },
+      :staging => {
+        :base_url => 'https://stage.familysearch.org',
+        :discovery_path => '/.well-known/app-meta'
+      },
+      :sandbox => {
+        :base_url => 'https://sandbox.familysearch.org',
+        :discovery_path => '/.well-known/app-meta'
+      }
+    }
+    
+    attr_accessor :access_token, :logger, :key, :environment, :discovery, :agent
+    attr_reader :base_url
+    
+    extend Forwardable
+    def_delegators :@agent, :get, :put, :post, :delete, :head, :options
+    
+    def initialize(options = {})
+      @access_token = options[:access_token] # if options[:access_token]
+      @logger = options[:logger]
+      @key = options[:key]
+      @environment = options[:environment] || :sandbox
+      @base_url = options[:base_url] || ENV_CONF[@environment][:base_url]
+      @agent = Faraday.new(@base_url) do |faraday|
+        faraday.response :logger, options[:logger] if options[:logger]
+        faraday.response :rashify
+        faraday.response :json
+        faraday.response :follow_redirects, :limit => 3, :standards_compliant => true
+        faraday.headers['Accept'] = 'application/x-fs-v1+json'
+        faraday.authorization('Bearer',@access_token) if @access_token
+        faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+      end
+    end
+        
+    def discover!
+      @discovery ||= get_discovery
+    end
+    
+    def basic_auth!(username,password,key=nil)
+      self.discover!
+      @key ||= key if key
+      @agent.basic_auth username, password
+      response = @agent.get @discovery.links.fs_identity_v2_login.href, :dataFormat => 'application/json', :key => @key
+      @access_token = response.body.session.id
+      @agent.authorization('Bearer',@access_token)
+    end
+    
+    private
+    def get_discovery
+      result = @agent.get(ENV_CONF[@environment][:discovery_path])
+      result.body
+    end    
+  end
+end

data/spec/client_spec.rb

@@ -0,0 +1,132 @@
+require 'spec_helper'
+require 'familysearch/client'
+
+describe FamilySearch::Client do
+  
+  describe "instantiating" do
+    
+    it "should accept a hash of config options" do
+      client = FamilySearch::Client.new {}
+    end
+    
+    it "should accept a logger option" do
+      require 'logger'
+      logger = Logger.new STDOUT
+      client = FamilySearch::Client.new :logger => logger
+      client.logger.should == logger
+    end
+    
+    it "should accept an access_token" do
+      token = 'access-token'
+      client = FamilySearch::Client.new :access_token => token
+      client.access_token.should == token
+    end
+    
+    it "should only set the access_token if passed in the options" do
+      client = FamilySearch::Client.new
+      client.access_token.should be(nil)
+      client.agent.headers['Authorization'].should be(nil)
+    end
+    
+    it "should accept a developer key" do
+      key = 'Jimmyz-cool-dev-key'
+      client = FamilySearch::Client.new :key => key
+      client.key.should == key
+    end
+    
+    it "should accept an environment variable (:production)" do
+      client = FamilySearch::Client.new :environment => :production
+      client.environment.should == :production
+      client.base_url.should == 'https://familysearch.org'
+    end
+    
+    it "should accept an environment variable (:staging)" do
+      client = FamilySearch::Client.new :environment => :staging
+      client.environment.should == :staging
+      client.base_url.should == 'https://stage.familysearch.org'
+    end
+    
+    it "should accept an environment variable (:sandbox)" do
+      client = FamilySearch::Client.new :environment => :sandbox
+      client.environment.should == :sandbox
+      client.base_url.should == 'https://sandbox.familysearch.org'
+    end
+    
+    it "should default to sandbox environment" do
+      client = FamilySearch::Client.new
+      client.environment.should == :sandbox
+      client.base_url.should == 'https://sandbox.familysearch.org'
+    end
+    
+    it "should allow the overriding of the base_url" do
+      client = FamilySearch::Client.new :base_url => 'http://localhost:8080'
+      client.base_url.should == 'http://localhost:8080'
+    end
+    
+    it "should instantiate a Faraday instance accessible via .agent" do
+      client = FamilySearch::Client.new
+      client.agent.is_a? Faraday
+    end
+  end
+    
+  describe "get" do
+    def client
+      @client = FamilySearch::Client.new
+    end
+    
+    it "should accept a path and return an object" do
+      VCR.use_cassette('discovery') do
+        obj = client.get 'https://sandbox.familysearch.org/.well-known/app-meta'
+        obj.is_a? Object
+      end
+    end
+    
+  end
+  
+  describe "discover!" do
+    def client
+      @client ||= FamilySearch::Client.new
+    end
+    
+    it "should make a request " do
+      VCR.use_cassette('discovery') do
+        client.discover!
+        client.discovery.links.fs_identity_v2_login.href.should == 'https://sandbox.familysearch.org/identity/v2/login'
+        client.discovery['links']['fs-identity-v2-login']['href'].should == 'https://sandbox.familysearch.org/identity/v2/login'
+      end
+    end
+  end
+  
+  describe "basic_auth!" do
+    def client()
+      @client ||= FamilySearch::Client.new(:key => 'WCQY-7J1Q-GKVV-7DNM-SQ5M-9Q5H-JX3H-CMJK' )
+    end
+    
+    it "should call discover! if it hasn't already" do
+      VCR.use_cassette('discovery_auth') do
+        client.should_receive(:discover!).and_call_original
+        client.basic_auth! 'api-user-1241', '1782'
+      end
+    end
+    
+    it "should accept a username and password" do
+      VCR.use_cassette('discovery_auth') do
+        client.basic_auth! 'api-user-1241', '1782'
+      end
+    end
+    
+    it "should make a call to the fs-identity-v2-login with credentials and set the access_token" do
+      VCR.use_cassette('discovery_auth') do
+        client.basic_auth! 'api-user-1241', '1782'
+        client.access_token.should == 'USYS8B6B487A084AA3B3C027451E23D20D5E_nbci-045-034.d.usys.fsglobal.net'
+      end
+    end
+    
+    it "should set the agent's authorization to Bearer with the access token" do
+      VCR.use_cassette('discovery_auth') do
+        client.agent.should_receive(:authorization).with('Bearer','USYS8B6B487A084AA3B3C027451E23D20D5E_nbci-045-034.d.usys.fsglobal.net').and_call_original
+        client.basic_auth! 'api-user-1241', '1782'
+      end
+    end
+  end
+end