v2gpti 1.1.9 → 1.2.0

data/tracker_api/lib/tracker_api/endpoints/tasks.rb

@@ -0,0 +1,20 @@
+module TrackerApi
+  module Endpoints
+    class Tasks
+      attr_accessor :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      def get(project_id, story_id,  params={})
+        data = client.paginate("/projects/#{project_id}/stories/#{story_id}/tasks", params: params)
+        raise TrackerApi::Errors::UnexpectedData, 'Array of tasks expected' unless data.is_a? Array
+
+        data.map do |task|
+          Resources::Task.new({ story_id: story_id }.merge(task))
+        end
+      end
+    end
+  end
+end

data/tracker_api/lib/tracker_api/error.rb

@@ -0,0 +1,18 @@
+module TrackerApi
+  class Error < StandardError
+    attr_reader :wrapped_exception, :response
+
+    def initialize(wrapped_exception)
+      @wrapped_exception = wrapped_exception
+      @response          = wrapped_exception.response
+      message            = if wrapped_exception.is_a?(Faraday::Error::ParsingError)
+                             wrapped_exception.message
+                           elsif wrapped_exception.is_a?(Faraday::Error::ClientError)
+                             wrapped_exception.response.inspect
+                           else
+                             wrapped_exception.instance_variable_get(:@wrapped_exception).inspect
+                           end
+      super(message)
+    end
+  end
+end

data/tracker_api/lib/tracker_api/logger.rb

@@ -0,0 +1,31 @@
+module TrackerApi
+  class Logger < Faraday::Response::Middleware
+    extend Forwardable
+
+    def initialize(app, logger = nil)
+      super(app)
+      @logger = logger || ::Logger.new(STDOUT)
+    end
+
+    def_delegators :@logger, :debug, :info, :warn, :error, :fatal
+
+    def call(env)
+      info("#{env[:method]} => #{env[:url].to_s}")
+      debug('request') { dump_headers env[:request_headers] }
+      debug('request.body') { env[:body] }
+      super
+    end
+
+    def on_complete(env)
+      info("#{env[:status]} <= #{env[:url].to_s}")
+      debug('response') { dump_headers env[:response_headers] }
+      debug('response.body') { env[:body] }
+    end
+
+    private
+
+    def dump_headers(headers)
+      headers.map { |k, v| "#{k}: #{v.inspect}" }.join("\n")
+    end
+  end
+end

data/tracker_api/lib/tracker_api/resources/account.rb

@@ -0,0 +1,18 @@
+module TrackerApi
+  module Resources
+    class Account
+      include Virtus.model
+
+      attribute :id, Integer
+      attribute :created_at, DateTime
+      attribute :status, String
+      attribute :kind, String
+      attribute :name, String
+      attribute :updated_at, DateTime
+      attribute :url, String
+      attribute :plan, String
+      attribute :days_left, Integer
+      attribute :over_the_limit, Boolean
+    end
+  end
+end

data/tracker_api/lib/tracker_api/resources/activity.rb

@@ -0,0 +1,24 @@
+module TrackerApi
+  module Resources
+    class Activity
+      include Virtus.model
+
+      attribute :client
+
+      attribute :kind, String
+      attribute :guid, String
+      attribute :project_version, Integer
+      attribute :message, String
+      attribute :highlight, String
+      attribute :changes, Array[TrackerApi::Resources::Change]
+      attribute :primary_resources, Array[TrackerApi::Resources::PrimaryResource]
+      attribute :project, TrackerApi::Resources::Project
+      attribute :performed_by, TrackerApi::Resources::Person
+      attribute :occurred_at, DateTime
+
+      def project=(data)
+        super.client = client
+      end
+    end
+  end
+end

data/tracker_api/lib/tracker_api/resources/base.rb

@@ -0,0 +1,71 @@
+require 'virtus'
+require 'active_support/concern'
+require 'active_model'
+
+module TrackerApi
+  module Resources
+    module Base
+      extend ActiveSupport::Concern
+
+      include ActiveModel::Model
+      include ActiveModel::Dirty
+
+      included do
+        include Virtus.model
+        include OverrideAttributes
+
+        attribute :id, Integer
+
+        def initialize(attrs)
+          super
+
+          # always reset dirty tracking on initialize
+          clear_changes_information
+        end
+
+        private
+
+        # @return [Hash] key value pairs for just the changed attributes with their new values.
+        def just_changes
+          # @see changes in ActiveModel::Dirty in active_model/dirty.rb
+          #     { attr => [original value, new value] }
+          changes.inject({}) do |h, (k, v)|
+            h[k] = v[1]; h;
+          end
+        end
+      end
+
+      module OverrideAttributes
+        extend ActiveSupport::Concern
+
+        module ClassMethods
+          def attribute(name, type, options = {})
+            define_attribute_methods name
+
+            attribute = super
+            create_writer_with_dirty_tracking(name)
+            attribute
+          end
+
+          private
+
+          def create_writer_with_dirty_tracking(name)
+            method_str = <<-RUBY
+              def #{name}=(value)
+                prev_value = #{name}
+                new_value  = value
+                if prev_value != new_value
+                  #{name}_will_change!
+                  new_value = super(value)
+                end
+                new_value
+              end
+            RUBY
+
+            class_eval method_str, __FILE__, __LINE__ + 1
+          end
+        end
+      end
+    end
+  end
+end

data/tracker_api/lib/tracker_api/resources/change.rb

@@ -0,0 +1,15 @@
+module TrackerApi
+  module Resources
+    class Change
+      include Virtus.model
+
+      attribute :change_type, String
+      attribute :id, Integer
+      attribute :kind, String
+      attribute :name, String
+      attribute :new_values, Hash
+      attribute :original_values, Hash
+      attribute :story_type, String
+    end
+  end
+end

data/tracker_api/lib/tracker_api/resources/comment.rb

@@ -0,0 +1,20 @@
+module TrackerApi
+  module Resources
+    class Comment
+      include Virtus.model
+
+      attribute :id, Integer
+      attribute :story_id, Integer
+      attribute :epic_id, Integer
+      attribute :text, String
+      attribute :person_id, Integer
+      attribute :created_at, DateTime
+      attribute :updated_at, DateTime
+      attribute :file_attachment_ids, Array[Integer]
+      attribute :google_attachment_ids, Array[Integer]
+      attribute :commit_identifier, String
+      attribute :commit_type, String
+      attribute :kind, String
+    end
+  end
+end

data/tracker_api/lib/tracker_api/resources/epic.rb

@@ -0,0 +1,17 @@
+module TrackerApi
+  module Resources
+    class Epic
+      include Virtus.model
+
+      attribute :id, Integer
+      attribute :created_at, DateTime
+      attribute :description, String
+      attribute :kind, String
+      attribute :label, TrackerApi::Resources::Label
+      attribute :name, String
+      attribute :project_id, Integer
+      attribute :updated_at, DateTime
+      attribute :url, String
+    end
+  end
+end

data/tracker_api/lib/tracker_api/resources/file_attachment.rb

@@ -0,0 +1,23 @@
+module TrackerApi
+  module Resources
+    class FileAttachment
+      include Virtus.model
+
+      attribute :id, Integer
+      attribute :filename, String
+      attribute :created_at, DateTime
+      attribute :uploader_id, Integer
+      attribute :thumbnailable, Boolean
+      attribute :height, Integer
+      attribute :width, Integer
+      attribute :size, Integer
+      attribute :download_url, String
+      attribute :content_type, String
+      attribute :uploaded, Boolean
+      attribute :big_url, String
+      attribute :thumbnail_url, String
+      attribute :kind, String
+
+    end
+  end
+end

data/tracker_api/lib/tracker_api/resources/iteration.rb

@@ -0,0 +1,24 @@
+module TrackerApi
+  module Resources
+    class Iteration
+      include Virtus.model
+
+      attribute :client
+
+      attribute :finish, DateTime
+      attribute :kind, String
+      attribute :length, Integer
+      attribute :number, Integer
+      attribute :planned, Boolean
+      attribute :project_id, Integer
+      attribute :start, DateTime
+      attribute :stories, [TrackerApi::Resources::Story]
+      attribute :story_ids, [Integer]
+      attribute :team_strength, Float
+
+      def stories=(data)
+        super.each { |s| s.client = client }
+      end
+    end
+  end
+end

data/tracker_api/lib/tracker_api/resources/label.rb

@@ -0,0 +1,14 @@
+module TrackerApi
+  module Resources
+    class Label
+      include Virtus.model
+
+      attribute :id, Integer
+      attribute :created_at, DateTime
+      attribute :kind, String
+      attribute :name, String
+      attribute :project_id, Integer
+      attribute :updated_at, DateTime
+    end
+  end
+end

data/tracker_api/lib/tracker_api/resources/me.rb

@@ -0,0 +1,21 @@
+module TrackerApi
+  module Resources
+    class Me
+      include Virtus.model
+
+      attribute :id, Integer
+      attribute :name, String
+      attribute :initials, String
+      attribute :username, String
+      attribute :time_zone, TrackerApi::Resources::TimeZone
+      attribute :api_token, String
+      attribute :has_google_identity, Boolean
+      attribute :project_ids, Array[Integer]
+      attribute :projects, [TrackerApi::Resources::MembershipSummary]
+      attribute :workspace_ids, Array[Integer]
+      attribute :email, String
+      attribute :receives_in_app_notifications, Boolean
+      attribute :kind, String
+    end
+  end
+end

data/tracker_api/lib/tracker_api/resources/membership_summary.rb

@@ -0,0 +1,15 @@
+module TrackerApi
+  module Resources
+    class MembershipSummary
+      include Virtus.model
+
+      attribute :id, Integer
+      attribute :kind, String
+      attribute :last_viewed_at, DateTime
+      attribute :project_color, String
+      attribute :project_id, Integer
+      attribute :project_name, String
+      attribute :role, String
+    end
+  end
+end

data/tracker_api/lib/tracker_api/resources/notification.rb

@@ -0,0 +1,26 @@
+module TrackerApi
+  module Resources
+    class Notification
+      include Virtus.model
+
+      attribute :client
+
+      attribute :id, Integer
+      attribute :message, String
+      attribute :kind, String
+      attribute :project, TrackerApi::Resources::Project
+      attribute :story, TrackerApi::Resources::Story
+      attribute :performer, TrackerApi::Resources::Person
+      attribute :created_at, DateTime
+      attribute :updated_at, DateTime
+
+      def project=(data)
+        super.client = client
+      end
+
+      def story=(data)
+        super.client = client
+      end
+    end
+  end
+end

data/tracker_api/lib/tracker_api/resources/person.rb

@@ -0,0 +1,14 @@
+module TrackerApi
+  module Resources
+    class Person
+      include Virtus.model
+
+      attribute :kind, String
+      attribute :id, Integer
+      attribute :name, String
+      attribute :email, String
+      attribute :initials, String
+      attribute :username, String
+    end
+  end
+end

data/tracker_api/lib/tracker_api/resources/primary_resource.rb

@@ -0,0 +1,13 @@
+module TrackerApi
+  module Resources
+    class PrimaryResource
+      include Virtus.model
+
+      attribute :id, Integer
+      attribute :kind, String
+      attribute :name, String
+      attribute :story_type, String
+      attribute :url, String
+    end
+  end
+end

data/tracker_api/lib/tracker_api/resources/project.rb

@@ -0,0 +1,131 @@
+module TrackerApi
+  module Resources
+    class Project
+      include Virtus.model
+
+      attribute :client
+
+      attribute :account, TrackerApi::Resources::Account
+      attribute :account_id, Integer
+      attribute :atom_enabled, Boolean
+      attribute :bugs_and_chores_are_estimatable, Boolean
+      attribute :created_at, DateTime
+      attribute :current_iteration_number, Integer
+      attribute :current_velocity, Integer
+      attribute :description, String
+      attribute :enable_following, Boolean
+      attribute :enable_incoming_emails, Boolean
+      attribute :enable_planned_mode, Boolean
+      attribute :enable_tasks, Boolean
+      attribute :epic_ids, Array[Integer]
+      attribute :epics, Array[TrackerApi::Resources::Epic]
+      attribute :has_google_domain, Boolean
+      attribute :id, Integer
+      attribute :initial_velocity, Integer
+      attribute :iteration_length, Integer
+      attribute :kind, String
+      attribute :label_ids, Array[Integer]
+      attribute :labels, Array[TrackerApi::Resources::Label]
+      attribute :name, String
+      attribute :number_of_done_iterations_to_show, Integer
+      attribute :point_scale, String
+      attribute :point_scale_is_custom, Boolean
+      attribute :profile_content, String
+      attribute :public, Boolean
+      attribute :start_date, DateTime
+      attribute :start_time, DateTime
+      attribute :time_zone, TrackerApi::Resources::TimeZone
+      attribute :updated_at, DateTime
+      attribute :velocity_averaged_over, Integer
+      attribute :version, Integer
+      attribute :week_start_day, String
+
+      # @return [String] comma separated list of labels
+      def label_list
+        @label_list ||= labels.collect(&:name).join(',')
+      end
+
+      # @param [Hash] params
+      # @return [Array[Epic]] epics associated with this project
+      def epics(params={})
+        raise ArgumentError, 'Expected @epics to be an Array' unless @epics.is_a? Array
+        return @epics unless @epics.empty?
+
+        @epics = Endpoints::Epics.new(client).get(id, params)
+      end
+
+      # @param [Hash] params
+      # @option params [String] :scope Restricts the state of iterations to return.
+      #   If not specified, it defaults to all iterations including done.
+      #   Valid enumeration values: done, current, backlog, current_backlog.
+      # @option params [Integer] :number The iteration to retrieve, starting at 1
+      # @option params [Integer] :offset The offset of first iteration to return, relative to the
+      #   set of iterations specified by 'scope', with zero being the first iteration in the scope.
+      # @option params [Integer] :limit The number of iterations to return relative to the offset.
+      # @return [Array[Iteration]] iterations associated with this project
+      def iterations(params = {})
+        if params.include?(:number)
+          number = params[:number].to_i
+          raise ArgumentError, ':number must be > 0' unless number > 0
+
+          params = params.merge(auto_paginate: false, limit: 1)
+          params.delete(:number)
+
+          offset          = number - 1
+          params[:offset] = offset if offset > 0
+        end
+
+        Endpoints::Iterations.new(client).get(id, params)
+      end
+
+      # @param [Hash] params
+      # @option params [String] :with_label A label name which all returned stories must match.
+      # @option params [String] :with_state A story's current_state which all returned stories must match.
+      #   Valid enumeration values: accepted, delivered, finished, started, rejected, unstarted, unscheduled
+      # @option params [String] :filter This parameter supplies a search string;
+      #   only stories that match the search criteria are returned.
+      #   Cannot be used together with any other parameters except limit and offset.
+      #   ex) state:started requester:OWK label:"jedi stuff" keyword
+      # @option params [Integer] :offset With the first story in your priority list as 0,
+      #   the index of the first story you want returned.
+      # @option params [Integer] :limit The number of stories you want returned.
+      # @return [Array[Story]] stories associated with this project
+      def stories(params = {})
+        Endpoints::Stories.new(client).get(id, params)
+      end
+
+      # @param [Hash] params
+      # @return [Array[ProjectMembership]] memberships of this project
+      def memberships(params = {})
+        Endpoints::Memberships.new(client).get(id, params)
+      end
+
+      # Provides a list of all the activity performed on a project.
+      #
+      # @param [Hash] params
+      # @return [Array[Activity]]
+      def activity(params = {})
+        Endpoints::Activity.new(client).get_project(id, params)
+      end
+
+      # @param [Fixnum] story_id id of story to get
+      # @return [Story] story with given id
+      def story(story_id)
+        Endpoints::Story.new(client).get(id, story_id)
+      end
+
+      # @param [Hash] params attributes to create the story with
+      # @return [Story] newly created Story
+      def create_story(params)
+        Endpoints::Story.new(client).create(id, params)
+      end
+
+      # @file_name [String] name of the file to be uploaded. Full path to be specified
+      # @content_type [String] content type of the file.
+      # @return [FileAttachment] newly created FileAttachment.
+      def add_attachment(file_name, content_type)
+        Endpoints::FileAttachment.new(client).create(id, file_name, content_type)
+      end
+    end
+  end
+end

data/tracker_api/lib/tracker_api/resources/project_membership.rb

@@ -0,0 +1,16 @@
+module TrackerApi
+  module Resources
+    class ProjectMembership
+      include Virtus.model
+
+      attribute :id, Integer
+      attribute :person_id, Integer
+      attribute :project_id, Integer
+      attribute :role, String
+      attribute :project_color, String
+      attribute :wants_comment_notification_emails, Boolean
+      attribute :kind, String
+      attribute :person, TrackerApi::Resources::Person
+    end
+  end
+end

data/tracker_api/lib/tracker_api/resources/story.rb

@@ -0,0 +1,102 @@
+module TrackerApi
+  module Resources
+    class Story
+      include TrackerApi::Resources::Base
+
+      attribute :client
+
+      attribute :accepted_at, DateTime
+      attribute :comment_ids, Array[Integer]
+      attribute :comments, Array[TrackerApi::Resources::Comment]
+      attribute :created_at, DateTime
+      attribute :current_state, String # (accepted, delivered, finished, started, rejected, planned, unstarted, unscheduled)
+      attribute :deadline, DateTime
+      attribute :description, String
+      attribute :estimate, Float
+      attribute :external_id, String
+      attribute :follower_ids, Array[Integer]
+      attribute :integration_id, Integer
+      attribute :kind, String
+      attribute :label_ids, Array[Integer]
+      attribute :labels, Array[TrackerApi::Resources::Label]
+      attribute :name, String
+      attribute :owned_by_id, Integer # deprecated!
+      attribute :owner_ids, Array[Integer]
+      attribute :owners, Array[TrackerApi::Resources::Person]
+      attribute :planned_iteration_number, Integer
+      attribute :project_id, Integer
+      attribute :requested_by_id, Integer
+      attribute :story_type, String # (feature, bug, chore, release)
+      attribute :task_ids, Array[Integer]
+      attribute :tasks, Array[TrackerApi::Resources::Task]
+      attribute :updated_at, DateTime
+      attribute :url, String
+      attribute :before_id, Integer
+      attribute :after_id, Integer
+
+      # @return [String] Comma separated list of labels.
+      def label_list
+        @label_list ||= labels.collect(&:name).join(',')
+      end
+
+      # Provides a list of all the activity performed on the story.
+      #
+      # @param [Hash] params
+      # @return [Array[Activity]]
+      def activity(params = {})
+        Endpoints::Activity.new(client).get_story(project_id, id, params)
+      end
+
+      # Provides a list of all the comments on the story.
+      #
+      # @param [Hash] params
+      # @return [Array[Comment]]
+      def comments(params = {})
+        if @comments.any?
+          @comments
+        else
+          @comments = Endpoints::Comments.new(client).get(project_id, id, params)
+        end
+      end
+
+      # @param [Hash] params
+      # @return [Array[Task]]
+      def tasks(params = {})
+        if @tasks.any?
+          @tasks
+        else
+          @tasks = Endpoints::Tasks.new(client).get(project_id, id, params)
+        end
+      end
+
+      # Save changes to an existing Story.
+      def save
+        raise ArgumentError, 'Can not update a story with an unknown project_id.' if project_id.nil?
+
+        Endpoints::Story.new(client).update(self, just_changes)
+
+        changes_applied
+      end
+
+      # update labels.This method can also be used to remove labels.
+      def add_labels(*new_labels)
+        raise ArgumentError, 'Can not update a story with an unknown project_id.' if project_id.nil?
+        raise ArgumentError, 'Provide at lease one label name' if new_labels.empty?
+
+        Endpoints::Story.new(client).update(self, {:labels => new_labels.map{|l| {:name => l.to_s}}})
+
+        changes_applied
+      end
+
+      # Add an existing attachment to the story
+      def add_comment_with_attachment(text, file_attachment)
+        raise ArgumentError, 'Can not update a story with an unknown project_id.' if project_id.nil?
+
+        comment = {:text => text, :file_attachments => [file_attachment.attributes]}
+        Endpoints::Comments.new(client).create_with_attachment(project_id, id, text, file_attachment)
+
+        changes_applied
+      end
+    end
+  end
+end

data/tracker_api/lib/tracker_api/resources/task.rb

@@ -0,0 +1,16 @@
+module TrackerApi
+  module Resources
+    class Task
+      include Virtus.model
+
+      attribute :id, Integer
+      attribute :story_id, Integer
+      attribute :description, String
+      attribute :complete, Boolean
+      attribute :position, Integer
+      attribute :created_at, DateTime
+      attribute :updated_at, DateTime
+      attribute :kind, String
+    end
+  end
+end

data/tracker_api/lib/tracker_api/resources/time_zone.rb

@@ -0,0 +1,13 @@
+module TrackerApi
+  module Resources
+    class TimeZone
+      include Virtus.value_object
+
+      values do
+        attribute :offset, String
+        attribute :olson_name, String
+        attribute :kind, String
+      end
+    end
+  end
+end