runcible 0.4.5 → 0.4.6

data/CONTRIBUTING.md

@@ -0,0 +1,7 @@
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Gemfile

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in runcible.gemspec
+gemspec
+
+group :test do
+  gem 'rake', '0.9.2.2'
+  gem 'vcr'
+  gem 'webmock'
+  gem 'minitest'
+  gem 'parseconfig'
+end
+
+group :debug do
+  gem 'debugger'
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Red Hat
+
+MIT License
+
+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.md

@@ -0,0 +1,165 @@
+# Runcible
+
+[![Build Status](https://secure.travis-ci.org/Katello/runcible.png)](http://travis-ci.org/Katello/runcible)
+
+Exposing Pulp's juiciest parts. http://www.pulpproject.org/
+
+Latest Live Tested Version: **pulp-server-2.1.1-0.5.beta.el6.noarch**
+
+Current stable Runcible: https://github.com/Katello/runcible/tree/0.3
+
+For in-depth class and method documentation: http://katello.github.com/runcible/
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'runcible'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install runcible
+
+## Usage
+
+### Set Configuration
+
+The base configuration allows for the following to be set.
+
+    Runcible::Base.config = { 
+                :url      => "",
+                :api_path => "",
+                :user     => "",
+                :logger   => ""
+              }
+
+Required Configuration
+
+    :uri      => The base URI of the Pulp server (default: https://localhost)
+    :api_path => The API path of the Pulp server (default: pulp/api/v2/)
+    :user     => The Pulp username to be used in authentication
+    :logger   => The location to log RestClient calls (e.g. stdout)
+  
+Authentication Options are either HTTP or Oauth:
+
+    :http_auth  => {:password => ''}
+
+    :oauth      => {:oauth_secret => "",
+                    :oauth_key    => "" }
+
+For an example on parsing the Pulp server.conf and using values provided within for the configuration see the [test_runner](https://github.com/Katello/runcible/blob/master/test/integration/test_runner.rb)
+
+### Make a Request
+
+Runcible provides two represntation's of Pulp entities to make API calls: [resources](https://github.com/Katello/runcible/tree/master/lib/runcible/resources) and [extensions](https://github.com/Katello/runcible/tree/master/lib/runcible/extensions)
+
+The best examples of how to use either the resources or extensions can be found within the [tests](https://github.com/Katello/runcible/tree/master/test/integration)
+
+#### Resources
+
+Resources are designed to be one-for-one with the Pulp API calls in terms of required parameters and naming of the calls.  For example, in order to create a repository, associate a Yum importer and a distributor:
+
+    Runcible::Resources::Repository.create("Repository_ID")
+    Runcible::Resources::Repository.associate_importer("Repository_ID", "yum_importer", {})
+    Runcible::Resources::Repository.associate_distributor("Repository_ID", "yum_distributor", {"relative_url" => "/", "http" => true, "https" => true})
+
+#### Extensions
+
+Extensions are constructs around the Pulp API that make retrieving, accessing or creating certain data types easier.  For example, providing objects that represent the details of a yum importer or distributor, and providing functions to create a Repository with an importer and distributors in a single call.  The same three step process above using extensions is:
+
+    Runcible::Extensions::Repository.create_with_importer_and_distributors("Repository_ID", {:id=>'yum_importer'}, [{'type_id' => 'yum_distributor', 'id'=>'123', 'auto_publish'=>true, 'config'=>{'relative_url' => '/', 'http' => true, 'https' => true}}])
+
+Alternatively, using distributor and importer objects:
+
+    distributors = [Runcible::Extensions::YumDistributor.new('/path', true, true, :id => '123')]
+    importer = Runcible::Extensions::YumImporter.new()
+    Runcible::Extensions::Repository.create_with_importer_and_distributors("Repository_ID", importer, distributors)
+
+
+## Testing
+
+To run all tests using recorded data, run:
+
+    rake test mode=none
+
+To run all tests to record data:
+   
+    rake test mode=all
+
+To run a single test using recorded data, run:
+   
+    rake test mode=none test=extensions/respository
+    or (by filename)
+    rake test mode=none test=./test/extensions/respository_test.rb
+
+To run tests against your live Pulp without recording a new cassette set record flag to false (does not apply to mode=none):
+
+    record=false
+
+To run with  oauth, simply append the following to any commend:
+   
+    auth_type=oauth
+
+To see RestClient logs while testing:
+  
+    logging=true
+
+
+## Building and Releasing
+
+### Gem
+
+While anyone can grab the source and build a new version of the gem, only those with Rubygems.org permissions on the project can release an official version.
+
+To build a new version of Runcible, first bump the version depending on the type of release.
+
+    cd runcible/
+    vim lib/runcible/version.rb
+
+Now update the version to the new version, and commit the changes.
+
+    git commit -a -m 'Version bump'
+
+Now build:
+    
+    gem build runcible.gemspec
+
+
+#### Official Release
+  
+For an official release, again assuming you have the right permssions:
+
+    gem push runcible-<version>.gem
+
+### RPM Release
+
+If you are wanting to generate a new RPM build, please make sure you have followed the steps above if the build is going to include new code.  All builds should first go in gem form to Rubygems.  You'll need to make sure tito is installed:
+
+    yum install tito
+
+Now tag, making sure the tag version matches the gem version:
+
+    tito tag
+
+Assuming you have the right dependencies available, you can do a local test build with tito (although we recommend using mock):
+
+    tito build --test --rpm
+
+With mock:
+
+    tito build --test --rpm --builder=mock --builder-arg mock=<name_of_mock_config>
+
+From here there are a variety of options to build and release an RPM pakaged version of Runcible (e.g. you can build an SRPM to feed to Koji, or use mock locally)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Ensure all tests are passing
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

data/Rakefile

@@ -0,0 +1,82 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+namespace :test do
+  "Runs the unit tests"
+  Rake::TestTask.new :unit do |t|
+    t.pattern = 'test/unit/test_*.rb'
+  end
+
+  [:resources, :extensions].each do |task_name|
+    desc "Runs the #{task_name} tests"
+    task task_name do
+      options = {}
+
+      options[:mode]      = ENV['mode'] || 'none'
+      options[:test_name] = ENV['test']
+      options[:auth_type] = ENV['auth_type']
+      options[:logging]   = ENV['logging']
+
+      if !['new_episodes', 'all', 'none', 'once'].include?(options[:mode])
+        puts "Invalid test mode"
+      else
+        require "./test/test_runner"
+
+        test_runner = PulpMiniTestRunner.new
+
+        if options[:test_name]
+          puts "Running tests for: #{options[:test_name]}"
+        else
+          puts "Running tests for: #{task_name}"
+        end
+
+        test_runner.run_tests(task_name, options)
+        Rake::Task[:update_test_version].invoke if options[:mode] == "all" && ENV['record'] != false
+      end
+    end
+  end
+end
+
+desc "Updats the version of Pulp tested against in README"
+task :update_test_version do
+  text = File.open('README.md').read
+
+  File.open('README.md', 'w+') do |file|
+    original_regex = /Latest Live Tested Version: *.*/
+    pulp_version = `rpm -q pulp-server`.strip
+    replacement_string = "Latest Live Tested Version: **#{pulp_version}**"
+    replace = text.gsub!(original_regex, replacement_string)
+    file.puts replace
+  end
+end
+
+desc "Finds functions without dedicated tests"
+task :untested do
+  test_functions  = `grep -r 'def test_' test/ --exclude-dir=test/fixtures --include=*.rb --no-filename` 
+  lib_functions   = `grep -r 'def self' lib/ --exclude=base.rb --include=*.rb --no-filename`
+  
+  test_functions  = test_functions.split("\n").map{ |str| str.strip.split("def test_")[1] }.to_set
+  lib_functions   = lib_functions.split("\n").map{ |str| str.strip.split("def self.")[1].split("(").first }.to_set
+
+  difference = (lib_functions - test_functions).to_a
+
+  if !difference.empty?
+    puts difference
+    exit 1 
+  end
+end
+
+desc "Clears out all cassette files"
+task :clear_cassettes do
+  `rm -rf test/fixtures/vcr_cassettes/*.yml`
+  `rm -rf test/fixtures/vcr_cassettes/extensions/*.yml`
+  `rm -rf test/fixtures/vcr_cassettes/support/*.yml`
+end
+
+desc "Runs all tests"
+task :test do
+  Rake::Task['test:unit'].invoke
+  Rake::Task['test:resources'].invoke
+  Rake::Task['test:extensions'].invoke
+end

data/lib/runcible/version.rb

@@ -1,3 +1,3 @@
 module Runcible
-  VERSION = "0.4.5"
+  VERSION = "0.4.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runcible
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.4.6
   prerelease:
 platform: ruby
 authors:
@@ -130,6 +130,11 @@ files:
 - lib/runcible/resources/user.rb
 - lib/runcible/resources/unit.rb
 - lib/runcible/resources/repository_group.rb
+- LICENSE
+- Rakefile
+- Gemfile
+- README.md
+- CONTRIBUTING.md
 homepage: https://github.com/Katello/runcible
 licenses: []
 post_install_message: