pulp 0.0.8

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,19 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem "rest-client", "~> 1.6.7"
+gem "activesupport"
+gem "json"
+gem "i18n"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+  gem "mocha"
+end

data/Gemfile.lock

@@ -0,0 +1,42 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.1.0)
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    i18n (0.6.0)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    json (1.6.4)
+    metaclass (0.0.1)
+    mime-types (1.16)
+    mocha (0.10.0)
+      metaclass (~> 0.0.1)
+    rake (0.9.2)
+    rcov (0.9.11)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  bundler (~> 1.0.0)
+  i18n
+  jeweler (~> 1.6.4)
+  json
+  mocha
+  rcov
+  rest-client (~> 1.6.7)
+  rspec (~> 2.3.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 mh
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,147 @@
+= ruby-pulp
+
+A ruby gem to talk to a pulp server using its REST-api.
+
+Pulp is juicy software repository managment and so we want to talk to it in a juicy language.
+
+The library provides easy to use, `activerecord`-like objects for the different resources you can manage
+via Pulp's REST-Api. So that if you for example like to create a new repository you need to do only the
+following:
+
+    repo = Pulp::Repository.create(
+      :id => 'pulp-rhel6-x86_64',
+      :name => 'Example Repository for pulp on RHEL 6 x86_64',
+      :arch => 'x86_64',
+      :feed => "http://repos.fedorapeople.org/repos/pulp/pulp/6Server/x86_64/",
+      :relative_path => "pulp_test/#{random_id}",
+      :sync_schedule => '' 
+    )
+
+You can then search by any field that is allowed as search field for that repository:
+
+    Pulp::Repository.find_by_arch('x86_64').find{{|r| r.name == 'pulp-rhel6-x86_64' }
+    puts repo.name
+
+Or simply get it by its id:
+
+    repo = Pulp::Repository.get('pulp-rhel6-x86_64')
+    puts repo.name
+
+If you don't like it anymore, you can simply delete it:
+
+    repo.delete
+
+As you would know things from working with activerecord.
+
+== Disclaimer
+
+Not all parts have already been used and tested against a real pulp server. Pulp is still a piece of software
+that is moving very quickly forward. So use it only with the latest pulp version, and it might be that things
+are broken.
+
+Bug reports / Pull requests (including tests) are welcome! See below.
+
+== Configuration
+
+When requiring the gem, it is looking for the environment variable PULP_YML, if it points to an existing yaml file,
+or whether a yaml file exist at `~/.pulp.yaml` or `/etc/pulp/pulp.yaml`. It then tries to configure itself with
+the options from that file.
+
+However, you can also later configure the access credentils with:
+
+    Pulp::Connection::Handler.hostname = 'localhost'
+    Pulp::Connection::Handler.username = 'admin'
+    Pulp::Connection::Handler.password = 'admin'
+
+== Examples
+
+A few examples can be found in `examples/`. The main one `repositories.rb` can easily be run agains a local
+pulp server, that does have internet connection.
+It will generate a new repository, clone from it, and will cleanup at the end. Give it a shot, otherwise even
+reading the code, might give you already an idea of how to use this gem.
+
+== Defining resources
+
+This gem comes with a little framework behind that provides various methods to create the classes for the
+resources in a very declarative manner. The main idea is that a Pulp resource inherits from `Pulp::Connection::Base`
+and then declares its field and their behavior with the various class methods. These fields and actions are mainly
+take from the existing PULP-Api documentation: https://fedorahosted.org/pulp/wiki/UGRESTAPI
+
+The idea is to make it very easy to declare the fields and actions of resources and to not let you rewrite a lot
+of common code to just interact with the REST-API. What follows is a short description of the most important fields.
+
+By default we assume that the objects have an `id` field that is their unique identifier.
+
+We can then define further fields of the resource, with the `pulp_field(s)` method. For example for a
+`Pulp::Repository` we can define the fields `arch`, `name`, `release`.
+
+    module Pulp
+      class Repository
+        ...
+        pulp_fields :arch, :name, :release
+        ...
+      end
+    end
+    
+    puts repo.name
+    repo.name = 'some other name'
+    repo.save # will to an UPDATE including the new name
+
+You can also execute various actions on the different pulp resources. These actions can be declared using `pulp_action`:
+
+    module Pulp
+      class Repository
+        ...
+        pulp_action :create_packagegroupcategory, :returns => Pulp::PackageGroupCategory
+        pulp_action :delete_errata, :parse => false
+        ...
+      end
+    end
+
+This means that you can use `repo.create_packagegroupcategory({...})` and pass it a hash of options as described in the API
+documentation and it will return the newly created `Pulp::PackageGroupCategory`. `repo.delete_errata({...})` will delete an
+errata, but won't parse the actual result, as it might simply return 'true' or 'false'. Attention: the last part might change
+within the near future of pulp.
+
+A `pulp_update_action` can be used to describe update methods for various special (usually locked fields).
+
+Any other methods can simple be added added using short methods, for example like, getting all the schedules or deleting a 
+node of a repository:
+
+    module Pulp
+      class Repository
+        ...
+        def self.schedules
+          self.base_get('schedules/')
+        end
+        def delete_note(key)
+          self.class.base_unparsed_delete("notes/#{key}/",self.id)
+          refresh
+          self
+        end
+        ...
+      end
+    end
+    Pulp::Repository.schedules
+    repo.delete_note('some_key')
+
+If you are unsure how certain things are used or can be added, I recommend you to A) read the pulp API docuemntation, B) read
+the code of this gem and C) read the pulp python code, as some things might not work as documented or are not documented at
+all. But the pulp maintainers are doing a really great job to get this last point fixe. Kudos to them! And they are also very
+happy if you point things out in the api, that does currently not work very correctly, does not follow the REST-"Standard",
+is undocumented or is somehow else weird.
+    
+== Contributing to ruby-pulp
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 mh. See LICENSE.txt for further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "pulp"
+  gem.homepage = "https://github.com/duritong"
+  gem.license = "MIT"
+  gem.summary = %Q{A little ruby wrapper around th pulp API}
+  gem.description = %Q{A little ruby wrapper around th pulp (http://pulpproject.org) API}
+  gem.email = "mh@immerda.ch"
+  gem.authors = ["mh"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ruby-pulp #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.8

data/examples/repositories.rb

@@ -0,0 +1,205 @@
+base = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+$LOAD_PATH << File.join(base, "lib")
+$LOAD_PATH << File.join(base, "examples")
+
+puts <<EOS
+Pulp examples: Repositories
+---------------------------
+
+This will do a simple workflow through the management of repositories via the PULP Api using our ruby wrapper.
+
+It will either use the test_pulp.yml file in this directory or use the PULP_YML environment variable, so you can set it to your own.
+
+The test_pulp.yml file assumes that you have a pulp server running on localhost with username and password set to admin.
+
+It will:
+ * Basic operations:
+   * list all existing repositories
+   * create a repository from the offical pulp repository for RHEL 6 - with a random prefix
+   * list all x86_64 repositories via a search filter
+   * relist all repositories
+   * run a sync on the created repository and wait till the sync finished
+   * make a clone of said repository
+   * list all repositories
+ * Additional Operations:
+   * unpublish the cloned repository
+   * Adjust the name of the created repository
+   * Add a note to the created repository
+   * Update this note
+   * Delete the note
+   * Add a group to the cloned repository
+   * Remove that group
+   * Add a filter to the cloned repository
+   * Remove that filter
+   * Republish the cloned repository
+ * Cleanup operations
+   * Delete the cloned repository
+   * Delete the created repository
+   * Print all repositories
+   
+ Do you like to start? (y/n)  
+EOS
+
+exit 1 unless STDIN.gets.chomp == 'y'
+
+ENV['PULP_YML'] ||= File.expand_path(File.join(File.dirname(__FILE__), 'test_pulp.yml'))
+require 'pulp'
+
+def field_sizes
+    @field_sizes ||= Hash.new(12).merge('id' => 27)
+end
+def fields
+  @fields ||= ['id', 'name', 'arch', 'source', 'release', 'last_sync', 'publish']
+end
+def pretty_table_row(obj = nil)
+    '| ' + fields.collect{|field| sprintf("%0-#{field_sizes[field]}s", (obj ? obj.send(field).inspect : field).to_s[0..field_sizes[field]-1]) }.join(' | ') + ' |'
+end
+
+def print_repos(repos=Pulp::Repository.all)
+  header = pretty_table_row
+  [header,header.gsub(/./, '-'), repos.collect{|r| pretty_table_row(r) },header.gsub(/./, '-')].flatten.join("\n")
+end
+  
+puts print_repos
+random_id = "pulp-rhel6-x86_64-#{8.times.collect{|a| (65 + rand(25)).chr}.join('')}"
+
+puts "Creating repository"
+repo = Pulp::Repository.create(
+  :id => random_id,
+  :name => 'Example Repository for pulp on RHEL 6 x86_64',
+  :arch => 'x86_64',
+  :feed => "http://repos.fedorapeople.org/repos/pulp/pulp/6Server/x86_64/",
+  :relative_path => "pulp_test/#{random_id}",
+  :sync_schedule => '' 
+)
+puts print_repos
+
+puts "All x86_64 repos:"
+puts print_repos(Pulp::Repository.find_by_arch('x86_64'))
+
+puts "Starting repo sync"
+
+task = repo.sync
+
+puts "Syncing enqueued with task id: #{task.id} and arguments: #{task.args.inspect}"
+
+while ['waiting','running'].include?(task.refresh.state) do
+  puts "Task is in state #{task.state} - Will wait for 30s and recheck"
+  sleep 30
+end
+
+puts "Task finished with state: #{task.state}"
+if task.exception
+  puts "The following exception occured: #{task.exception}"
+end
+
+puts "Cloning repository"
+
+task = repo.clone(
+  :clone_id => "clone-#{random_id}",
+  :clone_name => "Clone of #{random_id}",
+  :feed => 'parent'
+)
+
+puts "Cloning with task id: #{task.id} and arguments: #{task.args.inspect}"
+
+while ['waiting','running'].include?(task.refresh.state) do
+  puts "Task is in state #{task.state} - Will wait for 30s and recheck"
+  sleep 30
+end
+
+puts "Task finished with state: #{task.state}"
+if task.exception
+  puts "The following exception occurred: #{task.exception}"
+end
+
+clone_repo = Pulp::Repository.get("clone-#{random_id}")
+
+puts print_repos
+
+puts "Unpublish the cloned repository"
+clone_repo.update_publish(:state => false)
+clone_repo.refresh
+
+puts print_repos
+
+
+puts "Adjust name: #{repo.name}"
+repo.name = 'Some other name'
+repo.save
+puts "New name: #{repo.name}"
+
+puts
+
+puts "Managing notes"
+puts "---------------"
+puts "Current notes: #{repo.notes.inspect}"
+repo.add_note('test_note','foo')
+repo.refresh
+puts "Current notes: #{repo.notes.inspect}"
+repo.update_note('test_note','foo 2')
+repo.refresh
+puts "Updated notes: #{repo.notes.inspect}"
+puts "Delete note"
+repo.delete_note('test_note')
+repo.refresh
+puts "Current notes: #{repo.notes.inspect}"
+
+puts
+
+puts "Managing groups"
+puts "---------------"
+puts "Current groups: #{repo.groupid.inspect}"
+repo.add_group(:addgrp => 'test_group')
+repo.refresh
+puts "Current groups: #{repo.groupid.inspect}"
+puts "Delete groups"
+repo.remove_group(:rmgrp => 'test_group')
+repo.refresh
+puts "Current groups: #{repo.groupid.inspect}"
+
+puts
+
+puts "Managing filters"
+puts "----------------"
+puts "Init filter"
+begin
+  filter = nil
+  Pulp::Filter.get('wildcard')
+rescue RestClient::ResourceNotFound => e
+  filter = Pulp::Filter.create(:id => 'wildcard', :description => 'discard everything', :type => 'blacklist', :package_list => '*')
+end
+
+puts "Current filters: #{clone_repo.filters.inspect}"
+puts "Adding filter 'wildcard'"
+clone_repo.add_filters(:filters => ['wildcard'])
+clone_repo.refresh
+puts "Current filters: #{clone_repo.filters.inspect}"
+puts "Delete filter"
+clone_repo.remove_filters(:filters => ['wildcard'])
+clone_repo.refresh
+puts "Current filters: #{clone_repo.filters.inspect}"
+
+if filter
+  puts "Removing filter as it have been created by us"
+  filter.delete
+end
+
+puts
+
+puts "Republish the cloned repository"
+clone_repo.update_publish(:state => true)
+clone_repo.refresh
+
+puts print_repos
+
+puts
+
+puts "Deleting repository"
+
+repo.delete
+clone_repo.delete
+
+puts print_repos
+
+puts "Finished..."