umlaut_borrow_direct 1.0.0.pre.alpha.1 → 1.0.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NWFkNDIxZDUyOWZhZmIxMDJjNzkxY2FmMTc1Yjc2OGU0NjZlZTU3Yw==
-  data.tar.gz: !binary |-
-    ZDEwNzk3YmE3ODVlZWNmYTRkMGE1MjEwMDEwODMyMmYwOGJiZmZlYg==
+SHA1:
+  metadata.gz: 379ad3faee548537a8547a5bcab491e78c9e6caf
+  data.tar.gz: d73efae851761ae8b66b6b4268e19cbea0febc1d
 SHA512:
-  metadata.gz: !binary |-
-    OWY5NTIwZGU2MDIwZDJlNWQzMDg0ZmM1ODgxODM4Zjg3Y2MwYWY3NzQ1MGNj
-    ZjYyZTUwZTg2MTY3MGUxMjU3NDMxZTc2ODg0ZDAwNzgzODFiNmRmMWU3YzZh
-    Mjk0NmVmMDRlZjc1NzVlNDQwZmZmZWJlYjY4YjliMzMxZmM2MjQ=
-  data.tar.gz: !binary |-
-    MWY3YzM4MzUwNGY0Yjc3ODgyNjMzNWExZDFkMDBhZDdjNWVmZjcwMDM1MTE1
-    MGUyZGZjZmVhYWUwNGY2MmIyMTg4NjcwMzIwZGRkMzI1YjhjMzU1OGViNjBj
-    OTQzNDk0MzJlMDk4Y2FmMTczN2Y5NWJkZDJiZTc3NDU5N2EwYzg=
+  metadata.gz: 4af2e830f50d29dd4a7ba516af419cc872da6e933aae373d6da62926116a19f7af5210025d21f968d77344fdaa73bb68e6f479587933b11dcdafd0f275ed22fc
+  data.tar.gz: 35372508b02225c3aee4abbe6ab55adfde0714052f091f2e7399de5bd7cbbf5f9ea5cafa0143b7825be81a8ffa88a2abd11526a776c676199da4c8aa87289ff2

data/app/controllers/umlaut_borrow_direct/controller_implementation.rb

@@ -44,10 +44,15 @@ module UmlautBorrowDirect
       # Saving the @bg_thread only so in testing we can wait on it. 
       @bg_thread = Thread.new(@request, @service, @request.referent.isbn) do |request, service, isbn|
         begin
+          ActiveRecord::Base.forbid_implicit_checkout_for_thread!
 
           requester = BorrowDirect::RequestItem.new(self.patron_barcode, service.library_symbol)
           requester.timeout = @service.http_timeout
-          request_number = requester.make_request!(params[:pickup_location], :isbn => isbn)
+
+          # remove hyphens, BD likes it better. 
+          normalized_isbn = isbn.gsub('-', '') if isbn
+
+          request_number = requester.make_request!(params[:pickup_location], :isbn => normalized_isbn)
 
           ActiveRecord::Base.connection_pool.with_connection do
             service.bd_api_log(isbn, "RequestItem", "SUCCESS", requester.last_request_time)
@@ -56,7 +61,17 @@ module UmlautBorrowDirect
             set_status_response({:status => Successful, :request_number => request_number }, request)
           end
 
-        rescue StandardError => e          
+        rescue StandardError => e
+          # If it was an AR error in the first place, forget trying to record
+          # it. 
+          if e.kind_of?(ActiveRecord::ActiveRecordError)
+            Rails.logger.fatal("BorrowDirect: Error placing request, and we could not log to database (#{e}):  #{e.class} #{e.message}. Backtrace:\n  #{Umlaut::Util.clean_backtrace(e).join("\n  ")}\n")
+
+            # Nothing will do anything with this since we aren't waiting on
+            # the thread, but oh well. 
+            raise e
+          end
+
           ActiveRecord::Base.connection_pool.with_connection do
             Rails.logger.error("BorrowDirect: Error placing request:  #{e.class} #{e.message}. Backtrace:\n  #{Umlaut::Util.clean_backtrace(e).join("\n  ")}\n")
 
@@ -68,7 +83,7 @@ module UmlautBorrowDirect
             set_status_response(status_response_data, request)
 
             if service
-              service.bd_api_log(isbn, "RequestItem", e, requester.last_request_time)
+              service.bd_api_log(isbn, "RequestItem", e, (requester.last_request_time if requester))
             end
 
 

data/app/helpers/borrow_direct_presenter.rb

@@ -81,7 +81,7 @@ class BorrowDirectPresenter
   end
 
   def show_link_response?
-    self.link_response && ! self.show_confirmation?
+    self.link_response && (! self.show_confirmation?) && (! self.show_request_form?)
   end
 
   def could_not_place_request?

data/app/service_adaptors/borrow_direct_adaptor.rb

@@ -29,7 +29,7 @@ class BorrowDirectAdaptor < Service
     @bd_api_logger_level = nil
     # Abort for these rfr_id's -- keep from searching BD when
     # we came from BD. 
-    @suppress_rfr_ids = ["info:sid/BD"]
+    @suppress_rfr_ids = ["info:sid/BD", "info:sid/BD-Unfilled"]
 
     # Should we use the api at all? Set to false to disable API
     # entirely, because you think it performs too crappily or
@@ -47,6 +47,11 @@ class BorrowDirectAdaptor < Service
     return ! title_is_serial?(request.referent)
   end
 
+  # Make sure there are no hyphens, BD doesn't seem to like it
+  def isbn(request)
+    request.referent.isbn && request.referent.isbn.gsub('-', '')
+  end
+
   def handle(request)
     if request.referrer_id && @suppress_rfr_ids.include?(request.referrer_id)
       return request.dispatched(self, true)
@@ -70,10 +75,10 @@ class BorrowDirectAdaptor < Service
       begin
         finditem = BorrowDirect::FindItem.new(@find_item_patron_barcode, @library_symbol)
         finditem.timeout = @http_timeout
-        response = finditem.find(:isbn => request.referent.isbn)
+        response = finditem.find(:isbn => isbn(request))
 
         # Log success if configured, used for looking at error rate
-        bd_api_log(request.referent.isbn, "FindItem", "SUCCESS", finditem.last_request_time)
+        bd_api_log(isbn(request), "FindItem", "SUCCESS", finditem.last_request_time)
 
         if response.requestable?
           # Mark it requestable!
@@ -100,7 +105,7 @@ class BorrowDirectAdaptor < Service
         Rails.logger.error(msg)
 
         # Special BD error log if configured
-        bd_api_log(request.referent.isbn, "FindItem", e, finditem.last_request_time)
+        bd_api_log(isbn(request), "FindItem", e, finditem.last_request_time)
 
         # And mark it as an error so error message will be displayed. Let's
         # mark it a temporary error, so it'll be tried again later, it might
@@ -123,12 +128,15 @@ class BorrowDirectAdaptor < Service
   def can_precheck_borrow_direct?(request)
     return false unless @use_bd_api
 
-    request.referent.isbn.present?
+    isbn(request).present?
   end
 
   def bd_api_log(isbn, action, result, timing)
     if result.kind_of? Exception
       result = "#{result.class}/#{result.message}"
+      if result.respond_to?(:bd_code) && result.bd_code.present?
+        result += "/#{result.bd_code}"
+      end
     end
 
     if @bd_api_log_level

data/app/views/borrow_direct/_resolve_section.html.erb

@@ -27,6 +27,12 @@
         </p>
     <% end %>
     <%= render "borrow_direct/request_form", :response => bd_presenter.request_prompt_response %>
+    <% if bd_presenter.link_response && ! bd_presenter.show_link_response? %>
+        <%= link_to t('umlaut.services.borrow_direct_adaptor.bd_request_prompt.direct_link'), 
+            link_router_url(bd_presenter.link_response),
+            :class => "bd-direct-link",
+            :target => "_blank" %>
+    <% end %>
 <% end %>
 
 <% if bd_presenter.show_not_available?  %>
@@ -59,7 +65,7 @@ errors = umlaut_request.
 if errors.present? 
     %>
 
-        <% if bd_presenter.show_link_response? %>
+        <% if bd_presenter.show_link_response? && (! bd_presenter.error_div_classes.include?('alert'))%>
             <hr>
         <% end %>  
 

data/config/locales/en.yml

@@ -23,9 +23,10 @@ en:
           request: Request
           pickup_validation: "You must choose a pickup location"
           progress: "Checking BorrowDirect availability for you"
+          direct_link: "You can also check BorrowDirect for other editions."
         bd_not_available:
           display_text: "This edition is not available via BorrowDirect."
-          workaround_link: "You can check BorrowDirect manually for other editions."
+          workaround_link: "You can check BorrowDirect for other editions."
         bd_request_status:
           progress: "Placing the request to BorrowDirect"
           error:  "There was a problem submitting your request to BorrowDirect."
@@ -34,6 +35,6 @@ en:
       borrow_direct:
         title: "Request a copy from BorrowDirect"
         prompt: "Get item from one of our partner libraries in 3-6 days. Checkout period is 12 weeks, with no renewals."
-        error: Unable to determine BorrowDirect availability for this edition. 
-        workaround_link: Please check BorrowDirect for this item manually.
+        error: Unable to automatically determine BorrowDirect availability for this edition. 
+        workaround_link: Please check BorrowDirect for this item.
 

data/lib/tasks/umlaut_borrow_direct_tasks.rake

@@ -2,3 +2,121 @@
 # task :umlaut_borrow_direct do
 #   # Task goes here
 # end
+namespace :umlaut_borrow_direct do
+  desc "BD API stats calc"
+  task :api_stats, [:filename] do |t, args|
+
+    stats = {
+      "FindItem" => {
+        :times    => [],
+        :errors   => [],
+        :timeouts => [],
+        :count    => 0
+      },
+      "RequestItem" => {
+        :times    => [],
+        :errors   => [],
+        :timeouts => [],
+        :count    => 0
+      }
+    }
+
+    if args["filename"] == "stdin"
+      file = STDIN
+    else
+      file = File.open(File.expand_path args[:filename])
+    end
+
+    file.each_line do |line|
+
+      if line =~ /BD API log\t([^\t]*)\t([^\t]*)\t([^\t]*)\t([^\t]*)/
+        action = $1
+        result = $2
+        timing = $3
+        query  = $4
+        
+        if timing.present? && (timing.to_f == 0)
+          raise "Timing does not look like a float: #{timingf}" 
+        end
+        timing = timing.to_f
+
+        if ["FindItem", "RequestItem"].include? action
+          stats[action][:count] += 1
+
+          if line =~ /(\d\d\d\d-\d\d-\d\d)/
+
+            date = Date.parse($1)
+
+            stats[action][:min_date] = date if stats[action][:min_date].nil? || (date < stats[action][:min_date])
+            stats[action][:max_date] = date if stats[action][:max_date].nil? || (date > stats[action][:max_date])
+          end
+
+          value_dict = {:action => action, :result => result, :timing => timing, :query => query}
+
+          stats[action][:times] << timing unless timing == 0
+          unless result == "SUCCESS"
+            (exception_class, exception_message) = result.split("/")
+            value_dict[:exception_class]   = exception_class
+            value_dict[:exception_message] = exception_message
+            if exception_class == "BorrowDirect::HttpTimeoutError"          
+              stats[action][:timeouts] << value_dict 
+            else
+              stats[action][:errors] << value_dict
+            end
+          end
+        else
+          puts "Warning, unrecognized action: #{action}"
+        end
+      end
+    end
+
+    ["FindItem", "RequestItem"].each do |action|
+      sorted_times = stats[action][:times].sort
+
+      next if sorted_times.empty?
+      
+      puts "\n\n#{action} API: #{stats[action][:count]} requests from #{stats[action][:min_date]} to #{stats[action][:max_date]}"
+      puts "  Timing (not including timeouts):"
+      puts "    Min: #{sorted_times.first}"
+      puts "    25th %ile: #{percentile sorted_times, 25}"
+      puts "    Median: #{percentile sorted_times, 50}"
+      puts "    60th %ile: #{percentile sorted_times, 60}"
+      puts "    75th %ile: #{percentile sorted_times, 75}"
+      puts "    95th %ile: #{percentile sorted_times, 95}"
+      puts "    99th %ile: #{percentile sorted_times, 99}"
+      puts "    Max: #{sorted_times.last}"
+      puts ""
+      puts "  Timeouts: #{stats[action][:timeouts].count}"
+      puts "  Errors: #{stats[action][:errors].count}"
+
+      #error_types = stats[action][:errors].group_by {|dict| dict[:exception_class]}
+      #error_types.each_pair do |type, list|
+      #  puts "    #{type} (#{list.count}) #{list}"
+      #end
+
+    end
+    puts "\n\n"
+    
+    
+  end
+
+  # pass in a SORTED array a
+  def percentile a, p
+      rank = (p.to_f / 100) * (a.length + 1)
+      
+      if a.length == 0
+        return nil
+      elsif rank.modulo(1) != 0
+
+
+        sample_0 = a[rank.truncate - 1]
+        sample_1 = a[rank.truncate]
+
+
+        return sample_0 if sample_1.nil?
+        return (sample_1 + sample_0) / 2
+      else
+        return a[rank - 1]
+      end    
+  end
+end

data/lib/umlaut_borrow_direct/engine.rb

@@ -27,5 +27,15 @@ module UmlautBorrowDirect
       end
     end
 
+  initializer "umlaut_borrow_direct.set_api_base" do 
+    # We just set the default api_base in production, hopefully
+    # that won't cause any problems, local app could do something different
+    # in it's own initializer I think. 
+    if Rails.env.production?
+      require 'borrow_direct'
+      BorrowDirect::Defaults.api_base = BorrowDirect::Defaults::PRODUCTION_API_BASE
+    end
+  end
+
   end
 end

data/lib/umlaut_borrow_direct/version.rb

@@ -1,3 +1,3 @@
 module UmlautBorrowDirect
-  VERSION = "1.0.0-alpha.1"
-end
+  VERSION = "1.0.0"
+end