ansr 0.0.1 → 0.0.3

data/ansr_blacklight/spec/lib/relation/grouping_spec.rb

@@ -0,0 +1,159 @@
+# -*- encoding : utf-8 -*-
+require 'spec_helper'
+
+# check the methods that do solr requests. Note that we are not testing if
+#  solr gives "correct" responses, as that's out of scope (it's a part of
+#  testing the solr code itself).  We *are* testing if blacklight code sends
+#  queries to solr such that it gets appropriate results. When a user does a search,
+#  do we get data back from solr (i.e. did we properly configure blacklight code
+#  to talk with solr and get results)? when we do a document request, does
+#  blacklight code get a single document returned?)
+#
+describe Ansr::Blacklight do
+
+  class TestTable < Ansr::Arel::BigTable
+
+    def [](val)
+      key = (Arel::Attributes::Attribute === val) ? val.name.to_sym : val.to_sym
+      key == :configured ? Ansr::Arel::ConfiguredField.new(key, {:property => 'test', :escape => 'tes"t'}) : super(val)
+    end
+
+    def fields
+      [:id]
+    end
+
+  end
+
+  before do
+    Object.const_set('GroupModel', Class.new(TestModel))
+    GroupModel.solr = stub_solr(sample_response)
+    GroupModel.configure do |config|
+      config[:table_class] = TestTable
+    end
+  end
+
+  after do
+    Object.send(:remove_const, :GroupModel)
+  end
+
+  let(:response) do
+    create_response(sample_response)
+  end
+
+  let(:group) do
+    response.grouped(GroupModel).select { |x| x.key == "result_group_ssi" }.first
+  end
+
+  subject do
+    group.groups.first
+  end
+
+  describe Ansr::Blacklight::Solr::Response::Group do
+    describe "#doclist" do
+      it "should be the raw list of documents from solr" do
+        expect(subject.doclist).to be_a Hash
+        expect(subject.doclist['docs'].first[:id]).to eq 1
+      end
+    end
+
+    describe "#total" do
+      it "should be the number of results found in a group" do
+        expect(subject.total).to eq 2
+      end
+    end
+
+    describe "#start" do
+      it "should be the offset for the results in the group" do
+        expect(subject.start).to eq 0
+      end
+    end
+
+    describe "#docs" do
+      it "should be a list of GroupModels" do
+        subject.docs.each do |doc|
+          expect(doc).to be_a_kind_of GroupModel
+        end
+      
+        expect(subject.docs.first.id).to eq 1
+      end
+    end
+
+    describe "#field" do
+      it "should be the field the group belongs to" do
+        expect(subject.field).to eq "result_group_ssi"
+      end
+    end
+  end
+
+  describe Ansr::Blacklight::Solr::Response do
+    let(:response) do
+      create_response(sample_response)
+    end
+
+    let(:group) do
+      response.grouped(GroupModel).select { |x| x.key == "result_group_ssi" }.first
+    end
+
+    describe "groups" do
+      it "should return an array of Groups" do
+        response.grouped(GroupModel).should be_a Array
+
+        expect(group.groups).to have(2).items
+        group.groups.each do |group|
+          expect(group).to be_a Ansr::Blacklight::Solr::Response::Group
+        end
+      end
+      it "should include a list of SolrDocuments" do
+
+        group.groups.each do |group|
+          group.docs.each do |doc|
+            expect(doc).to be_a GroupModel
+          end
+        end
+      end
+    end
+    
+    describe "total" do
+      it "should return the ngroups value" do
+        expect(group.total).to eq 3
+      end
+    end
+    
+    describe "facets" do
+      it "should exist in the response object (not testing, we just extend the module)" do
+        expect(group).to respond_to :facets
+      end
+    end
+    
+    describe "rows" do
+      it "should get the rows from the response" do
+        expect(group.rows).to eq 3
+      end
+    end
+
+    describe "group_field" do
+      it "should be the field name for the current group" do
+        expect(group.group_field).to eq "result_group_ssi"
+      end
+    end
+
+    describe "group_limit" do
+      it "should be the number of documents to return for a group" do
+        expect(group.group_limit).to eq 5
+      end
+    end
+  end
+
+  def sample_response
+    {"responseHeader" => {"params" =>{"rows" => 3, "group.limit" => 5}},
+     "grouped" => 
+       {'result_group_ssi' => 
+         {'groups' => [{'groupValue'=>"Group 1", 'doclist'=>{'numFound'=>2, 'start' => 0, 'docs'=>[{:id=>1}, {:id => 'x'}]}},
+                       {'groupValue'=>"Group 2", 'doclist'=>{'numFound'=>3, 'docs'=>[{:id=>2}, :id=>3]}}
+                      ],
+          'ngroups' => "3"
+         }
+       }
+    }
+  end
+end

data/ansr_blacklight/spec/spec_helper.rb

@@ -0,0 +1,72 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'app/models'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+ENV["RAILS_ENV"] ||= 'test'
+require 'ansr'
+require 'rails/all'
+require 'rspec/rails'
+require 'loggable'
+require 'ansr_blacklight'
+#require 'blacklight'
+
+RSpec.configure do |config|
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :rspec
+
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+#  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  #config.use_transactional_fixtures = true
+end
+
+def fixture_path(path)
+  File.join(File.dirname(__FILE__), '..', 'fixtures', path)
+end
+
+def fixture path, &block
+  if block_given?
+    open(fixture_path(path)) &block
+  else
+    open(fixture_path(path))
+  end
+end
+
+def read_fixture(path)
+  _f = fixture(path)
+  _f.read
+ensure
+  _f and _f.close
+end
+
+def stub_solr(response='')
+  solr = double('Solr')
+  solr.stub(:send_and_receive).and_return(response)
+  solr
+end
+
+def create_response(response, params = {})
+  Ansr::Blacklight::Solr::Response.new(response, params)
+end
+
+class TestModel < Ansr::Blacklight::Base
+  configure do |config|
+    config[:unique_key] = 'id'
+  end
+  def self.solr=(solr)
+    @solr = solr
+  end
+  def self.solr
+    @solr
+  end
+end

data/ansr_dpla/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/ansr_dpla/Gemfile.lock

@@ -0,0 +1,138 @@
+PATH
+  remote: .
+  specs:
+    ansr_dpla (0.0.1)
+      ansr (= 0.0.1)
+      blacklight (>= 5.1.0)
+      json-ld
+      loggable
+      rest-client
+      sass-rails
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (4.0.3)
+      actionpack (= 4.0.3)
+      mail (~> 2.5.4)
+    actionpack (4.0.3)
+      activesupport (= 4.0.3)
+      builder (~> 3.1.0)
+      erubis (~> 2.7.0)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    activemodel (4.0.3)
+      activesupport (= 4.0.3)
+      builder (~> 3.1.0)
+    activerecord (4.0.3)
+      activemodel (= 4.0.3)
+      activerecord-deprecated_finders (~> 1.0.2)
+      activesupport (= 4.0.3)
+      arel (~> 4.0.0)
+    activerecord-deprecated_finders (1.0.3)
+    activesupport (4.0.3)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    ansr (0.0.1)
+      blacklight (>= 5.1.0)
+      loggable
+    arel (4.0.2)
+    atomic (1.1.15)
+    blacklight (5.2.0)
+      bootstrap-sass (~> 3.0)
+      deprecation
+      kaminari (~> 0.13)
+      nokogiri (~> 1.6)
+      rails (>= 3.2.6, < 5)
+      rsolr (~> 1.0.6)
+    bootstrap-sass (3.1.1.0)
+      sass (~> 3.2)
+    builder (3.1.4)
+    deprecation (0.1.0)
+      activesupport
+    diff-lcs (1.2.5)
+    erubis (2.7.0)
+    hike (1.2.3)
+    i18n (0.6.9)
+    json-ld (1.1.1)
+      rdf (>= 1.0.8)
+    kaminari (0.15.1)
+      actionpack (>= 3.0.0)
+      activesupport (>= 3.0.0)
+    loggable (0.3.0)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.25.1)
+    mini_portile (0.5.2)
+    minitest (4.7.5)
+    multi_json (1.9.0)
+    nokogiri (1.6.1)
+      mini_portile (~> 0.5.0)
+    polyglot (0.3.4)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (4.0.3)
+      actionmailer (= 4.0.3)
+      actionpack (= 4.0.3)
+      activerecord (= 4.0.3)
+      activesupport (= 4.0.3)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.0.3)
+      sprockets-rails (~> 2.0.0)
+    railties (4.0.3)
+      actionpack (= 4.0.3)
+      activesupport (= 4.0.3)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.1.1)
+    rdf (1.1.2.1)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rsolr (1.0.9)
+      builder (>= 2.1.2)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+    sass (3.3.2)
+    sass-rails (4.0.1)
+      railties (>= 4.0.0, < 5.0)
+      sass (>= 3.1.10)
+      sprockets-rails (~> 2.0.0)
+    sprockets (2.12.0)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.0.1)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (~> 2.8)
+    thor (0.18.1)
+    thread_safe (0.2.0)
+      atomic (>= 1.1.7, < 2)
+    tilt (1.4.1)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.39)
+    yard (0.8.7.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ansr_dpla!
+  bundler (>= 1.0.14)
+  rake
+  rspec
+  yard

data/ansr_dpla/README.md

@@ -1,9 +1,9 @@
-adpla
+Ansr::Dpla
 =====
 
 DPLA + ActiveRecord::Relation + Blacklight
 
-This project creates a Rails model that can be used to search the DPLA's public REST API (http://dp.la/info/developers/codex/).
+This project creates a Rails model that can be used to search the DPLA's public REST API (http://dp.la/info/developers/codex/). The goal of this project is to provide an avenue by which data from the DPLA REST API might be explored via a [Blacklight](https://github.com/projectblacklight/blacklight) application. It is proof-of-concept for a broader proposal described at (https://github.com/barmintor/ansr) 
 
 To use the Item and Collection models, they must first be configured with a DPLA API key:
 

data/ansr_dpla/ansr_dpla.gemspec

@@ -7,8 +7,8 @@ Gem::Specification.new do |spec|
   spec.authors = ["Benjamin Armintor"]
   spec.email = ["armintor@gmail.com"]
   spec.summary = 'ActiveRecord-style models and relations for DPLA APIs'
-  spec.description = 'Wrapping the DPLA APIs in Rails-like models and '
-  spec.homepage = 'http://github.com/barmintor/ansr/ansr_dpla'
+  spec.description = 'Wrapping the DPLA APIs in Rails-like models and relations'
+  spec.homepage = 'https://github.com/barmintor/ansr/tree/master/ansr_dpla'
   spec.files         = `git ls-files`.split("\n")
   spec.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }

data/ansr_dpla/lib/ansr_dpla.rb

@@ -1,6 +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/ansr_dpla/lib/ansr_dpla/api.rb

@@ -3,8 +3,8 @@ module Ansr::Dpla
   class Api
     include Ansr::Configurable
 
-    def config(yaml=nil)
-      super
+    def config &block
+      super &block
       raise "DPLA clients must be configured with an API key" unless @config[:api_key]
       @config
     end
@@ -13,7 +13,7 @@ module Ansr::Dpla
     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
+      self.config{|x| x.merge!(config)} if config
     end
 
     def api_key

data/ansr_dpla/lib/ansr_dpla/arel.rb

@@ -2,7 +2,6 @@ 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'
+    require 'ansr_dpla/arel/visitors'
   end
 end

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

@@ -93,12 +93,16 @@ module Ansr::Dpla
 
       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