ruby-fs-stack 0.2.6 → 0.3.0

data/README.rdoc

@@ -32,10 +32,17 @@ or for the pure Ruby implementation
 
   require 'rubygems'
   require 'ruby-fs-stack'
-
+  
+  # Optionally, you can pass a logger to the communicator
+  # the logger can be the standard Ruby Logger or any logger 
+  # that responds to :info or :debug like the Rails logger
+  require 'logger'
+  logger = Logger.new('fs_stack.log')
+  
   communicator = FsCommunicator.new :domain => 'http://www.dev.usys.org', # or 'https://api.familysearch.org'
                                     :key => 'DEVELOPER-KEY',
-                                    :user_agent => 'Ruby-Fs-Stack/v.1 (JimmyZimmerman) FsCommunicator/0.1 (Ruby)'
+                                    :user_agent => 'Ruby-Fs-Stack/v.1 (JimmyZimmerman) FsCommunicator/0.1 (Ruby)',
+                                    :logger => logger
 
   communicator.identity_v1.authenticate :username => 'USERNAME', :password => 'PASSWORD' #=> true
   communicator.session #=> "USYSE4EF197..."

data/VERSION

@@ -1 +1 @@
-0.2.6
+0.3.0

data/lib/ruby-fs-stack/fs_communicator.rb

@@ -3,7 +3,7 @@ require 'net/https'
 require 'uri'
 
 class FsCommunicator
-  attr_accessor :domain, :key, :user_agent, :session, :handle_throttling
+  attr_accessor :domain, :key, :user_agent, :session, :handle_throttling, :logger
   include RubyFsStack
   # ====Params
   # <tt>options</tt> - a hash with the following options
@@ -17,6 +17,10 @@ class FsCommunicator
   #   You will likely want this turned off when running this library from Rails or any other
   #   system that is single-threaded so as to not sleep the entire process until throttling 
   #   is successful.
+  # * :logger - (optional) if a logger is assigned to the communicator, all get requests and 
+  #   responses will be logged. The request and response ("GET /path" and "200 OK") will be
+  #   logged at the info level. Headers and request/response bodies will be logged at the debug
+  #   level.
   def initialize(options = {})
     # merge default options with options hash
     o = {
@@ -24,13 +28,15 @@ class FsCommunicator
       :key => '',
       :user_agent => 'FsCommunicator/0.1 (Ruby)', # should be overridden by options user_agent
       :session => nil,
-      :handle_throttling => false
+      :handle_throttling => false,
+      :logger => nil
     }.merge(options)
     @domain = o[:domain]
     @key = o[:key]
     @user_agent = o[:user_agent]
     @session = o[:session]
     @handle_throttling = o[:handle_throttling]
+    @logger = o[:logger]
   end
   
   def post(url,payload)
@@ -40,15 +46,16 @@ class FsCommunicator
     request.body = payload
     request['Content-Type'] = "application/json"
     request['User-Agent'] = self.user_agent
+    
     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
+    set_ssl(http) if uri.scheme == 'https'
+    
+    log_request('POST',full_url,request) if logger
     res = http.start do |ht|
       ht.request(request)
     end
+    log_response(res) if logger
+    
     if res.code == '503' && @handle_throttling
       sleep 15
       res = post(url,payload)
@@ -66,15 +73,16 @@ class FsCommunicator
     if credentials[:username] && credentials[:password]
       request.basic_auth credentials[:username], credentials[:password]
     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
+    set_ssl(http) if uri.scheme == 'https'
+    
+    log_request('GET',full_url,request) if logger
     res = http.start do |ht|
       ht.request(request)
     end
+    log_response(res) if logger
+    
     if res.code == '503' && @handle_throttling
       sleep 15
       res = get(url,credentials)
@@ -131,6 +139,28 @@ class FsCommunicator
     raise exception
   end
   
+  def log_request(method,url,request)
+    logger.info "#{method} #{url}"
+    request.each_header do |k,v|
+      logger.debug "#{k}: #{v}"
+    end
+    logger.debug request.body unless request.body.nil?
+  end
+  
+  def log_response(response)
+    logger.info "#{response.code} #{response.message}"
+    response.each_header do |k,v|
+      logger.debug "#{k}: #{v}"
+    end
+    logger.debug response.body
+  end
+  
+  def set_ssl(http)
+    http.use_ssl = true 
+    http.ca_file = File.join File.dirname(__FILE__), 'assets','entrust-ca.crt'
+    http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+  end
+  
   def set_extra_params(uri,credentials = {})
     if credentials[:username] && credentials[:password]
       sessionized_url = add_key(uri)

data/ruby-fs-stack.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ruby-fs-stack}
-  s.version = "0.2.6"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jimmy Zimmerman"]
-  s.date = %q{2009-12-17}
+  s.date = %q{2009-12-18}
   s.description = %q{A library that enables you to read and update information with the new.familysearch.org API.}
   s.email = %q{jimmy.zimmerman@gmail.com}
   s.extra_rdoc_files = [
@@ -54,6 +54,7 @@ Gem::Specification.new do |s|
      "spec/familytree_v2/match_results_spec.rb",
      "spec/familytree_v2/person_spec.rb",
      "spec/familytree_v2/search_results_spec.rb",
+     "spec/fixtures/fakeweb_response.txt",
      "spec/fs_utils_spec.rb",
      "spec/identity_v1/identity_spec.rb",
      "spec/identity_v1/json/login.js",

data/spec/communicator_spec.rb

@@ -1,9 +1,18 @@
 require File.dirname(__FILE__) + '/spec_helper'
 require 'ruby-fs-stack/fs_communicator'
 require 'fakeweb'
+require 'logger'
 
 describe FsCommunicator do
   include HttpCommunicatorHelper
+  
+  def fake_web(path,status,message,body = '')
+    FakeWeb.register_uri(:get, "https://api.familysearch.org#{path}?sessionId=SESSID&dataFormat=application/json", :body => body,
+                        :status => [status, message])
+    FakeWeb.register_uri(:post, "https://api.familysearch.org#{path}?sessionId=SESSID&dataFormat=application/json", :body => body,
+                        :status => [status, message])
+  end
+  
   describe "initializing" do
     it "should accept a hash of options" do
       lambda {
@@ -226,12 +235,6 @@ describe FsCommunicator do
   # 501 NotImplemented
   # 503 ServiceUnavailable
   describe "raising exceptions" do
-    def fake_web(path,status,message)
-      FakeWeb.register_uri(:get, "https://api.familysearch.org#{path}?sessionId=SESSID&dataFormat=application/json", :body => "",
-                          :status => [status, message])
-      FakeWeb.register_uri(:post, "https://api.familysearch.org#{path}?sessionId=SESSID&dataFormat=application/json", :body => "",
-                          :status => [status, message])
-    end
     
     before(:each) do
       options = {
@@ -376,4 +379,71 @@ describe FsCommunicator do
     end
   end
   
+  describe "logging" do
+    
+    before(:each) do
+      @logger = Logger.new(STDOUT)
+      options = {
+        :domain => 'https://api.familysearch.org', 
+        :key => '1111-1111', 
+        :user_agent => "FsCommunicator/0.1",
+        :session => 'SESSID',
+        :logger => @logger
+      }
+      @com = FsCommunicator.new options
+    end
+    
+    it "should accept an optional logger object when initializing" do
+      @com.logger.should == @logger
+    end
+    
+    it "should be able to assign a logger after initialization" do
+      @com.logger = @logger
+      @com.logger.should == @logger
+    end
+    
+    it "should log each GET request URL and headers" do
+      response = File.join(File.dirname(__FILE__),'fixtures','fakeweb_response.txt')
+      FakeWeb.register_uri(:get, "https://api.familysearch.org/familytree/v2/person/KWQS-BBQ?sessionId=SESSID&dataFormat=application/json", 
+                          :response => response)
+      @com.logger.should_receive(:info).with(/GET \/familytree\/v2\/person/)
+      @com.logger.should_receive(:debug).with("accept: */*")
+      @com.logger.should_receive(:debug).with("user-agent: FsCommunicator/0.1")
+      @com.logger.should_receive(:info).with("200 OK")
+      @com.logger.should_receive(:debug).with("app_svr_id: 9.32")
+      @com.logger.should_receive(:debug).with("expires: Thu, 01 Jan 1970 00:00:00 GMT")
+      @com.logger.should_receive(:debug).with("content-language: en-US")
+      @com.logger.should_receive(:debug).with("date: Thu, 17 Dec 2009 23:58:48 GMT")
+      @com.logger.should_receive(:debug).with("content-length: 779")
+      @com.logger.should_receive(:debug).with("x-processing-time: 152")
+      @com.logger.should_receive(:debug).with("cache-control: no-store, no-cache")      
+      @com.logger.should_receive(:debug).with("content-type: application/json;charset=utf-8")
+      @com.logger.should_receive(:debug).with(/\{"persons":/)
+      @com.get('/familytree/v2/person/KWQS-BBQ')
+    end
+    
+    it "should log each POST request URL and headers" do
+      response = File.join(File.dirname(__FILE__),'fixtures','fakeweb_response.txt')
+      FakeWeb.register_uri(:post, "https://api.familysearch.org/familytree/v2/person/KWQS-BBQ?sessionId=SESSID&dataFormat=application/json", 
+                          :response => response)
+      @com.logger.should_receive(:info).with(/POST \/familytree\/v2\/person/)
+      @com.logger.should_receive(:debug).with("accept: */*")
+      @com.logger.should_receive(:debug).with("user-agent: FsCommunicator/0.1")
+      @com.logger.should_receive(:debug).with("content-type: application/json")
+      @com.logger.should_receive(:debug).with("CONTENT")
+      @com.logger.should_receive(:info).with("200 OK")
+      @com.logger.should_receive(:debug).with("app_svr_id: 9.32")
+      @com.logger.should_receive(:debug).with("expires: Thu, 01 Jan 1970 00:00:00 GMT")
+      @com.logger.should_receive(:debug).with("content-language: en-US")
+      @com.logger.should_receive(:debug).with("date: Thu, 17 Dec 2009 23:58:48 GMT")
+      @com.logger.should_receive(:debug).with("content-length: 779")
+      @com.logger.should_receive(:debug).with("x-processing-time: 152")
+      @com.logger.should_receive(:debug).with("cache-control: no-store, no-cache")      
+      @com.logger.should_receive(:debug).with("content-type: application/json;charset=utf-8")
+      @com.logger.should_receive(:debug).with(/\{"persons":/)
+      @com.post('/familytree/v2/person/KWQS-BBQ','CONTENT')
+    end
+    
+  end
+  
 end

data/spec/fixtures/fakeweb_response.txt

@@ -0,0 +1,12 @@
+HTTP/1.1 200 OK
+Content-Type: application/json;charset=utf-8
+Expires: Thu, 01 Jan 1970 00:00:00 GMT
+Cache-Control: no-store
+Cache-Control: no-cache
+X-PROCESSING-TIME: 152
+Date: Thu, 17 Dec 2009 23:58:48 GMT
+Content-Language: en-US
+APP_SVR_ID: 9.32
+Content-Length: 779
+
+{"persons":[{"id":"KW3B-N9X","version":"8590000133","assertions":{"events":[{"value":{"type":"Birth","date":{"selected":false,"normalized":"11 March 1950","original":"11 Mar 1950","astro":{"earliest":"2433352","latest":"2433352"}},"place":{"selected":false,"normalized":{"value":"Utah, United States","id":"27","version":"3.5.0"},"original":"Utah"}}}],"names":[{"value":{"type":"Name","forms":[{"selected":false,"pieces":[{"value":"API","type":"Given","predelimiters":"","postdelimiters":" "},{"value":"User","type":"Given","predelimiters":"","postdelimiters":" "},{"value":"1241","type":"Family","predelimiters":"","postdelimiters":""}],"fullText":"API User 1241"}]}}],"genders":[{"value":{"type":"Male"}}]}}],"version":"2.0.20091103.5176","statusCode":200,"statusMessage":"OK"}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-fs-stack
 version: !ruby/object:Gem::Version 
-  version: 0.2.6
+  version: 0.3.0
 platform: ruby
 authors: 
 - Jimmy Zimmerman
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-17 00:00:00 -07:00
+date: 2009-12-18 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -79,6 +79,7 @@ files:
 - spec/familytree_v2/match_results_spec.rb
 - spec/familytree_v2/person_spec.rb
 - spec/familytree_v2/search_results_spec.rb
+- spec/fixtures/fakeweb_response.txt
 - spec/fs_utils_spec.rb
 - spec/identity_v1/identity_spec.rb
 - spec/identity_v1/json/login.js