saladdays-nl/badgerkit.rb

View on GitHub
lib/badgerkit.rb

Summary

Maintainability
A
0 mins
Test Coverage
require "badgerkit/version"
require "badgerkit/client"
require "badgerkit/archive"

##
# Ruby toolkit for the Badgerkit api.
#
module Badgerkit

  ### Class methods

  class << self

    ##
    # Alias for Badgerkit::Client.new
    #
    # @return [Badgerkit::Client]
    #
    def new(options={})
      @options = options
      Badgerkit::Client.new(options)
    end

    ##
    # Delegates to {Badgerkit::Client#post}
    #
    # @return [Hashie::Mash]
    #
    def post(*args)
      new.post(*args)
    end

    ##
    # Alias for {Badgerkit::Archive.archive}.
    #
    # @param directory [String] the directory to archive.
    # @return [File]
    #
    def archive(directory)
      Badgerkit::Archive.archive(directory)
    end

  end # class << self

end # Badgerkit