RubyGems - dbla - Versions diffs - 0.0.1 - Mend

dbla 0.0.1

Files changed (63) hide show

checksums.yaml +7 -0
data/LICENSE +20 -0
data/Rakefile +34 -0
data/app/assets/javascripts/dbla/application.js +13 -0
data/app/assets/stylesheets/dbla/application.css +15 -0
data/app/controllers/dbla/application_controller.rb +4 -0
data/app/helpers/dbla/application_helper.rb +4 -0
data/app/views/layouts/dbla/application.html.erb +14 -0
data/config/routes.rb +2 -0
data/lib/dbla.rb +15 -0
data/lib/dbla/abstract_response.rb +54 -0
data/lib/dbla/document_presenter.rb +111 -0
data/lib/dbla/engine.rb +5 -0
data/lib/dbla/repository.rb +45 -0
data/lib/dbla/response.rb +16 -0
data/lib/dbla/routes.rb +44 -0
data/lib/dbla/search_builder_behavior.rb +4 -0
data/lib/dbla/version.rb +3 -0
data/lib/generators/dbla/models_generator.rb +19 -0
data/lib/generators/dbla/routes_generator.rb +20 -0
data/lib/generators/dbla/search_builder_generator.rb +20 -0
data/lib/generators/dbla/templates/collection.rb +45 -0
data/lib/generators/dbla/templates/item.rb +45 -0
data/lib/generators/dbla/templates/search_builder.rb +3 -0
data/lib/tasks/dbla_key.rake +57 -0
data/spec/dbla_spec.rb +7 -0
data/spec/dummy/README.rdoc +28 -0
data/spec/dummy/Rakefile +6 -0
data/spec/dummy/app/assets/javascripts/application.js +13 -0
data/spec/dummy/app/assets/stylesheets/application.css +15 -0
data/spec/dummy/app/controllers/application_controller.rb +5 -0
data/spec/dummy/app/helpers/application_helper.rb +2 -0
data/spec/dummy/app/views/layouts/application.html.erb +14 -0
data/spec/dummy/bin/bundle +3 -0
data/spec/dummy/bin/rails +4 -0
data/spec/dummy/bin/rake +4 -0
data/spec/dummy/config.ru +4 -0
data/spec/dummy/config/application.rb +23 -0
data/spec/dummy/config/boot.rb +5 -0
data/spec/dummy/config/database.yml +25 -0
data/spec/dummy/config/environment.rb +5 -0
data/spec/dummy/config/environments/development.rb +37 -0
data/spec/dummy/config/environments/production.rb +78 -0
data/spec/dummy/config/environments/test.rb +39 -0
data/spec/dummy/config/initializers/assets.rb +8 -0
data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
data/spec/dummy/config/initializers/cookies_serializer.rb +3 -0
data/spec/dummy/config/initializers/filter_parameter_logging.rb +4 -0
data/spec/dummy/config/initializers/inflections.rb +16 -0
data/spec/dummy/config/initializers/mime_types.rb +4 -0
data/spec/dummy/config/initializers/session_store.rb +3 -0
data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
data/spec/dummy/config/locales/en.yml +23 -0
data/spec/dummy/config/routes.rb +4 -0
data/spec/dummy/config/secrets.yml +22 -0
data/spec/dummy/db/test.sqlite3 +0 -0
data/spec/dummy/log/test.log +0 -0
data/spec/dummy/public/404.html +67 -0
data/spec/dummy/public/422.html +67 -0
data/spec/dummy/public/500.html +66 -0
data/spec/dummy/public/favicon.ico +0 -0
data/spec/spec_helper.rb +11 -0
metadata +215 -0

checksums.yaml ADDED

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: edd97f400f8dfae0835dc039528d2a3c7871a263
+  data.tar.gz: 898b2b9ebce6a913683681001be63c6fc1b1c8c1
+SHA512:
+  metadata.gz: db96548cea5437ab103e652e8664d443ec57385cc7433bb1975ef6b11b8ecbc9cec4e3efd0a2dd1372213d1d4ac8f72504ce71bb8af9b0ef5c2bcb4dd85928bb
+  data.tar.gz: 441f24c79d6bec54919ffd7edcdc8880cc464f64b19da454ef753849fcea862fd0a5c647420d9a395879866f06b7cc6dda7562924ddd2638efabe111f7d46722

data/LICENSE ADDED

@@ -0,0 +1,20 @@
+Copyright 2015 YOURNAME
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile ADDED

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+require 'rdoc/task'
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Dbla'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+APP_RAKEFILE = File.expand_path("../test/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
+task default: :test

data/app/assets/javascripts/dbla/application.js ADDED

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

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

@@ -0,0 +1,15 @@
+/*
+ * 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
+ */

data/app/controllers/dbla/application_controller.rb ADDED

@@ -0,0 +1,4 @@
+module Dbla
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/dbla/application_helper.rb ADDED

@@ -0,0 +1,4 @@
+module Dbla
+  module ApplicationHelper
+  end
+end

data/app/views/layouts/dbla/application.html.erb ADDED

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dbla</title>
+  <%= stylesheet_link_tag    "dbla/application", media: "all" %>
+  <%= javascript_include_tag "dbla/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+<%= yield %>
+</body>
+</html>

data/config/routes.rb ADDED

	@@ -0,0 +1,2 @@
1	+ Dbla::Engine.routes.draw do
2	+ end

data/lib/dbla.rb ADDED

@@ -0,0 +1,15 @@
+require "dbla/engine"
+module Dbla
+  def self.config_path
+    @config_path ||= File.join(Rails.root,'config','dpla.yml').freeze
+  end
+  def self.config
+    @config ||= YAML.load(File.read(config_path)).symbolize_keys
+  end
+  autoload :AbstractResponse, 'dbla/abstract_response'
+  autoload :DocumentPresenter, 'dbla/document_presenter'
+  autoload :Repository, 'dbla/repository'
+  autoload :Response, 'dbla/response'
+  autoload :Routes, 'dbla/routes'
+end

data/lib/dbla/abstract_response.rb ADDED

@@ -0,0 +1,54 @@
+# -*- encoding : utf-8 -*-
+module Dbla
+  class AbstractResponse < HashWithIndifferentAccess
+    require  'blacklight/solr_response/pagination_methods'
+    include Blacklight::SolrResponse::PaginationMethods
+    # secret api
+    attr_accessor :document_model, :blacklight_config, :total, :documents, :start, :limit, :request_params
+    def header
+      self['responseHeader'] || {}
+    end
+    def params
+      header['params'] || request_params
+    end
+    def start
+      @start
+    end
+    def rows
+      @limit
+    end
+    def sort
+      params[:sort]
+    end
+    # secret api
+    def grouped?
+      false
+    end
+    def more_like(doc)
+      []
+    end
+    private
+    # borrowed from Blacklight::SolrRepository
+    def force_to_utf8(value)
+      case value
+      when Hash
+        value.each { |k, v| value[k] = force_to_utf8(v) }
+      when Array
+        value.each { |v| force_to_utf8(v) }
+      when String
+        value.force_encoding("utf-8")  if value.respond_to?(:force_encoding)
+      end
+      value
+    end
+  end
+end

data/lib/dbla/document_presenter.rb ADDED

@@ -0,0 +1,111 @@
+module Dbla
+  class DocumentPresenter
+    include ActionView::Helpers::OutputSafetyHelper
+    include ActionView::Helpers::TagHelper
+    extend Deprecation
+    # @param [Item or Collection] document
+    # @param [ActionController::Base] controller scope for linking and generating urls
+    # @param [Blacklight::Configuration] configuration
+    def initialize(document, controller, configuration = controller.blacklight_config)
+      @document = document
+      @configuration = configuration
+      @controller = controller
+    end
+    ##
+    # Get the value of the document's "title" field, or a placeholder
+    # value (if empty)
+    #
+    # @param [SolrDocument] document
+    # @return [String]
+    def document_heading
+      @document['sourceResource']['title']
+    end
+    ##
+    # Get the document's "title" to display in the <title> element.
+    # (by default, use the #document_heading)
+    #
+    # @see #document_heading
+    # @return [String]
+    def document_show_html_title
+      @document['sourceResource']['title']
+    end
+    ##
+    # Render a value (or array of values) from a field
+    #
+    # @param [String] value or list of values to display
+    # @param [Blacklight::Solr::Configuration::Field] solr field configuration
+    # @return [String]
+    def render_field_value value=nil, field_config=nil
+    end
+    ##
+    # Render the document index heading
+    #
+    # @param [Hash] opts (Deprecated)
+    # @option opts [Symbol] :label Render the given field from the document
+    # @option opts [Proc] :label Evaluate the given proc
+    # @option opts [String] :label Render the given string
+    # @param [Symbol, Proc, String] field Render the given field or evaluate the proc or render the given string
+    def render_document_index_label field, opts ={}
+      if Symbol === field
+        # these are shenanigans to find a nested field
+        field.to_s.split('/').inject(@document) {|m,v| m[v]}
+      elsif Proc === field
+        field.call
+      else
+        field
+      end
+    end
+    ##
+    # Render the index field label for a document
+    #
+    #   Allow an extention point where information in the document
+    #   may drive the value of the field
+    #   @param [String] field
+    #   @param [Hash] opts
+    #   @options opts [String] :value
+    def render_index_field_value field, options = {}
+    end
+    ##
+    # Render the show field value for a document
+    #
+    #   Allow an extention point where information in the document
+    #   may drive the value of the field
+    #   @param [String] field
+    #   @param [Hash] options
+    #   @options opts [String] :value
+    def render_document_show_field_value field, options={}
+    end
+    ##
+    # Get the value for a document's field, and prepare to render it.
+    # - highlight_field
+    # - accessor
+    # - solr field
+    #
+    # Rendering:
+    #   - helper_method
+    #   - link_to_search
+    # TODO : maybe this should be merged with render_field_value, and the ugly signature
+    # simplified by pushing some of this logic into the "model"
+    # @param [SolrDocument] document
+    # @param [String] field name
+    # @param [Blacklight::Solr::Configuration::Field] solr field configuration
+    # @param [Hash] options additional options to pass to the rendering helpers
+    def get_field_values field, field_config, options = {}
+    end
+    ##
+    # Default separator to use in #render_field_value
+    #
+    # @return [String]
+    def field_value_separator
+      ', '
+    end
+  end
+end

data/lib/dbla/engine.rb ADDED

@@ -0,0 +1,5 @@
+module Dbla
+  class Engine < ::Rails::Engine
+    isolate_namespace Dbla
+  end
+end

data/lib/dbla/repository.rb ADDED

@@ -0,0 +1,45 @@
+module Dbla
+  class Repository < Blacklight::AbstractRepository
+    extend Deprecation
+    self.deprecation_horizon = 'blacklight 6.0'
+    def find id, params = {}
+      data = get("#{url}/#{id}?api_key=#{api_key}")
+      Response.new(data, params,{})
+    end
+    def search params = {}
+      data = nil
+      #TODO Move this into a SearchBuilder, add a generator
+      if params['q']
+        q = "?api_key=#{api_key}&q=#{params['q']}"
+        if params.page
+            q << "&page=#{params.page}"
+        end
+        if params.rows
+            q << "&page_size=#{params.rows}"
+        end
+        puts url + q
+        data = get(url + q)
+      end
+      Response.new(data, params,{})
+    end
+    def get(uri)
+      uri = URI(uri)
+      Net::HTTP.start(uri.host, uri.port) do |http|
+        request = Net::HTTP::Get.new uri
+        response = http.request request
+        return JSON.parse(response.body)
+      end
+    end
+    def api_key
+      Dbla.config[:api_key]
+    end
+    def url
+      @url ||= (Dbla.config[:url] + blacklight_config.document_model.name.downcase.pluralize).freeze
+    end
+  end
+end

data/lib/dbla/response.rb ADDED

@@ -0,0 +1,16 @@
+# -*- encoding : utf-8 -*-
+module Dbla
+  class Response < AbstractResponse
+    def initialize(data, request_params, options = {})
+      super(force_to_utf8(data))
+      @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']
+    end
+  end
+end

data/lib/dbla/routes.rb ADDED

@@ -0,0 +1,44 @@
+# -*- encoding : utf-8 -*-
+module Dbla
+  class Routes < Blacklight::Routes
+    def self.for(router, *resources)
+        raise_no_blacklight_secret_key unless Blacklight.secret_key
+        options = resources.extract_options!
+        resources.map!(&:to_sym)
+        Dbla::Routes.new(router, options.merge(resources: resources)).draw
+    end
+    def draw
+      item_routing(primary_resource)
+      collection_routing(primary_resource)
+    end
+    def item_routing(primary_resource)
+      add_routes do |options|
+        args = {only: [:show]}
+        args[:constraints] = options[:constraints] if options[:constraints]
+        resources :item, args.merge(path: primary_resource, controller: primary_resource) do
+          member do
+            post "track"
+          end
+        end
+      end
+    end
+    def collection_routing(primary_resource)
+      add_routes do |options|
+        args = {only: [:show]}
+        args[:constraints] = options[:constraints] if options[:constraints]
+        resources :collection, args.merge(path: primary_resource, controller: primary_resource) do
+          member do
+            post "track"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dbla/search_builder_behavior.rb ADDED

@@ -0,0 +1,4 @@
+module Dbla
+  module SearchBuilderBehavior
+  end
+end

data/lib/dbla/version.rb ADDED

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

data/lib/generators/dbla/models_generator.rb ADDED

@@ -0,0 +1,19 @@
+require 'rails/generators'
+module Dbla
+  class DocumentGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+    source_root File.expand_path('../templates', __FILE__)
+    desc """
+This generator makes the following changes to your application:
+ 1. Creates the Item and Collection in your /app/models directory
+"""
+    def create_models
+      template "item.rb", "app/models/item.rb"
+      template "collection.rb", "app/models/collection.rb"
+    end
+  end
+end