ansr 0.0.1

data/ansr_dpla/lib/ansr_dpla.rb

@@ -0,0 +1,6 @@
+require 'ansr'
+module Ansr::Dpla
+  require 'ansr_dpla/api'
+  require 'ansr_dpla/arel'
+  require 'ansr_dpla/model'
+end

data/ansr_dpla/lib/ansr_dpla/api.rb

@@ -0,0 +1,78 @@
+require 'rest_client'
+module Ansr::Dpla
+  class Api
+    include Ansr::Configurable
+
+    def config(yaml=nil)
+      super
+      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(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/ansr_dpla/lib/ansr_dpla/arel.rb

@@ -0,0 +1,8 @@
+require 'active_record'
+module Ansr::Dpla
+  module Arel
+    require 'ansr_dpla/arel/big_table'
+    require 'ansr_dpla/arel/connection'
+    require 'ansr_dpla/arel/query_builder'
+  end
+end

data/ansr_dpla/lib/ansr_dpla/arel/big_table.rb

@@ -0,0 +1,104 @@
+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())
+        @fields += (opts[:fields] || FIELDS)
+        @facets += (opts[:facets] || FACETS)
+        @sorts += (opts[:sorts] || SORTS)
+        self.config(opts[:config]) if opts[:config]
+      end
+
+    end
+  end
+end

data/ansr_dpla/lib/ansr_dpla/arel/connection.rb

@@ -0,0 +1,81 @@
+module Ansr::Dpla
+  module Arel
+    class Connection < Ansr::Model::Connection
+      def initialize(klass)
+        super(klass)
+        @method = klass.name.downcase.pluralize.to_sym
+        @api = @table.engine.api
+      end
+
+      def to_sql(*args)
+        to_nosql(*args)
+      end
+
+      # the object generated by this method will be passed to the self#execute
+      def to_nosql(select_manager, bind_values)
+        qb = Ansr::Dpla::Arel::QueryBuilder.new(@table)
+        if ::Arel::Nodes::Intersect === select_manager
+          filter_context = select_manager.right
+          select_manager = select_manager.left
+          constraints(filter_context).each {|c| qb.where(c)}
+          projections(filter_context).each {|c| qb.add_facet(c)}
+        end
+        constraints(select_manager).each {|c| qb.where(c)}
+        orders(select_manager).each {|c| qb.order(c)}
+        projections(select_manager).each {|c| qb.select(c)}
+        if (limit = limit(select_manager))
+          qb.take(limit)
+        end
+        if (offset = offset(select_manager))
+          qb.skip(offset)
+        end
+        qb.query_opts
+      end
+
+
+      def to_aliases(select_manager, bind_values)
+        qb = Ansr::Dpla::Arel::QueryBuilder.new(@table)
+        if ::Arel::Nodes::Intersect === select_manager
+          select_manager = select_manager.left
+        end
+        projections(select_manager).each {|c| qb.select(c)}
+        qb.aliases
+      end
+
+      def execute(query, aliases = {})
+        json = @api.send(@method, query)
+        json = json.length > 0 ? JSON.load(json) : {}
+        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

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

@@ -0,0 +1,131 @@
+module Ansr::Dpla
+  module Arel
+    class QueryBuilder
+      attr_reader :query_opts, :aliases, :table
+      def initialize(big_table)
+        @query_opts = {}
+        @aliases = {}
+        @table = big_table
+      end
+      def fields=(value)
+        @query_opts[:fields] = value
+      end
+      def select(arel_nodes=nil)
+        arel_nodes = [arel_nodes].compact unless arel_nodes.respond_to? :each
+        arel_nodes.each.select {|an| ::Arel::SqlLiteral === an}.each do |n|
+          select_val = n.to_s.split(" AS ")
+          add_field(select_val[0])
+          aliases[select_val[0]] = select_val[1] if select_val[1]
+        end
+      end
+
+      def field_key_from_node(node)
+        table.model.field_name(node)
+      end
+
+      def add_field(field_name)
+        return unless field_name
+        query_opts[:fields] ||= ""
+        query_opts[:fields] << ',' << field_name
+        query_opts[:fields].sub!(/^,/,'')
+      end        
+
+      def add_facet(field_name)
+        return unless field_name
+        field_name = Array(field_name).uniq
+        if query_opts[:facets]
+          query_opts[:facets] = (Array(query_opts[:facets]) + field_name).uniq
+        else
+          query_opts[:facets] = field_name[1] ? field_name : field_name[0]
+        end
+      end
+
+      def where(arel_nodes)
+          arel_nodes = (arel_nodes.respond_to? :each) ? arel_nodes : Array(arel_nodes)
+        arel_nodes.each do |node|
+          case node
+            when ::Arel::Nodes::Equality
+              field_key = field_key_from_node(node.left)
+              if @query_opts[field_key]
+                @query_opts[field_key] = (Array(@query_opts[field_key]) << node.right)
+              else
+                @query_opts[field_key] = node.right
+              end
+            when ::Arel::Nodes::Grouping
+              n = node.expr
+              if ::Arel::Nodes::Binary === n
+                prefix = nil
+                prefix = "NOT" if (::Arel::Nodes::NotEqual === n)
+                prefix = "OR" if (::Arel::Nodes::Or === n)
+                if prefix
+                  val = "#{prefix} #{n.right}"
+                else
+                  val = n.right
+                end
+                field_key = field_key_from_node(n)
+                if @query_opts[field_key]
+                  @query_opts[field_key] = Array(@query_opts[field_key]) << val
+                else
+                  @query_opts[field_key] = val
+                end
+              end
+            when ::Arel::Attributes::Attribute # this is the field references
+          end
+        end
+      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 take(value=nil)
+        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 skip(value=nil)
+        if value
+          @query_opts[:page] = (value.to_i / (@query_opts[:page_size] || Ansr::Relation::DEFAULT_PAGE_SIZE)) + 1
+        end
+      end
+
+      def filters=(values)
+        unless values.empty?
+          @query_opts[:facets] = (values[1]) ? values : values[0]
+        end
+      end
+    end
+  end
+end

data/ansr_dpla/lib/ansr_dpla/model.rb

@@ -0,0 +1,7 @@
+module Ansr::Dpla
+  module Model
+  	autoload :PseudoAssociate, 'ansr_dpla/model/pseudo_associate'
+  	require 'ansr_dpla/model/querying'
+  	require 'ansr_dpla/model/base'
+  end
+end

data/ansr_dpla/lib/ansr_dpla/model/base.rb

@@ -0,0 +1,17 @@
+require 'ansr'
+module Ansr::Dpla
+  module Model
+    class Base < Ansr::Base
+      self.abstract_class = true
+
+  	  include Querying
+
+  		def assign_nested_parameter_attributes(pairs)
+	      pairs.each do |k, v|
+          v = PseudoAssociate.new(v) if Hash === v
+          _assign_attribute(k, v)
+        end
+	    end      	
+    end
+  end
+end

data/ansr_dpla/lib/ansr_dpla/model/pseudo_associate.rb

@@ -0,0 +1,14 @@
+# a class to pretend the unfindable "associations" are real models
+module Ansr::Dpla
+	module Model
+    class PseudoAssociate
+      def initialize(doc = {})
+        @doc = doc.with_indifferent_access
+      end
+
+      def method_missing(name, *args)
+        @doc[name] or super
+      end
+    end
+  end
+end