tracker_api 0.2.9 → 0.2.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eb0f996134be9b6af61da9dbb41f47c23bbc79fd
-  data.tar.gz: 3172bee693120381ce20b5f83c2037e604d7edd7
+  metadata.gz: a617d2b19c294a813a8edf94eed605c18daa6969
+  data.tar.gz: 8d05e8a155dcdf15e84c0efaba86dcd6b1914e86
 SHA512:
-  metadata.gz: 95c7d010ab3c59f30944c14a760736d5f3ebab13caeac8c8eed4471347a464b26bb34af3094e10af131ff254a8b2fedc4bc532717058853033cfd0c5b63dd2ac
-  data.tar.gz: 4d1a3bd5ac33807a8219c05e7ad995b905857e960d4dee6ddf582e19a255c346102c0385b304d903672eb4fc098dee9579b6b255154fdf86808512491c1a98a6
+  metadata.gz: 374ec16671b186d2309513d2419e7839f98b0e71e88fee635660a18f2f5a406e5133cc24252fc8cebb6a5094d2b3cdc725edf879ad94c4bf585aa79ded685fd9
+  data.tar.gz: b8b668d588b2e6ffc4fd8455d0ef0b288e5f25c8ed896385fc707e35f608639e93781aef742aec4ef9483b48ef54a9ae8cf9e01fba4cc38dd43f2563d5f47de4

data/.travis.yml

@@ -3,6 +3,7 @@ rvm:
   - "1.9.3"
   - "2.0.0"
   - "2.1.0"
+  - "2.2.2"
   # Faraday::ConnectionFailed: Could not generate DH keypair (Java::JavaLang::RuntimeException)
   # http://bugs.java.com/bugdatabase/view_bug.do?bug_id=7044060
   #  - jruby-19mode # JRuby in 1.9 mode

data/README.md

@@ -53,6 +53,7 @@ story.activity                                                            # Get
 
 story.name = 'Save the Ewoks'                                             # Update a single story attribute
 story.attributes = { name: 'Save the Ewoks', description: '...' }         # Update multiple story attributes
+story.labels << Label.new(name: 'Endor')                                  # Add a new label to an existing story
 story.save                                                                # Save changes made to a story
 
 epics = project.epics                                                     # Get all epics for a project

data/lib/core_ext/object/blank.rb

@@ -0,0 +1,132 @@
+# encoding: utf-8
+
+# Borrowed from: activesupport-4.2.2/lib/active_support/core_ext/object/blank.rb
+class Object
+  # An object is blank if it's false, empty, or a whitespace string.
+  # For example, '', '   ', +nil+, [], and {} are all blank.
+  #
+  # This simplifies
+  #
+  #   address.nil? || address.empty?
+  #
+  # to
+  #
+  #   address.blank?
+  #
+  # @return [true, false]
+  def blank?
+    respond_to?(:empty?) ? !!empty? : !self
+  end
+
+  # An object is present if it's not blank.
+  #
+  # @return [true, false]
+  def present?
+    !blank?
+  end
+
+  # Returns the receiver if it's present otherwise returns +nil+.
+  # <tt>object.presence</tt> is equivalent to
+  #
+  #    object.present? ? object : nil
+  #
+  # For example, something like
+  #
+  #   state   = params[:state]   if params[:state].present?
+  #   country = params[:country] if params[:country].present?
+  #   region  = state || country || 'US'
+  #
+  # becomes
+  #
+  #   region = params[:state].presence || params[:country].presence || 'US'
+  #
+  # @return [Object]
+  def presence
+    self if present?
+  end
+end
+
+class NilClass
+  # +nil+ is blank:
+  #
+  #   nil.blank? # => true
+  #
+  # @return [true]
+  def blank?
+    true
+  end
+end
+
+class FalseClass
+  # +false+ is blank:
+  #
+  #   false.blank? # => true
+  #
+  # @return [true]
+  def blank?
+    true
+  end
+end
+
+class TrueClass
+  # +true+ is not blank:
+  #
+  #   true.blank? # => false
+  #
+  # @return [false]
+  def blank?
+    false
+  end
+end
+
+class Array
+  # An array is blank if it's empty:
+  #
+  #   [].blank?      # => true
+  #   [1,2,3].blank? # => false
+  #
+  # @return [true, false]
+  alias_method :blank?, :empty?
+end
+
+class Hash
+  # A hash is blank if it's empty:
+  #
+  #   {}.blank?                # => true
+  #   { key: 'value' }.blank?  # => false
+  #
+  # @return [true, false]
+  alias_method :blank?, :empty?
+end
+
+class String
+  BLANK_RE = /\A[[:space:]]*\z/
+
+  # A string is blank if it's empty or contains whitespaces only:
+  #
+  #   ''.blank?       # => true
+  #   '   '.blank?    # => true
+  #   "\t\n\r".blank? # => true
+  #   ' blah '.blank? # => false
+  #
+  # Unicode whitespace is supported:
+  #
+  #   "\u00a0".blank? # => true
+  #
+  # @return [true, false]
+  def blank?
+    BLANK_RE === self
+  end
+end
+
+class Numeric #:nodoc:
+  # No number is blank:
+  #
+  #   1.blank? # => false
+  #   0.blank? # => false
+  #
+  # @return [false]
+  def blank?
+    false
+  end
+end

data/lib/tracker_api/client.rb

@@ -187,7 +187,7 @@ module TrackerApi
       headers = options[:headers]
 
       if (method == :post || method == :put) && options[:body].blank?
-        body                    = params.to_json
+        body                    = Oj.dump(params)
         headers['Content-Type'] = 'application/json'
 
         params = {}

data/lib/tracker_api/endpoints/comments.rb

@@ -7,7 +7,7 @@ module TrackerApi
         @client = client
       end
 
-      def get(project_id, story_id,  params={})
+      def get(project_id, story_id, params={})
         data = client.paginate("/projects/#{project_id}/stories/#{story_id}/comments", params: params)
         raise TrackerApi::Errors::UnexpectedData, 'Array of comments expected' unless data.is_a? Array
 

data/lib/tracker_api/endpoints/epic.rb

@@ -7,8 +7,8 @@ module TrackerApi
         @client = client
       end
 
-      def get(project_id, id)
-        data = client.get("/projects/#{project_id}/epics/#{id}").body
+      def get(project_id, id, params={})
+        data = client.get("/projects/#{project_id}/epics/#{id}", params: params).body
 
         Resources::Epic.new({ project_id: project_id }.merge(data))
       end

data/lib/tracker_api/endpoints/labels.rb

@@ -0,0 +1,26 @@
+module TrackerApi
+  module Endpoints
+    class Labels
+      attr_accessor :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      def get(project_id, params={})
+        data = client.paginate("/projects/#{project_id}/labels", params: params)
+        raise TrackerApi::Errors::UnexpectedData, 'Array of labels expected' unless data.is_a? Array
+
+        data.map do |label|
+          Resources::Label.new({ project_id: project_id }.merge(label))
+        end
+      end
+
+      def add(project_id, params={})
+        data = client.post("/projects/#{project_id}/labels", params: params).body
+
+        Resources::Label.new({ project_id: project_id }.merge(data))
+      end
+    end
+  end
+end

data/lib/tracker_api/endpoints/memberships.rb

@@ -15,6 +15,12 @@ module TrackerApi
           Resources::ProjectMembership.new({ project_id: project_id }.merge(membership))
         end
       end
+
+      def add(project_id, params={})
+        data = client.post("/projects/#{project_id}/memberships", params: params).body
+
+        Resources::ProjectMembership.new({ project_id: project_id }.merge(data))
+      end
     end
   end
 end

data/lib/tracker_api/endpoints/story.rb

@@ -7,14 +7,14 @@ module TrackerApi
         @client = client
       end
 
-      def get(project_id, id)
-        data = client.get("/projects/#{project_id}/stories/#{id}").body
+      def get(project_id, id, params={})
+        data = client.get("/projects/#{project_id}/stories/#{id}", params: params).body
 
         Resources::Story.new({ client: client, project_id: project_id }.merge(data))
       end
 
-      def get_story(story_id)
-        data = client.get("/stories/#{story_id}").body
+      def get_story(story_id, params={})
+        data = client.get("/stories/#{story_id}", params: params).body
 
         Resources::Story.new({ client: client }.merge(data))
       end

data/lib/tracker_api/endpoints/task.rb

@@ -0,0 +1,16 @@
+module TrackerApi
+  module Endpoints
+    class Task
+      attr_accessor :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      def create(project_id, story_id, params={})
+        data = client.post("/projects/#{project_id}/stories/#{story_id}/tasks", params: params).body
+        Resources::Task.new(data)
+      end
+    end
+  end
+end

data/lib/tracker_api/endpoints/tasks.rb

@@ -7,7 +7,7 @@ module TrackerApi
         @client = client
       end
 
-      def get(project_id, story_id,  params={})
+      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/lib/tracker_api/resources/account.rb

@@ -1,9 +1,8 @@
 module TrackerApi
   module Resources
     class Account
-      include Virtus.model
+      include Resources::Base
 
-      attribute :id, Integer
       attribute :created_at, DateTime
       attribute :status, String
       attribute :kind, String

data/lib/tracker_api/resources/activity.rb

@@ -3,6 +3,8 @@ module TrackerApi
     class Activity
       include Virtus.model
 
+      include Equalizer.new(:guid)
+
       attribute :client
 
       attribute :kind, String
@@ -10,10 +12,10 @@ module TrackerApi
       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 :changes, Array[Resources::Change]
+      attribute :primary_resources, Array[Resources::PrimaryResource]
+      attribute :project, Resources::Project
+      attribute :performed_by, Resources::Person
       attribute :occurred_at, DateTime
 
       def project=(data)

data/lib/tracker_api/resources/base.rb

@@ -1,69 +1,14 @@
 require 'virtus'
-require 'active_support/concern'
-require 'active_model'
 
 module TrackerApi
   module Resources
     module Base
-      extend ActiveSupport::Concern
+      def self.included(base)
+        base.class_eval do
+          include Virtus.model
+          include Equalizer.new(:id)
 
-      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
+          attribute :id, Integer
         end
       end
     end

data/lib/tracker_api/resources/change.rb

@@ -1,10 +1,9 @@
 module TrackerApi
   module Resources
     class Change
-      include Virtus.model
+      include Resources::Base
 
       attribute :change_type, String
-      attribute :id, Integer
       attribute :kind, String
       attribute :name, String
       attribute :new_values, Hash

data/lib/tracker_api/resources/comment.rb

@@ -1,9 +1,8 @@
 module TrackerApi
   module Resources
     class Comment
-      include Virtus.model
+      include Resources::Base
 
-      attribute :id, Integer
       attribute :story_id, Integer
       attribute :epic_id, Integer
       attribute :text, String

data/lib/tracker_api/resources/epic.rb

@@ -1,9 +1,8 @@
 module TrackerApi
   module Resources
     class Epic
-      include Virtus.model
+      include Resources::Base
 
-      attribute :id, Integer
       attribute :created_at, DateTime
       attribute :description, String
       attribute :kind, String

data/lib/tracker_api/resources/iteration.rb

@@ -3,6 +3,8 @@ module TrackerApi
     class Iteration
       include Virtus.model
 
+      include Equalizer.new(:number, :project_id)
+
       attribute :client
 
       attribute :finish, DateTime

data/lib/tracker_api/resources/label.rb

@@ -1,14 +1,20 @@
 module TrackerApi
   module Resources
     class Label
-      include Virtus.model
+      include Resources::Base
 
-      attribute :id, Integer
       attribute :created_at, DateTime
       attribute :kind, String
       attribute :name, String
       attribute :project_id, Integer
       attribute :updated_at, DateTime
+
+      class UpdateRepresenter < Representable::Decorator
+        include Representable::JSON
+
+        property :id
+        property :name
+      end
     end
   end
 end

data/lib/tracker_api/resources/me.rb

@@ -1,9 +1,8 @@
 module TrackerApi
   module Resources
     class Me
-      include Virtus.model
+      include Resources::Base
 
-      attribute :id, Integer
       attribute :name, String
       attribute :initials, String
       attribute :username, String

data/lib/tracker_api/resources/membership_summary.rb

@@ -1,9 +1,8 @@
 module TrackerApi
   module Resources
     class MembershipSummary
-      include Virtus.model
+      include Resources::Base
 
-      attribute :id, Integer
       attribute :kind, String
       attribute :last_viewed_at, DateTime
       attribute :project_color, String

data/lib/tracker_api/resources/notification.rb

@@ -1,11 +1,10 @@
 module TrackerApi
   module Resources
     class Notification
-      include Virtus.model
+      include Resources::Base
 
       attribute :client
 
-      attribute :id, Integer
       attribute :message, String
       attribute :kind, String
       attribute :project, TrackerApi::Resources::Project

data/lib/tracker_api/resources/person.rb

@@ -1,10 +1,9 @@
 module TrackerApi
   module Resources
     class Person
-      include Virtus.model
+      include Resources::Base
 
       attribute :kind, String
-      attribute :id, Integer
       attribute :name, String
       attribute :email, String
       attribute :initials, String

data/lib/tracker_api/resources/primary_resource.rb

@@ -1,9 +1,8 @@
 module TrackerApi
   module Resources
     class PrimaryResource
-      include Virtus.model
+      include Resources::Base
 
-      attribute :id, Integer
       attribute :kind, String
       attribute :name, String
       attribute :story_type, String

data/lib/tracker_api/resources/project.rb

@@ -1,7 +1,7 @@
 module TrackerApi
   module Resources
     class Project
-      include Virtus.model
+      include Resources::Base
 
       attribute :client
 
@@ -20,7 +20,6 @@ module TrackerApi
       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
@@ -45,6 +44,25 @@ module TrackerApi
         @label_list ||= labels.collect(&:name).join(',')
       end
 
+      # @return [Integer] comma separated list of label_ids
+      def label_ids
+        @label_ids ||= labels.collect(&:id).join(',')
+      end
+
+      # Provides a list of all the labels on the project.
+      #
+      # @param [Hash] params
+      # @return [Array[Label]] labels of this project
+      def labels(params = {})
+        if @labels && @labels.any?
+          @labels
+        else
+          @labels = Endpoints::Labels.new(client).get(id, params)
+        end
+      end
+
+      # Provides a list of all the epics in the project.
+      #
       # @param [Hash] params
       # @return [Array[Epic]] epics associated with this project
       def epics(params={})
@@ -54,6 +72,8 @@ module TrackerApi
         @epics = Endpoints::Epics.new(client).get(id, params)
       end
 
+      # Provides a list of all the iterations in the project.
+      #
       # @param [Hash] params
       # @option params [String] :scope Restricts the state of iterations to return.
       #   If not specified, it defaults to all iterations including done.
@@ -63,7 +83,7 @@ module TrackerApi
       #   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 = {})
+      def iterations(params={})
         if params.include?(:number)
           number = params[:number].to_i
           raise ArgumentError, ':number must be > 0' unless number > 0
@@ -78,6 +98,9 @@ module TrackerApi
         Endpoints::Iterations.new(client).get(id, params)
       end
 
+
+      # Provides a list of all the stories in the project.
+      #
       # @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.
@@ -90,13 +113,15 @@ module TrackerApi
       #   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 = {})
+      def stories(params={})
         Endpoints::Stories.new(client).get(id, params)
       end
 
+      # Provides a list of all the memberships in the project.
+      #
       # @param [Hash] params
       # @return [Array[ProjectMembership]] memberships of this project
-      def memberships(params = {})
+      def memberships(params={})
         Endpoints::Memberships.new(client).get(id, params)
       end
 
@@ -104,21 +129,33 @@ module TrackerApi
       #
       # @param [Hash] params
       # @return [Array[Activity]]
-      def activity(params = {})
+      def activity(params={})
         Endpoints::Activity.new(client).get_project(id, params)
       end
 
+      # Find a story by id for the project.
+      #
       # @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)
+      def story(story_id, params={})
+        Endpoints::Story.new(client).get(id, story_id, params)
       end
 
+      # Create a new story in the project.
+      #
       # @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
+
+      # Add a new membership for the project.
+      #
+      # @param [Hash] params attributes to add a member; must have at least email or user_id
+      # @return [ProjectMembership] member that was added to project
+      def add_membership(params)
+        Endpoints::Memberships.new(client).add(id, params)
+      end
     end
   end
 end

data/lib/tracker_api/resources/project_membership.rb

@@ -1,9 +1,8 @@
 module TrackerApi
   module Resources
     class ProjectMembership
-      include Virtus.model
+      include Resources::Base
 
-      attribute :id, Integer
       attribute :person_id, Integer
       attribute :project_id, Integer
       attribute :role, String