dbla 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb8fae248060253ada17d9cbc785ec9bef380173
-  data.tar.gz: f9c302e800a86a250dcbf215b16464e73e07f438
+  metadata.gz: ed3c90144eabe9791538f773b22ba691467248be
+  data.tar.gz: 7cab3b50332d69e51d978538022ff2034b88265f
 SHA512:
-  metadata.gz: d86878a38f42a993afc633916a57e83a251f78dba365c28cccccaf2035e6528c663ac6bbcdacae8139684b68356bdc8117f5aeefcbc7876643e5bb1732450536
-  data.tar.gz: 37ad200951dfc84c7b99c005daa60465db099b5c4b3857115e402f74f9006ee2f9dee669d6750913f90bd9670bad5836cdd7ed3e3290b26a02a06c73cc1f471a
+  metadata.gz: 276e2e397be231484d882ce6c8111f7905a79e1dbe428be6dff04944c02efa4598f47106c01e454c8f23012714159f52f8c90b4078136114813c237edfea6c68
+  data.tar.gz: 19da1e0593e6f066ac31505d6d9df0a0120685186966fd112ed4481c04ec6e0e7a7e7284df49466f0b1ff91a1fc914b1b40e7d1c7c441b2901934dd8f514858d

data/lib/dbla.rb

@@ -12,4 +12,5 @@ module Dbla
   autoload :Repository, 'dbla/repository'
   autoload :Response, 'dbla/response'
   autoload :Routes, 'dbla/routes'
+  autoload :SearchBuilderBehavior, 'dbla/search_builder_behavior'
 end

data/lib/dbla/abstract_response.rb

@@ -49,10 +49,10 @@ module Dbla
       when Array
         value.each { |v| force_to_utf8(v) }
       when String
-        value.force_encoding("utf-8")  if value.respond_to?(:force_encoding) 
+        value.force_encoding("utf-8")  if value.respond_to?(:force_encoding)
       end
       value
     end
 
   end
-end
+end

data/lib/dbla/document_presenter.rb

@@ -4,6 +4,8 @@ module Dbla
     include ActionView::Helpers::TagHelper
     extend Deprecation
 
+    DESCRIPTIVE_METADATA_KEY = 'sourceResource'.freeze
+
     # @param [Item or Collection] document
     # @param [ActionController::Base] controller scope for linking and generating urls
     # @param [Blacklight::Configuration] configuration
@@ -19,7 +21,7 @@ module Dbla
     # @param [SolrDocument] document
     # @return [String]
     def document_heading
-      @document['sourceResource']['title']
+      @document[DESCRIPTIVE_METADATA_KEY]['title']
     end
     ##
     # Get the document's "title" to display in the <title> element.
@@ -28,7 +30,7 @@ module Dbla
     # @see #document_heading
     # @return [String]
     def document_show_html_title
-      @document['sourceResource']['title']
+      @document[DESCRIPTIVE_METADATA_KEY]['title']
     end
     ##
     # Render a value (or array of values) from a field
@@ -49,7 +51,7 @@ module Dbla
     def render_document_index_label field, opts ={}
       if Symbol === field
         # these are shenanigans to find a nested field
-        field.to_s.split('/').inject(@document) {|m,v| m[v]}
+        field.to_s.split('.').inject(@document) {|m,v| m[v]}
       elsif Proc === field
         field.call
       else
@@ -87,7 +89,7 @@ module Dbla
     # Rendering:
     #   - helper_method
     #   - link_to_search
-    # TODO : maybe this should be merged with render_field_value, and the ugly signature 
+    # TODO : maybe this should be merged with render_field_value, and the ugly signature
     # simplified by pushing some of this logic into the "model"
     # @param [SolrDocument] document
     # @param [String] field name
@@ -108,4 +110,4 @@ module Dbla
 
 
   end
-end
+end

data/lib/dbla/repository.rb

@@ -12,12 +12,16 @@ module Dbla
       data = nil
       #TODO Move this into a SearchBuilder, add a generator
       if params['q']
-        q = "?api_key=#{api_key}&q=#{params['q']}"
+        q = "?api_key=#{api_key}&q=#{params['q']}&facets=sourceResource.format"
         if params.page
-            q << "&page=#{params.page}"
+          q << "&page=#{params.page}"
         end
         if params.rows
-            q << "&page_size=#{params.rows}"
+          q << "&page_size=#{params.rows}"
+        end
+        params.facet_filters do |facet_field, value|
+          value = "\"#{value}\"" if value.index(' ')
+          q << "&#{facet_field}=#{CGI::escape(value)}"
         end
         puts url + q
         data = get(url + q)
@@ -34,12 +38,13 @@ module Dbla
       end
     end
     def api_key
-      Dbla.config[:api_key]
+      Dbla.config.fetch(:api_key)
     end
 
     def url
-      @url ||= (Dbla.config[:url] + blacklight_config.document_model.name.downcase.pluralize).freeze
+      # REVIEW: What if the URL does not have a trailing /; Should it be `File.join?`
+      @url ||= (Dbla.config.fetch(:url) + blacklight_config.document_model.name.downcase.pluralize).freeze
     end
 
   end
-end
+end

data/lib/dbla/response.rb

@@ -1,6 +1,8 @@
 # -*- encoding : utf-8 -*-
 module Dbla
   class Response < AbstractResponse
+    autoload :Facets, 'dbla/response/facets'
+
     def initialize(data, request_params, options = {})
       super(force_to_utf8(data))
       @request_params = request_params
@@ -11,6 +13,29 @@ module Dbla
         @documents = (data['docs'] || []).map {|d| document_model.new(d,self)}
         @start = data['start']
         @limit = data['limit']
+        @aggregations = (data['facets'] || {})
+      else
+        @aggregations = {}
+        @total = 0
+        @start = 0
+        @limit = 10
+        @documents = []
+      end
+    end
+    def aggregations
+      # "facets":{"sourceResource.format":{"_type":"terms","missing":77,"total":250,"other":16,"terms":[{"term":"Photographs","count":44},
+      Hash[@aggregations.map do |k,v|
+        items = v['terms'].map {|term| Facets::FacetItem.new(value: term['term'], hits: term['count'])}
+        [k, Facets::FacetField.new(k,items)]
+      end]
+    end
+    def spelling
+      Words.new([])
+    end
+    class Words
+      attr_accessor :words
+      def initialize(words)
+        @words = words
       end
     end
   end

data/lib/dbla/response/facets.rb

@@ -0,0 +1,62 @@
+require 'ostruct'
+module Dbla::Response::Facets
+  # Borrowed from Blacklight
+  class FacetField
+    attr_reader :name, :items
+    def initialize name, items, options = {}
+      @name, @items = name, items
+      @options = options
+    end
+
+    def limit
+      @options[:limit] || default_limit
+    end
+
+    def sort
+      @options[:sort] || default_sort
+    end
+
+    def offset
+      @options[:offset] || default_offset
+    end
+
+    private
+    def default_limit
+      100
+    end
+
+    def default_sort
+      if limit > 0
+        'count'
+      else
+        'index'
+      end
+    end
+
+    def default_offset
+      0
+    end
+  end
+  class FacetItem < OpenStruct
+    def initialize *args
+      options = args.extract_options!
+
+      # Backwards-compat method signature
+      value = args.shift
+      hits = args.shift
+
+      options[:value] = value if value
+      options[:hits] = hits if hits
+
+      super(options)
+    end
+
+    def label
+      super || value
+    end
+
+    def as_json(props = nil)
+      table.as_json(props)
+    end
+  end
+end

data/lib/dbla/search_builder_behavior.rb

@@ -1,4 +1,24 @@
 module Dbla
   module SearchBuilderBehavior
+    def processed_parameters
+      request.tap do |request_parameters|
+        if blacklight_params[:q]
+          request_parameters[:q] = blacklight_params[:q]
+        end
+      end
+    end
+    def facet_filters
+      # :fq, map from :f.
+      if ( blacklight_params[:f])
+        f_request_params = blacklight_params[:f]
+
+        f_request_params.each_pair do |facet_field, value_list|
+          Array(value_list).each do |value|
+            next if value.blank? # skip empty strings
+            yield *[facet_field, value]
+          end
+        end
+      end
+    end
   end
 end

data/lib/dbla/version.rb

@@ -1,3 +1,3 @@
 module Dbla
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/generators/dbla/assets_generator.rb

@@ -2,7 +2,7 @@
 module Dbla
   class Assets < Rails::Generators::Base
     source_root File.expand_path('../templates', __FILE__)
-  
+
     def assets
       copy_file "dbla.css.scss", "app/assets/stylesheets/dbla.css.scss"
     end

data/lib/generators/dbla/install_generator.rb

@@ -1,8 +1,8 @@
 module Dbla
   class Install < Rails::Generators::Base
-    
+
     source_root File.expand_path('../templates', __FILE__)
-    
+
     argument     :controller_name, type: :string , default: "catalog"
     argument     :search_builder_name, type: :string , default: "search_builder"
 
@@ -15,11 +15,11 @@ module Dbla
 
     # Copy all files in templates/public/ directory to public/
     # Call external generator in AssetsGenerator, so we can
-    # leave that callable seperately too. 
-    def copy_public_assets 
+    # leave that callable seperately too.
+    def copy_public_assets
       generate "dbla:assets"
     end
-    
+
     def generate_search_builder
       generate 'dbla:search_builder', search_builder_name
     end
@@ -32,4 +32,4 @@ module Dbla
       generate 'dbla:routes'
     end
   end
-end
+end

data/lib/generators/dbla/routes_generator.rb

@@ -1,8 +1,8 @@
 module Dbla
   class RoutesGenerator < Rails::Generators::Base
-    
+
     source_root File.expand_path('../templates', __FILE__)
-    
+
     argument     :controller_name  , type: :string , default: "catalog"
 
     desc """
@@ -12,9 +12,9 @@ module Dbla
 
     def inject_dbla_routes
       # These will end up in routes.rb file in reverse order
-      # we add em, since each is added at the top of file. 
-      # we want "root" to be FIRST for optimal url generation. 
+      # we add em, since each is added at the top of file.
+      # we want "root" to be FIRST for optimal url generation.
       route("Dbla::Routes.for(self, :#{controller_name})")
     end
   end
-end
+end

data/lib/generators/dbla/templates/collection.rb

@@ -35,8 +35,8 @@ class Collection
 
   def has? f, *values
     # these are shenanigans to find a nested field
-    if f.is_a? String and f.index('/')
-      f = f.split('/')
+    if f.is_a? String and f.index('.')
+      f = f.split('.')
       f.inject(self) {|m,v| (m || {})[v]}
     else
       super

data/lib/generators/dbla/templates/item.rb

@@ -35,8 +35,8 @@ class Item
 
   def has? f, *values
     # these are shenanigans to find a nested field
-    if f.is_a? String and f.index('/')
-      f = f.split('/')
+    if f.is_a? String and f.index('.')
+      f = f.split('.')
       f.inject(self) {|m,v| (m || {})[v]}
     else
       super

data/lib/tasks/dbla_key.rake

@@ -10,7 +10,7 @@ module Dbla
     }
     def self.usage(key=:all)
       puts "Usage:"
-      USAGE.select {|k,v| k == key || key == :all}.each{|k,v| puts v} 
+      USAGE.select {|k,v| k == key || key == :all}.each{|k,v| puts v}
     end
   end
 end
@@ -43,9 +43,9 @@ namespace :dbla do
     end
     task config: :environment do
       if ENV['key']
-          open(Dbla.config_path,'a') do |blob|
-            blob.write YAML.dump('api_key' => ENV['key'])
-          end
+        open(Dbla.config_path,'a') do |blob|
+          blob.write YAML.dump('api_key' => ENV['key'])
+        end
       else
         Dbla::ApiKey.usage(:config)
       end
@@ -54,4 +54,4 @@ namespace :dbla do
       Dbla::ApiKey.usage
     end
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dbla
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Audrey Altman
@@ -25,6 +25,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 4.1.10
+- !ruby/object:Gem::Dependency
+  name: blacklight
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.10'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -104,6 +118,7 @@ files:
 - lib/dbla/engine.rb
 - lib/dbla/repository.rb
 - lib/dbla/response.rb
+- lib/dbla/response/facets.rb
 - lib/dbla/routes.rb
 - lib/dbla/search_builder_behavior.rb
 - lib/dbla/version.rb