artrest 0.0.1

data/lib/artrest/resources.rb

@@ -0,0 +1,54 @@
+
+module ArtRest
+
+    # An ArtRest::Resource that doubles as a collection of resources, each such
+    # resource being an ArtRest::Resource instance. This is an abstract base
+    # class that is *not* meant to be instantiated.
+    #
+    # === Example
+    #
+    # An ArtRest::Builds instance is a collection of ArtRest::Build instances.
+    #
+    class Resources < ArtRest::Resource
+        include Enumerable
+
+        class << self
+
+            # An ArtRest::Resources instance is represented by a parsed
+            # JSON hash. In order to be able to iterate over the contained
+            # ArtRest::Resource instances we need a means of converting
+            # that JSON hash into an array of ArtRest::Resource instances
+            # of an appropriate subtype. We choose a +block+ taking the JSON hash
+            # and the +options+ hash and returning an array of ArtRest::Resource
+            # instances.
+            #
+            # This method assigns that block to this class.
+            #
+            # * *Args*    :
+            #   - +block+ -> A +block+ taking a parsed JSON hash and an +options+
+            #     hash and returning an array of appropriate ArtRest::Resource
+            #     instances
+            #
+            def resources_creator=(block)
+                self.singleton_class.class_eval do
+                    define_method(:resources_creator) do
+                        block
+                    end
+                end
+            end
+        end
+
+        public
+        
+        # Iterate over all ArtRest::Resource instances contained in this
+        # instance. Yield each such instance to the supplied +block+.
+        #
+        # * *Args*    :
+        #   - +block+ -> The +block+ to yield each contained ArtRest::Resource
+        #     instance to
+        #
+        def each &block # :yields: content, options
+            self.class.resources_creator.call(content, options).each &block 
+        end
+    end
+end

data/lib/artrest/system.rb

@@ -0,0 +1,74 @@
+module ArtRest
+
+    # Represents the {Artifactory}[http://www.jfrog.com/home/v_artifactory_opensource_overview]
+    # {System}[http://wiki.jfrog.org/confluence/display/RTF/Artifactory's+REST+API#Artifactory'sRESTAPI-SystemInfo]
+    # resource. Its content is a formatted multiline string listing
+    #
+    # * Java version used
+    # * Memory consumption
+    # * ...
+    #
+    # === Example
+    #
+    #  sysInfo = ArtRest::System.new('http://localhost:8081/artifactory/api/system', { ... })
+    #
+    class System < ArtRest::Resource
+
+        class << self
+            public
+
+            # Shortcut method to retrieve *the* ArtRest::System resource.
+            #
+            # * *Args*    :
+            #   - +base_url+ -> Our Artifactory server's base URL
+            #   - +options+ -> A Hash containing username and password
+            # * *Returns* :
+            #   - *The* ArtRest::System resource
+            #
+            def get(base_url, options)
+                System.new("#{base_url}/api/system", options)
+            end
+
+            def matches_path(path, options) # :nodoc:
+                path =~ %r|^/api/system/?$|
+            end
+        end
+
+        self.mime_type = MIME::Types['text/plain']
+
+        # Get this system resource's {ping}[http://wiki.jfrog.org/confluence/display/RTF/Artifactory's+REST+API#Artifactory'sRESTAPI-SystemHealthPing]
+        # subresource, i.e. issue a ping request to test whether the
+        # Artifactory server this resource represents is still in a healthy
+        # state.
+        #
+        # Returns the plain RestClient::Response object returned by the server.
+        # In case the server is functioning properly this response will carry
+        # an HTTP 200 return code, and its body will contain the string
+        # "OK". Otherwise, the response returned will carry a return code from
+        # the 5xx family, and its body will be a text describing the problem.
+        #
+        # * *Returns* :
+        #   - The plain RestClient::Response object as returned by the server
+        #
+        def ping
+            # Directly accessing the ping resource from this resource contravenes
+            # our design. For consistency reasons, we ought to explicitly model
+            # this ping resource as e.g. an instance of ArtRest::SystemPing.
+            # However, here we try to strike a balance between perfectionism
+            # and pragmatism and lean towards the latter.
+            RestClient::Resource.new("#{base_url}/api/system/ping", user, password).get
+        end
+
+        # Get this system resource's {general configuration}[http://wiki.jfrog.org/confluence/display/RTF/Artifactory's+REST+API#Artifactory'sRESTAPI-GeneralConfiguration]
+        # subresource, i.e. the resource representing Artifactory's
+        # +artifactory.config.xml+ file.
+        #
+        # * *Returns* :
+        #   - Artifactory's general configuration, represented as an instance of
+        #     ArtRest::System::GeneralConfiguration
+        #
+        def configuration
+            ArtRest::System::GeneralConfiguration.new("#{base_url}/api/system/configuration", options, block)
+        end
+    end
+end

data/lib/artrest/system_general_configuration.rb

@@ -0,0 +1,45 @@
+module ArtRest
+
+    class System
+
+        # Represents Artifactory's {General Configuration}[http://wiki.jfrog.org/confluence/display/RTF/Artifactory's+REST+API#Artifactory'sRESTAPI-GeneralConfiguration]
+        # resource. Essentially, this is Artifactory's +artifactory.config.xml+
+        # file.
+        #
+        # This class serves to
+        #
+        # * retrieve Artifactory's general configuration as an in-memory
+        #   XML data structure,
+        # * download Artifactory's general configuration to a folder/file, and
+        # * update (post) Artifactory's general configuration.
+        #
+        class GeneralConfiguration < ArtRest::Resource
+
+            class << self
+                public
+
+                # Shortcut method to retrieve *the*
+                # ArtRest::System::GeneralConfiguration resource.
+                #
+                # * *Args*    :
+                #   - +base_url+ -> Our Artifactory server's base URL
+                #   - +options+ -> A Hash containing username and password
+                # * *Returns* :
+                #   - *The* ArtRest::System::GeneralConfiguration resource
+                #
+                def get(base_url, options)
+                    System::GeneralConfiguration.new("#{base_url}/api/system/configuration", options)
+                end
+
+                def matches_path(path, options) # :nodoc:
+                    path =~ %r|^/api/system/configuration/?$|
+                end
+            end
+
+            self.mime_type = MIME::Types['application/xml']
+
+            # Make update! available on this class as it supports updates
+            public :update!, :update_with!
+        end
+    end
+end

data/lib/artrest/version.rb

@@ -0,0 +1,3 @@
+module ArtRest
+  VERSION = "0.0.1"
+end

data/spec/artrest/build_spec.rb

@@ -0,0 +1,62 @@
+require File.expand_path("../../spec_helper", __FILE__)
+
+describe ArtRest::Build do
+
+    before(:each) do
+        @build_name = 'vnet.sms.common.shell'
+        @build_path = "api/build/#{@build_name}"
+        @build_url  = "#{ARTIFACTORY_URL}/#{@build_path}"
+        @artbuild   = ArtRest::Build.new @build_url, OPTIONS 
+        register_stub_request('./build/build_response_correct.txt', "#{@build_path}")
+    end
+
+    describe "#each" do
+        it "should iterate over all build numbers" do
+            expected_number_of_build_numbers = 63
+            actual_number_of_build_numbers = 0
+            @artbuild.each do |build_number|
+                actual_number_of_build_numbers += 1 
+            end
+            actual_number_of_build_numbers.should equal expected_number_of_build_numbers
+        end
+
+        it "should return each build number as an instance of ArtRest::BuildNumber" do
+            @artbuild.each do |build_number|
+                build_number.should_not be_nil
+                build_number.should be_an_instance_of ArtRest::Buildnumber
+            end
+        end
+    end
+
+    describe "[all resource attributes]" do
+
+        before(:each) do
+            @resource_attributes = [:uri, :buildsNumbers]
+        end
+
+        context "when no block given" do
+            it "should return a non-nil value" do
+                @resource_attributes.each do |attr|
+                    value = @artbuild.send(attr)
+                    value.should_not be_nil
+                end
+            end
+        end
+
+        context "when block given" do
+            it "should yield a non-nil value to that block" do
+                @resource_attributes.each do |attr|
+                    @artbuild.send(attr) do |value|
+                        value.should_not be_nil
+                    end
+                end
+            end
+        end
+    end
+
+    describe "#url" do
+        it "should expose the url property" do
+            @artbuild.url.should eq @build_url
+        end
+    end
+end

data/spec/artrest/buildnumber_spec.rb

@@ -0,0 +1,45 @@
+require File.expand_path("../../spec_helper", __FILE__)
+
+describe ArtRest::Buildnumber do
+
+    before(:each) do
+        @build_name       = 'vnet.sms.common.shell'
+        @build_no         = 25
+        @buildnumber_path = "api/build/#{@build_name}/#{@build_no}"
+        @buildnumber_url  = "#{ARTIFACTORY_URL}/#{@buildnumber_path}"
+        @artbuildnumber   = ArtRest::Buildnumber.new(@buildnumber_url, OPTIONS) 
+        register_stub_request('./buildnumber/buildnumber_25_response.txt', "#{@buildnumber_path}")
+    end
+
+    describe "#url" do
+        it "should expose the url property" do
+            @artbuildnumber.url.should eq @buildnumber_url
+        end
+    end
+
+    describe "[all resource attributes]" do
+
+        before(:each) do
+            @resource_attributes = [:uri, :buildInfo]
+        end
+
+        context "when no block given" do
+            it "should return a non-nil value" do
+                @resource_attributes.each do |attr|
+                    value = @artbuildnumber.send(attr)
+                    value.should_not be_nil
+                end
+            end
+        end
+
+        context "when block given" do
+            it "should yield a non-nil value to that block" do
+                @resource_attributes.each do |attr|
+                    @artbuildnumber.send(attr) do |value|
+                        value.should_not be_nil
+                    end
+                end
+            end
+        end
+    end
+end

data/spec/artrest/builds_spec.rb

@@ -0,0 +1,69 @@
+require File.expand_path("../../spec_helper", __FILE__)
+
+describe ArtRest::Builds do
+
+    before(:each) do
+        @builds_path = "api/build"
+        @builds_url  = "#{ARTIFACTORY_URL}/#{@builds_path}"
+        @artbuilds   = ArtRest::Builds.new @builds_url, OPTIONS
+        register_stub_request('./builds/build_api_response_correct.txt', @builds_path)
+    end
+
+    describe "::get" do
+        it "should expose a shortcut method to retrieve all builds" do
+            all_builds = ArtRest::Builds.get ARTIFACTORY_URL, OPTIONS
+            all_builds.should_not be_nil
+            all_builds.should be_an_instance_of ArtRest::Builds
+        end
+    end
+
+    describe "#each" do
+        it "should iterate over all builds" do
+            expected_number_of_builds = 64
+            actual_number_of_builds = 0
+            @artbuilds.each do |build|
+                actual_number_of_builds += 1 
+            end
+            actual_number_of_builds.should equal expected_number_of_builds
+        end
+
+        it "should return all builds as an instance of ArtRest::Build" do
+            @artbuilds.each do |build|
+                build.should be_an_instance_of ArtRest::Build 
+            end
+        end
+    end
+
+    describe "[all resource attributes]" do
+
+        before(:each) do
+            @resource_attributes = [:uri, :builds]
+        end
+
+        context "when no block given" do
+            it "should return a non-nil value" do
+                @resource_attributes.each do |attr|
+                    value = @artbuilds.send(attr)
+                    value.should_not be_nil
+                end
+            end
+        end
+
+        context "when block given" do
+            it "should yield a non-nil value to that block" do
+                @resource_attributes.each do |attr|
+                    @artbuilds.send(attr) do |value|
+                        value.should_not be_nil
+                    end
+                end
+            end
+        end
+    end
+
+    describe "#url" do
+        it "should expose the url property" do
+            @artbuilds.url.should eq @builds_url
+        end
+    end
+
+end

data/spec/artrest/folder_spec.rb

@@ -0,0 +1,88 @@
+require File.expand_path("../../spec_helper", __FILE__)
+
+describe ArtRest::Folder do
+
+    before(:each) do
+        @repo_name   = 'ext-snapshot-local'
+        @folder_path = '/vnet/sms/infrastructure/rpm-elasticsearch'
+        @folder_url  = "#{ARTIFACTORY_URL}/api/storage/#{@repo_name}#{@folder_path}"
+        @artfolder   = ArtRest::Folder.new @folder_url, OPTIONS
+        register_stub_request('./folder/top_folder_response.txt', "api/storage/#{@repo_name}#{@folder_path}")
+        register_stub_request('./folder/sub_folder_response.txt', "api/storage/#{@repo_name}#{@folder_path}/1.0.0-SNAPSHOT")
+        register_stub_request('./folder/pom_file_response_1.txt', "api/storage/#{@repo_name}#{@folder_path}/1.0.0-SNAPSHOT/rpm-elasticsearch-1.0.0-20120411.155423-1.pom")
+    end
+
+    describe "#each" do
+        it "should iterate over all child folders" do
+            expected_number_of_folders = 1
+            actual_number_of_folders = 0
+            @artfolder.each do |folder|
+                actual_number_of_folders += 1 
+            end
+            actual_number_of_folders.should equal expected_number_of_folders
+        end
+
+        it "should return each child folder as an ArtRest::Folder instance" do
+            @artfolder.each do |folder|
+                folder.should be_an_instance_of ArtRest::Folder
+            end
+        end
+    end
+
+    describe "[all resource attributes]" do
+
+        before(:each) do
+            @resource_attributes = [:path, 
+                                    :lastUpdated,
+                                    :repo,
+                                    :uri,
+                                    :modifiedBy,
+                                    :created,
+                                    :createdBy,
+                                    :lastModified,
+                                    :metadataUri]
+        end
+
+        context "when no block given" do
+            it "should return a non-nil value" do
+                @resource_attributes.each do |attr|
+                    value = @artfolder.send(attr)
+                    value.should_not be_nil
+                end
+            end
+        end
+
+        context "when block given" do
+            it "should yield a non-nil value to that block" do
+                @resource_attributes.each do |attr|
+                    @artfolder.send(attr) do |value|
+                        value.should_not be_nil
+                    end
+                end
+            end
+        end
+    end
+
+    describe "#[]" do
+        it "should return a subfolder as an instance of ArtRest::Folder" do
+            folder = @artfolder['1.0.0-SNAPSHOT']
+            folder.should_not be_nil
+            folder.should be_an_instance_of ArtRest::Folder
+        end
+
+        it "should return a contained artifact as an instance of ArtRest::Artifact" do
+            artifact = @artfolder['1.0.0-SNAPSHOT/rpm-elasticsearch-1.0.0-20120411.155423-1.pom']
+            artifact.should_not be_nil
+            artifact.should be_an_instance_of ArtRest::Artifact
+        end
+    end
+
+    describe "#traverse" do
+        it "should traverse the whole subtree rooted at itself" do
+            @artfolder.traverse do |child|
+                child.should be_a_kind_of ArtRest::DirEntry
+            end
+        end
+    end
+
+end