gradesfirst 0.2.1 → 0.3.0

data/lib/http_magic/request.rb

@@ -0,0 +1,93 @@
+require 'net/http'
+require 'json'
+
+module HttpMagic
+  # Encapsulating class to hold all of the infrastructure to make the actual
+  # requests to the api. It receives at a minimum a HttpMagic::Uri object which
+  # manages the url building.
+  #
+  # == Example
+  #
+  #   uri_object = HttpMagic::Uri.new('http://example.com')
+  #
+  #   request = Request.new(uri_object)
+  #
+  #   request.get
+  #   => { 'name' => 'Foo Bar' }
+  class Request
+    def initialize(uri, options = {})
+      @uri = uri
+      @data = options[:data]
+      @options = {
+        headers: options[:headers] || {}
+      }
+    end
+
+    def delete
+      parse_response http.delete(@uri.urn, @options[:headers])
+    end
+
+    # Makes a GET request to the url provided by the Uri object and returns the
+    # resulting JSON data as a Ruby hash.
+    #
+    # == Example
+    #
+    #   uri_object = HttpMagic::Uri.new('http://example.com')
+    #
+    #   request = Request.new(uri_object)
+    #
+    #   request.get
+    #   => { 'name' => 'Foo Bar' }
+    def get
+      parse_response http.request_get(@uri.urn, @options[:headers])
+    end
+
+    # Makes a POST request to the url provided by the Uri object and returns the
+    # resulting JSON data as a Ruby hash. If data was provided as an optional
+    # initialization parameter, then that is also POSTed.
+    #
+    # == Example
+    #
+    #   uri_object = HttpMagic::Uri.new('http://example.com')
+    #
+    #   request = Request.new(uri_object, data: { name: 'New Foo' })
+    #
+    #   request.post
+    def post
+      if !@data.empty?
+        @options[:headers].merge!( 'Content-Type' => 'application/json' )
+      end
+
+      parse_response http.request_post(@uri.urn, @data.to_json, @options[:headers])
+    end
+
+    def put
+      if !@data.empty?
+        @options[:headers].merge!( 'Content-Type' => 'application/json' )
+      end
+
+      parse_response http.request_put(@uri.urn, @data.to_json, @options[:headers])
+    end
+
+    private
+
+    def http
+      return @http unless @http.nil?
+      @http = Net::HTTP.new(@uri.domain, 443)
+      @http.use_ssl = true
+      @http
+    end
+
+    def parse_response(response)
+      if response && response.is_a?(Net::HTTPSuccess)
+        if response.body && response.content_type == 'application/json'
+          JSON.parse(response.body)
+        else
+          response.body.to_s
+        end
+      else
+        nil
+      end
+    end
+  end
+end

data/lib/http_magic/uri.rb

@@ -0,0 +1,74 @@
+
+module HttpMagic
+  # Helper class that holds the parts of the URI and provides methods to put
+  # them together.
+  #
+  # == Example
+  #
+  #   uri = HttpMagic::Uri.new('example.com')
+  #   uri.build
+  #   => "https://example.com/"
+  #
+  #   uri.namespace = 'api/v2'
+  #   uri.build
+  #   => "https://example.com/api/v2"
+  #
+  #   uri.parts = ['path']
+  #   uri.build
+  #   => "https://example.com/api/v2/path"
+  #
+  class Uri
+    attr_accessor :namespace, :parts
+
+    attr_reader :domain
+
+    def initialize(domain)
+      @domain = domain
+      @parts = []
+    end
+
+    # Builds a full uniform resource identifier.
+    #
+    # == Example
+    #
+    #   uri = HttpMagic::Uri.new('example.com')
+    #   uri.namespace = 'api/v1'
+    #   uri.parts = %w(foo bar)
+    #
+    #   uri.urn
+    #   => "https://example.com/api/v1/foo/bar"
+    def build
+      "#{url}#{urn}"
+    end
+
+    # Uniform resource locator based on @domain value.
+    #
+    # == Example
+    #
+    #   uri = HttpMagic::Uri.new('example.com')
+    #
+    #   uri.url
+    #   => "https://example.com/"
+    #
+    #   uri.url(false)
+    #   => "https://example.com"
+    def url
+      "https://#{@domain}"
+    end
+
+    # Uniform resource name for a resource.
+    #
+    # == Example
+    #
+    #   uri = HttpMagic::Uri.new('example.com')
+    #   uri.namespace = 'api/v1'
+    #   uri.parts = %w(foo bar)
+    #
+    #   uri.urn
+    #   => "/api/v1/foo/bar"
+    def urn
+      resource_name = [@namespace, @parts].flatten.compact.join('/')
+      "/#{resource_name}"
+    end
+  end
+end

data/lib/pivotal_tracker.rb

@@ -1,6 +1,6 @@
 require 'http_magic'
 
-class PivotalTracker < HttpMagic
+class PivotalTracker < HttpMagic::Api
   url 'www.pivotaltracker.com'
   namespace 'services/v5'
 

data/test/branch_command_test.rb

@@ -1,32 +1,19 @@
 require 'test_helper'
+require 'pivotal_tracker'
 require 'gradesfirst/branch_command'
+require 'pivotal_tracker'
 
 describe GradesFirst::BranchCommand do
   before do
-    stub_pivotal_request(
-      :get,
-      'stories/29384793',
-      body: fixture_file('story_bar.json')
-    )
-
-    stub_pivotal_request(
-      :get,
-      'stories/57348714',
-      body: fixture_file('story_foo.json')
-    )
-
-    PivotalTracker.api_token = 'test_token'
-    git_branch_output = fixture_file('git_branch.txt')
-    @command = GradesFirst::BranchCommand.new
-    @command.stub :git_branch, git_branch_output do
-      @command.execute
+    expect_requests stub_bar_story_request, stub_foo_story_request do
+      git_branch_output = fixture_file('git_branch.txt')
+      @command = GradesFirst::BranchCommand.new
+      @command.stub :git_branch, git_branch_output, &call_execute
     end
   end
 
-  describe '#response' do
-    it 'should respond with Pivotal enhancements' do
-      assert_equal fixture_file('gf_branch.txt'), @command.response
-    end
+  specify '#response responds with Pivotal enhancements' do
+    assert_equal fixture_file('gf_branch.txt'), @command.response
   end
 
 end

data/test/cli_test.rb

@@ -2,52 +2,69 @@ require 'test_helper'
 require 'gradesfirst/cli'
 
 describe GradesFirst::CLI do
-  def command_not_found(command)
-    "Could not find task \"#{command}\".\n"
-  end
 
-  def executed_command_expectations(command)
-    command.any_instance.expects(:execute)
-    command.any_instance.expects(:response).returns('')
-  end
+  def assert_command_hooked_up(shell_command, klass)
+    assert_includes klass.instance_methods, :execute
+    assert_includes klass.instance_methods, :response
 
-  describe 'branch command' do
-    before do
-      executed_command_expectations(GradesFirst::BranchCommand)
+    execute_arity = klass.instance_method(:execute).arity
+    if execute_arity < 0
+      execute_arity += 1
+      execute_arity = execute_arity.abs
     end
+    expected_execute_parameters = Array.new(execute_arity, Object)
+
+    expected_output = 'Expected Response'
+    command_instance = Minitest::Mock.new.
+      expect(:execute, nil, expected_execute_parameters).
+      expect(:response, expected_output)
 
-    it 'should exist' do
-      output = capture_io do
-        GradesFirst::CLI.start %w{ branch }
+    stdout, stderr = capture_io do
+      klass.stub :new, command_instance do
+        GradesFirst::CLI.start Shellwords.split(shell_command)
       end
-      refute_includes output, command_not_found('branch')
     end
+
+    assert_equal '', stderr, "Error reported to standard error by CLI command \"#{shell_command}\""
+    assert_match expected_output, stdout, "Incorrect output from CLI command \"#{shell_command}\""
+    command_instance.verify
   end
 
-  describe 'commit-message command' do
-    before do
-      executed_command_expectations(GradesFirst::CommitMessageCommand)
-    end
+  specify 'branch command is hooked up' do
+    assert_command_hooked_up 'branch', GradesFirst::BranchCommand
+  end
 
-    it 'should exist' do
-      output = capture_io do
-        GradesFirst::CLI.start %w{ commit-message }
-      end
-      refute_includes output, command_not_found('commit-message')
-    end
+  specify 'commit-message command is hooked up' do
+    assert_command_hooked_up 'commit-message', GradesFirst::CommitMessageCommand
   end
 
-  describe 'task command' do
-    before do
-      executed_command_expectations(GradesFirst::TaskCommand)
-    end
+  # Waiting on fix for subcommands with default command.
+  # https://github.com/erikhuda/thor/pull/374
+  #specify 'task command is hooked up to default list subcommand' do
+  #  assert_command_hooked_up 'task', GradesFirst::TaskListCommand
+  #end
 
-    it 'should exist' do
-      output = capture_io do
-        GradesFirst::CLI.start %w{ task }
-      end
-      refute_includes output, command_not_found('task')
-    end
+  specify 'task add command is hooked up' do
+    assert_command_hooked_up(
+      'task add "This is a task."',
+      GradesFirst::TaskAddCommand
+    )
+  end
+
+  specify 'task delete command is hooked up' do
+    assert_command_hooked_up('task delete 1', GradesFirst::TaskDeleteCommand)
+  end
+
+  specify 'task list command is hooked up' do
+    assert_command_hooked_up 'task list', GradesFirst::TaskListCommand
+  end
+
+  specify 'task move command is hooked up' do
+    assert_command_hooked_up('task move 5 1', GradesFirst::TaskMoveCommand)
+  end
+
+  specify 'task toggle command is hooked up' do
+    assert_command_hooked_up('task toggle 1', GradesFirst::TaskToggleCommand)
   end
 
 end

data/test/command_test.rb

@@ -2,13 +2,11 @@ require 'test_helper'
 require 'gradesfirst/command'
 
 describe GradesFirst::Command do
-  describe '#story_id' do
-    it 'should pull the story id from the branch' do
-      assert '123', GradesFirst::Command.new.send(:story_id, 'abc/123')
-    end
+  specify '#story_id pulls the story id from the branch' do
+    assert '123', GradesFirst::Command.new.send(:story_id, 'abc/123')
+  end
 
-    it 'should return nil if not story id' do
-      assert_nil GradesFirst::Command.new.send(:story_id, 'abc')
-    end
+  specify '#story_id returns nil if not story id' do
+    assert_nil GradesFirst::Command.new.send(:story_id, 'abc')
   end
 end

data/test/commit_message_command_test.rb

@@ -1,62 +1,54 @@
 require 'test_helper'
+require 'pivotal_tracker'
 require 'gradesfirst/commit_message_command'
+require 'pivotal_tracker'
 
 describe GradesFirst::CommitMessageCommand do
-  before do
-    stub_pivotal_request(
-      :get,
-      'stories/29384793',
-      body: fixture_file('story_bar.json')
-    )
-
-    PivotalTracker.api_token = 'test_token'
-  end
-
   describe '#response' do
-    it 'should repond with formatted commit message' do
+    it 'responds with formatted commit message' do
       command = GradesFirst::CommitMessageCommand.new
-      command.stub :current_branch, 'test/29384793' do
-        command.execute
-        assert_equal fixture_file('commit_message.txt'), command.response
+      expect_requests stub_bar_story_request do
+        command.stub :current_branch, "test/#{bar_story_id}", &call_execute
       end
+      assert_equal fixture_file('commit_message.txt'), command.response
     end
   end
-end
 
-describe 'GradesFirst::CommitMessageCommand#constrain_line_length' do
-  def test_string
-    'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce vitae.'
-  end
+  describe '#constrain_line_length' do
+    def test_string
+      'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce vitae.'
+    end
 
-  def test_string_ending_with_a_letter
-    'Lorem ipsum dolor sit amet'
-  end
+    def test_string_ending_with_a_letter
+      'Lorem ipsum dolor sit amet'
+    end
 
-  def test_string_with_line_feeds_at_30
-    "Lorem ipsum dolor sit amet,\nconsectetur adipiscing elit.\nFusce vitae."
-  end
+    def test_string_with_line_feeds_at_30
+      "Lorem ipsum dolor sit amet,\nconsectetur adipiscing elit.\nFusce vitae."
+    end
 
-  it 'should add new lines at natural breaks when length is exceeded' do
-    command = GradesFirst::CommitMessageCommand.new
-    assert_equal(
-      test_string_with_line_feeds_at_30,
-      command.send(:constrain_line_length, test_string, 30)
-    )
-  end
+    it 'adds new lines at natural breaks when length is exceeded' do
+      command = GradesFirst::CommitMessageCommand.new
+      assert_equal(
+        test_string_with_line_feeds_at_30,
+        command.send(:constrain_line_length, test_string, 30)
+      )
+    end
 
-  it 'should do nothing when length is not exceeded' do
-    command = GradesFirst::CommitMessageCommand.new
-    assert_equal(
-      test_string,
-      command.send(:constrain_line_length, test_string, 80)
-    )
-  end
+    it 'does nothing when length is not exceeded' do
+      command = GradesFirst::CommitMessageCommand.new
+      assert_equal(
+        test_string,
+        command.send(:constrain_line_length, test_string, 80)
+      )
+    end
 
-  it 'should not wrap when ending with a letter' do
-    command = GradesFirst::CommitMessageCommand.new
-    assert_equal(
-      test_string_ending_with_a_letter,
-      command.send(:constrain_line_length, test_string_ending_with_a_letter, 80)
-    )
+    it 'does not wrap when ending with a letter' do
+      command = GradesFirst::CommitMessageCommand.new
+      assert_equal(
+        test_string_ending_with_a_letter,
+        command.send(:constrain_line_length, test_string_ending_with_a_letter, 80)
+      )
+    end
   end
 end

data/test/fixtures/task.json

@@ -0,0 +1,10 @@
+{
+   "updated_at": "2014-01-14T12:00:00Z",
+   "description": "New task.",
+   "complete": false,
+   "kind": "task",
+   "id": 5100,
+   "created_at": "2014-01-14T12:00:00Z",
+   "position": 3,
+   "story_id": 558
+}