jro_apps/redmine Commit - r12202:a4d3da988a3e

Allow filtering with timestamp (#8842)....

Jean-Philippe Lang -

r12202:a4d3da988a3e

parent child

Context file:

r12202:a4d3da988a3e

Collapse all files

app/models/query.rb +27 -12

              # Redmine - project management software
              # Copyright (C) 2006-2013  Jean-Philippe Lang
              #
              # This program is free software; you can redistribute it and/or
              # modify it under the terms of the GNU General Public License
              # as published by the Free Software Foundation; either version 2
              # of the License, or (at your option) any later version.
              #
              # This program is distributed in the hope that it will be useful,
              # but WITHOUT ANY WARRANTY; without even the implied warranty of
              # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
              # GNU General Public License for more details.
              #
              # You should have received a copy of the GNU General Public License
              # along with this program; if not, write to the Free Software
              # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
              class QueryColumn
                attr_accessor :name, :sortable, :groupable, :default_order
                include Redmine::I18n
                def initialize(name, options={})
                  self.name = name
                  self.sortable = options[:sortable]
                  self.groupable = options[:groupable] || false
                  if groupable == true
                    self.groupable = name.to_s
                  end
                  self.default_order = options[:default_order]
                  @inline = options.key?(:inline) ? options[:inline] : true
                  @caption_key = options[:caption] || "field_#{name}".to_sym
                  @frozen = options[:frozen]
                end
                def caption
                  @caption_key.is_a?(Symbol) ? l(@caption_key) : @caption_key
                end
                # Returns true if the column is sortable, otherwise false
                def sortable?
                  !@sortable.nil?
                end
                def sortable
                  @sortable.is_a?(Proc) ? @sortable.call : @sortable
                end
                def inline?
                  @inline
                end
                def frozen?
                  @frozen
                end
                def value(object)
                  object.send name
                end
                def css_classes
                  name
                end
              end
              class QueryCustomFieldColumn < QueryColumn
                def initialize(custom_field)
                  self.name = "cf_#{custom_field.id}".to_sym
                  self.sortable = custom_field.order_statement || false
                  self.groupable = custom_field.group_statement || false
                  @inline = true
                  @cf = custom_field
                end
                def caption
                  @cf.name
                end
                def custom_field
                  @cf
                end
                def value(object)
                  if custom_field.visible_by?(object.project, User.current)
                    cv = object.custom_values.select {|v| v.custom_field_id == @cf.id}.collect {|v| @cf.cast_value(v.value)}
                    cv.size > 1 ? cv.sort {|a,b| a.to_s <=> b.to_s} : cv.first
                  else
                    nil
                  end
                end
                def css_classes
                  @css_classes ||= "#{name} #{@cf.field_format}"
                end
              end
              class QueryAssociationCustomFieldColumn < QueryCustomFieldColumn
                def initialize(association, custom_field)
                  super(custom_field)
                  self.name = "#{association}.cf_#{custom_field.id}".to_sym
                  # TODO: support sorting/grouping by association custom field
                  self.sortable = false
                  self.groupable = false
                  @association = association
                end
                def value(object)
                  if assoc = object.send(@association)
                    super(assoc)
                  end
                end
                def css_classes
                  @css_classes ||= "#{@association}_cf_#{@cf.id} #{@cf.field_format}"
                end
              end
              class Query < ActiveRecord::Base
                class StatementInvalid < ::ActiveRecord::StatementInvalid
                end
                VISIBILITY_PRIVATE = 0
                VISIBILITY_ROLES   = 1
                VISIBILITY_PUBLIC  = 2
                belongs_to :project
                belongs_to :user
                has_and_belongs_to_many :roles, :join_table => "#{table_name_prefix}queries_roles#{table_name_suffix}", :foreign_key => "query_id"
                serialize :filters
                serialize :column_names
                serialize :sort_criteria, Array
                serialize :options, Hash
                attr_protected :project_id, :user_id
                validates_presence_of :name
                validates_length_of :name, :maximum => 255
                validates :visibility, :inclusion => { :in => [VISIBILITY_PUBLIC, VISIBILITY_ROLES, VISIBILITY_PRIVATE] }
                validate :validate_query_filters
                validate do |query|
                  errors.add(:base, l(:label_role_plural) + ' ' + l('activerecord.errors.messages.blank')) if query.visibility == VISIBILITY_ROLES && roles.blank?
                end
                after_save do |query|
                  if query.visibility_changed? && query.visibility != VISIBILITY_ROLES
              	    query.roles.clear
              	  end
                end
                class_attribute :operators
                self.operators = {
                  "="   => :label_equals,
                  "!"   => :label_not_equals,
                  "o"   => :label_open_issues,
                  "c"   => :label_closed_issues,
                  "!*"  => :label_none,
                  "*"   => :label_any,
                  ">="  => :label_greater_or_equal,
                  "<="  => :label_less_or_equal,
                  "><"  => :label_between,
                  "<t+" => :label_in_less_than,
                  ">t+" => :label_in_more_than,
                  "><t+"=> :label_in_the_next_days,
                  "t+"  => :label_in,
                  "t"   => :label_today,
                  "ld"  => :label_yesterday,
                  "w"   => :label_this_week,
                  "lw"  => :label_last_week,
                  "l2w" => [:label_last_n_weeks, {:count => 2}],
                  "m"   => :label_this_month,
                  "lm"  => :label_last_month,
                  "y"   => :label_this_year,
                  ">t-" => :label_less_than_ago,
                  "<t-" => :label_more_than_ago,
                  "><t-"=> :label_in_the_past_days,
                  "t-"  => :label_ago,
                  "~"   => :label_contains,
                  "!~"  => :label_not_contains,
                  "=p"  => :label_any_issues_in_project,
                  "=!p" => :label_any_issues_not_in_project,
                  "!p"  => :label_no_issues_in_project
                }
                class_attribute :operators_by_filter_type
                self.operators_by_filter_type = {
                  :list => [ "=", "!" ],
                  :list_status => [ "o", "=", "!", "c", "*" ],
                  :list_optional => [ "=", "!", "!*", "*" ],
                  :list_subprojects => [ "*", "!*", "=" ],
                  :date => [ "=", ">=", "<=", "><", "<t+", ">t+", "><t+", "t+", "t", "ld", "w", "lw", "l2w", "m", "lm", "y", ">t-", "<t-", "><t-", "t-", "!*", "*" ],
                  :date_past => [ "=", ">=", "<=", "><", ">t-", "<t-", "><t-", "t-", "t", "ld", "w", "lw", "l2w", "m", "lm", "y", "!*", "*" ],
                  :string => [ "=", "~", "!", "!~", "!*", "*" ],
                  :text => [  "~", "!~", "!*", "*" ],
                  :integer => [ "=", ">=", "<=", "><", "!*", "*" ],
                  :float => [ "=", ">=", "<=", "><", "!*", "*" ],
                  :relation => ["=", "=p", "=!p", "!p", "!*", "*"]
                }
                class_attribute :available_columns
                self.available_columns = []
                class_attribute :queried_class
                def queried_table_name
                  @queried_table_name ||= self.class.queried_class.table_name
                end
                def initialize(attributes=nil, *args)
                  super attributes
                  @is_for_all = project.nil?
                end
                # Builds the query from the given params
                def build_from_params(params)
                  if params[:fields] || params[:f]
                    self.filters = {}
                    add_filters(params[:fields] || params[:f], params[:operators] || params[:op], params[:values] || params[:v])
                  else
                    available_filters.keys.each do |field|
                      add_short_filter(field, params[field]) if params[field]
                    end
                  end
                  self.group_by = params[:group_by] || (params[:query] && params[:query][:group_by])
                  self.column_names = params[:c] || (params[:query] && params[:query][:column_names])
                  self
                end
                # Builds a new query from the given params and attributes
                def self.build_from_params(params, attributes={})
                  new(attributes).build_from_params(params)
                end
                def validate_query_filters
                  filters.each_key do |field|
                    if values_for(field)
                      case type_for(field)
                      when :integer
                        add_filter_error(field, :invalid) if values_for(field).detect {|v| v.present? && !v.match(/^[+-]?\d+$/) }
                      when :float
                        add_filter_error(field, :invalid) if values_for(field).detect {|v| v.present? && !v.match(/^[+-]?\d+(\.\d*)?$/) }
                      when :date, :date_past
                        case operator_for(field)
                        when "=", ">=", "<=", "><"
-                         add_filter_error(field, :invalid) if values_for(field).detect {|v| v.present? && (!v.match(/^\d{4}-\d{2}-\d{2}$/) || (Date.parse(v) rescue nil).nil?) }
+                         add_filter_error(field, :invalid) if values_for(field).detect {|v|
+                           v.present? && (!v.match(/\A\d{4}-\d{2}-\d{2}(T\d{2}((:)?\d{2}){,2}(Z|\d{2}:?\d{2})?)?\z/) || parse_date(v).nil?)
+                         }
                        when ">t-", "<t-", "t-", ">t+", "<t+", "t+", "><t+", "><t-"
                          add_filter_error(field, :invalid) if values_for(field).detect {|v| v.present? && !v.match(/^\d+$/) }
                        end
                      end
                    end
                    add_filter_error(field, :blank) unless
                        # filter requires one or more values
                        (values_for(field) and !values_for(field).first.blank?) or
                        # filter doesn't require any value
                        ["o", "c", "!*", "*", "t", "ld", "w", "lw", "l2w", "m", "lm", "y"].include? operator_for(field)
                  end if filters
                end
                def add_filter_error(field, message)
                  m = label_for(field) + " " + l(message, :scope => 'activerecord.errors.messages')
                  errors.add(:base, m)
                end
                def editable_by?(user)
                  return false unless user
                  # Admin can edit them all and regular users can edit their private queries
                  return true if user.admin? || (is_private? && self.user_id == user.id)
                  # Members can not edit public queries that are for all project (only admin is allowed to)
                  is_public? && !@is_for_all && user.allowed_to?(:manage_public_queries, project)
                end
                def trackers
                  @trackers ||= project.nil? ? Tracker.sorted.all : project.rolled_up_trackers
                end
                # Returns a hash of localized labels for all filter operators
                def self.operators_labels
                  operators.inject({}) {|h, operator| h[operator.first] = l(*operator.last); h}
                end
                # Returns a representation of the available filters for JSON serialization
                def available_filters_as_json
                  json = {}
                  available_filters.each do |field, options|
                    json[field] = options.slice(:type, :name, :values).stringify_keys
                  end
                  json
                end
                def all_projects
                  @all_projects ||= Project.visible.all
                end
                def all_projects_values
                  return @all_projects_values if @all_projects_values
                  values = []
                  Project.project_tree(all_projects) do |p, level|
                    prefix = (level > 0 ? ('--' * level + ' ') : '')
                    values << ["#{prefix}#{p.name}", p.id.to_s]
                  end
                  @all_projects_values = values
                end
                # Adds available filters
                def initialize_available_filters
                  # implemented by sub-classes
                end
                protected :initialize_available_filters
                # Adds an available filter
                def add_available_filter(field, options)
                  @available_filters ||= ActiveSupport::OrderedHash.new
                  @available_filters[field] = options
                  @available_filters
                end
                # Removes an available filter
                def delete_available_filter(field)
                  if @available_filters
                    @available_filters.delete(field)
                  end
                end
                # Return a hash of available filters
                def available_filters
                  unless @available_filters
                    initialize_available_filters
                    @available_filters.each do |field, options|
                      options[:name] ||= l(options[:label] || "field_#{field}".gsub(/_id$/, ''))
                    end
                  end
                  @available_filters
                end
                def add_filter(field, operator, values=nil)
                  # values must be an array
                  return unless values.nil? || values.is_a?(Array)
                  # check if field is defined as an available filter
                  if available_filters.has_key? field
                    filter_options = available_filters[field]
                    filters[field] = {:operator => operator, :values => (values || [''])}
                  end
                end
                def add_short_filter(field, expression)
                  return unless expression && available_filters.has_key?(field)
                  field_type = available_filters[field][:type]
                  operators_by_filter_type[field_type].sort.reverse.detect do |operator|
                    next unless expression =~ /^#{Regexp.escape(operator)}(.*)$/
                    values = $1
                    add_filter field, operator, values.present? ? values.split('|') : ['']
                  end || add_filter(field, '=', expression.split('|'))
                end
                # Add multiple filters using +add_filter+
                def add_filters(fields, operators, values)
                  if fields.is_a?(Array) && operators.is_a?(Hash) && (values.nil? || values.is_a?(Hash))
                    fields.each do |field|
                      add_filter(field, operators[field], values && values[field])
                    end
                  end
                end
                def has_filter?(field)
                  filters and filters[field]
                end
                def type_for(field)
                  available_filters[field][:type] if available_filters.has_key?(field)
                end
                def operator_for(field)
                  has_filter?(field) ? filters[field][:operator] : nil
                end
                def values_for(field)
                  has_filter?(field) ? filters[field][:values] : nil
                end
                def value_for(field, index=0)
                  (values_for(field) || [])[index]
                end
                def label_for(field)
                  label = available_filters[field][:name] if available_filters.has_key?(field)
                  label ||= l("field_#{field.to_s.gsub(/_id$/, '')}", :default => field)
                end
                def self.add_available_column(column)
                  self.available_columns << (column) if column.is_a?(QueryColumn)
                end
                # Returns an array of columns that can be used to group the results
                def groupable_columns
                  available_columns.select {|c| c.groupable}
                end
                # Returns a Hash of columns and the key for sorting
                def sortable_columns
                  available_columns.inject({}) {|h, column|
                    h[column.name.to_s] = column.sortable
                    h
                  }
                end
                def columns
                  # preserve the column_names order
                  cols = (has_default_columns? ? default_columns_names : column_names).collect do |name|
                     available_columns.find { |col| col.name == name }
                  end.compact
                  available_columns.select(&:frozen?) | cols
                end
                def inline_columns
                  columns.select(&:inline?)
                end
                def block_columns
                  columns.reject(&:inline?)
                end
                def available_inline_columns
                  available_columns.select(&:inline?)
                end
                def available_block_columns
                  available_columns.reject(&:inline?)
                end
                def default_columns_names
                  []
                end
                def column_names=(names)
                  if names
                    names = names.select {|n| n.is_a?(Symbol) || !n.blank? }
                    names = names.collect {|n| n.is_a?(Symbol) ? n : n.to_sym }
                    # Set column_names to nil if default columns
                    if names == default_columns_names
                      names = nil
                    end
                  end
                  write_attribute(:column_names, names)
                end
                def has_column?(column)
                  column_names && column_names.include?(column.is_a?(QueryColumn) ? column.name : column)
                end
                def has_custom_field_column?
                  columns.any? {|column| column.is_a? QueryCustomFieldColumn}
                end
                def has_default_columns?
                  column_names.nil? || column_names.empty?
                end
                def sort_criteria=(arg)
                  c = []
                  if arg.is_a?(Hash)
                    arg = arg.keys.sort.collect {|k| arg[k]}
                  end
                  c = arg.select {|k,o| !k.to_s.blank?}.slice(0,3).collect {|k,o| [k.to_s, (o == 'desc' || o == false) ? 'desc' : 'asc']}
                  write_attribute(:sort_criteria, c)
                end
                def sort_criteria
                  read_attribute(:sort_criteria) || []
                end
                def sort_criteria_key(arg)
                  sort_criteria && sort_criteria[arg] && sort_criteria[arg].first
                end
                def sort_criteria_order(arg)
                  sort_criteria && sort_criteria[arg] && sort_criteria[arg].last
                end
                def sort_criteria_order_for(key)
                  sort_criteria.detect {|k, order| key.to_s == k}.try(:last)
                end
                # Returns the SQL sort order that should be prepended for grouping
                def group_by_sort_order
                  if grouped? && (column = group_by_column)
                    order = sort_criteria_order_for(column.name) || column.default_order
                    column.sortable.is_a?(Array) ?
                      column.sortable.collect {|s| "#{s} #{order}"}.join(',') :
                      "#{column.sortable} #{order}"
                  end
                end
                # Returns true if the query is a grouped query
                def grouped?
                  !group_by_column.nil?
                end
                def group_by_column
                  groupable_columns.detect {|c| c.groupable && c.name.to_s == group_by}
                end
                def group_by_statement
                  group_by_column.try(:groupable)
                end
                def project_statement
                  project_clauses = []
                  if project && !project.descendants.active.empty?
                    ids = [project.id]
                    if has_filter?("subproject_id")
                      case operator_for("subproject_id")
                      when '='
                        # include the selected subprojects
                        ids += values_for("subproject_id").each(&:to_i)
                      when '!*'
                        # main project only
                      else
                        # all subprojects
                        ids += project.descendants.collect(&:id)
                      end
                    elsif Setting.display_subprojects_issues?
                      ids += project.descendants.collect(&:id)
                    end
                    project_clauses << "#{Project.table_name}.id IN (%s)" % ids.join(',')
                  elsif project
                    project_clauses << "#{Project.table_name}.id = %d" % project.id
                  end
                  project_clauses.any? ? project_clauses.join(' AND ') : nil
                end
                def statement
                  # filters clauses
                  filters_clauses = []
                  filters.each_key do |field|
                    next if field == "subproject_id"
                    v = values_for(field).clone
                    next unless v and !v.empty?
                    operator = operator_for(field)
                    # "me" value subsitution
                    if %w(assigned_to_id author_id user_id watcher_id).include?(field)
                      if v.delete("me")
                        if User.current.logged?
                          v.push(User.current.id.to_s)
                          v += User.current.group_ids.map(&:to_s) if field == 'assigned_to_id'
                        else
                          v.push("0")
                        end
                      end
                    end
                    if field == 'project_id'
                      if v.delete('mine')
                        v += User.current.memberships.map(&:project_id).map(&:to_s)
                      end
                    end
                    if field =~ /cf_(\d+)$/
                      # custom field
                      filters_clauses << sql_for_custom_field(field, operator, v, $1)
                    elsif respond_to?("sql_for_#{field}_field")
                      # specific statement
                      filters_clauses << send("sql_for_#{field}_field", field, operator, v)
                    else
                      # regular field
                      filters_clauses << '(' + sql_for_field(field, operator, v, queried_table_name, field) + ')'
                    end
                  end if filters and valid?
                  if (c = group_by_column) && c.is_a?(QueryCustomFieldColumn)
                    # Excludes results for which the grouped custom field is not visible
                    filters_clauses << c.custom_field.visibility_by_project_condition
                  end
                  filters_clauses << project_statement
                  filters_clauses.reject!(&:blank?)
                  filters_clauses.any? ? filters_clauses.join(' AND ') : nil
                end
                private
                def sql_for_custom_field(field, operator, value, custom_field_id)
                  db_table = CustomValue.table_name
                  db_field = 'value'
                  filter = @available_filters[field]
                  return nil unless filter
                  if filter[:field].format.target_class && filter[:field].format.target_class <= User
                    if value.delete('me')
                      value.push User.current.id.to_s
                    end
                  end
                  not_in = nil
                  if operator == '!'
                    # Makes ! operator work for custom fields with multiple values
                    operator = '='
                    not_in = 'NOT'
                  end
                  customized_key = "id"
                  customized_class = queried_class
                  if field =~ /^(.+)\.cf_/
                    assoc = $1
                    customized_key = "#{assoc}_id"
                    customized_class = queried_class.reflect_on_association(assoc.to_sym).klass.base_class rescue nil
                    raise "Unknown #{queried_class.name} association #{assoc}" unless customized_class
                  end
                  where = sql_for_field(field, operator, value, db_table, db_field, true)
                  if operator =~ /[<>]/
                    where = "(#{where}) AND #{db_table}.#{db_field} <> ''"
                  end
                  "#{queried_table_name}.#{customized_key} #{not_in} IN (" +
                    "SELECT #{customized_class.table_name}.id FROM #{customized_class.table_name}" +
                    " LEFT OUTER JOIN #{db_table} ON #{db_table}.customized_type='#{customized_class}' AND #{db_table}.customized_id=#{customized_class.table_name}.id AND #{db_table}.custom_field_id=#{custom_field_id}" +
                    " WHERE (#{where}) AND (#{filter[:field].visibility_by_project_condition}))"
                end
                # Helper method to generate the WHERE sql for a +field+, +operator+ and a +value+
                def sql_for_field(field, operator, value, db_table, db_field, is_custom_filter=false)
                  sql = ''
                  case operator
                  when "="
                    if value.any?
                      case type_for(field)
                      when :date, :date_past
-                       sql = date_clause(db_table, db_field, (Date.parse(value.first) rescue nil), (Date.parse(value.first) rescue nil))
+                       sql = date_clause(db_table, db_field, parse_date(value.first), parse_date(value.first))
                      when :integer
                        if is_custom_filter
                          sql = "(#{db_table}.#{db_field} <> '' AND CAST(CASE #{db_table}.#{db_field} WHEN '' THEN '0' ELSE #{db_table}.#{db_field} END AS decimal(30,3)) = #{value.first.to_i})"
                        else
                          sql = "#{db_table}.#{db_field} = #{value.first.to_i}"
                        end
                      when :float
                        if is_custom_filter
                          sql = "(#{db_table}.#{db_field} <> '' AND CAST(CASE #{db_table}.#{db_field} WHEN '' THEN '0' ELSE #{db_table}.#{db_field} END AS decimal(30,3)) BETWEEN #{value.first.to_f - 1e-5} AND #{value.first.to_f + 1e-5})"
                        else
                          sql = "#{db_table}.#{db_field} BETWEEN #{value.first.to_f - 1e-5} AND #{value.first.to_f + 1e-5}"
                        end
                      else
                        sql = "#{db_table}.#{db_field} IN (" + value.collect{|val| "'#{connection.quote_string(val)}'"}.join(",") + ")"
                      end
                    else
                      # IN an empty set
                      sql = "1=0"
                    end
                  when "!"
                    if value.any?
                      sql = "(#{db_table}.#{db_field} IS NULL OR #{db_table}.#{db_field} NOT IN (" + value.collect{|val| "'#{connection.quote_string(val)}'"}.join(",") + "))"
                    else
                      # NOT IN an empty set
                      sql = "1=1"
                    end
                  when "!*"
                    sql = "#{db_table}.#{db_field} IS NULL"
                    sql << " OR #{db_table}.#{db_field} = ''" if is_custom_filter
                  when "*"
                    sql = "#{db_table}.#{db_field} IS NOT NULL"
                    sql << " AND #{db_table}.#{db_field} <> ''" if is_custom_filter
                  when ">="
                    if [:date, :date_past].include?(type_for(field))
-                     sql = date_clause(db_table, db_field, (Date.parse(value.first) rescue nil), nil)
+                     sql = date_clause(db_table, db_field, parse_date(value.first), nil)
                    else
                      if is_custom_filter
                        sql = "(#{db_table}.#{db_field} <> '' AND CAST(CASE #{db_table}.#{db_field} WHEN '' THEN '0' ELSE #{db_table}.#{db_field} END AS decimal(30,3)) >= #{value.first.to_f})"
                      else
                        sql = "#{db_table}.#{db_field} >= #{value.first.to_f}"
                      end
                    end
                  when "<="
                    if [:date, :date_past].include?(type_for(field))
-                     sql = date_clause(db_table, db_field, nil, (Date.parse(value.first) rescue nil))
+                     sql = date_clause(db_table, db_field, nil, parse_date(value.first))
                    else
                      if is_custom_filter
                        sql = "(#{db_table}.#{db_field} <> '' AND CAST(CASE #{db_table}.#{db_field} WHEN '' THEN '0' ELSE #{db_table}.#{db_field} END AS decimal(30,3)) <= #{value.first.to_f})"
                      else
                        sql = "#{db_table}.#{db_field} <= #{value.first.to_f}"
                      end
                    end
                  when "><"
                    if [:date, :date_past].include?(type_for(field))
-                     sql = date_clause(db_table, db_field, (Date.parse(value[0]) rescue nil), (Date.parse(value[1]) rescue nil))
+                     sql = date_clause(db_table, db_field, parse_date(value[0]), parse_date(value[1]))
                    else
                      if is_custom_filter
                        sql = "(#{db_table}.#{db_field} <> '' AND CAST(CASE #{db_table}.#{db_field} WHEN '' THEN '0' ELSE #{db_table}.#{db_field} END AS decimal(30,3)) BETWEEN #{value[0].to_f} AND #{value[1].to_f})"
                      else
                        sql = "#{db_table}.#{db_field} BETWEEN #{value[0].to_f} AND #{value[1].to_f}"
                      end
                    end
                  when "o"
                    sql = "#{queried_table_name}.status_id IN (SELECT id FROM #{IssueStatus.table_name} WHERE is_closed=#{connection.quoted_false})" if field == "status_id"
                  when "c"
                    sql = "#{queried_table_name}.status_id IN (SELECT id FROM #{IssueStatus.table_name} WHERE is_closed=#{connection.quoted_true})" if field == "status_id"
                  when "><t-"
                    # between today - n days and today
                    sql = relative_date_clause(db_table, db_field, - value.first.to_i, 0)
                  when ">t-"
                    # >= today - n days
                    sql = relative_date_clause(db_table, db_field, - value.first.to_i, nil)
                  when "<t-"
                    # <= today - n days
                    sql = relative_date_clause(db_table, db_field, nil, - value.first.to_i)
                  when "t-"
                    # = n days in past
                    sql = relative_date_clause(db_table, db_field, - value.first.to_i, - value.first.to_i)
                  when "><t+"
                    # between today and today + n days
                    sql = relative_date_clause(db_table, db_field, 0, value.first.to_i)
                  when ">t+"
                    # >= today + n days
                    sql = relative_date_clause(db_table, db_field, value.first.to_i, nil)
                  when "<t+"
                    # <= today + n days
                    sql = relative_date_clause(db_table, db_field, nil, value.first.to_i)
                  when "t+"
                    # = today + n days
                    sql = relative_date_clause(db_table, db_field, value.first.to_i, value.first.to_i)
                  when "t"
                    # = today
                    sql = relative_date_clause(db_table, db_field, 0, 0)
                  when "ld"
                    # = yesterday
                    sql = relative_date_clause(db_table, db_field, -1, -1)
                  when "w"
                    # = this week
                    first_day_of_week = l(:general_first_day_of_week).to_i
                    day_of_week = Date.today.cwday
                    days_ago = (day_of_week >= first_day_of_week ? day_of_week - first_day_of_week : day_of_week + 7 - first_day_of_week)
                    sql = relative_date_clause(db_table, db_field, - days_ago, - days_ago + 6)
                  when "lw"
                    # = last week
                    first_day_of_week = l(:general_first_day_of_week).to_i
                    day_of_week = Date.today.cwday
                    days_ago = (day_of_week >= first_day_of_week ? day_of_week - first_day_of_week : day_of_week + 7 - first_day_of_week)
                    sql = relative_date_clause(db_table, db_field, - days_ago - 7, - days_ago - 1)
                  when "l2w"
                    # = last 2 weeks
                    first_day_of_week = l(:general_first_day_of_week).to_i
                    day_of_week = Date.today.cwday
                    days_ago = (day_of_week >= first_day_of_week ? day_of_week - first_day_of_week : day_of_week + 7 - first_day_of_week)
                    sql = relative_date_clause(db_table, db_field, - days_ago - 14, - days_ago - 1)
                  when "m"
                    # = this month
                    date = Date.today
                    sql = date_clause(db_table, db_field, date.beginning_of_month, date.end_of_month)
                  when "lm"
                    # = last month
                    date = Date.today.prev_month
                    sql = date_clause(db_table, db_field, date.beginning_of_month, date.end_of_month)
                  when "y"
                    # = this year
                    date = Date.today
                    sql = date_clause(db_table, db_field, date.beginning_of_year, date.end_of_year)
                  when "~"
                    sql = "LOWER(#{db_table}.#{db_field}) LIKE '%#{connection.quote_string(value.first.to_s.downcase)}%'"
                  when "!~"
                    sql = "LOWER(#{db_table}.#{db_field}) NOT LIKE '%#{connection.quote_string(value.first.to_s.downcase)}%'"
                  else
                    raise "Unknown query operator #{operator}"
                  end
                  return sql
                end
                # Adds a filter for the given custom field
                def add_custom_field_filter(field, assoc=nil)
                  options = field.format.query_filter_options(field, self)
                  if field.format.target_class && field.format.target_class <= User
                    if options[:values].is_a?(Array) && User.current.logged?
                      options[:values].unshift ["<< #{l(:label_me)} >>", "me"]
                    end
                  end
                  filter_id = "cf_#{field.id}"
                  filter_name = field.name
                  if assoc.present?
                    filter_id = "#{assoc}.#{filter_id}"
                    filter_name = l("label_attribute_of_#{assoc}", :name => filter_name)
                  end
                  add_available_filter filter_id, options.merge({
                    :name => filter_name,
                    :field => field
                  })
                end
                # Adds filters for the given custom fields scope
                def add_custom_fields_filters(scope, assoc=nil)
                  scope.visible.where(:is_filter => true).sorted.each do |field|
                    add_custom_field_filter(field, assoc)
                  end
                end
                # Adds filters for the given associations custom fields
                def add_associations_custom_fields_filters(*associations)
                  fields_by_class = CustomField.visible.where(:is_filter => true).group_by(&:class)
                  associations.each do |assoc|
                    association_klass = queried_class.reflect_on_association(assoc).klass
                    fields_by_class.each do |field_class, fields|
                      if field_class.customized_class <= association_klass
                        fields.sort.each do |field|
                          add_custom_field_filter(field, assoc)
                        end
                      end
                    end
                  end
                end
                # Returns a SQL clause for a date or datetime field.
                def date_clause(table, field, from, to)
                  s = []
                  if from
-                   from_yesterday = from - 1
-                   from_yesterday_time = Time.local(from_yesterday.year, from_yesterday.month, from_yesterday.day)
+                   if from.is_a?(Date)
+                     from = Time.local(from.year, from.month, from.day).beginning_of_day
+                   end
                    if self.class.default_timezone == :utc
-                     from_yesterday_time = from_yesterday_time.utc
+                     from = from.utc
                    end
-                   s << ("#{table}.#{field} > '%s'" % [connection.quoted_date(from_yesterday_time.end_of_day)])
+                   from = from - 1
+                   s << ("#{table}.#{field} > '%s'" % [connection.quoted_date(from)])
                  end
                  if to
-                   to_time = Time.local(to.year, to.month, to.day)
+                   if to.is_a?(Date)
+                     to = Time.local(to.year, to.month, to.day).end_of_day
+                   end
                    if self.class.default_timezone == :utc
-                     to_time = to_time.utc
+                     to = to.utc
                    end
-                   s << ("#{table}.#{field} <= '%s'" % [connection.quoted_date(to_time.end_of_day)])
+                   s << ("#{table}.#{field} <= '%s'" % [connection.quoted_date(to)])
                  end
                  s.join(' AND ')
                end
                # Returns a SQL clause for a date or datetime field using relative dates.
                def relative_date_clause(table, field, days_from, days_to)
                  date_clause(table, field, (days_from ? Date.today + days_from : nil), (days_to ? Date.today + days_to : nil))
                end
+               # Returns a Date or Time from the given filter value
+               def parse_date(arg)
+                 if arg.to_s =~ /\A\d{4}-\d{2}-\d{2}T/
+                   Time.parse(arg) rescue nil
+                 else
+                   Date.parse(arg) rescue nil
+                 end
+               end
                # Additional joins required for the given sort options
                def joins_for_order_statement(order_options)
                  joins = []
                  if order_options
                    if order_options.include?('authors')
                      joins << "LEFT OUTER JOIN #{User.table_name} authors ON authors.id = #{queried_table_name}.author_id"
                    end
                    order_options.scan(/cf_\d+/).uniq.each do |name|
                      column = available_columns.detect {|c| c.name.to_s == name}
                      join = column && column.custom_field.join_for_order_statement
                      if join
                        joins << join
                      end
                    end
                  end
                  joins.any? ? joins.join(' ') : nil
                end
              end

test/integration/api_test/issues_test.rb +23 0

              # Redmine - project management software
              # Copyright (C) 2006-2013  Jean-Philippe Lang
              #
              # This program is free software; you can redistribute it and/or
              # modify it under the terms of the GNU General Public License
              # as published by the Free Software Foundation; either version 2
              # of the License, or (at your option) any later version.
              #
              # This program is distributed in the hope that it will be useful,
              # but WITHOUT ANY WARRANTY; without even the implied warranty of
              # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
              # GNU General Public License for more details.
              #
              # You should have received a copy of the GNU General Public License
              # along with this program; if not, write to the Free Software
              # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
              require File.expand_path('../../../test_helper', __FILE__)
              class Redmine::ApiTest::IssuesTest < Redmine::ApiTest::Base
                fixtures :projects,
                  :users,
                  :roles,
                  :members,
                  :member_roles,
                  :issues,
                  :issue_statuses,
                  :issue_relations,
                  :versions,
                  :trackers,
                  :projects_trackers,
                  :issue_categories,
                  :enabled_modules,
                  :enumerations,
                  :attachments,
                  :workflows,
                  :custom_fields,
                  :custom_values,
                  :custom_fields_projects,
                  :custom_fields_trackers,
                  :time_entries,
                  :journals,
                  :journal_details,
                  :queries,
                  :attachments
                def setup
                  Setting.rest_api_enabled = '1'
                end
                context "/issues" do
                  # Use a private project to make sure auth is really working and not just
                  # only showing public issues.
                  should_allow_api_authentication(:get, "/projects/private-child/issues.xml")
                  should "contain metadata" do
                    get '/issues.xml'
                    assert_tag :tag => 'issues',
                      :attributes => {
                        :type => 'array',
                        :total_count => assigns(:issue_count),
                        :limit => 25,
                        :offset => 0
                      }
                  end
                  context "with offset and limit" do
                    should "use the params" do
                      get '/issues.xml?offset=2&limit=3'
                      assert_equal 3, assigns(:limit)
                      assert_equal 2, assigns(:offset)
                      assert_tag :tag => 'issues', :children => {:count => 3, :only => {:tag => 'issue'}}
                    end
                  end
                  context "with nometa param" do
                    should "not contain metadata" do
                      get '/issues.xml?nometa=1'
                      assert_tag :tag => 'issues',
                        :attributes => {
                          :type => 'array',
                          :total_count => nil,
                          :limit => nil,
                          :offset => nil
                        }
                    end
                  end
                  context "with nometa header" do
                    should "not contain metadata" do
                      get '/issues.xml', {}, {'X-Redmine-Nometa' => '1'}
                      assert_tag :tag => 'issues',
                        :attributes => {
                          :type => 'array',
                          :total_count => nil,
                          :limit => nil,
                          :offset => nil
                        }
                    end
                  end
                  context "with relations" do
                    should "display relations" do
                      get '/issues.xml?include=relations'
                      assert_response :success
                      assert_equal 'application/xml', @response.content_type
                      assert_tag 'relations',
                        :parent => {:tag => 'issue', :child => {:tag => 'id', :content => '3'}},
                        :children => {:count => 1},
                        :child => {
                          :tag => 'relation',
                          :attributes => {:id => '2', :issue_id => '2', :issue_to_id => '3',
                                          :relation_type => 'relates'}
                        }
                      assert_tag 'relations',
                        :parent => {:tag => 'issue', :child => {:tag => 'id', :content => '1'}},
                        :children => {:count => 0}
                    end
                  end
                  context "with invalid query params" do
                    should "return errors" do
                      get '/issues.xml', {:f => ['start_date'], :op => {:start_date => '='}}
                      assert_response :unprocessable_entity
                      assert_equal 'application/xml', @response.content_type
                      assert_tag 'errors', :child => {:tag => 'error', :content => "Start date can't be blank"}
                    end
                  end
                  context "with custom field filter" do
                    should "show only issues with the custom field value" do
                      get '/issues.xml',
                          {:set_filter => 1, :f => ['cf_1'], :op => {:cf_1 => '='},
                           :v => {:cf_1 => ['MySQL']}}
                      expected_ids = Issue.visible.
                          joins(:custom_values).
                          where(:custom_values => {:custom_field_id => 1, :value => 'MySQL'}).map(&:id)
                      assert_select 'issues > issue > id', :count => expected_ids.count do |ids|
                         ids.each { |id| assert expected_ids.delete(id.children.first.content.to_i) }
                      end
                    end
                  end
                  context "with custom field filter (shorthand method)" do
                    should "show only issues with the custom field value" do
                      get '/issues.xml', { :cf_1 => 'MySQL' }
                      expected_ids = Issue.visible.
                          joins(:custom_values).
                          where(:custom_values => {:custom_field_id => 1, :value => 'MySQL'}).map(&:id)
                      assert_select 'issues > issue > id', :count => expected_ids.count do |ids|
                        ids.each { |id| assert expected_ids.delete(id.children.first.content.to_i) }
                      end
                    end
                  end
                end
+               def test_index_should_allow_timestamp_filtering
+                 Issue.delete_all
+                 Issue.generate!(:subject => '1').update_column(:updated_on, Time.parse("2014-01-02T10:25:00Z"))
+                 Issue.generate!(:subject => '2').update_column(:updated_on, Time.parse("2014-01-02T12:13:00Z"))
+                 get '/issues.xml',
+                   {:set_filter => 1, :f => ['updated_on'], :op => {:updated_on => '<='},
+                    :v => {:updated_on => ['2014-01-02T12:00:00Z']}}
+                 assert_select 'issues>issue', :count => 1
+                 assert_select 'issues>issue>subject', :text => '1'
+                 get '/issues.xml',
+                   {:set_filter => 1, :f => ['updated_on'], :op => {:updated_on => '>='},
+                    :v => {:updated_on => ['2014-01-02T12:00:00Z']}}
+                 assert_select 'issues>issue', :count => 1
+                 assert_select 'issues>issue>subject', :text => '2'
+                 get '/issues.xml',
+                   {:set_filter => 1, :f => ['updated_on'], :op => {:updated_on => '>='},
+                    :v => {:updated_on => ['2014-01-02T08:00:00Z']}}
+                 assert_select 'issues>issue', :count => 2
+               end
                context "/index.json" do
                  should_allow_api_authentication(:get, "/projects/private-child/issues.json")
                end
                context "/index.xml with filter" do
                  should "show only issues with the status_id" do
                    get '/issues.xml?status_id=5'
                    expected_ids = Issue.visible.where(:status_id => 5).map(&:id)
                    assert_select 'issues > issue > id', :count => expected_ids.count do |ids|
                       ids.each { |id| assert expected_ids.delete(id.children.first.content.to_i) }
                    end
                  end
                end
                context "/index.json with filter" do
                  should "show only issues with the status_id" do
                    get '/issues.json?status_id=5'
                    json = ActiveSupport::JSON.decode(response.body)
                    status_ids_used = json['issues'].collect {|j| j['status']['id'] }
                    assert_equal 3, status_ids_used.length
                    assert status_ids_used.all? {|id| id == 5 }
                  end
                end
                # Issue 6 is on a private project
                context "/issues/6.xml" do
                  should_allow_api_authentication(:get, "/issues/6.xml")
                end
                context "/issues/6.json" do
                  should_allow_api_authentication(:get, "/issues/6.json")
                end
                context "GET /issues/:id" do
                  context "with journals" do
                    context ".xml" do
                      should "display journals" do
                        get '/issues/1.xml?include=journals'
                        assert_tag :tag => 'issue',
                          :child => {
                            :tag => 'journals',
                            :attributes => { :type => 'array' },
                            :child => {
                              :tag => 'journal',
                              :attributes => { :id => '1'},
                              :child => {
                                :tag => 'details',
                                :attributes => { :type => 'array' },
                                :child => {
                                  :tag => 'detail',
                                  :attributes => { :name => 'status_id' },
                                  :child => {
                                    :tag => 'old_value',
                                    :content => '1',
                                    :sibling => {
                                      :tag => 'new_value',
                                      :content => '2'
                                    }
                                  }
                                }
                              }
                            }
                          }
                      end
                    end
                  end
                  context "with custom fields" do
                    context ".xml" do
                      should "display custom fields" do
                        get '/issues/3.xml'
                        assert_tag :tag => 'issue',
                          :child => {
                            :tag => 'custom_fields',
                            :attributes => { :type => 'array' },
                            :child => {
                              :tag => 'custom_field',
                              :attributes => { :id => '1'},
                              :child => {
                                :tag => 'value',
                                :content => 'MySQL'
                              }
                            }
                          }
                        assert_nothing_raised do
                          Hash.from_xml(response.body).to_xml
                        end
                      end
                    end
                  end
                  context "with multi custom fields" do
                    setup do
                      field = CustomField.find(1)
                      field.update_attribute :multiple, true
                      issue = Issue.find(3)
                      issue.custom_field_values = {1 => ['MySQL', 'Oracle']}
                      issue.save!
                    end
                    context ".xml" do
                      should "display custom fields" do
                        get '/issues/3.xml'
                        assert_response :success
                        assert_tag :tag => 'issue',
                          :child => {
                            :tag => 'custom_fields',
                            :attributes => { :type => 'array' },
                            :child => {
                              :tag => 'custom_field',
                              :attributes => { :id => '1'},
                              :child => {
                                :tag => 'value',
                                :attributes => { :type => 'array' },
                                :children => { :count => 2 }
                              }
                            }
                          }
                        xml = Hash.from_xml(response.body)
                        custom_fields = xml['issue']['custom_fields']
                        assert_kind_of Array, custom_fields
                        field = custom_fields.detect {|f| f['id'] == '1'}
                        assert_kind_of Hash, field
                        assert_equal ['MySQL', 'Oracle'], field['value'].sort
                      end
                    end
                    context ".json" do
                      should "display custom fields" do
                        get '/issues/3.json'
                        assert_response :success
                        json = ActiveSupport::JSON.decode(response.body)
                        custom_fields = json['issue']['custom_fields']
                        assert_kind_of Array, custom_fields
                        field = custom_fields.detect {|f| f['id'] == 1}
                        assert_kind_of Hash, field
                        assert_equal ['MySQL', 'Oracle'], field['value'].sort
                      end
                    end
                  end
                  context "with empty value for multi custom field" do
                    setup do
                      field = CustomField.find(1)
                      field.update_attribute :multiple, true
                      issue = Issue.find(3)
                      issue.custom_field_values = {1 => ['']}
                      issue.save!
                    end
                    context ".xml" do
                      should "display custom fields" do
                        get '/issues/3.xml'
                        assert_response :success
                        assert_tag :tag => 'issue',
                          :child => {
                            :tag => 'custom_fields',
                            :attributes => { :type => 'array' },
                            :child => {
                              :tag => 'custom_field',
                              :attributes => { :id => '1'},
                              :child => {
                                :tag => 'value',
                                :attributes => { :type => 'array' },
                                :children => { :count => 0 }
                              }
                            }
                          }
                        xml = Hash.from_xml(response.body)
                        custom_fields = xml['issue']['custom_fields']
                        assert_kind_of Array, custom_fields
                        field = custom_fields.detect {|f| f['id'] == '1'}
                        assert_kind_of Hash, field
                        assert_equal [], field['value']
                      end
                    end
                    context ".json" do
                      should "display custom fields" do
                        get '/issues/3.json'
                        assert_response :success
                        json = ActiveSupport::JSON.decode(response.body)
                        custom_fields = json['issue']['custom_fields']
                        assert_kind_of Array, custom_fields
                        field = custom_fields.detect {|f| f['id'] == 1}
                        assert_kind_of Hash, field
                        assert_equal [], field['value'].sort
                      end
                    end
                  end
                  context "with attachments" do
                    context ".xml" do
                      should "display attachments" do
                        get '/issues/3.xml?include=attachments'
                        assert_tag :tag => 'issue',
                          :child => {
                            :tag => 'attachments',
                            :children => {:count => 5},
                            :child => {
                              :tag => 'attachment',
                              :child => {
                                :tag => 'filename',
                                :content => 'source.rb',
                                :sibling => {
                                  :tag => 'content_url',
                                  :content => 'http://www.example.com/attachments/download/4/source.rb'
                                }
                              }
                            }
                          }
                      end
                    end
                  end
                  context "with subtasks" do
                    setup do
                      @c1 = Issue.create!(
                              :status_id => 1, :subject => "child c1",
                              :tracker_id => 1, :project_id => 1, :author_id => 1,
                              :parent_issue_id => 1
                            )
                      @c2 = Issue.create!(
                              :status_id => 1, :subject => "child c2",
                              :tracker_id => 1, :project_id => 1, :author_id => 1,
                              :parent_issue_id => 1
                            )
                      @c3 = Issue.create!(
                              :status_id => 1, :subject => "child c3",
                              :tracker_id => 1, :project_id => 1, :author_id => 1,
                              :parent_issue_id => @c1.id
                            )
                    end
                    context ".xml" do
                      should "display children" do
                        get '/issues/1.xml?include=children'
                        assert_tag :tag => 'issue',
                          :child => {
                            :tag => 'children',
                            :children => {:count => 2},
                            :child => {
                              :tag => 'issue',
                              :attributes => {:id => @c1.id.to_s},
                              :child => {
                                :tag => 'subject',
                                :content => 'child c1',
                                :sibling => {
                                  :tag => 'children',
                                  :children => {:count => 1},
                                  :child => {
                                    :tag => 'issue',
                                    :attributes => {:id => @c3.id.to_s}
                                  }
                                }
                              }
                            }
                          }
                      end
                      context ".json" do
                        should "display children" do
                          get '/issues/1.json?include=children'
                          json = ActiveSupport::JSON.decode(response.body)
                          assert_equal([
                            {
                              'id' => @c1.id, 'subject' => 'child c1', 'tracker' => {'id' => 1, 'name' => 'Bug'},
                              'children' => [{'id' => @c3.id, 'subject' => 'child c3',
                                              'tracker' => {'id' => 1, 'name' => 'Bug'} }]
                            },
                            { 'id' => @c2.id, 'subject' => 'child c2', 'tracker' => {'id' => 1, 'name' => 'Bug'} }
                            ],
                            json['issue']['children'])
                        end
                      end
                    end
                  end
                end
                test "GET /issues/:id.xml?include=watchers should include watchers" do
                  Watcher.create!(:user_id => 3, :watchable => Issue.find(1))
                  get '/issues/1.xml?include=watchers', {}, credentials('jsmith')
                  assert_response :ok
                  assert_equal 'application/xml', response.content_type
                  assert_select 'issue' do
                    assert_select 'watchers', Issue.find(1).watchers.count
                    assert_select 'watchers' do
                      assert_select 'user[id=3]'
                    end
                  end
                end
                context "POST /issues.xml" do
                  should_allow_api_authentication(
                    :post,
                    '/issues.xml',
                    {:issue => {:project_id => 1, :subject => 'API test', :tracker_id => 2, :status_id => 3}},
                    {:success_code => :created}
                  )
                  should "create an issue with the attributes" do
                    assert_difference('Issue.count') do
                      post '/issues.xml',
                           {:issue => {:project_id => 1, :subject => 'API test',
                            :tracker_id => 2, :status_id => 3}}, credentials('jsmith')
                    end
                    issue = Issue.first(:order => 'id DESC')
                    assert_equal 1, issue.project_id
                    assert_equal 2, issue.tracker_id
                    assert_equal 3, issue.status_id
                    assert_equal 'API test', issue.subject
                    assert_response :created
                    assert_equal 'application/xml', @response.content_type
                    assert_tag 'issue', :child => {:tag => 'id', :content => issue.id.to_s}
                  end
                end
                test "POST /issues.xml with watcher_user_ids should create issue with watchers" do
                  assert_difference('Issue.count') do
                    post '/issues.xml',
                         {:issue => {:project_id => 1, :subject => 'Watchers',
                          :tracker_id => 2, :status_id => 3, :watcher_user_ids => [3, 1]}}, credentials('jsmith')
                    assert_response :created
                  end
                  issue = Issue.order('id desc').first
                  assert_equal 2, issue.watchers.size
                  assert_equal [1, 3], issue.watcher_user_ids.sort
                end
                context "POST /issues.xml with failure" do
                  should "have an errors tag" do
                    assert_no_difference('Issue.count') do
                      post '/issues.xml', {:issue => {:project_id => 1}}, credentials('jsmith')
                    end
                    assert_tag :errors, :child => {:tag => 'error', :content => "Subject can't be blank"}
                  end
                end
                context "POST /issues.json" do
                  should_allow_api_authentication(:post,
                                                  '/issues.json',
                                                  {:issue => {:project_id => 1, :subject => 'API test',
                                                   :tracker_id => 2, :status_id => 3}},
                                                  {:success_code => :created})
                  should "create an issue with the attributes" do
                    assert_difference('Issue.count') do
                      post '/issues.json',
                           {:issue => {:project_id => 1, :subject => 'API test',
                                       :tracker_id => 2, :status_id => 3}},
                           credentials('jsmith')
                    end
                    issue = Issue.first(:order => 'id DESC')
                    assert_equal 1, issue.project_id
                    assert_equal 2, issue.tracker_id
                    assert_equal 3, issue.status_id
                    assert_equal 'API test', issue.subject
                  end
                end
                context "POST /issues.json with failure" do
                  should "have an errors element" do
                    assert_no_difference('Issue.count') do
                      post '/issues.json', {:issue => {:project_id => 1}}, credentials('jsmith')
                    end
                    json = ActiveSupport::JSON.decode(response.body)
                    assert json['errors'].include?("Subject can't be blank")
                  end
                end
                # Issue 6 is on a private project
                context "PUT /issues/6.xml" do
                  setup do
                    @parameters = {:issue => {:subject => 'API update', :notes => 'A new note'}}
                  end
                  should_allow_api_authentication(:put,
                                                  '/issues/6.xml',
                                                  {:issue => {:subject => 'API update', :notes => 'A new note'}},
                                                  {:success_code => :ok})
                  should "not create a new issue" do
                    assert_no_difference('Issue.count') do
                      put '/issues/6.xml', @parameters, credentials('jsmith')
                    end
                  end
                  should "create a new journal" do
                    assert_difference('Journal.count') do
                      put '/issues/6.xml', @parameters, credentials('jsmith')
                    end
                  end
                  should "add the note to the journal" do
                    put '/issues/6.xml', @parameters, credentials('jsmith')
                    journal = Journal.last
                    assert_equal "A new note", journal.notes
                  end
                  should "update the issue" do
                    put '/issues/6.xml', @parameters, credentials('jsmith')
                    issue = Issue.find(6)
                    assert_equal "API update", issue.subject
                  end
                end
                context "PUT /issues/3.xml with custom fields" do
                  setup do
                    @parameters = {
                      :issue => {:custom_fields => [{'id' => '1', 'value' => 'PostgreSQL' },
                      {'id' => '2', 'value' => '150'}]}
                    }
                  end
                  should "update custom fields" do
                    assert_no_difference('Issue.count') do
                      put '/issues/3.xml', @parameters, credentials('jsmith')
                    end
                    issue = Issue.find(3)
                    assert_equal '150', issue.custom_value_for(2).value
                    assert_equal 'PostgreSQL', issue.custom_value_for(1).value
                  end
                end
                context "PUT /issues/3.xml with multi custom fields" do
                  setup do
                    field = CustomField.find(1)
                    field.update_attribute :multiple, true
                    @parameters = {
                      :issue => {:custom_fields => [{'id' => '1', 'value' => ['MySQL', 'PostgreSQL'] },
                      {'id' => '2', 'value' => '150'}]}
                    }
                  end
                  should "update custom fields" do
                    assert_no_difference('Issue.count') do
                      put '/issues/3.xml', @parameters, credentials('jsmith')
                    end
                    issue = Issue.find(3)
                    assert_equal '150', issue.custom_value_for(2).value
                    assert_equal ['MySQL', 'PostgreSQL'], issue.custom_field_value(1).sort
                  end
                end
                context "PUT /issues/3.xml with project change" do
                  setup do
                    @parameters = {:issue => {:project_id => 2, :subject => 'Project changed'}}
                  end
                  should "update project" do
                    assert_no_difference('Issue.count') do
                      put '/issues/3.xml', @parameters, credentials('jsmith')
                    end
                    issue = Issue.find(3)
                    assert_equal 2, issue.project_id
                    assert_equal 'Project changed', issue.subject
                  end
                end
                context "PUT /issues/6.xml with failed update" do
                  setup do
                    @parameters = {:issue => {:subject => ''}}
                  end
                  should "not create a new issue" do
                    assert_no_difference('Issue.count') do
                      put '/issues/6.xml', @parameters, credentials('jsmith')
                    end
                  end
                  should "not create a new journal" do
                    assert_no_difference('Journal.count') do
                      put '/issues/6.xml', @parameters, credentials('jsmith')
                    end
                  end
                  should "have an errors tag" do
                    put '/issues/6.xml', @parameters, credentials('jsmith')
                    assert_tag :errors, :child => {:tag => 'error', :content => "Subject can't be blank"}
                  end
                end
                context "PUT /issues/6.json" do
                  setup do
                    @parameters = {:issue => {:subject => 'API update', :notes => 'A new note'}}
                  end
                  should_allow_api_authentication(:put,
                                                  '/issues/6.json',
                                                  {:issue => {:subject => 'API update', :notes => 'A new note'}},
                                                  {:success_code => :ok})
                  should "update the issue" do
                    assert_no_difference('Issue.count') do
                      assert_difference('Journal.count') do
                        put '/issues/6.json', @parameters, credentials('jsmith')
                        assert_response :ok
                        assert_equal '', response.body
                      end
                    end
                    issue = Issue.find(6)
                    assert_equal "API update", issue.subject
                    journal = Journal.last
                    assert_equal "A new note", journal.notes
                  end
                end
                context "PUT /issues/6.json with failed update" do
                  should "return errors" do
                    assert_no_difference('Issue.count') do
                      assert_no_difference('Journal.count') do
                        put '/issues/6.json', {:issue => {:subject => ''}}, credentials('jsmith')
                        assert_response :unprocessable_entity
                      end
                    end
                    json = ActiveSupport::JSON.decode(response.body)
                    assert json['errors'].include?("Subject can't be blank")
                  end
                end
                context "DELETE /issues/1.xml" do
                  should_allow_api_authentication(:delete,
                                                  '/issues/6.xml',
                                                  {},
                                                  {:success_code => :ok})
                  should "delete the issue" do
                    assert_difference('Issue.count', -1) do
                      delete '/issues/6.xml', {}, credentials('jsmith')
                      assert_response :ok
                      assert_equal '', response.body
                    end
                    assert_nil Issue.find_by_id(6)
                  end
                end
                context "DELETE /issues/1.json" do
                  should_allow_api_authentication(:delete,
                                                  '/issues/6.json',
                                                  {},
                                                  {:success_code => :ok})
                  should "delete the issue" do
                    assert_difference('Issue.count', -1) do
                      delete '/issues/6.json', {}, credentials('jsmith')
                      assert_response :ok
                      assert_equal '', response.body
                    end
                    assert_nil Issue.find_by_id(6)
                  end
                end
                test "POST /issues/:id/watchers.xml should add watcher" do
                  assert_difference 'Watcher.count' do
                    post '/issues/1/watchers.xml', {:user_id => 3}, credentials('jsmith')
                    assert_response :ok
                    assert_equal '', response.body
                  end
                  watcher = Watcher.order('id desc').first
                  assert_equal Issue.find(1), watcher.watchable
                  assert_equal User.find(3), watcher.user
                end
                test "DELETE /issues/:id/watchers/:user_id.xml should remove watcher" do
                  Watcher.create!(:user_id => 3, :watchable => Issue.find(1))
                  assert_difference 'Watcher.count', -1 do
                    delete '/issues/1/watchers/3.xml', {}, credentials('jsmith')
                    assert_response :ok
                    assert_equal '', response.body
                  end
                  assert_equal false, Issue.find(1).watched_by?(User.find(3))
                end
                def test_create_issue_with_uploaded_file
                  set_tmp_attachments_directory
                  # upload the file
                  assert_difference 'Attachment.count' do
                    post '/uploads.xml', 'test_create_with_upload',
                         {"CONTENT_TYPE" => 'application/octet-stream'}.merge(credentials('jsmith'))
                    assert_response :created
                  end
                  xml = Hash.from_xml(response.body)
                  token = xml['upload']['token']
                  attachment = Attachment.first(:order => 'id DESC')
                  # create the issue with the upload's token
                  assert_difference 'Issue.count' do
                    post '/issues.xml',
                         {:issue => {:project_id => 1, :subject => 'Uploaded file',
                                     :uploads => [{:token => token, :filename => 'test.txt',
                                                   :content_type => 'text/plain'}]}},
                         credentials('jsmith')
                    assert_response :created
                  end
                  issue = Issue.first(:order => 'id DESC')
                  assert_equal 1, issue.attachments.count
                  assert_equal attachment, issue.attachments.first
                  attachment.reload
                  assert_equal 'test.txt', attachment.filename
                  assert_equal 'text/plain', attachment.content_type
                  assert_equal 'test_create_with_upload'.size, attachment.filesize
                  assert_equal 2, attachment.author_id
                  # get the issue with its attachments
                  get "/issues/#{issue.id}.xml", :include => 'attachments'
                  assert_response :success
                  xml = Hash.from_xml(response.body)
                  attachments = xml['issue']['attachments']
                  assert_kind_of Array, attachments
                  assert_equal 1, attachments.size
                  url = attachments.first['content_url']
                  assert_not_nil url
                  # download the attachment
                  get url
                  assert_response :success
                end
                def test_update_issue_with_uploaded_file
                  set_tmp_attachments_directory
                  # upload the file
                  assert_difference 'Attachment.count' do
                    post '/uploads.xml', 'test_upload_with_upload',
                         {"CONTENT_TYPE" => 'application/octet-stream'}.merge(credentials('jsmith'))
                    assert_response :created
                  end
                  xml = Hash.from_xml(response.body)
                  token = xml['upload']['token']
                  attachment = Attachment.first(:order => 'id DESC')
                  # update the issue with the upload's token
                  assert_difference 'Journal.count' do
                    put '/issues/1.xml',
                        {:issue => {:notes => 'Attachment added',
                                    :uploads => [{:token => token, :filename => 'test.txt',
                                                  :content_type => 'text/plain'}]}},
                        credentials('jsmith')
                    assert_response :ok
                    assert_equal '', @response.body
                  end
                  issue = Issue.find(1)
                  assert_include attachment, issue.attachments
                end
              end

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages