codefumes 0.1.4 → 0.1.5

data/History.txt

@@ -1,3 +1,12 @@
+== 0.1.5 2009-09-26
+
+* Added visibility support to Claim class
+* Updated Claim#create to use PUT request instead of POST
+* Updated cf_claim_project to support -p/--private flag(s)
+* Renamed store_codefumes_credentials to cf_store_credentials
+* Added cf_release_project executable for releasing/deleting project claims
+* Added ConfigFile#api_key
+
 == 0.1.4 2009-09-26
 
 * Updated require statements executables

data/Manifest.txt

@@ -3,8 +3,11 @@ Manifest.txt
 README.txt
 Rakefile
 bin/cf_claim_project
-bin/store_codefumes_credentials
+bin/cf_release_project
+bin/cf_store_credentials
 lib/cf_claim_project/cli.rb
+lib/cf_release_project/cli.rb
+lib/cf_store_credentials/cli.rb
 lib/codefumes.rb
 lib/codefumes/api.rb
 lib/codefumes/claim.rb
@@ -12,18 +15,24 @@ 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/cf_release_project/cli_spec.rb
+spec/cf_store_credentials/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/codefumes_service_helpers.rb
+spec/fixtures/commit.xml
+spec/fixtures/commit_with_custom_attrs.xml
+spec/fixtures/multiple_commits.xml
+spec/fixtures/payload.xml
+spec/fixtures/project.xml
+spec/fixtures/project_update.xml
 spec/spec.opts
 spec/spec_helper.rb
-spec/store_codefumes_credentials/cli_spec.rb
 tasks/rspec.rake
 website/index.html
 website/stylesheets/screen.css

data/Rakefile

@@ -22,7 +22,7 @@ $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"],
                          ['rubigen', ">= 1.5.2"],
-                         ['fakeweb', ">= 1.2.0"]
+                         ['fakeweb', ">= 1.2.6"]
                         ]
   self.extra_deps     = [['httparty','>= 0.4.3']]
   developer('Tom Kersten', 'tom.kersten@cosyntech.com')

data/bin/cf_release_project

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

data/bin/{store_codefumes_credentials → cf_store_credentials}

@@ -5,6 +5,6 @@
 
 require 'rubygems'
 require File.expand_path(File.dirname(__FILE__) + "/../lib/codefumes")
-require File.expand_path(File.dirname(__FILE__) + "/../lib/store_codefumes_credentials/cli")
+require File.expand_path(File.dirname(__FILE__) + "/../lib/cf_store_credentials/cli")
 
-StoreCodefumesCredentials::CLI.execute(STDOUT, ARGV)
+CfStoreCredentials::CLI.execute(STDOUT, ARGV)

data/lib/cf_claim_project/cli.rb

@@ -2,9 +2,10 @@ require 'optparse'
 require 'codefumes/config_file'
 include CodeFumes
 
-module CfClaimProject
-  class CLI
+module CfClaimProject #:nodoc:
+  class CLI #:nodoc:
     @attempt_to_claim_all = false
+    @private_project = false
 
     def self.execute(stdout, arguments=[])
       @stdout = stdout
@@ -21,7 +22,7 @@ module CfClaimProject
         end
 
         @stdout.print "Claiming...'#{public_key}': "
-        @stdout.puts Claim.create(project, @users_api_key) ? 'Success!' : 'Denied.'
+        @stdout.puts Claim.create(project, @users_api_key, visibility) ? 'Success!' : 'Denied.'
       end
 
       @stdout.puts ""
@@ -32,7 +33,9 @@ module CfClaimProject
       def self.parse_cli_arguments!(arguments)
         OptionParser.new do |opts|
           opts.banner = <<-BANNER.gsub(/^          /,'')
-            This application is wonderful because...
+            Used to 'claim' a project on CodeFumes.com. The claim request has a
+            "visibility" attribute as well, which defaults to "public", but can
+            be set to "private" using the -p/--private flag.
 
             Usage: #{File.basename($0)} [options]
 
@@ -40,8 +43,15 @@ module CfClaimProject
           BANNER
           opts.separator ""
           opts.on("-a", "--all", String,
-                  "Attempt to claim all projects in your CodeFumes config file"
+                  "Attempt to claim all projects in your CodeFumes config file."
                   ) {@attempt_to_claim_all = true}
+          opts.on("-p", "--private", String,
+                  "Claims the project(s) as a 'private' project."
+                  ) {@private_project = true}
+          opts.on("-l", "--local",
+                  "Send requests to localhost. (Testing/Development)") { CodeFumes::API.mode(:local) }
+          opts.on("-t", "--test",
+                  "Send requests to test.codefumes.com. (Testing/Development)") { CodeFumes::API.mode(:test) }
           opts.on("-h", "--help",
                   "Show this help message.") { @stdout.puts opts; exit(1) }
           opts.parse!(arguments)
@@ -59,6 +69,10 @@ module CfClaimProject
         @attempt_to_claim_all == true
       end
 
+      def self.visibility
+        @private_project == true ? :private : :public
+      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"
@@ -67,7 +81,7 @@ module CfClaimProject
       end
 
       def self.retrieve_users_credentials_or_exit
-        @users_api_key = ConfigFile.credentials[:api_key]
+        @users_api_key = ConfigFile.api_key
         return @users_api_key unless @users_api_key.nil?
         @stdout.puts "No API key saved in your CodeFumes config file!"
         @stdout.puts ""

data/lib/cf_release_project/cli.rb

@@ -0,0 +1,76 @@
+require 'optparse'
+include CodeFumes
+
+module CfReleaseProject #:nodoc:
+  class CLI #:nodoc:
+    def self.execute(stdout, arguments=[])
+      @stdout = stdout
+      @users_api_key = ConfigFile.api_key
+      parse_cli_options(arguments)
+
+      @public_keys.each do |public_key|
+        project = Project.find(public_key)
+
+        if project.nil?
+          @stdout.puts "Releasing...'#{public_key}': Not found"
+          next
+        end
+
+        @stdout.print "Releasing...'#{public_key}': "
+        @stdout.puts Claim.destroy(project, @users_api_key) ? 'Success!' : 'Denied.'
+      end
+
+      @stdout.puts ""
+      stdout.puts "Done."
+    end
+
+    private
+      def self.parse_cli_options(arguments)
+        parser = OptionParser.new do |opts|
+          opts.banner = <<-BANNER.gsub(/^          /,'')
+            Removes the claim of ownership on a CodeFumes project, making
+            the project visible to the public and possible for other users
+            to claim.
+
+            Usage: #{File.basename($0)} [PROJECT_PUBLIC_KEY]
+
+            Options are:
+          BANNER
+          opts.separator ""
+          opts.on("-a", "--all",
+                  "Release all projects listed in your CodeFumes config file."
+                 ) {@attempt_to_release_all = true}
+          opts.on("-l", "--local",
+                  "Send requests to localhost. (Testing/Development)") { CodeFumes::API.mode(:local) }
+          opts.on("-t", "--test",
+                  "Send requests to test.codefumes.com. (Testing/Development)") { CodeFumes::API.mode(:test) }
+          opts.on("-h", "--help",
+                  "Show this help message."
+                 ) {@stdout.puts opts; exit}
+          opts.parse!(arguments)
+
+          @public_keys = release_all_projects_flag_set? ? ConfigFile.public_keys : arguments.compact
+          if @public_keys.empty?
+            print_missing_arguments_message
+            exit
+          end
+
+          if arguments.empty?
+            @stdout.puts "No public key specified"
+            @stdout.puts opts; exit
+          end
+        end
+      end
+
+      def self.release_all_projects_flag_set?
+        @attempt_to_release_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
+  end
+end

data/lib/{store_codefumes_credentials → cf_store_credentials}/cli.rb

@@ -1,7 +1,7 @@
 require 'optparse'
 
-module StoreCodefumesCredentials
-  class CLI
+module CfStoreCredentials #:nodoc:
+  class CLI #:nodoc:
     def self.execute(stdout, arguments=[])
       @stdout = stdout
       parse_command_line_options!(arguments)

data/lib/codefumes/api.rb

@@ -5,16 +5,21 @@ module CodeFumes
     format :xml
 
     BASE_URIS = {
-      :production => 'http://www.codefumes.com/api/v1/xml',
+      :production => 'http://codefumes.com/api/v1/xml',
       :test       => 'http://test.codefumes.com/api/v1/xml',
-      :local      => 'http://localhost:3000/api/v1/xml'
-    }
+      :local      => 'http://codefumes.com.local/api/v1/xml'
+    } #:nodoc:
 
+    # Set the connection base for all server requests. Valid options
+    # are +:production+ and +:test+, which connect to
+    # http://codefumes.com and http://test.codefumes.com (respectively).
+    #
+    # +:local+ is also technically supported, but provided for local
+    # testing and likely only useful for CodeFumes.com developers.
     def self.mode(mode)
       base_uri(BASE_URIS[mode]) if BASE_URIS[mode]
     end
 
     mode(:production)
-
   end
 end

data/lib/codefumes/claim.rb

@@ -1,22 +1,55 @@
 module CodeFumes
   class Claim < CodeFumes::API
     attr_accessor :created_at
+    SUPPORTED_VISIBILITIES = [:public, :private]
 
     # Attempts to claim the specified Project instance using the
     # supplied API key.
     #
+    # +visibility+ defaults to +:public+. Valid options are +public+
+    # and +private+.
+    #
     # Similar to Project#claim, but more explicit.
     #
-    # Returns true if the request is successful.
+    # Returns +true+ if the request is successful, or if the project
+    # was already owned by the user associated with the privided API
+    # key.
+    #
+    # Returns +false+ in all other cases.
+    def self.create(project, api_key, visibility = :public)
+      unless SUPPORTED_VISIBILITIES.include?(visibility.to_sym)
+        msg = "Unsupported visibility supplied (#{visibility.to_s}). "
+        msg << "Valid options are: #{SUPPORTED_VISIBILITIES.join(', ')}"
+        raise ArgumentError, msg
+      end
+
+      auth_args = {:username => project.public_key, :password => project.private_key}
+
+      uri = "/projects/#{project.public_key}/claim"
+      response = put(uri, :query => {:api_key => api_key, :visibility => visibility}, :basic_auth => auth_args)
+
+      case response.code
+        when 200 : true
+        else false
+      end
+    end
+
+    # Removes a claim on the specified Project instance using the
+    # supplied API key, releasing ownership.  If the project was a
+    # "private" project, this method will convert it to "public".
+    #
+    # Returns true if the request was successful or there was not
+    # an existing owner (the action is idempotent).
     #
     # Returns +false+ in all other cases.
-    def self.create(project, api_key)
+    def self.destroy(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)
+      response = delete(uri, :query => {:api_key => api_key}, :basic_auth => auth_args)
+
       case response.code
-        when 201 : true
+        when 200 : true
         else false
       end
     end

data/lib/codefumes/config_file.rb

@@ -77,6 +77,10 @@ module CodeFumes
         serialized_projects.nil? ? [] : serialized_projects.keys
       end
 
+      def api_key
+        credentials[:api_key]
+      end
+
       private
         def write(serializable_object)
           File.open(path, 'w') do |f|

data/lib/codefumes/project.rb

@@ -108,7 +108,7 @@ module CodeFumes
     #
     # Returns +false+ in all other cases.
     def claim
-      Claim.create(self, ConfigFile.credentials[:api_key])
+      Claim.create(self, ConfigFile.api_key)
     end
 
     private

data/lib/codefumes.rb

@@ -8,5 +8,5 @@ require 'codefumes/payload'
 require 'codefumes/project'
 
 module CodeFumes
-  VERSION = '0.1.4'
+  VERSION = '0.1.5'
 end

data/spec/cf_release_project/cli_spec.rb

@@ -0,0 +1,41 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'cf_release_project/cli'
+
+def delete_config_file
+  unless ConfigFile.path == File.expand_path('~/.codefumes_config')
+    File.delete(ConfigFile.path) if File.exist?(ConfigFile.path)
+  end
+end
+
+def execute_command(args)
+  @stdout_io = StringIO.new
+  CfReleaseProject::CLI.execute(@stdout_io, [args])
+  @stdout_io.rewind
+  @stdout = @stdout_io.read
+end
+
+
+describe CfReleaseProject::CLI, "execute" do
+  before(:each) do
+    @api_key = "my_credentials"
+    @project = Project.new(:public_key => "abc", :private_key => "382")
+    ConfigFile.save_project(@project)
+    ConfigFile.save_credentials(@api_key)
+    Project.stub!(:find).and_return(@project)
+    Claim.stub!(:destroy).with(@project, @api_key)
+  end
+
+  after(:all) do
+    delete_config_file
+  end
+
+  it "deletes the claim on the project" do
+    Claim.should_receive(:destroy).with(@project, @api_key)
+    execute_command(@project.public_key)
+  end
+
+  it "should print default output" do
+    execute_command(@project.public_key)
+    @stdout.should =~ /Done/
+  end
+end

data/spec/{store_codefumes_credentials → cf_store_credentials}/cli_spec.rb

@@ -1,17 +1,22 @@
 require 'spec/spec_helper'
-require 'lib/store_codefumes_credentials/cli'
+require 'lib/cf_store_credentials/cli'
 
-describe StoreCodefumesCredentials::CLI, "execute" do
+def delete_config_file
+  unless ConfigFile.path == File.expand_path('~/.codefumes_config')
+    File.delete(ConfigFile.path) if File.exist?(ConfigFile.path)
+  end
+end
+
+describe CfStoreCredentials::CLI, "execute" do
   after(:all) do
-    unless ConfigFile.path == File.expand_path('~/.codefumes_config')
-      File.delete(ConfigFile.path) if File.exist?(ConfigFile.path)
-    end
+    delete_config_file
   end
 
   before(:each) do
+    delete_config_file
     @api_key_value = "API_KEY#{rand(100)}"
     @stdout_io = StringIO.new
-    StoreCodefumesCredentials::CLI.execute(@stdout_io, [@api_key_value])
+    CfStoreCredentials::CLI.execute(@stdout_io, [@api_key_value])
     @stdout_io.rewind
     @stdout = @stdout_io.read
   end

data/spec/codefumes/api_spec.rb

@@ -9,7 +9,7 @@ describe "API" do
   end
 
   it "defaults the base uri to the production site" do
-    APIClass.base_uri.should == 'http://www.codefumes.com/api/v1/xml'
+    APIClass.base_uri.should == 'http://codefumes.com/api/v1/xml'
   end
 
   context "switching modes" do
@@ -23,7 +23,7 @@ describe "API" do
 
     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'
+      APIClass.base_uri.should == 'http://codefumes.com/api/v1/xml'
     end
 
     it "ignores unrecognized modes" do
@@ -33,7 +33,7 @@ describe "API" do
 
     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'
+      APIClass.base_uri.should == 'http://codefumes.com.local/api/v1/xml'
     end
   end
   

data/spec/codefumes/claim_spec.rb

@@ -1,30 +1,67 @@
 require File.dirname(__FILE__) + '/../spec_helper.rb'
 
 describe Claim do
+  include CodeFumesServiceHelpers::Claim
+
   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}"
+  before(:all) do
+    FakeWeb.clean_registry
+    FakeWeb.allow_net_connect = false
+    setup_fixture_base
   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 =>  "")
+    context "with '200 Ok' response" do
+      it "returns true" do
+        register_public_create_uri
         Claim.create(@project, @api_key).should be_true
       end
     end
 
-    context "with Unauthorized response" do
+    context "with '401 Unauthorized' response" do
       it "returns false" do
-        FakeWeb.register_uri( :post, @claim_uri, :status => ["401", "Unauthorized"], :string =>  "")
+        register_public_create_uri(["401", "Unauthorized"])
         Claim.create(@project, @api_key).should be_false
       end
     end
+
+    context "setting visibility" do
+      it "supports 'public'" do
+        register_public_create_uri
+        Claim.create(@project, @api_key, :public).should be_true
+        Claim.create(@project, @api_key).should be_true
+      end
+
+      it "supports 'private'" do
+        register_private_create_uri
+        Claim.create(@project, @api_key, :private).should be_true
+      end
+
+      it "raises an ArgumentError if an unsupported visibility type is provided" do
+        lambda {
+          Claim.create(@project, @api_key, :unsupported_visibility)
+        }.should raise_error(ArgumentError)
+      end
+    end
+  end
+
+  describe "destroy" do
+    context "with '200 Ok' response" do
+      it "returns true" do
+        register_destroy_uri
+        Claim.destroy(@project, @api_key).should be_true
+      end
+    end
+
+    context "with '401 Unauthorized' response" do
+      it "returns false" do
+        register_destroy_uri(["401", "Unauthorized"])
+        Claim.destroy(@project, @api_key).should be_false
+      end
+    end
   end
 end