codefumes 0.1.2 → 0.1.3

data/History.txt

@@ -1,4 +1,15 @@
+== 0.1.3 2009-09-22
+
+* Added ConfigFile#save_credentials
+* Added ConfigFile#credentials
+* Added store_codefumes_credentials executable
+* Added support for claiming projects (Project#claim, Claim#create)
+* Added cf_claim_project executable
+* Added :local mode for API
+* Removed (almost) all "require 'rubygems'" statements
+
 == 0.1.2 2009-09-10
+
 * Documentation updated
 * Fixed dependency definitions in Rakefile
 

data/Manifest.txt

@@ -2,23 +2,28 @@ History.txt
 Manifest.txt
 README.txt
 Rakefile
-config/website.yml.sample
+bin/cf_claim_project
+bin/store_codefumes_credentials
+lib/cf_claim_project/cli.rb
 lib/codefumes.rb
 lib/codefumes/api.rb
+lib/codefumes/claim.rb
 lib/codefumes/commit.rb
 lib/codefumes/config_file.rb
 lib/codefumes/payload.rb
 lib/codefumes/project.rb
+lib/store_codefumes_credentials/cli.rb
+spec/cf_claim_project/cli_spec.rb
 spec/codefumes/api_spec.rb
+spec/codefumes/claim_spec.rb
 spec/codefumes/commit_spec.rb
 spec/codefumes/config_file_spec.rb
 spec/codefumes/payload_spec.rb
 spec/codefumes/project_spec.rb
+spec/codefumes_service_stubs.rb
 spec/spec.opts
 spec/spec_helper.rb
+spec/store_codefumes_credentials/cli_spec.rb
 tasks/rspec.rake
 website/index.html
-website/index.txt
-website/javascripts/rounded_corners_lite.inc.js
 website/stylesheets/screen.css
-website/template.html.erb

data/README.txt

@@ -1,6 +1,10 @@
 = codefumes
 
-http://www.codefumes.com
+* http://codefumes.rubyforge.org/codefumes
+* Wiki: https://github.com/cosyn/codefumes/wikis
+* Repository: https://github.com/cosyn/codefumes
+* Official CodeFumes.com gems: http://codefumes.rubyforge.org/
+* Website: http://www.codefumes.com
 
 == DESCRIPTION:
 
@@ -46,8 +50,8 @@ gem, you can refer to the
   # Creating & finding a CodeFumes project
   p = Project.save  # optionally providing a custom public key: :public_key => 'Abc3'
   found_p = Project.find(p.public_key)
-  p.pulic_key # => 'Abc3'
-  p.api_uri   # => 'http://codefumes.com/api/v1/xml/Abc3'
+  p.public_key # => 'Abc3'
+  p.api_uri    # => 'http://codefumes.com/api/v1/xml/Abc3'
 
   # Commits
   c = Commit.find(<commit identifier>)

data/Rakefile

@@ -1,6 +1,7 @@
 %w[hoe rake rake/clean fileutils rubigen hoe].each { |f| require f }
 
-require File.dirname(__FILE__) + '/lib/codefumes'
+$LOAD_PATH.unshift('lib') unless $LOAD_PATH.include?('lib')
+require 'lib/codefumes'
 
 begin
   require "hanna/rdoctask"
@@ -15,9 +16,14 @@ begin
 rescue LoadError
 end
 
+Hoe.plugin :website
+
 $hoe = Hoe.spec('codefumes') do
   self.summary = "A client-side implementation of the CodeFumes.com API."
-  self.extra_dev_deps = [['jscruggs-metric_fu', ">= 1.1.5"]]
+  self.extra_dev_deps = [['jscruggs-metric_fu', ">= 1.1.5"],
+                         ['rubigen', ">= 1.5.2"],
+                         ['fakeweb', ">= 1.2.0"]
+                        ]
   self.extra_deps     = [['httparty','>= 0.4.3']]
   developer('Tom Kersten', 'tom.kersten@cosyntech.com')
   developer('Joe Banks', 'freemarmoset@gmail.com')

data/bin/cf_claim_project

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+#
+#  Created on 2009-9-21.
+#  Copyright (c) 2009. All rights reserved.
+
+require 'lib/codefumes'
+require "lib/cf_claim_project/cli"
+
+CfClaimProject::CLI.execute(STDOUT, ARGV)

data/bin/store_codefumes_credentials

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+#
+#  Created on 2009-9-18.
+#  Copyright (c) 2009. All rights reserved.
+
+require 'rubygems'
+require File.expand_path(File.dirname(__FILE__) + "/../lib/codefumes")
+require "lib/store_codefumes_credentials/cli"
+
+StoreCodefumesCredentials::CLI.execute(STDOUT, ARGV)

data/lib/cf_claim_project/cli.rb

@@ -0,0 +1,81 @@
+require 'optparse'
+require 'codefumes/config_file'
+include CodeFumes
+
+module CfClaimProject
+  class CLI
+    @attempt_to_claim_all = false
+
+    def self.execute(stdout, arguments=[])
+      @stdout = stdout
+      parse_cli_arguments!(arguments)
+      retrieve_users_credentials_or_exit
+
+
+      @public_keys.each do |public_key|
+        project = Project.find(public_key)
+
+        if project.nil?
+          @stdout.puts "Claiming...'#{public_key}': Not found"
+          next
+        end
+
+        @stdout.print "Claiming...'#{public_key}': "
+        @stdout.puts Claim.create(project, @users_api_key) ? 'Success!' : 'Denied.'
+      end
+
+      @stdout.puts ""
+      @stdout.puts "Done!"
+    end
+
+    private
+      def self.parse_cli_arguments!(arguments)
+        OptionParser.new do |opts|
+          opts.banner = <<-BANNER.gsub(/^          /,'')
+            This application is wonderful because...
+
+            Usage: #{File.basename($0)} [options]
+
+            Options are:
+          BANNER
+          opts.separator ""
+          opts.on("-a", "--all", String,
+                  "Attempt to claim all projects in your CodeFumes config file"
+                  ) {@attempt_to_claim_all = true}
+          opts.on("-h", "--help",
+                  "Show this help message.") { @stdout.puts opts; exit(1) }
+          opts.parse!(arguments)
+        end
+
+        @public_keys = claim_all_projects_flag_set? ? ConfigFile.public_keys : [ARGV[0]].compact
+        if @public_keys.empty?
+          print_missing_arguments_message
+          exit
+        end
+
+      end
+
+      def self.claim_all_projects_flag_set?
+        @attempt_to_claim_all == true
+      end
+
+      def self.print_missing_arguments_message
+        @stdout.puts "You must specify either a public key of a project, or -a/--all to"
+        @stdout.puts "claim all projects in your CodeFumes config file"
+        @stdout.puts ""
+        @stdout.puts "Exiting."
+      end
+
+      def self.retrieve_users_credentials_or_exit
+        @users_api_key = ConfigFile.credentials[:api_key]
+        return @users_api_key unless @users_api_key.nil?
+        @stdout.puts "No API key saved in your CodeFumes config file!"
+        @stdout.puts ""
+        @stdout.puts "Grab your API key from CodeFumes.com and run 'store_codefumes_credentials [api_key]."
+        @stdout.puts "Then try again."
+        @stdout.puts ""
+        @stdout.puts "Exiting."
+        exit
+      end
+  end
+end

data/lib/codefumes/api.rb

@@ -1,19 +1,20 @@
 module CodeFumes
   class API
     include HTTParty
-    
+
     format :xml
-    
+
     BASE_URIS = {
       :production => 'http://www.codefumes.com/api/v1/xml',
-      :test => 'http://test.codefumes.com/api/v1/xml'
+      :test       => 'http://test.codefumes.com/api/v1/xml',
+      :local      => 'http://localhost:3000/api/v1/xml'
     }
-    
+
     def self.mode(mode)
       base_uri(BASE_URIS[mode]) if BASE_URIS[mode]
     end
-    
+
     mode(:production)
 
   end
-end
+end

data/lib/codefumes/claim.rb

@@ -0,0 +1,24 @@
+module CodeFumes
+  class Claim < CodeFumes::API
+    attr_accessor :created_at
+
+    # Attempts to claim the specified Project instance using the
+    # supplied API key.
+    #
+    # Similar to Project#claim, but more explicit.
+    #
+    # Returns true if the request is successful.
+    #
+    # Returns +false+ in all other cases.
+    def self.create(project, api_key)
+      auth_args = {:username => project.public_key, :password => project.private_key}
+
+      uri = "/projects/#{project.public_key}/claim"
+      response = post(uri, :query => {:api_key => api_key}, :basic_auth => auth_args)
+      case response.code
+        when 201 : true
+        else false
+      end
+    end
+  end
+end

data/lib/codefumes/commit.rb

@@ -92,11 +92,11 @@ module CodeFumes
     def self.find(identifier)
       response = get("/commits/#{identifier}")
       case response.code
-      when 200
-        return nil if response["commit"].empty?
-        new(response["commit"])
-      else
-        nil
+        when 200
+          return nil if response["commit"].empty?
+          new(response["commit"])
+        else
+          nil
       end
     end
 
@@ -105,13 +105,13 @@ module CodeFumes
     def self.all(project_public_key)
       response = get("/projects/#{project_public_key}/commits")
       case response.code
-      when 200
-        return [] if response["commits"].empty? || response["commits"]["commit"].nil?
-        response["commits"]["commit"].map do |commit_data|
-          new(commit_data)
-        end
-      else
-        nil
+        when 200
+          return [] if response["commits"].empty? || response["commits"]["commit"].nil?
+          response["commits"]["commit"].map do |commit_data|
+            new(commit_data)
+          end
+        else
+          nil
       end
     end
 
@@ -120,10 +120,10 @@ module CodeFumes
     def self.latest(project_public_key)
       response = get("/projects/#{project_public_key}/commits/latest")
       case response.code
-      when 200
-        new(response["commit"])
-      else
-        nil
+        when 200
+          new(response["commit"])
+        else
+          nil
       end
     end
 

data/lib/codefumes/config_file.rb

@@ -34,20 +34,30 @@ module CodeFumes
 
       # Store the supplied project into the CodeFumes config file.
       def save_project(project)
-        config = serialized
-        if config[:projects]
-          config[:projects].merge!(project.to_config)
-        else
-          config[:projects] = project.to_config
+        update_config_file do |config|
+          if config[:projects]
+            config[:projects].merge!(project.to_config)
+          else
+            config[:projects] = project.to_config
+          end
         end
-        write(config)
       end
 
       # Remove the supplied project from the CodeFumes config file.
       def delete_project(project)
-        config = serialized
-        config[:projects] && config[:projects].delete(project.public_key.to_sym)
-        write(config)
+        update_config_file do |config|
+          config[:projects] && config[:projects].delete(project.public_key.to_sym)
+        end
+      end
+
+      def save_credentials(api_key)
+        update_config_file do |config|
+          config.merge!(:credentials => {:api_key => api_key})
+        end
+      end
+
+      def credentials
+        serialized[:credentials] || {}
       end
 
       # Returns a Hash representation of the CodeFumes config file
@@ -62,6 +72,11 @@ module CodeFumes
         public_key && config[:projects] && config[:projects][public_key.to_sym] || {}
       end
 
+      def public_keys
+        serialized_projects = serialized[:projects]
+        serialized_projects.nil? ? [] : serialized_projects.keys
+      end
+
       private
         def write(serializable_object)
           File.open(path, 'w') do |f|
@@ -80,6 +95,12 @@ module CodeFumes
         def loaded
           YAML::load_file(path)
         end
+
+        def update_config_file(&block)
+          config = serialized
+          yield config
+          write(config)
+        end
     end
   end
 end

data/lib/codefumes/payload.rb

@@ -16,7 +16,7 @@ module CodeFumes
     #
     #   {:public_key => "abC3", :private_key => "some-private-key",
     #   :content => {:commits => [{:identifier => "commit_identifer",
-    #   :files_affected => 3, :any_metric_you_want => "value"}]}}
+    #   :files_affected => 3, :custom_attributes => {:any_metric_you_want => "value"}}]}}
     def initialize(options = {})
       @project_public_key = options[:public_key]
       @project_private_key = options[:private_key]
@@ -36,11 +36,11 @@ module CodeFumes
       response = self.class.post("/projects/#{@project_public_key}/payloads", :query => {:payload => @content}, :basic_auth => {:username => @project_public_key, :password => @project_private_key})
 
       case response.code
-      when 201
-        @created_at = response['payload']['created_at']
-        true
-      else
-        false
+        when 201
+          @created_at = response['payload']['created_at']
+          true
+        else
+          false
       end
     end
 
@@ -65,7 +65,7 @@ module CodeFumes
 
       public_key = raw_payload.delete(:public_key)
       raise ArgumentError, "No public key provided" if public_key.nil?
-      
+
       private_key = raw_payload.delete(:private_key)
 
       if raw_payload[:content].nil? || raw_payload[:content][:commits].nil?

data/lib/codefumes/project.rb

@@ -25,10 +25,10 @@ module CodeFumes
     def delete
       response = destroy!
       case response.code
-      when 200
-        return true
-      else
-        return false
+        when 200
+          return true
+        else
+          return false
       end
     end
 
@@ -43,11 +43,11 @@ module CodeFumes
     def save
       response = exists? ? update : create
       case response.code
-      when 201, 200
-        reinitialize!(response)
-        true
-      else
-        false
+        when 201, 200
+          reinitialize!(response)
+          true
+        else
+          false
       end
     end
 
@@ -79,11 +79,11 @@ module CodeFumes
     def self.find(public_key)
       response = get("/projects/#{public_key}")
       case response.code
-      when 200
-        project = Project.new
-        project.reinitialize!(response)
-      else
-        nil
+        when 200
+          project = Project.new
+          project.reinitialize!(response)
+        else
+          nil
       end
     end
 
@@ -97,6 +97,20 @@ module CodeFumes
       self
     end
 
+    # Attempts to claim "ownership" of the project using the API key
+    # defined in the "credentials" section of your CodeFumes config
+    # file.
+    #
+    # If you need to claim a project for a key that is not defined in
+    # your config file, refer to Claim#create.
+    #
+    # Returns true if the request is successful.
+    #
+    # Returns +false+ in all other cases.
+    def claim
+      Claim.create(self, ConfigFile.credentials[:api_key])
+    end
+
     private
       def update
         self.class.put("/projects/#{@public_key}", :query => {:project => {:name => @name}}, :basic_auth => {:username => @public_key, :password => @private_key})

data/lib/codefumes.rb

@@ -1,11 +1,12 @@
 require 'httparty'
 
 require 'codefumes/api'
-require 'codefumes/project'
+require 'codefumes/claim'
+require 'codefumes/commit'
 require 'codefumes/config_file'
 require 'codefumes/payload'
-require 'codefumes/commit'
+require 'codefumes/project'
 
 module CodeFumes
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

data/lib/store_codefumes_credentials/cli.rb

@@ -0,0 +1,49 @@
+require 'optparse'
+
+module StoreCodefumesCredentials
+  class CLI
+    def self.execute(stdout, arguments=[])
+      parse_command_line_options!(stdout, arguments)
+
+      api_key = ARGV[0]
+      if CodeFumes::ConfigFile.credentials.empty? || @force_overwrite == true
+        CodeFumes::ConfigFile.save_credentials(api_key)
+        stdout.puts "Saved credentials to codefumes config file.\n\nExiting."
+      else
+        if CodeFumes::ConfigFile.credentials == api_key
+          stdout.puts "Credentials already stored in config file!\n"
+        else
+          stdout.puts "You have already stored CodeFumes credentials.\n\n"
+          stdout.puts "The current value you have stored is: #{CodeFumes::ConfigFile.credentials[:api_key]}\n\n"
+          stdout.puts "If you would like to replace this value, execute:\n\n"
+          stdout.puts "\t#{File.basename($0)} --force #{api_key}\n\n"
+        end
+      end
+    end
+
+    private
+      def self.parse_command_line_options!(stdout, arguments = [])
+        @force_overwrite = false
+
+        parser = OptionParser.new do |opts|
+          opts.banner = <<-BANNER.gsub(/^          /,'')
+            Stores user's API_KEY from CodFumes.com in the CodeFumes global config file.
+
+            Usage: #{File.basename($0)} [options] api_key
+
+            Options are:
+          BANNER
+          opts.separator ""
+          opts.on("-h", "--help",
+                  "Show this help message.") { stdout.puts opts; exit }
+          opts.on("-f", "--force",
+                  "Force overwrite of existing API key in config file.") { @force_overwrite = true }
+          opts.parse!(arguments)
+
+          if ARGV[0].nil?
+            stdout.puts opts; exit
+          end
+        end
+      end
+  end
+end

data/spec/cf_claim_project/cli_spec.rb

@@ -0,0 +1,15 @@
+require 'spec/spec_helper'
+require 'lib/cf_claim_project/cli'
+
+describe CfClaimProject::CLI, "execute" do
+  before(:each) do
+    ConfigFile.save_credentials("sample_credentials")
+    Project.stub!(:find).and_return(mock(Project))
+    @stdout_io = StringIO.new
+  end
+
+  it "calls Claim#create" do
+    Claim.should_receive(:create)
+    CfClaimProject::CLI.execute(@stdout_io, [])
+  end
+end

data/spec/codefumes/api_spec.rb

@@ -4,30 +4,37 @@ 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
+
+    it "changes the base uri to 'localhost:3000' when switched to local mode (for developer testing)" do
+      CodeFumes::API.mode(:local)
+      APIClass.base_uri.should == 'http://localhost:3000/api/v1/xml'
+    end
   end
   
 end

data/spec/codefumes/claim_spec.rb

@@ -0,0 +1,30 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+describe Claim do
+  after(:all) do
+    FakeWeb.allow_net_connect = false
+    FakeWeb.clean_registry
+  end
+
+  before(:each) do
+    @api_key = "USERS_API_KEY"
+    @project = Project.new(:public_key => 'public_key_value', :private_key => 'private_key_value')
+    @claim_uri = "http://www.codefumes.com/api/v1/xml/projects/#{@project.public_key}/claim?api_key=#{@api_key}"
+  end
+
+  describe "create" do
+    context "with 201 Created response" do
+      it "returns an instance of Claim with the created_at attribute set" do
+        FakeWeb.register_uri( :post, @claim_uri, :status => ["201", "Created"], :string =>  "")
+        Claim.create(@project, @api_key).should be_true
+      end
+    end
+
+    context "with Unauthorized response" do
+      it "returns false" do
+        FakeWeb.register_uri( :post, @claim_uri, :status => ["401", "Unauthorized"], :string =>  "")
+        Claim.create(@project, @api_key).should be_false
+      end
+    end
+  end
+end