supplejack_client 1.0.1

data/lib/supplejack/user_set_relation.rb

@@ -0,0 +1,143 @@
+# The Supplejack Client code is Crown copyright (C) 2014, New Zealand Government,
+# and is licensed under the GNU General Public License, version 3.
+# See https://github.com/DigitalNZ/supplejack_client for details.
+#
+# Supplejack was created by DigitalNZ at the National Library of NZ
+# and the Department of Internal Affairs. http://digitalnz.org/supplejack
+
+module Supplejack
+
+  # The +UserSetRelation+ class provides ActiveRecord like functionality to the
+  # relationship between a User object and it's UserSet objects.
+  # 
+  # @exmaple 
+  #   user = Supplejack::User.find(1)
+  #
+  #   user.sets.build({name: "Dogs and cats"})    => Returns a new UserSet object linked to the User
+  #   user.sets.find(123)                         => Return a UserSet object which belongs to the User
+  #   user.sets.order(:name)                      => Return a array of UserSet objects ordered by name
+  #
+  class UserSetRelation
+    include Supplejack::Request
+
+    attr_reader :user
+
+    def initialize(user)
+      @user = user
+    end
+
+    # Returns an array of UserSet objects and memoizes the array 
+    #
+    def sets
+      @sets ||= self.fetch_sets
+    end
+
+    # Initialize an array of UserSet objects and orders them by priority.
+    #
+    # @return [ Array ] A Array of +Supplejack::UserSet+ objects
+    #
+    def fetch_sets
+      response = sets_response
+      sets_array = response["sets"] || []
+      @sets = sets_array.map {|attributes| Supplejack::UserSet.new(attributes) }.sort_by { |set| set.priority }
+    end
+
+    # Execute a GET request to the API to retrieve the user_sets from a User.
+    # It caches the response from the API for a day. The cache is invalidated
+    # every time any set for the user changes.
+    #
+    # @return [ Hash ] A hash parsed from a JSON string. See the API Documentation for more details.
+    #
+    def sets_response
+      params = {}
+
+      if user.use_own_api_key?
+        path = "/sets"
+        params[:api_key] = user.api_key
+      else
+        path = "/users/#{user.api_key}/sets"
+      end
+
+      if Supplejack.enable_caching
+        Rails.cache.fetch(path, expires_in: 1.day) do
+          get(path, params)
+        end
+      else
+        get(path, params)
+      end
+    end
+
+    # Finds a UserSet object with the provided ID that belongs to the current
+    # User
+    #
+    # @param [ String ] A 24 character string representing the UserSet ID
+    #
+    # @return [ Supplejack::UserSet ] A UserSet object
+    #
+    def find(user_set_id)
+      Supplejack::UserSet.find(user_set_id, self.user.api_key)
+    end
+
+    # Initializes a new UserSet object and links it to the current User
+    #
+    # @param [ Hash ] A hash with the UserSet field names and values
+    #
+    # @return [ Supplejack::UserSet] A new UserSet object 
+    #
+    def build(attributes={})
+      user_set = Supplejack::UserSet.new(attributes)
+      user_set.api_key = user.api_key
+      user_set
+    end
+
+    # Build and persist a UserSet object with the provided attributes
+    #
+    # @param [ Hash ] A hash with the UserSet field names and values
+    #
+    # @return [ Supplejack::UserSet ] A persisted UserSet object
+    #
+    def create(attributes={})
+      user_set = self.build(attributes)
+      user_set.save
+      user_set
+    end
+
+    # Return a array of UserSet objects ordered by the priority first and then
+    # in ascending order by the specified attribute.
+    # 
+    # The only exception is for the "updated_at" attribute, for which ignores
+    # the priority and orders on descending order.
+    #
+    # @param [ Symbol ] A symbol with the attribute to order the UserSet objects on.
+    #
+    # @return [ Array ] A array of Supplejack::UserSet objects.
+    # 
+    def order(attribute)
+      @sets = sets.sort_by do |set|
+        value = set.send(attribute)
+        value = value.downcase if value.is_a?(String)
+        attribute == :updated_at ? value : [set.priority, value]
+      end
+      @sets = @sets.reverse if attribute == :updated_at
+      @sets
+    end
+
+    # Returns an array of all UserSet objects for the current User
+    # 
+    def all
+      self.sets
+    end
+
+    # Any method missing on this class is delegated to the UserSet objects array
+    # so that the developer can easily execute any Array method on the UserSetRelation
+    #
+    # @example
+    #   user.sets.each ....     => Iterate through the UserSet objects array
+    #   user.sets.size          => Get the size of the UserSet objects array
+    # 
+    def method_missing(method, *args, &block)
+      sets.send(method, *args, &block)
+    end
+
+  end
+end

data/lib/supplejack/util.rb

@@ -0,0 +1,120 @@
+# The Supplejack Client code is Crown copyright (C) 2014, New Zealand Government,
+# and is licensed under the GNU General Public License, version 3.
+# See https://github.com/DigitalNZ/supplejack_client for details.
+#
+# Supplejack was created by DigitalNZ at the National Library of NZ
+# and the Department of Internal Affairs. http://digitalnz.org/supplejack
+
+module Supplejack
+  module Util
+    
+    class << self
+      
+      #
+      # Return a array no matter what.
+      #
+      def array(object)
+        case object
+        when Array
+          object
+        when NilClass
+          []
+        else
+          [object]
+        end
+      end
+
+      #
+      # Try to parse any string into a Time object
+      #
+      def time(time)
+        begin
+          if time.is_a?(String)
+            time = Time.parse(time)
+          elsif time.is_a?(Time) || time.is_a?(DateTime)
+            time = time
+          end
+        rescue
+          time = nil
+        end
+
+        time
+      end
+      # 
+      # Perform a deep merge of hashes, returning the result as a new hash.
+      # See #deep_merge_into for rules used to merge the hashes
+      #
+      # ==== Parameters
+      #
+      # left<Hash>:: Hash to merge
+      # right<Hash>:: The other hash to merge
+      #
+      # ==== Returns
+      #
+      # Hash:: New hash containing the given hashes deep-merged.
+      #
+      def deep_merge(left, right)
+        deep_merge_into({}, left, right)
+      end
+
+      # 
+      # Perform a deep merge of the right hash into the left hash
+      #
+      # ==== Parameters
+      #
+      # left:: Hash to receive merge
+      # right:: Hash to merge into left
+      #
+      # ==== Returns
+      #
+      # Hash:: left
+      #
+      def deep_merge!(left, right)
+        deep_merge_into(left, left, right)
+      end
+
+      private
+
+      # 
+      # Deep merge two hashes into a third hash, using rules that produce nice
+      # merged parameter hashes. The rules are as follows, for a given key:
+      #
+      # * If only one hash has a value, or if both hashes have the same value,
+      #   just use the value.
+      # * If either of the values is not a hash, create arrays out of both
+      #   values and concatenate them.
+      # * Otherwise, deep merge the two values (which are both hashes)
+      #
+      # ==== Parameters
+      #
+      # destination<Hash>:: Hash into which to perform the merge
+      # left<Hash>:: One hash to merge
+      # right<Hash>:: The other hash to merge
+      #
+      # ==== Returns
+      #
+      # Hash:: destination
+      #
+      def deep_merge_into(destination, left, right)
+        left.to_hash.symbolize_keys!
+        right.to_hash.symbolize_keys!
+        left.each_pair do |name, left_value|
+          right_value = right[name] if right
+          destination[name] =
+            if right_value.nil? || left_value == right_value
+              left_value
+            elsif !left_value.respond_to?(:each_pair) || !right_value.respond_to?(:each_pair)
+              Array(left_value) + Array(right_value)
+            else
+              merged_value = {}
+              deep_merge_into(merged_value, left_value, right_value)
+            end
+        end
+        left_keys = Set.new(left.keys)
+        destination.merge!(right.reject { |k, v| left_keys.include?(k) })
+        destination
+      end
+    end
+    
+  end
+end

data/lib/supplejack/version.rb

@@ -0,0 +1,10 @@
+# The Supplejack Client code is Crown copyright (C) 2014, New Zealand Government,
+# and is licensed under the GNU General Public License, version 3.
+# See https://github.com/DigitalNZ/supplejack_client for details.
+#
+# Supplejack was created by DigitalNZ at the National Library of NZ
+# and the Department of Internal Affairs. http://digitalnz.org/supplejack
+
+module Supplejack
+  VERSION = '1.0.1'
+end

data/lib/supplejack_client.rb

@@ -0,0 +1,29 @@
+# The Supplejack Client code is Crown copyright (C) 2014, New Zealand Government,
+# and is licensed under the GNU General Public License, version 3.
+# See https://github.com/DigitalNZ/supplejack_client for details.
+#
+# Supplejack was created by DigitalNZ at the National Library of NZ
+# and the Department of Internal Affairs. http://digitalnz.org/supplejack
+
+require 'supplejack/config'
+require 'supplejack/version'
+
+module Supplejack
+  extend Config
+  
+  require 'supplejack/engine'
+  require 'supplejack/exceptions'
+  require 'supplejack/log_subscriber'
+  require 'supplejack/record'
+  require "supplejack/request"
+  require 'supplejack/paginated_collection'
+  require 'supplejack/controllers/helpers'
+  require 'supplejack/url_formats/item_hash'
+  require 'supplejack/util'
+  require 'supplejack/facet'
+  require 'supplejack/user_set'
+  require 'supplejack/item_relation'
+  require 'supplejack/item'
+  require 'supplejack/user'
+  require 'supplejack/user_set_relation'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+# The Supplejack Client code is Crown copyright (C) 2014, New Zealand Government,
+# and is licensed under the GNU General Public License, version 3.
+# See https://github.com/DigitalNZ/supplejack_client for details.
+#
+# Supplejack was created by DigitalNZ at the National Library of NZ
+# and the Department of Internal Affairs. http://digitalnz.org/supplejack
+
+require 'rubygems'
+require 'bundler/setup'
+
+Bundler.require(:default)
+
+require 'supplejack_client'
+require 'active_support/all'
+
+RSpec.configure do |config|
+  # some (optional) config here
+  config.mock_with :rspec
+  
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+end

data/spec/supplejack/controllers/helpers_spec.rb

@@ -0,0 +1,277 @@
+# The Supplejack Client code is Crown copyright (C) 2014, New Zealand Government,
+# and is licensed under the GNU General Public License, version 3.
+# See https://github.com/DigitalNZ/supplejack_client for details.
+#
+# Supplejack was created by DigitalNZ at the National Library of NZ
+# and the Department of Internal Affairs. http://digitalnz.org/supplejack
+
+require 'spec_helper'
+require 'action_view'
+require 'action_controller'
+require 'rails_autolink/helpers'
+
+include ActionView::Context
+
+module FakeRoutes
+  def records_path(options={})
+    path = '/records'
+    path += "?#{options.to_query}" if options.any?
+    path
+  end
+
+  def record_path(id, options={})
+    path = "/records/#{id}"
+    path += "?#{options.to_query}" if options.any?
+    path
+  end
+
+  def url_for(options={})
+    options
+  end
+end
+
+def mock_record(stubs={})
+  (@mock_record ||= double(:record).as_null_object).tap do |record|
+    record.stub(stubs) unless stubs.empty?
+  end
+end
+
+class AdvancedSearch < Supplejack::Search
+end
+
+module Supplejack
+  module Controllers
+    describe Helpers do
+
+      before(:each) do
+        @c = ActionController::Base.new
+        @c.class.send(:include, FakeRoutes)
+        @c.class.send(:include, Supplejack::Controllers::Helpers)
+        @c.class.send(:include, ActionView::Helpers)
+      end
+
+      describe '#search' do
+        before(:each) do
+          @c.stub(:params) {{:text => 'dog'}}
+        end
+
+        it 'initializes a search object with the params' do
+          Supplejack::Search.should_receive(:new).with({:text => 'dog'})
+          @c.search
+        end
+
+        it 'tries to initialize with params[:search] ' do
+          @c.stub(:params) {{:search => {:text => 'cat'}}}
+          Supplejack::Search.should_receive(:new).with({:text => 'cat'})
+          @c.search
+        end
+
+        it 'initializes the search with the passed params' do
+          Supplejack::Search.should_receive(:new).with({:text => 'elephant'})
+          @c.search({:text => 'elephant'})
+        end
+
+        it 'uses the special Search class' do
+          Supplejack.stub(:search_klass) { 'AdvancedSearch' }
+          AdvancedSearch.should_receive(:new).with({:text => 'dog'})
+          @c.search
+        end
+
+        it 'memoizes the search object' do
+          @search = Supplejack::Search.new
+          Supplejack::Search.should_receive(:new).once.and_return(@search)
+          @c.search
+          @c.search
+        end
+      end
+
+      describe 'attribute' do
+        context 'nested attributes' do
+          before(:each) do
+            @user_set = Supplejack::UserSet.new(user: {name: 'Juanito'})
+          end
+
+          it 'supports nested attributes' do
+            @c.attribute(@user_set, 'user.name').should eq %{<p><strong>User.name: </strong>Juanito</p>}
+          end
+
+          it 'correctly uses the translation for the label' do
+            I18n.should_receive(:t).with('supplejack_user_sets.user.name', default: 'User.name') { 'By' }
+            @c.attribute(@user_set, 'user.name')
+          end
+        end
+        
+        context 'single value' do
+          before(:each) do
+            @record = mock_record({:title => 'Wellington', :content_partner => '', :description => nil})
+          end
+
+          it 'returns the attribute name and its value' do
+            @c.attribute(@record, :title).should eq %{<p><strong>Title: </strong>Wellington</p>}
+          end
+
+          it 'uses a div instead of a p' do
+            @c.attribute(@record, :title, {:tag => :div}).should eq %{<div><strong>Title: </strong>Wellington</div>}
+          end
+          
+          it 'does not use a tag if tag option is nil' do
+            @c.attribute(@record, :title, {:tag => nil}).should eq %{<strong>Title: </strong>Wellington}
+          end
+  
+          it 'truncates the content to 5 characters' do
+            @c.attribute(@record, :title, {:limit => 8}).should eq %{<p><strong>Title: </strong>Welli...</p>}
+          end
+
+          it 'puts the label and the field value on seperate lines if label_inle is false' do
+            @c.attribute(@record, :title, {:label_inline => false}).should eq %{<p><strong>Title: </strong><br/>Wellington</p>}
+          end
+          
+          it 'removes the label' do
+            @c.attribute(@record, :title, {:label => false}).should eq %{<p>Wellington</p>}
+          end
+
+          it 'doesn\'t display anything when the value is nil' do
+            @c.attribute(@record, :content_partner).should be_nil
+            @c.attribute(@record, :description).should be_nil
+          end
+
+          it 'displays span label tag' do
+            @c.attribute(@record, :title, {:label_tag => :span}).should eq %{<p><span>Title: </span>Wellington</p>}
+          end
+
+          it 'displays label tag with a class' do
+            @c.attribute(@record, :title, {:label_class => 'label'}).should eq %{<p><strong class="label">Title: </strong>Wellington</p>}
+          end
+
+          it 'uses the translation key' do
+            I18n.should_receive(:t).with('item.key', :default => 'Title').and_return('Title')
+            @c.attribute(@record, :title, {:trans_key => 'item.key'})
+          end
+
+          context ':link => true' do
+            it 'converts it to a URL when value is a url' do
+              url = "http://google.com/images"
+              @record = mock_record({:landing_url => url})
+              @c.attribute(@record, :landing_url, {:link => true}).should eq %{<p><strong>Landing_url: </strong>#{@c.link_to url, url}</p>}
+            end
+
+            it 'links to the URL when the value contains both a URL and text' do
+              url = 'http://google.com/images'
+              @record = mock_record({:source => "Image location #{url}"})
+              @c.attribute(@record, :source, {:link => true}).should eq %{<p><strong>Source: </strong>Image location #{@c.link_to url, url}</p>}
+            end
+
+            it 'converts it to a URL with the url pattern in :link and replaces the value' do
+              @record = mock_record({:subject => ['New Zealand']})
+              @c.attribute(@record, :subject, :link => '/records?i[subject_text]={{value}}').should eq %{<p><strong>Subject: </strong>#{@c.link_to "New Zealand", "/records?i[subject_text]=New Zealand"}</p>}
+            end
+
+            it 'returns nothing when value is nil' do
+              @c.attribute(@record, :description, {:link => true}).should be_nil
+            end
+          end
+
+          it 'returns nothing when value is "Not specified"' do
+            record = mock_record({:description => 'Not specified'})
+            @c.attribute(record, :description).should be_nil
+          end
+
+          it 'adds extra_html inside of the <p>' do
+            @c.attribute(@record, :title, {:extra_html => @c.content_tag(:span, 'Hi!')}).should eq %{<p><strong>Title: </strong>Wellington<span>Hi!</span></p>}
+          end
+
+          context 'default HTML values' do
+            it 'uses the tag defined in the config' do
+              Supplejack.stub(:attribute_tag) { :span }
+              @c.attribute(@record, :title).should eq %{<span><strong>Title: </strong>Wellington</span>}
+            end
+
+            it 'uses the label tag defined in the config' do
+              Supplejack.stub(:label_tag) { :b }
+              @c.attribute(@record, :title).should eq %{<p><b>Title: </b>Wellington</p>}
+            end
+
+            it 'uses the label class defined in the config' do
+              Supplejack.stub(:label_class) { 'label' }
+              @c.attribute(@record, :title).should eq %{<p><strong class="label">Title: </strong>Wellington</p>}
+            end
+          end
+        end
+
+        context 'multiple values' do
+          before(:each) do
+            @record = mock_record({:category => ['Images', 'Videos']})
+          end
+
+          it 'displays the values separated by commas' do
+            @c.attribute(@record, :category).should eq %{<p><strong>Category: </strong>Images, Videos</p>}
+          end
+
+          it 'displays the values separated by another delimiter' do
+            @c.attribute(@record, :category, {:delimiter => ':'}).should eq %{<p><strong>Category: </strong>Images:Videos</p>}
+          end
+
+          it 'limits the amount of values returned' do
+            @c.attribute(@record, :category, {:limit => 1}).should eq %{<p><strong>Category: </strong>Images</p>}
+          end
+
+          it 'limits the amount of values returned when less than 20' do
+            @record.stub(:category) { (1..30).to_a.map(&:to_s) }
+            @c.attribute(@record, :category, {:limit => 10}).should eq %{<p><strong>Category: </strong>1, 2, 3, 4, 5, 6, 7, 8, 9, 10</p>}
+          end
+
+          it 'generates links for every value' do
+            @link1 = @c.link_to('Images', "/records?#{{:i => {:category => 'Images'}}.to_query}")
+            @link2 = @c.link_to('Videos', "/records?#{{:i => {:category => 'Videos'}}.to_query}")
+            @c.attribute(@record, :category, {:link_path => "records_path"}).should eq %{<p><strong>Category: </strong>#{@link1}, #{@link2}</p>}
+          end
+
+          it 'converts every value to a URL when :link => true and value is a url' do
+            url1 = 'http://google.com/images'
+            url2 = 'http://yahoo.com/photos'
+            @record = mock_record({:landing_url => [url1, url2]})
+            @c.attribute(@record, :landing_url, {:link => true}).should eq %{<p><strong>Landing_url: </strong>#{@c.link_to url1, url1}, #{@c.link_to url2, url2}</p>}
+          end
+
+          it 'truncates the sum of all elements in the array' do
+            @record = mock_record({:description => ['This is a lengthy description', 'Some other stuff']})
+            @c.attribute(@record, :description, :limit => 40, :label => false).should eq "<p>This is a lengthy description, Some o...</p>"
+          end
+
+          it 'converts it to a URL with the url pattern in :link and replaces the value for each value' do
+            @c.attribute(@record, :category, :link => '/records?i[category]={{value}}').should eq %{<p><strong>Category: </strong>#{@c.link_to "Images", "/records?i[category]=Images"}, #{@c.link_to "Videos", "/records?i[category]=Videos"}</p>}
+          end
+        end
+
+        context 'multiple attributes' do
+          before(:each) do
+            @record = mock_record({:category => ['Images', 'Videos'], :creator => 'Federico', :object_url => nil, :source => nil})
+          end
+
+          it 'fetches values from multiple attributes' do
+            @c.attribute(@record, [:category, :creator]).should eq %{<p><strong>Category: </strong>Images, Videos, Federico</p>}
+          end
+
+          it 'returns nothing when both values are nil' do
+            @c.attribute(@record, [:object_url, :source], {:link => true}).should be_nil
+          end
+        end
+      end
+
+      describe '#attribute_link_replacement' do
+        it 'generates a link and replaces the value' do
+          @c.attribute_link_replacement('Images', '/records?i[category]={{value}}').should eq(@c.link_to('Images', '/records?i[category]=Images'))
+        end
+
+        it 'generates a link with the value as text and url' do
+          @c.attribute_link_replacement('http://google.comm/images', true).should eq(@c.link_to('http://google.comm/images', 'http://google.comm/images'))
+        end
+
+        it 'decodes the link_pattern' do
+          @c.attribute_link_replacement('Images', '/records?i[category]=%7B%7Bvalue%7D%7D').should eq(@c.link_to('Images', '/records?i[category]=Images'))
+        end
+      end
+
+    end
+  end
+end