dbla 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: edd97f400f8dfae0835dc039528d2a3c7871a263
-  data.tar.gz: 898b2b9ebce6a913683681001be63c6fc1b1c8c1
+  metadata.gz: cb8fae248060253ada17d9cbc785ec9bef380173
+  data.tar.gz: f9c302e800a86a250dcbf215b16464e73e07f438
 SHA512:
-  metadata.gz: db96548cea5437ab103e652e8664d443ec57385cc7433bb1975ef6b11b8ecbc9cec4e3efd0a2dd1372213d1d4ac8f72504ce71bb8af9b0ef5c2bcb4dd85928bb
-  data.tar.gz: 441f24c79d6bec54919ffd7edcdc8880cc464f64b19da454ef753849fcea862fd0a5c647420d9a395879866f06b7cc6dda7562924ddd2638efabe111f7d46722
+  metadata.gz: d86878a38f42a993afc633916a57e83a251f78dba365c28cccccaf2035e6528c663ac6bbcdacae8139684b68356bdc8117f5aeefcbc7876643e5bb1732450536
+  data.tar.gz: 37ad200951dfc84c7b99c005daa60465db099b5c4b3857115e402f74f9006ee2f9dee669d6750913f90bd9670bad5836cdd7ed3e3290b26a02a06c73cc1f471a

data/README.md

@@ -0,0 +1,49 @@
+= Dbla
+
+1. Generate a Blacklight app:
+```
+rails new search_app -m https://raw.github.com/projectblacklight/blacklight/master/template.demo.rb
+cd search_app
+```
+
+2. Add the dbla gem to the Gemfile:
+```
+gem "dbla"
+```
+and bundle install.
+
+3. Run the dbla generators:
+```
+rails g dbla:install
+```
+
+4. Create a config/dpla.yml file of the form:
+```
+api_key: 00000000
+api_email: ab@dp.la
+url: http://api.dp.la/v2/
+```
+This file can be stubbed out with a rake task:
+```
+rake dbla:key:get email=my.email@my.server.org
+# get your email
+rake dbla:key:config key=YOURKEY00000000
+```
+5. Configure the CatalogController
+```
+    config.repository_class = Dbla::Repository
+    config.document_model = Item
+    config.response_model = Dbla::Response
+    config.document_presenter_class = Dbla::DocumentPresenter
+    # solr field configuration for search results/index views
+    config.index.title_field = 'sourceResource/title'
+    config.index.thumbnail_field = 'object'
+    config.index.display_type_field = 'format'
+```
+
+6. Fire it up!
+``` rails s```
+
+Go to localhost:3000
+
+Search for kittens!

data/app/assets/stylesheets/dbla/dbla.scss

@@ -0,0 +1,9 @@
+@charset "UTF-8";
+
+DIV.document-thumbnail IMG {
+	width: auto;
+	max-height: 150px;
+	max-width: 100%;
+	vertical-align: middle;
+	border:0;
+}

data/lib/dbla/abstract_response.rb

@@ -26,6 +26,10 @@ module Dbla
       params[:sort]
     end
 
+    # Facets are built from this method's output
+    def aggregations
+      {}
+    end
     # secret api
     def grouped?
       false

data/lib/dbla/response.rb

@@ -6,11 +6,12 @@ module Dbla
       @request_params = request_params
       self.document_model = options[:solr_document_model] || options[:document_model] || Item
       self.blacklight_config = options[:blacklight_config]
-      # {"count":228,"start":0,"limit":10,"docs"
-      @total = data['count']
-      @documents = (data['docs'] || []).map {|d| document_model.new(d,self)}
-      @start = data['start']
-      @limit = data['limit']
+      if data
+        @total = data['count']
+        @documents = (data['docs'] || []).map {|d| document_model.new(d,self)}
+        @start = data['start']
+        @limit = data['limit']
+      end
     end
   end
 end

data/lib/dbla/version.rb

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

data/lib/generators/dbla/assets_generator.rb

@@ -0,0 +1,10 @@
+# -*- encoding : utf-8 -*-
+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
+  end
+end

data/lib/generators/dbla/install_generator.rb

@@ -0,0 +1,35 @@
+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"
+
+    desc """
+  This generator makes the following changes to your application:
+   1. Generates dbla:models
+   3. Creates a stylesheet
+   2. Adds Dbla routes to your ./config/routes.rb
+         """
+
+    # 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 
+      generate "dbla:assets"
+    end
+    
+    def generate_search_builder
+      generate 'dbla:search_builder', search_builder_name
+    end
+
+    def generate_dbla_models
+      generate 'dbla:models'
+    end
+
+    def generate_dbla_routes
+      generate 'dbla:routes'
+    end
+  end
+end

data/lib/generators/dbla/models_generator.rb

@@ -1,7 +1,7 @@
 require 'rails/generators'
 
 module Dbla
-  class DocumentGenerator < Rails::Generators::Base
+  class ModelsGenerator < Rails::Generators::Base
     include Rails::Generators::Migration
 
     source_root File.expand_path('../templates', __FILE__)

data/lib/generators/dbla/routes_generator.rb

@@ -10,7 +10,7 @@ module Dbla
    1. Adds routes for your controller
          """
 
-    def inject_blacklight_routes
+    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. 

data/lib/generators/dbla/templates/dbla.css.scss

@@ -0,0 +1 @@
+@import 'dbla/dbla';

data/lib/tasks/dbla_key.rake

@@ -14,7 +14,7 @@ module Dbla
     end
   end
 end
-namespace :Dbla do
+namespace :dbla do
   namespace :key do
     task get: :environment do
       if ENV['email']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dbla
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Audrey Altman
@@ -90,9 +90,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
+- README.md
 - Rakefile
 - app/assets/javascripts/dbla/application.js
-- app/assets/stylesheets/dbla/application.css
+- app/assets/stylesheets/dbla/dbla.scss
 - app/controllers/dbla/application_controller.rb
 - app/helpers/dbla/application_helper.rb
 - app/views/layouts/dbla/application.html.erb
@@ -106,10 +107,13 @@ files:
 - lib/dbla/routes.rb
 - lib/dbla/search_builder_behavior.rb
 - lib/dbla/version.rb
+- lib/generators/dbla/assets_generator.rb
+- lib/generators/dbla/install_generator.rb
 - lib/generators/dbla/models_generator.rb
 - lib/generators/dbla/routes_generator.rb
 - lib/generators/dbla/search_builder_generator.rb
 - lib/generators/dbla/templates/collection.rb
+- lib/generators/dbla/templates/dbla.css.scss
 - lib/generators/dbla/templates/item.rb
 - lib/generators/dbla/templates/search_builder.rb
 - lib/tasks/dbla_key.rake

data/app/assets/stylesheets/dbla/application.css

@@ -1,15 +0,0 @@
-/*
- * This is a manifest file that'll be compiled into application.css, which will include all the files
- * listed below.
- *
- * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
- * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
- *
- * You're free to add application-wide styles to this file and they'll appear at the bottom of the
- * compiled file so the styles you add here take precedence over styles defined in any styles
- * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
- * file per style scope.
- *
- *= require_tree .
- *= require_self
- */