pdc 0.1.0

data/docs/source/conf.py

@@ -0,0 +1,257 @@
+# -*- coding: utf-8 -*-
+#
+# PDC documentation build configuration file, created by
+# sphinx-quickstart on Tue Nov 18 14:45:45 2014.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'PDC Client'
+copyright = u'2014-2016, PDC Devel Team'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+
+version = '0.1'
+# The full version, including alpha/beta/rc tags.
+release = '0.1.0-1'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = []
+
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+#keep_warnings = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+#html_extra_path = []
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'PDCRubyGemdoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+#latex_documents = [
+#  ('index', 'PDC_client.tex', u'PDC Ruby Gem Documentation',
+#   u'PDC Devel Team', 'manual'),
+#]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+#man_pages = [
+#    ('index', 'pdc client', u'PDC Client Documentation',
+#     [u'PDC Devel Team'], 1)
+#]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+#texinfo_documents = [
+#  ('index', 'PDC Client', u'PDC Client Documentation',
+#   u'PDC Devel Team', 'PDC', 'One line description of project.',
+#   'Miscellaneous'),
+#]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+#texinfo_no_detailmenu = False

data/docs/source/example.rst

@@ -0,0 +1,10 @@
+.. _example:
+
+
+First page
+=======
+
+Example page
+-------------
+
+Please use markdown to write the documentation file.

data/docs/source/index.rst

@@ -0,0 +1,23 @@
+.. PDC Ruby Gem documentation master file, created by
+   sphinx-quickstart on Tue Aug 17 14:45:45 2016.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to PDC Ruby Gem's documentation!
+===============================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 3
+   :numbered:
+
+   example
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`search`
+

data/docs/sphinx_deployment.mk

@@ -0,0 +1,117 @@
+# Copyright (c) Teracy, Inc. and individual contributors.
+# All rights reserved.
+
+# Redistribution and use in source and binary forms, with or without modification,
+# are permitted provided that the following conditions are met:
+
+#     1. Redistributions of source code must retain the above copyright notice,
+#        this list of conditions and the following disclaimer.
+
+#     2. Redistributions in binary form must reproduce the above copyright
+#        notice, this list of conditions and the following disclaimer in the
+#        documentation and/or other materials provided with the distribution.
+
+#     3. Neither the name of Teracy, Inc. nor the names of its contributors may be used
+#        to endorse or promote products derived from this software without
+#        specific prior written permission.
+
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+# ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+# Deployment configurations from sphinx_deployment project
+
+# default deployment when $ make deploy
+# deploy_gh_pages                            : to $ make deploy_gh_pages
+
+# default value: deploy_gh_pages
+ifndef DEPLOY_DEFAULT
+DEPLOY_DEFAULT = deploy_gh_pages
+endif
+
+# The deployment directory to be deployed
+ifndef DEPLOY_DIR
+DEPLOY_DIR      = _deploy
+endif
+
+# The heroku deployment directory to be deployed
+# we must create this separated dir to avoid any conflict with _deploy (rsync and gh_pages)
+ifndef DEPLOY_DIR_HEROKU
+DEPLOY_DIR_HEROKU = _deploy_heroku
+endif
+
+# Copy contents from $(BUILDDIR) to $(DEPLOY_DIR)/$(DEPLOY_HTML_DIR) directory
+ifndef DEPLOY_HTML_DIR
+DEPLOY_HTML_DIR = .
+endif
+
+## -- Github Pages Deploy config -- ##
+
+# Configure the right deployment branch
+ifndef DEPLOY_BRANCH_GITHUB
+DEPLOY_BRANCH_GITHUB = gh-pages
+endif
+
+#if REPO_URL_GITHUB was NOT defined by travis-ci
+ifndef REPO_URL_GITHUB
+# Configure your right github project repo
+# REPO_URL_GITHUB       = https://github.com/product-definition-center/pdc-client
+endif
+
+## end deployment configuration, don't edit anything below this line ##
+#######################################################################
+
+ifeq ($(RSYNC_DELETE), true)
+RSYNC_DELETE_OPT = --delete
+endif
+
+init_gh_pages:
+	@rm -rf $(DEPLOY_DIR)
+	@mkdir -p $(DEPLOY_DIR)
+	@cd $(DEPLOY_DIR); git init;\
+		echo 'sphinx docs comming soon...' > index.html;\
+		touch .nojekyll;\
+		git add .; git commit -m "sphinx docs init";\
+		git branch -m $(DEPLOY_BRANCH_GITHUB);\
+		git remote add origin $(REPO_URL_GITHUB);
+	@cd $(DEPLOY_DIR);\
+		if ! git ls-remote origin $(DEPLOY_BRANCH_GITHUB) | grep $(DEPLOY_BRANCH_GITHUB) ; then \
+			echo "Preparing Github deployment branch: $(DEPLOY_BRANCH_GITHUB) for the first time only...";\
+			git push -u origin $(DEPLOY_BRANCH_GITHUB);\
+		fi
+
+setup_gh_pages: init_gh_pages
+	@echo "Setting up gh-pages deployment..."
+	@cd $(DEPLOY_DIR);\
+		git fetch origin;\
+		git reset --hard origin/$(DEPLOY_BRANCH_GITHUB);\
+		git branch --set-upstream $(DEPLOY_BRANCH_GITHUB) origin/$(DEPLOY_BRANCH_GITHUB)
+	@echo "Now you can deploy to Github Pages with 'make generate' and then 'make deploy_gh_pages'"
+
+generate: html
+
+prepare_gh_pages_deployment:
+	@echo "Preparing gh_pages deployment..."
+	@echo "Pulling any updates from Github Pages..."
+	@cd $(DEPLOY_DIR); git pull;
+	@mkdir -p $(DEPLOY_DIR)/$(DEPLOY_HTML_DIR)
+	@echo "Copying files from '$(BUILDDIR)/html/.' to '$(DEPLOY_DIR)/$(DEPLOY_HTML_DIR)'"
+	@cp -r $(BUILDDIR)/html/. $(DEPLOY_DIR)/$(DEPLOY_HTML_DIR)
+
+deploy_gh_pages: prepare_gh_pages_deployment
+	@echo "Deploying on github pages now..."
+	@cd $(DEPLOY_DIR); git add -A; git commit -m "docs updated at `LC_ALL=en_US.utf8 date -u`";\
+		git push origin $(DEPLOY_BRANCH) --quiet
+	@echo "Github Pages deploy was completed at `LC_ALL=en_US.utf8 date -u`"
+
+
+deploy: $(DEPLOY_DEFAULT)
+
+gen_deploy: generate deploy

data/examples/active_attr.rb

@@ -0,0 +1,33 @@
+
+# module PDC
+#   class Base
+#     include ActiveAttr::Model
+#     include Resource::Identity
+#   end
+# end
+#
+# module PDC::V1
+#   class Release < PDC::Base
+#     attribute :first_name
+#     attribute :last_name
+#   end
+# end
+#
+#
+#
+#
+# describe PDC::V1::Release do
+#   let(:release_class) { PDC::V1::Release }
+#   it 'works' do
+#     person = release_class.new
+#     person.first_name = "Chris"
+#     person.last_name = "Griego"
+#     person.attributes #=> {"first_name"=>"Chris", "last_name"=>"Griego"}
+#     person.first_name = "Chris"
+#     person.last_name = "Griego"
+#     require 'pry'; binding.pry
+#     person.attributes #=> {"first_name"=>"Chris", "last_name"=>"Griego"}
+#   end
+# end
+#
+#

data/examples/http_failures.rb

@@ -0,0 +1,18 @@
+require 'ap'
+require './lib/pdc'
+
+PDC.configure do |config|
+  # invalid
+  config.site = 'http://localhost:8000/foo/bar/baz'
+  config.enable_logging = true
+  config.auth_type = :basic
+  config.use_ssl = false
+end
+
+begin
+  release = PDC::V1::Release.all
+  release.to_a
+rescue PDC::Error::ResourceNotFound => e
+  ap e
+  puts "Got resource not found as expected: #{e.response[:status]}".yellowish
+end

data/examples/local_pdc_dev.rb

@@ -0,0 +1,15 @@
+require 'ap'
+require_relative '../lib/pdc'
+
+def main
+  PDC.configure do |config|
+    config.site = 'http://localhost:8000'
+    config.requires_token = false
+    config.log_level = :debug
+  end
+
+  releases = PDC::V1::Release.all!.to_a
+  ap releases
+end
+
+main if __FILE__ == $PROGRAM_NAME

data/examples/logger.rb

@@ -0,0 +1,50 @@
+require_relative '../lib/pdc'
+require 'ap'
+
+class FakeLogger
+  attr_accessor :level
+
+  def debug(*args)
+  end
+  def info(*args)
+  end
+  def warn(*args)
+  end
+  def fatal(*args)
+  end
+
+  def error(*args)
+  end
+end
+
+#PDC.logger = FakeLogger.new
+
+
+logger = PDC.logger
+
+logger.debug("Debug will be logged")
+logger.info("Info will be logged as well")
+
+logger.level = Logger::WARN
+
+logger.debug("Created logger")    # won't be logged
+logger.info("Program started")    # won't be logged
+logger.warn("Nothing to do!")
+logger.error("Error something really went wrong")
+
+path = "a_non_existent_file"
+
+begin
+  File.foreach(path) do |line|
+    unless line =~ /^(\w+) = (.*)$/
+      logger.error("Line in wrong format: #{line.chomp}")
+    end
+  end
+rescue => err
+  logger.fatal("Caught exception; exiting")
+  logger.fatal(err)
+end
+
+logger.level = Logger::INFO
+logger.info("will continue here")
+

data/examples/pdc_curb_access_token.rb

@@ -0,0 +1,36 @@
+require 'ap'
+require 'curb'
+require 'json'
+require './lib/pdc'
+
+def obtain_token
+  url = PDC.config.site + PDC.config.rest_api_path + '/' + PDC.config.token_obtain_path
+
+  c = Curl::Easy.new(url) do |request|
+    request.headers["Accept"] = "application/json"
+    request.http_auth_types = :gssnegotiate
+
+    # The curl man page (http://curl.haxx.se/docs/manpage.html) specifes
+    # setting a fake username when using Negotiate auth, and use ':'
+    # in their example.
+    request.username = ':'
+  end
+  c.perform
+  raise "Obtain token from #{url} failed: #{c.body_str}" if c.response_code != 200
+  result = JSON.parse(c.body_str)
+  ap result
+  c.close
+  result['token']
+end
+
+PDC.configure do |config|
+  # invalid
+  config.site = 'https://pdc.engineering.redhat.com/'
+end
+
+def show_releases
+  releases = PDC::V1::Release.all
+  ap releases.to_a
+end
+
+show_releases