redmine_rest 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 47cace2287f24338aefe30d5a70f510d3ac4720b
-  data.tar.gz: bc42629a5bdba3e5a222ce5dade6b8d29782bb9f
+  metadata.gz: c650caea3e5f25a8dd23a954d48a9c12e0837c4d
+  data.tar.gz: c7e03f5bb55417b07afca18e2cb45dce898b17b6
 SHA512:
-  metadata.gz: b79646ee24677762a75bf20314b98e82406f7652b84b2b3b9c6fec2854eadaf88c9e523c12922c1ca436bde2670bb52f3c429c85c1dd56c86bbaa2e682ab2d2a
-  data.tar.gz: 2e5799a39d574563b4e2a5732e53e14e61a5eb8a98ad1f869c3b7a017fbc7669ebfbd1b3cbe6f0e1a8128bf838d35f32d0488565071633700c23ae5db4ecfda8
+  metadata.gz: 9a67c5f368edab616da3de28b6f0a0bdce2fce1d0a66f253f856d43993c75b654c7f36f7b1bfa05a29e504a8a2868fb3f992ee976102e0d16b9fb49eb01c0e2f
+  data.tar.gz: 7f5745029e7de897d4bb84864563d127e254edd97f64583a7689f06ccefe22676acddd27b3051ab306ff349398390eff304532aa55054e4a8f38a5380a5290f9

data/lib/redmine_rest/models/collections/base.rb

@@ -0,0 +1,18 @@
+require 'active_resource'
+require 'unicode'
+
+module RedmineRest
+  module Models
+    module Collections
+      #
+      # Base class for most custom collections
+      #
+      class Base < ActiveResource::Collection
+        def filter_by_name_substring(str)
+          str = Unicode.downcase(str)
+          self.class.new @elements.find_all { |e| Unicode.downcase(e.name).include? str }
+        end
+      end
+    end
+  end
+end

data/lib/redmine_rest/models/group.rb

@@ -0,0 +1,15 @@
+require 'active_resource'
+
+require_relative 'collections/base'
+
+module RedmineRest
+  module Models
+    #
+    # Group model. Right now it cant work with user lists (add, delete and so on)
+    #
+    class Group < ActiveResource::Base
+      self.format = :xml
+      self.collection_parser = Collections::Base
+    end
+  end
+end

data/lib/redmine_rest/models/issue_priority.rb

@@ -0,0 +1,21 @@
+require 'active_resource'
+
+require_relative 'collections/base'
+
+module RedmineRest
+  module Models
+    #
+    # issue priority model
+    #
+    class IssuePriority < ActiveResource::Base
+      self.format = :xml
+      self.collection_parser = Collections::Base
+      self.prefix = '/enumerations/'
+
+      def self.find(*args)
+        fail('Issue priorities can be loaded as :all only') unless args.size == 1 && args.first == :all
+        super
+      end
+    end
+  end
+end

data/lib/redmine_rest/models/issue_status.rb

@@ -1,6 +1,6 @@
 require 'active_resource'
 
-require_relative 'collections/issue_status'
+require_relative 'collections/base'
 
 module RedmineRest
   module Models
@@ -9,13 +9,11 @@ module RedmineRest
     #
     class IssueStatus < ActiveResource::Base
       self.format = :xml
-      self.collection_parser = Collections::IssueStatus
+      self.collection_parser = Collections::Base
 
       def self.find(*args)
         fail('Issue statuses can be loaded as :all only') unless args.size == 1 && args.first == :all
-
-        return @statuses if @statuses
-        @statuses = super
+        super
       end
     end
   end

data/lib/redmine_rest/models/membership.rb

@@ -0,0 +1,29 @@
+require 'active_resource'
+
+require_relative 'collections/base'
+require_relative 'user'
+require_relative 'group'
+
+module RedmineRest
+  module Models
+    #
+    # Membership model
+    #
+    class Membership < ActiveResource::Base
+      self.format = :xml
+      self.collection_parser = Collections::Base
+      self.prefix = '/projects/:project_id/'
+
+      has_one :user, class_name: User
+      has_one :group, class_name: Group
+
+      #
+      # Overrides parent method.
+      # When we want to fetch one membership, we need not to use prefix
+      #
+      def self.element_path(id, _prefix_options = {}, query_options = nil)
+        "/memberships/#{URI.parser.escape id.to_s}#{format_extension}#{query_string(query_options)}"
+      end
+    end
+  end
+end

data/lib/redmine_rest/models/project.rb

@@ -1,6 +1,9 @@
 require 'active_resource'
 
-require_relative 'collections/project'
+require_relative 'tracker'
+require_relative 'collections/base'
+require_relative 'version'
+require_relative 'membership'
 
 module RedmineRest
   module Models
@@ -9,7 +12,42 @@ module RedmineRest
     #
     class Project < ActiveResource::Base
       self.format = :xml
-      self.collection_parser = Collections::Project
+      self.collection_parser = Collections::Base
+
+      has_many :trackers, class_name: Tracker
+
+      #
+      # Adds trackers to request.
+      #
+      def self.find(scope, options = {})
+        options[:params] = {} unless options[:params]
+        params = options[:params]
+
+        if params[:include]
+          params[:include] += ',trackers'
+        else # doubling is not bad
+          params[:include] = 'trackers'
+        end
+
+        super(scope, options)
+      end
+
+      def versions
+        Version.all params: { project_id: id }
+      end
+
+      def memberships
+        Membership.all params: { project_id: id }
+      end
+
+      def members(options = {})
+        users = memberships
+                .map { |m| m.user? ? m.user : m.group.reload.users }
+                .flatten
+        users.map(&:reload) if options[:reload]
+
+        Collections::Base.new(users)
+      end
     end
   end
 end

data/lib/redmine_rest/models/relation.rb

@@ -9,26 +9,18 @@ module RedmineRest
       TYPES = %w(relates duplicates duplicated blocks blocked precedes follows copied_to copied_from).freeze
 
       self.format = :xml
+      self.prefix = '/issues/:issue_id/'
 
       validate :validate_relation_type,
                :validate_issue_id,
                :validate_issue_to_id
 
-      def self.set_prefix
-        self.prefix = '/issues/:issue_id'
-      end
-
-      set_prefix
-
-      def self.find(what, options = {})
-        if what == :all
-          super
-        else
-          self.prefix = '/'
-          result = super
-          set_prefix
-          result
-        end
+      #
+      # Overrides parent method.
+      # When we want to fetch one relation, we need not to use prefix
+      #
+      def self.element_path(id, _prefix_options = {}, query_options = nil)
+        "/relations/#{URI.parser.escape id.to_s}#{format_extension}#{query_string(query_options)}"
       end
 
       private

data/lib/redmine_rest/models/time_entry_activity.rb

@@ -0,0 +1,21 @@
+require 'active_resource'
+
+require_relative 'collections/base'
+
+module RedmineRest
+  module Models
+    #
+    # time entry activity model
+    #
+    class TimeEntryActivity < ActiveResource::Base
+      self.format = :xml
+      self.collection_parser = Collections::Base
+      self.prefix = '/enumerations/'
+
+      def self.find(*args)
+        fail('Issue priorities can be loaded as :all only') unless args.size == 1 && args.first == :all
+        super
+      end
+    end
+  end
+end

data/lib/redmine_rest/models/tracker.rb

@@ -1,6 +1,6 @@
 require 'active_resource'
 
-require_relative 'collections/tracker'
+require_relative 'collections/base'
 
 module RedmineRest
   module Models
@@ -9,13 +9,11 @@ module RedmineRest
     #
     class Tracker < ActiveResource::Base
       self.format = :xml
-      self.collection_parser = Collections::Tracker
+      self.collection_parser = Collections::Base
 
       def self.find(*args)
         fail('Trackers can be loaded as :all only') unless args.size == 1 && args.first == :all
-
-        return @trackers if @trackers
-        @trackers = super
+        super
       end
     end
   end

data/lib/redmine_rest/models/version.rb

@@ -1,6 +1,6 @@
 require 'active_resource'
 
-require_relative 'collections/version'
+require_relative 'collections/base'
 
 module RedmineRest
   module Models
@@ -9,7 +9,16 @@ module RedmineRest
     #
     class Version < ActiveResource::Base
       self.format = :xml
-      self.collection_parser = Collections::Version
+      self.collection_parser = Collections::Base
+      self.prefix = '/projects/:project_id/'
+
+      #
+      # Overrides parent method.
+      # When we want to fetch one version, we need not to use prefix
+      #
+      def self.element_path(id, _prefix_options = {}, query_options = nil)
+        "/versions/#{URI.parser.escape id.to_s}#{format_extension}#{query_string(query_options)}"
+      end
     end
   end
 end

data/lib/redmine_rest/models.rb

@@ -1,11 +1,29 @@
+require 'active_resource'
+
 Dir[File.expand_path('../models/*.rb', __FILE__)].each { |f| require f }
 
+module ActiveResource
+  #
+  # some monkey-patching
+  #
+  class Base
+    def self.find_by_id(id)
+      find(id)
+    rescue ActiveResource::ResourceNotFound
+      nil
+    end
+  end
+end
+
 module RedmineRest
   #
   # Namespace for models + some self-methods
   #
   module Models
-    LIST = [Issue, User, Project, IssueStatus, TimeEntry, Tracker, Relation].freeze
+    LIST = constants
+           .map { |symbol| const_get(symbol) }
+           .find_all { |const| const.is_a?(Class) && const < ActiveResource::Base }
+           .freeze
 
     def self.configure_models(params)
       ModelConfigurator.new.configure_models(params)

data/lib/redmine_rest/version.rb

@@ -1,3 +1,3 @@
 module RedmineRest
-  VERSION = '0.5.2'.freeze
+  VERSION = '0.6.0'.freeze
 end

data/lib/redmine_rest.rb

@@ -1,3 +1,2 @@
 require 'redmine_rest/version'
-Dir[File.expand_path('../redmine_rest/helpers/**/*.rb', __FILE__)].each { |f| require f }
 require 'redmine_rest/models'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redmine_rest
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.0
 platform: ruby
 authors:
 - Dmitriy Non
@@ -111,18 +111,18 @@ files:
 - bin/console
 - bin/setup
 - lib/redmine_rest.rb
-- lib/redmine_rest/helpers/collection.rb
 - lib/redmine_rest/models.rb
+- lib/redmine_rest/models/collections/base.rb
 - lib/redmine_rest/models/collections/issue.rb
-- lib/redmine_rest/models/collections/issue_status.rb
-- lib/redmine_rest/models/collections/project.rb
-- lib/redmine_rest/models/collections/tracker.rb
-- lib/redmine_rest/models/collections/version.rb
+- lib/redmine_rest/models/group.rb
 - lib/redmine_rest/models/issue.rb
+- lib/redmine_rest/models/issue_priority.rb
 - lib/redmine_rest/models/issue_status.rb
+- lib/redmine_rest/models/membership.rb
 - lib/redmine_rest/models/project.rb
 - lib/redmine_rest/models/relation.rb
 - lib/redmine_rest/models/time_entry.rb
+- lib/redmine_rest/models/time_entry_activity.rb
 - lib/redmine_rest/models/tracker.rb
 - lib/redmine_rest/models/user.rb
 - lib/redmine_rest/models/version.rb

data/lib/redmine_rest/helpers/collection.rb

@@ -1,16 +0,0 @@
-require 'active_resource'
-require 'unicode'
-
-module RedmineRest
-  module Helpers
-    #
-    # some methods for ActiveResource collections
-    #
-    module Collection
-      def filter_by_name_substring(str)
-        str = Unicode.downcase(str)
-        self.class.new @elements.find_all { |e| Unicode.downcase(e.name).include? str }
-      end
-    end
-  end
-end

data/lib/redmine_rest/models/collections/issue_status.rb

@@ -1,14 +0,0 @@
-require 'active_resource'
-
-module RedmineRest
-  module Models
-    module Collections
-      #
-      # Methods for status collections
-      #
-      class IssueStatus < ActiveResource::Collection
-        include Helpers::Collection
-      end
-    end
-  end
-end

data/lib/redmine_rest/models/collections/project.rb

@@ -1,14 +0,0 @@
-require 'active_resource'
-
-module RedmineRest
-  module Models
-    module Collections
-      #
-      # Methods for project collections
-      #
-      class Project < ActiveResource::Collection
-        include Helpers::Collection
-      end
-    end
-  end
-end

data/lib/redmine_rest/models/collections/tracker.rb

@@ -1,14 +0,0 @@
-require 'active_resource'
-
-module RedmineRest
-  module Models
-    module Collections
-      #
-      # Methods for tracker collections
-      #
-      class Tracker < ActiveResource::Collection
-        include Helpers::Collection
-      end
-    end
-  end
-end

data/lib/redmine_rest/models/collections/version.rb

@@ -1,14 +0,0 @@
-require 'active_resource'
-
-module RedmineRest
-  module Models
-    module Collections
-      #
-      # Methods for version collections
-      #
-      class Version < ActiveResource::Collection
-        include Helpers::Collection
-      end
-    end
-  end
-end