jimmyz-fs-communicator 0.1.0

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 1
+:patch: 0
+:major: 0

data/lib/assets/entrust-ca.crt

@@ -0,0 +1,104 @@
+##
+## $Id: ca-bundle.crt,v 1.2 2003/03/24 11:06:57 bagder Exp $
+##
+##  ca-bundle.crt -- Bundle of CA Root Certificates
+##  Last Modified: Thu Mar  2 09:32:46 CET 2000
+##
+##  This is a bundle of X.509 certificates of public
+##  Certificate Authorities (CA). These were automatically
+##  extracted from Netscape Communicator 4.72's certificate database
+##  (the file `cert7.db'). It contains the certificates in both
+##  plain text and PEM format and therefore can be directly used
+##  with an Apache+mod_ssl webserver for SSL client authentication.
+##  Just configure this file as the SSLCACertificateFile.
+##
+##  (SKIPME)
+##
+
+
+Entrust.net Secure Server CA
+============================
+MD5 Fingerprint: DF:F2:80:73:CC:F1:E6:61:73:FC:F5:42:E9:C5:7C:EE
+PEM Data:
+-----BEGIN CERTIFICATE-----
+MIIE2DCCBEGgAwIBAgIEN0rSQzANBgkqhkiG9w0BAQUFADCBwzELMAkGA1UEBhMC
+VVMxFDASBgNVBAoTC0VudHJ1c3QubmV0MTswOQYDVQQLEzJ3d3cuZW50cnVzdC5u
+ZXQvQ1BTIGluY29ycC4gYnkgcmVmLiAobGltaXRzIGxpYWIuKTElMCMGA1UECxMc
+KGMpIDE5OTkgRW50cnVzdC5uZXQgTGltaXRlZDE6MDgGA1UEAxMxRW50cnVzdC5u
+ZXQgU2VjdXJlIFNlcnZlciBDZXJ0aWZpY2F0aW9uIEF1dGhvcml0eTAeFw05OTA1
+MjUxNjA5NDBaFw0xOTA1MjUxNjM5NDBaMIHDMQswCQYDVQQGEwJVUzEUMBIGA1UE
+ChMLRW50cnVzdC5uZXQxOzA5BgNVBAsTMnd3dy5lbnRydXN0Lm5ldC9DUFMgaW5j
+b3JwLiBieSByZWYuIChsaW1pdHMgbGlhYi4pMSUwIwYDVQQLExwoYykgMTk5OSBF
+bnRydXN0Lm5ldCBMaW1pdGVkMTowOAYDVQQDEzFFbnRydXN0Lm5ldCBTZWN1cmUg
+U2VydmVyIENlcnRpZmljYXRpb24gQXV0aG9yaXR5MIGdMA0GCSqGSIb3DQEBAQUA
+A4GLADCBhwKBgQDNKIM0VBuJ8w+vN5Ex/68xYMmo6LIQaO2f55M28Qpku0f1BBc/
+I0dNxScZgSYMVHINiC3ZH5oSn7yzcdOAGT9HZnuMNSjSuQrfJNqc1lB5gXpa0zf3
+wkrYKZImZNHkmGw6AIr1NJtl+O3jEP/9uElY3KDegjlrgbEWGWG5VLbmQwIBA6OC
+AdcwggHTMBEGCWCGSAGG+EIBAQQEAwIABzCCARkGA1UdHwSCARAwggEMMIHeoIHb
+oIHYpIHVMIHSMQswCQYDVQQGEwJVUzEUMBIGA1UEChMLRW50cnVzdC5uZXQxOzA5
+BgNVBAsTMnd3dy5lbnRydXN0Lm5ldC9DUFMgaW5jb3JwLiBieSByZWYuIChsaW1p
+dHMgbGlhYi4pMSUwIwYDVQQLExwoYykgMTk5OSBFbnRydXN0Lm5ldCBMaW1pdGVk
+MTowOAYDVQQDEzFFbnRydXN0Lm5ldCBTZWN1cmUgU2VydmVyIENlcnRpZmljYXRp
+b24gQXV0aG9yaXR5MQ0wCwYDVQQDEwRDUkwxMCmgJ6AlhiNodHRwOi8vd3d3LmVu
+dHJ1c3QubmV0L0NSTC9uZXQxLmNybDArBgNVHRAEJDAigA8xOTk5MDUyNTE2MDk0
+MFqBDzIwMTkwNTI1MTYwOTQwWjALBgNVHQ8EBAMCAQYwHwYDVR0jBBgwFoAU8Bdi
+E1U9s/8KAGv7UISX8+1i0BowHQYDVR0OBBYEFPAXYhNVPbP/CgBr+1CEl/PtYtAa
+MAwGA1UdEwQFMAMBAf8wGQYJKoZIhvZ9B0EABAwwChsEVjQuMAMCBJAwDQYJKoZI
+hvcNAQEFBQADgYEAkNwwAvpkdMKnCqV8IY00F6j7Rw7/JXyNEwr75Ji174z4xRAN
+95K+8cPV1ZVqBLssziY2ZcgxxufuP+NXdYR6Ee9GTxj005i7qIcyunL2POI9n9cd
+2cNgQ4xYDiKWL2KjLB+6rQXvqzJ4h6BUcxm1XAX5Uj5tLUUL9wqT6u0G+bI=
+-----END CERTIFICATE-----
+Certificate Ingredients:
+    Data:
+        Version: 3 (0x2)
+        Serial Number: 927650371 (0x374ad243)
+        Signature Algorithm: sha1WithRSAEncryption
+        Issuer: C=US, O=Entrust.net, OU=www.entrust.net/CPS incorp. by ref. (limits liab.), OU=(c) 1999 Entrust.net Limited, CN=Entrust.net Secure Server Certification Authority
+        Validity
+            Not Before: May 25 16:09:40 1999 GMT
+            Not After : May 25 16:39:40 2019 GMT
+        Subject: C=US, O=Entrust.net, OU=www.entrust.net/CPS incorp. by ref. (limits liab.), OU=(c) 1999 Entrust.net Limited, CN=Entrust.net Secure Server Certification Authority
+        Subject Public Key Info:
+            Public Key Algorithm: rsaEncryption
+            RSA Public Key: (1024 bit)
+                Modulus (1024 bit):
+                    00:cd:28:83:34:54:1b:89:f3:0f:af:37:91:31:ff:
+                    af:31:60:c9:a8:e8:b2:10:68:ed:9f:e7:93:36:f1:
+                    0a:64:bb:47:f5:04:17:3f:23:47:4d:c5:27:19:81:
+                    26:0c:54:72:0d:88:2d:d9:1f:9a:12:9f:bc:b3:71:
+                    d3:80:19:3f:47:66:7b:8c:35:28:d2:b9:0a:df:24:
+                    da:9c:d6:50:79:81:7a:5a:d3:37:f7:c2:4a:d8:29:
+                    92:26:64:d1:e4:98:6c:3a:00:8a:f5:34:9b:65:f8:
+                    ed:e3:10:ff:fd:b8:49:58:dc:a0:de:82:39:6b:81:
+                    b1:16:19:61:b9:54:b6:e6:43
+                Exponent: 3 (0x3)
+        X509v3 extensions:
+            Netscape Cert Type: 
+                SSL CA, S/MIME CA, Object Signing CA
+            X509v3 CRL Distribution Points: 
+                DirName:/C=US/O=Entrust.net/OU=www.entrust.net/CPS incorp. by ref. (limits liab.)/OU=(c) 1999 Entrust.net Limited/CN=Entrust.net Secure Server Certification Authority/CN=CRL1
+                URI:http://www.entrust.net/CRL/net1.crl
+
+            X509v3 Private Key Usage Period: 
+                Not Before: May 25 16:09:40 1999 GMT, Not After: May 25 16:09:40 2019 GMT
+            X509v3 Key Usage: 
+                Certificate Sign, CRL Sign
+            X509v3 Authority Key Identifier: 
+                keyid:F0:17:62:13:55:3D:B3:FF:0A:00:6B:FB:50:84:97:F3:ED:62:D0:1A
+
+            X509v3 Subject Key Identifier: 
+                F0:17:62:13:55:3D:B3:FF:0A:00:6B:FB:50:84:97:F3:ED:62:D0:1A
+            X509v3 Basic Constraints: 
+                CA:TRUE
+            1.2.840.113533.7.65.0: 
+                0
+..V4.0....
+    Signature Algorithm: sha1WithRSAEncryption
+        90:dc:30:02:fa:64:74:c2:a7:0a:a5:7c:21:8d:34:17:a8:fb:
+        47:0e:ff:25:7c:8d:13:0a:fb:e4:98:b5:ef:8c:f8:c5:10:0d:
+        f7:92:be:f1:c3:d5:d5:95:6a:04:bb:2c:ce:26:36:65:c8:31:
+        c6:e7:ee:3f:e3:57:75:84:7a:11:ef:46:4f:18:f4:d3:98:bb:
+        a8:87:32:ba:72:f6:3c:e2:3d:9f:d7:1d:d9:c3:60:43:8c:58:
+        0e:22:96:2f:62:a3:2c:1f:ba:ad:05:ef:ab:32:78:87:a0:54:
+        73:19:b5:5c:05:f9:52:3e:6d:2d:45:0b:f7:0a:93:ea:ed:06:
+        f9:b2

data/lib/fs_communicator.rb

@@ -0,0 +1,66 @@
+require 'net/https'
+require 'uri'
+
+class FsCommunicator
+  attr_accessor :domain, :key, :user_agent, :session
+  
+  def initialize(options = {})
+    # merge default options with options hash
+    o = {
+      :domain => 'http://www.dev.usys.org',
+      :key => '',
+      :user_agent => 'FsCommunicator/0.1 (Ruby)',
+      :session => nil
+    }.merge(options)
+    @domain = o[:domain]
+    @key = o[:key]
+    @user_agent = o[:user_agent]
+    @session = o[:session]
+  end
+  
+  def get(url,credentials = {})
+    uri = URI.parse(self.domain+url)
+    full_url = set_extra_params(uri,credentials)
+    request = Net::HTTP::Get.new(full_url)
+    if credentials[:username] && credentials[:password]
+      request.basic_auth credentials[:username], credentials[:password]
+      request['User-Agent'] = self.user_agent
+    end
+    http = Net::HTTP.new(uri.host, uri.port)
+    if uri.scheme == 'https'
+      http.use_ssl = true 
+      http.ca_file = File.join File.dirname(__FILE__), 'assets','entrust-ca.crt'
+      http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+    end
+    res = http.start do |ht|
+      ht.request(request)
+    end
+  end
+  
+  private
+  def set_extra_params(uri,credentials)
+    if credentials[:username] && credentials[:password]
+      sessionized_url = add_key(uri)
+    else
+      sessionized_url = add_session(uri)
+    end
+  end
+  
+  def add_session(uri)
+    if uri.query
+      uri.query << '&sessionId=' + self.session
+    else
+      uri.query = 'sessionId=' + self.session
+    end
+    uri.request_uri
+  end
+  
+  def add_key(uri)
+    if uri.query
+      uri.query << '&key=' + self.key
+    else
+      uri.query = 'key=' + self.key
+    end
+    uri.request_uri
+  end
+end

data/spec/fs_communicator_spec.rb

@@ -0,0 +1,117 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+module HttpCommunicatorHelper
+  
+  def stub_net_objects
+    @request = mock("Net::HTTP::Get")
+    # @request.stub!(:[]=)
+    @http = mock("Net::HTTP")
+    Net::HTTP.stub!(:new).and_return(@http)
+    Net::HTTP::Get.stub!(:new).and_return(@request)
+    @http.stub!(:use_ssl=)
+    @http.stub!(:ca_file=)
+    @http.stub!(:verify_mode=)
+    @http.stub!(:start)
+  end
+  
+end
+
+describe FsCommunicator do
+  include HttpCommunicatorHelper
+  describe "initializing" do
+    it "should accept a hash of options" do
+      lambda {
+        com = FsCommunicator.new :domain => 'https://api.familysearch.org', :key => '1111-1111', :user_agent => "FsCommunicator/0.1"
+      }.should_not raise_error
+    end
+    
+    it "should set defaults to the Reference System" do
+      com = FsCommunicator.new
+      com.domain.should == 'http://www.dev.usys.org'
+      com.key.should == ''
+      com.user_agent.should == 'FsCommunicator/0.1 (Ruby)'
+    end
+    
+    it "should set the domain, key, and user_agent to options hash" do
+      options = {
+        :domain => 'https://api.familysearch.org', 
+        :key => '1111-1111', 
+        :user_agent => "RSpecTest/0.1",
+        :session => 'SESSID'
+      }
+      com = FsCommunicator.new options
+      com.domain.should == options[:domain]
+      com.key.should == options[:key]
+      com.user_agent.should == options[:user_agent]
+      com.session.should == options[:session]
+    end
+  end
+  
+  describe "GET on a URL" do
+    before(:each) do
+      options = {
+        :domain => 'https://api.familysearch.org', 
+        :key => '1111-1111', 
+        :user_agent => "FsCommunicator/0.1",
+        :session => 'SESSID'
+      }
+      @com = FsCommunicator.new options
+      stub_net_objects
+      @url = '/familytree/v1/person/KWQS-BBQ'
+      @session_url = @url + "?sessionId=#{@com.session}"
+    end
+    
+    def do_get(url, credentials = {})
+      @com.get(url, credentials)
+    end
+    
+    it "should initialize a Net::HTTP object to make the request" do
+      Net::HTTP.should_receive(:new).with('api.familysearch.org',443).and_return(@http)
+      do_get(@url)
+    end
+    
+    it "should create a GET request with url containing a session" do
+      Net::HTTP::Get.should_receive(:new).with(@session_url).and_return(@request)
+      do_get(@url)
+    end
+    
+    it "should tack a sessionId as an additional parameter if params already set" do
+      url = "/familytree/v1/person/KWQS-BBQ?view=summary"
+      Net::HTTP::Get.should_receive(:new).with(url+"&sessionId=#{@com.session}").and_return(@request)
+      do_get(url)
+    end
+    
+    it "should set the http object to use ssl if https" do
+      @http.should_receive(:use_ssl=).with(true)
+      do_get(@url)
+    end
+    
+    it "should not set the http object to use ssl if no http" do
+      @com.domain = 'http://www.dev.usys.org'
+      @http.should_not_receive(:use_ssl=)
+      do_get(@url)
+    end
+    
+    it "should set the ca file to the entrust certificate (for FamilySearch systems)" do
+      @http.should_receive(:ca_file=).with(File.join(File.dirname(__FILE__),'..','lib','assets','entrust-ca.crt'))
+      do_get(@url)
+    end
+    
+    it "should set the basic_authentication if the credentials passed as parameters" do
+      @request.should_receive(:basic_auth).with('user','pass')
+      @request.should_receive(:[]=).with('User-Agent',@com.user_agent)
+      Net::HTTP::Get.should_receive(:new).with(@url+"?key=#{@com.key}").and_return(@request)
+      do_get(@url,:username => 'user',:password => 'pass')
+    end
+    
+    it "should make the request" do
+      block = lambda{ |ht|
+        ht.request('something')
+      }
+      @http.should_receive(:start)
+      do_get(@url)
+    end
+    
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'spec'
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'fs_communicator')
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification 
+name: jimmyz-fs-communicator
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jimmy Zimmerman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-02 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: TODO
+email: jimmy.zimmerman@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- VERSION.yml
+- lib/assets
+- lib/assets/entrust-ca.crt
+- lib/fs_communicator.rb
+- spec/fs_communicator_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/jimmyz/fs-communicator
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: TODO
+test_files: []
+