supplejack_client 1.0.4 → 1.0.5

data/lib/supplejack/controllers/helpers.rb

@@ -7,6 +7,8 @@
 
 require 'rails_autolink'
 
+# rubocop:disable All
+# FIXME: make this module presentable
 module Supplejack
   module Controllers
     module Helpers

data/lib/supplejack/engine.rb

@@ -7,6 +7,7 @@
 
 require 'supplejack_client'
 require 'rails'
+require 'active_model'
 
 module Supplejack
   class Engine < Rails::Engine

data/lib/supplejack/exceptions.rb

@@ -9,6 +9,9 @@ module Supplejack
   class RecordNotFound < StandardError
   end
 
+  class ConceptNotFound < StandardError
+  end
+
   class SetNotFound < StandardError
   end
 

data/lib/supplejack/item_relation.rb

@@ -24,7 +24,9 @@ module Supplejack
     def initialize(user_set)
       @user_set = user_set
       items_array = user_set.attributes[:records] || []
-      @items = items_array.map { |hash| Supplejack::Item.new(hash.merge(user_set_id: user_set.id, api_key: user_set.api_key)) }
+      @items = items_array.map do |hash| 
+        Supplejack::Item.new(hash.merge(user_set_id: user_set.id, api_key: user_set.api_key))
+      end
     end
 
     # Returns an Array with all items for the current UserSet

data/lib/supplejack/log_subscriber.rb

@@ -8,6 +8,8 @@
 module Supplejack
   class LogSubscriber < ActiveSupport::LogSubscriber
 
+    # rubocop:disable Metrics/LineLength
+    # FIXME: make line 24 (request = "") shorter
     def log_request(duration, payload, solr_request_params={})
       return unless Supplejack.enable_debugging
       

data/lib/supplejack/record.rb

@@ -59,11 +59,11 @@ module Supplejack
     def metadata
       metadata = []
 
-      Supplejack.send("special_fields").each do |schema, fields|
+      Supplejack.send('special_fields').each do |schema, fields|
         fields[:fields].each do |field|
           if @attributes.has_key?(field)
             values = @attributes[field]
-            values ||= [] unless !!values == values #Testing if boolean
+            values ||= [] unless !!values == values # Testing if boolean
             values = [values] unless values.is_a?(Array)
 
             case fields[:format]
@@ -72,7 +72,6 @@ module Supplejack
             when "camelcase" then field = field.to_s.camelcase
             end
 
-            # field = field.to_s.camelcase(:lower) if schema == :dcterms
             field = field.to_s.sub(/#{schema}_/, '')
             values.each do |value|
               metadata << {:name => field, :schema => schema.to_s, :value => value }
@@ -85,7 +84,9 @@ module Supplejack
     end
 
     def format
-      raise NoMethodError, "undefined method 'format' for Supplejack::Record:Module" unless @attributes.has_key?(:format)
+      unless @attributes.has_key?(:format)
+        raise NoMethodError, "undefined method 'format' for Supplejack::Record:Module" 
+      end
       @attributes[:format]
     end
 
@@ -99,26 +100,10 @@ module Supplejack
       true
     end
 
-    # def build_authorities(name)
-    #   @attributes[:authorities] ||= []
-    #   authorities = @attributes[:authorities].find_all {|authority| authority["name"] == name }
-    #   authorities.map {|attributes| Supplejack::Authority.new(attributes) }
-    # end
-
     def method_missing(symbol, *args, &block)
-      if symbol.to_s.match(/(.+)_authorities/)
-        return build_authorities("#{$1}_authority")
-      end
-
-      if symbol.to_s.match(/(.+)_terms/)
-        return build_authorities("#{$1}_term")
+      unless @attributes.has_key?(symbol)
+        raise NoMethodError, "undefined method '#{symbol.to_s}' for Supplejack::Record:Module" 
       end
-
-      if [:series_parent, :child_series, :collection_parent, :collection_root, :collection_mid].include?(symbol)
-        return build_authorities(symbol.to_s)
-      end
-
-      raise NoMethodError, "undefined method '#{symbol.to_s}' for Supplejack::Record:Module" unless @attributes.has_key?(symbol)
       @attributes[symbol]
     end
 
@@ -130,7 +115,8 @@ module Supplejack
       # @params [ Hash ] options Search options used to perform a search in order to get the next/previous
       #   records within the search results.
       #
-      # @return [ Supplejack::Record ] A record or array of records initialized with the class of where the Supplejack::Record module was included
+      # @return [ Supplejack::Record ] A record or array of records initialized with the class of where the 
+      # Supplejack::Record module was included
       #
       def find(id_or_array, options={})
         if id_or_array.is_a?(Array)

data/lib/supplejack/request.rb

@@ -13,6 +13,7 @@ module Supplejack
 
 		def get(path, params={}, options={})
       params ||= {}
+
       url = full_url(path, options[:format], params)
 
       started = Time.now
@@ -37,21 +38,30 @@ module Supplejack
     def post(path, params={}, payload={}, options={})
       payload ||= {}
       log_request(:post, path, params, payload) do
-        response = RestClient::Request.execute(:url => full_url(path, nil, params), :method => :post, :payload => payload.to_json, :timeout => timeout(options), :headers => {:content_type => :json, :accept => :json})
+        response = RestClient::Request.execute(:url => full_url(path, nil, params),
+                                               :method => :post, :payload => payload.to_json,
+                                               :timeout => timeout(options),
+                                               :headers => {:content_type => :json, :accept => :json})
         JSON.parse(response) rescue {}.to_json
       end
     end
 
     def delete(path, params={}, options={})
       log_request(:delete, path, params, {}) do
-        RestClient::Request.execute(:url => full_url(path, nil, params), :method => :delete, :timeout => timeout(options))
+        RestClient::Request.execute(:url => full_url(path, nil, params),
+                                    :method => :delete,
+                                    :timeout => timeout(options))
       end
     end
 
     def put(path, params={}, payload={}, options={})
       payload ||= {}
       log_request(:put, path, params, payload) do
-        response = RestClient::Request.execute(:url => full_url(path, nil, params), :method => :put, :payload => payload.to_json, :timeout => timeout(options), :headers => {:content_type => :json, :accept => :json})
+        response = RestClient::Request.execute(:url => full_url(path, nil, params),
+                                               :method => :put,
+                                               :payload => payload.to_json,
+                                               :timeout => timeout(options),
+                                               :headers => {:content_type => :json, :accept => :json})
         JSON.parse(response) rescue {}.to_json
       end
     end
@@ -91,5 +101,5 @@ module Supplejack
       end
     end
 
-	end	
+	end
 end

data/lib/supplejack/search.rb

@@ -9,10 +9,13 @@ require 'supplejack/request'
 require 'digest/md5'
 
 module Supplejack
+  # rubocop:disable Metrics/ClassLength
+  # FIXME: make me smaller!
   class Search
     include Supplejack::Request
 
-    attr_accessor :results, :text, :page, :per_page, :pagination_limit, :direction, :sort, :filters, :record_type, :record_klass
+    attr_accessor :results, :text, :page, :per_page, :pagination_limit, :direction
+    attr_accessor :sort, :filters, :record_type, :record_klass, :geo_bbox
     attr_accessor :url_format, :without, :and, :or, :params, :api_params
 
     def initialize(params={})
@@ -32,6 +35,7 @@ module Supplejack
       @direction        = @params[:direction]
       @url_format       = Supplejack.url_format_klass.new(@params, self)
       @filters          = @url_format.filters
+
       @api_params       = @url_format.to_api_hash
       @record_klass     = @params[:record_klass] || Supplejack.record_klass
 
@@ -92,7 +96,8 @@ module Supplejack
     #
     # @param [ Hash ] options Supported options: :drill_dates
     #
-    # @return [ Array<Supplejack::Facet> ] Every element in the array is a Supplejack::Facet object, and responds to name and values
+    # @return [ Array<Supplejack::Facet> ] Every element in the array is a Supplejack::Facet object,
+    # and responds to name and values
     #
     def facets(options={})
       return @facets if @facets
@@ -155,9 +160,10 @@ module Supplejack
     # @example Returns the following hash:
     #   {"photos" => 100}
     #
+    # rubocop:disable Metrics/LineLength
     # @param [Hash{String => Hash{String => String}}] a hash with query names as keys and a hash with filters as values.
     # @return [Hash{String => Integer}] A hash with the query names as keys and the result count for every query as values
-    #
+    # rubocop:enable Metrics/LineLength
     def counts(query_parameters={})
       if Supplejack.enable_caching
         cache_key = Digest::MD5.hexdigest(counts_params(query_parameters).to_query)
@@ -196,10 +202,10 @@ module Supplejack
         query_record_type = count_filters[:record_type].to_i
         type = query_record_type == 0 ? :items : :headings
         filters = self.url_format.and_filters(type).dup
-        
+
         without_filters = self.url_format.without_filters(type).dup
-        without_filters = Hash[without_filters.map {|key, value| ["-#{key}".to_sym, value]}]          
-        
+        without_filters = Hash[without_filters.map {|key, value| ["-#{key}".to_sym, value]}]
+
         filters.merge!(without_filters)
         query_with_filters.merge!({count_name.to_sym => Supplejack::Util.deep_merge(filters, count_filters) })
       end
@@ -207,7 +213,7 @@ module Supplejack
       params = {:facet_query => query_with_filters, :record_type => "all"}
       params[:text] = self.url_format.text
       params[:text] = self.text if self.text.present?
-      # params[:geo_bbox] = self.geo_bbox if self.geo_bbox.present?
+      params[:geo_bbox] = self.geo_bbox if self.geo_bbox.present?
       params[:query_fields] = self.url_format.query_fields
       params = merge_extra_filters(params)
       params
@@ -240,7 +246,7 @@ module Supplejack
       end
 
       @facet_values["All"] = response["search"]["result_count"] if options[:all]
-      
+
       facet = Supplejack::Facet.new(facet_name, @facet_values)
       @facet_values = facet.values(options[:sort])
 
@@ -316,7 +322,7 @@ module Supplejack
     def categories(options={})
       return @categories if @categories
       @categories = facet_values("category", options)
-    end    
+    end
 
     # Convienence method to find out if the search object has any specific filter
     # applied to it. It works for both single and multiple value filters.
@@ -350,6 +356,6 @@ module Supplejack
 
       Util.deep_merge(existing_filters, extra_filters)
     end
-    
+
   end
-end
+end

data/lib/supplejack/url_formats/item_hash.rb

@@ -8,9 +8,9 @@
 module Supplejack
   module UrlFormats
     class ItemHash
-      
+
       attr_accessor :params, :search, :i_unlocked, :i_locked, :h_unlocked, :h_locked
-      
+
       def initialize(params={}, search=nil)
         @params     = params || {}
         @search     = search
@@ -19,7 +19,7 @@ module Supplejack
         @h_unlocked = filters_of_type(:h)
         @h_locked   = filters_of_type(:hl)
       end
-      
+
       def to_api_hash
         hash = {}
         text_value = text(params[:text])
@@ -36,51 +36,54 @@ module Supplejack
         hash[:fields]           = params[:fields] || Supplejack.fields.join(',')
         hash[:query_fields]     = query_fields if query_fields
         hash[:solr_query]       = params[:solr_query] if params[:solr_query].present?
-        
+        hash[:ignore_metrics]   = params[:ignore_metrics] if params[:ignore_metrics].present?
+
         if params[:sort].present?
           hash[:sort] = params[:sort]
           hash[:direction] = params[:direction] || "asc"
         end
-        
+
         hash
       end
-      
+
       # Returns all the active filters for the current search
       # These filters are used to scope the search results
       #
       def filters(filter_type=nil)
         filters = {}
-        
+
         symbol = filter_symbol(filter_type)
-        
+
         memoized_filters = self.instance_variable_get("@#{symbol}_filters")
         return memoized_filters if memoized_filters
-                
+
         unlocked = filters_of_type(symbol.to_sym)
         locked = filters_of_type("#{symbol}l".to_sym)
-        
+
         filters = Supplejack::Util.deep_merge!(unlocked, locked)
-                
+
         @all_filters = filters.dup.symbolize_keys.to_hash rescue {}
         self.instance_variable_set("@#{symbol}_filters", @all_filters)
         @all_filters
       end
-      
+
       def and_filters(filter_type=nil)
         @and_filters ||= {}
-        @and_filters[filter_symbol(filter_type)] ||= filters(filter_type).reject {|filter, value| filter.to_s.match(/-(.+)/) or is_text_field?(filter)}
+        valid_filters = filters(filter_type).reject {|filter, value| filter.to_s.match(/-(.+)/)}
+                                            .reject {|filter, value| is_text_field?(filter)}
+        @and_filters[filter_symbol(filter_type)] ||= valid_filters
       end
 
       def is_text_field?(filter)
-        return false if filter.nil?
+        return false if filter.nil? || Supplejack.non_text_fields.include?(filter.to_sym)
         filter.to_s.split(//).last(5).join('').to_s == '_text'
       end
-      
+
       def without_filters(filter_type=nil)
         symbol = filter_symbol(filter_type)
-        @without_filters ||= {} 
+        @without_filters ||= {}
         return @without_filters[symbol] if @without_filters[symbol]
-        
+
         @without_filters[symbol] = {}
         filters(filter_type).each_pair do |filter, value|
           if filter.to_s.match(/-(.+)/)
@@ -89,13 +92,13 @@ module Supplejack
         end
         @without_filters[symbol]
       end
-      
+
       def all_filters
         return @all_filters if @all_filters
         self.filters
         @all_filters
       end
-      
+
       def filter_symbol(filter_type=nil)
         if filter_type
           filter_type == :items ? 'i' : 'h'
@@ -103,7 +106,7 @@ module Supplejack
           params[:record_type].to_i == 0 ? 'i' : 'h'
         end
       end
-       
+
       # Returns the value from the text param and joins any values from
       # fields which end in _text (ie. creator_text)
       #
@@ -112,32 +115,32 @@ module Supplejack
       def text(default_text=nil)
         text_values = []
         text_values << default_text if default_text.present?
-        
+
         all_filters.each do |filter, value|
           text_values << value if is_text_field?(filter)
         end
-        
+
         return nil if text_values.empty?
         text_values.join(' ')
       end
-      
+
       # Returns the query_fields from the current search filters so that
       # specific fields can be searched.
       # The '_text' is removed from the end of the field name
       #
       def query_fields
         query_fields = []
-                
+
         all_filters.each do |filter, value|
           if is_text_field?(filter)
             query_fields << filter.to_s.chomp!('_text').to_sym
           end
         end
-        
+
         return nil if query_fields.empty?
         query_fields
       end
-      
+
       # Returns one type of filters
       #
       # @param [ :i, :il, :h, :hl ] filter_type The symbol of the filter type
@@ -145,7 +148,7 @@ module Supplejack
       def filters_of_type(filter_type)
         params[filter_type].dup.symbolize_keys.to_hash rescue {}
       end
-      
+
       # Returns a hash options to be used for generating URL's with all the search state.
       #
       # @param [ Hash ] filter_options A hash of options to be able to remove or add filters
@@ -153,25 +156,27 @@ module Supplejack
       # @filter_option option [ Array ] :except A array of filter names to be removed
       # @filter_options option [ Hash ] :plus A hash with filters and their values to be added
       #
+      # rubocop:disable Metrics/MethodLength
+      # FIXME: make me smaller!
       def options(filter_options={})
         filter_options.reverse_merge!({:except => [], :plus => {}})
         filter_options[:except] ||= []
-      
+
         hash = {}
         {:i => :i_unlocked, :il => :i_locked, :h => :h_unlocked, :hl => :h_locked}.each_pair do |symbol, instance_name|
           filters = self.send(instance_name).clone || {}
-          
+
           filters.each_pair do |name, value|
             filters.delete(name) if value.blank?
           end
-          
+
           filter_options[:except].each do |exception|
             if exception.is_a?(Hash)
               facet, values_to_delete = exception.first
               values_to_delete = Util.array(values_to_delete)
               existing_values = Util.array(filters[facet])
               new_values = existing_values - values_to_delete
-              
+
               if new_values.any?
                 new_values = new_values.first if new_values.size == 1
                 filters[facet] = new_values
@@ -182,27 +187,28 @@ module Supplejack
               filters.delete(exception)
             end
           end
-      
+
           if filter_options[:plus].try(:any?) && filter_options[:plus][symbol].try(:any?)
             filters = Util.deep_merge(filters, filter_options[:plus][symbol])
           end
-      
+
           hash[symbol] = filters.symbolize_keys if filters.any?
         end
-      
+
         [:text, :direction, :sort].each do |attribute|
           attribute_value = search.send(attribute)
           hash.merge!(attribute => attribute_value) if attribute_value.present?
         end
-                
+
         unless filter_options[:except].include?(:page)
           hash.merge!(:page => search.page) if search.page.present? && search.page != 1
         end
-        
+
         hash.merge!(:record_type => 1) if search.record_type > 0
         return hash
       end
-      
+      # rubocop:enable Metrics/MethodLength
+
     end
   end
 end

data/lib/supplejack/user.rb

@@ -132,5 +132,10 @@ module Supplejack
       response = post("/users", {}, {user: attributes})
       new(response["user"])
     end
+
+    def self.update(attributes={})
+      response = put("/users/#{attributes[:api_key]}", {}, {user: attributes})
+      new(response["user"])
+    end
   end
 end

data/lib/supplejack/user_set.rb

@@ -27,7 +27,8 @@ module Supplejack
     include ActiveModel::Conversion
     extend ActiveModel::Naming
 
-    ATTRIBUTES = [:id, :name, :description, :privacy, :url, :priority, :count, :tags, :tag_list, :homepage, :records, :created_at, :updated_at, :approved, :record]
+    ATTRIBUTES = [:id, :name, :description, :privacy, :url, :priority, :count, :tags, :tag_list, 
+                  :featured, :records, :created_at, :updated_at, :approved, :record]
     attr_accessor *ATTRIBUTES
     attr_accessor :api_key, :errors, :user
 
@@ -55,7 +56,7 @@ module Supplejack
     #
     def api_attributes
       api_attributes = {}
-      [:name, :description, :privacy, :priority, :tag_list, :homepage, :approved].each do |attr|
+      [:name, :description, :privacy, :priority, :tag_list, :featured, :approved].each do |attr|
         api_attributes[attr] = self.send(attr)
       end
       api_attributes[:records] = self.api_records
@@ -203,7 +204,7 @@ module Supplejack
     # @return [ Array ] A array of hashes in the format {record_id: 1, position: 1}
     #
     # @example
-    #   user_set.ordered_records_from_array([89,66])      => [{record_id: 89, position: 1}, {record_id: 66, position: 2}]
+    #   user_set.ordered_records_from_array([89,66]) => [{record_id: 89, position: 1}, {record_id: 66, position: 2}]
     #
     def ordered_records_from_array(record_ids)
       records = []
@@ -313,16 +314,19 @@ module Supplejack
       response = get("/sets/public", options)
       sets_array = response["sets"] || []
       user_sets = sets_array.map {|attrs| new(attrs) }
-      Supplejack::PaginatedCollection.new(user_sets, options[:page].to_i, options[:per_page].to_i, response["total"].to_i)
+      Supplejack::PaginatedCollection.new(user_sets, 
+                                          options[:page].to_i, 
+                                          options[:per_page].to_i, 
+                                          response["total"].to_i)
     end
 
-    # Execute a GET request to the API /sets/home endpoint to retrieve
-    # all UserSet objects which have the :homepage flag set to true
+    # Execute a GET request to the API /sets/featured endpoint to retrieve
+    # all UserSet objects which have the :featured flag set to true
     #
     # @return [ Array ] A array of Supplejack::UserSet objects
     #
-    def self.homepage_sets
-      path = "/sets/home"
+    def self.featured_sets
+      path = "/sets/featured"
       if Supplejack.enable_caching
         response = Rails.cache.fetch(path, expires_in: 1.day) do
           get(path)

data/lib/supplejack/util.rb

@@ -117,4 +117,4 @@ module Supplejack
     end
     
   end
-end
+end

data/lib/supplejack/version.rb

@@ -6,5 +6,5 @@
 # and the Department of Internal Affairs. http://digitalnz.org/supplejack
 
 module Supplejack
-  VERSION = '1.0.4'
+  VERSION = '1.0.5'
 end

data/lib/supplejack_client.rb

@@ -10,11 +10,12 @@ require 'supplejack/version'
 
 module Supplejack
   extend Config
-  
+
   require 'supplejack/engine'
   require 'supplejack/exceptions'
   require 'supplejack/log_subscriber'
   require 'supplejack/record'
+  require 'supplejack/concept'
   require "supplejack/request"
   require 'supplejack/paginated_collection'
   require 'supplejack/controllers/helpers'

data/spec/spec_helper.rb

@@ -7,12 +7,18 @@
 
 require 'rubygems'
 require 'bundler/setup'
+require 'simplecov'
 
 Bundler.require(:default)
 
 require 'supplejack_client'
 require 'active_support/all'
 
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
+#SimpleCov.start
+
 RSpec.configure do |config|
   # some (optional) config here
   config.mock_with :rspec