codefumes 0.1.0

data/spec/codefumes/payload_spec.rb

@@ -0,0 +1,161 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+describe "Payload" do
+  after(:all) do
+    FakeWeb.allow_net_connect = false
+    FakeWeb.clean_registry
+  end
+
+  describe "save" do
+    before(:each) do
+      @project = Project.new(:public_key => "apk", :private_key => 'private_key_value')
+    end
+
+    context "with valid parameters" do
+      before(:each) do
+        FakeWeb.register_uri( :post, "http://www.codefumes.com:80/api/v1/xml/projects/apk/payloads?payload[commits]=data_to_send_up",
+                             :status => ["201", "Created"],
+                             :string =>  "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<payload>\n <created_at>Creation Date</created_at>\n  </payload>\n")
+      end
+      it "sets basic auth with the public and private key" do
+        payload = Payload.new(:public_key => @project.public_key, :private_key => @project.private_key, :content => {:commits => "data_to_send_up"})
+        Payload.should_receive(:post).with("/projects/#{@project.public_key}/payloads", :query => {:payload => {:commits => "data_to_send_up"}}, :basic_auth => {:username => @project.public_key, :password => @project.private_key}).and_return(mock("response", :code => 401))
+        payload.save
+      end
+      context "with Created response" do
+        [:created_at].each do |method_name|
+          it "sets the '#{method_name.to_s}'" do
+            payload = Payload.new(:public_key => @project.public_key, :content => {:commits => "data_to_send_up"})
+            payload.send(method_name).should == nil
+            payload.save.should == true
+            payload.send(method_name).should_not == nil
+          end
+        end
+      end
+      context "with Unauthorized response" do
+        before(:each) do
+          @project = Project.new(:public_key => "apk")
+          FakeWeb.register_uri( :post, "http://www.codefumes.com:80/api/v1/xml/projects/apk/payloads?payload[commits]=data_to_send_up",
+                              :status => ["401", "Unauthorized"])
+        end
+        [:created_at].each do |method_name|
+          it "sets the '#{method_name.to_s}'" do
+            payload = Payload.new(:public_key => @project.public_key, :content => {:commits => "data_to_send_up"})
+            payload.send(method_name).should == nil
+            payload.save.should == false
+            payload.send(method_name).should == nil
+          end
+        end
+      end
+
+    end
+
+    context "when the payload does not have any content" do
+      before(:each) do
+        @payload = Payload.new(:public_key => @project.public_key, :content => {:commits => ""})
+      end
+
+      it "returns true without attempting to save to the site" do
+        @payload.save.should == true
+      end
+
+      it "does not set the value of created_at" do
+        @payload.save
+        @payload.created_at.should == nil
+      end
+    end
+
+    context "with invalid parameters" do
+      before(:each) do
+        FakeWeb.register_uri( :post, "http://www.codefumes.com:80/api/v1/xml/projects/apk/payloads?payload[commits]=invalid_data",
+                              :status => ["422", "Unprocessable Entity"])
+      end
+
+      [:created_at].each do |method_name|
+        it "does not set a value for '#{method_name.to_s}'" do
+          payload = Payload.new(:public_key => @project.public_key, :content => {:commits => "invalid_data"})
+          payload.save.should == false
+          payload.send(method_name).should == nil
+        end
+      end
+    end
+  end
+
+  describe "calling the class method" do
+    describe "'prepare'" do
+      context "when supplying nil content" do
+        it "returns an empty array" do
+          Payload.prepare(nil).should == []
+        end
+      end
+
+      context "when supplying an empty Hash" do
+        it "returns an empty array" do
+          Payload.prepare({}).should == []
+        end
+      end
+
+      context "when supplying hash does not contain a :public_key key" do
+        it "raises an ArgumentError exception" do
+          lambda {Payload.prepare({:commits => []})}.should raise_error(ArgumentError)
+        end
+      end
+
+      context "when supplying hash does not contain a :commits key" do
+        it "raises an ArgumentError exception" do
+          lambda {Payload.prepare({:public_key => "pub_key1"})}.should raise_error(ArgumentError)
+        end
+      end
+
+      context "when supplying a hash with less than 4,000 characters" do
+        before(:each) do
+          single_commit_ex =  {:identifier => "92dd08477f0ca144ee0f12ba083760dd810760a2_000"}
+          commit_count = 4000 / single_commit_ex.to_s.length
+          commits = commit_count.times.map do |index|
+            {:identifier => "92dd08477f0ca144ee0f12ba083760dd810760a2_#{index}"}
+          end
+          @prepared = Payload.prepare({:public_key => 'fjsk', :private_key => 'something_super_secret', :content => {:commits => commits}})
+        end
+
+        it "returns an Array with a single payload element" do
+          @prepared.should be_instance_of(Array)
+          @prepared.size.should == 1
+          @prepared.first.should be_instance_of(Payload)
+        end
+        it "sets the private_key on all payloads" do
+          @prepared.each do |payload|
+            payload.project_private_key.should == 'something_super_secret'
+          end
+        end
+      end
+
+      context "when supplying a hash with approximately 15,000 characters" do
+        before(:each) do
+          single_commit_ex =  {:identifier => "92dd08477f0ca144ee0f12ba083760dd810760a2_000"}
+          commit_count = 15000 / single_commit_ex.to_s.length + 1
+          commits = commit_count.times.map do |index|
+            {:identifier => "92dd08477f0ca144ee0f12ba083760dd810760a2_#{index}"}
+          end
+          raw_payload = {:public_key => 'fjsk', :private_key => 'something_super_secret', :content => {:commits => commits}}
+          @prepared = Payload.prepare(raw_payload)
+        end
+
+        it "returns an Array with a four payload elements" do
+          @prepared.should be_instance_of(Array)
+          @prepared.size.should == 4
+          all_are_payloads = @prepared.all? {|chunk| chunk.instance_of?(Payload)}
+          all_are_payloads.should == true
+        end
+        
+        it "sets the private_key on all payloads" do
+          @prepared.each do |payload|
+            payload.project_private_key.should == 'something_super_secret'
+          end
+        end
+
+        it "the first payload contains approximately 10,000 characters"
+        it "the second payload contains approximately 5,000 characters"
+      end
+    end
+  end
+end

data/spec/codefumes/project_spec.rb

@@ -0,0 +1,274 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+def register_create_uri
+  FakeWeb.register_uri( :post, "http://www.codefumes.com:80/api/v1/xml/projects?project[name]=&project[public_key]=",
+                        :status => ["201", "Created"],
+                        :string =>  "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<project>\n  <access-secret nil=\"true\"></access-secret>\n  <created-at type=\"datetime\">2009-04-29T23:18:03Z</created-at>\n  <public-key>foofoolerue</public-key>\n <private-key>foobarbaz</private-key>\n  <updated-at type=\"datetime\">2009-04-29T23:18:03Z</updated-at>\n <short_uri>http://www.codefumes.com/p/foofoolerue</short_uri>\n <community_uri>http://www.codefumes.com/community/projects/1</community_uri>\n <api-uri>http://www.codefumes.com/api/v1/xml/projects/1.xml</api-uri>\n</project>")
+end
+
+def register_update_uri(public_key = "public_key_value", project_name = "The Project Name(tm)")
+  response = {:status => ["200", "Ok"], :string =>  "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<project>\n  <access-secret nil=\"true\"></access-secret>\n  <created-at type=\"datetime\">2009-04-29T23:18:03Z</created-at>\n  <public-key>existing_public_key</public-key>\n <private-key>private_key_value</private-key>\n  <updated-at type=\"datetime\">2009-04-29T23:18:03Z</updated-at>\n <short_uri>http://www.codefumes.com/p/#{public_key}</short_uri>\n <community_uri>http://www.codefumes.com/community/projects/#{public_key}</community_uri>\n <api-uri>http://www.codefumes.com/api/v1/xml/projects/#{public_key}.xml</api-uri>\n <name>#{project_name}</name>\n</project>\n"}
+  FakeWeb.register_uri(:put, "http://www.codefumes.com/api/v1/xml/projects/existing_public_key?project[name]=#{project_name}",
+                       response)
+end
+
+def register_show_uri(public_key = "public_key_value", project_name = "The Project Name(tm)", status_code = ["200", "Ok"])
+  FakeWeb.register_uri(:get, "http://www.codefumes.com/api/v1/xml/projects/#{public_key}",
+                       :status => status_code,
+                       :string =>  "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<project>\n  <access-secret nil=\"true\"></access-secret>\n  <created-at type=\"datetime\">2009-04-29T23:18:03Z</created-at>\n  <public-key>#{public_key}</public-key>\n <private-key>private_key_value</private-key>\n  <updated-at type=\"datetime\">2009-04-29T23:18:03Z</updated-at>\n <short_uri>http://www.codefumes.com/p/#{public_key}</short_uri>\n <community_uri>http://www.codefumes.com/community/projects/#{public_key}</community_uri>\n <api-uri>http://www.codefumes.com/api/v1/xml/projects/#{public_key}.xml</api-uri>\n <name>original_name</name>\n</project>\n")
+
+end
+
+describe "Project" do
+  before(:each) do
+  end
+  
+  after(:all) do
+    FakeWeb.allow_net_connect = false
+    FakeWeb.clean_registry
+  end
+
+  describe "save" do
+    context "with valid parameters" do
+      context "when the public key has not been taken yet (or no key provided)" do
+        before(:each) do
+          register_create_uri
+        end
+
+        [ :public_key,
+          :private_key,
+          :short_uri,
+          :community_uri,
+          :api_uri].each do |method_name|
+            it "sets the '#{method_name.to_s}'" do
+              project = CodeFumes::Project.new
+              project.send(method_name).should be_nil
+              #project.save
+              #project.send(method_name).should_not be_nil
+            end
+          end
+      end
+
+      context "when the public key has already been taken" do
+
+        context "when response is success" do
+          before(:each) do
+            @updated_name = "different_name"
+            @project = CodeFumes::Project.new(:public_key => "existing_public_key", :private_key => 'private_key_value', :name => @updated_name)
+            register_show_uri(@project.public_key, @updated_name)
+            register_update_uri(@project.public_key, @updated_name)
+            @project.stub!(:exists?).and_return(true)
+            @project.save.should be_true
+          end
+          
+          it "sets basic auth with the public and private key" do
+            Project.should_receive(:put).with("/projects/#{@project.public_key}", :query => {:project => {:name => @updated_name}}, :basic_auth => {:username => @project.public_key, :password => @project.private_key}).and_return(mock("response", :code => 401))
+            @project.save
+          end
+          
+          it "updates the value of 'name' for the project associated with the supplied public key" do
+            @project.name.should == @updated_name
+          end
+
+          [ :public_key,
+            :private_key,
+            :short_uri,
+            :community_uri,
+            :name,
+            :api_uri].each do |method_name|
+              it "sets the '#{method_name.to_s}'" do
+                @project.send(method_name).should_not be_nil
+              end
+          end
+        end
+        context "respons is Unauthorized" do
+          before(:each) do
+            @updated_name = "different_name"
+            @project = CodeFumes::Project.new(:public_key => "existing_public_key", :private_key => 'bad_key', :name => @updated_name)
+            FakeWeb.register_uri(:put, "http://www.codefumes.com/api/v1/xml/projects/existing_public_key?project[name]=#{@project.name}",
+                                 :status => ["401", "Unauthorized"])
+            @project.stub!(:exists?).and_return(true)
+          end
+          it "returns false" do
+            @project.save.should be_false
+          end      
+        end
+      end
+    end
+
+    context "with invalid parameters" do
+      before(:each) do
+          FakeWeb.register_uri( :post, "http://www.codefumes.com/api/v1/xml/projects?project[public_key]=&project[name]=",
+                                :status => ["422", "Unprocessable Entity"])
+      end
+
+      [:private_key].each do |method_name|
+        it "does not set the '#{method_name.to_s}'" do
+          project = CodeFumes::Project.new
+          project.save.should be_false
+          project.send(method_name).should be_nil
+        end
+      end
+    end
+  end
+
+  context "delete" do
+    before(:each) do
+      @project = Project.new(:public_key => 'public_key_value', :private_key => 'private_key_value')
+      FakeWeb.register_uri( :delete, "http://www.codefumes.com/api/v1/xml/projects/#{@project.public_key}",
+                            :status => ["200", "Successful"],
+                            :string =>  "")
+    end
+    it "sets basic auth with the public and private key" do
+      Project.should_receive(:delete).with("/projects/#{@project.public_key}", :basic_auth => {:username => @project.public_key, :password => @project.private_key}).and_return(mock("response", :code => 401))
+      @project.delete
+    end
+    context "with Sucessful response" do
+      it "returns true" do
+        @project.delete.should be_true
+      end
+    end
+    context "with Unauthorized response" do
+      before(:each) do 
+        @project = Project.new(:public_key => 'public_key_value')
+        FakeWeb.register_uri( :delete, "http://www.codefumes.com/api/v1/xml/projects/#{@project.public_key}",
+                              :status => ["401", "Unauthorized"],
+                              :string =>  "")
+      end
+      it "returns false when invalid Unauthorized response is received" do
+        @project.delete.should be_false
+      end
+    end
+  end
+
+  describe "exists?" do
+    before(:each) do
+      @public_key = "some_public_key"
+    end
+
+    context "when the specified public_key has been reserved already" do
+      before(:each) do
+        FakeWeb.register_uri(:get, "http://www.codefumes.com/api/v1/xml/projects/#{@public_key}",
+                             :status => ["200", "Ok"],
+                             :string =>  "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<project>\n  <access-secret nil=\"true\"></access-secret>\n  <created-at type=\"datetime\">2009-04-29T23:18:03Z</created-at>\n  <public-key>foofoolerue</public-key>\n <private-key>foobarbaz</private-key>\n  <updated-at type=\"datetime\">2009-04-29T23:18:03Z</updated-at>\n <short_uri>http://www.codefumes.com/p/foofoolerue</short_uri>\n <community_uri>http://www.codefumes.com/community/projects/1</community_uri>\n <api-uri>http://www.codefumes.com/api/v1/xml/projects/1.xml</api-uri>\n <name>original_name</name>\n")
+      end
+
+      it "returns true" do
+        Project.new(:public_key => @public_key).exists?.should be_true
+      end
+    end
+
+    context "when the public_key is not set" do
+      it "returns false when the public key is nil" do
+        Project.new.exists?.should be_false
+      end
+
+      it "returns false when the public key is an empty string" do
+        Project.new(:public_key => "").exists?.should be_false
+      end
+    end
+
+    context "when the specified public_key is available" do
+      before(:each) do
+        FakeWeb.register_uri(:get, "http://www.codefumes.com/api/v1/xml/projects/#{@public_key}",
+                             :status => ["404", "Not Found"],
+                             :string =>  "")
+
+      end
+
+      it "returns false" do
+        Project.new(:public_key => @public_key).exists?.should be_false
+      end
+    end
+  end
+
+  describe "to_config" do
+    before(:each) do
+      register_create_uri
+      FakeWeb.register_uri( :post, "http://www.codefumes.com:80/api/v1/xml/projects?project[name]=&project[public_key]=",
+                            :status => ["201", "Created"],
+                            :string =>  "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<project>\n  <access-secret nil=\"true\"></access-secret>\n  <created-at type=\"datetime\">2009-04-29T23:18:03Z</created-at>\n  <public-key>foofoolerue</public-key>\n <private-key>foobarbaz</private-key>\n  <updated-at type=\"datetime\">2009-04-29T23:18:03Z</updated-at>\n <short_uri>http://www.codefumes.com/p/foofoolerue</short_uri>\n <community_uri>http://www.codefumes.com/community/projects/1</community_uri>\n <api-uri>http://www.codefumes.com/api/v1/xml/projects/1.xml</api-uri>\n</project>")
+      @project = Project.new
+      @project.save
+    end
+
+    it "returns an object keyed by the project's public_key as a symbol" do
+      @project.to_config.should include(@project.public_key.to_sym)
+    end
+
+    context "the content under the project's public_key element" do
+      [:private_key, :api_uri, :short_uri].each do |project_attribute|
+        it "includes a key-value pair of ':#{project_attribute.to_s} => [project's #{project_attribute.to_s}]'" do
+          value = @project.send(project_attribute)
+          @project.to_config[@project.public_key.to_sym].should include(project_attribute => value)
+        end
+      end
+    end
+    
+    it "doesn't include the private_key in the hash if it is nil" do
+      public_key = "key_to_happiness"
+      Project.new(:public_key => public_key).to_config[public_key.to_sym].should_not have_key(:private_key)
+    end
+  end
+
+  describe "protected attributes" do
+    [:api_uri, :community_uri, :short_uri].each do |attribute_name|
+      it "values passed in during initiazation for '#{attribute_name.to_s}' are silently ignored" do
+        p = Project.new(attribute_name => Time.now.to_s)
+        p.send(attribute_name).should be_nil
+      end
+
+      it "calling '#{attribute_name.to_s}= [value]' is not supported" do
+        p = Project.new
+        lambda {p.send("#{attribute_name}=", "my_value")}.should raise_error
+      end
+    end
+  end
+
+  describe "accessible attributes" do
+    before(:each) do
+      @value = 'my_value'
+    end
+
+    [:public_key, :name].each do |attribute_name|
+      it "values for '#{attribute_name.to_s}' are allowed to be modified by the client" do
+        p = Project.new(attribute_name => @value )
+        p.send(attribute_name).should ==  @value
+      end
+    end
+  end
+
+  describe "calling the class method" do
+    describe "'find'" do
+      context "and specifying a public_key which is already associated to a project on the site" do
+        before(:each) do
+          @public_key = "an_existing_public_key"
+          register_show_uri(@public_key)
+        end
+
+        it "returns an initialized instance of the Project class" do
+          expected_config = {
+                              :an_existing_public_key => 
+                                {
+                                  :private_key=>"private_key_value",
+                                  :api_uri=>"http://www.codefumes.com/api/v1/xml/projects/an_existing_public_key.xml",
+                                  :short_uri=>"http://www.codefumes.com/p/an_existing_public_key"
+                                }
+                            }
+          Project.find(@public_key).to_config.should == expected_config
+        end
+      end
+
+      context "and specifying a public_key which is not associated to any project on the site yet" do
+        before(:each) do
+          @public_key = "non_existant_public_key"
+          register_show_uri(@public_key, "Some Name", ["404", "Not Found"])
+        end
+
+        it "returns nil" do
+          Project.find(@public_key).should == nil
+        end
+      end
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
--format specdoc
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'rubygems'
+
+begin
+  require 'spec/autorun'
+rescue LoadError
+  gem 'rspec'
+  require 'spec'
+end
+
+gem 'ruby-debug'
+require 'ruby-debug'
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'codefumes'
+require 'fakeweb'
+
+include CodeFumes
+
+ENV['CODEFUMES_CONFIG_FILE'] = File.expand_path(File.dirname(__FILE__) + '/sample_codefumes_config.tmp')