ansr_dpla 0.0.4

data/lib/ansr_dpla.rb

@@ -0,0 +1,9 @@
+require 'ansr'
+module Ansr::Dpla
+  require 'ansr_dpla/api'
+  require 'ansr_dpla/request'
+  require 'ansr_dpla/connection_adapters/no_sql_adapter'
+  require 'ansr_dpla/arel'
+  require 'ansr_dpla/relation'
+  require 'ansr_dpla/model'
+end

data/lib/ansr_dpla/api.rb

@@ -0,0 +1,78 @@
+require 'rest_client'
+module Ansr::Dpla
+  class Api
+    include Ansr::Configurable
+
+    def config &block
+      super &block
+      raise "DPLA clients must be configured with an API key" unless @config[:api_key]
+      @config
+    end
+
+
+    API_PARAM_KEYS = [:api_key, :callback, :facets, :fields, :page, :page_size, :sort_by, :sort_by_pin, :sort_order]
+
+    def initialize(config=nil)
+      self.config{|x| x.merge!(config)} if config
+    end
+
+    def api_key
+      config[:api_key]
+    end
+
+    def url
+      config[:url] || 'http://api.dp.la/v2/'
+    end
+
+    def path_for base, options = nil
+      return "#{base}?api_key=#{self.api_key}" unless options.is_a? Hash
+      options = {:api_key=>api_key}.merge(options)
+      API_PARAM_KEYS.each do |query_key|
+        options[query_key] = options[query_key].join(',') if options[query_key].is_a? Array
+      end
+      (options.keys - API_PARAM_KEYS).each do |query_key|
+        options[query_key] = options[query_key].join(' AND ') if options[query_key].is_a? Array
+        options[query_key].sub!(/^OR /,'')
+        options[query_key].gsub!(/\s+AND\sOR\s+/, ' OR ')
+      end
+      "#{base}" + (("?#{options.map { |key, value|  "#{CGI::escape(key.to_s)}=#{CGI::escape(value.to_s)}"}.join("&")  }" if options and not options.empty?) || '')
+    end
+
+    def client
+      @client ||= RestClient::Resource.new(self.url)
+    end
+
+    def items_path(options={})
+      path_for('items', options)
+    end
+
+    def items(options = {})
+      client[items_path(options)].get
+    end
+
+    def item_path(id)
+      path_for("items/#{id}")
+    end
+
+    def item(id)
+      client[item_path(id)].get
+    end
+
+    def collections_path(options={})
+      path_for('collections', options)
+    end
+
+    def collections(options = {})
+      client[collections_path(options)].get
+    end
+
+    def collection_path(id)
+      path_for("collections/#{id}")
+    end
+
+    def collection(id)
+      client[collection_path(id)].get
+    end
+
+  end
+end

data/lib/ansr_dpla/arel.rb

@@ -0,0 +1,7 @@
+require 'active_record'
+module Ansr::Dpla
+  module Arel
+    require 'ansr_dpla/arel/big_table'
+    require 'ansr_dpla/arel/visitors'
+  end
+end

data/lib/ansr_dpla/arel/big_table.rb

@@ -0,0 +1,108 @@
+module Ansr::Dpla
+  module Arel
+    class BigTable < Ansr::Arel::BigTable
+
+      FIELDS = [
+        # can we list the fields from the DPLA v2 api?
+        # the sourceResource, originalRecord, and provider fields need to be associations, right?
+        :"_id",
+        :"dataProvider",
+        :"sourceResource",
+        :"object",
+        :"ingestDate",
+        :"originalRecord",
+        :"ingestionSequence",
+        :"isShownAt",
+        :"hasView",
+        :"provider",
+        :"@context",
+        :"ingestType",
+        :"@id",
+        :"id"
+      ]
+
+      FACETS = [
+        :"sourceResource.contributor",
+        :"sourceResource.date.begin",
+        :"sourceResource.date.end",
+        :"sourceResource.language.name",
+        :"sourceResource.language.iso639",
+        :"sourceResource.format",
+        :"sourceResource.stateLocatedIn.name",
+        :"sourceResource.stateLocatedIn.iso3166-2",
+        :"sourceResource.spatial.name",
+        :"sourceResource.spatial.country",
+        :"sourceResource.spatial.region",
+        :"sourceResource.spatial.county",
+        :"sourceResource.spatial.state",
+        :"sourceResource.spatial.city",
+        :"sourceResource.spatial.iso3166-2",
+        :"sourceResource.spatial.coordinates",
+        :"sourceResource.subject.@id",
+        :"sourceResource.subject.name",
+        :"sourceResource.temporal.begin",
+        :"sourceResource.temporal.end",
+        :"sourceResource.type",
+        :"hasView.@id",
+        :"hasView.format",
+        :"isPartOf.@id",
+        :"isPartOf.name",
+        :"isShownAt",
+        :"object",
+        :"provider.@id",
+        :"provider.name",
+      ]
+
+      SORTS = [
+        :"id",
+        :"@id",
+        :"sourceResource.id",
+        :"sourceResource.contributor",
+        :"sourceResource.date.begin",
+        :"sourceResource.date.end",
+        :"sourceResource.extent",
+        :"sourceResource.language.name",
+        :"sourceResource.language.iso639",
+        :"sourceResource.format",
+        :"sourceResource.stateLocatedIn.name",
+        :"sourceResource.stateLocatedIn.iso3166-2",
+        :"sourceResource.spatial.name",
+        :"sourceResource.spatial.country",
+        :"sourceResource.spatial.region",
+        :"sourceResource.spatial.county",
+        :"sourceResource.spatial.state",
+        :"sourceResource.spatial.city",
+        :"sourceResource.spatial.iso3166-2",
+        :"sourceResource.spatial.coordinates",
+        :"sourceResource.subject.@id",
+        :"sourceResource.subject.type",
+        :"sourceResource.subject.name",
+        :"sourceResource.temporal.begin",
+        :"sourceResource.temporal.end",
+        :"sourceResource.title",
+        :"sourceResource.type",
+        :"hasView.@id",
+        :"hasView.format",
+        :"isPartOf.@id",
+        :"isPartOf.name",
+        :"isShownAt",
+        :"object",
+        :"provider.@id",
+        :"provider.name",
+      ]
+
+      def initialize(klass, opts={})
+        super(klass.model())
+        self.name = klass.name.downcase.pluralize
+        @fields += (opts[:fields] || FIELDS)
+        @facets += (opts[:facets] || FACETS)
+        @sorts += (opts[:sorts] || SORTS)
+        self.config(opts[:config]) if opts[:config]
+      end
+
+      def name
+        super.pluralize.downcase
+      end
+    end
+  end
+end

data/lib/ansr_dpla/arel/visitors.rb

@@ -0,0 +1,6 @@
+module Ansr::Dpla::Arel
+  module Visitors
+    require 'ansr_dpla/arel/visitors/query_builder'
+    require 'ansr_dpla/arel/visitors/to_no_sql'
+  end
+end

data/lib/ansr_dpla/arel/visitors/query_builder.rb

@@ -0,0 +1,188 @@
+module Ansr::Dpla::Arel::Visitors
+  class QueryBuilder < Ansr::Arel::Visitors::QueryBuilder
+    attr_reader :query_opts
+    
+    def initialize(table, query_opts=nil)
+      super(table)
+      @query_opts = query_opts ||= Ansr::Dpla::Request.new
+      @query_opts.path = table.name
+    end
+
+    # determines whether multiple values should accumulate or overwrite in merges
+    def multiple?(field_key)
+      true
+    end
+
+    def visit_String o, a
+      case a
+      when Ansr::Arel::Visitors::From
+        query_opts.path = o
+      when Ansr::Arel::Visitors::Facet
+        filter_field(o.to_sym)
+      when Ansr::Arel::Visitors::Order
+        order(o)
+      else
+        raise "visited String \"#{o}\" with #{a.to_s}"
+      end
+    end
+
+    def visit_Arel_SqlLiteral(n, attribute)
+      select_val = n.to_s.split(" AS ")
+      case attribute
+      when Ansr::Arel::Visitors::Order
+        order(n.to_s)
+      when Ansr::Arel::Visitors::Facet
+        filter_field(select_val[0].to_sym)
+      else
+        field(select_val[0].to_sym)
+        if select_val[1]
+          query_opts.aliases ||= {}
+          query_opts.aliases[select_val[0]] = select_val[1]
+        end
+      end
+    end
+
+    def visit_Ansr_Arel_Nodes_Filter(object, attribute)
+      expr = object.expr
+      case expr
+      when ::Arel::SqlLiteral
+        visit expr, Ansr::Arel::Visitors::Filter.new(attribute) if object.select
+      when ::Arel::Attributes::Attribute
+        name = object.expr.name
+        name = "#{expr.relation.name}.#{name}" if expr.relation.name.to_s != table.name.to_s
+        visit name, Ansr::Arel::Visitors::Filter.new(attribute) if object.select
+      else
+        raise "Unexpected filter expression type #{object.expr.class}"
+      end
+    end
+
+    def visit_Ansr_Arel_Nodes_Facet(object, attribute)
+      expr = object.expr
+      case expr
+      when ::Arel::SqlLiteral
+        visit expr, Ansr::Arel::Visitors::Facet.new(attribute)
+      when ::Arel::Attributes::Attribute
+        name = object.expr.name
+        name = "#{expr.relation.name}.#{name}" if expr.relation.name.to_s != table.name.to_s
+        visit name, Ansr::Arel::Visitors::Facet.new(attribute) if object.select
+      else
+        raise "Unexpected filter expression type #{object.expr.class}"
+      end
+    end
+
+    def projections
+      query_opts[:fields] || []
+    end
+
+    def filter_projections
+      query_opts[:facets] || []
+    end
+
+
+    def field(field_name)
+      return unless field_name
+      old = query_opts[:fields] ? Array(query_opts[:fields]) : []
+      field_names = (old + Array(field_name)).uniq
+      if field_names[0]
+        query_opts[:fields] = field_names[1] ? field_names : field_names[0]
+      end
+    end
+
+    def filter_field(field_name)
+      return unless field_name
+      field_name = Array(field_name)
+      field_name.each {|fn| raise "#{fn} is not a facetable field" unless table.facets.include? fn.to_sym}
+      old = query_opts[:facets] ? Array(query_opts[:facets]) : []
+      field_names = (old + Array(field_name)).uniq
+      if field_names[0]
+        query_opts[:facets] = field_names[1] ? field_names : field_names[0]
+      end
+    end
+
+    def add_where_clause(attr_node, val)
+      field_key = field_key_from_node(attr_node)
+      if query_opts[field_key]
+        query_opts[field_key] = Array(query_opts[field_key]) << val
+      else
+        query_opts[field_key] = val
+      end
+    end
+
+    # the DPLA API makes no distinction between filter and normal queries
+    def visit_Arel_Nodes_Equality(object, attribute)
+      add_where_clause(object.left, object.right)
+    end
+
+    def visit_Arel_Nodes_NotEqual(object, attribute)
+      add_where_clause(object.left, "NOT " + object.right)
+    end
+    def visit_Arel_Nodes_Or(object, attribute)
+      add_where_clause(object.left, "OR " + object.right)
+    end
+
+    def visit_Arel_Nodes_Grouping(object, attribute)
+      visit object.expr, attribute
+    end
+
+    def visit_Arel_Nodes_Ordering(object, attribute)
+      if query_opts[:sort_by]
+        query_opts[:sort_by] = Array[query_opts[:sort_by]] << object.expr.name
+      else
+        query_opts[:sort_by] = object.expr.name
+      end
+      direction = :asc if (::Arel::Nodes::Ascending === object and direction)
+      direction = :desc if (::Arel::Nodes::Descending === object)
+      query_opts[:sort_order] = direction if direction
+    end      
+
+    def order(*arel_nodes)
+      direction = nil
+      nodes = []
+      arel_nodes.inject(nodes) do |c, n|
+        if ::Arel::Nodes::Ordering === n
+          c << n
+        elsif n.is_a? String
+          _ns = n.split(',')
+          _ns.each do |_n| 
+            _p = _n.split(/\s+/)
+            if (_p[1])
+              _p[1] = _p[1].downcase.to_sym
+            else
+              _p[1] = :asc
+            end
+            c << table[_p[0].to_sym].send(_p[1])
+          end
+        end
+        c
+      end
+      nodes.each do |node|
+        if ::Arel::Nodes::Ordering === node
+          if query_opts[:sort_by]
+            query_opts[:sort_by] = Array[query_opts[:sort_by]] << node.expr.name
+          else
+            query_opts[:sort_by] = node.expr.name
+          end
+          direction = :asc if (::Arel::Nodes::Ascending === node and direction)
+          direction = :desc if (::Arel::Nodes::Descending === node)
+        end
+      end
+      query_opts[:sort_order] = direction if direction
+    end
+
+    def visit_Arel_Nodes_Limit(object, attribute)
+      value = object.expr
+      if value and (value = value.to_i)
+        raise "Page size cannot be > 500 (#{value}" if value > 500
+        query_opts[:page_size] = value
+      end
+    end
+
+    def visit_Arel_Nodes_Offset(object, attribute)
+      value = object.expr
+      if value
+        query_opts[:page] = (value.to_i / (query_opts[:page_size] || Ansr::Relation::DEFAULT_PAGE_SIZE)) + 1
+      end
+    end        
+
+  end    
+end

data/lib/ansr_dpla/arel/visitors/to_no_sql.rb

@@ -0,0 +1,9 @@
+module Ansr::Dpla::Arel::Visitors
+  class ToNoSql < Ansr::Arel::Visitors::ToNoSql
+
+    def query_builder(opts = nil)
+      Ansr::Dpla::Arel::Visitors::QueryBuilder.new(table, opts)
+    end
+
+  end
+end

data/lib/ansr_dpla/connection_adapters/no_sql_adapter.rb

@@ -0,0 +1,58 @@
+module Ansr::Dpla
+  module ConnectionAdapters
+    class NoSqlAdapter < Ansr::ConnectionAdapters::NoSqlAdapter
+
+      def self.connection_for(klass)
+        klass.api
+      end
+
+      def initialize(klass, logger = nil, pool = nil) #:nodoc:
+        super(klass, klass.api, logger, pool)
+        @visitor = Ansr::Dpla::Arel::Visitors::ToNoSql.new(@table)
+      end
+
+      def to_sql(*args)
+        to_nosql(*args)
+      end
+
+      def execute(query, name='ANSR-DPLA')
+        method = query.path
+        query = query.to_h if Ansr::Dpla::Request === query
+        query = query.dup
+        aliases = query.delete(:aliases)
+        json = @connection.send(method, query)
+        json = json.length > 0 ? JSON.load(json) : {'docs' => [], 'facets' => []}
+        if json['docs'] and aliases
+          json['docs'].each do |doc|
+            aliases.each do |k,v|
+              if doc[k]
+                old = doc.delete(k)
+                if old and doc[v]
+                  doc[v] = Array(doc[v]) if doc[v]
+                  Array(old).each {|ov| doc[v] << ov}
+                else
+                  doc[v] = old
+                end
+              end
+            end
+          end
+        end
+        json
+      end
+
+      def table_exists?(table_name)
+        ['Collection', 'Item'].include? table_name
+      end
+
+      def sanitize_limit(limit_value)
+        if (0..500) === limit_value.to_s.to_i
+          limit_value
+        else
+          Ansr::Relation::DEFAULT_PAGE_SIZE
+        end
+      end
+
+    end
+  end
+ 
+end