artifactory 0.0.1 → 1.0.0

data/lib/artifactory/resources/user.rb

@@ -0,0 +1,57 @@
+module Artifactory
+  class Resource::User < Resource::Base
+    class << self
+      #
+      #
+      #
+      def all(options = {})
+        client = extract_client!(options)
+        client.get('/api/security/users').map do |hash|
+          from_url(hash['uri'], client: client)
+        end
+      end
+
+      #
+      #
+      #
+      def find(options = {})
+        client   = extract_client!(options)
+        username = URI.escape(options[:username])
+        response = client.get("/api/security/users/#{username}")
+        from_hash(response, client: client)
+      rescue Error::NotFound
+        nil
+      end
+
+      #
+      #
+      #
+      def from_url(url, options = {})
+        client = extract_client!(options)
+        from_hash(client.get(url), client: client)
+      end
+
+      #
+      #
+      #
+      def from_hash(hash, options = {})
+        client = extract_client!(options)
+
+        new(client).tap do |instance|
+          instance.admin      = hash['admin']
+          instance.email      = hash['email']
+          instance.last_login = Time.parse(hash['lastLoggedIn']) rescue nil
+          instance.name       = hash['name']
+          instance.realm      = hash['realm']
+        end
+      end
+    end
+
+    attribute :admin, false
+    attribute :email
+    attribute :last_login
+    attribute :name, ->{ raise 'Name missing!' }
+    attribute :password
+    attribute :realm
+  end
+end

data/lib/artifactory/util.rb

@@ -0,0 +1,93 @@
+module Artifactory
+  module Util
+    extend self
+
+    #
+    # Covert the given CaMelCaSeD string to under_score. Graciously borrowed
+    # from http://stackoverflow.com/questions/1509915.
+    #
+    # @param [String] string
+    #   the string to use for transformation
+    #
+    # @return [String]
+    #
+    def underscore(string)
+      string
+        .to_s
+        .gsub(/::/, '/')
+        .gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+        .gsub(/([a-z\d])([A-Z])/,'\1_\2')
+        .tr('-', '_')
+        .downcase
+    end
+
+    #
+    # Convert an underscored string to it's camelcase equivalent constant.
+    #
+    # @param [String] string
+    #   the string to convert
+    #
+    # @return [String]
+    #
+    def camelize(string)
+      string
+        .to_s
+        .split('_')
+        .map { |e| e.capitalize }
+        .join
+    end
+
+    #
+    # Truncate the given string to a certain number of characters.
+    #
+    # @param [String] string
+    #   the string to truncate
+    # @param [Hash] options
+    #   the list of options (such as +length+)
+    #
+    def truncate(string, options = {})
+      length = options[:length] || 30
+
+      if string.length > length
+        string[0..length-3] + '...'
+      else
+        string
+      end
+    end
+
+    #
+    # Rename a list of keys to the given map.
+    #
+    # @example Rename the given keys
+    #   rename_keys(hash, foo: :bar, zip: :zap)
+    #
+    # @param [Hash] options
+    #   the options to map
+    # @param [Hash] map
+    #   the map of keys to map
+    #
+    # @return [Hash]
+    #
+    def rename_keys(options, map = {})
+      Hash[options.map { |k, v| [map[k] || k, v] }]
+    end
+
+    #
+    # Slice the given list of options with the given keys.
+    #
+    # @param [Hash] options
+    #   the list of options to slice
+    # @param [Array<Object>] keys
+    #   the keys to slice
+    #
+    # @return [Hash]
+    #   the sliced hash
+    #
+    def slice(options, *keys)
+      keys.inject({}) do |hash, key|
+        hash[key] = options[key] if options[key]
+        hash
+      end
+    end
+  end
+end

data/lib/artifactory/version.rb

@@ -1,3 +1,3 @@
 module Artifactory
-  VERSION = "0.0.1"
+  VERSION = '1.0.0'
 end

data/locales/en.yml

@@ -0,0 +1,27 @@
+en:
+  artifactory:
+    errors:
+      bad_request: >
+        The Artifactory server declined to server the URL `%{url}'. Here is
+        more information from the server:
+
+          %{body}
+      connection_error: >
+        The Artifactory server at `%{url}' threw an unexpected error. We do not
+        have any additional information to offer, sorry. Here is what the server
+        said:
+
+          %{body}
+      forbidden: >
+        You are not permitted to access `%{url}'. The Artifactory server
+        responded with a 403 Forbidden error.
+      method_not_allowed: >
+        That HTTP method is not allowed!
+      not_found: >
+        The requested URL `%{url}' does not exist on the Artifactory server.
+        Please confirm you have spelled everything correctly.
+      unauthorized: >
+        You are not authorized to access `%{url}'. The Artifactory server
+        responded with a 401 Unauthorzed. The requested endpoint requires
+        authentication - try adding basic authentication to your request and
+        try again.

data/spec/integration/resources/artifact_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+module Artifactory
+  describe Resource::Artifact, :integration do
+    shared_examples 'an artifact search endpoint' do |name, options = {}|
+      it "finds artifacts by #{name}" do
+        response = described_class.send(name, options)
+        expect(response).to be_a(Array)
+        expect(response.size).to eq(2)
+
+        artifact_1 = response[0]
+        expect(artifact_1).to be_a(described_class)
+        expect(artifact_1.repo).to eq('libs-release-local')
+
+        artifact_2 = response[1]
+        expect(artifact_2).to be_a(described_class)
+        expect(artifact_2.repo).to eq('ext-release-local')
+      end
+
+      it "finds artifacts by repo" do
+        response = described_class.send(name, options.merge(repos: 'libs-release-local'))
+        expect(response).to be_a(Array)
+        expect(response.size).to eq(1)
+
+        artifact = response.first
+        expect(artifact).to be_a(described_class)
+        expect(artifact.repo).to eq('libs-release-local')
+      end
+    end
+
+    describe '.search' do
+      it_behaves_like 'an artifact search endpoint', :search, name: 'artifact.deb'
+    end
+
+    describe '.gavc_search' do
+      it_behaves_like 'an artifact search endpoint', :gavc_search, {
+        group:      'org.acme',
+        name:       'artifact.deb',
+        version:    '1.0',
+        classifier: 'sources',
+      }
+    end
+
+    describe '.property_search' do
+      it_behaves_like 'an artifact search endpoint', :property_search, {
+        branch:    'master',
+        committer: 'Seth Vargo',
+      }
+    end
+
+    describe '.checksum_search' do
+      it_behaves_like 'an artifact search endpoint', :checksum_search, md5: 'abcd1234'
+    end
+
+    describe '.versions' do
+      it 'returns an array of versions' do
+        response = described_class.versions
+        expect(response).to be_a(Array)
+        expect(response.size).to eq(3)
+
+        expect(response[0]['version']).to eq('1.2')
+      end
+    end
+
+    describe '.latest_version' do
+      it 'finds the latest version of the artifact' do
+        response = described_class.latest_version
+        expect(response).to be_a(String)
+        expect(response).to eq('1.0-201203131455-2')
+      end
+    end
+  end
+end

data/spec/integration/resources/build_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+module Artifactory
+  describe Resource::Build, :integration do
+    describe '.all' do
+      it 'returns an array of build objects' do
+        pending 'Need more information about what the Build API returns'
+      end
+    end
+  end
+end

data/spec/integration/resources/repository_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+module Artifactory
+  describe Resource::Repository, :integration do
+    describe '.all' do
+      it 'returns an array of repository objects' do
+        results = described_class.all
+        expect(results).to be_a(Array)
+        expect(results.first).to be_a(described_class)
+      end
+    end
+  end
+end

data/spec/integration/resources/system_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+module Artifactory
+  describe Resource::System, :integration do
+    describe '.info' do
+      it 'gets the system information' do
+        expect(described_class.info).to eq('This is some serious system info right here')
+      end
+    end
+
+    describe '.ping' do
+      it 'returns ok' do
+        expect(described_class.ping).to be_true
+      end
+    end
+
+    describe '.configuration' do
+      it 'returns the system configuration' do
+        expect(described_class.configuration).to be_a(REXML::Document)
+      end
+    end
+
+    describe '.update_configuration' do
+      let(:tempfile) { Tempfile.new(['config', 'xml']) }
+      let(:content) do
+        """.strip.gsub(/^ {8}/, '')
+        <?xml version='1.0' encoding='UTF-8' standalone='yes'?>
+        <newConfig>true</newConfig>
+        """
+      end
+
+      after do
+        tempfile.close
+        tempfile.unlink
+      end
+
+      it 'posts the new configuration to the server' do
+        tempfile.write(content)
+        tempfile.rewind
+
+        expect(described_class.update_configuration(tempfile)).to eq(content)
+      end
+    end
+
+    describe '.version' do
+      it 'gets the version information' do
+        expect(described_class.version).to eq({
+          'version' => '3.1.0',
+          'revision' => '30062',
+          'addons' => [
+            'ldap',
+            'license',
+            'yum'
+          ]
+        })
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,40 @@
+require 'bundler/setup'
+require 'rspec'
+require 'webmock/rspec'
+
+# Require our main library
+require 'artifactory'
+
+# Require helpers
+require_relative 'support/api_server'
+
+RSpec.configure do |config|
+  # Custom helper modules and extensions
+
+  # Prohibit using the should syntax
+  config.expect_with :rspec do |spec|
+    spec.syntax = :expect
+  end
+
+  # Allow tests to isolate a specific test using +focus: true+. If nothing
+  # is focused, then all tests are executed.
+  config.filter_run(focus: true)
+  config.run_all_when_everything_filtered = true
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+
+  # Stuff to do on each run
+  config.before(:each) { Artifactory.reset! }
+  config.after(:each)  { Artifactory.reset! }
+
+  #
+  config.before(:each, :integration) do
+    Artifactory.endpoint = 'http://localhost:8889'
+    stub_request(:any, /#{Artifactory.endpoint}/).to_rack(Artifactory::APIServer)
+  end
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/support/api_server.rb

@@ -0,0 +1,41 @@
+require 'sinatra/base'
+
+module Artifactory
+  #
+  # An in-memory, fully-API compliant Artifactory server. The data is all
+  # fake, but it is based off of real responses from the Artifactory server.
+  #
+  class APIServer < Sinatra::Base
+    require_relative 'api_server/artifact_endpoints'
+    require_relative 'api_server/build_endpoints'
+    require_relative 'api_server/repository_endpoints'
+    require_relative 'api_server/status_endpoints'
+    require_relative 'api_server/system_endpoints'
+
+    register APIServer::ArtifactEndpoints
+    register APIServer::BuildEndpoints
+    register APIServer::RepositoryEndpoints
+    register APIServer::StatusEndpoints
+    register APIServer::SystemEndpoints
+
+    private
+
+    #
+    # This server's URL, returned as a {Pathname} for easy joining.
+    #
+    # @example Construct a server url
+    #   server_url.join('libs-release-local', 'artifact.deb')
+    #
+    # @return [Pathname]
+    #
+    def server_url
+      @server_url ||= begin
+        scheme  = request.env['rack.url_scheme']
+        address = request.env['SERVER_NAME']
+        port    = request.env['SERVER_PORT']
+
+        Pathname.new("#{scheme}://#{address}:#{port}")
+      end
+    end
+  end
+end

data/spec/support/api_server/artifact_endpoints.rb

@@ -0,0 +1,122 @@
+module Artifactory
+  module APIServer::ArtifactEndpoints
+    def self.registered(app)
+      app.get('/api/search/artifact') do
+        content_type 'application/vnd.org.jfrog.artifactory.search.ArtifactSearchResult+json'
+        artifacts_for_conditions do
+          params['name'] == 'artifact.deb'
+        end
+      end
+
+      app.get('/api/search/gavc') do
+        content_type 'application/vnd.org.jfrog.artifactory.search.GavcSearchResult+json'
+        artifacts_for_conditions do
+          params['g'] == 'org.acme' &&
+          params['a'] == 'artifact.deb' &&
+          params['v'] == '1.0' &&
+          params['c'] == 'sources'
+        end
+      end
+
+      app.get('/api/search/prop') do
+        content_type 'application/vnd.org.jfrog.artifactory.search.MetadataSearchResult+json'
+        artifacts_for_conditions do
+          params['branch'] == 'master' && params['committer'] == 'Seth Vargo'
+        end
+      end
+
+      app.get('/api/search/checksum') do
+        content_type 'application/vnd.org.jfrog.artifactory.search.ChecksumSearchResult+json'
+        artifacts_for_conditions do
+          params['md5'] == 'abcd1234'
+        end
+      end
+
+      app.get('/api/search/versions') do
+        content_type 'application/vnd.org.jfrog.artifactory.search.ArtifactVersionsResult+json'
+        JSON.fast_generate(
+          'results' => [
+            { 'version' => '1.2',          'integration' => false },
+            { 'version' => '1.0-SNAPSHOT', 'integration' => true  },
+            { 'version' => '1.0',          'integration' => false },
+          ]
+        )
+      end
+
+      app.get('/api/search/latestVersion') do
+        '1.0-201203131455-2'
+      end
+
+      app.get('/api/storage/libs-release-local/org/acme/artifact.deb') do
+        content_type 'application/vnd.org.jfrog.artifactory.storage.FileInfo+json'
+        JSON.fast_generate(
+          'uri'          => server_url.join('/api/storage/libs-release-local/org/acme/artifact.deb'),
+          'downloadUri'  => server_url.join('/artifactory/libs-release-local/org/acme/artifact.deb'),
+          'repo'         => 'libs-release-local',
+          'path'         => '/org/acme/artifact.deb',
+          'created'      => Time.parse('1991-07-23 12:07am'),
+          'createdBy'    => 'schisamo',
+          'lastModified' => Time.parse('2013-12-24 11:50pm'),
+          'modifiedBy'   => 'sethvargo',
+          'lastUpdated'  => Time.parse('2014-01-01 1:00pm'),
+          'size'         => '1024',
+          'mimeType'     => 'application/tgz',
+          'checksums'    => {
+            'md5' => 'MD5123',
+            'sha' => 'SHA456'
+          },
+          'originalChecksums' => {
+            'md5' => 'MD5123',
+            'sha' => 'SHA456'
+          }
+        )
+      end
+
+      app.get('/api/storage/ext-release-local/org/acme/artifact.deb') do
+        content_type 'application/vnd.org.jfrog.artifactory.storage.FileInfo+json'
+        JSON.fast_generate(
+          'uri'          => server_url.join('/api/storage/ext-release-local/org/acme/artifact.deb'),
+          'downloadUri'  => server_url.join('/artifactory/ext-release-local/org/acme/artifact.deb'),
+          'repo'         => 'ext-release-local',
+          'path'         => '/org/acme/artifact.deb',
+          'created'      => Time.parse('1995-04-11 11:05am'),
+          'createdBy'    => 'yzl',
+          'lastModified' => Time.parse('2013-11-10 10:10pm'),
+          'modifiedBy'   => 'schisamo',
+          'lastUpdated'  => Time.parse('2014-02-02 2:00pm'),
+          'size'         => '1024',
+          'mimeType'     => 'application/tgz',
+          'checksums'    => {
+            'md5' => 'MD5789',
+            'sha' => 'SHA101'
+          },
+          'originalChecksums' => {
+            'md5' => 'MD5789',
+            'sha' => 'SHA101'
+          }
+        )
+      end
+
+      app.class_eval do
+        def artifacts_for_conditions(&block)
+          if block.call
+            if params['repos'] == 'libs-release-local'
+              JSON.fast_generate(
+                'results' => [
+                  { 'uri' => server_url.join('/api/storage/libs-release-local/org/acme/artifact.deb') },
+                ]
+              )
+            else
+              JSON.fast_generate(
+                'results' => [
+                  { 'uri' => server_url.join('/api/storage/libs-release-local/org/acme/artifact.deb') },
+                  { 'uri' => server_url.join('/api/storage/ext-release-local/org/acme/artifact.deb') },
+                ]
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end