dbla 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b511243621c7428086b96e4b807c3900dddd1264
-  data.tar.gz: c46a5e41a85489dd58e189adc67859699bd7adb8
+  metadata.gz: 7ec4c36f34bce118a8f7742e32040622e68c76d8
+  data.tar.gz: 44f112fa2dd872c43aaa9c93394c5f995a4ce733
 SHA512:
-  metadata.gz: 54793d19643fd0c7854c1ef8f1e98720ea0c4b46ad1493265ae6bef4527369ff060e7a6d0914c2ea4fcc526ec21337fe21a60e5af72c736fda9edbbfd4f0fcec
-  data.tar.gz: 54a4c98894f0e24f4b1fbeb868b10b1941402bb2b9d1174bf82567a4af5c093672b6dfbe5795b9057119a8ff67c879cbad2893f3193a0b8db08f99a71263f836
+  metadata.gz: fef1b5003cbb9895b39ec794e9eece9e5dfeb4bfd173c7d48e40fc9a80f9b1007b82fb657a18ae408595a2d2533140fd9ad62bb4b4c7dae72647e1e3b72155a5
+  data.tar.gz: 0b86c1b40dd2cae506feb38ec78dcae7e53d048e6bd6160895e75eb80bcae7ae65a4816bf6909f6032afa20633e4b4c1f86316f3aa7f09722659d770d083cdc3

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2015 YOURNAME
+Copyright 2015 Audrey Altman, Ben Armintor, Jeremy Friesen
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,36 +1,60 @@
 = Dbla
 
+Access [DPLA](http://dp.la)'s API via the [Blacklight](http://projectblacklight.org/) search interface.
+
+## Installation
+
 1. Generate a Blacklight app:
-```
-rails new search_app -m https://raw.github.com/projectblacklight/blacklight/master/template.demo.rb
-cd search_app
+
+```console
+$ 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:
-```
+
+```ruby
 gem "dbla"
 ```
 and bundle install.
 
 3. Run the dbla generators:
-```
-rails g dbla:install
-```
 
-4. Create a config/dpla.yml file of the form:
+```console
+$ rails g dbla:install
 ```
-api_key: 00000000
-api_email: ab@dp.la
+
+4. Create a config/dpla.yml file of the form
+
+```yml
+api_key: <your-api-key
+api_email: <your-email-that-you-used-for-your-api-key>
 url: http://api.dp.la/v2/
 ```
+
+Find out how to [request your DPLA API key](http://dp.la/info/developers/codex/policies/#get-a-key)
+
 This file can be stubbed out with a rake task:
+
+```console
+$ rake dbla:key:get email=my.email@my.server.org
+# get your email from DPLA
+$ rake dbla:key:config key=YOURKEY00000000
 ```
-rake dbla:key:get email=my.email@my.server.org
-# get your email
-rake dbla:key:config key=YOURKEY00000000
-```
+
 5. Configure the CatalogController
+
+Replace the following code in your CatalogController:
+
+```ruby
+    # solr field configuration for search results/index views
+    config.index.title_field = 'title_display'
+    config.index.display_type_field = 'format'
 ```
+
+With the Dbla options.
+
+```ruby
     config.repository_class = Dbla::Repository
     config.document_model = Item
     config.response_model = Dbla::Response
@@ -42,8 +66,11 @@ rake dbla:key:config key=YOURKEY00000000
 ```
 
 6. Fire it up!
-``` rails s```
 
-Go to localhost:3000
+```console
+$ rails s
+```
+
+Open your browser and go to [localhost:3000](http://localhost:3000).
 
 Search for kittens!

data/Rakefile

@@ -14,21 +14,11 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
 load 'rails/tasks/engine.rake'
 
-
-
 Bundler::GemHelper.install_tasks
 
-require 'rake/testtask'
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
-end
-
+require 'rspec/core/rake_task'
 
-task default: :test
+task default: 'app:spec'

data/lib/dbla/abstract_response.rb

@@ -14,15 +14,11 @@ module Dbla
       header['params'] || request_params
     end
 
-    def start
-      @start
-    end
-
-    def rows
-      @limit
-    end
+    alias_method :rows, :limit
 
     def sort
+      # REVIEW: There are mixed style key accesses (strings and symbols);
+      # Could/Should this be "normalized"?
       params[:sort]
     end
 

data/lib/dbla/version.rb

@@ -1,3 +1,3 @@
 module Dbla
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/lib/tasks/dbla_key.rake

@@ -4,9 +4,9 @@ module Dbla
   module ApiKey
     RESOURCE = 'http://api.dp.la/v2/api_key/'.freeze
     USAGE = {
-      get:    "       rake Dbla:key:get email=YOUR.EMAIL@SERVER.ORG",
-      config: "       rake Dbla:key:config key=YOURKEY000000000000000000000000",
-      report: "       rake Dbla:key:report",
+      get:    "       rake dbla:key:get email=YOUR.EMAIL@SERVER.ORG",
+      config: "       rake dbla:key:config key=YOURKEY000000000000000000000000",
+      report: "       rake dbla:key:report",
     }
     def self.usage(key=:all)
       puts "Usage:"
@@ -18,7 +18,7 @@ namespace :dbla do
   namespace :key do
     task get: :environment do
       if ENV['email']
-        uri = URI(RESOURCE + email)
+        uri = URI(Dbla::ApiKey::RESOURCE + ENV['email'])
         Net::HTTP.start(uri.host, uri.port) do |http|
           request = Net::HTTP::Post.new uri
           response = http.request request
@@ -43,8 +43,10 @@ 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'])
+        config = YAML.load(File.read(Dbla.config_path))
+        config['api_key'] = ENV['key']
+        open(Dbla.config_path,'w') do |blob|
+          blob.write YAML.dump(config)
         end
       else
         Dbla::ApiKey.usage(:config)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dbla
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Audrey Altman