artifactory 0.0.1 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ab81695852a0f488f0a8c0aa5ec0c727a08c9e07
+  data.tar.gz: 77629846e4f5069fe9ed05645deff8fc6e94b0fd
+SHA512:
+  metadata.gz: 0f7ec99417175058028512e76512cb8ca8bdaf7812c3daef9445d62138f049d961840ab0a5e0aa4b1057e8646effd3d0996c43dd490add26a5e5b3dc979c0b04
+  data.tar.gz: 7ae2fedc3094519ccb94858527366980b34c04efa9cc1a99c5bb22285fef259f1b29d0ab23a523de912b7f39ce78bf75aa46002378d161c6df270c24e534e077

data/.gitignore

@@ -1,18 +1,26 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
+*~
+*#
+.#*
+\#*#
+.*.sw[a-z]
+*.un~
+*.tmp
+*.bk
+*.bkup
+.DS_Store
+.kitchen.local.yml
+.rspec
+Berksfile.lock
 Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
+
+.bundle/
+.cache/
+.kitchen/
+.vagrant/
+.vagrant.d/
+.yardoc/
+bin/
+coverage/
 doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-vendor/bundle
+tmp/
+vendor/

data/.travis.yml

@@ -0,0 +1,8 @@
+# Test on modern rubites
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+
+# Setup parallel downloaders
+bundler_args: --jobs 7

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+Artifactory Client CHANGELOG
+============================
+This file is used to document the changes between releases of the Artifactory
+Ruby client.
+
+
+v1.0.0
+------
+- Initial release

data/Gemfile

@@ -1,4 +1,8 @@
 source 'https://rubygems.org'
-
-# Specify your gem's dependencies in artifactory.gemspec
 gemspec
+
+group :test do
+  gem 'sinatra', '~> 1.4'
+  gem 'rspec',   '~> 2.14'
+  gem 'webmock', '~> 1.17'
+end

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -1,29 +1,228 @@
-# Artifactory
+Artifactory Client
+==================
+[![Build Status](https://secure.travis-ci.org/opscode/artifactory-client.png?branch=master)](http://travis-ci.org/opscode/artifactory-client)
 
-TODO: Write a gem description
+A Ruby client and interface to the Artifactory API. **The majority of API endpoints are only exposed for Artifactory Pro customers!** As such, many of the resources and actions exposed by this gem also require Artifactory Pro.
 
-## Installation
+The Artifactory gem offers a convienent interface for managing various parts of the Artifactory API. It is not a complete API implementation, and should still be considered a work in progress.
 
-Add this line to your application's Gemfile:
 
-    gem 'artifactory'
+Quick start
+-----------
+Install via Rubygems:
 
-And then execute:
+    $ gem install artifactory
 
-    $ bundle
+or add it to your Gemfile if you're using Bundler:
 
-Or install it yourself as:
+```ruby
+gem 'artifactory', '~> 1.0'
+```
 
-    $ gem install artifactory
+In your library or project, you wil likely want to include the `Artifactory::Resource` namespace:
+
+```ruby
+include Artifactory::Resource
+```
+
+This will given you "Rails-like" access to the top-level Artifactory resources like:
+
+```ruby
+System.info
+Respository.all
+```
+
+If you choose not to include the module (for namespacing reasons), you will need to specify the full module path to access resources:
+
+```ruby
+Artifactory::Resource::System.info
+Artifactory::Resource::Respository.all
+```
+
+### Create a connection
+Before you can make a request, you must give Artifactory your connection information.
+
+```ruby
+Artifactory.configure do |config|
+  # The endpoint for the Artifactory server. If you are running the "default"
+  # Artifactory installation using tomcat, don't forget to include the
+  # +/artifactoy+ part of the URL.
+  config.endpoint = 'https://my.storage.server/artifactory'
+
+  # The basic authentication information. Since this uses HTTP Basic Auth, it
+  # is highly recommended that you run Artifactory over SSL.
+  config.username = 'admin'
+  config.password = 'password'
+
+  # You can specify any proxy information, including any authentication
+  # information in the URL.
+  config.proxy = 'https://user:password@my.proxy.server'
+end
+```
+
+All of these parameters are also configurable via the top-level `Artifactory` object. For example:
+
+```ruby
+Artifactory.endpoint = '...'
+```
+
+Or, if you want to be really Unixy, these parameters are all configurable via environment variables:
+
+```bash
+# Artifactory will use these values for the defaults
+export ARTIFACTORY_ENDPOINT=http://my.storage.server/artifactory
+export ARTIFACTORY_USERNAME=admin
+export ARTIFACTORY_PASSWORD=password
+```
+
+You can also create a full `Client` object with hash parameters:
+
+```ruby
+client = Artifactory::Client.new(endpoint: '...', username: '...')
+```
+
+### Making requests
+The Artifactory gem attempts to make the Artifactory API as object-oriented and Ruby-like as possible. All of the methods and API calls are heavily documented with examples inline using YARD. In order to keep the examples versioned with the code, the README only lists a few examples for using the Artifactory gem. Please see the inline documentation for the full API documentation.
+
+#### Artifacts
+```ruby
+# Search for an artifact by name
+artifact = Artifact.search(name: 'package.deb').first
+artifact #=> "#<Artifactory::Resource::Artifact md5: 'ABCD1234'>"
+
+# Get the properties of an artifact
+artifact.md5 #=> "ABCD1234"
+artifact.properties #=> { ... }
+
+# Download the artifact to disk
+artifact.download #=> /tmp/folders-a38b0decf038201/package.deb
+artifact.download('~/Desktop', filename: 'software.deb') #=> /Users/you/Desktop/software.deb
+
+# Delete the artifact from the Artifactory server
+artifact.delete #=> true
+```
+
+#### Builds
+```ruby
+# Show all builds
+Build.all #=> [#<Build ...>]
+```
+
+#### Plugins
+```ruby
+# Show all plugins
+Plugin.all #=> [#<Plugin ...>]
+```
+
+#### Repository
+```ruby
+# Find a repository by name
+repo = Repository.find(name: 'libs-release-local')
+repo #=> #<Artifactory::Resource::Repository ...>
+
+# Get information about the repository
+repo.description => "The default storage mechanism for..."
+
+# Upload an artifact to the repo
+repo.upload('/local/path/to/file', param_1: 'foo', param_2: 'bar')
+
+# Get a list of artifacts in this repository
+repo.artifacts #=> [#<Artifactory::Resource::Artifact ...>, ...]
+```
+
+#### System
+```ruby
+# Get the system information
+System.info #=> "..."
+
+# See if artifactory is running
+System.ping #=> true
+
+# Get the Artifactory server version and other information
+System.version #=> { ... }
+```
+
+#### Raw requests
+If there's a specific endpoint or path you need to hit that is not implemented by this gem, you can execute a "raw" request:
+
+```ruby
+# Using the top-level Artifactory module
+Artifactory.get('/some/special/path', param_1: 'foo', param_2: 'bar')
+
+# Using an Artifactory::Client object
+client.get('/some/special/path', param_1: 'foo', param_2: 'bar')
+```
+
+For more information on the methods available, please see the [`Artifactory::Client` class](https://github.com/opscode/artifactory-client/blob/master/lib/artifactory/client.rb).
+
+### Theadsafey
+If you plan to use the Artifactory gem in a library, you should be aware that _certain_ pathways for accessing resources is **not** threadsafe. In order to deliver a "Rails-like" experience, accessing a resource without a client object uses a global shared state. Other threads may modify this state, and therefore we do **not** recommend using the Rails-like approach if you are concerned about threadsafety. The following code snippet may better explain the differences:
+
+```ruby
+# In our current thread...
+Artifactory.endpoint = 'http://foo.com/artifactory'
+
+# Meanwhile, in another thread...
+Thread.new do
+  Artifactory.endpoint = 'http://bar.com/artifactory'
+end
+
+# You have a 50/50 chance of which endpoint is used, depending on the order in
+# which the threads execute on the CPU.
+Artifactory.endpoint #=> 'http://foo.com/artifactory'
+Artifactory.endpoint #=> 'http://bar.com/artifactory'
+```
+
+To avoid this potential headache, the Artifactory gem offers a less Rails-like API in which the `Artifactory::Client` object becomes the pivot for all resources. First, you must create a client object (you cannot use the global namespace):
+
+```ruby
+client = Artifactory::Client.new(endpoint: 'http://foo.com/artifactory')
+```
+
+And then execute all requests using this client object, with the general pattern `resource_method`:
+
+```ruby
+# Search for artifacts
+client.artifact_search(name: '...') #=> [...]
+
+# Get all plugins
+client.all_plugins #=> [...]
+```
+
+This pattern is slightly less eye-appealing, but it will ensure that your code is threadsafe.
+
+
+Development
+-----------
+1. Clone the project on GitHub
+2. Create a feature branch
+3. Submit a Pull Request
+
+Artifactory uses a built-in Sinatra server that "acts like" a real Artifactory Pro server. Since we cannot bundle a full Artifactory Pro server with the gem, we have re-implemented various pieces of their API. If you are writing a feature that accesses a new endpoint, you will likely need to add that endpoint to the vendored Sinatra app, using the [API documentation for Artifactory](http://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API).
+
+Important Notes:
+
+- **All new features must include test coverage.** At a bare minimum, Unit tests are required. It is preferred if you include acceptance tests as well.
+- **The tests must be be idempotent.** The HTTP calls made during a test should be able to be run over and over.
+- **Tests are order independent.** The default RSpec configuration randomizes the test order, so this should not be a problem.
+
+
+License & Authors
+-----------------
+- Author: Seth Vargo <sethvargo@gmail.com>
 
-## Usage
+```text
+Copyright 2013-2014 Chef Software, Inc.
 
-TODO: Write usage instructions here
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
 
-## Contributing
+    http://www.apache.org/licenses/LICENSE-2.0
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+```