pivit 0.1.1 → 0.1.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MmY2ZDM0YjUyNTk0ODIzMjhlYjA0ZGI5ODk3NDQwZjRjMDE3YmQ2MA==
+    OGZiYmQ4OGFhZGNiZGVkMTFiYmMyMDIyNGE2ODUzZjU3YzdkZDhmZg==
   data.tar.gz: !binary |-
-    YmY2ZWZjZWZhM2JkMjEyMTNmNjMxNGQ4ZTI1NDEyOTE4YmZjYThhYQ==
+    YjZmZjhhODE2ZWY2Y2Y3YmM3NTUyM2I4MGQ5NzY5NmZmMDA0ODE2Nw==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MmMzNWRkYThmZDhjMDEzMjc1OWU2YmEzNzI2Zjg4NjJhZDUwN2RjNmVhYWVk
-    N2M3ODY0YjQ1NGUwYjY2MDhjY2UzMWJiMmNmYjhhNTc1MDlkMTliOWZhNWY2
-    ZTNkNGNiZjM3MGNiNWU3NGMyMmU1MTRjZDlhZDEyOTk3MDBiNDM=
+    MDRmNTllMjEzOGM2ZTkxOTlkMWFiZTJiYzQzYTAxYTZhZGFiMzUyZGE1ODli
+    NjFhMGVhMjE0OGQxMTRiMTMyMmFmYzZlMzJhYTNmNmU0N2E4MmNmYmZlYmYx
+    ZTUyZjE5MWIyOTMwNWE4MWMyZjdiN2ZjOTYyMjgxZWU1NjJjM2I=
   data.tar.gz: !binary |-
-    YTMzMTkwMzgxZTZkOTIyYzU4NmUzMTc5YTBjN2JmZjJiNDExYmZkZDQ4NGE2
-    ZTM1M2VkZmRhMzVhMThmOGY0MjkyZTk4MmM1YzE0MTczNTU3YWVkMTA4ODgy
-    ODQ1OWZiNWRkN2UwYjM2ZGQ0ZDIyMzhkZjlmOGI2MzdlYmE2NDM=
+    ZmNiNGEzODFhNTQzYTRlNzIyNjRkOWJkNjg4NzQ3OGRmMWE2MDIwZjA1NWMy
+    NDlhOTgyMDQ5YTA1ZDgyYzNmMGYzNTgyMTcxOTg5YTFhN2RmZWViZTFiMWRi
+    ZWY2M2E5Zjc4YWJmY2M3YWE5NzMxN2EwYTU3ZGRiYmYyZDM0YWI=

data/README.md

@@ -1,4 +1,4 @@
-# Pivit 
+# Pivit [![Build Status](https://travis-ci.org/jasontruluck/pivit.png?branch=master)](https://travis-ci.org/jasontruluck/pivit)
 
 Pivit is a api wrapper for the Pivotal Tracker API. Most features are currently
 build out but some are still being implemented.

data/lib/pivit/client/activity.rb

@@ -2,29 +2,29 @@ module Pivit
   class Client
     # Activity management
     # 
-    # @see http://www.pivotaltracker.com/help/api?version=v3#getting_activity
+    # @see https://www.pivotaltracker.com/help/api?version=v3#get_activity
     module Activity
       # Retrieve all activity from your account
       #
       # Pass any of the specified query parameters via options 
+      #
       # Available from Pivotal Tracker:
-      # limit - you can limit the number of activity feed items to a desired
-      # number. Note the default value is 10, and there is a upper cap of 100
-      # occurred_since_date - allows restricting the activity feed to only those
-      # items that occurred after a supplied date (example format: 2009/12/18
-      # 21:00:00 UTC)
-      # newer_than_version - allows restricting the activity feed to only those
-      # items that have a greater than supplied version
       #
-      # @see http://www.pivotaltracker.com/help/api?version=v3#getting_activity
+      # limit - you can limit the number of activity feed items to a desired number. Note the default value is 10, and there is a upper cap of 100
+      #
+      # occurred_since_date - allows restricting the activity feed to only those items that occurred after a supplied date (example format: 2009/12/18 21:00:00 UTC)
+      #
+      # newer_than_version - allows restricting the activity feed to only those items that have a greater than supplied version
+      #
+      # @see https://www.pivotaltracker.com/help/api?version=v3#get_activity
       #
       # @return [Hashie::Mash] activity response
       #
-      # @example 
+      # @example
       #   Pivit::Client.activity
       #
       #   Pivit::Client.activity({:limit => 50})
-      # 
+      #
       # @author Jason Truluck
       def activity(options = {})
         get("activities", options).activities

data/lib/pivit/client/iteration.rb

@@ -2,11 +2,11 @@ module Pivit
   class Client
     # Iteration management
     # 
-    # @see http://www.pivotaltracker.com/help/api?version=v3#getting_iterations
+    # @see https://www.pivotaltracker.com/help/api?version=v3#get_iterations
     module Iteration
       # Retrieve all iterations from the project
       #
-      # @see http://www.pivotaltracker.com/help/api?version=v3#getting_iterations
+      # @see https://www.pivotaltracker.com/help/api?version=v3#get_iterations
       #
       # @param project_id the id of the project
       #
@@ -22,7 +22,7 @@ module Pivit
 
       # Retrieve all done iterations from the project
       #
-      # @see http://www.pivotaltracker.com/help/api?version=v3#getting_iterations
+      # @see https://www.pivotaltracker.com/help/api?version=v3#get_iterations
       #
       # @param project_id the id of the project
       #
@@ -36,9 +36,9 @@ module Pivit
         get("projects/#{project_id}/iterations/done", options).iterations
       end
 
-      # Retrieve all iterations from the project
+      # Retrieve all backlog iterations group from the project
       #
-      # @see http://www.pivotaltracker.com/help/api?version=v3#getting_iterations
+      # @see https://www.pivotaltracker.com/help/api?version=v3#get_iterations
       #
       # @param project_id the id of the project
       #
@@ -52,9 +52,9 @@ module Pivit
         get("projects/#{project_id}/iterations/backlog", options).iterations
       end
 
-      # Retrieve all iterations from the project
+      # Retrieve all current iterations group from the project
       #
-      # @see http://www.pivotaltracker.com/help/api?version=v3#getting_iterations
+      # @see https://www.pivotaltracker.com/help/api?version=v3#get_iterations
       #
       # @param project_id the id of the project
       #
@@ -68,9 +68,9 @@ module Pivit
         get("projects/#{project_id}/iterations/current", options).iterations
       end
       
-      # Retrieve all iterations from the project
+      # Retrieve all current and backlog iterations from the project
       #
-      # @see http://www.pivotaltracker.com/help/api?version=v3#getting_iterations
+      # @see https://www.pivotaltracker.com/help/api?version=v3#get_iterations
       #
       # @param project_id the id of the project
       #

data/lib/pivit/client/membership.rb

@@ -4,19 +4,14 @@ module Pivit
   class Client
     # Membership management
     # 
-    # @see http://www.pivotaltracker.com/help/api?version=v3#getting_memberships
+    # @see https://www.pivotaltracker.com/help/api?version=v3#get_memberships
     module Membership
       # Retrieve a single membership from your account
       #
-      # @see http://www.pivotaltracker.com/help/api?version=v3#getting_memberships
+      # @see https://www.pivotaltracker.com/help/api?version=v3#get_membership_info
       #
-      # @param [Integer] project_id the id of the project that you want to
-      # retrieve memberships from
-      # @param [Integer] membership_id the id of the membership that you want to
-      # retrieve
-      #
-      # @param [Integer] project_id the id of the project that contains the
-      # membership
+      # @param [Integer] project_id the id of the project that you want to retrieve memberships from
+      # @param [Integer] membership_id the id of the membership that you want to retrieve
       #
       # @return [Hashie::Mash] membership response
       #
@@ -30,10 +25,9 @@ module Pivit
 
       # Retrieve all memberships from your account
       #
-      # @see http://www.pivotaltracker.com/help/api?version=v3#getting_memberships
+      # @see https://www.pivotaltracker.com/help/api?version=v3#get_memberships
       #
-      # @param [Integer] project_id the id of the project that contains the
-      #memberships
+      # @param [Integer] project_id the id of the project that contains the memberships
       #
       # @return [Hashie::Mash] memberships response
       #
@@ -47,16 +41,13 @@ module Pivit
 
       # Create a membership
       # 
-      # Provide the parameters you want to use for the membership via the options
-      # hash. 
+      # Provide the parameters you want to use for the membership via the options hash.
       #
       # @see http://www.pivotaltracker.com/help/api?version=v3#add_membership
       #
-      # @param [Integer] project_id the id of the project that contains the
-      # membership
-      # @param [Integer] email the email address of the member that is being
-      # added
-      # @param [Integer] role the role of the member that is being added
+      # @param [Integer] project_id the id of the project that contains the membership
+      # @param [String] email the email address of the member that is being added
+      # @param [String] role the role of the member that is being added
       #
       # @return [Hashie::Mash] membership created response
       #
@@ -68,14 +59,12 @@ module Pivit
         options.merge!({ :membership => { :role => role, :person => { :email => email }}})
         post("projects/#{project_id}/memberships", options).membership
       end
-    
+      
       # Delete a membership
-      # 
       #
-      # @see http://www.pivotaltracker.com/help/api?version=v3#delete_membership
+      # @see https://www.pivotaltracker.com/help/api?version=v3#remove_membership
       #
-      # @param [Integer] project_id the id of the project that contains the
-      # membership
+      # @param [Integer] project_id the id of the project that contains the membership
       # @param [Integer] membership_id the id of the membership that is getting deleted
       #
       # @return [Hashie::Mash] membership deleted response

data/lib/pivit/client/project.rb

@@ -1,15 +1,14 @@
 module Pivit
   class Client
     # Project management
-    # 
+    #
     # @see http://www.pivotaltracker.com/help/api?version=v3#getting_projects
     module Project
       # Retrieve a single project from your account
       #
-      # @see http://www.pivotaltracker.com/help/api?version=v3#getting_projects
+      # @see https://www.pivotaltracker.com/help/api?version=v3#get_project_info
       #
-      # @param [Integer] project_id the id of the project that you want to
-      # retrieve
+      # @param [Integer] project_id the id of the project that you want to retrieve
       #
       # @return [Hashie::Mash] project response
       #
@@ -23,31 +22,29 @@ module Pivit
 
       # Retrieve all projects from your account
       #
-      # @see http://www.pivotaltracker.com/help/api?version=v3#getting_projects
+      # @see https://www.pivotaltracker.com/help/api?version=v3#get_project_all_projects
       #
       # @return [Hashie::Mash] projects response
       #
-      # @example 
-      #   Pivit::Client.project      
-      # 
+      # @example
+      #   Pivit::Client.projects
+      #
       # @author Jason Truluck
       def projects(options = {})
         get("projects", options).projects
       end
 
       # Create a Project
-      # 
-      # Provide the parameters you wantt to use for the project via the options
-      # hash 
+      #
+      # Provide the parameters you wantt to use for the project via the options hash
       #
       # @see http://www.pivotaltracker.com/help/api?version=v3#create_project
       #
       # @return [Hashie::Mash] project created response
       #
-      # @example 
-      #   Pivit::Client.create_project({:name => "Test Project", :iteration_length
-      #   => "2"})
-      # 
+      # @example
+      #   Pivit::Client.create_project({:name => "Test Project", :iteration_length => "2"})
+      #
       # @author Jason Truluck
       def create_project(options = {})
         options = { :project => options }

data/lib/pivit/client/story.rb

@@ -10,13 +10,8 @@ module Pivit
       #
       # @see http://www.pivotaltracker.com/help/api?version=v3#getting_stories
       #
-      # @param [Integer] project_id the id of the project that you want to
-      # retrieve stories from
-      # @param [Integer] story_id the id of the story that you want to
-      # retrieve
-      #
-      # @param [Integer] project_id the id of the project that contains the
-      # story
+      # @param [Integer] project_id the id of the project that you want to retrieve stories from
+      # @param [Integer] story_id the id of the story that you want to retrieve
       #
       # @return [Hashie::Mash] story response
       #
@@ -32,13 +27,20 @@ module Pivit
       #
       # @see http://www.pivotaltracker.com/help/api?version=v3#getting_stories
       #
-      # @param [Integer] project_id the id of the project that contains the
-      #stories
+      # You can also use any filter option provided by pivotal tracker by
+      # prefacing with the option :filter
+      #
+      # @see https://www.pivotaltracker.com/help/faq#howcanasearchberefined
+      #
+      # @param [Integer] project_id the id of the project that contains the stories
       #
       # @return [Hashie::Mash] stories response
       #
       # @example 
       #   Pivit::Client.stories(1111111)
+      #
+      #   
+      #   Pivit::Client.stories(1111111, {:filter => "type:bug,chore"})
       # 
       # @author Jason Truluck
       def stories(project_id, options = {})
@@ -47,18 +49,16 @@ module Pivit
 
       # Create a story
       # 
-      # Provide the parameters you want to use for the story via the options
-      # hash 
+      # Provide the parameters you want to use for the story via the options hash 
       #
       # @see http://www.pivotaltracker.com/help/api?version=v3#add_story
       #
-      # @param [Integer] project_id the id of the project that contains the
-      # story
+      # @param [Integer] project_id the id of the project that contains the story
       #
       # @return [Hashie::Mash] story created response
       #
       # @example 
-      #   Pivit::Client.create_story_type=> "feature", :name => "Story"})
+      #   Pivit::Client.create_story({:type => "feature", :name => "Story"})
       #
       # @author Jason Truluck
       def create_story(project_id, options = {})
@@ -73,14 +73,13 @@ module Pivit
       #
       # @see http://www.pivotaltracker.com/help/api?version=v3#update_story
       #
-      # @param [Integer] project_id the id of the project that contains the
-      # story
+      # @param [Integer] project_id the id of the project that contains the story
       # @param [Integer] story_id the id of the story that is getting updated
       #
       # @return [Hashie::Mash] story updated response
       #
       # @example 
-      #   Pivit::Client.update_story(12345, 11111, { :name => "awesome new story name"})
+      #   Pivit::Client.update_story(12345, 11111, {:name => "awesome new story name"})
       #
       # @author Jason Truluck
       def update_story(project_id, story_id, options = {})
@@ -89,18 +88,16 @@ module Pivit
       end
     
       # Delete a story
-      # 
       #
       # @see http://www.pivotaltracker.com/help/api?version=v3#delete_story
       #
-      # @param [Integer] project_id the id of the project that contains the
-      # story
+      # @param [Integer] project_id the id of the project that contains the story
       # @param [Integer] story_id the id of the story that is getting deleted
       #
       # @return [Hashie::Mash] story deleted response
       #
       # @example 
-      #   Pivit::Client.update_story(12345, 11111)
+      #   Pivit::Client.delete_story(12345, 11111)
       ##
       # @author Jason Truluck
       def delete_story(project_id, story_id, options = {})
@@ -111,11 +108,9 @@ module Pivit
       #
       # @see http://www.pivotaltracker.com/help/api?version=v3#move_story
       #
-      # @param [Integer] project_id the id of the project that contains the
-      # story
+      # @param [Integer] project_id the id of the project that contains the story
       # @param [Integer] story_id the id of the story that is getting moved
-      # @param [Integer] story_target_id the id of the story that the other
-      # story is moving before
+      # @param [Integer] story_target_id the id of the story that the other story is moving before
       #
       # @return [Hashie::Mash] story move response
       #
@@ -131,11 +126,9 @@ module Pivit
       #
       # @see http://www.pivotaltracker.com/help/api?version=v3#move_story
       #
-      # @param [Integer] project_id the id of the project that contains the
-      # story
+      # @param [Integer] project_id the id of the project that contains the story
       # @param [Integer] story_id the id of the story that is getting moved
-      # @param [Integer] story_target_id the id of the story that the other
-      # story is moving after
+      # @param [Integer] story_target_id the id of the story that the other story is moving after
       #
       # @return [Hashie::Mash] story move response
       #

data/lib/pivit/client/task.rb

@@ -4,21 +4,15 @@ module Pivit
   class Client
     # Task management
     # 
-    # @see http://www.pivotaltracker.com/help/api?version=v3#getting_stories
+    # @see http://www.pivotaltracker.com/help/api?version=v3#tasks
     module Task
       # Retrieve a single task from your account
       #
-      # @see http://www.pivotaltracker.com/help/api?version=v3#getting_stories
+      # @see http://www.pivotaltracker.com/help/api?version=v3#view_task
       #
-      # @param [Integer] project_id the id of the project that you want to
-      # retrieve stories from
-      # @param [Integer] story_id the id of the story that you want to
-      # retrieve
-      # @param [Integer] task_id the id of the task that you want to
-      # retrieve
-      #
-      # @param [Integer] project_id the id of the project that contains the
-      # task
+      # @param [Integer] project_id the id of the project that you want to retrieve stories from
+      # @param [Integer] story_id the id of the story that you want to retrieve
+      # @param [Integer] task_id the id of the task that you want to retrieve
       #
       # @return [Hashie::Mash] task response
       #
@@ -32,7 +26,7 @@ module Pivit
 
       # Retrieve all tasks from a story
       #
-      # @see http://www.pivotaltracker.com/help/api?version=v3#getting_tasks
+      # @see http://www.pivotaltracker.com/help/api?version=v3#view_tasks
       #
       # @param [Integer] project_id the id of the project that contains the stories
       # @param [Integer] stroy_id the id of the story that contains the tasks
@@ -49,8 +43,7 @@ module Pivit
 
       # Create a task
       # 
-      # Provide the parameters you want to use for the task via the options
-      # hash 
+      # Provide the parameters you want to use for the task via the options hash 
       #
       # @see http://www.pivotaltracker.com/help/api?version=v3#add_task
       #
@@ -60,7 +53,7 @@ module Pivit
       # @return [Hashie::Mash] task created response
       #
       # @example 
-      #   Pivit::Client.create_task_type=> "feature", :name => "Task"})
+      #   Pivit::Client.create_task({:type=> "feature", :name => "Task"})
       #
       # @author Jason Truluck
       def create_task(project_id, story_id, options = {})
@@ -70,8 +63,7 @@ module Pivit
 
       # Update a task
       # 
-      # Provide the parameters you want to use for the task via the options
-      # hash 
+      # Provide the parameters you want to use for the task via the options hash 
       #
       # @see http://www.pivotaltracker.com/help/api?version=v3#update_task
       #
@@ -82,7 +74,7 @@ module Pivit
       # @return [Hashie::Mash] task updated response
       #
       # @example 
-      #   Pivit::Client.update_task(12345, 11111, 67890, { :name => "awesome new task name"})
+      #   Pivit::Client.update_task(12345, 11111, 67890, {:name => "awesome new task name"})
       #
       # @author Jason Truluck
       def update_task(project_id, story_id, task_id, options = {})
@@ -101,7 +93,7 @@ module Pivit
       # @return [Hashie::Mash] task deleted response
       #
       # @example 
-      #   Pivit::Client.update_task(12345, 11111, 67890)
+      #   Pivit::Client.delete_task(12345, 11111, 67890)
       #
       # @author Jason Truluck
       def delete_task(project_id, story_id, task_id, options = {})

data/lib/pivit/version.rb

@@ -1,3 +1,3 @@
 module Pivit
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pivit
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Jason Truluck
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-05 00:00:00.000000000 Z
+date: 2013-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday