pivit 0.1.0

data/lib/pivit/client/note.rb

@@ -0,0 +1,47 @@
+# notes
+
+module Pivit
+  class Client
+    # Note management
+    # 
+    # @see http://www.pivotaltracker.com/help/api?version=v3#getting_notes
+    module Note
+      # Retrieve all notes for a story
+      #
+      # @param [Integer] project_id the id of the project that contains the notes
+      # @param [Integer] story_id the id of the story that contains the notes
+      #
+      # @return [Hashie::Mash] notes response
+      #
+      # @example 
+      #   Pivit::Client.notes(1111111, 222222)
+      # 
+      # @author Jason Truluck
+      def notes(project_id, story_id, options = {})
+        get("projects/#{project_id}/stories/#{story_id}/notes", options).notes
+      end
+
+      # Create a note
+      # 
+      # Provide the parameters you want to use for the note via the options
+      # hash 
+      #
+      # @see http://www.pivotaltracker.com/help/api?version=v3#add_note
+      #
+      # @param [Integer] project_id the id of the project that contains the story
+      # @param [Integer] story_id the id of the story that contains the note
+      # @param [String] text the text that the story note will contain
+      #
+      # @return [Hashie::Mash] note created response
+      #
+      # @example 
+      #   Pivit::Client.create_note(111111, 222222, "some not text")
+      #
+      # @author Jason Truluck
+      def create_note(project_id, story_id, text, options = {})
+        options = { :note => options.merge!(:text => text) }
+        post("projects/#{project_id}/stories", options).note
+      end
+    end
+  end
+end

data/lib/pivit/client/project.rb

@@ -0,0 +1,58 @@
+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
+      #
+      # @param [Integer] project_id the id of the project that you want to
+      # retrieve
+      #
+      # @return [Hashie::Mash] project response
+      #
+      # @example 
+      #   Pivit::Client.project(123456)
+      #
+      # @author Jason Truluck
+      def project(project_id, options = {})
+        get("projects/#{project_id}", options).project
+      end
+
+      # Retrieve all projects from your account
+      #
+      # @see http://www.pivotaltracker.com/help/api?version=v3#getting_projects
+      #
+      # @return [Hashie::Mash] projects response
+      #
+      # @example 
+      #   Pivit::Client.project      
+      # 
+      # @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 
+      #
+      # @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"})
+      # 
+      # @author Jason Truluck
+      def create_project(options = {})
+        options = { :project => options }
+        post("projects", options).project
+      end
+    end
+  end
+end

data/lib/pivit/client/story.rb

@@ -0,0 +1,177 @@
+# Stories
+
+module Pivit
+  class Client
+    # Story management
+    # 
+    # @see http://www.pivotaltracker.com/help/api?version=v3#getting_stories
+    module Story
+      # Retrieve a single story from your account
+      #
+      # @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
+      #
+      # @return [Hashie::Mash] story response
+      #
+      # @example 
+      #   Pivit::Client.story(1111111, 123456)
+      #
+      # @author Jason Truluck
+      def story(project_id, story_id, options = {})
+        get("projects/#{project_id}/stories/#{story_id}", options).story
+      end
+
+      # Retrieve all stories from your account
+      #
+      # @see http://www.pivotaltracker.com/help/api?version=v3#getting_stories
+      #
+      # @param [Integer] project_id the id of the project that contains the
+      #stories
+      #
+      # @return [Hashie::Mash] stories response
+      #
+      # @example 
+      #   Pivit::Client.stories(1111111)
+      # 
+      # @author Jason Truluck
+      def stories(project_id, options = {})
+        get("projects/#{project_id}/stories/", options).stories
+      end
+
+      # Create a story
+      # 
+      # 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
+      #
+      # @return [Hashie::Mash] story created response
+      #
+      # @example 
+      #   Pivit::Client.create_story_type=> "feature", :name => "Story"})
+      #
+      # @author Jason Truluck
+      def create_story(project_id, options = {})
+        options = { :story => options }
+        post("projects/#{project_id}/stories", options).story
+      end
+
+      # Update a story
+      # 
+      # Provide the parameters you want to use for the story via the options
+      # hash 
+      #
+      # @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] 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"})
+      #
+      # @author Jason Truluck
+      def update_story(project_id, story_id, options = {})
+        options = { :story => options }
+        put("projects/#{project_id}/stories/#{story_id}",  options).story
+      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] story_id the id of the story that is getting deleted
+      #
+      # @return [Hashie::Mash] story deleted response
+      #
+      # @example 
+      #   Pivit::Client.update_story(12345, 11111)
+      ##
+      # @author Jason Truluck
+      def delete_story(project_id, story_id, options = {})
+        delete("projects/#{project_id}/stories/#{story_id}", options).story
+      end
+     
+      # Move a story before another story
+      #
+      # @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] 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
+      #
+      # @return [Hashie::Mash] story move response
+      #
+      # @example 
+      #   Pivit::Client.move_story_before(12345, 11111, 22222)
+      ##
+      # @author Jason Truluck
+      def move_story_before(project_id, story_id, story_target_id, options = {})
+        move_story(project_id, story_id, story_target_id, :before, options)
+      end
+      
+      # Move a story after another story
+      #
+      # @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] 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
+      #
+      # @return [Hashie::Mash] story move response
+      #
+      # @example 
+      #   Pivit::Client.move_story_after(12345, 11111, 22222)
+      ##
+      # @author Jason Truluck
+      def move_story_after(project_id, story_id, story_target_id, options = {})
+        move_story(project_id, story_id, story_target_id, :after, options)
+      end
+
+      # Add an attachement to a story
+      #
+      # @see http://www.pivotaltracker.com/help/api?version=v3#attachements
+      #
+      # @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 [String] file the location of the file to be attached
+      #
+      # @return [Hashie::Mash] story attachement response
+      #
+      # @example 
+      #   Pivit::Client.add_attachment(12345, 111111, "test.txt")
+      ##
+      # @author Jason Truluck
+      def add_attachment(project_id, story_id, file, options = {})
+        options.merge!(:payload => file)
+        post("projects/#{project_id}/stories/#{story_id}/attachments", options).attachment
+      end
+
+
+      private
+      def move_story(project_id, story_id, story_target_id, direction, options = {})
+        options.merge!("move\[move\]" => direction, "move\[target\]" =>  story_target_id)
+        post("projects/#{project_id}/stories/#{story_id}/moves", options).story
+      end
+    end
+  end
+end

data/lib/pivit/client/task.rb

@@ -0,0 +1,112 @@
+# Tasks
+
+module Pivit
+  class Client
+    # Task management
+    # 
+    # @see http://www.pivotaltracker.com/help/api?version=v3#getting_stories
+    module Task
+      # Retrieve a single task from your account
+      #
+      # @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] 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
+      #
+      # @return [Hashie::Mash] task response
+      #
+      # @example 
+      #   Pivit::Client.task(1111111, 123456, 67890)
+      #
+      # @author Jason Truluck
+      def task(project_id, story_id, task_id, options = {})
+        get("projects/#{project_id}/stories/#{story_id}/tasks/#{task_id}", options).task
+      end
+
+      # Retrieve all tasks from a story
+      #
+      # @see http://www.pivotaltracker.com/help/api?version=v3#getting_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
+      #
+      # @return [Hashie::Mash] tasks response
+      #
+      # @example 
+      #   Pivit::Client.tasks(1111111, 123456)
+      # 
+      # @author Jason Truluck
+      def tasks(project_id, story_id, options = {})
+        get("projects/#{project_id}/stories/#{story_id}/tasks", options).tasks
+      end
+
+      # Create a task
+      # 
+      # 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
+      #
+      # @param [Integer] project_id the id of the project that contains the task
+      # @param [Integer] story_id the id of the story that contains the task
+      #
+      # @return [Hashie::Mash] task created response
+      #
+      # @example 
+      #   Pivit::Client.create_task_type=> "feature", :name => "Task"})
+      #
+      # @author Jason Truluck
+      def create_task(project_id, story_id, options = {})
+        options = { :task => options }
+        post("projects/#{project_id}/stories/#{story_id}/tasks", options).task
+      end
+
+      # Update a task
+      # 
+      # 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
+      #
+      # @param [Integer] project_id the id of the project that contains the task
+      # @param [Integer] story_id the id of the story that contains the task
+      # @param [Integer] task_id the id of the task that is getting updated
+      #
+      # @return [Hashie::Mash] task updated response
+      #
+      # @example 
+      #   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 = {})
+        options = { :task => options }
+        put("projects/#{project_id}/stories/#{story_id}/tasks/#{task_id}",  options).task
+      end
+    
+      # Delete a task
+      # 
+      # @see http://www.pivotaltracker.com/help/api?version=v3#delete_task
+      #
+      # @param [Integer] project_id the id of the project that contains the task
+      # @param [Integer] story_id the id of the story that contains the task
+      # @param [Integer] task_id the id of the task that is getting deleted
+      #
+      # @return [Hashie::Mash] task deleted response
+      #
+      # @example 
+      #   Pivit::Client.update_task(12345, 11111, 67890)
+      #
+      # @author Jason Truluck
+      def delete_task(project_id, story_id, task_id, options = {})
+        delete("projects/#{project_id}/stories/#{story_id}/tasks/#{task_id}", options).task
+      end
+    end
+  end
+end

data/lib/pivit/configuration.rb

@@ -0,0 +1,29 @@
+#Configuration
+module Pivit
+  module Configuration
+    VALID_OPTIONS_KEYS = [
+      :username,
+      :password,
+      :api_token,
+      :api_endpoint,
+      :ssl
+    ]
+
+    attr_accessor(*VALID_OPTIONS_KEYS)
+
+    def configure
+      yield self
+    end
+
+    def options
+      VALID_OPTIONS_KEYS.inject({}){|o,k| o.merge!(k => send(k)) }
+    end
+
+    def reset!
+      self.username            = nil
+      self.password            = nil
+      self.api_token           = nil
+      self.ssl                 = true
+    end
+  end
+end

data/lib/pivit/connection.rb

@@ -0,0 +1,24 @@
+# Connection
+require "faraday_middleware"
+
+module Pivit
+  module Connection
+    def connection(options = {})
+      options = {
+        :ssl              => { :verify => false }
+      }.merge(options)
+  
+      connection = Faraday.new(options) do |build|
+        build.request :multipart
+        build.request :url_encoded
+        build.use FaradayMiddleware::Mashify
+        build.use FaradayMiddleware::ParseXml,  :content_type => /\bxml$/
+        build.adapter  Faraday.default_adapter
+      end
+
+      connection.headers["X-TrackerToken"] = api_token if self.authenticated?
+
+      connection
+    end
+  end
+end