codefumes 0.1.10 → 0.2.0

data/lib/codefumes/quick_build.rb

@@ -0,0 +1,43 @@
+module CodeFumes
+  class QuickBuild
+    # Creates a new build for the CodeFumes project linked
+    # at the specified repository path and associates
+    # it with the current local commit identifier
+    #
+    # Returns +true+ if the request succeeded.
+    #
+    # Returns +false+ if the request failed.
+    def self.start(build_name, options = {})
+      repo = SourceControl.new(options[:repository_path] || './')
+
+      commit_identifier = options[:commit_identifier] || repo.local_commit_identifier
+      public_key        = options[:public_key]  || repo.public_key
+      private_key       = options[:private_key] || repo.private_key
+      started_at        = options[:started_at]  || Time.now
+
+      project = Project.new(public_key, :private_key => private_key)
+      commit = Commit.new(project, commit_identifier)
+      timestamps = {:started_at => started_at, :ended_at => ""}
+      build = Build.new(commit, build_name, :running, timestamps)
+      build.save
+    end
+
+    def self.finish(build_name, success_or_failure, options = {})
+      repo = SourceControl.new(options[:repository_path] || './')
+
+      commit_identifier = options[:commit_identifier] || repo.local_commit_identifier
+      public_key        = options[:public_key]  || repo.public_key
+      private_key       = options[:private_key] || repo.private_key
+      ended_at          = options[:ended_at]  || Time.now
+
+      project = Project.new(public_key, :private_key => private_key)
+      commit = Commit.new(project, commit_identifier)
+
+      build = Build.find(commit, build_name)
+      return false if build.nil?
+      build.state = success_or_failure.to_s
+      build.ended_at = ended_at
+      build.save
+    end
+  end
+end

data/lib/codefumes/quick_metric.rb

@@ -0,0 +1,20 @@
+module CodeFumes
+  class QuickMetric
+    # Associates a Hash of +custom_attributes+ with the current commit
+    # identifier of the repository located at +repository_path+.
+    #
+    # Returns +true+ if the request succeeded.
+    #
+    # Returns +false+ if the request failed.
+    def self.save(custom_attributes, repository_path = './')
+      repo = SourceControl.new(repository_path)
+      commit = {:identifier => repo.local_commit_identifier,
+                :custom_attributes => custom_attributes
+               }
+      content = {:content => {:commits => [commit]}}
+      project = Project.new(repo.public_key, :private_key => repo.private_key)
+      payload_set = Payload.prepare(project, content)
+      payload_set.reject {|payload| payload.save}.empty?
+    end
+  end
+end

data/lib/codefumes/source_control.rb

@@ -0,0 +1,137 @@
+module CodeFumes
+  # Defines the contract between CodeFumes and any local source control
+  # management system (SCM).
+  #
+  # *NOTE:* Git is currently the only supported SCM. We look
+  # forward to changing this soon.
+  class SourceControl
+    SUPPORTED_SCMS_AND_DETECTORS = {:git => '.git'} #:nodoc:
+
+    # Sets up a SourceControl object to read content from the repository
+    # located at +path+.
+    def initialize(path)
+      begin
+        @repository = Grit::Repo.new(path)
+      rescue Grit::InvalidGitRepositoryError
+        raise Errors::UnsupportedScmToolError
+      end
+    end
+
+    # Returns a serialized Hash containing a single +:commits+ key
+    # associated with an Array of serialized commit information, ready
+    # to be sent to the CodeFumes service.
+    def payload_between(from = initial_commit_identifier, to = "HEAD")
+      start_commit = from || initial_commit_identifier
+      end_commit = to || "HEAD"
+      new_commits = commits_between(start_commit, end_commit)
+      new_commits.empty? ? {} : {:commits => new_commits}
+    end
+    alias :payload :payload_between
+
+    # Returns the first commit identifier of a repository's history.
+    def initial_commit_identifier
+      initial_commit.sha
+    end
+
+    # Returns an array of 'symbolized' executable names for all
+    # supported SCMs.
+    #
+    # The names are returned as symbols.
+    def self.supported_systems
+      SUPPORTED_SCMS_AND_DETECTORS.keys
+    end
+
+    # Accepts command-line executable name of SCM and returns whether it
+    # is a supported SCM or not. +tool_cli_name+ should be the
+    # name of the executable, not the 'full name' of the application
+    # (ex: 'svn' not 'subversion').
+    #
+    # Returns +true+ if the SCM is supported
+    #
+    # Returns +false+ if the SCM is not supported.
+    def self.supported_system?(tool_cli_name)
+      SUPPORTED_SCMS_AND_DETECTORS.keys.include?(tool_cli_name.to_sym)
+    end
+
+    # Stores the public_key of the project associated with the
+    # underlying local repository.  This will not be necessary
+    # with all SCMs.
+    #
+    # For example, in a git repository, this method will store a
+    # +codefumes+ key in the +.git/config+ file.  This value can be used
+    # as a lookup key for other tools to use in conjunction with the
+    # CodeFumes config file (see +ConfigFile+) to interact with a
+    # CodeFumes project.
+    def store_public_key(public_key)
+      @repository.config["codefumes.public-key"] = public_key
+    end
+
+    # Removes any association to the CodeFumes service which would have
+    # been added using the +store_public_key+ method.
+    #
+    # This method does not remove anything from the user's global
+    # CodeFumes config file.
+    def unlink_from_codefumes!
+      @repository.git.config({}, "--remove-section", "codefumes")
+    end
+
+    # Returns the public key of the project associated with this
+    # repository.
+    def public_key
+      @repository.config["codefumes.public-key"]
+    end
+
+    # Returns the private key of the project assciated with this
+    # repository.
+    def private_key
+      ConfigFile.options_for_project(public_key)[:private_key]
+    end
+
+    # Returns the current commit identifier of the underlying
+    # repository ('HEAD' of the supplied branch in git parlance).
+    def local_commit_identifier(branch_name = "master")
+      raise ArgumentError, "nil branch name supplied" if branch_name.nil?
+      @repository.get_head(branch_name).commit.sha
+    end
+
+    # Returns the full path of the underlying repository.
+    def path
+      @repository.path
+    end
+
+    private
+      def initial_commit
+        @repository.log.last
+      end
+
+      # Returns Array of serialized commit data. Each item in the Array
+      # contains attributes of a single commit.
+      def commits_between(from, to, including_from_commit = false)
+        commit_list = @repository.commits_between(from,to)
+
+        if including_from_commit == true || from == initial_commit_identifier
+          commit_list = [initial_commit] + commit_list
+        end
+
+        commit_list.map do |commit|
+          commit_stats = commit.stats
+          {
+            :identifier => commit.sha,
+            :author_name => commit.author.name,
+            :author_email => commit.author.email,
+            :committer_name => commit.committer.name,
+            :committer_email => commit.committer.email,
+            :authored_at => commit.authored_date,
+            :committed_at => commit.committed_date,
+            :message => commit.message,
+            :short_message => commit.short_message,
+            :parent_identifiers => commit.parents.map(&:sha).join(','),
+            :line_additions => commit_stats.additions,
+            :line_deletions => commit_stats.deletions,
+            :line_total => commit_stats.deletions,
+            :affected_file_count => commit_stats.files.count
+          }
+        end.reverse
+      end
+  end
+end

data/lib/integrity_notifier/codefumes.haml

@@ -0,0 +1,11 @@
+%p.normal
+  %label{ :for => "cf_build_name" } Build name
+  %input.text#cf_build_name{ :name => "notifiers[CodeFumes][build_name]", :type => "text", :value => config["build_name"] }
+
+%p.normal
+  %label{ :for => "cf_public_key" } Public key
+  %input.text#cf_public_key{ :name => "notifiers[CodeFumes][public_key]", :type => "text", :value => config["public_key"] }
+
+%p.normal
+  %label{ :for => "cf_private_key" } Private key
+  %input.text#cf_private_key{ :name => "notifiers[CodeFumes][private_key]", :type => "text", :value => config["private_key"] }

data/lib/integrity_notifier/codefumes.rb

@@ -0,0 +1,62 @@
+begin
+  require 'codefumes_harvester'
+rescue LoadError
+  abort "Install codefumes_harvester to use the CodeFumes notifier"
+end
+
+module CodeFumesHarvester
+  class IntegrityNotifier
+    class CodeFumes < ::Integrity::Notifier::Base
+      attr_reader :private_key, :public_key
+
+      def self.to_haml
+        @haml ||= File.read(File.dirname(__FILE__) + "/codefumes.haml")
+      end
+
+      def initialize(build, config={})
+        @public_key  = config["public_key"]
+        @private_key = config["private_key"]
+        @build_name  = config["build_name"]
+        @repo_path   = Integrity::Repository.new(
+          build.id, build.project.uri, build.project.branch, build.commit.identifier
+        ).directory
+        super(build, config)
+      end
+
+      def deliver!
+        Integrity.log "Updating build '#{@build_name}' for '#{@public_key}' (state: #{build_state})"
+        qb_options = {:public_key  => @public_key,
+                      :private_key => @private_key,
+                      :ended_at    => @build.completed_at,
+                      :repository_path => @repo_path}
+
+        CodeFumesHarvester::QuickBuild.finish(@build_name, build_state, qb_options)
+      end
+
+      def deliver_started_notification!
+        Integrity.log "Adding build '#{@build_name}' for '#{@public_key}' (state: #{build_state})"
+        qb_options = {:public_key  => @public_key,
+                      :private_key => @private_key,
+                      :started_at  => @build.started_at,
+                      :repository_path => @repo_path}
+
+        CodeFumesHarvester::QuickBuild.start(@build_name, qb_options)
+      end
+
+      private
+        def build_state
+          case @build.status
+          when :success  then :successful
+          when :failed   then :failed
+          when :building then :running
+          end
+        end
+    end
+  end
+end
+
+module Integrity
+  class Notifier
+    register CodeFumesHarvester::IntegrityNotifier::CodeFumes
+  end
+end

data/spec/codefumes/{build_spec.rb → api/build_spec.rb}

@@ -1,7 +1,7 @@
-require File.dirname(__FILE__) + '/../spec_helper.rb'
+require File.dirname(__FILE__) + '/../../spec_helper.rb'
 
-describe "Build" do
-  include CodeFumesServiceHelpers::Build
+describe "API::Build" do
+  include CodeFumesServiceHelpers::BuildHelpers
 
   after(:all) do
     FakeWeb.allow_net_connect = false
@@ -11,11 +11,7 @@ describe "Build" do
   before(:each) do
     setup_fixture_base
     setup_build_fixtures
-    @build_params = { :public_key => @pub_key, :private_key => @priv_key,
-                       :name => @build_name, :commit_identifier => @commit_identifier,
-                       :started_at => @started_at, :state => @state}
-
-    @build = Build.new(@build_params)
+    @build = Build.new(@commit, @build_name, @state, {:started_at => @started_at})
   end
 
   describe "save" do
@@ -23,10 +19,10 @@ describe "Build" do
       @build.stub!(:exists?).and_return(false)
       register_create_uri(["401", "Unauthorized"], "")
 
-      basic_auth_params = {:username => @pub_key, :password => @priv_key}
+      basic_auth_params = {:username => @project.public_key, :password => @project.private_key}
 
       build_query = {:build => {:name => @build_name, :ended_at => nil, :started_at => @started_at, :state => @state}}
-      Build.should_receive(:post).with("/projects/#{@project.public_key}/commits/#{@commit_identifier}/builds", :query => build_query, :basic_auth => basic_auth_params).and_return(mock("response", :code => 401))
+      API.should_receive(:post).with("/projects/#{@project.public_key}/commits/#{@commit_identifier}/builds", :query => build_query, :basic_auth => basic_auth_params).and_return(mock("response", :code => 401))
       @build.save
     end
 
@@ -63,16 +59,13 @@ describe "Build" do
     end
 
     context "when the build already exists on the server" do
-      before(:each) do
-        register_update_uri(["200", "OK"])
-        @build = Build.new(@build_params.merge(:identifier => @build_identifier))
-        Build.stub!(:find).and_return(@build)
-      end
-
       it "updates the existing build" do
+        register_update_uri(["200", "OK"])
+        build = Build.new(@commit, @build_name, @state, {:identifier => @build_identifier})
+        Build.stub!(:find).and_return(build)
         mock_response = mock("Response", :code => 200).as_null_object
-        @build.should_receive(:update).and_return(mock_response)
-        @build.save
+        build.should_receive(:update).and_return(mock_response)
+        build.save
       end
     end
   end
@@ -81,21 +74,18 @@ describe "Build" do
     before(:each) do
       setup_fixture_base
       setup_build_fixtures
-      @find_params = {:public_key => @pub_key,
-                      :commit_identifier => @commit_identifier,
-                      :identifier => @build_identifier}
     end
 
     it "returns an instance of Build when found" do
       register_show_uri(["200", "OK"])
-      returned_object = Build.find(@find_params)
+      returned_object = Build.find(@commit, @build_name)
       returned_object.should  be_instance_of(Build)
       returned_object.state.should_not be_nil
     end
 
     it "returns nil when not found" do
       register_show_uri(["404", "Not found"])
-      Build.find(@find_params).should be_nil
+      Build.find(@commit, @build_name).should be_nil
     end
   end
 
@@ -103,7 +93,7 @@ describe "Build" do
     before(:each) do
       setup_fixture_base
       setup_build_fixtures
-      @build = Build.new(@build_params.merge(:identifier => @build_identifier))
+      @build = Build.new(@commit, @build_name, @state)
     end
 
     it "returns true when the request returns a status of '200 Ok'" do

data/spec/codefumes/{claim_spec.rb → api/claim_spec.rb}

@@ -1,7 +1,7 @@
-require File.dirname(__FILE__) + '/../spec_helper.rb'
+require File.dirname(__FILE__) + '/../../spec_helper.rb'
 
-describe Claim do
-  include CodeFumesServiceHelpers::Claim
+describe "API::Claim" do
+  include CodeFumesServiceHelpers::ClaimHelpers
 
   after(:all) do
     FakeWeb.allow_net_connect = false
@@ -47,6 +47,32 @@ describe Claim do
         }.should raise_error(ArgumentError)
       end
     end
+
+    context "a nil value is passed in for the api_key" do
+      it "should not hit the CodeFumes API" do
+        API.should_not_receive(:put)
+        lambda {Claim.create(@project, nil)}
+      end
+
+      it "raises a NoUserApiKeyError" do
+        lambda {
+          Claim.create(@project, nil)
+        }.should raise_error(Errors::NoUserApiKeyError)
+      end
+    end
+
+    context "an empty string is passed in for the api_key" do
+      it "should not hit the CodeFumes API" do
+        API.should_not_receive(:put)
+        lambda {Claim.create(@project, '')}
+      end
+
+      it "raises a NoUserApiKeyError" do
+        lambda {
+          Claim.create(@project, '')
+        }.should raise_error(Errors::NoUserApiKeyError)
+      end
+    end
   end
 
   describe "destroy" do
@@ -63,5 +89,18 @@ describe Claim do
         Claim.destroy(@project, @api_key).should be_false
       end
     end
+
+    context "a nil value is passed in for the api_key" do
+      it "should not hit the CodeFumes API" do
+        API.should_not_receive(:delete)
+        lambda {Claim.destroy(@project, nil)}
+      end
+
+      it "raises a NoUserApiKeyError" do
+        lambda {
+          Claim.destroy(@project, nil)
+        }.should raise_error(Errors::NoUserApiKeyError)
+      end
+    end
   end
 end

data/spec/codefumes/{commit_spec.rb → api/commit_spec.rb}

@@ -1,7 +1,7 @@
-require File.dirname(__FILE__) + '/../spec_helper.rb'
+require File.dirname(__FILE__) + '/../../spec_helper.rb'
 
-describe "Commit" do
-  include CodeFumesServiceHelpers::Commit
+describe "API::Commit" do
+  include CodeFumesServiceHelpers::CommitHelpers
 
   before(:all) do
     FakeWeb.allow_net_connect = false
@@ -11,9 +11,7 @@ describe "Commit" do
     @priv_key = 'private_key_value'
     @anonymous_base_uri = "http://codefumes.com/api/v1/xml"
     @authenticated_base_uri = "http://#{@pub_key}:#{@priv_key}@codefumes.com/api/v1/xml/projects"
-    @project = Project.new(:public_key => @pub_key,
-                           :private_key => @priv_key,
-                           :name => @project_name)
+    @project = Project.new(@pub_key, :private_key => @priv_key, :name => @project_name)
     @authd_project_api_uri = "#{@authenticated_base_uri}/projects/#{@pub_key}"
     @anon_project_api_uri  = "#{@anonymous_base_uri}/projects/#{@pub_key}"
     @basic_auth_params = {:username => @pub_key, :password => @priv_key}
@@ -24,11 +22,23 @@ describe "Commit" do
     FakeWeb.clean_registry
   end
 
-  describe "find" do
+  describe "#id" do
+    it "returns the value of #identifier" do
+      Commit.new(@project, @identifier).id.should == @identifier
+    end
+  end
+
+  describe "#sha" do
+    it "returns the value of #identifier" do
+      Commit.new(@project, @identifier).sha.should == @identifier
+    end
+  end
+
+  describe "#find" do
     context "with a valid commit identifier" do
       before(:each) do
         register_find_uri
-        @commit = Commit.find(@identifier)
+        @commit = Commit.find(@project, @identifier)
       end
 
       [:identifier,
@@ -60,40 +70,40 @@ describe "Commit" do
       end
 
       it "returns nil" do
-        Commit.find(@identifier).should == nil
+        Commit.find(@project, @identifier).should == nil
       end
     end
   end
 
-  describe "calling 'latest'" do
+  describe "#latest" do
     context "with valid parameters" do
       it "returns a commit object for the latest commit" do
         register_latest_uri
-        Commit.latest(@pub_key).identifier.should == @identifier
+        Commit.latest(@project).identifier.should == @identifier
       end
     end
 
     context "with invalid parameters" do
       it "returns nil" do
         register_latest_uri(["404", "Not Found"], "")
-        Commit.latest(@pub_key).should == nil
+        Commit.latest(@project).should == nil
       end
     end
   end
 
-  describe "calling 'latest_identifier'" do
+  describe "#latest_identifier" do
     context "with valid parameters" do
       context "when the specified project has commits stored" do
         it "returns the commit identifier of the latest commit" do
           register_latest_uri
-          Commit.latest_identifier(@pub_key).should == @identifier
+          Commit.latest_identifier(@project).should == @identifier
         end
       end
 
       context "when the specified project does not have any commits stored" do
         it "returns nil" do
           register_latest_uri(["404", "Not Found"], "")
-          Commit.latest_identifier(@pub_key).should == nil
+          Commit.latest_identifier(@project).should == nil
         end
       end
     end
@@ -101,23 +111,23 @@ describe "Commit" do
     context "with invalid parameters" do
       it "returns nil" do
         register_latest_uri(["404", "Not Found"], "")
-        Commit.latest(@pub_key).should == nil
+        Commit.latest(@project).should == nil
       end
     end
   end
 
-  describe "calling 'all'" do
+  describe "#all" do
     context "with valid parameters" do
       it "returns an array of commits" do
         register_index_uri
-        Commit.all(@pub_key).should have(3).items
+        Commit.all(@project).should have(3).items
       end
     end
 
     context "with invalid parameters" do
       it "returns nil" do
         register_index_uri(["404", "Not Found"], "")
-        Commit.all(@pub_key).should == nil
+        Commit.all(@project).should == nil
       end
     end
   end
@@ -127,17 +137,17 @@ describe "Commit" do
       register_find_uri
       @email = "jdoe@example.com"
       @name  = "John Doe"
-      @commit = Commit.find(@identifier)
+      @commit = Commit.find(@project, @identifier)
     end
 
-    describe "author" do
+    describe "#author" do
       it "returns a concatenated string containing the author's name & email" do
         @commit.author.should =~ /#{@name}/
         @commit.author.should =~ /#{@email}/
       end
     end
 
-    describe "committer" do
+    describe "#committer" do
       it "returns a concatenated string containing the author's name & email" do
         @commit.committer.should =~ /#{@name}/
         @commit.committer.should =~ /#{@email}/
@@ -152,14 +162,14 @@ describe "Commit" do
       end
 
       it "returns an empty Hash" do
-        Commit.latest(@pub_key).custom_attributes.should == {}
+        Commit.latest(@project).custom_attributes.should == {}
       end
     end
 
     context "when the commit has defined custom attributes" do
       before(:each) do
         register_latest_uri(["200", "Ok"], fixtures[:commit_with_custom_attrs])
-        @commit = Commit.latest(@pub_key)
+        @commit = Commit.latest(@project)
       end
 
       it "returns a Hash of key-value pairs (attribute_name -> attribute_value)" do