gradesfirst 0.2.1 → 0.3.0

data/lib/gradesfirst/task_list_command.rb

@@ -0,0 +1,40 @@
+require 'gradesfirst/task_command'
+
+module GradesFirst
+
+  # Implementation of a Thor command for listing tasks related to a story.
+  class TaskListCommand < GradesFirst::TaskCommand
+
+    # Description of the gf task list Thor command that will be used in the
+    # command line help.
+    def self.description
+      'List the tasks related to a PivotalTracker story.'
+    end
+
+    # Performs the gf task list Thor command.
+    def execute
+      @story = current_story
+      if @story
+        @tasks = get_tasks(@story)
+      end
+    end
+
+    # Generates the comand line output response.  The output of the task command
+    # is a list of the tasks associated with the PivotalTracker story associated
+    # with the current branch.
+    def response
+      if @tasks.nil?
+        story_error_message
+      else
+        task_list_response(@story, @tasks)
+      end
+    end
+
+    private
+
+    def story_error_message
+      'Tasks cannot be retrieved for this branch.'
+    end
+
+  end
+end

data/lib/gradesfirst/task_move_command.rb

@@ -0,0 +1,64 @@
+require 'gradesfirst/task_command'
+
+module GradesFirst
+
+  # Implementation of a Thor command for moving tasks on a PivotalTracker story
+  # from one priority position to another in the list.
+  class TaskMoveCommand < GradesFirst::TaskCommand
+    # Description of the "gf task move" Thor command that will be sued in the
+    # commandline help.
+    def self.description
+      'Move a task to a new position in the list for a PivotalTracker story.'
+    end
+
+    # Performs the gf task move Thor command.
+    def execute(from, to)
+      @story = current_story
+      if @story
+        task_id = get_task_id_by_position(@story, from)
+        if task_id
+          @success = task_move(@story, task_id, to)
+        else
+          @task_position_invalid = true
+        end
+      end
+    end
+
+    # Generates the command line output response. The output of the task move
+    # command is a completion status message which may be followed by the new
+    # list of tasks if the task was moved successfully.
+    def response
+      if @task_position_invalid
+        position_invalid_message
+      else
+        task_action_response(@story, @success)
+      end
+    end
+
+    private
+
+    def position_invalid_message
+      'Task "from" position given does not exist.'
+    end
+
+    def story_error_message
+      'Tasks cannnot be moved for this branch.'
+    end
+
+    def task_error_message
+      'Moving the task failed.'
+    end
+
+    def task_move(story, task_id, to)
+      PivotalTracker.
+        projects[story['project_id']].
+        stories[story['id']].
+        tasks[task_id].
+        put(position: to.to_i)
+    end
+
+    def task_success_message
+      'Task was successfully moved.'
+    end
+  end
+end

data/lib/gradesfirst/task_toggle_command.rb

@@ -0,0 +1,65 @@
+require 'gradesfirst/task_command'
+
+module GradesFirst
+
+  # Implementation of a Thor command for toggling whether or not a task is
+  # complete.
+  class TaskToggleCommand < GradesFirst::TaskCommand
+    # Description of the "gf task toggle" Thor command that will be used in
+    # the commandline help.
+    def self.description
+      'Toggle completion status of a PivotalTracker story task.'
+    end
+
+    # Performs the gf task toggle POSITION Thor command.
+    def execute(position)
+      @story = current_story
+      if @story
+        task = get_task_by_position(@story, position)
+        if task
+          @success = task_toggle(@story, task)
+        else
+          @task_position_invalid = true
+        end
+      end
+    end
+
+    # Generates the command line output response.  The output of the task toggle
+    # command is a completion status message which may be followed by the new
+    # list of tasks if the task was moved successfully.
+    def response
+      if @task_position_invalid
+        position_invalid_message
+      else
+        task_action_response(@story, @success)
+      end
+    end
+
+    private
+
+    def position_invalid_message
+      'Task position given does not exist.'
+    end
+
+    def story_error_message
+      'Tasks cannot be toggled for this branch.'
+    end
+
+    def task_error_message
+      'Toggling of the task completion status failed.'
+    end
+
+    def task_success_message
+      'Task completion status was successfully toggled.'
+    end
+
+    def task_toggle(story, task)
+      PivotalTracker.
+        projects[story['project_id']].
+        stories[story['id']].
+        tasks[task['id']].
+        put(complete: !task['complete'])
+    end
+  end
+
+end

data/lib/http_magic.rb

@@ -1,260 +1,4 @@
-require 'net/http'
-require 'json'
+require 'http_magic/api'
 
-# A magical class that interacts with HTTP resources with a minimal amount of
-# configuration.
-#
-# Assuming an api where the url http://www.example.com/foo/99 responds with
-# the following.
-#
-# Header:
-#
-#   Content-Type: application/json
-#
-# Body:
-#
-#   {
-#     "name": "Foo Bar"
-#   }
-#
-# == Example
-#
-#   class ExampleApi < HttpMagic
-#     url 'www.example.com'
-#   end
-#
-#   ExampleApi.foo[99].get['name']
-#   => "Foo Bar"
-#
-class HttpMagic < BasicObject
-  # Makes the new method private so that instances of this class and it's
-  # children can only be instantiated through the class method method_missing.
-  # This is needed to enforce the intended usage of HttpMagic where the class
-  # is configured to represent an http location. Once it is configured, the
-  # location is interacted with dynamically with chained methods that correspond
-  # with parts of URNs found at the location.
-  #
-  # == Example
-  #
-  #   class ExampleApi < HttpMagic
-  #     url 'www.example.com'
-  #     namespace 'api/v1'
-  #     headers({'X-AuthToken' => 'token'})
-  #   end
-  #
-  #   ExampleApi.new.uri
-  #   => "http://www.example.com/api/v1/new"
-  #
-  #   ExampleApi.foo[99].uri
-  #   => "http://www.example.com/api/v1/foo/99"
-  class << self
-    private :new
-  end
-
-  # Sets or returns the request headers for an HttpMagic based class. The
-  # headers will be passed along to each resource request being made.
-  #
-  # == Example
-  #
-  #   class ExampleApi < HttpMagic
-  #     url 'www.example.com'
-  #     namespace 'api/v1'
-  #     headers({'X-AuthToken' => 'token'})
-  #   end
-  def self.headers(value = :not_provided)
-    unless value == :not_provided
-      @headers = value
-    end
-    @headers
-  end
-
-  # Sets or returns the namespace for an HttpMagic based class. The namespace
-  # will be prefixed to the urn for each request made to the url.
-  #
-  # Assuming an api where each resource is namespaced with 'api/v1' and where
-  # the url http://www.example.com/api/v1/foo/99 responds with the following.
-  #
-  # Header:
-  #
-  #   Content-Type: application/json
-  #
-  # Body:
-  #
-  #   {
-  #     "name": "Foo Bar"
-  #   }
-  #
-  # == Example
-  #
-  #   class ExampleApi < HttpMagic
-  #     url 'www.example.com'
-  #     namespace 'api/v1'
-  #   end
-  #
-  #   ExampleApi.foo[99].get['name']
-  #   => "Foo Bar"
-  def self.namespace(value = :not_provided)
-    unless value == :not_provided
-      @namespace = value
-    end
-    @namespace
-  end
-
-  # Sets or returns the uniform resource locator for the HTTP resource.
-  #
-  # == Example
-  #
-  #   class ExampleApi < HttpMagic
-  #     url 'www.example.com'
-  #   end
-  #
-  #   ExampleApi.url
-  #   => 'www.example.com'
-  def self.url(value = :not_provided)
-    unless value == :not_provided
-      @url = value
-    end
-    @url
-  end
-
-  # Class scoped method_missing that starts the magic of creating urns
-  # through meta programming by instantiating an instance of the class
-  # and delegating the first part of the urn to that instance. This method
-  # is an implementation of the Factory Method design pattern.
-  def self.method_missing(name, *args, &block)
-    new(@url, @namespace, @headers).__send__(name, *args)
-  end
-
-  def initialize(url, namespace, headers)
-    @url = url
-    @namespace = namespace
-    @headers = headers
-
-    @urn_parts = []
-  end
-
-  # Resource index reference intended to allow for the use of numbers in a urn
-  # such as the following 'foo/99' being referenced by ExampleApi.foo[99].  It
-  # can also be used to allow for HttpMagic methods to be specified for a urn
-  # such as 'foo/get' being referenced by ExampleApi.foo[:get]. Finally, it can
-  # be used for urn parts that are not valid Ruby methods such as 'foo/%5B%5D'
-  # being referenced by ExampleApi.foo["%5B%5D"].
-  #
-  # * part - a part of a urn such that 'foo' and 'bar' would be parts of the urn
-  #   'foo/bar'.
-  #
-  # Returns a reference to its instance so that urn parts can be chained
-  # together.
-  def [](part)
-    @urn_parts << part.to_s
-    self
-  end
-
-  # Gets a resource from the URI and returns it based on its content type. JSON
-  # content will be parsed and returned as equivalent Ruby objects. All other
-  # content types will be returned as text.
-  #
-  # Assuming an api where each resource is namespaced with 'api/v1' and where
-  # the url http://www.example.com/api/v1/foo/99 responds with the following.
-  #
-  # Header:
-  #
-  #   Content-Type: application/json
-  #
-  # Body:
-  #
-  #   {
-  #     "name": "Foo Bar"
-  #   }
-  #
-  # == Example
-  #
-  #   class ExampleApi < HttpMagic
-  #     url 'www.example.com'
-  #     namespace 'api/v1'
-  #   end
-  #
-  #   ExampleApi.foo[99].get
-  #   => { "name" => "Foo Bar" }
-  def get
-    http = ::Net::HTTP.new(url, 443)
-    http.use_ssl = true
-
-    response = http.request_get(urn, @headers || {})
-    if response && response.is_a?(::Net::HTTPSuccess)
-      if response.content_type == 'application/json'
-        ::JSON.parse(response.body)
-      else
-        response.body
-      end
-    else
-      nil
-    end
-  end
-
-  # Uniform resource identifier for a specified request.
-  #
-  # == Example
-  #
-  #   class ExampleApi < HttpMagic
-  #     url 'www.example.com'
-  #     namespace 'api/v1'
-  #   end
-  #
-  #   ExampleApi.foo[99].uri
-  #   => "www.example.com/api/v1/foo/99"
-  def uri
-    "#{url}#{urn}"
-  end
-
-  # Uniform resource locator for all the resources.
-  #
-  # == Example
-  #
-  #   class ExampleApi < HttpMagic
-  #     url 'www.example.com'
-  #     namespace 'api/v1'
-  #   end
-  #
-  #   ExampleApi.foo[99].url
-  #   => "www.example.com"
-  def url
-    @url
-  end
-
-  # Uniform resource name for a resource.
-  #
-  # == Example
-  #
-  #   class ExampleApi < HttpMagic
-  #     url 'www.example.com'
-  #     namespace 'api/v1'
-  #   end
-  #
-  #   ExampleApi.foo[99].urn
-  #   => "api/v1/foo/99"
-  def urn
-    resource_name = [@namespace, @urn_parts].flatten.compact.join('/')
-    "/#{resource_name}"
-  end
-
-  # Instance scoped method_missing that accumulates the URN parts used in
-  # forming the URI. It returns a reference to the current instance so that
-  # method and [] based parts can be chained together to from the URN. In the
-  # case of ExampleApi.foo[99] the 'foo' method is accumlated as a URN part
-  # that will form the resulting URI.
-  #
-  # == Example
-  #
-  #   class ExampleApi < HttpMagic
-  #     url 'www.example.com'
-  #     namespace 'api/v1'
-  #   end
-  #
-  #   ExampleApi.foo[99].uri
-  #   => "www.example.com/api/v1/foo/99"
-  def method_missing(part, *args, &block)
-    @urn_parts << part.to_s
-    self
-  end
+module HttpMagic
 end

data/lib/http_magic/api.rb

@@ -0,0 +1,233 @@
+require 'json'
+require 'http_magic/uri'
+require 'http_magic/request'
+
+module HttpMagic
+  # A magical class that interacts with HTTP resources with a minimal amount of
+  # configuration.
+  #
+  # Assuming an api where the url http://www.example.com/api/v1/foo/99 responds
+  # with the following.
+  #
+  # Header:
+  #
+  #   Content-Type: application/json
+  #
+  # Body:
+  #
+  #   {
+  #     "name": "Foo Bar"
+  #   }
+  #
+  # == Example
+  #
+  #   class ExampleApi < HttpMagic::Api
+  #     url 'www.example.com'
+  #     namespace 'api/v1'
+  #     headers({'X-AuthToken' => 'token'})
+  #   end
+  #
+  #   ExampleApi.foo[99].get['name']
+  #   => "Foo Bar"
+  #
+  #   ExampleApi.foo.create.post(name: 'New Foo')
+  #   => { 'name' => 'New Foo' }
+  class Api < BasicObject
+    # Makes the new method private so that instances of this class and it's
+    # children can only be instantiated through the class method method_missing.
+    # This is needed to enforce the intended usage of HttpMagic where the class
+    # is configured to represent an http location. Once it is configured, the
+    # location is interacted with dynamically with chained methods that correspond
+    # with parts of URNs found at the location.
+    class << self
+      private :new
+    end
+
+    # Sets or returns the request headers for an HttpMagic based class. The
+    # headers will be passed along to each resource request being made.
+    #
+    # == Example
+    #
+    #   class ExampleApi < HttpMagic:Api
+    #     url 'www.example.com'
+    #     headers({'X-AuthToken' => 'token'})
+    #   end
+    def self.headers(value = :not_provided)
+      unless value == :not_provided
+        @headers = value
+      end
+      @headers
+    end
+
+    # Sets or returns the namespace for an HttpMagic based class. The namespace
+    # will be prefixed to the urn for each request made to the url.
+    #
+    # Assuming an api where each resource is namespaced with 'api/v1' and where
+    # the url http://www.example.com/api/v1/foo/99 responds with the following.
+    #
+    # Header:
+    #
+    #   Content-Type: application/json
+    #
+    # Body:
+    #
+    #   {
+    #     "name": "Foo Bar"
+    #   }
+    #
+    # == Example
+    #
+    #   class ExampleApi < HttpMagic:Api
+    #     url 'www.example.com'
+    #     namespace 'api/v1'
+    #   end
+    #
+    #   ExampleApi.foo[99].get['name']
+    #   => "Foo Bar"
+    #
+    def self.namespace(value = :not_provided)
+      unless value == :not_provided
+        @namespace = value
+      end
+      @namespace
+    end
+
+    # Sets or returns the uniform resource locator for the HTTP resource.
+    #
+    # == Example
+    #
+    #   class ExampleApi < HttpMagic::Api
+    #     url 'www.example.com'
+    #   end
+    def self.url(value = :not_provided)
+      unless value == :not_provided
+        @url = value
+      end
+      @url
+    end
+
+    # Class scoped method_missing that starts the magic of creating urns
+    # through meta programming by instantiating an instance of the class
+    # and delegating the first part of the urn to that instance. This method
+    # is an implementation of the Factory Method design pattern.
+    def self.method_missing(name, *args, &block)
+      new(@url, @namespace, @headers).__send__(name, *args)
+    end
+
+    def initialize(url, namespace, headers)
+      @uri = Uri.new(url)
+      @uri.namespace = namespace
+      @headers = headers
+    end
+
+    # Resource index reference intended to allow for the use of numbers in a urn
+    # such as the following 'foo/99' being referenced by ExampleApi.foo[99].  It
+    # can also be used to allow for HttpMagic methods to be specified for a urn
+    # such as 'foo/get' being referenced by ExampleApi.foo[:get]. Finally, it can
+    # be used for urn parts that are not valid Ruby methods such as 'foo/%5B%5D'
+    # being referenced by ExampleApi.foo["%5B%5D"].
+    #
+    # * part - a part of a urn such that 'foo' and 'bar' would be parts of the urn
+    #   'foo/bar'.
+    #
+    # Returns a reference to its instance so that urn parts can be chained
+    # together.
+    def [](part)
+      @uri.parts << part.to_s
+      self
+    end
+
+    def delete
+      request = Request.new(@uri,
+        headers: @headers
+      )
+      request.delete
+    end
+
+    # Gets a resource from the URI and returns it based on its content type.
+    # JSON content will be parsed and returned as equivalent Ruby objects. All
+    # other content types will be returned as text.
+    #
+    # Assuming an api where each resource is namespaced with 'api/v1' and where
+    # the url http://www.example.com/api/v1/foo/99 responds with the following.
+    #
+    # Header:
+    #
+    #   Content-Type: application/json
+    #
+    # Body:
+    #
+    #   {
+    #     "name": "Foo Bar"
+    #   }
+    #
+    # == Example
+    #
+    #   class ExampleApi < HttpMagic::Api
+    #     url 'www.example.com'
+    #     namespace 'api/v1'
+    #   end
+    #
+    #   ExampleApi.foo[99].get
+    #   => { "name" => "Foo Bar" }
+    def get
+      request = Request.new(@uri,
+        headers: @headers
+      )
+      request.get
+    end
+
+    # POST's a resource from the URI and returns the result based on its content
+    # type. JSON content will be parsed and returned as equivalent Ruby objects.
+    # All other content types will be returned as text.
+    #
+    # Assuming an api where each resource is namespaced with 'api/v1' and where
+    # the url http://www.example.com/api/v1/foo/create responds with the
+    # following when a 'name' is sent with the request.
+    #
+    # Header:
+    #
+    #   Content-Type: application/json
+    #
+    # Body:
+    #
+    #   {
+    #     "name": "New Foo"
+    #   }
+    #
+    # == Example
+    #
+    #   class ExampleApi < HttpMagic::Api
+    #     url 'www.example.com'
+    #     namespace 'api/v1'
+    #   end
+    #
+    #   ExampleApi.foo.create.post(name: 'New Foo')
+    #   => { "name" => "New Foo" }
+    def post(data = {})
+      request = Request.new(@uri,
+        headers: @headers,
+        data: data,
+      )
+      request.post
+    end
+
+    def put(data = {})
+      request = Request.new(@uri,
+        headers: @headers,
+        data: data,
+      )
+      request.put
+    end
+
+    # Instance scoped method_missing that accumulates the URN parts used in
+    # forming the URI. It returns a reference to the current instance so that
+    # method and [] based parts can be chained together to from the URN. In the
+    # case of ExampleApi.foo[99] the 'foo' method is accumlated as a URN part
+    # that will form the resulting URI.
+    def method_missing(part, *args, &block)
+      @uri.parts << part.to_s
+      self
+    end
+  end
+end