codefumes 0.1.0

data/lib/codefumes/project.rb

@@ -0,0 +1,113 @@
+module CodeFumes
+  # A Project encapsulates the concept of a project on the CodeFumes.com
+  # website.  Each project has a public key, private key, and can have a
+  # name defined.  Projects are also associated with a collection of
+  # commits from a repository.
+  class Project < CodeFumes::API
+    attr_reader :private_key, :short_uri, :community_uri, :api_uri
+    attr_accessor :name,:public_key
+
+    # Accepts Hash containing the following keys:
+    # * :public_key
+    # * :private_key
+    # * :name
+    def initialize(options = {})
+      @public_key = options[:public_key]
+      @private_key = options[:private_key]
+      @name = options[:name]
+    end
+
+    # Deletes project from the website.
+    #
+    # Returns +true+ if the request succeeded.
+    #
+    # Returns +false+ if the request failed.
+    def delete
+      response = destroy!
+      case response.code
+      when 200
+        return true
+      else
+        return false
+      end
+    end
+
+    # Saves project +:public_key+ to the website. If the public key
+    # of the project has not been reserved yet, it will attempt to do
+    # so. If the public key of the project is already in use, it will
+    # attempt to update it with the current values.
+    #
+    # Returns +true+ if the request succeeded.
+    #
+    # Returns +false+ if the request failed.
+    def save
+      response = exists? ? update : create
+      case response.code
+      when 201, 200
+        reinitialize!(response)
+        true
+      else
+        false
+      end
+    end
+
+    # Serializes a Project instance to a format compatible with the
+    # CodeFumes config file.
+    def to_config
+      project_attributes = {:api_uri => @api_uri, :short_uri => @short_uri}
+      project_attributes[:private_key] = @private_key if @private_key
+      {@public_key.to_sym => project_attributes}
+    end
+
+    # Verifies existence of Project on website.
+    #
+    # Returns +true+ if the public key of Project is available.
+    #
+    # Returns +false+ if the public key of the Project is not available.
+    def exists?
+      return false if @public_key.nil? || @public_key.empty?
+      !self.class.find(@public_key).nil?
+    end
+
+
+    # Searches website for project with the supplied public key.
+    #
+    # Returns a Project instance if the project exists and is available,
+    # to the user making the request.
+    #
+    # Returns +nil+ in all other cases.
+    def self.find(public_key)
+      response = get("/projects/#{public_key}")
+      case response.code
+      when 200
+        project = Project.new
+        project.reinitialize!(response)
+      else
+        nil
+      end
+    end
+
+    # TODO: Make this a private method
+    def reinitialize!(options = {}) #:nodoc:
+      @public_key    = options['project']['public_key']
+      @private_key   = options['project']['private_key']
+      @short_uri     = options['project']['short_uri']
+      @community_uri = options['project']['community_uri']
+      @api_uri       = options['project']['api_uri']
+      self
+    end
+
+    private
+      def update
+        self.class.put("/projects/#{@public_key}", :query => {:project => {:name => @name}}, :basic_auth => {:username => @public_key, :password => @private_key})
+      end
+
+      def create
+        self.class.post('/projects', :query => {:project => {:name => @name, :public_key => @public_key}})
+      end
+
+      def destroy!
+        self.class.delete("/projects/#{@public_key}", :basic_auth => {:username => @public_key, :password => @private_key})
+      end
+  end
+end

data/spec/codefumes/api_spec.rb

@@ -0,0 +1,33 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+class APIClass < CodeFumes::API
+end
+
+describe "API" do
+  
+  after(:all) do
+    CodeFumes::API.mode(:production)
+  end
+    
+  it "defaults the base uri to the production site" do
+    APIClass.base_uri.should == 'http://www.codefumes.com/api/v1/xml'
+  end
+  
+  context "switching modes" do
+    before(:each) do
+      CodeFumes::API.mode(:test)
+    end
+    it "changes the base uri to the test site when switched to test mode" do
+      APIClass.base_uri.should == 'http://test.codefumes.com/api/v1/xml'
+    end
+    it "changes the base uri to the production site when switched to production mode" do
+      CodeFumes::API.mode(:production)
+      APIClass.base_uri.should == 'http://www.codefumes.com/api/v1/xml'
+    end
+    it "ignores unrecognized modes" do
+      CodeFumes::API.mode(:incomprehensible)
+      APIClass.base_uri.should == 'http://test.codefumes.com/api/v1/xml'
+    end
+  end
+  
+end

data/spec/codefumes/commit_spec.rb

@@ -0,0 +1,270 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+def single_commit(options = {})
+  commit_xml = <<-END_OF_COMMIT
+  <commit>
+    <identifier>f3badd5624dfbcf5176f0471261731e1b92ce957</identifier>
+    <author_name>John Doe</author_name>
+    <author_email>jdoe@example.com</author_email>
+    <committer_name>John Doe</committer_name>
+    <committer_email>jdoe@example.com</committer_email>
+    <short_message>Made command-line option for 'name' actually work</short_message>
+    <message>
+      Made command-line option for 'name' actually work
+      - Commentd out hard-coded 'require' line used for testing
+    </message>
+    <parent_identifiers>9ddj48423jdsjds5176f0471261731e1b92ce957,3ewdjok23jdsjds5176f0471261731e1b92ce957,284djsksjfjsjds5176f0471261731e1b92ce957</parent_identifiers>
+    <committed_at>Wed May 20 09:09:06 -0500 2009</committed_at>
+    <authored_at>Wed May 20 09:09:06 -0500 2009</authored_at>
+    <uploaded_at>2009-06-04 02:43:20 UTC</uploaded_at>
+    <api_uri>http://localhost:3000/api/v1/commits/f3badd5624dfbcf5176f0471261731e1b92ce957.xml</api_uri>
+    <line_additions>20</line_additions>
+    <line_deletions>10</line_deletions>
+    <line_total>30</line_total>
+    <affected_file_count>2</affected_file_count>
+  END_OF_COMMIT
+
+  if options[:include_custom_attributes]
+    commit_xml <<
+    <<-END_OF_COMMIT
+      <custom_attributes>
+        <coverage>83</coverage>
+        <random_attribute>1</random_attribute>
+      </custom_attributes>
+    END_OF_COMMIT
+  end
+
+  commit_xml << "\n</commit>"
+end
+
+
+def register_index_uri
+  FakeWeb.register_uri(
+    :get, "http://www.codefumes.com:80/api/v1/xml/projects/apk/commits",
+    :status => ["200", "Ok"],
+    :string =>  "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<commits>\n#{single_commit}\n#{single_commit}\n#{single_commit}\n</commits>\n")
+end
+
+describe "Commit" do
+  before(:all) do
+    @identifier = "f3badd5624dfbcf5176f0471261731e1b92ce957"
+    FakeWeb.allow_net_connect = false
+  end
+
+  after(:all) do
+    FakeWeb.clean_registry
+  end
+
+  describe "find" do
+    context "with a valid commit identifier" do
+      before(:each) do
+        FakeWeb.register_uri(
+          :get, "http://www.codefumes.com:80/api/v1/xml/commits/f3badd5624dfbcf5176f0471261731e1b92ce957",
+          :status => ["200", "Ok"],
+          :string =>  "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n#{single_commit}")
+        @commit = Commit.find(@identifier)
+      end
+
+      [:identifier,
+       :author_email,
+       :author_name,
+       :committer_name,
+       :committer_email,
+       :short_message,
+       :message,
+       :committed_at,
+       :authored_at,
+       :uploaded_at,
+       :api_uri,
+       :parent_identifiers,
+       :line_additions,
+       :line_deletions,
+       :line_total,
+       :affected_file_count,
+      ].each do |method_name|
+        it "sets the '#{method_name.to_s}'" do
+          @commit.send(method_name).should_not == nil
+        end
+      end
+    end
+
+    context "with a non-existant commit identifier" do
+      before(:each) do
+        @identifier = "non_existant_commit_identifier"
+        FakeWeb.register_uri( :get, "http://www.codefumes.com:80/api/v1/xml/commits/#{@identifier}",
+                              :status => ["404", "Not Found"])
+      end
+
+      it "returns nil" do
+        Commit.find(@identifier).should == nil
+      end
+    end
+  end
+
+  describe "calling 'latest'" do
+    before(:each) do
+      @project_public_key = "apk"
+    end
+
+    context "with valid parameters" do
+      before(:each) do
+        FakeWeb.register_uri(
+          :get, "http://www.codefumes.com:80/api/v1/xml/projects/#{@project_public_key}/commits/latest",
+          :status => ["200", "Ok"],
+          :string =>  "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n#{single_commit}")
+      end
+
+      it "returns a commit object for the latest commit" do
+        Commit.latest(@project_public_key).identifier.should == @identifier
+      end
+    end
+
+    context "with invalid parameters" do
+      before(:each) do
+        FakeWeb.register_uri(
+          :get, "http://www.codefumes.com:80/api/v1/xml/projects/#{@project_public_key}/commits/latest",
+          :status => ["404", "Not Found"],
+          :string =>  "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n#{single_commit}")
+      end
+
+      it "returns nil" do
+        Commit.latest(@project_public_key).should == nil
+      end
+    end
+  end
+
+  describe "calling 'latest_identifier'" do
+    before(:each) do
+      @project_public_key = "apk"
+    end
+
+    context "with valid parameters" do
+      context "when the specified project has commits stored" do
+        before(:each) do
+          FakeWeb.register_uri(
+            :get, "http://www.codefumes.com:80/api/v1/xml/projects/#{@project_public_key}/commits/latest",
+            :status => ["200", "Ok"],
+            :string =>  "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n#{single_commit}")
+        end
+
+        it "returns the commit identifier of the latest commit" do
+          Commit.latest_identifier(@project_public_key).should == @identifier
+        end
+      end
+
+      context "when the specified project does not have any commits stored" do
+        before(:each) do
+          FakeWeb.register_uri(
+            :get, "http://www.codefumes.com:80/api/v1/xml/projects/#{@project_public_key}/commits/latest",
+            :status => ["404", "Not Found"],
+            :string =>  "")
+        end
+
+        it "returns nil" do
+          Commit.latest_identifier(@project_public_key).should == nil
+        end
+      end
+    end
+
+    context "with invalid parameters" do
+      before(:each) do
+        FakeWeb.register_uri(
+          :get, "http://www.codefumes.com:80/api/v1/xml/projects/#{@project_public_key}/commits/latest",
+          :status => ["404", "Not Found"],
+          :string =>  "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n#{single_commit}")
+      end
+
+      it "returns nil" do
+        Commit.latest(@project_public_key).should == nil
+      end
+    end
+  end
+
+  describe "calling 'all'" do
+    before(:each) do
+      register_index_uri
+      @project_public_key = "apk"
+    end
+
+    context "with valid parameters" do
+      it "returns an array of commits" do
+        Commit.all(@project_public_key).should have(3).items
+      end
+    end
+
+    context "with invalid parameters" do
+      before(:each) do
+        FakeWeb.register_uri(
+          :get, "http://www.codefumes.com:80/api/v1/xml/projects/apk/commits",
+          :status => ["404", "Not Found"],
+          :string =>  "")
+      end
+
+      it "returns nil" do
+        Commit.all(@project_public_key).should == nil
+      end
+    end
+  end
+
+  describe "the convenience method" do
+    before(:each) do
+      @email = "jdoe@example.com"
+      @name  = "John Doe"
+      FakeWeb.register_uri(
+        :get, "http://www.codefumes.com:80/api/v1/xml/commits/f3badd5624dfbcf5176f0471261731e1b92ce957",
+        :status => ["200", "Ok"],
+        :string =>  "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n#{single_commit}")
+      @commit = Commit.find(@identifier)
+    end
+
+    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
+      it "returns a concatenated string containing the author's name & email" do
+        @commit.committer.should =~ /#{@name}/
+        @commit.committer.should =~ /#{@email}/
+      end
+    end
+  end
+
+  describe "accessing custom metrics" do
+    before(:each) do
+      @project_public_key = "apk"
+    end
+
+    context "when the commit does not have any custom attributes" do
+      before(:each) do
+        FakeWeb.register_uri(
+          :get, "http://www.codefumes.com:80/api/v1/xml/projects/#{@project_public_key}/commits/latest",
+          :status => ["200", "Ok"],
+          :string =>  "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n#{single_commit}")
+      end
+
+      it "returns an empty Hash" do
+        Commit.latest(@project_public_key).custom_attributes.should == {}
+      end
+    end
+
+    context "when the commit has defined custom attributes" do
+      before(:each) do
+        commit_content = single_commit(:include_custom_attributes => true)
+        FakeWeb.register_uri(
+          :get, "http://www.codefumes.com:80/api/v1/xml/projects/#{@project_public_key}/commits/latest",
+          :status => ["200", "Ok"],
+          :string =>  "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n#{commit_content}")
+      end
+
+      it "returns a Hash of key-value pairs (attribute_name -> attribute_value)" do
+        Commit.latest(@project_public_key).custom_attributes.should be_instance_of(Hash)
+        Commit.latest(@project_public_key).custom_attributes[:coverage].should == "83"
+        Commit.latest(@project_public_key).custom_attributes[:random_attribute].should == "1"
+        Commit.latest(@project_public_key).custom_attributes.size.should == 2
+      end
+    end
+  end
+end

data/spec/codefumes/config_file_spec.rb

@@ -0,0 +1,142 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+describe "ConfigFile" do
+  before(:each) do
+    @project = Project.new(:public_key => 'public_key_value', :private_key => 'private_key_value')
+  end
+
+  after(:all) do
+    unless ConfigFile.path == File.expand_path('~/.codefumes_config')
+      File.delete(ConfigFile.path) if File.exist?(ConfigFile.path)
+    end
+  end
+
+  describe "calling 'path'" do
+    before(:each) do
+      @original_path = ENV['CODEFUMES_CONFIG_FILE']
+    end
+
+    after(:all) do
+      ENV['CODEFUMES_CONFIG_FILE'] = @original_path
+    end
+
+    it "returns a default value of the full path to a dotfile named '.codefumes_config' in the user's home directory" do
+      ENV['CODEFUMES_CONFIG_FILE'] = nil
+      ConfigFile.path.should == File.expand_path('~/.codefumes_config')
+    end
+  end
+
+  describe "calling 'save_project'" do
+    after(:all) do
+      File.delete(ConfigFile.path) if File.exist?(ConfigFile.path)
+    end
+
+    context "when passed a new project" do
+      it "creates the config file if it did not exist already" do
+        File.exist?(ConfigFile.path).should be_false
+        ConfigFile.save_project(@project)
+        File.exist?(ConfigFile.path).should be_true
+      end
+
+      it "adds the supplied project's public key as a new entry under 'projects'" do
+        ConfigFile.save_project(@project)
+        ConfigFile.serialized[:projects].should include(@project.to_config)
+      end
+    end
+
+    context "when passed an existing project" do
+      before(:each) do
+        ConfigFile.save_project(@project)
+        @updated_project = Project.new(:public_key => @project.public_key, :private_key => "updated_private_key")
+      end
+
+      it "does not create a duplicate entry in the list of projects" do
+        ConfigFile.serialized[:projects].should include(@project.to_config)
+        ConfigFile.serialized[:projects].count.should == 1
+        ConfigFile.save_project(@updated_project)
+        ConfigFile.serialized[:projects].should include(@updated_project.to_config)
+        ConfigFile.serialized.count.should == 1
+      end
+    end
+
+    context "when several projects exist" do
+      before(:each) do
+        @project1 = Project.new(:public_key => :p1_pub_value, :private_key => "p1_private_key")
+        @project2 = Project.new(:public_key => :p2_pub_value, :private_key => "p2_private_key")
+        @project3 = Project.new(:public_key => :p3_pub_value, :private_key => "p3_private_key")
+        ConfigFile.save_project(@project1)
+        ConfigFile.save_project(@project2)
+        ConfigFile.save_project(@project3)
+      end
+
+      it "does not modify data pertaining to other projects" do
+        ConfigFile.serialized[:projects].should include(@project1.to_config)
+        ConfigFile.serialized[:projects].should include(@project2.to_config)
+        ConfigFile.serialized[:projects].should include(@project3.to_config)
+      end
+    end
+  end
+
+  describe "calling 'delete_project'" do
+    context "when the project entry exists in the file" do
+      before(:each) do
+        @project1 = Project.new(:public_key => "p1_pub_value", :private_key => "p1_private_key")
+        @project2 = Project.new(:public_key => "p2_pub_value", :private_key => "p2_private_key")
+        @project3 = Project.new(:public_key => "p3_pub_value", :private_key => "p3_private_key")
+        ConfigFile.save_project(@project1)
+        ConfigFile.save_project(@project2)
+        ConfigFile.save_project(@project3)
+        ConfigFile.delete_project(@project2)
+      end
+
+      it "removes the entry for the supplied project from the file" do
+        ConfigFile.serialized[:projects].should_not include(@project2.to_config)
+      end
+
+      xit "does not affect other project entries" do
+        ConfigFile.serialized[:projects].should include(@project1.to_config)
+        ConfigFile.serialized[:projects].should include(@project3.to_config)
+      end
+    end
+
+    context "when the project entry does not exist in the file" do
+      before(:each) do
+        @project = Project.new(:public_key => "p1_pub_nonexist_value", :private_key => "p1_private_key")
+      end
+
+      it "does not raise an error" do
+        lambda {ConfigFile.delete_project(@project)}.should_not raise_error
+      end
+    end
+  end
+
+  describe 'setting a custom path' do
+    before(:each) do
+      @original_path = ENV['CODEFUMES_CONFIG_FILE']
+      ENV['CODEFUMES_CONFIG_FILE'] = nil
+    end
+
+    after(:all) do
+      ENV['CODEFUMES_CONFIG_FILE'] = @original_path
+    end
+
+    context "via an environment variable" do
+      it "updates the value returned from 'path'" do
+        new_path = File.expand_path('./tmp/new_config_via_env_var')
+        ConfigFile.path.should == File.expand_path('~/.codefumes_config')
+        ENV['CODEFUMES_CONFIG_FILE'] = new_path
+        ConfigFile.path.should == new_path
+      end
+    end
+
+    context "via path=" do
+      it "updates the value returned from 'path'" do
+        new_path = File.expand_path('./tmp/new_config')
+        ConfigFile.path.should == File.expand_path('~/.codefumes_config')
+        ConfigFile.path = new_path
+        ConfigFile.path.should == new_path
+      end
+    end
+  end
+
+end