codefumes 0.1.10 → 0.2.0

data/lib/codefumes/commit.rb

@@ -1,144 +0,0 @@
-module CodeFumes
-  # Similar to a revision control system, a Commit encompasses a set of
-  # changes to a codebase, who made them, when said changes were applied
-  # to the previous revision of codebase, et cetera.
-  #
-  # A Commit has a concept of 'standard attributes' which will always be
-  # present in a response from CodeFumes.com[http://codefumes.com], such
-  # as the +identifier+, +author+, and +commit_message+ (see the list of
-  # attributes for a comprehensive listing).  In addition to this, users
-  # are able to associate 'custom attributes' to a Commit, allowing
-  # users to link any number of attributes with a commit identifier and
-  # easily retrieve them later.
-  #
-  # One thing to note about Commit objects is that they are read-only.
-  # To associate metrics with a Commit object, a Payload object should
-  # be created and saved.  Refer to the Payload documentation for more
-  # information.
-  class Commit < CodeFumes::API
-    attr_reader :identifier, :author_name, :author_email, :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, :custom_attributes
-
-    # Instantiates a new Commit object
-    #
-    # Accepts a Hash of options, including:
-    # * identifier
-    # * author_email
-    # * author_name
-    # * committer_email
-    # * committer_name
-    # * short_message
-    # * message
-    # * committed_at
-    # * authored_at
-    # * uploaded_at
-    # * api_uri
-    # * parent_identifiers
-    # * line_additions
-    # * line_deletions
-    # * line_total
-    # * affected_file_count
-    # * custom_attributes
-    #
-    # +custom_attributes+ should be a Hash of attribute_name/value
-    # pairs associated with the commit.  All other attributes are
-    # expected to be String values, other than +committed_at+ and
-    # +authored_at+, which are expected to be DateTime objects.
-    # Technically speaking, you could pass anything you wanted into
-    # the fields, but when using with the CodeFumes API, the attribute
-    # values will be of the type String, DateTime, or Hash.
-    def initialize(options)
-      @identifier          = options["identifier"]
-      @author_email        = options["author_email"]
-      @author_name         = options["author_name"]
-      @committer_email     = options["committer_email"]
-      @committer_name      = options["committer_name"]
-      @short_message       = options["short_message"]
-      @message             = options["message"]
-      @committed_at        = options["committed_at"]
-      @authored_at         = options["authored_at"]
-      @uploaded_at         = options["uploaded_at"]
-      @api_uri             = options["api_uri"]
-      @parent_identifiers  = options["parent_identifiers"]
-      @line_additions      = options["line_additions"]
-      @line_deletions      = options["line_deletions"]
-      @line_total          = options["line_total"]
-      @affected_file_count = options["affected_file_count"]
-      @custom_attributes   = options["custom_attributes"] || {}
-      convert_custom_attributes_keys_to_symbols
-    end
-
-    # Returns the name of the author and the email associated
-    # with the commit in a string formatted as:
-    #   "Name [email_address]"
-    #   (ie: "John Doe [jdoe@example.com]")
-    def author
-      "#{author_name} [#{author_email}]"
-    end
-
-    # Returns the name of the committer and the email associated
-    # with the commit in a string formatted as:
-    #   "Name [email_address]"
-    #   (ie: "John Doe [jdoe@example.com]")
-    def committer
-      "#{committer_name} [#{committer_email}]"
-    end
-
-    # Returns the Commit object associated with the supplied identifier.
-    # Returns nil if the identifier is not found.
-    def self.find(identifier)
-      response = get("/commits/#{identifier}")
-      case response.code
-        when 200
-          return nil if response["commit"].empty?
-          new(response["commit"])
-        else
-          nil
-      end
-    end
-
-    # Returns a collection of commits associated with the specified
-    # Project public key.
-    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
-      end
-    end
-
-    # Returns the most recent commit associated with the specified
-    # Project public key.
-    def self.latest(project_public_key)
-      response = get("/projects/#{project_public_key}/commits/latest")
-      case response.code
-        when 200
-          new(response["commit"])
-        else
-          nil
-      end
-    end
-
-    # Returns the commit identifier of the most recent commit of with
-    # the specified Project public key.
-    def self.latest_identifier(project_public_key)
-      latest_commit = latest(project_public_key)
-      latest_commit.nil? ? nil : latest_commit.identifier
-    end
-
-    private
-      def convert_custom_attributes_keys_to_symbols
-        @custom_attributes = @custom_attributes.inject({}) do |results, key_and_value|
-          results.merge! key_and_value.first.to_sym => key_and_value.last
-        end
-      end
-  end
-end

data/lib/codefumes/payload.rb

@@ -1,103 +0,0 @@
-module CodeFumes
-  # Payloads are intended to simplify sending up large amounts of
-  # content at one time.  For example, when sending up the entire
-  # history of a repository, making a POST request for each commit would
-  # require a very large number of requests.  Using a Payload object
-  # allows larger amounts of content to be saved at one time,
-  # significantly reducing the number of requests made.
-  class Payload < CodeFumes::API
-    PAYLOAD_CHARACTER_LIMIT = 4000 #:nodoc:
-
-    attr_reader :project_public_key, :project_private_key, :created_at
-
-    # Accepts +:public_key+, +:private_key+, and :content keys.
-    # +:content+ should also contain a key named +:commits+, with a list
-    # of commits and associated data.  An example would be:
-    #
-    #   {:public_key => "abC3", :private_key => "some-private-key",
-    #   :content => {:commits => [{:identifier => "commit_identifer",
-    #   :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]
-      @content = options[:content]
-    end
-
-    # Saves instance to CodeFumes.com. After a successful save, the
-    # +created_at+ attribute will be populated with the timestamp the
-    # Payload was created.
-    #
-    # Returns +true+ if the Payload does not contain any content to be
-    # saved or the request was successful.
-    #
-    # Returns +false+ if the request failed.
-    def save
-      return true if empty_payload?
-      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
-      end
-    end
-
-    # +save+ requests are made with a standard POST request (not a
-    # multi-part POST), so the request size is limited by the
-    # application server.  The current configuration on CodeFumes.com
-    # limits requests to approximately 8,000 bytes (a little over).  In
-    # order to simplify dealing with these constraints, without
-    # requiring a multi-part POST request, +prepare+ can be used to
-    # "chunk" up the data into Payloads which do not exceed this limit.
-    #
-    # Returns collection of payload objects which fall into the
-    # constraints of a individual payload (ie: length of raw request,
-    # et cetera).
-    #--
-    # TODO: Clean up how the size of the request is constrained, this
-    # is pretty hackish right now (basically guesses how many
-    # characters would be added when HTTParty wraps the content in XML.
-    def self.prepare(data = {})
-      return [] if data.nil? || data.empty?
-      raw_payload = data.dup
-
-      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?
-        raise ArgumentError, "No commits key provided"
-      end
-
-      content = raw_payload[:content][:commits]
-      initial_chunks = {:on_deck => [], :prepared => []}
-
-      # TODO: Clean this up
-      chunked = content.inject(initial_chunks) do |chunks, new_commit|
-        if chunks[:on_deck].to_s.length + new_commit.to_s.length >= PAYLOAD_CHARACTER_LIMIT
-          chunks[:prepared] << chunks[:on_deck]
-          chunks[:on_deck] = [new_commit]
-        elsif new_commit == content.last
-          chunks[:on_deck] << new_commit
-          chunks[:prepared] << chunks[:on_deck]
-          chunks[:on_deck] = []
-        else
-          chunks[:on_deck] << new_commit
-        end
-        chunks
-      end
-
-      chunked[:prepared].map do |raw_content|
-        Payload.new(:public_key => public_key, :private_key => private_key, :content => {:commits => raw_content})
-      end
-    end
-
-    private
-      def empty_payload?
-        @content.empty? || @content[:commits].nil? || @content[:commits].blank?
-      end
-  end
-end

data/lib/codefumes/project.rb

@@ -1,129 +0,0 @@
-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, :build_status
-    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['project'])
-          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['project'])
-        else
-          nil
-      end
-    end
-
-    # TODO: Make this a private method
-    def reinitialize!(options = {}) #:nodoc:
-      @public_key    = options['public_key']
-      @private_key   = options['private_key']
-      @short_uri     = options['short_uri']
-      @community_uri = options['community_uri']
-      @api_uri       = options['api_uri']
-      @build_status  = options['build_status'].empty? ? nil : options['build_status']
-      @build_status && @build_status.sub!(/_build/, '')
-      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.api_key)
-    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/cf_claim_project/cli_spec.rb

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

data/spec/cf_release_project/cli_spec.rb

@@ -1,41 +0,0 @@
-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/cf_store_credentials/cli_spec.rb

@@ -1,28 +0,0 @@
-require 'spec/spec_helper'
-require 'lib/cf_store_credentials/cli'
-
-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
-    delete_config_file
-  end
-
-  before(:each) do
-    delete_config_file
-    @api_key_value = "API_KEY#{rand(100)}"
-    @stdout_io = StringIO.new
-    CfStoreCredentials::CLI.execute(@stdout_io, [@api_key_value])
-    @stdout_io.rewind
-    @stdout = @stdout_io.read
-  end
-
-  it "stores the value supplied in the config file under the key ':api_key'" do
-    ConfigFile.credentials.keys.should include(:api_key)
-    ConfigFile.credentials[:api_key].should == @api_key_value
-  end
-end